clang
8.0.0
include
clang-c
CXString.h
Go to the documentation of this file.
1
/*===-- clang-c/CXString.h - C Index strings --------------------*- C -*-===*\
2
|* *|
3
|* The LLVM Compiler Infrastructure *|
4
|* *|
5
|* This file is distributed under the University of Illinois Open Source *|
6
|* License. See LICENSE.TXT for details. *|
7
|* *|
8
|*===----------------------------------------------------------------------===*|
9
|* *|
10
|* This header provides the interface to C Index strings. *|
11
|* *|
12
\*===----------------------------------------------------------------------===*/
13
14
#ifndef LLVM_CLANG_C_CXSTRING_H
15
#define LLVM_CLANG_C_CXSTRING_H
16
17
#include "
clang-c/Platform.h
"
18
19
#ifdef __cplusplus
20
extern
"C"
{
21
#endif
22
23
/**
24
* \defgroup CINDEX_STRING String manipulation routines
25
* \ingroup CINDEX
26
*
27
* @{
28
*/
29
30
/**
31
* A character string.
32
*
33
* The \c CXString type is used to return strings from the interface when
34
* the ownership of that string might differ from one call to the next.
35
* Use \c clang_getCString() to retrieve the string data and, once finished
36
* with the string data, call \c clang_disposeString() to free the string.
37
*/
38
typedef
struct
{
39
const
void
*
data
;
40
unsigned
private_flags
;
41
}
CXString
;
42
43
typedef
struct
{
44
CXString
*
Strings
;
45
unsigned
Count
;
46
}
CXStringSet
;
47
48
/**
49
* Retrieve the character data associated with the given string.
50
*/
51
CINDEX_LINKAGE
const
char
*
clang_getCString
(
CXString
string
);
52
53
/**
54
* Free the given string.
55
*/
56
CINDEX_LINKAGE
void
clang_disposeString
(
CXString
string
);
57
58
/**
59
* Free the given string set.
60
*/
61
CINDEX_LINKAGE
void
clang_disposeStringSet
(
CXStringSet
*
set
);
62
63
/**
64
* @}
65
*/
66
67
#ifdef __cplusplus
68
}
69
#endif
70
#endif
71
CINDEX_LINKAGE
#define CINDEX_LINKAGE
Definition:
Platform.h:29
CXString::private_flags
unsigned private_flags
Definition:
CXString.h:40
clang_disposeString
CINDEX_LINKAGE void clang_disposeString(CXString string)
Free the given string.
CXStringSet::Strings
CXString * Strings
Definition:
CXString.h:44
clang_getCString
CINDEX_LINKAGE const char * clang_getCString(CXString string)
Retrieve the character data associated with the given string.
clang_disposeStringSet
CINDEX_LINKAGE void clang_disposeStringSet(CXStringSet *set)
Free the given string set.
CXStringSet::Count
unsigned Count
Definition:
CXString.h:45
CXString
A character string.
Definition:
CXString.h:38
CXString::data
const void * data
Definition:
CXString.h:39
CXStringSet
Definition:
CXString.h:43
Platform.h
Generated on Fri Mar 8 2019 13:35:35 for clang by
1.8.13