aboutsummaryrefslogtreecommitdiff
path: root/clang/unittests/Tooling/HeaderAnalysisTest.cpp
blob: d91e50eda91164f887224832f9b7073c2afa12a8 (plain)
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
//===- unittest/Tooling/HeaderAnalysisTest.cpp ----------------------------===//
//
// 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/Tooling/Inclusions/HeaderAnalysis.h"
#include "clang/Lex/Preprocessor.h"
#include "clang/Testing/TestAST.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

namespace clang {
namespace tooling {
namespace {
using testing::Eq;

TEST(HeaderAnalysisTest, IsSelfContained) {
  TestInputs Inputs;
  Inputs.Code = R"cpp(
  #include "headerguard.h"
  #include "pragmaonce.h"
  #import "imported.h"

  #include "bad.h"
  #include "unguarded.h"
  )cpp";

  Inputs.ExtraFiles["headerguard.h"] = R"cpp(
  #ifndef HEADER_H
  #define HEADER_H

  #endif HEADER_H
  )cpp";
  Inputs.ExtraFiles["pragmaonce.h"] = R"cpp(
  #pragma once
  )cpp";
  Inputs.ExtraFiles["imported.h"] = "";

  Inputs.ExtraFiles["unguarded.h"] = "";
  Inputs.ExtraFiles["bad.h"] = R"cpp(
  #pragma once

  #if defined(INSIDE_H)
  #error "Only ... can be included directly"
  #endif
  )cpp";

  TestAST AST(Inputs);
  const auto &SM = AST.sourceManager();
  auto &FM = SM.getFileManager();
  auto &HI = AST.preprocessor().getHeaderSearchInfo();
  EXPECT_TRUE(
      isSelfContainedHeader(*FM.getOptionalFileRef("headerguard.h"), SM, HI));
  EXPECT_TRUE(
      isSelfContainedHeader(*FM.getOptionalFileRef("pragmaonce.h"), SM, HI));
  EXPECT_TRUE(
      isSelfContainedHeader(*FM.getOptionalFileRef("imported.h"), SM, HI));
  EXPECT_TRUE(isSelfContainedHeader(
      *SM.getFileEntryRefForID(SM.getMainFileID()), SM, HI));

  EXPECT_FALSE(
      isSelfContainedHeader(*FM.getOptionalFileRef("unguarded.h"), SM, HI));
  EXPECT_FALSE(isSelfContainedHeader(*FM.getOptionalFileRef("bad.h"), SM, HI));
}

TEST(HeaderAnalysisTest, CodeContainsImports) {
  EXPECT_TRUE(codeContainsImports(R"cpp(
  #include "foo.h"
  #import "NSFoo.h"

  int main() {
    foo();
  }
  )cpp"));

  EXPECT_TRUE(codeContainsImports(R"cpp(
  #include "foo.h"

  int main() {
    foo();
  }

  #import "NSFoo.h"
  )cpp"));

  EXPECT_FALSE(codeContainsImports(R"cpp(
  #include "foo.h"

  int main() {
    foo();
  }
  )cpp"));
}

TEST(HeaderAnalysisTest, ParseIWYUPragma) {
  EXPECT_THAT(parseIWYUPragma("// IWYU pragma: keep"), Eq("keep"));
  EXPECT_THAT(parseIWYUPragma("// IWYU pragma:   keep  me\netc"),
              Eq("keep  me"));
  EXPECT_THAT(parseIWYUPragma("/* IWYU pragma: keep */"), Eq("keep"));
  EXPECT_EQ(parseIWYUPragma("//  IWYU pragma: keep"), std::nullopt)
      << "Prefix is sensitive to whitespace";
  EXPECT_EQ(parseIWYUPragma("// IWYU pragma:keep"), std::nullopt)
      << "Prefix is sensitive to whitespace";
  EXPECT_EQ(parseIWYUPragma("/\n* IWYU pragma: keep */"), std::nullopt)
      << "Must start with /* or //";
}

} // namespace
} // namespace tooling
} // namespace clang