1 /*==-- clang-c/BuildSystem.h - Utilities for use by build systems -*- C -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header provides various utilities for use by build systems. *|
12 \*===----------------------------------------------------------------------===*/
14 #ifndef LLVM_CLANG_C_BUILDSYSTEM_H
15 #define LLVM_CLANG_C_BUILDSYSTEM_H
17 #include "clang-c/Platform.h"
18 #include "clang-c/CXErrorCode.h"
19 #include "clang-c/CXString.h"
26 * \defgroup BUILD_SYSTEM Build system utilities
31 * \brief Return the timestamp for use with Clang's
32 * \c -fbuild-session-timestamp= option.
34 CINDEX_LINKAGE unsigned long long clang_getBuildSessionTimestamp(void);
37 * \brief Object encapsulating information about overlaying virtual
38 * file/directories over the real file system.
40 typedef struct CXVirtualFileOverlayImpl *CXVirtualFileOverlay;
43 * \brief Create a \c CXVirtualFileOverlay object.
44 * Must be disposed with \c clang_VirtualFileOverlay_dispose().
46 * \param options is reserved, always pass 0.
48 CINDEX_LINKAGE CXVirtualFileOverlay
49 clang_VirtualFileOverlay_create(unsigned options);
52 * \brief Map an absolute virtual file path to an absolute real one.
53 * The virtual path must be canonicalized (not contain "."/"..").
54 * \returns 0 for success, non-zero to indicate an error.
56 CINDEX_LINKAGE enum CXErrorCode
57 clang_VirtualFileOverlay_addFileMapping(CXVirtualFileOverlay,
58 const char *virtualPath,
59 const char *realPath);
62 * \brief Set the case sensitivity for the \c CXVirtualFileOverlay object.
63 * The \c CXVirtualFileOverlay object is case-sensitive by default, this
64 * option can be used to override the default.
65 * \returns 0 for success, non-zero to indicate an error.
67 CINDEX_LINKAGE enum CXErrorCode
68 clang_VirtualFileOverlay_setCaseSensitivity(CXVirtualFileOverlay,
72 * \brief Write out the \c CXVirtualFileOverlay object to a char buffer.
74 * \param options is reserved, always pass 0.
75 * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
76 * disposed using \c free().
77 * \param out_buffer_size pointer to receive the buffer size.
78 * \returns 0 for success, non-zero to indicate an error.
80 CINDEX_LINKAGE enum CXErrorCode
81 clang_VirtualFileOverlay_writeToBuffer(CXVirtualFileOverlay, unsigned options,
82 char **out_buffer_ptr,
83 unsigned *out_buffer_size);
86 * \brief Dispose a \c CXVirtualFileOverlay object.
88 CINDEX_LINKAGE void clang_VirtualFileOverlay_dispose(CXVirtualFileOverlay);
91 * \brief Object encapsulating information about a module.map file.
93 typedef struct CXModuleMapDescriptorImpl *CXModuleMapDescriptor;
96 * \brief Create a \c CXModuleMapDescriptor object.
97 * Must be disposed with \c clang_ModuleMapDescriptor_dispose().
99 * \param options is reserved, always pass 0.
101 CINDEX_LINKAGE CXModuleMapDescriptor
102 clang_ModuleMapDescriptor_create(unsigned options);
105 * \brief Sets the framework module name that the module.map describes.
106 * \returns 0 for success, non-zero to indicate an error.
108 CINDEX_LINKAGE enum CXErrorCode
109 clang_ModuleMapDescriptor_setFrameworkModuleName(CXModuleMapDescriptor,
113 * \brief Sets the umbrealla header name that the module.map describes.
114 * \returns 0 for success, non-zero to indicate an error.
116 CINDEX_LINKAGE enum CXErrorCode
117 clang_ModuleMapDescriptor_setUmbrellaHeader(CXModuleMapDescriptor,
121 * \brief Write out the \c CXModuleMapDescriptor object to a char buffer.
123 * \param options is reserved, always pass 0.
124 * \param out_buffer_ptr pointer to receive the buffer pointer, which should be
125 * disposed using \c free().
126 * \param out_buffer_size pointer to receive the buffer size.
127 * \returns 0 for success, non-zero to indicate an error.
129 CINDEX_LINKAGE enum CXErrorCode
130 clang_ModuleMapDescriptor_writeToBuffer(CXModuleMapDescriptor, unsigned options,
131 char **out_buffer_ptr,
132 unsigned *out_buffer_size);
135 * \brief Dispose a \c CXModuleMapDescriptor object.
137 CINDEX_LINKAGE void clang_ModuleMapDescriptor_dispose(CXModuleMapDescriptor);
147 #endif /* CLANG_C_BUILD_SYSTEM_H */