| 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 virtual void HandleTranslationUnit(clang::ASTContext& context) override; |
| 25 | 26 |
| 26 protected: | 27 //protected: |
| 27 clang::CompilerInstance& instance() { return instance_; } | 28 clang::CompilerInstance& instance() { return instance_; } |
| 28 clang::DiagnosticsEngine& diagnostic() { return diagnostic_; } | 29 clang::DiagnosticsEngine& diagnostic() { return diagnostic_; } |
| 29 | 30 |
| 30 // Emits a simple warning; this shouldn't be used if you require printf-style | 31 // Emits a simple warning; this shouldn't be used if you require printf-style |
| 31 // printing. | 32 // printing. |
| 32 void emitWarning(clang::SourceLocation loc, const char* error); | 33 void emitWarning(clang::SourceLocation loc, const char* error); |
| 33 | 34 |
| 34 // Utility method for subclasses to check if this class is in a banned | 35 // Utility method for subclasses to check if this class is in a banned |
| 35 // namespace. | 36 // namespace. |
| 36 bool InBannedNamespace(const clang::Decl* record); | 37 bool InBannedNamespace(const clang::Decl* record); |
| 37 | 38 |
| 38 // Utility method for subclasses to determine the namespace of the | 39 // Utility method for subclasses to determine the namespace of the |
| 39 // specified record, if any. Unnamed namespaces will be identified as | 40 // specified record, if any. Unnamed namespaces will be identified as |
| 40 // "<anonymous namespace>". | 41 // "<anonymous namespace>". |
| 41 std::string GetNamespace(const clang::Decl* record); | 42 std::string GetNamespace(const clang::Decl* record); |
| 42 | 43 |
| 43 // Utility method for subclasses to check if this class is within an | 44 // Utility method for subclasses to check if this class is within an |
| 44 // implementation (.cc, .cpp, .mm) file. | 45 // implementation (.cc, .cpp, .mm) file. |
| 45 bool InImplementationFile(clang::SourceLocation location); | 46 bool InImplementationFile(clang::SourceLocation location); |
| 46 | 47 |
| 47 private: | 48 //private: |
| 48 void BuildBannedLists(); | 49 void BuildBannedLists(); |
| 49 | 50 |
| 50 void CheckTag(clang::TagDecl*); | 51 void CheckTag(clang::TagDecl*); |
| 51 | 52 |
| 52 // Filtered versions of tags that are only called with things defined in | 53 // Filtered versions of tags that are only called with things defined in |
| 53 // chrome header files. | 54 // chrome header files. |
| 54 virtual void CheckChromeClass(clang::SourceLocation record_location, | 55 virtual void CheckChromeClass(clang::SourceLocation record_location, |
| 55 clang::CXXRecordDecl* record) = 0; | 56 clang::CXXRecordDecl* record) = 0; |
| 56 | 57 |
| 57 // Filtered versions of enum type that are only called with things defined | 58 // Filtered versions of enum type that are only called with things defined |
| 58 // in chrome header files. | 59 // in chrome header files. |
| 59 virtual void CheckChromeEnum(clang::SourceLocation enum_location, | 60 virtual void CheckChromeEnum(clang::SourceLocation enum_location, |
| 60 clang::EnumDecl* enum_decl) { | 61 clang::EnumDecl* enum_decl) { |
| 61 } | 62 } |
| 62 | 63 |
| 63 // Utility methods used for filtering out non-chrome classes (and ones we | 64 // Utility methods used for filtering out non-chrome classes (and ones we |
| 64 // deliberately ignore) in HandleTagDeclDefinition(). | 65 // deliberately ignore) in HandleTagDeclDefinition(). |
| 65 std::string GetNamespaceImpl(const clang::DeclContext* context, | 66 std::string GetNamespaceImpl(const clang::DeclContext* context, |
| 66 const std::string& candidate); | 67 const std::string& candidate); |
| 67 bool InBannedDirectory(clang::SourceLocation loc); | 68 bool InBannedDirectory(clang::SourceLocation loc); |
| 68 bool IsIgnoredType(const std::string& base_name); | 69 bool IsIgnoredType(const std::string& base_name); |
| 69 | 70 |
| 70 // Attempts to determine the filename for the given SourceLocation. | 71 // Attempts to determine the filename for the given SourceLocation. |
| 71 // Returns false if the filename could not be determined. | 72 // Returns false if the filename could not be determined. |
| 72 bool GetFilename(clang::SourceLocation loc, std::string* filename); | 73 bool GetFilename(clang::SourceLocation loc, std::string* filename); |
| 73 | 74 |
| 74 clang::CompilerInstance& instance_; | 75 clang::CompilerInstance& instance_; |
| 75 clang::DiagnosticsEngine& diagnostic_; | 76 clang::DiagnosticsEngine& diagnostic_; |
| 76 | 77 |
| 78 unsigned diag_might_be_gone_; |
| 79 unsigned diag_might_be_gone_note_here_; |
| 80 |
| 77 // List of banned namespaces. | 81 // List of banned namespaces. |
| 78 std::vector<std::string> banned_namespaces_; | 82 std::vector<std::string> banned_namespaces_; |
| 79 | 83 |
| 80 // List of banned directories. | 84 // List of banned directories. |
| 81 std::vector<std::string> banned_directories_; | 85 std::vector<std::string> banned_directories_; |
| 82 | 86 |
| 83 // List of types that we don't check. | 87 // List of types that we don't check. |
| 84 std::set<std::string> ignored_record_names_; | 88 std::set<std::string> ignored_record_names_; |
| 85 | 89 |
| 86 // List of decls to check once the current top-level decl is parsed. | 90 // List of decls to check once the current top-level decl is parsed. |
| 87 std::vector<clang::TagDecl*> pending_class_decls_; | 91 std::vector<clang::TagDecl*> pending_class_decls_; |
| 88 }; | 92 }; |
| 89 | 93 |
| 90 #endif // TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ | 94 #endif // TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_ |
| OLD | NEW |