clang  6.0.0svn
Typedefs | Functions
Build system utilities

Typedefs

typedef struct CXVirtualFileOverlayImpl * CXVirtualFileOverlay
 Object encapsulating information about overlaying virtual file/directories over the real file system. More...
 
typedef struct CXModuleMapDescriptorImpl * CXModuleMapDescriptor
 Object encapsulating information about a module.map file. More...
 

Functions

CINDEX_LINKAGE unsigned long long clang_getBuildSessionTimestamp (void)
 Return the timestamp for use with Clang's -fbuild-session-timestamp= option. More...
 
CINDEX_LINKAGE CXVirtualFileOverlay clang_VirtualFileOverlay_create (unsigned options)
 Create a CXVirtualFileOverlay object. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_addFileMapping (CXVirtualFileOverlay, const char *virtualPath, const char *realPath)
 Map an absolute virtual file path to an absolute real one. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_setCaseSensitivity (CXVirtualFileOverlay, int caseSensitive)
 Set the case sensitivity for the CXVirtualFileOverlay object. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_writeToBuffer (CXVirtualFileOverlay, unsigned options, char **out_buffer_ptr, unsigned *out_buffer_size)
 Write out the CXVirtualFileOverlay object to a char buffer. More...
 
CINDEX_LINKAGE void clang_free (void *buffer)
 free memory allocated by libclang, such as the buffer returned by CXVirtualFileOverlay() or clang_ModuleMapDescriptor_writeToBuffer(). More...
 
CINDEX_LINKAGE void clang_VirtualFileOverlay_dispose (CXVirtualFileOverlay)
 Dispose a CXVirtualFileOverlay object. More...
 
CINDEX_LINKAGE CXModuleMapDescriptor clang_ModuleMapDescriptor_create (unsigned options)
 Create a CXModuleMapDescriptor object. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_setFrameworkModuleName (CXModuleMapDescriptor, const char *name)
 Sets the framework module name that the module.map describes. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_setUmbrellaHeader (CXModuleMapDescriptor, const char *name)
 Sets the umbrealla header name that the module.map describes. More...
 
CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_writeToBuffer (CXModuleMapDescriptor, unsigned options, char **out_buffer_ptr, unsigned *out_buffer_size)
 Write out the CXModuleMapDescriptor object to a char buffer. More...
 
CINDEX_LINKAGE void clang_ModuleMapDescriptor_dispose (CXModuleMapDescriptor)
 Dispose a CXModuleMapDescriptor object. More...
 

Detailed Description

Typedef Documentation

◆ CXModuleMapDescriptor

typedef struct CXModuleMapDescriptorImpl* CXModuleMapDescriptor

Object encapsulating information about a module.map file.

Definition at line 101 of file BuildSystem.h.

◆ CXVirtualFileOverlay

typedef struct CXVirtualFileOverlayImpl* CXVirtualFileOverlay

Object encapsulating information about overlaying virtual file/directories over the real file system.

Definition at line 40 of file BuildSystem.h.

Function Documentation

◆ clang_free()

CINDEX_LINKAGE void clang_free ( void *  buffer)

free memory allocated by libclang, such as the buffer returned by CXVirtualFileOverlay() or clang_ModuleMapDescriptor_writeToBuffer().

Parameters
buffermemory pointer to free.

◆ clang_getBuildSessionTimestamp()

CINDEX_LINKAGE unsigned long long clang_getBuildSessionTimestamp ( void  )

Return the timestamp for use with Clang's -fbuild-session-timestamp= option.

◆ clang_ModuleMapDescriptor_create()

CINDEX_LINKAGE CXModuleMapDescriptor clang_ModuleMapDescriptor_create ( unsigned  options)

Create a CXModuleMapDescriptor object.

Must be disposed with clang_ModuleMapDescriptor_dispose().

Parameters
optionsis reserved, always pass 0.

◆ clang_ModuleMapDescriptor_dispose()

CINDEX_LINKAGE void clang_ModuleMapDescriptor_dispose ( CXModuleMapDescriptor  )

Dispose a CXModuleMapDescriptor object.

◆ clang_ModuleMapDescriptor_setFrameworkModuleName()

CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_setFrameworkModuleName ( CXModuleMapDescriptor  ,
const char *  name 
)

Sets the framework module name that the module.map describes.

Returns
0 for success, non-zero to indicate an error.

◆ clang_ModuleMapDescriptor_setUmbrellaHeader()

CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_setUmbrellaHeader ( CXModuleMapDescriptor  ,
const char *  name 
)

Sets the umbrealla header name that the module.map describes.

Returns
0 for success, non-zero to indicate an error.

◆ clang_ModuleMapDescriptor_writeToBuffer()

CINDEX_LINKAGE enum CXErrorCode clang_ModuleMapDescriptor_writeToBuffer ( CXModuleMapDescriptor  ,
unsigned  options,
char **  out_buffer_ptr,
unsigned *  out_buffer_size 
)

Write out the CXModuleMapDescriptor object to a char buffer.

Parameters
optionsis reserved, always pass 0.
out_buffer_ptrpointer to receive the buffer pointer, which should be disposed using clang_free().
out_buffer_sizepointer to receive the buffer size.
Returns
0 for success, non-zero to indicate an error.

◆ clang_VirtualFileOverlay_addFileMapping()

CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_addFileMapping ( CXVirtualFileOverlay  ,
const char *  virtualPath,
const char *  realPath 
)

Map an absolute virtual file path to an absolute real one.

The virtual path must be canonicalized (not contain "."/"..").

Returns
0 for success, non-zero to indicate an error.

◆ clang_VirtualFileOverlay_create()

CINDEX_LINKAGE CXVirtualFileOverlay clang_VirtualFileOverlay_create ( unsigned  options)

Create a CXVirtualFileOverlay object.

Must be disposed with clang_VirtualFileOverlay_dispose().

Parameters
optionsis reserved, always pass 0.

◆ clang_VirtualFileOverlay_dispose()

CINDEX_LINKAGE void clang_VirtualFileOverlay_dispose ( CXVirtualFileOverlay  )

Dispose a CXVirtualFileOverlay object.

◆ clang_VirtualFileOverlay_setCaseSensitivity()

CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_setCaseSensitivity ( CXVirtualFileOverlay  ,
int  caseSensitive 
)

Set the case sensitivity for the CXVirtualFileOverlay object.

The CXVirtualFileOverlay object is case-sensitive by default, this option can be used to override the default.

Returns
0 for success, non-zero to indicate an error.

◆ clang_VirtualFileOverlay_writeToBuffer()

CINDEX_LINKAGE enum CXErrorCode clang_VirtualFileOverlay_writeToBuffer ( CXVirtualFileOverlay  ,
unsigned  options,
char **  out_buffer_ptr,
unsigned *  out_buffer_size 
)

Write out the CXVirtualFileOverlay object to a char buffer.

Parameters
optionsis reserved, always pass 0.
out_buffer_ptrpointer to receive the buffer pointer, which should be disposed using clang_free().
out_buffer_sizepointer to receive the buffer size.
Returns
0 for success, non-zero to indicate an error.