New fract4dc interface

.travis.yml

@@ -10,9 +10,9 @@ before_install:
   sudo apt-get install -y libgirepository1.0-dev gir1.2-gtk-3.0
 install:
   - python setup.py build
-  - pip install tox-travis pillow pygobject pylint
+  - pip install tox-travis pylint
 script:
-  - ./bin/pylint.sh
+  - ./bin/pylint.sh || travis_terminate 1;
   - tox
 notifications:
   email: false

fract4d/b.sh → bin/build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-pushd ..
+
 rm -rf build
+rm fract4d/*.so
 ./setup.py build
-popd

bin/clean.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+rm -rf build
+rm fract4d/*.so
+rm -rf .pytest_cache
+rm -rf .tox

bin/pylint.sh

@@ -1,2 +1,15 @@
-#!/bin/sh
-pylint *.py fract4d fract4d_compiler fract4dgui
+#!/bin/bash
+
+pylint --rcfile pylintrc *.py fract4d fract4d_compiler fract4dgui
+if [[ $? > 0 ]]
+then
+  exit 1
+fi
+
+pylint --rcfile pylintrc_new fract4d/fract4d_new
+if [[ $? > 0 ]]
+then
+  exit 1
+fi
+
+echo "pylint passed successfully"

docker/Dockerfile

@@ -9,12 +9,20 @@ RUN \
     apt-get -y upgrade && \
     apt-get -y install libpng-dev libjpeg-dev python3-dev gtk3.0 libcairo2-dev python3-cairo python3-gi-cairo pkg-config python3-pip xvfb
 
+# bin/run_builds.sh deps
+RUN apt-get -y install software-properties-common && \
+    add-apt-repository -y ppa:deadsnakes/ppa && \
+    apt-get -y install python3.5 python3.5-dev python3.6 python3.6-dev python3.7 python3.7-dev python3.8 python3.8-dev
 
-# deps for bin/run_*.sh scripts
-RUN pip3 install pillow pylint pytest tox
+# bin/run_pylint.sh deps
+RUN pip3 install pylint
 
-# other deps
-RUN apt-get -y install libgirepository1.0-dev gir1.2-gtk-3.0
+# bin/run_pytest.sh deps
+RUN pip3 install pytest
+
+# bin/run_tox.sh deps
+RUN apt-get -y install libgirepository1.0-dev
+RUN pip3 install tox
 
 # Xvfb (in memory x11 server) setup
 ENV DISPLAY :99

docker/bin/run_builds.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+docker-compose up -d --build
+docker-compose exec server bash -c "rm -rf build"
+docker-compose exec server bash -c "python3.5 ./setup.py build && \
+                                    python3.6 ./setup.py build && \
+                                    python3.7 ./setup.py build && \
+                                    python3.8 ./setup.py build"
+docker-compose down

docker/bin/run_clean.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+docker-compose up -d
+docker-compose exec server bash -c "rm -rf build && \
+                                    rm fract4d/*.so && \
+                                    rm -rf .pytest_cache && \
+                                    rm -rf .tox"
+docker-compose down

docker/bin/run_pylint.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+docker-compose up -d --build
+docker-compose exec server bash -c "rm -rf build"
+docker-compose exec server bash -c "python3 setup.py build && \
+                                    ./bin/pylint.sh"
+docker-compose down

docker/bin/run_test.sh

@@ -1,4 +1,7 @@
+#!/bin/bash
+
 docker-compose up -d --build
-# docker-compose exec server bash -c "pytest -s test.py::Test::testGenerateMandelbrot"
-docker-compose exec server bash -c "rm -rf build && python3 setup.py build && ./test.py"
+docker-compose exec server bash -c "rm -rf build"
+docker-compose exec server bash -c "python3 setup.py build && \
+                                    ./test.py"
 docker-compose down

docker/bin/run_tox.sh

@@ -1,3 +1,10 @@
+#!/bin/bash
+
 docker-compose up -d --build
-docker-compose exec server bash -c "rm -rf build && python3 setup.py build && tox"
+docker-compose exec server bash -c "rm -rf build"
+docker-compose exec server bash -c "python3.5 ./setup.py build && \
+                                    python3.6 ./setup.py build && \
+                                    python3.7 ./setup.py build && \
+                                    python3.8 ./setup.py build && \
+                                    tox"
 docker-compose down

examples/README.md

@@ -0,0 +1,155 @@
+# EXAMPLES
+
+*Note: for all exmples make sure you have performed the setup previously:*
+```
+./setup.py build
+```
+
+## Python examples
+### Creating a simple mandelbrot using fract4dc.controller
+
+Execute:
+```
+examples/python/simple_mandelbrot.py
+```
+Then you should see a new file under `examples/output`.
+
+---
+
+## C++ examples
+For these examples you'll need [docker](https://docs.docker.com/get-docker/)
+
+### Creating a simple mandelbrot
+Execute:
+```
+examples/cpp/simple_mandelbrot.sh
+```
+Then you should see a new file under `examples/output`.
+
+
+
+### Creating a simple mandelbrot using multiple threads
+Execute:
+```
+examples/cpp/multithread_mandelbrot.sh
+```
+Then you should see a new file under `examples/output`.
+
+
+
+### Creating a simple mandelbrot using no high level model entities (fractfunc, workers, pointfunc)
+In this example we use the compiled formula directly to calculate the fractal with no postprocessing (antialiasing) or improvements (ie. autodeepen)
+Execute:
+```
+examples/cpp/raw_mandelbrot.sh
+```
+Then you should see a new file under `examples/output`.
+
+
+
+### Creating a simple mandelbrot using no high level model entities (fractfunc, workers, pointfunc)
+### plus: using a custom formula source (not generated by compiler)
+
+In this example we use the compiled formula directly to calculate the fractal with no postprocessing (antialiasing) or improvements (ie. autodeepen)
+
+The forumula sources `examples/cpp/custom_mandelbrot_formula.c` were generated using gnofract4d and then modified introducing comments and eliminating some temporary vars to clarify calculations
+
+These are the formulas used to generate the sources to begin with:
+
+* main formula: __The Mandelbrot set__
+```
+Mandelbrot {
+; The classic Mandelbrot set
+init:
+	z = #zwpixel
+loop:
+	z = sqr(z) + #pixel
+bailout:
+	@bailfunc(z) < @bailout
+default:
+float param bailout
+	default = 4.0
+endparam
+float func bailfunc
+	default = cmag
+endfunc
+}
+```
+* outer transfer function: __Continuous Potential__
+```
+continuous_potential {
+final:
+    float ed = @bailout/(|z| + 1.0e-9)
+    #index = (#numiter + ed) / 256.0
+default:
+float param bailout
+	default = 4.0
+endparam
+}
+```
+* inner transfer function: __Zero__
+```
+zero (BOTH) {
+final:
+     #solid = true
+}
+```
+Each of these formulas has its own params, you cam see them on the GUI (fractal settings):
+
+![Formula](readme/formula.png)
+![Outer](readme/outer.png)
+![Inner](readme/inner.png)
+
+Except for the functions (bailfunc in the Formula and transfer functions in Inner and Outer) all the param values are passed to the formula through the init function.
+> Have in mind the formula sources are written in C. This is how you pass the params to the formula: `pf_handle->vtbl->init(pf_handle, const_cast<double *>(pos_params), params.get(), param_len);`
+
+> Actually there's no reason but to keep the interface to send the `pos_param`(x,y,z,w ...) in the init call. The formula params are kept in the state of the pf_handle and used afterwards in the calc method.
+
+> If you look at the code that the compiler spits out there's some parts that seem to have been left behind and are no longer needed: `get_defaults` interface and almost all the state props in `pf_real`struct.
+
+> bailfunc and transfer functions (with values cmag, ident and ident respectively) are not passed along with the params but instead they are coded by the compiler.
+
+If you compare `examples/cpp/custom_mandelbrot_formula.c` with the code generated by running `./gnofract4d --nogui --buildonly mandelbrot -f gf4d.frm#Mandelbrot` you'll find the temporary variables and unused code we disposed for this example to make the code easy to understand.
+
+Back to the Mandelbrot Set formula you can see in the screenshots above or in the file `formulas/gf4d.frm`. There you can identify sections (ended with a colon) init,
+loop, bailout... In the source you'll find those sections wrapped by goto labels and some comments we introduced for this example:
+* init:
+```C++
+t__start_finit:;
+    // init: z = #zwpixel
+    z_re = t__h_zwpixel_re;
+    z_im = t__h_zwpixel_im;
+    goto t__end_finit;
+t__end_finit:;
+```
+* loop:
+```C++
+t__start_floop:;
+    // loop: (z = sqr(z) + #pixel) same as (z = z*z + #pixel)
+    // complex x complex -> (a+bi)⋅(c+di)=(ac−bd)+(ad+bc)i
+    t__f5 = (z_re * z_re - z_im * z_im) + pixel_re;
+    t__f6 = (2.00000000000000000 * z_re * z_im) + pixel_im;
+    z_re = t__f5;
+    z_im = t__f6;
+    goto t__end_floop;
+t__end_floop:;
+```
+* bailout:
+```C++
+t__start_fbailout:;
+    // this is the bailout function, in this case "cmag" -> "square modulus"
+    // cmag(a,bi) is equivalent to a*a+b*b
+    f__bailout = (z_re * z_re + z_im * z_im) < t__a_fbailout;
+    goto t__end_fbailout;
+t__end_fbailout:;
+```
+
+This example is intended only to demonstrate how the sources generated by the compiler work for an specific case "The Mandelbrot" with scpecific transfer functions and paramters.
+
+The compiler is capable to handle more complex scenarios, functions and special parameters. You can find more information about that in [the manual](http://fract4d.github.io/gnofract4d/manual/formref.html).
+
+Execute:
+```
+examples/cpp/custom_formula.sh
+```
+Then you should see a new file under `examples/output`.

examples/cpp/CMakeLists.txt

@@ -0,0 +1,48 @@
+cmake_minimum_required(VERSION 3.10)
+project(simple_mandelbrot)
+
+set(CMAKE_CXX_STANDARD 17)
+
+include_directories(${PROJECT_SOURCE_DIR})
+include_directories(${PROJECT_SOURCE_DIR}/model)
+
+FILE(GLOB MODELFILES ${PROJECT_SOURCE_DIR}/model/*.cpp)
+
+set(CMAKE_CXX_FLAGS "-ffast-math")
+
+# MAIN
+
+add_executable(example main.cpp ${MODELFILES})
+
+find_package(PNG REQUIRED)
+include_directories(${PNG_INCLUDE_DIR})
+target_link_libraries(example ${PNG_LIBRARY})
+
+find_package(JPEG REQUIRED)
+include_directories(${JPEG_INCLUDE_DIR})
+target_link_libraries(example ${JPEG_LIBRARY})
+
+find_package(Threads REQUIRED)
+target_link_libraries(example ${CMAKE_THREAD_LIBS_INIT})
+
+target_link_libraries(example ${CMAKE_DL_LIBS})
+
+add_definitions(-DTHREADS -D_REENTRANT -DPNG_ENABLED -DJPG_ENABLED)
+
+# FRACT_STDLIB
+
+add_library(fract_stdlib SHARED
+    ${PROJECT_SOURCE_DIR}/fract_stdlib.cpp
+    ${PROJECT_SOURCE_DIR}/model/colorutils.cpp
+    ${PROJECT_SOURCE_DIR}/model/colormap.cpp
+    ${PROJECT_SOURCE_DIR}/model/image.cpp)
+
+set_target_properties(fract_stdlib PROPERTIES PREFIX "")
+set_target_properties(fract_stdlib PROPERTIES SUFFIX ".so")
+
+# FORMULA LIB
+
+add_library(formula SHARED
+    ${PROJECT_SOURCE_DIR}/formula.c)
+set_target_properties(formula PROPERTIES SUFFIX ".so")
+set_target_properties(formula PROPERTIES PREFIX "")

examples/cpp/Dockerfile

@@ -0,0 +1,22 @@
+FROM ubuntu:18.04
+
+ENV TZ=Europe/Minsk
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && \
+	apt-get install -y build-essential git cmake autoconf libtool pkg-config libpng-dev libjpeg-dev
+
+WORKDIR /src
+
+ARG main_source
+ARG formula_source
+
+COPY examples/cpp/${main_source} ./main.cpp
+COPY examples/cpp/CMakeLists.txt ./
+COPY fract4d/c/fract_stdlib.cpp fract4d/c/fract_stdlib.h fract4d/c/pf.h  ./
+COPY fract4d/c/model/ ./model
+COPY ${formula_source} ./formula.c
+
+RUN cmake . && make
+
+CMD ["./example"]