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)
+* [Python 2.7 & 3](https://www.python.org)
+* [meson 0.40.0+](https://www.mesonbuild.com)

[sergei, 2017/12/12 17:37:29]

Can we set the version to exactly 0.43.0 because it is working on Windows? The
latest one is not working right now.

Actually, I still prefer to rather have it in third_party/meson and "call meson
module" from our python script.

Additional info:
https://github.com/mesonbuild/meson/releases/tag/0.43.0, commit ID
5626df46453e73b63827c4542aae36443fbd928b.

[hub, 2017/12/13 20:28:59]

I pinned 0.43.0 in the current patch.

I'm not convinced by using it as a python module ; it would introduce another
NIH for the build system.

[Wladimir Palant, 2017/12/14 10:57:01]

Is there an issue on it already? If not, can you file one? Insisting on outdated
versions or even replicating them in our repository generally isn't a good idea,
we should rather make sure that the bugs are fixed. Normally, we can expect new
meson releases to be backwards compatible, a meson release breaking things for
us is rather unlikely - not a good justification for drastic measures.

[sergei, 2017/12/14 14:22:46]

Done, https://github.com/mesonbuild/meson/issues/2784.

+* [ninja](https://www.ninja-build.org)

[sergei, 2017/12/12 17:37:29]

Could you please add that ninja executable should be available, e.g. by having a
path to the directory with it in the PATH environment variable, because meson
searches for it while generating build-files?

Maybe later, we could avoid pollution of PATH variable and even automatically
fetch ninja as dependency.

[hub, 2017/12/13 20:28:59]

This conflict with Wladimir saying we shouldn't have the installation
instructions here.

 
 ### 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
+create a release build.
+
+Then to build just do:
+
+    ninja -C build
+
+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.