File: header_exportable_declarations.hpp

package info (click to toggle)
llvm-toolchain-20 1%3A20.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 2,111,696 kB
  • sloc: cpp: 7,438,781; ansic: 1,393,871; asm: 1,012,926; python: 241,771; f90: 86,635; objc: 75,411; lisp: 42,144; pascal: 17,286; sh: 8,596; ml: 5,082; perl: 4,730; makefile: 3,591; awk: 3,523; javascript: 2,251; xml: 892; fortran: 672
file content (64 lines) | stat: -rw-r--r-- 2,289 bytes parent folder | download | duplicates (11)
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
//===----------------------------------------------------------------------===//
//
// 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-tidy/ClangTidyCheck.h"

#include "llvm/ADT/StringRef.h"

#include <fstream>
#include <set>
#include <string>

namespace libcpp {
class header_exportable_declarations : public clang::tidy::ClangTidyCheck {
public:
  explicit header_exportable_declarations(llvm::StringRef, clang::tidy::ClangTidyContext*);
  ~header_exportable_declarations();
  void registerMatchers(clang::ast_matchers::MatchFinder*) override;
  void check(const clang::ast_matchers::MatchFinder::MatchResult&) override;

  enum class FileType {
    // std module specific
    Header,
    CompatModulePartition,
    Module,
    // std.compat module specific
    CHeader,
    ModulePartition,
    CompatModule,
    // invalid value
    Unknown
  };

private:
  llvm::StringRef filename_;
  FileType file_type_;
  llvm::StringRef extra_header_;
  std::set<std::string> decls_;
  std::set<std::string> global_decls_;

  // The named declarations in .h C headers are "tricky". On POSIX
  // systems these headers contain POSIX specific functions that do not
  // use a reserved name. For example, fmemopen is provided by stdio.h.
  // We filter the names that should be provided by the headers as follows:
  // - record all named declarations the global namespace
  // - wait until the header is completely processed
  // - every named declaration in the global namespace that has a matching
  //   "export" in the std namespace is exported.
  //
  // The only place where we can do the above while ensuring that all
  // the declarations in the header have been seen is in the clang tidy
  // plugin's destructor.
  //
  // It is possible to skip some declarations in the std namespace,
  // these are added to decls_ before processing. To differentiate
  // between a skipped declaration and a real declaration the skipped
  // declarations are recorded in an extra variable.
  std::set<std::string> skip_decls_;
};
} // namespace libcpp