clang 17.0.0git
TestAST.h
Go to the documentation of this file.
1//===--- TestAST.h - Build clang ASTs for testing -------------------------===//
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// In normal operation of Clang, the FrontendAction's lifecycle both creates
10// and destroys the AST, and code should operate on it during callbacks in
11// between (e.g. via ASTConsumer).
12//
13// For tests it is often more convenient to parse an AST from code, and keep it
14// alive as a normal local object, with assertions as straight-line code.
15// TestAST provides such an interface.
16// (ASTUnit can be used for this purpose, but is a production library with
17// broad scope and complicated API).
18//
19//===----------------------------------------------------------------------===//
20
21#ifndef LLVM_CLANG_TESTING_TESTAST_H
22#define LLVM_CLANG_TESTING_TESTAST_H
23
24#include "clang/Basic/LLVM.h"
27#include "llvm/ADT/StringRef.h"
28#include <string>
29#include <vector>
30
31namespace clang {
32
33/// Specifies a virtual source file to be parsed as part of a test.
34struct TestInputs {
35 TestInputs() = default;
36 TestInputs(StringRef Code) : Code(Code) {}
37
38 /// The source code of the input file to be parsed.
39 std::string Code;
40
41 /// The language to parse as.
42 /// This affects the -x and -std flags used, and the filename.
44
45 /// Extra argv to pass to clang -cc1.
46 std::vector<std::string> ExtraArgs = {};
47
48 /// Extra virtual files that are available to be #included.
49 /// Keys are plain filenames ("foo.h"), values are file content.
50 llvm::StringMap<std::string> ExtraFiles = {};
51
52 /// By default, error diagnostics during parsing are reported as gtest errors.
53 /// To suppress this, set ErrorOK or include "error-ok" in a comment in Code.
54 /// In either case, all diagnostics appear in TestAST::diagnostics().
55 bool ErrorOK = false;
56
57 /// The action used to parse the code.
58 /// By default, a SyntaxOnlyAction is used.
59 std::function<std::unique_ptr<FrontendAction>()> MakeAction;
60};
61
62/// The result of parsing a file specified by TestInputs.
63///
64/// The ASTContext, Sema etc are valid as long as this object is alive.
65class TestAST {
66public:
67 /// Constructing a TestAST parses the virtual file.
68 ///
69 /// To keep tests terse, critical errors (e.g. invalid flags) are reported as
70 /// unit test failures with ADD_FAILURE() and produce an empty ASTContext,
71 /// Sema etc. This frees the test code from handling these explicitly.
72 TestAST(const TestInputs &);
73 TestAST(StringRef Code) : TestAST(TestInputs(Code)) {}
74 TestAST(TestAST &&M);
76 ~TestAST();
77
78 /// Provides access to the AST context and other parts of Clang.
79
80 ASTContext &context() { return Clang->getASTContext(); }
81 Sema &sema() { return Clang->getSema(); }
82 SourceManager &sourceManager() { return Clang->getSourceManager(); }
83 FileManager &fileManager() { return Clang->getFileManager(); }
84 Preprocessor &preprocessor() { return Clang->getPreprocessor(); }
85 FrontendAction &action() { return *Action; }
86
87 /// Returns diagnostics emitted during parsing.
88 /// (By default, errors cause test failures, see TestInputs::ErrorOK).
90
91private:
92 void clear();
93 std::unique_ptr<FrontendAction> Action;
94 std::unique_ptr<CompilerInstance> Clang;
95 std::vector<StoredDiagnostic> Diagnostics;
96};
97
98} // end namespace clang
99
100#endif
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:182
Implements support for file system lookup, file system caching, and directory search management.
Definition: FileManager.h:53
Abstract base class for actions which can be performed by the frontend.
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:128
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:358
This class handles loading and caching of source files into memory.
The result of parsing a file specified by TestInputs.
Definition: TestAST.h:65
Sema & sema()
Definition: TestAST.h:81
Preprocessor & preprocessor()
Definition: TestAST.h:84
ASTContext & context()
Provides access to the AST context and other parts of Clang.
Definition: TestAST.h:80
FileManager & fileManager()
Definition: TestAST.h:83
TestAST(StringRef Code)
Definition: TestAST.h:73
FrontendAction & action()
Definition: TestAST.h:85
TestAST & operator=(TestAST &&)
Definition: TestAST.cpp:151
llvm::ArrayRef< StoredDiagnostic > diagnostics()
Returns diagnostics emitted during parsing.
Definition: TestAST.h:89
SourceManager & sourceManager()
Definition: TestAST.h:82
Language
The language for the input, used to select and validate the language standard and possible actions.
Definition: LangStandard.h:23
Specifies a virtual source file to be parsed as part of a test.
Definition: TestAST.h:34
TestInputs(StringRef Code)
Definition: TestAST.h:36
bool ErrorOK
By default, error diagnostics during parsing are reported as gtest errors.
Definition: TestAST.h:55
std::vector< std::string > ExtraArgs
Extra argv to pass to clang -cc1.
Definition: TestAST.h:46
TestInputs()=default
llvm::StringMap< std::string > ExtraFiles
Extra virtual files that are available to be #included.
Definition: TestAST.h:50
std::function< std::unique_ptr< FrontendAction >()> MakeAction
The action used to parse the code.
Definition: TestAST.h:59
std::string Code
The source code of the input file to be parsed.
Definition: TestAST.h:39