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)
+* [meson 0.40.0+](https://www.mesonbuild.com)
 * [ninja](https://www.ninja-build.org)
+
+Make sure that meson and ninja are in your PATH.
 
 ### Running Emscripten
 
 After installing and configuring Emscripten you can setup the build
 with the following commands:
 
-    mkdir build

[Wladimir Palant, 2017/10/12 08:46:09]

This step is unnecessary, meson will create the directory automatically.

[hub, 2017/10/12 18:12:10]

Done.

     meson build

[Wladimir Palant, 2017/10/12 08:46:09]

By default, a debug build will be created. So we should probably add
`--buildtype debug|release` here.

[hub, 2017/10/12 18:12:11]

Done.

+
+By default it will create a debug build. Pass `--buildtype release` to
+create a release build.
 
 Then to build just do:
 
-    cd build
-    ninja

[Wladimir Palant, 2017/10/12 08:46:08]

We should mention that running meson is normally a one-time thing, ninja will
detect changes to build configuration automatically.

[hub, 2017/10/12 18:12:10]

Done.

+    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
 `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
-`build/compiled.js` without the `PRINT_BINDINGS` symbol, so that the

[Wladimir Palant, 2017/10/12 08:46:08]

It's still lib/compiled.js right now.

We should update this section so that it no longer mentions PRINT_BINDINGS
symbol. That's a separate issue however.

[hub, 2017/10/12 18:12:11]

Done.

+`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).
 However, embind doesn't use a separate build step to produce the bindings, the
 bindings are rather generated dynamically at run time. As a side-effect, it
 increases the build size considerably and also imposes a significant performance
 penalty. Also, generating JavaScript code dynamically is discouraged for browser
@@ skipping 33 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.