Propagate argument names to julia and more.

- argument names: if code is generated for CxxWrap release 0.15.0 or above, then the method
argument names are passed to their julia wrapper with the `jlcxx::argname`
featured added with this release.
- Add suppport to enable verbose import at runtime by defining the WRAPIT_VERBOSE_INPUT environment variable, which as the same effect as the VERBOSE_INPUT compilation option.
- New class_order_contraints configuration parameter to allow tuning of type wrapper declaration order

Author: grasph

doc/FAQ.md

@@ -79,13 +79,17 @@ Clang options:
 
 ## Issue when using code generated by wrapit.
 
-### C++ exception while wrapping module <module_name>: No appropriate factory for type <mangled_name>.
+### Exception "No appropriate factory for type <mangled_name>".
 
-First, used `c++filt -t <mangled_name>` to get the name of the problematic type. Beware of not being misled by mangled_name that looks like a plain name, always demangle it. 
+First, use `c++filt -t <mangled_name>` to get the name of the problematic type `T`. Beware of not being misled by mangled_name that looks like a plain name, always demangle it. If the exception occurs when importing the Julia module, see the question "I get an exception when loading the Julia module. How can I find the guilty code?" to find the wrapper declaration that is causing the exception.
+
+The exception indicates that the wrapper for `T` must be declared (with the `add_type()` function) before the declaration triggering the exception. There two options, the wrapper is not declared or is declared too late. You can check order of type declaration in the generation file name jl<module_name>.cxx: the wrapport of type `<type_name>` is declared with a call `newJl<type_name>(jlModule)`.
+
+The order of wrapper declaration lines can be tuned using the `class_order_constraints` configuration parameter. If the wrapper is not declared at all, check the `wrapit` logs to find the reason. If the file, where the type is declared is not included in the configuration, you can try to add it in the `input` or `extra_headers` list.
 
 ### I get an exception when loading the Julia module. How can I find the guilty code?
 
-For wrapit release 1.1.x or less, compile the code with the VERBOSE_IMPORT macro defined (`-DVERBOSE_IMPORT` compiler flag). For newer release, it is sufficient to define the `VERBOSE_IMPORT` environment variable.
+For wrapit release 1.1.x or less, compile the code with the VERBOSE_IMPORT macro defined (`-DVERBOSE_IMPORT` compiler flag). For newer release, it is sufficient to define the `WRAPIT_VERBOSE_IMPORT` environment variable.
 
 ### What the `Warning: specialization found at `X` for class/struct `Y` before its definition.` message mean?
 

doc/config.md

@@ -4,7 +4,6 @@ The configuration file uses the [toml](https://toml.io) syntax.
 
 The list of parameters with their defaut value is provided below.
 
-
 ### Main parameters
 
 ```
@@ -113,6 +112,15 @@ fields_and_variables = true
 #
 inheritances        = [ "" ]
 
+# Explicit constraints on the class wrapper declaration order.
+# A constraint is a string with format class_name_1 < class_name_2. It results
+# in having the wrappert of class_name_1 declared before the one of class_name_2.
+#
+# This parameter can be used to fix a bad wrapper declaration order resulting
+# from a Wrapit limitation. See the FAQ ""
+#
+class_order_constraints = [ "" ]
+
 # List of customized C++-to-Julia name mapping.  Each element of the list must
 # be a string with format <C++ fully qualified name> -> <julia name>.
 #

examples/ex002-ROOT/ROOT.wit

@@ -16,8 +16,8 @@ veto_list           = "jlROOT-veto.h"
 
 fields_and_variables = false
 
-# Currently not working with CxxWrap 0.15.0, use 0.14.x
-cxxwrap_version = "0.14"
+# Currently not working with CxxWrap 0.15.0, use 0.14.x or 0.16+
+cxxwrap_version = "0.17"
 
 #auto_veto           = false
 

src/CodeTree.cpp

@@ -308,7 +308,7 @@ CodeTree::generate_template_add_type_cxx(std::ostream& o,
 #ifdef DEFINE_TEMPLATE_METHODS_IN_CTOR
   if(type_rcd.default_ctor){
     FunctionWrapper::gen_ctor(o, 2, "t", type_rcd.template_parameters.empty(),
-                              type_rcd.finalize, std::string(),
+                              type_rcd.finalize, std::string(), std::string(),
                               cxxwrap_version_);
   }
 #endif
@@ -449,7 +449,7 @@ CodeTree::generate_cxx_for_type(std::ostream& o,
       //Generate a wrapper for the implicit default ctor if needed
       if(t.default_ctor){
         FunctionWrapper::gen_ctor(o, 2, "t", t.template_parameters.empty(),
-                                  t.finalize, std::string(),
+                                  t.finalize, std::string(), std::string(),
                                   cxxwrap_version_);
       }
     }
@@ -722,7 +722,7 @@ CodeTree::generate_cxx(){
   o2 << "#ifdef VERBOSE_IMPORT\n"
     "#  define DEBUG_MSG(a) std::cerr << a << \"\\n\"\n"
     "#else\n"
-    "#  define DEBUG_MSG(a)\n"
+    "#  define DEBUG_MSG(a) if(getenv(\"WRAPIT_VERBOSE_IMPORT\")) std::cerr << a << \"\\n\"\n"
     "#endif\n"
     "#define __HERE__  __FILE__ \":\" QUOTE2(__LINE__)\n"
     "#define QUOTE(arg) #arg\n"
@@ -1100,7 +1100,8 @@ CodeTree::generate_methods_of_templated_type_cxx(std::ostream& o,
   //    wrapped.constructor<>();
   if(t.default_ctor){
     FunctionWrapper::gen_ctor(o, 3, "wrapped", /*templated=*/true,
-                              t.finalize, std::string(), cxxwrap_version_);
+                              t.finalize, std::string(), std::string(),
+                              cxxwrap_version_);
   }
 
   //        wrapped.method("get_first", [](const T& a) -> T1 { return a.get_first(); });
@@ -2674,6 +2675,30 @@ void CodeTree::preprocess(){
       }//next paramType
     }//next iCombi
 
+
+    //Add user defined dependencies
+    for(const auto& dep: class_order_constraints_){
+      auto it1 = std::find_if(types_.begin(), types_.end(),
+                              [dep](const auto& x){ return x.type_name == dep.first;});
+      auto it2 = std::find_if(types_.begin(), types_.end(),
+                              [dep](const auto& x){ return x.type_name == dep.second;});
+      
+      if(it1 != types_.end() && it2 != types_.end()){
+        type_dependencies_.preceeds(it1 - types_.begin(), it2 - types_.begin());
+        if(verbose > 1) std::cerr << "Dependency \"" << dep.second << " requires " << dep.first
+                                << "\" added.\n";
+      } else{
+        if(verbose>0){
+          std::cerr << "Warning: class dependency "
+                    << dep.first << " < " << dep.second
+                    << " not used.";
+          if(it1 == types_.end()) std::cerr << " No " << dep.first << " class.";
+          if(it2 == types_.end()) std::cerr << " No " << dep.second << " class.";
+          std::cerr << "\n";
+        } 
+      }
+    }
+
 #ifdef DEFINE_TEMPLATE_METHODS_IN_CTOR
     //Add dependencies of templated classes to the type of their methods
     //argument and return value.
@@ -3160,24 +3185,54 @@ void CodeTree::generate_project_file(std::ostream& o,
 
 void CodeTree::set_julia_names(const std::vector<std::string>& name_map){
   cxx_to_julia_.clear();
-  std::regex re("\\s*->\\s");
+  std::regex re("\\s*->\\s*");
+  int i = 0;
   for(const std::string& m: name_map){
+    ++i;
     std::sregex_token_iterator it{m.begin(), m.end(), re, -1};
     std::vector<std::string> tokens{it, {}};
     if(tokens.size() > 1){
       cxx_to_julia_[tokens[0]] = tokens[1];
+    } else{
+      std::cerr << "ERROR. Syntax error for the " << nth(i) << " element "
+                << m
+                << " of julia_names parameter.\n";
+    }
+  }
+}
+
+void CodeTree::set_class_order_constraints(const std::vector<std::string>& class_order_constraints){
+  class_order_constraints_.clear();
+  std::regex re("\\s*<\\s*");
+  int i = 0;
+  for(const std::string& m: class_order_constraints){
+    ++i;
+    std::sregex_token_iterator it{m.begin(), m.end(), re, -1};
+    std::vector<std::string> tokens{it, {}};
+    if(tokens.size() > 1){
+      class_order_constraints_.push_back(std::make_pair(tokens[0], tokens[1]));
+    } else{
+      std::cerr << "ERROR. Syntax error for the " << nth(i) << " element "
+                << m
+                << " of class_dependencies configuration parameter.\n";
     }
   }
 }
 
 void CodeTree::set_mapped_types(const std::vector<std::string>& name_map){
   type_straight_mapping_.clear();
-  std::regex re("\\s*->\\s");
+  std::regex re("\\s*->\\s*");
+  int i = 0;
   for(const std::string& m: name_map){
+    ++i;
     std::sregex_token_iterator it{m.begin(), m.end(), re, -1};
     std::vector<std::string> tokens{it, {}};
     if(tokens.size() > 1){
       type_straight_mapping_[tokens[0]] = tokens[1];
+    } else{
+      std::cerr << "ERROR. Syntax error for the " << nth(i) << " element "
+                << m
+                << " of mapped_types configuration parameter.\n";
     }
   }
 }

src/CodeTree.h

@@ -284,6 +284,8 @@ namespace codetree{
     void set_force_mode(bool forced){ out_open_mode_ = forced ? std::ios_base::out : std::ios_base::app; }
 
     void set_julia_names(const std::vector<std::string>& name_map);
+
+    void set_class_order_constraints(const std::vector<std::string>& class_order_constraints);
 
     void set_mapped_types(const std::vector<std::string>& name_map);
 
@@ -320,7 +322,6 @@ namespace codetree{
 
     bool add_type_specialization(TypeRcd* pTypeRcd, const CXType& type);
 
-
     bool check_resource_dir(bool verbose) const;
 
     //Finds the definition of a type or the underlying type in case
@@ -546,6 +547,8 @@ namespace codetree{
 
     Graph type_dependencies_;
 
+    std::vector<std::pair<std::string, std::string>> class_order_constraints_;
+    
     std::vector<std::string> towrap_type_filenames_;
     std::set<std::string> towrap_type_filenames_set_;