OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ | 5 #ifndef TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ |
6 #define TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ | 6 #define TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ |
7 | 7 |
8 #include <set> | 8 #include <set> |
9 #include <vector> | 9 #include <vector> |
10 | 10 |
11 #include "clang/AST/ASTConsumer.h" | 11 #include "clang/AST/ASTConsumer.h" |
12 #include "clang/AST/TypeLoc.h" | 12 #include "clang/AST/TypeLoc.h" |
13 #include "clang/Frontend/CompilerInstance.h" | 13 #include "clang/Frontend/CompilerInstance.h" |
14 | 14 |
15 // A class on top of ASTConsumer that forwards classes defined in Chromium | 15 // A class on top of ASTConsumer that forwards classes defined in Chromium |
16 // headers to subclasses which implement CheckChromeClass(). | 16 // headers to subclasses which implement CheckChromeClass(). |
17 class ChromeClassTester : public clang::ASTConsumer { | 17 class ChromeClassTester : public clang::ASTConsumer { |
18 public: | 18 public: |
19 explicit ChromeClassTester(clang::CompilerInstance& instance); | 19 explicit ChromeClassTester(clang::CompilerInstance& instance); |
20 virtual ~ChromeClassTester(); | 20 virtual ~ChromeClassTester(); |
21 | 21 |
22 // clang::ASTConsumer: | 22 // clang::ASTConsumer: |
23 virtual void HandleTagDeclDefinition(clang::TagDecl* tag); | 23 virtual void HandleTagDeclDefinition(clang::TagDecl* tag); |
24 virtual bool HandleTopLevelDecl(clang::DeclGroupRef group_ref); | 24 virtual bool HandleTopLevelDecl(clang::DeclGroupRef group_ref); |
25 | 25 |
| 26 void CheckTag(clang::TagDecl*); |
| 27 |
26 protected: | 28 protected: |
27 clang::CompilerInstance& instance() { return instance_; } | 29 clang::CompilerInstance& instance() { return instance_; } |
28 clang::DiagnosticsEngine& diagnostic() { return diagnostic_; } | 30 clang::DiagnosticsEngine& diagnostic() { return diagnostic_; } |
29 | 31 |
30 // Emits a simple warning; this shouldn't be used if you require printf-style | 32 // Emits a simple warning; this shouldn't be used if you require printf-style |
31 // printing. | 33 // printing. |
32 void emitWarning(clang::SourceLocation loc, const char* error); | 34 void emitWarning(clang::SourceLocation loc, const char* error); |
33 | 35 |
34 // Utility method for subclasses to check if this class is in a banned | 36 // Utility method for subclasses to check if this class is in a banned |
35 // namespace. | 37 // namespace. |
36 bool InBannedNamespace(const clang::Decl* record); | 38 bool InBannedNamespace(const clang::Decl* record); |
37 | 39 |
38 // Utility method for subclasses to determine the namespace of the | 40 // Utility method for subclasses to determine the namespace of the |
39 // specified record, if any. Unnamed namespaces will be identified as | 41 // specified record, if any. Unnamed namespaces will be identified as |
40 // "<anonymous namespace>". | 42 // "<anonymous namespace>". |
41 std::string GetNamespace(const clang::Decl* record); | 43 std::string GetNamespace(const clang::Decl* record); |
42 | 44 |
43 // Utility method for subclasses to check if this class is within an | 45 // Utility method for subclasses to check if this class is within an |
44 // implementation (.cc, .cpp, .mm) file. | 46 // implementation (.cc, .cpp, .mm) file. |
45 bool InImplementationFile(clang::SourceLocation location); | 47 bool InImplementationFile(clang::SourceLocation location); |
46 | 48 |
47 private: | 49 private: |
48 void BuildBannedLists(); | 50 void BuildBannedLists(); |
49 | 51 |
50 void CheckTag(clang::TagDecl*); | |
51 | |
52 // Filtered versions of tags that are only called with things defined in | 52 // Filtered versions of tags that are only called with things defined in |
53 // chrome header files. | 53 // chrome header files. |
54 virtual void CheckChromeClass(clang::SourceLocation record_location, | 54 virtual void CheckChromeClass(clang::SourceLocation record_location, |
55 clang::CXXRecordDecl* record) = 0; | 55 clang::CXXRecordDecl* record) = 0; |
56 | 56 |
57 // Filtered versions of enum type that are only called with things defined | 57 // Filtered versions of enum type that are only called with things defined |
58 // in chrome header files. | 58 // in chrome header files. |
59 virtual void CheckChromeEnum(clang::SourceLocation enum_location, | 59 virtual void CheckChromeEnum(clang::SourceLocation enum_location, |
60 clang::EnumDecl* enum_decl) { | 60 clang::EnumDecl* enum_decl) { |
61 } | 61 } |
(...skipping 19 matching lines...) Expand all Loading... |
81 std::vector<std::string> banned_directories_; | 81 std::vector<std::string> banned_directories_; |
82 | 82 |
83 // List of types that we don't check. | 83 // List of types that we don't check. |
84 std::set<std::string> ignored_record_names_; | 84 std::set<std::string> ignored_record_names_; |
85 | 85 |
86 // List of decls to check once the current top-level decl is parsed. | 86 // List of decls to check once the current top-level decl is parsed. |
87 std::vector<clang::TagDecl*> pending_class_decls_; | 87 std::vector<clang::TagDecl*> pending_class_decls_; |
88 }; | 88 }; |
89 | 89 |
90 #endif // TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ | 90 #endif // TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ |
OLD | NEW |