TODO: [LOGO]

CppBind

Description

CppBind is a software development tool that generates bindings between C++ and other languages. This innovative solution helps developers bridge a code written in a programming language with C++ code. It is an error-prone and complex process to accomplish the bridging process manually, especially for large projects — every time new changes are required. Moreover, developers must learn many things about C APIs that connect the target language with C++.

CppBind automates the process and solves the problems mentioned above.

The list of currently supported languages and additional information on their specifications can be found here. The tool can be extended to other languages as well. Also, it can be customized to generate bindings better fitting your needs.

Table of contents

• Installation

• Usage

• Tutorial

• Credits

• License

• Features

• How to contribute

Installation

There are some required steps to install and use CppBind. The installation steps are described here.

Usage

After installing CppBind, it is run through the command-line interface (CLI). CppBind CLI options are described here.

Tutorial

To configure and run CppBind, read our tutorial example, which is called “Hello User.” This tutorial will help you learn about the basic usage of CppBind and configure it for your project.

• Tutorial documentation: “Hello User” doc

• Tutorial GitHub sources: “Hello User” GitHub

Credits

The CppBind tool is developed and open-sourced by PicsArt, Inc.

License

CppBind is provided under the MIT license that can be found in the LICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

Features

CppBind supports the generation of bindings for many types of entities from C++ source code. For example, you can expose classes, methods, global functions, enums, exception types, nested structures, template types, etc., to the target language. Here is the list of the most important features of CppBind:

• Classes and structs

• Interfaces

• Nested types

• Methods

• Static methods

• Overloaded methods

• Operator overloading

• Single and multiple inheritance

• Enumerations

• Templates

• Exception handling

• Return value policy, keep alive policy

• Default arguments

• Nullables

• Object type preservation

• Properties and data accessors

• Standard library types (std::vector, std::map, etc.)

• Shared pointers

• Full featured code assistance

How to contribute

To contribute to this project, follow the rules described in the Contribution guide.

First Steps

• Installation prerequisites
• Supported languages
• Installation
• “Hello user” example

Binding With Examples

• Functions
  • Global functions
  • Overloaded methods
  • Static methods
  • Custom argument names and labels
  • Nullable arguments
  • Default arguments
  • Return value policies
  • Keep alive policy
• Classes/Structs
  • Nested Types
• Enums
• Inheritance
  • Single Inheritance
  • Multiple Inheritance
• Exception handling
• Templates
  • Class templates
  • Template Getters/Setters
• Operator Overloading
  • Overloading subscript operator

Advanced Topics

• Snippets
  • Code snippets
  • Type converter snippets
  • Action snippets
• Adding a custom type converter
• Add new language bindings generation
• Building Swift bindings with Xcode
• Object type preservation

Detailed Information

• Application configuration
  • APPLICATION
  • API
  • LOG
• Project Configuration
  • Section var_def
  • Section vars
  • Section rules
  • Section dir_vars
  • Section file_vars
  • Section type_vars
• Variable Definitions
• Generation instructions
• Command line interface
  • cppbind init
  • cppbind run
  • cppbind clean

FAQs

• Frequently asked questions

API Documentation

cppbind

CppBind is a tool to generate c++ bindings for various languages.

Indices and tables

• Index

• Module Index