CXString.h revision dad4c1a9ac4ef1aa591ac2ef20dc4c30d96f9f2a 
1//===- CXString.h - Routines for manipulating CXStrings -------------------===//
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 file defines routines for manipulating CXStrings.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_CXSTRING_H
15#define LLVM_CLANG_CXSTRING_H
16
17#include "clang-c/Index.h"
18#include "clang/Basic/LLVM.h"
19#include "llvm/ADT/SmallString.h"
20#include "llvm/ADT/StringRef.h"
21#include <vector>
22
23namespace clang {
24namespace cxstring {
25
26struct CXStringBuf;
27
28/// \brief Create a CXString object for an NULL string.
29CXString createNull();
30
31/// \brief Create a CXString object from a C string.
32CXString createCXString(const char *String, bool DupString = false);
33
34/// \brief Create a CXString object from a StringRef.
35CXString createCXString(StringRef String, bool DupString = true);
36
37/// \brief Create a CXString object that is backed by a string buffer.
38CXString createCXString(CXStringBuf *buf);
39
40/// \brief A string pool used for fast allocation/deallocation of strings.
41class CXStringPool {
42public:
43  ~CXStringPool();
44
45  CXStringBuf *getCXStringBuf(CXTranslationUnit TU);
46
47private:
48  std::vector<CXStringBuf *> Pool;
49
50  friend struct CXStringBuf;
51};
52
53struct CXStringBuf {
54  SmallString<128> Data;
55  CXTranslationUnit TU;
56
57  CXStringBuf(CXTranslationUnit TU) : TU(TU) {}
58
59  /// \brief Return this buffer to the pool.
60  void dispose();
61};
62
63CXStringBuf *getCXStringBuf(CXTranslationUnit TU);
64
65/// \brief Returns true if the CXString data is managed by a pool.
66bool isManagedByPool(CXString str);
67
68}
69}
70
71#endif
72
73