blob: 296e61247cef572973533f267ac973dde62cc359 [file] [log] [blame]
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01001/*==-- clang-c/BuildSystem.h - Utilities for use by build systems -*- C -*-===*\
2|* *|
Andrew Walbran16937d02019-10-22 13:54:20 +01003|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4|* Exceptions. *|
5|* See https://llvm.org/LICENSE.txt for license information. *|
6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01007|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header provides various utilities for use by build systems. *|
11|* *|
12\*===----------------------------------------------------------------------===*/
13
14#ifndef LLVM_CLANG_C_BUILDSYSTEM_H
15#define LLVM_CLANG_C_BUILDSYSTEM_H
16
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010017#include "clang-c/CXErrorCode.h"
18#include "clang-c/CXString.h"
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020019#include "clang-c/ExternC.h"
20#include "clang-c/Platform.h"
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010021
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020022LLVM_CLANG_C_EXTERN_C_BEGIN
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010023
24/**
25 * \defgroup BUILD_SYSTEM Build system utilities
26 * @{
27 */
28
29/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010030 * Return the timestamp for use with Clang's
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010031 * \c -fbuild-session-timestamp= option.
32 */
33CINDEX_LINKAGE unsigned long long clang_getBuildSessionTimestamp(void);
34
35/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010036 * Object encapsulating information about overlaying virtual
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010037 * file/directories over the real file system.
38 */
39typedef struct CXVirtualFileOverlayImpl *CXVirtualFileOverlay;
40
41/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010042 * Create a \c CXVirtualFileOverlay object.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010043 * Must be disposed with \c clang_VirtualFileOverlay_dispose().
44 *
45 * \param options is reserved, always pass 0.
46 */
47CINDEX_LINKAGE CXVirtualFileOverlay
48clang_VirtualFileOverlay_create(unsigned options);
49
50/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010051 * Map an absolute virtual file path to an absolute real one.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010052 * The virtual path must be canonicalized (not contain "."/"..").
53 * \returns 0 for success, non-zero to indicate an error.
54 */
55CINDEX_LINKAGE enum CXErrorCode
56clang_VirtualFileOverlay_addFileMapping(CXVirtualFileOverlay,
57 const char *virtualPath,
58 const char *realPath);
59
60/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010061 * Set the case sensitivity for the \c CXVirtualFileOverlay object.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010062 * The \c CXVirtualFileOverlay object is case-sensitive by default, this
63 * option can be used to override the default.
64 * \returns 0 for success, non-zero to indicate an error.
65 */
66CINDEX_LINKAGE enum CXErrorCode
67clang_VirtualFileOverlay_setCaseSensitivity(CXVirtualFileOverlay,
Andrew Scullcdfcccc2018-10-05 20:58:37 +010068 int caseSensitive);
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010069
70/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010071 * Write out the \c CXVirtualFileOverlay object to a char buffer.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010072 *
73 * \param options is reserved, always pass 0.
74 * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
75 * disposed using \c clang_free().
76 * \param out_buffer_size pointer to receive the buffer size.
77 * \returns 0 for success, non-zero to indicate an error.
78 */
79CINDEX_LINKAGE enum CXErrorCode
80clang_VirtualFileOverlay_writeToBuffer(CXVirtualFileOverlay, unsigned options,
81 char **out_buffer_ptr,
82 unsigned *out_buffer_size);
83
84/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010085 * free memory allocated by libclang, such as the buffer returned by
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010086 * \c CXVirtualFileOverlay() or \c clang_ModuleMapDescriptor_writeToBuffer().
87 *
88 * \param buffer memory pointer to free.
89 */
90CINDEX_LINKAGE void clang_free(void *buffer);
91
92/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010093 * Dispose a \c CXVirtualFileOverlay object.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010094 */
95CINDEX_LINKAGE void clang_VirtualFileOverlay_dispose(CXVirtualFileOverlay);
96
97/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +010098 * Object encapsulating information about a module.map file.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010099 */
100typedef struct CXModuleMapDescriptorImpl *CXModuleMapDescriptor;
101
102/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +0100103 * Create a \c CXModuleMapDescriptor object.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100104 * Must be disposed with \c clang_ModuleMapDescriptor_dispose().
105 *
106 * \param options is reserved, always pass 0.
107 */
108CINDEX_LINKAGE CXModuleMapDescriptor
109clang_ModuleMapDescriptor_create(unsigned options);
110
111/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +0100112 * Sets the framework module name that the module.map describes.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100113 * \returns 0 for success, non-zero to indicate an error.
114 */
115CINDEX_LINKAGE enum CXErrorCode
116clang_ModuleMapDescriptor_setFrameworkModuleName(CXModuleMapDescriptor,
117 const char *name);
118
119/**
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200120 * Sets the umbrella header name that the module.map describes.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100121 * \returns 0 for success, non-zero to indicate an error.
122 */
123CINDEX_LINKAGE enum CXErrorCode
124clang_ModuleMapDescriptor_setUmbrellaHeader(CXModuleMapDescriptor,
125 const char *name);
126
127/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +0100128 * Write out the \c CXModuleMapDescriptor object to a char buffer.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100129 *
130 * \param options is reserved, always pass 0.
131 * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
132 * disposed using \c clang_free().
133 * \param out_buffer_size pointer to receive the buffer size.
134 * \returns 0 for success, non-zero to indicate an error.
135 */
136CINDEX_LINKAGE enum CXErrorCode
137clang_ModuleMapDescriptor_writeToBuffer(CXModuleMapDescriptor, unsigned options,
138 char **out_buffer_ptr,
139 unsigned *out_buffer_size);
140
141/**
Andrew Scullcdfcccc2018-10-05 20:58:37 +0100142 * Dispose a \c CXModuleMapDescriptor object.
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100143 */
144CINDEX_LINKAGE void clang_ModuleMapDescriptor_dispose(CXModuleMapDescriptor);
145
146/**
147 * @}
148 */
149
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200150LLVM_CLANG_C_EXTERN_C_END
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100151
152#endif /* CLANG_C_BUILD_SYSTEM_H */
153