62 lines
1.8 KiB
C
62 lines
1.8 KiB
C
/*===-- clang-c/CXString.h - C Index strings --------------------*- C -*-===*\
|
|
|* *|
|
|
|* The LLVM Compiler Infrastructure *|
|
|
|* *|
|
|
|* This file is distributed under the University of Illinois Open Source *|
|
|
|* License. See LICENSE.TXT for details. *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header provides the interface to C Index strings. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef CLANG_CXSTRING_H
|
|
#define CLANG_CXSTRING_H
|
|
|
|
#include "clang-c/Platform.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* \defgroup CINDEX_STRING String manipulation routines
|
|
* \ingroup CINDEX
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \brief A character string.
|
|
*
|
|
* The \c CXString type is used to return strings from the interface when
|
|
* the ownership of that string might different from one call to the next.
|
|
* Use \c clang_getCString() to retrieve the string data and, once finished
|
|
* with the string data, call \c clang_disposeString() to free the string.
|
|
*/
|
|
typedef struct {
|
|
void *data;
|
|
unsigned private_flags;
|
|
} CXString;
|
|
|
|
/**
|
|
* \brief Retrieve the character data associated with the given string.
|
|
*/
|
|
CINDEX_LINKAGE const char *clang_getCString(CXString string);
|
|
|
|
/**
|
|
* \brief Free the given string,
|
|
*/
|
|
CINDEX_LINKAGE void clang_disposeString(CXString string);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|
|
|