1 //===--- SimpleFormatContext.h ----------------------------------*- 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 /// \file
11 ///
12 /// \brief Defines a utility class for use of clang-format in libclang
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_CLANG_LIB_INDEX_SIMPLEFORMATCONTEXT_H
17 #define LLVM_CLANG_LIB_INDEX_SIMPLEFORMATCONTEXT_H
18 
19 #include "clang/Basic/Diagnostic.h"
20 #include "clang/Basic/DiagnosticOptions.h"
21 #include "clang/Basic/FileManager.h"
22 #include "clang/Basic/LangOptions.h"
23 #include "clang/Basic/SourceManager.h"
24 #include "clang/Rewrite/Core/Rewriter.h"
25 #include "llvm/Support/FileSystem.h"
26 #include "llvm/Support/Path.h"
27 #include "llvm/Support/raw_ostream.h"
28 
29 namespace clang {
30 namespace index {
31 
32 /// \brief A small class to be used by libclang clients to format
33 /// a declaration string in memory. This object is instantiated once
34 /// and used each time a formatting is needed.
35 class SimpleFormatContext {
36 public:
SimpleFormatContext(LangOptions Options)37   SimpleFormatContext(LangOptions Options)
38       : DiagOpts(new DiagnosticOptions()),
39         Diagnostics(new DiagnosticsEngine(new DiagnosticIDs,
40                                           DiagOpts.get())),
41         Files((FileSystemOptions())),
42         Sources(*Diagnostics, Files),
43         Rewrite(Sources, Options) {
44     Diagnostics->setClient(new IgnoringDiagConsumer, true);
45   }
46 
createInMemoryFile(StringRef Name,StringRef Content)47   FileID createInMemoryFile(StringRef Name, StringRef Content) {
48     std::unique_ptr<llvm::MemoryBuffer> Source =
49         llvm::MemoryBuffer::getMemBuffer(Content);
50     const FileEntry *Entry =
51         Files.getVirtualFile(Name, Source->getBufferSize(), 0);
52     Sources.overrideFileContents(Entry, std::move(Source));
53     assert(Entry != nullptr);
54     return Sources.createFileID(Entry, SourceLocation(), SrcMgr::C_User);
55   }
56 
getRewrittenText(FileID ID)57   std::string getRewrittenText(FileID ID) {
58     std::string Result;
59     llvm::raw_string_ostream OS(Result);
60     Rewrite.getEditBuffer(ID).write(OS);
61     OS.flush();
62     return Result;
63   }
64 
65   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts;
66   IntrusiveRefCntPtr<DiagnosticsEngine> Diagnostics;
67   FileManager Files;
68   SourceManager Sources;
69   Rewriter Rewrite;
70 };
71 
72 } // end namespace index
73 } // end namespace clang
74 
75 #endif
76