Build system utilities

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

Functions
CINDEX_LINKAGE unsigned long long	clang_getBuildSessionTimestamp (void)
	Return the timestamp for use with Clang's -fbuild-session-timestamp= option.
CINDEX_LINKAGE CXVirtualFileOverlay	clang_VirtualFileOverlay_create (unsigned options)
	Create a CXVirtualFileOverlay object.
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.
CINDEX_LINKAGE enum CXErrorCode	clang_VirtualFileOverlay_setCaseSensitivity (CXVirtualFileOverlay, int caseSensitive)
	Set the case sensitivity for the CXVirtualFileOverlay object.
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.
CINDEX_LINKAGE void	clang_free (void *buffer)
	free memory allocated by libclang, such as the buffer returned by CXVirtualFileOverlay() or clang_ModuleMapDescriptor_writeToBuffer().
CINDEX_LINKAGE void	clang_VirtualFileOverlay_dispose (CXVirtualFileOverlay)
	Dispose a CXVirtualFileOverlay object.
CINDEX_LINKAGE CXModuleMapDescriptor	clang_ModuleMapDescriptor_create (unsigned options)
	Create a CXModuleMapDescriptor object.
CINDEX_LINKAGE enum CXErrorCode	clang_ModuleMapDescriptor_setFrameworkModuleName (CXModuleMapDescriptor, const char *name)
	Sets the framework module name that the module.modulemap describes.
CINDEX_LINKAGE enum CXErrorCode	clang_ModuleMapDescriptor_setUmbrellaHeader (CXModuleMapDescriptor, const char *name)
	Sets the umbrella header name that the module.modulemap describes.
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.
CINDEX_LINKAGE void	clang_ModuleMapDescriptor_dispose (CXModuleMapDescriptor)
	Dispose a CXModuleMapDescriptor object.

Detailed Description

Typedef Documentation

CXModuleMapDescriptor

typedef struct CXModuleMapDescriptorImpl* CXModuleMapDescriptor

Object encapsulating information about a module.modulemap file.

Definition at line 100 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 39 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

buffer

memory 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

options

is 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.modulemap 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 umbrella header name that the module.modulemap 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

options	is reserved, always pass 0.
out_buffer_ptr	pointer to receive the buffer pointer, which should be disposed using clang_free().
out_buffer_size	pointer 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

options

is 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

options	is reserved, always pass 0.
out_buffer_ptr	pointer to receive the buffer pointer, which should be disposed using clang_free().
out_buffer_size	pointer to receive the buffer size.

Returns

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