Merge pull request #157 from kornilova-l/gsoc-report

Update readme for GSoC report

Author: kornilova203

README.md

@@ -1,28 +1,70 @@
-# Scala Native Binding generator
+# Scala Native Binding Generator
 
 [![Build Status](https://travis-ci.com/kornilova-l/scala-native-bindgen.svg?branch=master)](https://travis-ci.com/kornilova-l/scala-native-bindgen)
 
-This tool generates Scala Native bindings from C headers. It's built upon clang and Libtooling and thus respects the conventions of clang-tools.
+The tool generates Scala Native bindings from C headers.
 
-[Documentation](https://kornilova-l.github.io/scala-native-bindgen/)
+## Documentation
 
-## Releasing
+Documentation can be found at [kornilova-l.github.io/scala-native-bindgen](https://kornilova-l.github.io/scala-native-bindgen/).
 
-First build the `scala-native-bindgen` executable for both macOS and
-Linux:
+## Bindgen Features
 
-    > scripts/prepare-release.sh
+* possibility to reuse types from existing bindings.
+* type casts that make recursive structs be valid Scala Native structs.
+* implicit classes for structs and unions that make fields access easier.
+* implicit classes that add setters and getters to structs with more than 22 fields (such structs in Scala
+  Native are represented as arrays of bytes).
+* literal defines embedding `#define MY_CONSTANT 42` → `val MY_CONSTANT: native.CInt = 42`.
+* read-only bindings for extern variables (such variables cannot be updated due to Scala Native limitation).
+* declarations filtering by prefix.
 
-You should now have `scala-native-bindgen-linux` and
-`scala-native-bindgen-darwin` if you ran the script on a macOS machine.
+## Example
 
-Then release version `x.y.z` by running:
+```c
+struct point {
+    float x;
+    float y;
+};
 
-    > sbt -Dproject.version=x.y.z release
+struct vector {
+    struct point a;
+    struct point b;
+};
 
-Finally, upload the `scala-native-bindgen-linux` and
-`scala-native-bindgen-darwin` executables to the release page at:
-<https://github.com/kornilova-l/scala-native-bindgen/releases/tag/vx.y.z>
+struct vector *add(struct vector *v1, struct vector *v2);
+```
+
+```scala
+import scala.scalanative._
+import scala.scalanative.native._
+
+@native.link("vector")
+@native.extern
+object vector {
+  type struct_point = native.CStruct2[native.CFloat, native.CFloat]
+  type struct_vector = native.CStruct2[struct_point, struct_point]
+  def add(v1: native.Ptr[struct_vector], v2: native.Ptr[struct_vector]): native.Ptr[struct_vector] = native.extern
+
+  object implicits {
+    implicit class struct_point_ops(val p: native.Ptr[struct_point]) extends AnyVal {
+      def x: native.CFloat = !p._1
+      def x_=(value: native.CFloat): Unit = !p._1 = value
+      def y: native.CFloat = !p._2
+      def y_=(value: native.CFloat): Unit = !p._2 = value
+    }
+    def struct_point()(implicit z: native.Zone): native.Ptr[struct_point] = native.alloc[struct_point]
+
+    implicit class struct_vector_ops(val p: native.Ptr[struct_vector]) extends AnyVal {
+      def a: native.Ptr[struct_point] = p._1
+      def a_=(value: native.Ptr[struct_point]): Unit = !p._1 = !value
+      def b: native.Ptr[struct_point] = p._2
+      def b_=(value: native.Ptr[struct_point]): Unit = !p._2 = !value
+    }
+    def struct_vector()(implicit z: native.Zone): native.Ptr[struct_vector] = native.alloc[struct_vector]
+  }
+}
+```
 
 ## License