CXString.h revision 9c48d16a11872624410ab3a5944edcba0f32818c
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 from a C string.
29CXString createCXString(const char *String, bool DupString = false);
30
31/// \brief Create a CXString object from a StringRef.
32CXString createCXString(StringRef String, bool DupString = true);
33
34/// \brief Create a CXString object that is backed by a string buffer.
35CXString createCXString(CXStringBuf *buf);
36
37/// \brief A string pool used for fast allocation/deallocation of strings.
38class CXStringPool {
39public:
40  ~CXStringPool();
41
42  CXStringBuf *getCXStringBuf(CXTranslationUnit TU);
43
44private:
45  std::vector<CXStringBuf *> Pool;
46
47  friend struct CXStringBuf;
48};
49
50struct CXStringBuf {
51  SmallString<128> Data;
52  CXTranslationUnit TU;
53
54  CXStringBuf(CXTranslationUnit TU) : TU(TU) {}
55
56  /// \brief Return this buffer to the pool.
57  void dispose();
58};
59
60CXStringBuf *getCXStringBuf(CXTranslationUnit TU);
61
62/// \brief Returns true if the CXString data is managed by a pool.
63bool isManagedByPool(CXString str);
64
65}
66}
67
68#endif
69
70