1 //===- clang/Lex/DependencyDirectivesSourceMinimizer.h - ----------*- C++ -*-//
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
7 //===----------------------------------------------------------------------===//
10 /// This is the interface for minimizing header and source files to 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.
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_CLANG_LEX_DEPENDENCY_DIRECTIVES_SOURCE_MINIMIZER_H
18 #define LLVM_CLANG_LEX_DEPENDENCY_DIRECTIVES_SOURCE_MINIMIZER_H
20 #include "clang/Basic/SourceLocation.h"
21 #include "llvm/ADT/ArrayRef.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/ADT/StringRef.h"
27 class DiagnosticsEngine;
29 namespace minimize_source_to_dependency_directives {
31 /// Represents the kind of preprocessor directive or a module declaration that
32 /// is tracked by the source minimizer in its token output.
56 /// Represents a simplified token that's lexed as part of the source
57 /// minimization. It's used to track the location of various preprocessor
58 /// directives that could potentially have an effect on the depedencies.
60 /// The kind of token.
61 TokenKind K = pp_none;
63 /// Offset into the output byte stream of where the directive begins.
66 Token(TokenKind K, int Offset) : K(K), Offset(Offset) {}
69 /// Simplified token range to track the range of a potentially skippable PP
72 /// Offset into the output byte stream of where the skipped directive begins.
75 /// The number of bytes that can be skipped before the preprocessing must
80 /// Computes the potential source ranges that can be skipped by the preprocessor
81 /// when skipping a directive like #if, #ifdef or #elsif.
83 /// \returns false on success, true on error.
84 bool computeSkippedRanges(ArrayRef<Token> Input,
85 llvm::SmallVectorImpl<SkippedRange> &Range);
87 } // end namespace minimize_source_to_dependency_directives
89 /// Minimize the input down to the preprocessor directives that might have
90 /// an effect on the dependencies for a compilation unit.
92 /// This function deletes all non-preprocessor code, and strips anything that
93 /// can't affect what gets included. It canonicalizes whitespace where
94 /// convenient to stabilize the output against formatting changes in the input.
96 /// Clears the output vectors at the beginning of the call.
98 /// \returns false on success, true on error. If the diagnostic engine is not
99 /// null, an appropriate error is reported using the given input location
100 /// with the offset that corresponds to the minimizer's current buffer offset.
101 bool minimizeSourceToDependencyDirectives(
102 llvm::StringRef Input, llvm::SmallVectorImpl<char> &Output,
103 llvm::SmallVectorImpl<minimize_source_to_dependency_directives::Token>
105 DiagnosticsEngine *Diags = nullptr,
106 SourceLocation InputSourceLoc = SourceLocation());
108 } // end namespace clang
110 #endif // LLVM_CLANG_LEX_DEPENDENCY_DIRECTIVES_SOURCE_MINIMIZER_H