New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a helper library, libClangSharp, for exposing functionality not in libClang #94

Merged

tannergooding merged 4 commits into dotnet:master from tannergooding:libclangsharp

Nov 18, 2019

Member

tannergooding commented Nov 13, 2019

This exposes a new helper library named libClangSharp. This library exposes functionality not yet in libClang for use in ClangSharp.

Member Author

tannergooding commented Nov 13, 2019

A NuGet package hasn't been published for libClangSharp yet as I'd like to get some feedback first.

Ideally, all functionality being exposed here would also be ported back to libClang. At least one of the APIs (for getting the binary operator opcode: https://reviews.llvm.org/D10833) is actively in PR against libClang as well; however, it has been a WIP for 4 years now and I'm not confident it will get in any time soon (the same would go for other tweaks/changes).

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      private const string libraryPath = "libClangSharp";
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_Cursor_getBinaryOpcode", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern CX_BinaryOperatorKind Cursor_getBinaryOpcode(CXCursor C);

Member Author

tannergooding Nov 13, 2019

An API for explicitly getting the opcode of a binary operator. This avoids the need to try and manually process tokens.

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      public static extern CXString Cursor_getBinaryOpcodeStr(CX_BinaryOperatorKind Op);
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_Cursor_getUnaryOpcode", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern CX_UnaryOperatorKind Cursor_getUnaryOpcode(CXCursor C);

Member Author

tannergooding Nov 13, 2019

An API for explicitly getting the opcode of a unary operator. This avoids the need to try and manually process tokens.

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      public static extern CXString Cursor_getUnaryOpcodeStr(CX_UnaryOperatorKind Op);
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_getCursorExtent", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern CXSourceRange getCursorExtent(CXCursor param0);

Member Author

tannergooding Nov 13, 2019

The clang_getCursorExtent API keeps the start location "as-is". However, it transforms the end location to its expansion location. This means that if the actual extent is in a macro, you get macro start location, expansion end location.

That transformation is what was blocking the token processing logic from working in some cases (namely when macros were involved).

This API just gives you the raw extent (macro start location, macro end location) and the consumer, if desired, can manually transform each location to the expansion location or any other location as needed. This allows token processing to work as needed and allows the consumer to customize as necessary.

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      public static extern CXSourceRange getNullRange();
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_getRange", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern CXSourceRange getRange(CXSourceLocation begin, CXSourceLocation end);

Member Author

tannergooding Nov 13, 2019

Same scenario as in getCursorExtent.

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      public static extern CXSourceRange getRange(CXSourceLocation begin, CXSourceLocation end);
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_getSpellingLocation", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern void getSpellingLocation(CXSourceLocation location, [NativeTypeName("CXFile *")] void** file, [NativeTypeName("unsigned int *")] uint* line, [NativeTypeName("unsigned int *")] uint* column, [NativeTypeName("unsigned int *")] uint* offset);

Member Author

tannergooding Nov 13, 2019

The libClang API was actually doing getFileLocation. The API, when added, was correctly getting the spelling location; but then at some point later there were CI failures and someone changed it to be functionally getFileLocation with a FIXME comment.

This version of the API correctly gets the spelling location, which allows users to get the line/column/offset as it exists in the raw header files. This is useful for when processing macros.

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs Outdated

+                      [DllImport(libraryPath, EntryPoint = "clangsharp_isAttribute", CallingConvention = CallingConvention.Cdecl)]
+                      [return: NativeTypeName("unsigned int")]
+                      public static extern uint isAttribute([NativeTypeName("enum CXCursorKind")] CXCursorKind param0);

Member Author

tannergooding Nov 13, 2019

Other APIs here, that I've not commented on, are the exact same as the libClang versions. They ended up being redeclared to avoid static linking errors (I could probably remove the exports, however).

Member Author

tannergooding commented Nov 13, 2019

CC. @mjsabby for thoughts/opinions on this approach.

tannergooding force-pushed the libclangsharp branch from 56fb001 to b3ada8c Compare

November 13, 2019 22:48

tannergooding commented

View reviewed changes

sources/ClangSharp/Interop/clangsharp.cs

+                      public static extern CXString Cursor_getBinaryOpcodeSpelling(CX_BinaryOperatorKind Op);
+                      [DllImport(libraryPath, EntryPoint = "clangsharp_Cursor_getDeclKind", CallingConvention = CallingConvention.Cdecl)]
+                      public static extern CX_DeclKind Cursor_getDeclKind(CXCursor C);

Member Author

tannergooding Nov 13, 2019

getDeclKind, getAttrKind, and getStmtKind lets you determine the type of unexposed cursors.

tannergooding force-pushed the libclangsharp branch from b3ada8c to 697d136 Compare

November 14, 2019 06:01

Member Author

tannergooding commented Nov 14, 2019

Added a commit which exposes all of the attr, decl, stmt, and expr kinds.

tannergooding force-pushed the libclangsharp branch 6 times, most recently from 00a55a4 to e98db34 Compare

November 16, 2019 23:24

tannergooding added 4 commits

November 17, 2019 18:42


          Adding a libClangSharp project to expose functionality not supported …

87c05a3

…by libclang


          Generating bindings for libClangSharp

9d4ab6c


          Updating ClangSharp to use libClangSharp where applicable

08c7c2d


          Adding Attr, Decl, Expr, Stmt, and Type types for the full set of exp…

24e590d

…osed kinds

tannergooding force-pushed the libclangsharp branch from e98db34 to 24e590d Compare

November 18, 2019 02:48

tannergooding merged commit ff9e62f into dotnet:master

tannergooding deleted the libclangsharp branch

November 18, 2019 17:55

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet