1 /*===-- clang-c/CXCompilationDatabase.h - Compilation database ---*- C -*-===*\
3 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
5 |* See https://llvm.org/LICENSE.txt for license information. *|
6 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header provides a public interface to use CompilationDatabase without *|
11 |* the full Clang C++ API. *|
13 \*===----------------------------------------------------------------------===*/
15 #ifndef LLVM_CLANG_C_CXCOMPILATIONDATABASE_H
16 #define LLVM_CLANG_C_CXCOMPILATIONDATABASE_H
18 #include "clang-c/CXString.h"
19 #include "clang-c/ExternC.h"
20 #include "clang-c/Platform.h"
22 LLVM_CLANG_C_EXTERN_C_BEGIN
24 /** \defgroup COMPILATIONDB CompilationDatabase functions
31 * A compilation database holds all information used to compile files in a
32 * project. For each file in the database, it can be queried for the working
33 * directory or the command line used for the compiler invocation.
35 * Must be freed by \c clang_CompilationDatabase_dispose
37 typedef void * CXCompilationDatabase;
40 * Contains the results of a search in the compilation database
42 * When searching for the compile command for a file, the compilation db can
43 * return several commands, as the file may have been compiled with
44 * different options in different places of the project. This choice of compile
45 * commands is wrapped in this opaque data structure. It must be freed by
46 * \c clang_CompileCommands_dispose.
48 typedef void * CXCompileCommands;
51 * Represents the command line invocation to compile a specific file.
53 typedef void * CXCompileCommand;
56 * Error codes for Compilation Database
62 CXCompilationDatabase_NoError = 0,
65 * Database can not be loaded
67 CXCompilationDatabase_CanNotLoadDatabase = 1
69 } CXCompilationDatabase_Error;
72 * Creates a compilation database from the database found in directory
73 * buildDir. For example, CMake can output a compile_commands.json which can
74 * be used to build the database.
76 * It must be freed by \c clang_CompilationDatabase_dispose.
78 CINDEX_LINKAGE CXCompilationDatabase
79 clang_CompilationDatabase_fromDirectory(const char *BuildDir,
80 CXCompilationDatabase_Error *ErrorCode);
83 * Free the given compilation database
86 clang_CompilationDatabase_dispose(CXCompilationDatabase);
89 * Find the compile commands used for a file. The compile commands
90 * must be freed by \c clang_CompileCommands_dispose.
92 CINDEX_LINKAGE CXCompileCommands
93 clang_CompilationDatabase_getCompileCommands(CXCompilationDatabase,
94 const char *CompleteFileName);
97 * Get all the compile commands in the given compilation database.
99 CINDEX_LINKAGE CXCompileCommands
100 clang_CompilationDatabase_getAllCompileCommands(CXCompilationDatabase);
103 * Free the given CompileCommands
105 CINDEX_LINKAGE void clang_CompileCommands_dispose(CXCompileCommands);
108 * Get the number of CompileCommand we have for a file
110 CINDEX_LINKAGE unsigned
111 clang_CompileCommands_getSize(CXCompileCommands);
114 * Get the I'th CompileCommand for a file
116 * Note : 0 <= i < clang_CompileCommands_getSize(CXCompileCommands)
118 CINDEX_LINKAGE CXCompileCommand
119 clang_CompileCommands_getCommand(CXCompileCommands, unsigned I);
122 * Get the working directory where the CompileCommand was executed from
124 CINDEX_LINKAGE CXString
125 clang_CompileCommand_getDirectory(CXCompileCommand);
128 * Get the filename associated with the CompileCommand.
130 CINDEX_LINKAGE CXString
131 clang_CompileCommand_getFilename(CXCompileCommand);
134 * Get the number of arguments in the compiler invocation.
137 CINDEX_LINKAGE unsigned
138 clang_CompileCommand_getNumArgs(CXCompileCommand);
141 * Get the I'th argument value in the compiler invocations
144 * - argument 0 is the compiler executable
146 CINDEX_LINKAGE CXString
147 clang_CompileCommand_getArg(CXCompileCommand, unsigned I);
150 * Get the number of source mappings for the compiler invocation.
152 CINDEX_LINKAGE unsigned
153 clang_CompileCommand_getNumMappedSources(CXCompileCommand);
156 * Get the I'th mapped source path for the compiler invocation.
158 CINDEX_LINKAGE CXString
159 clang_CompileCommand_getMappedSourcePath(CXCompileCommand, unsigned I);
162 * Get the I'th mapped source content for the compiler invocation.
164 CINDEX_LINKAGE CXString
165 clang_CompileCommand_getMappedSourceContent(CXCompileCommand, unsigned I);
171 LLVM_CLANG_C_EXTERN_C_END