Tools and libraries to glue C/C++ APIs to high-level languages
Перейти к файлу
Salvage b4f261ea38 Simplify `IsTemplateParameterType` 2023-10-19 14:01:33 +01:00
.github Additional bump 2023-10-18 16:27:43 +01:00
build Default to .NET 5.0 if building for VS2019 or under. 2023-09-30 09:52:10 +01:00
docs
examples Fix SDL_PollEvent generation in the SDL example. 2023-10-18 17:40:15 +01:00
include
src Simplify `IsTemplateParameterType` 2023-10-19 14:01:33 +01:00
tests Fix #1251 three parameter equality operator 2023-10-19 14:01:33 +01:00
.gitattributes
.gitignore
.gitmodules
CHANGELOG.md
CONTRIBUTING.md
CppSharp.code-workspace
Directory.Build.props Fix source dir 2023-10-18 16:27:43 +01:00
Directory.Packages.props
LICENSE
README.md
nuget.config
version.json Update our version to 1.1. 2023-10-18 16:03:36 +01:00

README.md

CppSharp is a tool and set of libraries which facilitates the usage of native C/C++ code with the .NET ecosystem.

It consumes C/C++ header and library files and generates the necessary glue code to surface the native API as a managed API. Such an API can be used to consume an existing native library in your managed code or add managed scripting support to a native codebase.

The supported target languages at present are C# and C++/CLI.

It can also be used as a library to parse native code into a syntax tree with a rich declaration and type information model.

Releases/Build Status

NuGet Packages Continuous Integration
NuGet GitHub-actions
  1. Libraries
  2. Documentation
  3. Community
  4. Support
  5. Users

Libraries

AST

Mirrors the Clang's C/C++ AST and type system classes in C# APIs.

Check out Clang's AST introduction docs for more details about its architecture.

  • C++ declarations
  • C++ statements / expressions
  • C++ types
  • Class object layout
  • Declaration visitors
  • Type visitors

Parser

Provides APIs for parsing of C/C++ source code into a syntax tree.

  • Parsing of C/C++ source code
  • Parsing of libraries archives symbols
  • Parsing of shared libraries symbols
  • Based on the very accurate Clang C++ parser.

Generator

Generates the glue binding code from a syntax tree of the native code.

  • Multiple backends: C++/CLI and C# (P/Invoke)
  • Multiple ABIs: Itanium, MS, ARM, iOS
  • Multiple platforms: Windows, OS X and Linux
  • Multiple runtimes: .NET and Mono
  • C++ virtual methods overriding from managed code
  • C++ multiple inheritance by translating to C# interfaces
  • C++ std::string
  • C++ default parameter values
  • C/C++ semantic comments (Doxygen) to C# comments
  • Extensible bindings semantics via user passes and type mapping

Documentation

Please see the following resources for more information:

Getting Started

User's Manual

Developer's Manual

Community

Feel free to open up issues on Github for any problems you find.

Support

For building wrappers and priority support please write to cppsharp@protonmail.com. Alternatively, you may post bounties at https://www.bountysource.com/.

Users

CppSharp is used by the following projects:

Kythera AI

QtSharp

MonoGame

LLDBSharp

Xamarin

FFMPEG.net

FFmpeg bindings

Tizen bindings

libgd bindings

ChakraSharp

FFmpeg.AutoGen

GLFW3.NET

Please feel free to send us a pull request adding your own projects to the list above.