Merge branch 'master' into output-name

Author: kornilova203

.travis.yml

@@ -4,11 +4,10 @@ compiler: gcc
 
 script:
  - docker-compose build $TEST_ENV
- - docker run --rm -ti scala-native-bindgen:$TEST_ENV /usr/include/ctype.h -name ctype --
- - docker-compose run --rm sbt-test
+ - docker-compose run $TEST_ENV
 
 matrix:
   include:
-  - env: TEST_ENV=ubuntu-16.04-llvm-dev
-  - env: TEST_ENV=ubuntu-16.04-llvm-6.0
-  - env: TEST_ENV=ubuntu-16.04-llvm-5.0
+  - env: TEST_ENV=ubuntu-18.04-llvm-dev
+  - env: TEST_ENV=ubuntu-18.04-llvm-6.0
+  - env: TEST_ENV=ubuntu-18.04-llvm-5.0

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Guide for contributors
+
+Scala Native Bindgen follows Scala Native's [contributing guidelines].
+Larger contributions should always begin by creating an issue to
+ensure that it is properly scoped.
+
+Important to note is that all contributors must have signed the [Scala CLA].
+
+ [contributing guidelines]: http://www.scala-native.org/en/latest/contrib/contributing.html
+ [Scala CLA]: https://www.lightbend.com/contribute/cla/scala
+
+## Developer Workflow
+
+Build the `scalaBindgen` tool:
+
+```sh
+mkdir target
+cd target
+cmake ..
+make
+
+# Alternatively rerun on change
+watchman-make -p '*.cpp' '*.h' --run 'make -C target'
+```
+
+In another terminal, run the test suite:
+
+```sh
+cd tests
+sbt ~test
+```
+
+## Coding Guidelines
+
+The C++ tool is built on Clang and Libtooling and should respect the conventions of
+LLVM and Clang tools. The code itself should adhere to the [LLVM Coding Standards],
+specifically:
+
+ - For code generation and error reporting use `llvm::outs()` and `llvm::errs()`.
+ - [Use `\n` instead of `std::endl`](https://llvm.org/docs/CodingStandards.html#avoid-std-endl)
+   and remember to flush when reporting errors.
+
+ [LLVM Coding Standards]: https://llvm.org/docs/CodingStandards.html

Dockerfile

@@ -1,36 +1,25 @@
-ARG UBUNTU_VERSION=16.04
+ARG UBUNTU_VERSION=18.04
 FROM ubuntu:$UBUNTU_VERSION
 
 RUN set -x \
  && apt update \
- && apt install -y apt-transport-https \
+ && apt install -y apt-transport-https gnupg2 ca-certificates \
  && echo "deb https://dl.bintray.com/sbt/debian /" > /etc/apt/sources.list.d/sbt.list \
  && apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 2EE0EA64E40A89B84B2DF73499E82A75642AC823 \
  && apt update \
- && apt install -y curl build-essential openjdk-8-jdk-headless sbt \
+ && apt install -y curl build-essential openjdk-8-jdk-headless sbt cmake make \
  && rm -rf /var/lib/apt/lists/*
 
-WORKDIR /cmake
-ARG CMAKE_ARCHIVE=cmake-3.11.2-Linux-x86_64
-RUN curl https://cmake.org/files/v3.11/$CMAKE_ARCHIVE.tar.gz | tar zxf - \
- && for i in bin share; do \
-      cp -r /cmake/$CMAKE_ARCHIVE/$i/* /usr/$i/; \
-    done \
- && rm -rf /cmake
-
 ARG LLVM_VERSION=6.0
+ENV LLVM_VERSION=$LLVM_VERSION
 # LLVM dev versions do not have a "-x.y" version suffix.
 ARG LLVM_DEB_COMPONENT=-$LLVM_VERSION
 RUN set -x \
  && curl https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - \
  && . /etc/lsb-release \
  && echo "deb https://apt.llvm.org/$DISTRIB_CODENAME/ llvm-toolchain-$DISTRIB_CODENAME$LLVM_DEB_COMPONENT main" > /etc/apt/sources.list.d/llvm.list \
  && apt update \
- && apt install -y clang-$LLVM_VERSION libclang-$LLVM_VERSION-dev make \
+ && apt install -y clang-$LLVM_VERSION libclang-$LLVM_VERSION-dev \
  && rm -rf /var/lib/apt/lists/*
 
-WORKDIR /src/target
-COPY . /src
-RUN cmake .. && make VERBOSE=1
-
-ENTRYPOINT ["/src/target/scala-native-bindgen"]
+WORKDIR /src

NEWS.md

@@ -0,0 +1,26 @@
+# Release notes
+
+## master
+
+Improvements:
+
+ - Save results from AST visitor in an intermediate representation. [#6], [#10]
+ - Add struct alloc helper. [mrRosset#3], [mrRosset#4]
+ - Simplify the build to link against system installed Clang libraries. [mrRosset#2]
+ - Use docker-compose to run tests against multiple LLVM versions on Travis. [#8], [#9]
+ - Migrate the test suite to Scala and sbt. [#17]
+ - Align code with LLVM Coding Standards. [#23]
+
+ [mrRosset#2]: https://github.com/mrRosset/scala-native-bindgen/pull/2
+ [mrRosset#3]: https://github.com/mrRosset/scala-native-bindgen/issues/3
+ [mrRosset#4]: https://github.com/mrRosset/scala-native-bindgen/pull/4
+ [#6]: https://github.com/kornilova-l/scala-native-bindgen/issues/6
+ [#8]: https://github.com/kornilova-l/scala-native-bindgen/pull/8
+ [#9]: https://github.com/kornilova-l/scala-native-bindgen/issues/9
+ [#10]: https://github.com/kornilova-l/scala-native-bindgen/pull/10
+ [#17]: https://github.com/kornilova-l/scala-native-bindgen/pull/17
+
+Based on work by [Marius Rosset][@mrRosset] done as part of a project at [EPFL].
+
+ [@mrRosset]: https://github.com/mrRosset
+ [EPFL]: https://www.epfl.ch/

README.md

@@ -25,12 +25,24 @@ cd target
 cmake ..
 make
 ./scala-native-bindgen /usr/include/ctype.h -name ctype --
+```
+
+Alternatively, you can use [docker-compose] to build and test the program:
+
+```sh
+# Build the docker image with LLVM version 6.0.
+docker-compose build ubuntu-18.04-llvm-6.0
+# Build the bindgen tool and run the tests.
+docker-compose run --rm ubuntu-18.04-llvm-6.0
+# Run the bindgen tool inside the container.
+docker-compose run --rm ubuntu-18.04-llvm-6.0 target/scalaBindgen -name union tests/samples/Union.h --
 ```
 
  [CMake]: https://cmake.org/
  [LLVM]: https://llvm.org/
  [Clang]: https://clang.llvm.org/
  [Scala Native setup guide]: http://www.scala-native.org/en/latest/user/setup.html
+ [docker-compose]: https://docs.docker.com/compose/
 
 ## Testing
 

TypeTranslator.cpp

@@ -153,7 +153,7 @@ std::string TypeTranslator::Translate(const clang::QualType& qtpe, const std::st
         return TranslatePointer(tpe->getAs<clang::PointerType>()->getPointeeType(), avoid);
 
     } else if(qtpe->isStructureType() || qtpe->isUnionType()){
-        return TranslateStructOrUnion(qtpe);
+        return handleReservedWords(TranslateStructOrUnion(qtpe));
 
     } else if(qtpe->isEnumeralType()){
         return TranslateEnum(qtpe);
@@ -166,10 +166,10 @@ std::string TypeTranslator::Translate(const clang::QualType& qtpe, const std::st
 
         auto found = typeMap.find(qtpe.getUnqualifiedType().getAsString());
         if(found != typeMap.end()){
-            return found->second;
+            return handleReservedWords(found->second);
         } else {
             //TODO: Properly handle non-default types
-            return qtpe.getUnqualifiedType().getAsString();
+            return handleReservedWords(qtpe.getUnqualifiedType().getAsString());
         }
     }
 

Utils.h

@@ -68,12 +68,12 @@ static std::array<std::string, 39> reserved_words = {"abstract", "case", "catch"
                                       "protected", "return", "sealed", "super", "this", "throw", "trait", "try",
                                       "true", "type", "val", "var", "while", "with", "yield"};
 
-inline std::string handleReservedWords(std::string name){
+inline std::string handleReservedWords(std::string name, std::string suffix = "") {
     auto found = std::find(reserved_words.begin(), reserved_words.end(), name);
-    if(found != reserved_words.end()){
-        return "`" + name + "`";
-    } else{
-        return name;
+    if (found != reserved_words.end()) {
+        return "`" + name + suffix + "`";
+    } else {
+        return name + suffix;
     }
 }
 

docker-compose.yml

@@ -1,39 +1,42 @@
 version: '3'
 
 services:
-  ubuntu-16.04-llvm-dev:
-    image: scala-native-bindgen:ubuntu-16.04-llvm-dev
+  ubuntu-18.04-llvm-dev:
+    image: scalabindgen/scala-native-bindgen:ubuntu-18.04-llvm-dev
     build:
       context: .
       args:
-        - UBUNTU_VERSION=16.04
+        - UBUNTU_VERSION=18.04
         - LLVM_VERSION=7
         - LLVM_DEB_COMPONENT=
+    command: scripts/test.sh
+    volumes:
+      - .:/src
+      - ${HOME}/.ivy2:/root/.ivy2
+      - ${HOME}/.sbt:/root/.sbt
 
-  ubuntu-16.04-llvm-6.0:
-    image: scala-native-bindgen:ubuntu-16.04-llvm-6.0
+  ubuntu-18.04-llvm-6.0:
+    image: scalabindgen/scala-native-bindgen:ubuntu-18.04-llvm-6.0
     build:
       context: .
       args:
-        - UBUNTU_VERSION=16.04
+        - UBUNTU_VERSION=18.04
         - LLVM_VERSION=6.0
+    command: scripts/test.sh
+    volumes:
+      - .:/src
+      - ${HOME}/.ivy2:/root/.ivy2
+      - ${HOME}/.sbt:/root/.sbt
 
-  ubuntu-16.04-llvm-5.0:
-    image: scala-native-bindgen:ubuntu-16.04-llvm-5.0
+  ubuntu-18.04-llvm-5.0:
+    image: scalabindgen/scala-native-bindgen:ubuntu-18.04-llvm-5.0
     build:
       context: .
       args:
-        - UBUNTU_VERSION=16.04
+        - UBUNTU_VERSION=18.04
         - LLVM_VERSION=5.0
-
-  sbt-test:
-    image: scala-native-bindgen:${TEST_ENV}
-    entrypoint: 
-    - sh
-    - -c
-    - |
-      cd /src/tests
-      sbt compile test
+    command: scripts/test.sh
     volumes:
+      - .:/src
       - ${HOME}/.ivy2:/root/.ivy2
       - ${HOME}/.sbt:/root/.sbt

ir/Struct.cpp

@@ -46,10 +46,11 @@ std::string Struct::generateHelperClass() const {
     int fieldIndex = 0;
     for (const auto &field : fields) {
         if (!field.getName().empty()) {
-            std::string fname = handleReservedWords(field.getName());
+            std::string getter = handleReservedWords(field.getName());
+            std::string setter = handleReservedWords(field.getName(), "_=");
             std::string ftype = field.getType();
-            s << "    def " << fname << ": " << ftype << " = !p._" << std::to_string(fieldIndex + 1) << "\n"
-              << "    def " << fname << "_=(value: " + ftype + "):Unit = !p._" << std::to_string(fieldIndex + 1)
+            s << "    def " << getter << ": " << ftype << " = !p._" << std::to_string(fieldIndex + 1) << "\n"
+              << "    def " << setter << "(value: " + ftype + "):Unit = !p._" << std::to_string(fieldIndex + 1)
               << " = value\n";
         }
         fieldIndex++;
@@ -81,13 +82,14 @@ std::string Union::generateHelperClass() const {
       << "(val p: native.Ptr[union_" << name << "]) extends AnyVal {\n";
     for (const auto &field : fields) {
         if (!field.getName().empty()) {
-            std::string fname = handleReservedWords(field.getName());
+            std::string getter = handleReservedWords(field.getName());
+            std::string setter = handleReservedWords(field.getName(), "_=");
             std::string ftype = field.getType();
-            s << "    def " << fname
+            s << "    def " << getter
               << ": native.Ptr[" << ftype << "] = p.cast[native.Ptr[" << ftype << "]]\n";
 
-            s << "    def " << fname
-              << "_=(value: " << ftype << "): Unit = !p.cast[native.Ptr[" << ftype << "]] = value\n";
+            s << "    def " << setter
+              << "(value: " << ftype << "): Unit = !p.cast[native.Ptr[" << ftype << "]] = value\n";
         }
     }
     s << "  }\n";

scripts/test.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# Bash strict mode
+# http://redsymbol.net/articles/unofficial-bash-strict-mode/
+set -euo pipefail
+IFS=$'\n\t'
+
+if [[ ! -e target/.llvm-version ]] || [[ "$(<target/.llvm-version)" != "${LLVM_VERSION:-}" ]]; then
+  rm -rf target
+  mkdir -p target
+  echo "${LLVM_VERSION:-}" > target/.llvm-version
+  (cd target && cmake ..)
+  make -C target
+fi
+
+cd tests
+sbt "${@:-test}"