Fix: #194 Align scala-native-bindgen with Scala Native 0.4.x API

.gitignore

@@ -2,3 +2,6 @@ target/
 scripts/.coursier
 scripts/.scalafmt-*
 /scala-native-bindgen-*
+
+.vscode/
+metals.sbt

.scalafmt.conf

@@ -1,3 +1,4 @@
+version = 1.5.1
 style = defaultWithAlign
 docstrings = JavaDoc
 assumeStandardLibraryStripMargin = true
@@ -8,4 +9,4 @@ project.excludeFilters = [
   "tests/samples/[^/]*[.]scala"
 ]
 project.git = true
-runner.dialect = Scala211
+runner.dialect = scala211

CONTRIBUTING.md

@@ -11,6 +11,12 @@ Important to note is that all contributors must have signed the [Scala CLA].
 
 ## Developer Workflow
 
+Install the following for macOS:
+```sh
+brew tap nlohmann/json
+brew install nlohmann-json
+```
+
 Build the `scalaBindgen` tool:
 
 ```sh

bindgen/CMakeLists.txt

@@ -3,6 +3,8 @@ project(scala-native-bindgen)
 
 option(STATIC_LINKING "Statically link the executable" OFF)
 
+find_package(nlohmann_json REQUIRED)
+
 # Locate LLVMConfig.cmake
 find_package(LLVM REQUIRED CONFIG)
 message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
@@ -106,6 +108,7 @@ set_target_properties(bindgen
 
 target_link_libraries(bindgen
   PRIVATE
+  nlohmann_json
   clangFrontend
   clangTooling
   clangSerialization

bindgen/TypeTranslator.cpp

@@ -8,29 +8,29 @@ TypeTranslator::TypeTranslator(clang::ASTContext *ctx_, IR &ir)
 
     // Native Types
     typeMap["void"] = "Unit";
-    typeMap["bool"] = "native.CBool";
-    typeMap["_Bool"] = "native.CBool";
-    typeMap["char"] = "native.CChar";
-    typeMap["signed char"] = "native.CSignedChar";
-    typeMap["unsigned char"] = "native.CUnsignedChar";
-    typeMap["short"] = "native.CShort";
-    typeMap["unsigned short"] = "native.CUnsignedShort";
-    typeMap["int"] = "native.CInt";
-    typeMap["long int"] = "native.CLongInt";
-    typeMap["unsigned int"] = "native.CUnsignedInt";
-    typeMap["unsigned long int"] = "native.CUnsignedLongInt";
-    typeMap["long"] = "native.CLong";
-    typeMap["unsigned long"] = "native.CUnsignedLong";
-    typeMap["long long"] = "native.CLongLong";
-    typeMap["unsigned long long"] = "native.CUnsignedLongLong";
-    typeMap["size_t"] = "native.CSize";
-    typeMap["ptrdiff_t"] = "native.CPtrDiff";
-    typeMap["wchar_t"] = "native.CWideChar";
-    typeMap["char16_t"] = "native.CChar16";
-    typeMap["char32_t"] = "native.CChar32";
-    typeMap["float"] = "native.CFloat";
-    typeMap["double"] = "native.CDouble";
-    typeMap["long double"] = "native.CDouble";
+    typeMap["bool"] = "CBool";
+    typeMap["_Bool"] = "CBool";
+    typeMap["char"] = "CChar";
+    typeMap["signed char"] = "CSignedChar";
+    typeMap["unsigned char"] = "CUnsignedChar";
+    typeMap["short"] = "CShort";
+    typeMap["unsigned short"] = "CUnsignedShort";
+    typeMap["int"] = "CInt";
+    typeMap["long int"] = "CLongInt";
+    typeMap["unsigned int"] = "CUnsignedInt";
+    typeMap["unsigned long int"] = "CUnsignedLongInt";
+    typeMap["long"] = "CLong";
+    typeMap["unsigned long"] = "CUnsignedLong";
+    typeMap["long long"] = "CLongLong";
+    typeMap["unsigned long long"] = "CUnsignedLongLong";
+    typeMap["size_t"] = "CSize";
+    typeMap["ptrdiff_t"] = "CPtrDiff";
+    typeMap["wchar_t"] = "CWideChar";
+    typeMap["char16_t"] = "CChar16";
+    typeMap["char32_t"] = "CChar32";
+    typeMap["float"] = "CFloat";
+    typeMap["double"] = "CDouble";
+    typeMap["long double"] = "CDouble";
 }
 
 std::shared_ptr<Type>
@@ -73,8 +73,8 @@ TypeTranslator::translatePointer(const clang::QualType &pte) {
         // Take care of char*
         if (as->getKind() == clang::BuiltinType::Char_S ||
             as->getKind() == clang::BuiltinType::SChar) {
-            // TODO: new PointerType(new PrimitiveType("native.CChar"))
-            return std::make_shared<PrimitiveType>("native.CString");
+            // TODO: new PointerType(new PrimitiveType("CChar"))
+            return std::make_shared<PrimitiveType>("CString");
         }
     }
 

bindgen/Utils.h

@@ -1,25 +1,31 @@
 #ifndef UTILS_H
 #define UTILS_H
 
+#include <iostream>
 #include "ir/TypeDef.h"
 #include "ir/types/Type.h"
 #include <clang/AST/AST.h>
 
-inline std::string uint64ToScalaNat(uint64_t v, std::string accumulator = "") {
+inline std::string uint64ToScalaNat(uint64_t v, std::string acc = "") {
     if (v == 0)
-        return accumulator;
+        return acc;
 
-    auto last_digit = v % 10;
-    auto rest = v / 10;
+    auto v_str = std::to_string(v);
+    auto len = v_str.length();
 
-    if (accumulator.empty()) {
-        return uint64ToScalaNat(rest,
-                                "native.Nat._" + std::to_string(last_digit));
+    if (len == 1) {
+        acc = acc + "Nat._" + v_str;
     } else {
-        return uint64ToScalaNat(rest, "native.Nat.Digit[native.Nat._" +
-                                          std::to_string(last_digit) + ", " +
-                                          accumulator + "]");
+        for (char const &c: v_str) {
+            if (acc.empty()) {
+                acc = acc + "Nat.Digit" + std::to_string(len) + "[Nat._" + c;
+            } else {
+                acc = acc + ", Nat._" + c;
+            }
+        }
+        acc = acc + "]";
     }
+    return acc;
 }
 
 static std::array<std::string, 39> reserved_words = {

bindgen/defines/DefineFinder.cpp

@@ -48,7 +48,7 @@ void DefineFinder::MacroDefined(const clang::Token &macroNameTok,
                                 stringToken.getLength());
             ir.addLiteralDefine(
                 macroName, "c" + literal,
-                std::make_shared<PrimitiveType>("native.CString"));
+                std::make_shared<PrimitiveType>("CString"));
         } else if (tokens->size() == 1 &&
                    (*tokens)[0].getKind() == clang::tok::identifier) {
             // token might be a variable
@@ -126,15 +126,15 @@ void DefineFinder::addNumericConstantDefine(const std::string &macroName,
         if (parser.isLongLong) {
             /* literal has `LL` ending. `long long` is represented as `Long`
              * in Scala Native */
-            type = "native.CLongLong";
+            type = "CLongLong";
 
             /* must fit into Scala integer type */
             if (!integerFitsIntoType<long, unsigned long>(parser, positive)) {
                 type.clear();
             }
         } else if (parser.isLong) {
             /* literal has `L` ending */
-            type = "native.CLong";
+            type = "CLong";
 
             /* must fit into Scala integer type */
             if (!integerFitsIntoType<long, unsigned long>(parser, positive)) {
@@ -146,13 +146,13 @@ void DefineFinder::addNumericConstantDefine(const std::string &macroName,
 
         if (!type.empty()) {
             scalaLiteral = getDecimalLiteral(parser);
-            if (type == "native.CLong" || type == "native.CLongLong") {
+            if (type == "CLong" || type == "CLongLong") {
                 scalaLiteral = scalaLiteral + "L";
             }
         }
     } else if (parser.isFloatingLiteral()) {
         if (fitsIntoDouble(parser)) {
-            type = "native.CDouble";
+            type = "CDouble";
             scalaLiteral = getDoubleLiteral(parser);
         }
     }
@@ -172,9 +172,9 @@ DefineFinder::getTypeOfIntegerLiteral(const clang::NumericLiteralParser &parser,
                                       bool positive) {
 
     if (integerFitsIntoType<int, uint>(parser, positive)) {
-        return "native.CInt";
+        return "CInt";
     } else if (integerFitsIntoType<long, unsigned long>(parser, positive)) {
-        return "native.CLong";
+        return "CLong";
     } else {
         llvm::errs() << "Warning: integer value does not fit into 8 bytes: "
                      << literal << "\n";

bindgen/ir/Enum.cpp

@@ -1,4 +1,5 @@
 #include "Enum.h"
+#include <sstream>
 
 Enumerator::Enumerator(std::string name, int64_t value)
     : name(std::move(name)), value(value) {}
@@ -29,11 +30,11 @@ std::string Enum::getEnumerators() const {
 
 std::string Enum::getTypeCastSuffix() const {
     std::string primitiveType = PrimitiveType::getType();
-    if (primitiveType == "native.CLong") {
+    if (primitiveType == "CLong") {
         return "L";
-    } else if (primitiveType == "native.CUnsignedInt") {
+    } else if (primitiveType == "CUnsignedInt") {
         return ".toUInt";
-    } else if (primitiveType == "native.CUnsignedLong") {
+    } else if (primitiveType == "CUnsignedLong") {
         return "L.toULong";
     }
     return "";

bindgen/ir/Function.cpp

@@ -17,7 +17,7 @@ std::string
 Function::getDefinition(const LocationManager &locationManager) const {
     std::stringstream s;
     if (scalaName != name) {
-        s << "  @native.link(\"" << name << "\")\n";
+        s << "  @link(\"" << name << "\")\n";
     }
     s << "  def " << handleReservedWords(scalaName) << "(";
     std::string sep = "";
@@ -29,9 +29,9 @@ Function::getDefinition(const LocationManager &locationManager) const {
     if (isVariadic) {
         /* the C Iso require at least one argument in a variadic function, so
          * the comma is fine */
-        s << ", " << getVarargsParameterName() << ": native.CVararg*";
+        s << ", " << getVarargsParameterName() << ": CVarArg*";
     }
-    s << "): " << retType->str(locationManager) << " = native.extern\n";
+    s << "): " << retType->str(locationManager) << " = extern\n";
     return s.str();
 }
 

bindgen/ir/IR.cpp

@@ -1,5 +1,6 @@
 #include "IR.h"
 #include "../Utils.h"
+#include <sstream>
 
 IR::IR(std::string libName, std::string linkName, std::string objectName,
        std::string packageName, const LocationManager &locationManager)
@@ -102,15 +103,15 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &s, const IR &ir) {
         return s;
     }
 
-    s << "import scala.scalanative._\n"
-      << "import scala.scalanative.native._\n\n";
+    s << "import scala.scalanative.unsigned._\n"
+      << "import scala.scalanative.unsafe._\n\n";
 
     if (!ir.functions.empty() || !ir.varDefines.empty() ||
         !ir.variables.empty()) {
         if (!ir.linkName.empty()) {
-            s << "@native.link(\"" << ir.linkName << "\")\n";
+            s << "@link(\"" << ir.linkName << "\")\n";
         }
-        s << "@native.extern\n";
+        s << "@extern\n";
     }
     s << "object " << handleReservedWords(ir.objectName) << " {\n";
 

bindgen/ir/IR.h

@@ -89,14 +89,14 @@ class IR {
      *
      * Example:
      * @code
-     * type __int32_t = native.CInt
+     * type __int32_t = CInt
      * type __darwin_pid_t = __int32_t
      * type pid_t = __darwin_pid_t
      * @endcode
      *
      * Becomes:
      * @code
-     * type pid_t = native.CInt
+     * type pid_t = CInt
      * @endcode
      *
      */

bindgen/ir/LocationManager.cpp

@@ -4,6 +4,7 @@
 #include "Struct.h"
 #include <fstream>
 #include <stdexcept>
+#include <sstream>
 
 LocationManager::LocationManager(std::string mainHeaderPath)
     : mainHeaderPath(std::move(mainHeaderPath)) {}