Add TextSort example from snapchat

Author: mutagene

.github/workflows/build.yml

@@ -123,6 +123,26 @@ jobs:
       working-directory: build/test-suite
       run: ctest -C Release -V
 
+  build-on-ubuntu-for-wasm:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: asdf-vm/actions/install@v1
+    - name: Install dependencies
+      uses: py-actions/py-dependency-install@v3
+      with:
+        path: "requirements.txt"
+    - name: Setup EMSDK
+      uses: mymindstorm/setup-emsdk@v11
+      with:
+        version: 3.1.44
+    - name: Report cmake version
+      run: cmake --version
+    - name: Configure cmake
+      run: cmake -S . -B build -DDJINNI_WITH_WASM=ON
+    - name: Build release
+      run: cmake --build build --parallel $(nproc) --config Release
+     
 
   build-on-windows-for-cppcli:
     runs-on: windows-latest

CMakeLists.txt

@@ -10,6 +10,8 @@ project(djinni_support_lib CXX ${PROJECT_LANGUAGES})
 
 include(GNUInstallDirs)
 
+include(cmake/Djinni.cmake)
+
 set(SRC_SHARED
   "djinni/djinni_common.hpp"
   "djinni/proxy_cache_interface.hpp"
@@ -211,5 +213,6 @@ option(DJINNI_BUILD_TESTING "Build tests" ON)
 
 include(CTest)
 if (BUILD_TESTING AND DJINNI_BUILD_TESTING)
+  add_subdirectory(examples)
   add_subdirectory(test-suite)
 endif()

test-suite/Djinni.cmake renamed to cmake/Djinni.cmake

@@ -450,6 +450,7 @@ function(add_djinni_target)
 
     resolve_djinni_outputs(COMMAND "${DJINNI_TS_GENERATION_COMMAND}" RESULT TS_OUT_FILES)
 
+    message(STATUS "Output: ${TS_OUT_FILES}, Depends: ${DJINNI_INPUTS}, Command: ${DJINNI_TS_GENERATION_COMMAND}")
     add_custom_command(
       OUTPUT ${TS_OUT_FILES}
       DEPENDS ${DJINNI_INPUTS}

examples/CMakeLists.txt

@@ -0,0 +1,103 @@
+cmake_minimum_required(VERSION 3.6.0)
+
+set(CMAKE_CXX_STANDARD 17)
+
+if(APPLE)
+    set(MACOSX_RPATH TRUE)
+    set(CMAKE_MACOSX_RPATH ${CMAKE_CURRENT_BINARY_DIR})
+endif()
+
+enable_testing()
+
+add_djinni_target(DjinniTextSort
+  IDL "example.djinni"
+#  IDL_INCLUDE_PATH "djinni/vendor"
+  CPP_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/cpp"
+  CPP_NAMESPACE "textsort"
+  IDENT_CPP_ENUM_TYPE "foo_bar"
+  CPP_EXTENDED_RECORD_INCLUDE_PREFIX "handwritten-src/cpp/"
+  CPP_ENUM_HASH_WORKAROUND
+  JAVA_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/java"
+  JAVA_PACKAGE "com.dropbox.textsort"
+  JAVA_GENERATE_INTERFACES
+  JAVA_IMPLEMENT_ANDROID_OS_PARCELABLE
+  JAVA_NULLABLE_ANNOTATION "javax.annotation.CheckForNull"
+  JAVA_NONNULL_ANNOTATION "javax.annotation.Nonnull"
+  IDENT_JAVA_FIELD "mFooBar"
+  JNI_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/jni"
+  IDENT_JNI_CLASS "NativeFooBar"
+  IDENT_JNI_FILE "NativeFooBar"
+  OBJC_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/objc"
+  OBJC_TYPE_PREFIX "DB"
+  OBJCPP_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/objc"
+  CPPCLI_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/cppcli"
+  CPPCLI_NAMESPACE "Djinni::TestSuite"
+  CPPCLI_INCLUDE_CPP_PREFIX "cpp/"
+  WASM_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/wasm"
+  TS_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/ts"
+  TS_MODULE "example"
+  YAML_OUT "${CMAKE_CURRENT_BINARY_DIR}/generated-src/yaml"
+  YAML_PREFIX "test_"
+
+  CPP_OUT_FILES     CPP_GENERATED_SRCS
+  JAVA_OUT_FILES    JAVA_GENERATED_SRCS
+  JNI_OUT_FILES     JNI_GENERATED_SRCS
+  OBJC_OUT_FILES    OBJC_GENERATED_SRCS
+  OBJCPP_OUT_FILES  OBJCPP_GENERATED_SRCS
+  CPPCLI_OUT_FILES  CPPCLI_GENERATED_SRCS
+  WASM_OUT_FILES    WASM_GENERATED_SRCS
+  TS_OUT_FILES      TS_GENERATED_SRCS
+  YAML_OUT_FILE     YAML_GENERATED_SRCS
+)
+
+if(DJINNI_WITH_WASM)
+  set(DjinniTextsortWasm "textsort-wasm")
+
+  set(CPP_HANDWRITTEN_SRCS 
+      ${CMAKE_CURRENT_SOURCE_DIR}/handwritten-src/cpp/sort_items_impl.cpp
+  )
+
+  add_executable(${DjinniTextsortWasm} 
+      ${CPP_HANDWRITTEN_SRCS}
+      ${CPP_GENERATED_SRCS}
+      ${WASM_GENERATED_SRCS}
+      ${TS_GENERATED_SRCS}
+    )
+    target_include_directories(${DjinniTextsortWasm} PUBLIC
+      ${CMAKE_SOURCE_DIR}
+      ${CMAKE_CURRENT_SOURCE_DIR}/handwritten-src/cpp
+      ${CMAKE_CURRENT_BINARY_DIR}/generated-src/cpp
+      ${CMAKE_CURRENT_BINARY_DIR}/generated-src/wasm
+    )
+
+    set(WASM_CC_FLAGS "-s MAIN_MODULE=1 -fexceptions")
+    message(WARNING ${WASM_CC_FLAGS})
+    set_target_properties(${DjinniTextsortWasm} PROPERTIES COMPILE_FLAGS ${WASM_CC_FLAGS})
+    
+    string(JOIN " " EMSCRIPTEN_LINK_OPTIONS
+      "-s WASM=1"
+      "--bind"  # Compiles the source code using the Embind bindings to connect C/C++ and JavaScript
+      "-s MALLOC=emmalloc"  # Switch to using the much smaller implementation
+      "-s MODULARIZE=1"  # Allows us to manually invoke the initialization of wasm
+      "-s WASM_BIGINT=1" # We need to pass int64_t
+    )
+
+    set(WASM_LINK_FLAGS "${EMSCRIPTEN_LINK_OPTIONS} -fexceptions")
+    message(WARNING ${WASM_LINK_FLAGS})
+    set_target_properties(${DjinniTextsortWasm} PROPERTIES LINK_FLAGS ${WASM_LINK_FLAGS})
+    set(CMAKE_EXECUTABLE_SUFFIX ".js")
+    
+    target_link_libraries(${DjinniTextsortWasm} PUBLIC djinni-support-lib::djinni-support-lib embind)
+
+    add_custom_target(DjinniTextsortWasmCopy)
+    file(GLOB DjinniTextsortWasmResources ${CMAKE_CURRENT_SOURCE_DIR}/ts/*)
+    foreach(ResourceFile ${DjinniTextsortWasmResources})
+      add_custom_command(TARGET ${DjinniTextsortWasm} PRE_BUILD
+                        COMMAND ${CMAKE_COMMAND} -E
+                            copy ${ResourceFile} $<TARGET_FILE_DIR:${DjinniTextsortWasm}>)
+    endforeach()
+    add_dependencies(${DjinniTextsortWasm} DjinniTextsortWasmCopy)
+
+    # add_test(NAME DjinniWasmTestTests COMMAND bash -c "${CMAKE_CURRENT_BINARY_DIR}/run.sh")
+
+endif()

examples/example.djinni

@@ -0,0 +1,22 @@
+item_list = record {
+    items: list<string>;
+}
+
+sort_order = enum {
+    ascending;
+    descending;
+    random;
+}
+
+sort_items = interface +c {
+    # For the iOS / Android demo
+    sort(order: sort_order, items: item_list);
+    static create_with_listener(listener: textbox_listener): sort_items;
+
+    # For the localhost / command-line demo
+    static run_sort(items: item_list): item_list;
+}
+
+textbox_listener = interface +j +o +w {
+    update(items: item_list);
+}

examples/example.yaml

@@ -0,0 +1,71 @@
+# This is an example YAML file for being imported in other projects.
+# It holds all necessary information for Djinni to integrate foreign types into the generated code.
+# All fields are mandatory.
+---
+# The name to refer to this type in other .djinni files.
+# It must be unique in the entire Djinni run, so you should pick a unique prefix for your framework/library.
+name: mylib_record1
+# Specifies what kind of type this is.
+# Supports the same syntax as is used to declare types in .djinni files.
+# Examples: 'interface +c', 'record deriving(eq, or)', 'enum', 'flags', 'interface +j +o'
+# This determines how Djinni integrates this type into function parameters, fields or return types and operators.
+typedef: 'record +c deriving(eq, ord)'
+# The (potentially empty) list of required type parameters.
+params: [type_param1, type_param2]
+# This string is stripped from the value specified under "name" to ensure Djinni is referencing the correct typename in code.
+# May be an empty string if you don't have a prefix (bad!)
+prefix: 'mylib'
+cpp:
+  # The name of this type in C++ (without template arguments). Should be fully qualified.
+  typename: '::mylib::Record1'
+  # The header required in C++ to use your type. Must include "" or <>.
+  header: '"MyLib/Record1.hpp"'
+  # Only used for "record" types: determines whether it should be passed by-value in C++.
+  # If this is false it is always passed as const&
+  byValue: false
+objc:
+  # The name of this type in Objective-C.
+  typename: 'MLBRecord1'
+  # The header required in Objective-C to use your type.
+  header: '"MLB/MLBRecord1.h"'
+  # Only used for "record" types: determines the type used when boxing the record is required.
+  # Should not contain the pointer asterisk "*", protocols are not supported.
+  # This files is the same as "typename" most of the time as records are typically NSObjects and require no special boxing.
+  # However, some may not, for example NSTimeInterval is boxed to NSNumber.
+  boxed: 'MLBRecord1'
+  # Specifies whether the unboxed type is a pointer.
+  pointer: true
+  # If the type is a "record" and has "eq" deriving then this string must not be empty.
+  # It declares a well-formed expression with a single "%s" format placeholder replaced with the variable for which the hash code is needed
+  hash: '%s.hash'
+objcpp:
+  # The fully qualified name of the class containing the toCpp/fromCpp methods.
+  translator: '::mylib::djinni::objc::Record1'
+  # Where to find the translator class.
+  header: '"mylib/djinni/objc/Record1.hpp"'
+java:
+  # The name of the (fully qualified) Java type to be used.
+  typename: 'com.example.mylib.Record1'
+  # Only used for "record" types: determines the type used when boxing the record is required.
+  # This field is the same as "typename" most of the time as records are typically Objects and require no special boxing.
+  # However maybe your record has a dedicated boxed type and this field allows you to control that.
+  boxed: 'com.example.mylib.Record1'
+  # If this is true "typename" is an Object reference (and not a builtin).
+  reference: true
+  # Controls whether the type parameters as specified in "params" are forwarded as generics to Java.
+  # This is useful when templates are only used in C++ (e.g. std::chrono::duration<rep, period> versus java.time.Duration)
+  # This should be true by default (even if your type has no parameters) and only set to false if required
+  generic: true
+  # If the type is a "record" and has "eq" deriving then this string must not be empty.
+  # It declares a well-formed expression with a single "%s" format placeholder replaced with the variable for which the hash code is needed
+  hash: '%s.hashCode()'
+jni:
+  # The fully qualified name of the class containing the toCpp/fromCpp methods.
+  translator: '::mylib::djinni::jni::Record1'
+  # Where to find the translator class.
+  header: '"mylib/djinni/jni/Record1.hpp"'
+  # The type used for representations in JNI (jobject, jint, jbyteArray, etc)
+  typename: jobject
+  # The mangled type signature of your type to be found by JNI.
+  # See the JNI docs for its format
+  typeSignature: 'Lcom/example/mylib/Record1;'

examples/handwritten-src/cpp/sort_items_impl.cpp

@@ -0,0 +1,46 @@
+#include <algorithm>
+#include <random>
+
+#include "item_list.hpp"
+#include "sort_order.hpp"
+
+#include "sort_items_impl.hpp"
+
+namespace textsort {
+
+std::shared_ptr<SortItems> SortItems::create_with_listener(const std::shared_ptr<TextboxListener>& listener) {
+    return std::make_shared<SortItemsImpl>(listener);
+}
+
+SortItemsImpl::SortItemsImpl (const std::shared_ptr<TextboxListener> & listener) {
+    this->m_listener = listener;
+}
+
+void SortItemsImpl::sort(sort_order order, const ItemList & items) {
+    auto lines = items.items;
+    switch (order) {
+        case sort_order::ASCENDING: {
+            std::sort(lines.begin(), lines.end(), std::less<std::string>());
+            break;
+        }
+        case sort_order::DESCENDING: {
+            std::sort(lines.begin(), lines.end(), std::greater<std::string>());
+            break;
+        }
+        case sort_order::RANDOM: {
+            std::shuffle(lines.begin(), lines.end(), std::default_random_engine{});
+            break;
+        }
+    }
+
+    // Pass result to client interface
+    this->m_listener->update(ItemList(lines));
+}
+
+ItemList SortItems::run_sort(const ItemList & items) {
+    auto lines = items.items;
+    std::sort(lines.begin(), lines.end(), std::less<std::string>());
+    return ItemList(lines);
+}
+
+}

examples/handwritten-src/cpp/sort_items_impl.hpp

@@ -0,0 +1,19 @@
+#pragma once
+
+#include "sort_items.hpp"
+#include "textbox_listener.hpp"
+
+namespace textsort {
+
+class SortItemsImpl : public SortItems {
+
+public:
+    SortItemsImpl(const std::shared_ptr<TextboxListener> & listener);
+    virtual void sort(sort_order order, const ItemList & items) override;
+
+private:
+    std::shared_ptr<TextboxListener> m_listener;
+
+};
+
+}

examples/handwritten-src/java/com/dropbox/textsort/MainActivity.java

@@ -0,0 +1,50 @@
+package com.dropbox.textsort;
+
+import android.app.Activity;
+import android.os.Bundle;
+import android.view.View;
+import android.widget.EditText;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+
+public class MainActivity extends Activity {
+
+    private EditText text;
+    private SortItems sortItemsInterface;
+    private TextboxListener textboxListener;
+
+    static {
+        System.loadLibrary("android-app");
+    }
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_main);
+
+        text = (EditText) findViewById(R.id.editText);
+        textboxListener = new TextboxListenerImpl(text);
+        // Call JNI to initiate the SortItems object from the given textboxListener and translate to Java
+        sortItemsInterface = SortItems.createWithListener(textboxListener);
+    }
+
+    public void sort(SortOrder order) {
+        String str = text.getText().toString();
+        ArrayList<String> items = new ArrayList<String>(Arrays.asList(str.split("\n")));
+        ItemList itemList = new ItemList(items);
+        sortItemsInterface.sort(order, itemList);
+    }
+
+    public void sortAsc(View view) {
+        this.sort(SortOrder.ASCENDING);
+    }
+
+    public void sortDesc(View view) {
+        this.sort(SortOrder.DESCENDING);
+    }
+
+    public void sortRandom(View view) {
+        this.sort(SortOrder.RANDOM);
+    }
+}

examples/handwritten-src/java/com/dropbox/textsort/TextboxListenerImpl.java

@@ -0,0 +1,25 @@
+package com.dropbox.textsort;
+
+import android.widget.EditText;
+
+import java.util.ArrayList;
+
+public class TextboxListenerImpl extends TextboxListener {
+
+    private EditText mTextArea;
+
+    public TextboxListenerImpl(EditText textArea) {
+        this.mTextArea = textArea;
+    }
+
+    @Override
+    public void update(ItemList items) {
+        ArrayList<String> list = items.getItems();
+        StringBuilder builder = new StringBuilder();
+        for (String str : list) {
+            builder.append(str);
+            builder.append("\n");
+        }
+        mTextArea.setText(builder);
+    }
+}