clang 17.0.0git
DependencyDirectivesScanner.h
Go to the documentation of this file.
1//===- clang/Lex/DependencyDirectivesScanner.h ---------------------*- 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/// \file
10/// This is the interface for scanning header and source files to get the
11/// minimum necessary preprocessor directives for evaluating includes. It
12/// reduces the source down to #define, #include, #import, @import, and any
13/// conditional preprocessor logic that contains one of those.
14///
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSCANNER_H
18#define LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSCANNER_H
19
21#include "llvm/ADT/ArrayRef.h"
22
23namespace clang {
24
25namespace tok {
26enum TokenKind : unsigned short;
27}
28
29class DiagnosticsEngine;
30
31namespace dependency_directives_scan {
32
33/// Token lexed as part of dependency directive scanning.
34struct Token {
35 /// Offset into the original source input.
36 unsigned Offset;
37 unsigned Length;
39 unsigned short Flags;
40
41 Token(unsigned Offset, unsigned Length, tok::TokenKind Kind,
42 unsigned short Flags)
44
45 unsigned getEnd() const { return Offset + Length; }
46
47 bool is(tok::TokenKind K) const { return Kind == K; }
48 bool isNot(tok::TokenKind K) const { return Kind != K; }
50 return is(K1) || is(K2);
51 }
52 template <typename... Ts> bool isOneOf(tok::TokenKind K1, Ts... Ks) const {
53 return is(K1) || isOneOf(Ks...);
54 }
55};
56
57/// Represents the kind of preprocessor directive or a module declaration that
58/// is tracked by the scanner in its token output.
59enum DirectiveKind : uint8_t {
85 /// Indicates that there are tokens present between the last scanned directive
86 /// and eof. The \p Directive::Tokens array will be empty for this kind.
89};
90
91/// Represents a directive that's lexed as part of the dependency directives
92/// scanning. It's used to track various preprocessor directives that could
93/// potentially have an effect on the dependencies.
94struct Directive {
96
97 /// The kind of token.
99
100 Directive() = default;
102 : Tokens(Tokens), Kind(K) {}
103};
104
105} // end namespace dependency_directives_scan
106
107/// Scan the input for the preprocessor directives that might have
108/// an effect on the dependencies for a compilation unit.
109///
110/// This function ignores all non-preprocessor code and anything that
111/// can't affect what gets included.
112///
113/// \returns false on success, true on error. If the diagnostic engine is not
114/// null, an appropriate error is reported using the given input location
115/// with the offset that corresponds to the \p Input buffer offset.
117 StringRef Input, SmallVectorImpl<dependency_directives_scan::Token> &Tokens,
118 SmallVectorImpl<dependency_directives_scan::Directive> &Directives,
119 DiagnosticsEngine *Diags = nullptr,
120 SourceLocation InputSourceLoc = SourceLocation());
121
122/// Print the previously scanned dependency directives as minimized source text.
123///
124/// \param Source The original source text that the dependency directives were
125/// scanned from.
126/// \param Directives The previously scanned dependency
127/// directives.
128/// \param OS the stream to print the dependency directives on.
129///
130/// This is used primarily for testing purposes, during dependency scanning the
131/// \p Lexer uses the tokens directly, not their printed version.
133 StringRef Source,
134 ArrayRef<dependency_directives_scan::Directive> Directives,
135 llvm::raw_ostream &OS);
136
137} // end namespace clang
138
139#endif // LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSCANNER_H
static constexpr bool isOneOf()
Defines the clang::SourceLocation class and associated facilities.
DirectiveKind
Represents the kind of preprocessor directive or a module declaration that is tracked by the scanner ...
@ tokens_present_before_eof
Indicates that there are tokens present between the last scanned directive and eof.
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
void printDependencyDirectivesAsSource(StringRef Source, ArrayRef< dependency_directives_scan::Directive > Directives, llvm::raw_ostream &OS)
Print the previously scanned dependency directives as minimized source text.
bool scanSourceForDependencyDirectives(StringRef Input, SmallVectorImpl< dependency_directives_scan::Token > &Tokens, SmallVectorImpl< dependency_directives_scan::Directive > &Directives, DiagnosticsEngine *Diags=nullptr, SourceLocation InputSourceLoc=SourceLocation())
Scan the input for the preprocessor directives that might have an effect on the dependencies for a co...
Represents a directive that's lexed as part of the dependency directives scanning.
Directive(DirectiveKind K, ArrayRef< Token > Tokens)
Token lexed as part of dependency directive scanning.
bool isOneOf(tok::TokenKind K1, Ts... Ks) const
Token(unsigned Offset, unsigned Length, tok::TokenKind Kind, unsigned short Flags)
unsigned Offset
Offset into the original source input.
bool isOneOf(tok::TokenKind K1, tok::TokenKind K2) const