CppSharp/README.md

**CppSharp has been selected for participation in the Google Summer of Code 2017!**

We are looking for volunteers to write code for CppSharp in the summer of 2017. Please check our task at http://www.mono-project.com/community/google-summer-of-code/projects/#cppsharp--maintenance--improvement-tasks.



CppSharp is a tool and set of libraries which allows programmmers to use
C/C++ libraries with high-level programming languages (such as C#).

It is a tool that takes C/C++ header and library files and generates the 
necessary glue to surface the native API as a managed API. Such an API can be
used to consume an existing native library in your high-level code or add
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

|Windows 64-bit|Windows 32-bit| windows-vs-x86            | linux-gcc-x86_64            | osx-clang-x86               |
|---------------------------|---------------------------|---------------------------|-----------------------------|-----------------------------|
| [![NuGet][1]][2] | [![GitHub release][3]][4] | [![windows-vs-x86][5]][6] | [![linux-gcc-x86_64][7]][8] | [![osx-clang-x86][7]][8]

[1]: https://img.shields.io/nuget/v/CppSharp.svg
[2]: https://www.nuget.org/packages/CppSharp/
[3]: https://img.shields.io/github/release/mono/CppSharp.svg
[4]: https://github.com/mono/CppSharp/releases
[5]: https://ci.appveyor.com/api/projects/status/5o9gxjcttuaup671/branch/master?svg=true
[6]: https://ci.appveyor.com/project/tritao/CppSharp/branch/master
[7]: https://travis-ci.org/mono/CppSharp.svg?branch=master
[8]: https://travis-ci.org/mono/CppSharp

1. [Libraries](#libraries)
2. [Documentation](#documentation)
3. [Community](#community)
4. [Support](#support)
5. [Users](#users)

## Libraries

### AST 

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

Check out [_Clang's AST introduction docs_](http://clang.llvm.org/docs/IntroductionToTheClangAST.html) for more details about its architecture.
 
 * C++ declarations
 * 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++ standard library types (work-in-progress)
 * 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](docs/GettingStarted.md)

[User's Manual](docs/UsersManual.md)

[Developer's Manual](docs/DevManual.md)

## Community

Feel free to open up issues on Github with any questions

Mailing list: [Google group](https://groups.google.com/forum/#!forum/cppsharp-list)

## 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:

[QtSharp](https://gitlab.com/ddobrev/QtSharp)

[MonoGame](https://github.com/mono/MonoGame)

[LLDBSharp](https://github.com/tritao/LLDBSharp)

[Xamarin](http://xamarin.com/)

[FFMPEG.net](https://github.com/crazyender/FFMPEG.net)

[FFmpeg bindings](https://github.com/InitialForce/FFmpeg_bindings)

[Tizen bindings](https://github.com/kitsilanosoftware/CppSharpTizen)

[libgd bindings](https://github.com/imazen/deprecated-gd-bindings-generator-old)

[ChakraSharp](https://github.com/baristalabs/ChakraSharp)

[FFmpeg.AutoGen](https://github.com/Ruslan-B/FFmpeg.AutoGen)

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