Issue 5062 - [emscripten] Allow generation of custom bindings code

compiled/bindings.ipp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #pragma once
 
 #include <cstddef>
 #include <cstdint>
 #include <cstdio>
 #include <cstdlib>
 #include <exception>
+#include <functional>
 #include <map>
 #include <string>
 #include <type_traits>
 #include <utility>
 #include <vector>
 
 #include <emscripten.h>
 
 #include "String.h"
 #include "intrusive_ptr.h"
@@ skipping 266 matching lines @@
     size_t offset;
     std::vector<std::pair<int, std::string>> mapping;
   };
 
   struct ClassInfo
   {
     ClassInfo* baseClass;
     std::string name;
     std::vector<PropertyInfo> properties;
     std::vector<MethodInfo> methods;
-    std::vector<FunctionInfo> initializers;
     DifferentiatorInfo subclass_differentiator;
     ptrdiff_t ref_counted_offset;
   };
 
+  typedef std::function<void()>  CustomGenerator;
+
   std::map<TYPEID, ClassInfo> classes;
+  std::vector<CustomGenerator> customGenerators;
 
   void register_class(const char* name, TYPEID classID, TYPEID baseClassID,
                       ptrdiff_t ref_counted_offset)
   {
     auto it = classes.find(classID);
     if (it != classes.end())
       throw std::runtime_error(std::string("Duplicate definition for class ") + name);
 
     ClassInfo* baseClass = nullptr;
     if (baseClassID != TypeInfo<NoBaseClass>())
@@ skipping 34 matching lines @@
     auto it = classes.find(classID);
     if (it == classes.end())
       throw std::runtime_error(std::string("Method defined on unknown class: ") + name);
 
     MethodInfo methodInfo;
     methodInfo.name = name;
     methodInfo.call = call;
     it->second.methods.push_back(methodInfo);
   }
 
-  void register_initializer(TYPEID classID, const FunctionInfo& call)
-  {
-    auto it = classes.find(classID);
-    if (it == classes.end())
-      throw std::runtime_error("Initializer defined on unknown class");
-
-    it->second.initializers.push_back(call);
-  }
-
   void register_differentiator(TYPEID classID, size_t offset,
       std::vector<std::pair<int, std::string>>& mapping)
   {
     auto it = classes.find(classID);
     if (it == classes.end())
       throw std::runtime_error("Subclass differentiator defined on unknown class");
 
     if (it->second.subclass_differentiator.offset != SIZE_MAX)
       throw std::runtime_error("More than one subclass differentiator defined for class " + it->second.name);
 
@@ skipping 206 matching lines @@
     }
 
     for (const auto& item : cls.methods)
     {
       std::string obj("exports." + cls.name);
       if (item.call.instance_function)
         obj += ".prototype";
       printf("%s.%s = %s;\n", obj.c_str(), item.name.c_str(),
           wrapCall(item.call).c_str());
     }
-
-    for (const auto& item : cls.initializers)
-      printf("%s()\n", item.name);
   }
 
   void printBindings()
   {
     printHelpers();
 
     for (const auto& item : classes)
       printClass(item.second);
+
+    for (const auto& item : customGenerators)
+      item();
   }
 }
 
 #if defined(PRINT_BINDINGS)
   // Bindings generation step: collect bindings information and print
   // corresponding JS code.
   #define EMSCRIPTEN_BINDINGS \
       struct BindingsInitializer {\
           BindingsInitializer();\
-          BindingsInitializer(bool dummy)\
-          {\
-            try\
-            {\
-              BindingsInitializer();\
-              bindings_internal::printBindings();\
-            }\
-            catch (const std::exception& e)\
-            {\
-              EM_ASM_ARGS(\
-                console.error("Error occurred generating JavaScript bindings: " +\
-                    Module.AsciiToString($0)), e.what()\
-              );\
-              abort();\
-            }\
-          }\
-      } BindingsInitializer_instance(true);\
+      };\

[sergei, 2017/03/30 11:09:17]

I would make it a simple function `void InitializeBindings();`.

[Wladimir Palant, 2017/03/30 12:58:58]

Done.

+      int main(void)\

[sergei, 2017/03/30 11:09:17]

In C++ there is no need for specifying of void in arguments.

[sergei, 2017/03/30 11:09:17]

Do you mind to consider in future moving of such C++ code into cpp files?

[Wladimir Palant, 2017/03/30 12:58:58]

Done.

[Wladimir Palant, 2017/03/30 12:58:58]

Not sure what you mean. This code is inside bindings.cpp - but it is being
generated by a macro.

[sergei, 2017/04/04 14:49:30]

I mean it would be better to have this code in another cpp file than use
preprocessor, e.g. we could simply append the file with main function to a list
of cpp files.

[Wladimir Palant, 2017/04/04 15:41:48]

But we are not compiling an executable, it's not supposed to have a main()
function. The fact that the intermediate binding generation step is compiling an
executable that we throw away is merely an implementation detail.

[sergei, 2017/04/11 16:29:20]

I didn't mean to append a cpp with main to SOURCE_FILES which is also used in
run_compiler, I meant it could be appended only to the list of cpp files used in
generate_bindings.

Even more, it's not only getting rid of defines with the code but also getting
it clearer and less error-prone. Clearer because it would be clear which code is
used only for generator, which is used only for regular run and which is a
common set. Less error-prone because we would eliminate even an accidental
possibility of influence from the generator code on a regular run code.

For instance only for generator we need non-existing currently main.cpp,
bindings.cpp and bindings.ipp, however we use two latter in compilation of JS
code which is for regular run.

[Wladimir Palant, 2017/04/11 18:22:44]

Let's do this in a follow-up, I'll file an issue.

+      {\
+        try\
+        {\
+          struct BindingsInitializer instance;\

[sergei, 2017/03/30 11:09:17]

Why did you need to add struct here?

[Wladimir Palant, 2017/03/30 12:58:57]

This is a InitializeBindings() call now - this was implicitly running the
constructor.

+          bindings_internal::printBindings();\
+        }\
+        catch (const std::exception& e)\
+        {\
+          EM_ASM_ARGS(\
+            console.error("Error occurred generating JavaScript bindings: " +\
+                Module.AsciiToString($0)), e.what()\
+          );\
+          abort();\
+        }\
+        return 0;\
+      }\
       BindingsInitializer::BindingsInitializer()
 #else
   // Actual compilation step: ignore bindings information but define some
   // exported helper functions necessary for the bindings.
   #define EMSCRIPTEN_BINDINGS \
       extern "C"\
       {\
         void EMSCRIPTEN_KEEPALIVE InitString(DependentString* str,\
             String::value_type* data, String::size_type len)\
         {\
@@ skipping 81 matching lines @@
   }
 
   template<typename ReturnType, typename... Args>
   const class_& class_function(const char* name, ReturnType (*method)(Args...)) const
   {
     bindings_internal::register_method(
         bindings_internal::TypeInfo<ClassType>(), name, method);
     return *this;
   }
 
-  const class_& class_initializer(void (*function)()) const
-  {
-    bindings_internal::register_initializer(
-        bindings_internal::TypeInfo<ClassType>(), function);
-    return *this;
-  }
-
   template<typename ReturnType,
       typename std::enable_if<std::is_convertible<ReturnType, int32_t>::value>::type* = nullptr>
   const class_& subclass_differentiator(ReturnType ClassType::* member,
       std::initializer_list<std::pair<ReturnType, const char*>> list) const
   {
     ClassType* instance = nullptr;
     size_t offset = (char*)&(instance->*member) - (char*)instance;
 
     std::vector<std::pair<int, std::string>> mapping;
     for (const auto& item : list)
       mapping.emplace_back(item.first, item.second);
 
     bindings_internal::register_differentiator(
         bindings_internal::TypeInfo<ClassType>(), offset, mapping);
     return *this;
   }
 };
+
+void custom_generator(bindings_internal::CustomGenerator generator)
+{
+  bindings_internal::customGenerators.push_back(generator);
+}