Bridge :: Scapix Language Bridge

Introduction

Mon, 01 Jan 0001 00:00:00 +0000

Introduction to Scapix Language Bridge

Examples

Mon, 01 Jan 0001 00:00:00 +0000

Minimal example: tiny_bridge git clone https://github.com/scapix-com/tiny_bridge cd tiny_bridge cmake -B build -DSCAPIX_BRIDGE=java Minimal example (ObjC/Swift): scapix_example_objc git clone https://github.com/scapix-com/scapix_example_objc cd scapix_example_objc/cpplib ./cmake_generate.sh Extended example (all languages): example1 git clone https://github.com/scapix-com/example1 cd example1 ./buils.sh

Tutorial

Mon, 01 Jan 0001 00:00:00 +0000

Step by step instructions on building and running example1 project. C#

CMake Integration

Mon, 01 Jan 0001 00:00:00 +0000

Integrating Scapix into CMake project

Optional Integration

Mon, 01 Jan 0001 00:00:00 +0000

Optionally integrate Scapix into your project

Types

Mon, 01 Jan 0001 00:00:00 +0000

Scapix generates bindings for functions with supported parameter types and return type. Functions with unsupported types in parameters or return value are ignored. Portable types: classes derived from scapix::bridge::object void bool std::int8_t std::int16_t std::int32_t std::int64_t std::uint8_t std::uint16_t std::uint32_t std::uint64_t float double std::shared_ptr std::string (always in UTF-8 encoding) std::vector std::map std::set std::unordered_map std::unordered_set std::function enum (as underlying integer type) struct (all non-static data members are public) Non-portable types: char signed char short int long long long unsigned char unsigned short unsigned int unsigned long unsigned long long Supported types may be nested arbitrarily. Classes derived from scapix::bridge::object are bridged by reference and supported in Scapix bindings only when passed as std::shared_ptr. All other types are bridged by copy. Supported type may be passed or returned by value (Type), by const reference (const Type&) or by rvalue reference (Type&&). Non-const lvalue reference (Type&) is intentionally unsupported. struct should be defined in the same header where it is used as a parameter or return value (this limitation will be lifted in a future version). Use callbacks to call bridged language from C++ Type mappings:

Callbacks

Mon, 01 Jan 0001 00:00:00 +0000

There are two ways to call from C++ to bridged languages: Use std::function<> parameter to send callback routine to C++ Implement C++ interface in bridged language (override C++ virtual functions) Overriding C++ virtual functions is currently supported by Python and JavaScript bridge, support for other languages coming soon.

Bridge Object

Mon, 01 Jan 0001 00:00:00 +0000

Any C++ class in cross-platform part of your project can be automatically bridged to other languages to expose it to UI code written in ObjC, Swift or Java. Just derive your class from scapix::bridge::object: #include class user_info : public scapix::bridge::object { public: //... }; The lifetime of scapix::bridge::object should always be managed by std::shared_ptr / std::weak_ptr void create() { auto u1 = std::make_shared(); // Ok auto u2 = std::shared_ptr(new user_info); // Ok user_info u3; // Wrong!!! } If you need the functionality of std::enable_shared_from_this, you can derive your classes from both scapix::bridge::object and std::enable_shared_from_this:

Project Layout

Mon, 01 Jan 0001 00:00:00 +0000

Suggested project layout

Motivation

Mon, 01 Jan 0001 00:00:00 +0000

Comparison to existing solutions

Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Supported host platforms macOS arm64 (Apple silicon) macOS x86_64 Windows x64 Linux x86_64 (Ubuntu 22.04 x86_64 or compatible) Tools Git CMake C++20 compiler (Clang, GCC, MSVC, etc.) Python (only for Python bridge) Emscripten SDK (only for JavaScript bridge)

Known issues

Mon, 01 Jan 0001 00:00:00 +0000

Android Studio build sometimes fails after updating Scapix version, etc. Use Android Studio menu command: Build / Refresh Linked C++ Projects Build errors on Windows caused by 260 characters path limitation For example, you may receive error The CXX compiler identification is unknown when building Python bridge on Windows. To fix this, enable Windows long path support available starting from Windows 10 version 1607 (released in July 2016):