1 //===--- TestWorkspace.h - Utility for writing multi-file tests --*- C++-*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // TestWorkspace builds on TestTU to provide a way to write tests involving
10 // several related files with inclusion relationships between them.
11 //
12 // The tests can exercise both index and AST based operations.
13 //
14 //===---------------------------------------------------------------------===//
15 
16 #ifndef LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_TESTWORKSPACE_H
17 #define LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_TESTWORKSPACE_H
18 
19 #include "TestFS.h"
20 #include "TestTU.h"
21 #include "index/FileIndex.h"
22 #include "index/Index.h"
23 #include "llvm/ADT/StringRef.h"
24 #include <string>
25 #include <vector>
26 
27 namespace clang {
28 namespace clangd {
29 
30 class TestWorkspace {
31 public:
32   // The difference between addSource() and addMainFile() is that only main
33   // files will be indexed.
addSource(llvm::StringRef Filename,llvm::StringRef Code)34   void addSource(llvm::StringRef Filename, llvm::StringRef Code) {
35     addInput(Filename.str(), {Code.str(), /*IsMainFile=*/false});
36   }
addMainFile(llvm::StringRef Filename,llvm::StringRef Code)37   void addMainFile(llvm::StringRef Filename, llvm::StringRef Code) {
38     addInput(Filename.str(), {Code.str(), /*IsMainFile=*/true});
39   }
40 
41   std::unique_ptr<SymbolIndex> index();
42 
43   Optional<ParsedAST> openFile(llvm::StringRef Filename);
44 
45 private:
46   struct SourceFile {
47     std::string Code;
48     bool IsMainFile = false;
49   };
50   llvm::StringMap<SourceFile> Inputs;
51   TestTU TU;
52 
53   void addInput(llvm::StringRef Filename, const SourceFile &Input);
54 };
55 
56 } // namespace clangd
57 } // namespace clang
58 
59 #endif // LLVM_CLANG_TOOLS_EXTRA_UNITTESTS_CLANGD_TESTWORKSPACE_H
60