Noissue - Use meson to build the C++ code

README.md

 Adblock Plus core
 =================
 
 This repository contains the generic Adblock Plus code that's shared between
 platforms. This repository is not designed to be used directly, but instead to
 serve as a dependency for `adblockplus`, `adblockpluschrome` and
 `libadblockplus`.
 
 Compiling C++ code
 ------------------
 
 ### Purpose
 
 In order to improve performance and memory usage, some of the code (located
 inside the `compiled` directory) is written in C++ and compiled to JavaScript
 via Empscripten.
 
 ### Requirements
 
 * [Emscripten 1.37.3](https://github.com/kripken/emscripten)
 * [Python 2.7](https://www.python.org)
+* [meson](https://www.mesonbuild.com)
+* [ninja](https://www.ninja-build.org)

[sergei, 2017/10/16 15:27:12]

It seems it would be good to specify minimal versions of both meson and ninja
because there are new features and bugfixes in newer versions which can be
essential for us.

[sergei, 2017/10/16 15:27:12]

Just a notice, maybe add some tips about installing them, e.g. meson can be
installed using pip and ninja package is usually actually called ninja-build,
ninja is unrelated package.

[hub, 2017/10/26 16:15:27]

For meson, I can even add a required version.

[Wladimir Palant, 2017/10/26 19:27:00]

We generally don't do this, leaving that up to the vendor of the respective
product - their preferred installation method can change.

 
 ### Running Emscripten
 
-After installing and configuring Emscripten you can run the following command:
+After installing and configuring Emscripten you can setup the build
+with the following commands:
 
-    python compile
+    meson build
+
+By default it will create a debug build. Pass `--buildtype release` to

[sergei, 2017/10/16 15:27:12]

Actually, IMO one should follow some convention distinguishing debug and release
directories, e.g.
meson build/release --builttype=release
ninja -C build/release.

+create a release build.
+
+Then to build just do:
+
+    cd build
+    ninja

[sergei, 2017/10/16 15:27:12]

What about
ninja -C build?

[hub, 2017/10/26 16:15:27]

Done.

+
+This will regenerate the build files as needed.
 
 This will produce a `lib/compiled.js` exporting the classes defined in C++ code.
 
 ### Technical details
 
 Compilation is currently a two-step process. In the bindings generation step,
 the source files are compiled into `compiled/bindings.cpp.js` with the
 `PRINT_BINDINGS` symbol defined. This application is then executed via Node.js
 and will print JavaScript wrappers for the C++ classes to
-`compiled/bindings.js` according to definitions within the `EMSCRIPTEN_BINDINGS`
+`build/bindings.js` according to definitions within the `EMSCRIPTEN_BINDINGS`
 macro in `compiled/bindings.cpp`.
 
 In the actual compilation step the source files are compiled into
 `lib/compiled.js` without the `PRINT_BINDINGS` symbol, so that the
 `EMSCRIPTEN_BINDINGS` macro ignores its contents and merely emits some generic
 functions necessary for the JavaScript bindings to work. The previously
 generated `compiled/bindings.js` file is added to the end of Emscripten output.
 
 The binding generation approach is heavily inspired by
 [embind](http://kripken.github.io/emscripten-site/docs/porting/connecting_cpp_and_javascript/embind.html).
@@ skipping 37 matching lines @@
 Linting
 -------
 
 You can lint the code using [ESLint](http://eslint.org).
 
     eslint *.js chrome lib test
 
 You will need to set up ESLint and our configuration first, see
 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-config-eyeo)
 for more information.