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.
52 /// Represents a simplified token that's lexed as part of the source
53 /// minimization. It's used to track the location of various preprocessor
54 /// directives that could potentially have an effect on the depedencies.
56 /// The kind of token.
57 TokenKind K = pp_none;
59 /// Offset into the output byte stream of where the directive begins.
62 Token(TokenKind K, int Offset) : K(K), Offset(Offset) {}
65 } // end namespace minimize_source_to_dependency_directives
67 /// Minimize the input down to the preprocessor directives that might have
68 /// an effect on the dependencies for a compilation unit.
70 /// This function deletes all non-preprocessor code, and strips anything that
71 /// can't affect what gets included. It canonicalizes whitespace where
72 /// convenient to stabilize the output against formatting changes in the input.
74 /// Clears the output vectors at the beginning of the call.
76 /// \returns false on success, true on error. If the diagnostic engine is not
77 /// null, an appropriate error is reported using the given input location
78 /// with the offset that corresponds to the minimizer's current buffer offset.
79 bool minimizeSourceToDependencyDirectives(
80 llvm::StringRef Input, llvm::SmallVectorImpl<char> &Output,
81 llvm::SmallVectorImpl<minimize_source_to_dependency_directives::Token>
83 DiagnosticsEngine *Diags = nullptr,
84 SourceLocation InputSourceLoc = SourceLocation());
86 } // end namespace clang
88 #endif // LLVM_CLANG_LEX_DEPENDENCY_DIRECTIVES_SOURCE_MINIMIZER_H