Coverage Report

Created: 2022-01-18 06:27

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Lex/DependencyDirectivesSourceMinimizer.h
Line
Count
Source
1
//===- clang/Lex/DependencyDirectivesSourceMinimizer.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 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.
14
///
15
//===----------------------------------------------------------------------===//
16
17
#ifndef LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSOURCEMINIMIZER_H
18
#define LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSOURCEMINIMIZER_H
19
20
#include "clang/Basic/SourceLocation.h"
21
#include "llvm/ADT/ArrayRef.h"
22
#include "llvm/ADT/SmallVector.h"
23
#include "llvm/ADT/StringRef.h"
24
25
namespace clang {
26
27
class DiagnosticsEngine;
28
29
namespace minimize_source_to_dependency_directives {
30
31
/// Represents the kind of preprocessor directive or a module declaration that
32
/// is tracked by the source minimizer in its token output.
33
enum TokenKind {
34
  pp_none,
35
  pp_include,
36
  pp___include_macros,
37
  pp_define,
38
  pp_undef,
39
  pp_import,
40
  pp_pragma_import,
41
  pp_pragma_once,
42
  pp_pragma_push_macro,
43
  pp_pragma_pop_macro,
44
  pp_pragma_include_alias,
45
  pp_include_next,
46
  pp_if,
47
  pp_ifdef,
48
  pp_ifndef,
49
  pp_elif,
50
  pp_elifdef,
51
  pp_elifndef,
52
  pp_else,
53
  pp_endif,
54
  decl_at_import,
55
  cxx_export_decl,
56
  cxx_module_decl,
57
  cxx_import_decl,
58
  pp_eof,
59
};
60
61
/// Represents a simplified token that's lexed as part of the source
62
/// minimization. It's used to track the location of various preprocessor
63
/// directives that could potentially have an effect on the depedencies.
64
struct Token {
65
  /// The kind of token.
66
  TokenKind K = pp_none;
67
68
  /// Offset into the output byte stream of where the directive begins.
69
  int Offset = -1;
70
71
172k
  Token(TokenKind K, int Offset) : K(K), Offset(Offset) {}
72
};
73
74
/// Simplified token range to track the range of a potentially skippable PP
75
/// directive.
76
struct SkippedRange {
77
  /// Offset into the output byte stream of where the skipped directive begins.
78
  int Offset;
79
80
  /// The number of bytes that can be skipped before the preprocessing must
81
  /// resume.
82
  int Length;
83
};
84
85
/// Computes the potential source ranges that can be skipped by the preprocessor
86
/// when skipping a directive like #if, #ifdef or #elsif.
87
///
88
/// \returns false on success, true on error.
89
bool computeSkippedRanges(ArrayRef<Token> Input,
90
                          llvm::SmallVectorImpl<SkippedRange> &Range);
91
92
} // end namespace minimize_source_to_dependency_directives
93
94
/// Minimize the input down to the preprocessor directives that might have
95
/// an effect on the dependencies for a compilation unit.
96
///
97
/// This function deletes all non-preprocessor code, and strips anything that
98
/// can't affect what gets included. It canonicalizes whitespace where
99
/// convenient to stabilize the output against formatting changes in the input.
100
///
101
/// Clears the output vectors at the beginning of the call.
102
///
103
/// \returns false on success, true on error. If the diagnostic engine is not
104
/// null, an appropriate error is reported using the given input location
105
/// with the offset that corresponds to the minimizer's current buffer offset.
106
bool minimizeSourceToDependencyDirectives(
107
    llvm::StringRef Input, llvm::SmallVectorImpl<char> &Output,
108
    llvm::SmallVectorImpl<minimize_source_to_dependency_directives::Token>
109
        &Tokens,
110
    DiagnosticsEngine *Diags = nullptr,
111
    SourceLocation InputSourceLoc = SourceLocation());
112
113
} // end namespace clang
114
115
#endif // LLVM_CLANG_LEX_DEPENDENCYDIRECTIVESSOURCEMINIMIZER_H