CppAst 0.20.1

dotnet add package CppAst --version 0.20.1
NuGet\Install-Package CppAst -Version 0.20.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CppAst" Version="0.20.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CppAst --version 0.20.1
#r "nuget: CppAst, 0.20.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CppAst as a Cake Addin
#addin nuget:?package=CppAst&version=0.20.1

// Install CppAst as a Cake Tool
#tool nuget:?package=CppAst&version=0.20.1

CppAst.NET Build Status Coverage Status NuGet

<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 use 0.14.0 version.
  • Using Clang/libclang 17.0.1
  • 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 is false)

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 NuGet

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

The C++ project cppast serves similar purpose although CppAst.NET does not share API or any implementation details.

Author

Alexandre Mutel aka xoofx.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 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++

SharpRNA.Tools

SharpRNA tooling to generate DNA YAML from C headers

GitHub repositories (5)

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.20.1 182 5/22/2024
0.20.0 163 5/19/2024
0.19.0 55 5/19/2024
0.18.0 160 5/12/2024
0.17.0 95 5/12/2024
0.16.0 275 4/9/2024
0.15.0 473 1/9/2024
0.14.0 750 10/14/2023
0.13.0 353 8/30/2023
0.12.0 522 6/5/2023
0.11.0 579 3/17/2023
0.10.0 619 2/16/2023
0.9.4 513 12/1/2022
0.9.3 344 11/30/2022
0.9.2 353 11/29/2022
0.9.1 372 11/24/2022
0.9.0 1,424 11/22/2022
0.8.0 3,330 2/12/2022
0.8.0-alpha-001 3,001 5/2/2020
0.7.3 4,239 3/8/2020
0.7.2 646 2/27/2020
0.7.0 862 2/12/2020
0.6.0 1,310 11/8/2019
0.5.9 1,414 9/8/2019
0.5.8 1,290 7/16/2019
0.5.7 1,426 6/18/2019
0.5.6 849 6/16/2019
0.5.5 692 6/15/2019
0.5.4 1,096 6/15/2019
0.5.3 709 6/14/2019
0.5.2 649 6/14/2019
0.5.1 672 6/13/2019
0.5.0 684 6/12/2019
0.4.0 758 6/8/2019
0.3.0 689 5/29/2019
0.2.0 687 5/27/2019
0.1.3 703 5/27/2019
0.1.2 684 5/27/2019
0.1.1 691 5/27/2019
0.1.0 756 5/27/2019