Add libclang-style C API

- Add `CXScope` and `CXQualType` as a bridge between libclang types and CppInterOp's types
- Add C API for interpreter and scope manipulations

Author: Gnimuc

include/clang-c/CXCppInterOp.h

@@ -0,0 +1,366 @@
+// NOLINTBEGIN()
+#ifndef LLVM_CLANG_C_CXCPPINTEROP_H
+#define LLVM_CLANG_C_CXCPPINTEROP_H
+
+#include "clang-c/CXErrorCode.h"
+#include "clang-c/CXString.h"
+#include "clang-c/ExternC.h"
+#include "clang-c/Index.h"
+#include "clang-c/Platform.h"
+
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+
+LLVM_CLANG_C_EXTERN_C_BEGIN
+
+/**
+ * \defgroup CPPINTEROP_INTERPRETER_MANIP Interpreter manipulations
+ *
+ * @{
+ */
+
+/**
+ * An opaque pointer representing an interpreter context.
+ */
+typedef struct CXInterpreterImpl* CXInterpreter;
+
+/**
+ * Create a Clang interpreter instance from the given arguments.
+ *
+ * \param argv The arguments that would be passed to the interpreter.
+ *
+ * \param argc The number of arguments in \c argv.
+ *
+ * \returns a \c CXInterpreter.
+ */
+CXInterpreter clang_createInterpreter(const char* const* argv, int argc);
+
+typedef void* TInterp_t;
+
+/**
+ * Bridge between C API and C++ API.
+ *
+ * \returns a \c CXInterpreter.
+ */
+CXInterpreter clang_createInterpreterFromRawPtr(TInterp_t I);
+
+/**
+ * Returns a pointer to the underlying interpreter.
+ */
+void* clang_Interpreter_getClangInterpreter(CXInterpreter I);
+
+/**
+ * Returns a \c TInterp_t and takes the ownership.
+ */
+TInterp_t clang_Interpreter_takeInterpreterAsPtr(CXInterpreter I);
+
+/**
+ * Undo N previous incremental inputs.
+ */
+enum CXErrorCode clang_Interpreter_Undo(CXInterpreter I, unsigned int N);
+
+/**
+ * Dispose of the given interpreter context.
+ */
+void clang_Interpreter_dispose(CXInterpreter I);
+
+/**
+ * Describes the return result of the different routines that do the incremental
+ * compilation.
+ */
+typedef enum {
+  /**
+   * The compilation was successful.
+   */
+  CXInterpreter_Success = 0,
+  /**
+   * The compilation failed.
+   */
+  CXInterpreter_Failure = 1,
+  /**
+   * More more input is expected.
+   */
+  CXInterpreter_MoreInputExpected = 2,
+} CXInterpreter_CompilationResult;
+
+/**
+ * Add a search path to the interpreter.
+ *
+ * \param I The interpreter.
+ *
+ * \param dir The directory to add.
+ *
+ * \param isUser Whether the directory is a user directory.
+ *
+ * \param prepend Whether to prepend the directory to the search path.
+ */
+void clang_Interpreter_addSearchPath(CXInterpreter I, const char* dir,
+                                     bool isUser, bool prepend);
+
+/**
+ * Add an include path.
+ *
+ * \param I The interpreter.
+ *
+ * \param dir The directory to add.
+ */
+void clang_Interpreter_addIncludePath(CXInterpreter I, const char* dir);
+
+/**
+ * Declares a code snippet in \c code and does not execute it.
+ *
+ * \param I The interpreter.
+ *
+ * \param code The code snippet to declare.
+ *
+ * \param silent Whether to suppress the diagnostics or not
+ *
+ * \returns a \c CXErrorCode.
+ */
+enum CXErrorCode clang_Interpreter_declare(CXInterpreter I, const char* code,
+                                           bool silent);
+
+/**
+ * Declares and executes a code snippet in \c code.
+ *
+ * \param I The interpreter.
+ *
+ * \param code The code snippet to execute.
+ *
+ * \returns a \c CXErrorCode.
+ */
+enum CXErrorCode clang_Interpreter_process(CXInterpreter I, const char* code);
+
+/**
+ * An opaque pointer representing a lightweight struct that is used for carrying
+ * execution results.
+ */
+typedef void* CXValue;
+
+/**
+ * Create a CXValue.
+ *
+ * \returns a \c CXValue.
+ */
+CXValue clang_createValue(void);
+
+/**
+ * Dispose of the given CXValue.
+ *
+ * \param V The CXValue to dispose.
+ */
+void clang_Value_dispose(CXValue V);
+
+/**
+ * Declares, executes and stores the execution result to \c V.
+ *
+ * \param[in] I The interpreter.
+ *
+ * \param[in] code The code snippet to evaluate.
+ *
+ * \param[out] V The value to store the execution result.
+ *
+ * \returns a \c CXErrorCode.
+ */
+enum CXErrorCode clang_Interpreter_evaluate(CXInterpreter I, const char* code,
+                                            CXValue V);
+
+/**
+ * Looks up the library if access is enabled.
+ *
+ * \param I The interpreter.
+ *
+ * \param lib_name The name of the library to lookup.
+ *
+ * \returns the path to the library.
+ */
+CXString clang_Interpreter_lookupLibrary(CXInterpreter I, const char* lib_name);
+
+/**
+ * Finds \c lib_stem considering the list of search paths and loads it by
+ * calling dlopen.
+ *
+ * \param I The interpreter.
+ *
+ * \param lib_stem The stem of the library to load.
+ *
+ * \param lookup Whether to lookup the library or not.
+ *
+ * \returns a \c CXInterpreter_CompilationResult.
+ */
+CXInterpreter_CompilationResult
+clang_Interpreter_loadLibrary(CXInterpreter I, const char* lib_stem,
+                              bool lookup);
+
+/**
+ * Finds \c lib_stem considering the list of search paths and unloads it by
+ * calling dlclose.
+ *
+ * \param I The interpreter.
+ *
+ * \param lib_stem The stem of the library to unload.
+ */
+void clang_Interpreter_unloadLibrary(CXInterpreter I, const char* lib_stem);
+
+/**
+ * @}
+ */
+
+/**
+ * \defgroup CPPINTEROP_SCOPE_MANIP Scope manipulations
+ *
+ * @{
+ */
+
+/**
+ * A fake CXCursor for working with the interpreter.
+ * It has the same structure as CXCursor, but unlike CXCursor, it stores a
+ * handle to the interpreter in the third slot of the data field.
+ * This pave the way for upstreaming features to the LLVM project.
+ */
+typedef struct {
+  enum CXCursorKind kind;
+  int xdata;
+  const void* data[3];
+} CXScope;
+
+// for debugging purposes
+void clang_scope_dump(CXScope S);
+
+/**
+ * Checks if a class has a default constructor.
+ */
+bool clang_hasDefaultConstructor(CXScope S);
+
+/**
+ * Returns the default constructor of a class, if any.
+ */
+CXScope clang_getDefaultConstructor(CXScope S);
+
+/**
+ * Returns the class destructor, if any.
+ */
+CXScope clang_getDestructor(CXScope S);
+
+/**
+ * Returns a stringified version of a given function signature in the form:
+ * void N::f(int i, double d, long l = 0, char ch = 'a').
+ */
+CXString clang_getFunctionSignature(CXScope func);
+
+/**
+ * Checks if a function is a templated function.
+ */
+bool clang_isTemplatedFunction(CXScope func);
+
+/**
+ * This function performs a lookup to check if there is a templated function of
+ * that type. \c parent is mandatory, the global scope should be used as the
+ * default value.
+ */
+bool clang_existsFunctionTemplate(const char* name, CXScope parent);
+
+typedef struct {
+  void* Type;
+  const char* IntegralValue;
+} CXTemplateArgInfo;
+
+/**
+ * Builds a template instantiation for a given templated declaration.
+ * Offers a single interface for instantiation of class, function and variable
+ * templates.
+ *
+ * \param[in] tmpl The uninstantiated template class/function.
+ *
+ * \param[in] template_args The pointer to vector of template arguments stored
+ * in the \c TemplateArgInfo struct
+ *
+ * \param[in] template_args_size The size of the vector of template arguments
+ * passed as \c template_args
+ *
+ * \returns a \c CXScope representing the instantiated templated
+ * class/function/variable.
+ */
+CXScope clang_instantiateTemplate(CXScope tmpl,
+                                  CXTemplateArgInfo* template_args,
+                                  size_t template_args_size);
+
+/**
+ * A fake CXType for working with the interpreter.
+ * It has the same structure as CXType, but unlike CXType, it stores a
+ * handle to the interpreter in the second slot of the data field.
+ */
+typedef struct {
+  enum CXTypeKind kind;
+  void* data[2];
+} CXQualType;
+
+/**
+ * Gets the string of the type that is passed as a parameter.
+ */
+CXString clang_getTypeAsString(CXQualType type);
+
+/**
+ * Returns the complex of the provided type.
+ */
+CXQualType clang_getComplexType(CXQualType eltype);
+
+/**
+ * An opaque pointer representing the object of a given type (\c CXScope).
+ */
+typedef void* CXObject;
+
+/**
+ * Allocates memory for the given type.
+ */
+CXObject clang_allocate(unsigned int n);
+
+/**
+ * Deallocates memory for a given class.
+ */
+void clang_deallocate(CXObject address);
+
+/**
+ * Creates an object of class \c scope and calls its default constructor. If \c
+ * arena is set it uses placement new.
+ */
+CXObject clang_construct(CXScope scope, void* arena);
+
+/**
+ * Creates a trampoline function and makes a call to a generic function or
+ * method.
+ *
+ * \param func The function or method to call.
+ *
+ * \param result The location where the return result will be placed.
+ *
+ * \param args The arguments to pass to the invocation.
+ *
+ * \param n The number of arguments.
+ *
+ * \param self The 'this pointer' of the object.
+ */
+void clang_invoke(CXScope func, void* result, void** args, size_t n,
+                  void* self);
+
+/**
+ * Calls the destructor of object of type \c type. When withFree is true it
+ * calls operator delete/free.
+ *
+ * \param This The object to destruct.
+ *
+ * \param type The type of the object.
+ *
+ * \param withFree Whether to call operator delete/free or not.
+ */
+void clang_destruct(CXObject This, CXScope S, bool withFree);
+
+/**
+ * @}
+ */
+
+LLVM_CLANG_C_EXTERN_C_END
+
+#endif // LLVM_CLANG_C_CXCPPINTEROP_H
+       // NOLINTEND()

lib/Interpreter/CMakeLists.txt

@@ -97,6 +97,7 @@ endif(LLVM_LINK_LLVM_DYLIB)
 add_llvm_library(clangCppInterOp
   DISABLE_LLVM_LINK_LLVM_DYLIB
   CppInterOp.cpp
+  CXCppInterOp.cpp
   ${DLM}
   LINK_LIBS
   ${link_libs}