CppAst 0.21.1
dotnet add package CppAst --version 0.21.1
NuGet\Install-Package CppAst -Version 0.21.1
<PackageReference Include="CppAst" Version="0.21.1" />
paket add CppAst --version 0.21.1
#r "nuget: CppAst, 0.21.1"
// Install CppAst as a Cake Addin #addin nuget:?package=CppAst&version=0.21.1 // Install CppAst as a Cake Tool #tool nuget:?package=CppAst&version=0.21.1
CppAst.NET
<img align="right" width="160px" height="160px" src="https://raw.githubusercontent.com/xoofx/CppAst.NET/main/img/cppast.png">
CppAst provides a C/C++ parser for header files with access to the full AST, comments and macros for .NET Framework and .NET Core
Purpose
The target primary usage of this library is to serve as a simple foundation for domain oriented PInvoke/Interop codegen
Features
- Compatible with
net8.0
- For
netstandard2.0
use0.14.0
version.
- For
- Using
Clang/libclang 18.1.0
- Allow to parse in-memory C/C++ text and C/C++ files from the disk
- Simple AST model
- Full type system
- Provides basic access to attributes (
_declspec(...)
or__attribute__((...))
) - Provides access to attached comments
- Provides access to expressions for variable and parameter init value (e.g
const int x = (1 + 2) << 1
the(1 + 2) << 1
will be retrievable as a binary expression from the AST) - Provides access to macro definitions, including tokens via the option
CppParserOptions.ParseMacros
(default isfalse
)
Documentation
Check the user guide documentation from the doc/
folder.
Usage Example
Setup
After installing the NuGet package, you need to modify your csproj to select a Platform RID via the RuntimeIdentifier
property:
<PropertyGroup>
<RuntimeIdentifier Condition="'$(RuntimeIdentifier)' == '' AND '$(PackAsTool)' != 'true'">$(NETCoreSdkRuntimeIdentifier)</RuntimeIdentifier>
</PropertyGroup>
Code
You can jump-start with the CppParser.Parse
method:
// Parse a C++ files
var compilation = CppParser.Parse(@"
enum MyEnum { MyEnum_0, MyEnum_1 };
void function0(int a, int b);
struct MyStruct { int field0; int field1;};
typedef MyStruct* MyStructPtr;
"
);
// Print diagnostic messages
foreach (var message in compilation.Diagnostics.Messages)
Console.WriteLine(message);
// Print All enums
foreach (var cppEnum in compilation.Enums)
Console.WriteLine(cppEnum);
// Print All functions
foreach (var cppFunction in compilation.Functions)
Console.WriteLine(cppFunction);
// Print All classes, structs
foreach (var cppClass in compilation.Classes)
Console.WriteLine(cppClass);
// Print All typedefs
foreach (var cppTypedef in compilation.Typedefs)
Console.WriteLine(cppTypedef);
Prints the following result:
enum MyEnum {...}
void function0(int a, int b)
struct MyStruct { ... }
typedef MyStruct* MyStructPtr
Binaries
This library is distributed as a NuGet package
Known issues
The library libclang used by this project has some known issues and limitations:
- Attributes are not fully exposed (e.g in function parameters, on typedefs...)
- Generic instance types are not fully exposed (e.g used as parameters, or as base types...)
License
This software is released under the BSD-Clause 2 license.
Credits
- ClangSharp: .NET managed wrapper around Clang/libclang
Related
The C++ project cppast serves similar purpose although CppAst.NET does not share API or any implementation details.
Author
Alexandre Mutel aka xoofx.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net8.0
- ClangSharp (>= 18.1.0.2)
- Irony (>= 1.5.3)
NuGet packages (4)
Showing the top 4 NuGet packages that depend on CppAst:
Package | Downloads |
---|---|
CppAst.CodeGen
CppAst.CodeGen is an extensible P/Invoke Code Generator from C++ to C# for .NET |
|
CppPinvokeGenerator
CppPinvokeGenerator is a simple pinvoke generator based on CppAst to generate C# for C++ |
|
HexaGen.Core
Package Description |
|
SharpRNA.Tools
SharpRNA tooling to generate DNA YAML from C headers |
GitHub repositories (6)
Showing the top 5 popular GitHub repositories that depend on CppAst:
Repository | Stars |
---|---|
mono/SkiaSharp
SkiaSharp is a cross-platform 2D graphics API for .NET platforms based on Google's Skia Graphics Library. It provides a comprehensive 2D API that can be used across mobile, server and desktop models to render images.
|
|
EgorBo/SimdJsonSharp
C# bindings for lemire/simdjson (and full C# port)
|
|
amerkoleci/Vortice.Vulkan
Cross platform .NET bindings for Vulkan, VMA, SPIRV-Cross and shaderc
|
|
BepInEx/Il2CppInterop
A tool interoperate between CoreCLR and Il2Cpp at runtime
|
|
xoofx/CppAst.CodeGen
An extensible library providing C# PInvoke codegen from C/C++ files for .NET
|
Version | Downloads | Last updated |
---|---|---|
0.21.1 | 231 | 11/13/2024 |
0.21.0 | 246 | 10/16/2024 |
0.20.2 | 885 | 8/20/2024 |
0.20.1 | 866 | 5/22/2024 |
0.20.0 | 512 | 5/19/2024 |
0.19.0 | 106 | 5/19/2024 |
0.18.0 | 225 | 5/12/2024 |
0.17.0 | 149 | 5/12/2024 |
0.16.0 | 402 | 4/9/2024 |
0.15.0 | 589 | 1/9/2024 |
0.14.0 | 975 | 10/14/2023 |
0.13.0 | 405 | 8/30/2023 |
0.12.0 | 553 | 6/5/2023 |
0.11.0 | 1,097 | 3/17/2023 |
0.10.0 | 648 | 2/16/2023 |
0.9.4 | 532 | 12/1/2022 |
0.9.3 | 369 | 11/30/2022 |
0.9.2 | 367 | 11/29/2022 |
0.9.1 | 401 | 11/24/2022 |
0.9.0 | 1,562 | 11/22/2022 |
0.8.0 | 4,226 | 2/12/2022 |
0.8.0-alpha-001 | 3,186 | 5/2/2020 |
0.7.3 | 4,624 | 3/8/2020 |
0.7.2 | 669 | 2/27/2020 |
0.7.0 | 889 | 2/12/2020 |
0.6.0 | 1,371 | 11/8/2019 |
0.5.9 | 1,503 | 9/8/2019 |
0.5.8 | 1,375 | 7/16/2019 |
0.5.7 | 1,514 | 6/18/2019 |
0.5.6 | 888 | 6/16/2019 |
0.5.5 | 717 | 6/15/2019 |
0.5.4 | 1,164 | 6/15/2019 |
0.5.3 | 731 | 6/14/2019 |
0.5.2 | 673 | 6/14/2019 |
0.5.1 | 696 | 6/13/2019 |
0.5.0 | 710 | 6/12/2019 |
0.4.0 | 782 | 6/8/2019 |
0.3.0 | 716 | 5/29/2019 |
0.2.0 | 697 | 5/27/2019 |
0.1.3 | 730 | 5/27/2019 |
0.1.2 | 709 | 5/27/2019 |
0.1.1 | 723 | 5/27/2019 |
0.1.0 | 782 | 5/27/2019 |