Reuse generated bindings #140

kornilova203 · 2018-07-30T10:29:43Z

Closes #2

Compilation requires https://github.com/nlohmann/json library.

Format of config file changed to json. It is very similar to previous stdHeaders file, but it provides a way to specify custom names mapping:

{
  "_stdio.h": "scala.scalanative.native.stdio",
  "hiredis.h": {
    "object": "bindings.hiredis.hiredis",
    "names": {
      "struct redisContext": "RedisContext"
    }
  }
}

To do:

validate config file
support custom name mapping (e.g struct s -> s instead of struct_s)
test function pointer type (clang replaces typedef with actual function pointer type, so it's not possible to reuse function pointer type)
update documentation
add the option to sbt plugin

jonas

Looks good although I hope we can figure out a way to make this change work with the PR to use bindings options in the sbt plugin.

jonas · 2018-08-06T12:05:26Z

bindgen/Main.cpp

@@ -26,6 +26,10 @@ int main(int argc, const char *argv[]) {
    llvm::cl::opt<std::string> LinkName(
        "link", llvm::cl::cat(Category),
        llvm::cl::desc("Library to link with, e.g. -luv for libuv"));
+    llvm::cl::opt<std::string> ReuseBindingsConfig(
+        "integrate-bindings", llvm::cl::cat(Category),


--binding-config might be better

jonas · 2018-08-06T12:07:19Z

bindgen/Main.cpp

@@ -62,6 +66,11 @@ int main(int argc, const char *argv[]) {
    std::string resolved = getRealPath(op.getSourcePathList()[0].c_str());
    LocationManager locationManager(resolved);

+    auto reuseBindingsConfig = ReuseBindingsConfig.getValue();
+    if (!reuseBindingsConfig.empty()) {
+        locationManager.loadConfig(reuseBindingsConfig);


Any thoughts on also providing a built-in default config to ease use of the standard library bindings from Scala Native

It may be a separate option, for example, useStandardScalaNativeBindings: Boolean

I looked through native package and found types only in stdio and in complex (but bindgen fails to translate float complex, double complex etc types, so currently it's not possible to reuse complex).

The easiest solution would be to hard code standard config in C++ code and "activate" it by passing use-standard-scala-native-bindings option.

Or it is possible to support multiple config files, so sbt plugin can pass to bindgen a user-defined config(s) and a standard config

I created an issue #147

jonas · 2018-08-06T12:09:55Z

bindgen/ir/IR.cpp

@@ -462,13 +461,21 @@ IR::~IR() {
 }

 template <typename T>
-bool IR::hasOutputtedDeclaration(
+bool IR::hasOutputtedType(


shouldOutoutType for consistency?

jonas · 2018-08-06T12:13:14Z

bindgen/ir/LocationManager.cpp

+        s << line;
+    }
+    config = json::parse(s.str());
+    validateConfig(config);


Great that you put validation of the configuration. ❤️

jonas · 2018-08-06T12:13:57Z

bindgen/ir/LocationManager.cpp

+        std::string object = headerEntry.get<std::string>();
+        if (object.empty()) {
+            throw std::invalid_argument("Invalid configuration. Each header "
+                                        "entry should contain non empty "


I believe it is "non-empty'

jonas · 2018-08-06T12:19:23Z

bindgen/ir/TypeDef.cpp

+    }
+    if (!type) {
+        if (startsWith(name, "struct_")) {
+            return "struct " +


So we still encode the name with an underscore internally?

I agree that it's better to store types with spaces

jonas · 2018-08-06T12:24:57Z

tools/src/main/scala/org/scalanative/bindgen/Bindgen.scala

@@ -111,6 +118,11 @@ object Bindgen {
      copy(extraArgBefore = extraArgBefore ++ args)
    }

+    def integrateBindings(config: File): Bindgen = {
+      require(config.exists())


Please add a proper error message here.

jonas · 2018-08-06T12:26:52Z

tools/src/main/scala/org/scalanative/bindgen/Bindgen.scala

@@ -130,6 +142,9 @@ object Bindgen {
        withArgs("--exclude-prefix", excludePrefix) ++
        withArgs("--extra-arg", extraArg) ++
        withArgs("--extra-arg-before", extraArgBefore) ++
+        integrateBindingsConfig
+          .flatMap(c => Option(Seq("--integrate-bindings", c.getAbsolutePath)))
+          .getOrElse(Seq[String]()) ++


Didn't withArgs work here?

withArgs("--...", integrateBindingsConfig)

withArgs("--binding-config", bindingConfig.map(_.getAbsolutePath)) does work

Use json format for config file Update documentation

kornilova203 force-pushed the recursive-structs branch from bc0fea7 to e698e7f Compare July 31, 2018 05:49

kornilova203 force-pushed the reuse-bindings branch from 1242546 to 49be660 Compare July 31, 2018 06:53

kornilova203 changed the base branch from recursive-structs to 0.3 July 31, 2018 06:54

kornilova203 mentioned this pull request Jul 31, 2018

Add tests for the --std-header option #72

Closed

kornilova203 force-pushed the reuse-bindings branch 3 times, most recently from 11fcf04 to 4735226 Compare August 2, 2018 14:26

kornilova203 changed the base branch from 0.3 to check-exit-code August 2, 2018 14:26

kornilova203 force-pushed the reuse-bindings branch 2 times, most recently from 200ab75 to 85fedc2 Compare August 4, 2018 06:58

kornilova203 changed the base branch from check-exit-code to master August 4, 2018 06:58

kornilova203 force-pushed the reuse-bindings branch 13 times, most recently from 81de677 to bfa9529 Compare August 6, 2018 05:52

kornilova203 requested a review from jonas August 6, 2018 06:47

kornilova203 changed the title ~~[WIP] Reuse generated bindings~~ Reuse generated bindings Aug 6, 2018

jonas reviewed Aug 6, 2018

View reviewed changes

kornilova203 mentioned this pull request Aug 6, 2018

Provide a default config to integrate standard bindings from Scala Native #147

Open

kornilova203 force-pushed the reuse-bindings branch 2 times, most recently from fe73222 to 04a5d59 Compare August 7, 2018 12:08

Reuse generated bindings

4b91635

Use json format for config file Update documentation

kornilova203 force-pushed the reuse-bindings branch from 04a5d59 to 4b91635 Compare August 7, 2018 12:23

kornilova203 merged commit ab51928 into master Aug 8, 2018

kornilova203 deleted the reuse-bindings branch August 8, 2018 04:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reuse generated bindings #140

Reuse generated bindings #140

kornilova203 commented Jul 30, 2018 •

edited

Loading

jonas left a comment

jonas Aug 6, 2018

jonas Aug 6, 2018

kornilova203 Aug 6, 2018 •

edited

Loading

kornilova203 Aug 6, 2018

jonas Aug 6, 2018

jonas Aug 6, 2018

jonas Aug 6, 2018

jonas Aug 6, 2018

kornilova203 Aug 6, 2018

jonas Aug 6, 2018

jonas Aug 6, 2018

kornilova203 Aug 6, 2018

Reuse generated bindings #140

Reuse generated bindings #140

Conversation

kornilova203 commented Jul 30, 2018 • edited Loading

jonas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kornilova203 Aug 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kornilova203 commented Jul 30, 2018 •

edited

Loading

kornilova203 Aug 6, 2018 •

edited

Loading