File: IncludeTreePPActions.cpp

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (224 lines) | stat: -rw-r--r-- 8,357 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
//===- IncludeTreePPActions.cpp - PP actions using include-tree -----------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "clang/Frontend/IncludeTreePPActions.h"
#include "clang/CAS/IncludeTree.h"
#include "clang/Frontend/FrontendDiagnostic.h"
#include "clang/Lex/PPCachedActions.h"
#include "clang/Lex/Preprocessor.h"

using namespace clang;

namespace {

struct IncludeStackInfo {
  cas::IncludeTree Tree;
  SourceLocation FileStartLoc;
  unsigned CurIncludeIndex = 0;
  unsigned CurHasIncludeCheckIndex = 0;
};

/// Uses the info from an \p IncludeTreeRoot to resolve include directives
/// and evaluate \p __has_include checks.
class IncludeTreePPActions final : public PPCachedActions {
  cas::IncludeTree MainTree;
  SmallVector<IncludeStackInfo> IncludeStack;
  bool HasCASErrorOccurred = false;

  void reportError(Preprocessor &PP, llvm::Error &&E) {
    PP.getDiagnostics().Report(diag::err_unable_to_load_include_tree_node)
        << llvm::toString(std::move(E));
    HasCASErrorOccurred = true;
  }

public:
  IncludeTreePPActions(cas::IncludeTree MainTree)
      : MainTree(std::move(MainTree)) {}

  FileID handlePredefines(Preprocessor &PP) override {
    auto createEmptyFID = [&]() -> FileID {
      llvm::MemoryBufferRef Buffer({}, "<built-in>");
      return PP.getSourceManager().createFileID(Buffer);
    };

    if (HasCASErrorOccurred) {
      return createEmptyFID();
    }

    auto reportError = [&](llvm::Error &&E) -> FileID {
      this->reportError(PP, std::move(E));
      return createEmptyFID();
    };

    SourceManager &SM = PP.getSourceManager();
    SourceLocation MainFileLoc = SM.getLocForStartOfFile(SM.getMainFileID());
    IncludeStack.push_back({std::move(MainTree), MainFileLoc});

    IncludeStackInfo &IncludeInfo = IncludeStack.back();
    Expected<cas::IncludeTree> EnteredTree =
        IncludeInfo.Tree.getIncludeTree(IncludeInfo.CurIncludeIndex++);
    if (!EnteredTree)
      return reportError(EnteredTree.takeError());
    auto FileInfo = EnteredTree->getBaseFileInfo();
    if (!FileInfo)
      return reportError(FileInfo.takeError());
    llvm::MemoryBufferRef Buffer(FileInfo->Contents, FileInfo->Filename);
    FileID FID = SM.createFileID(Buffer);
    IncludeStack.push_back(
        {std::move(*EnteredTree), SM.getLocForStartOfFile(FID)});
    return FID;
  }

  bool evaluateHasInclude(Preprocessor &PP, SourceLocation Loc,
                          bool IsIncludeNext) override {
    if (HasCASErrorOccurred)
      return false;

    IncludeStackInfo &IncludeInfo = IncludeStack.back();
    unsigned Index = IncludeInfo.CurHasIncludeCheckIndex++;
    return IncludeInfo.Tree.getCheckResult(Index);
  }

  std::variant<std::monostate, IncludeFile, IncludeModule, SpuriousImport>
  handleIncludeDirective(Preprocessor &PP, SourceLocation IncludeLoc,
                         SourceLocation AfterDirectiveLoc) override {
    if (HasCASErrorOccurred)
      return {};

    IncludeStackInfo &IncludeInfo = IncludeStack.back();
    if (IncludeInfo.CurIncludeIndex >= IncludeInfo.Tree.getNumIncludes())
      return {};

    unsigned ExpectedOffset =
        IncludeInfo.Tree.getIncludeOffset(IncludeInfo.CurIncludeIndex);
    SourceLocation ExpectedLoc =
        IncludeInfo.FileStartLoc.getLocWithOffset(ExpectedOffset);
    if (ExpectedLoc != AfterDirectiveLoc)
      return {};

    auto reportError = [&](llvm::Error &&E) -> std::monostate {
      this->reportError(PP, std::move(E));
      return {};
    };

    auto reportErrorTwine = [&](const llvm::Twine &T) -> std::monostate {
      return reportError(
          llvm::createStringError(llvm::inconvertibleErrorCode(), T));
    };

    Expected<cas::IncludeTree::Node> Node =
        IncludeInfo.Tree.getIncludeNode(IncludeInfo.CurIncludeIndex++);
    if (!Node)
      return reportError(Node.takeError());

    auto MakeModuleImport = [&](cas::IncludeTree::ModuleImport Import) {
      SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
      SmallVector<StringRef, 2> ModuleComponents;
      Import.getModuleName().split(ModuleComponents, '.');
      for (StringRef Component : ModuleComponents)
        Path.emplace_back(PP.getIdentifierInfo(Component), IncludeLoc);
      return IncludeModule{std::move(Path), Import.visibilityOnly()};
    };

    auto MakeIncludeTree = [&](cas::IncludeTree EnteredTree)
        -> std::variant<std::monostate, IncludeFile> {
      auto File = EnteredTree.getBaseFile();
      if (!File)
        return reportError(File.takeError());
      auto FilenameBlob = File->getFilename();
      if (!FilenameBlob)
        return reportError(FilenameBlob.takeError());

      SourceManager &SM = PP.getSourceManager();
      Expected<FileEntryRef> FE =
          SM.getFileManager().getFileRef(FilenameBlob->getData(),
                                         /*OpenFile=*/true);
      if (!FE)
        return reportError(FE.takeError());
      FileID FID =
          SM.createFileID(*FE, IncludeLoc, EnteredTree.getFileCharacteristic());
      PP.markIncluded(*FE);
      IncludeStack.push_back(
          {std::move(EnteredTree), SM.getLocForStartOfFile(FID)});

      Module *M = nullptr;
      auto SubmoduleName = EnteredTree.getSubmoduleName();
      if (!SubmoduleName)
        return reportError(SubmoduleName.takeError());
      if (*SubmoduleName) {
        SmallVector<StringRef> ModuleComponents;
        (*SubmoduleName)->split(ModuleComponents, '.');
        M = PP.getHeaderSearchInfo().lookupModule(
            ModuleComponents[0], IncludeLoc,
            /*AllowSearch=*/false, /*AllowExtraModuleMapSearch=*/false);
        if (!M)
          return reportErrorTwine(llvm::Twine("failed to find module '") +
                                  ModuleComponents[0] + "'");
        for (StringRef Sub : ArrayRef(ModuleComponents).drop_front()) {
          M = M->findOrInferSubmodule(Sub);
          if (!M)
            return reportErrorTwine(
                llvm::Twine("failed to find or infer submodule '") + Sub + "'");
        }

        // Add to known headers for the module.
        ModuleMap &MMap = PP.getHeaderSearchInfo().getModuleMap();
        Module::Header H{"", "", *FE};
        MMap.addHeader(M, std::move(H), ModuleMap::NormalHeader);
      }

      return IncludeFile{FID, M};
    };

    switch (Node->getKind()) {
    case cas::IncludeTree::NodeKind::ModuleImport:
      return MakeModuleImport(Node->getModuleImport());
    case cas::IncludeTree::NodeKind::Tree: {
      auto IncludeTree = MakeIncludeTree(Node->getIncludeTree());
      if (std::holds_alternative<std::monostate>(IncludeTree))
        return std::monostate{};
      return std::get<IncludeFile>(IncludeTree);
    }
    case cas::IncludeTree::NodeKind::SpuriousImport: {
      auto SpuriousImportNode = Node->getSpuriousImport();
      auto ModuleImportNode = SpuriousImportNode.getModuleImport();
      if (!ModuleImportNode)
        return reportError(ModuleImportNode.takeError());
      auto IncludeTreeNode = SpuriousImportNode.getIncludeTree();
      if (!IncludeTreeNode)
        return reportError(IncludeTreeNode.takeError());
      auto ModuleImport = MakeModuleImport(*ModuleImportNode);
      auto IncludeTree = MakeIncludeTree(*IncludeTreeNode);
      if (std::holds_alternative<std::monostate>(IncludeTree))
        return std::monostate{};
      return SpuriousImport{ModuleImport, std::get<IncludeFile>(IncludeTree)};
    }
    }
  }

  void exitedFile(Preprocessor &PP, FileID FID) override {
    if (HasCASErrorOccurred)
      return;

    assert(!IncludeStack.empty());
    assert(IncludeStack.back().FileStartLoc ==
           PP.getSourceManager().getLocForStartOfFile(FID));
    assert(IncludeStack.back().CurIncludeIndex ==
           IncludeStack.back().Tree.getNumIncludes());
    IncludeStack.pop_back();
  }
};
} // namespace

Expected<std::unique_ptr<PPCachedActions>>
clang::createPPActionsFromIncludeTree(cas::IncludeTreeRoot &Root) {
  auto MainTree = Root.getMainFileTree();
  if (!MainTree)
    return MainTree.takeError();
  return std::make_unique<IncludeTreePPActions>(std::move(*MainTree));
}