blob: ff1ec63db057eeef09171dd5d7600c7e68bca8fc [file] [log] [blame]
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +00001/*===-- clang-c/CXCompilationDatabase.h - Compilation database ---*- C -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
5|* This file is distributed under the University of Illinois Open Source *|
6|* License. See LICENSE.TXT for details. *|
7|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header provides a public inferface to use CompilationDatabase without *|
11|* the full Clang C++ API. *|
12|* *|
13\*===----------------------------------------------------------------------===*/
14
15#ifndef CLANG_CXCOMPILATIONDATABASE_H
16#define CLANG_CXCOMPILATIONDATABASE_H
17
18#include "clang-c/Platform.h"
19#include "clang-c/CXString.h"
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/** \defgroup COMPILATIONDB CompilationDatabase functions
26 * \ingroup CINDEX
27 *
28 * @{
29 */
30
31/**
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000032 * A compilation database holds all information used to compile files in a
33 * project. For each file in the database, it can be queried for the working
34 * directory or the command line used for the compiler invocation.
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000035 *
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000036 * Must be freed by \c clang_CompilationDatabase_dispose
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000037 */
38typedef void * CXCompilationDatabase;
39
40/**
41 * \brief Contains the results of a search in the compilation database
42 *
43 * When searching for the compile command for a file, the compilation db can
44 * return several commands, as the file may have been compiled with
45 * different options in different places of the project. This choice of compile
46 * commands is wrapped in this opaque data structure. It must be freed by
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000047 * \c clang_CompileCommands_dispose.
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000048 */
49typedef void * CXCompileCommands;
50
51/**
52 * \brief Represents the command line invocation to compile a specific file.
53 */
54typedef void * CXCompileCommand;
55
56/**
57 * \brief Error codes for Compilation Database
58 */
59typedef enum {
60 /*
61 * \brief No error occured
62 */
63 CXCompilationDatabase_NoError = 0,
64
65 /*
66 * \brief Database can not be loaded
67 */
68 CXCompilationDatabase_CanNotLoadDatabase = 1
69
70} CXCompilationDatabase_Error;
71
72/**
73 * \brief Creates a compilation database from the database found in directory
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000074 * buildDir. For example, CMake can output a compile_commands.json which can
75 * be used to build the database.
76 *
77 * It must be freed by \c clang_CompilationDatabase_dispose.
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000078 */
79CINDEX_LINKAGE CXCompilationDatabase
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000080clang_CompilationDatabase_fromDirectory(const char *BuildDir,
81 CXCompilationDatabase_Error *ErrorCode);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000082
83/**
84 * \brief Free the given compilation database
85 */
86CINDEX_LINKAGE void
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000087clang_CompilationDatabase_dispose(CXCompilationDatabase);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000088
89/**
90 * \brief Find the compile commands used for a file. The compile commands
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000091 * must be freed by \c clang_CompileCommands_dispose.
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000092 */
93CINDEX_LINKAGE CXCompileCommands
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +000094clang_CompilationDatabase_getCompileCommands(CXCompilationDatabase,
95 const char *CompleteFileName);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +000096
97/**
Argyrios Kyrtzidis7e96bfb2012-12-04 07:26:44 +000098 * \brief Get all the compile commands in the given compilation database.
99 */
100CINDEX_LINKAGE CXCompileCommands
101clang_CompilationDatabase_getAllCompileCommands(CXCompilationDatabase);
102
103/**
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000104 * \brief Free the given CompileCommands
105 */
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000106CINDEX_LINKAGE void clang_CompileCommands_dispose(CXCompileCommands);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000107
108/**
109 * \brief Get the number of CompileCommand we have for a file
110 */
111CINDEX_LINKAGE unsigned
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000112clang_CompileCommands_getSize(CXCompileCommands);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000113
114/**
115 * \brief Get the I'th CompileCommand for a file
116 *
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000117 * Note : 0 <= i < clang_CompileCommands_getSize(CXCompileCommands)
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000118 */
119CINDEX_LINKAGE CXCompileCommand
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000120clang_CompileCommands_getCommand(CXCompileCommands, unsigned I);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000121
122/**
123 * \brief Get the working directory where the CompileCommand was executed from
124 */
125CINDEX_LINKAGE CXString
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000126clang_CompileCommand_getDirectory(CXCompileCommand);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000127
128/**
129 * \brief Get the number of arguments in the compiler invocation.
130 *
131 */
132CINDEX_LINKAGE unsigned
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000133clang_CompileCommand_getNumArgs(CXCompileCommand);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000134
135/**
136 * \brief Get the I'th argument value in the compiler invocations
137 *
138 * Invariant :
139 * - argument 0 is the compiler executable
140 */
141CINDEX_LINKAGE CXString
Arnaud A. de Grandmaisonc70851b2012-07-03 20:38:12 +0000142clang_CompileCommand_getArg(CXCompileCommand, unsigned I);
Arnaud A. de Grandmaisondb293182012-06-30 11:27:57 +0000143
144/**
145 * @}
146 */
147
148#ifdef __cplusplus
149}
150#endif
151#endif
152