Remapping functions

Collaboration diagram for Remapping functions:

Typedefs
typedef void *	CXRemapping
	A remapping of original source files and their translated files.

Functions
CINDEX_LINKAGE CXRemapping	clang_getRemappings (const char *path)
	Retrieve a remapping.
CINDEX_LINKAGE CXRemapping	clang_getRemappingsFromFileList (const char **filePaths, unsigned numFiles)
	Retrieve a remapping.
CINDEX_LINKAGE unsigned	clang_remap_getNumFiles (CXRemapping)
	Determine the number of remappings.
CINDEX_LINKAGE void	clang_remap_getFilenames (CXRemapping, unsigned index, CXString *original, CXString *transformed)
	Get the original and the associated filename from the remapping.
CINDEX_LINKAGE void	clang_remap_dispose (CXRemapping)
	Dispose the remapping.

Detailed Description

Typedef Documentation

CXRemapping

typedef void* CXRemapping

A remapping of original source files and their translated files.

Definition at line 5862 of file Index.h.

Function Documentation

clang_getRemappings()

CINDEX_LINKAGE CXRemapping clang_getRemappings

(

const char *

path

)

Retrieve a remapping.

Parameters

path	the path that contains metadata about remappings.

Returns

the requested remapping. This remapping must be freed via a call to clang_remap_dispose(). Can return NULL if an error occurred.

clang_getRemappingsFromFileList()

CINDEX_LINKAGE CXRemapping clang_getRemappingsFromFileList	(	const char **	filePaths,
		unsigned	numFiles
	)

Retrieve a remapping.

Parameters

filePaths	pointer to an array of file paths containing remapping info.
numFiles	number of file paths.

Returns

the requested remapping. This remapping must be freed via a call to clang_remap_dispose(). Can return NULL if an error occurred.

clang_remap_dispose()

CINDEX_LINKAGE void clang_remap_dispose

(

CXRemapping

)

Dispose the remapping.

clang_remap_getFilenames()

CINDEX_LINKAGE void clang_remap_getFilenames	(	CXRemapping	,
		unsigned	index,
		CXString *	original,
		CXString *	transformed
	)

Get the original and the associated filename from the remapping.

Parameters

original	If non-NULL, will be set to the original filename.
transformed	If non-NULL, will be set to the filename that the original is associated with.

clang_remap_getNumFiles()

CINDEX_LINKAGE unsigned clang_remap_getNumFiles

(

CXRemapping

)

Determine the number of remappings.