Refactor banned directory checking so Blink can opt into certain checks.

tools/clang/plugins/ChromeClassTester.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_
 #define TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_
 
 #include <set>
 #include <vector>
 
@@ skipping 14 matching lines @@
   void CheckTag(clang::TagDecl*);
 
   clang::DiagnosticsEngine::Level getErrorLevel();
 
  protected:
   clang::CompilerInstance& instance() { return instance_; }
   clang::DiagnosticsEngine& diagnostic() { return diagnostic_; }
 
   // Emits a simple warning; this shouldn't be used if you require printf-style
   // printing.
+  // TODO(dcheng): This will be removed. Do not add new usage.
   void emitWarning(clang::SourceLocation loc, const char* error);
 
   // Utility method for subclasses to check if this class is in a banned
   // namespace.
   bool InBannedNamespace(const clang::Decl* record);
 
-  // Utility method for subclasses to check if the source location is in a
-  // directory the plugin should ignore.
-  bool InBannedDirectory(clang::SourceLocation loc);
+  // Utility method for subclasses to check how a certain SourceLocation should
+  // be handled. The main criteria for classification is the SourceLocation's
+  // path (e.g. whether it's in //third_party).
+  enum class LocationType {
+    kNotIgnored,
+    kBlink,
+    kIgnored,

[Nico, 2017/04/06 19:03:13]

kNotIgnored, kIgnored, kBlink sounds a bit like TRUE, FALSE, FILE_NOT_FOUND –
maybe kChromium, kBlink, kThirdParty (or kIgnored)? With comments explaining
that kChromium means default checks, kBlink is a transitionary thing (hopefully,
maybe, with link to your bug), and that kThirdParty (kIgnored) is for code where
we don't diag.

[dcheng, 2017/04/11 08:38:40]

Done.

+  };
+  LocationType ClassifyLocation(clang::SourceLocation loc);
 
   // Utility method for subclasses to determine the namespace of the
   // specified record, if any. Unnamed namespaces will be identified as
   // "<anonymous namespace>".
   std::string GetNamespace(const clang::Decl* record);
 
   // Utility method to check whether the given record has any of the ignored
   // base classes.
   bool HasIgnoredBases(const clang::CXXRecordDecl* record);
 
   // Utility method for subclasses to check if this class is within an
   // implementation (.cc, .cpp, .mm) file.
   bool InImplementationFile(clang::SourceLocation location);
 
   // Options.
   const chrome_checker::Options options_;
 
  private:
   void BuildBannedLists();
 
   // Filtered versions of tags that are only called with things defined in
   // chrome header files.
-  virtual void CheckChromeClass(clang::SourceLocation record_location,
+  virtual void CheckChromeClass(LocationType location_type,
+                                clang::SourceLocation record_location,
                                 clang::CXXRecordDecl* record) = 0;
 
   // Filtered versions of enum type that are only called with things defined
   // in chrome header files.
-  virtual void CheckChromeEnum(clang::SourceLocation enum_location,
-                               clang::EnumDecl* enum_decl) {
-  }
+  virtual void CheckChromeEnum(LocationType location_type,
+                               clang::SourceLocation enum_location,
+                               clang::EnumDecl* enum_decl) = 0;
 
   // Utility methods used for filtering out non-chrome classes (and ones we
   // deliberately ignore) in HandleTagDeclDefinition().
   std::string GetNamespaceImpl(const clang::DeclContext* context,
                                const std::string& candidate);
   bool IsIgnoredType(const std::string& base_name);
 
   // Attempts to determine the filename for the given SourceLocation.
   // Returns false if the filename could not be determined.
   bool GetFilename(clang::SourceLocation loc, std::string* filename);
 
   clang::CompilerInstance& instance_;
   clang::DiagnosticsEngine& diagnostic_;
 
   // List of banned namespaces.
   std::set<std::string> banned_namespaces_;
 
-  // List of directories allowed even though their parent directories are in
-  // |banned_directories_|, below.
-  std::set<std::string> allowed_directories_;
+  // List of Blink directories.
+  std::set<std::string> blink_directories_;
 
   // List of banned directories.
   std::set<std::string> banned_directories_;
 
   // List of types that we don't check.
   std::set<std::string> ignored_record_names_;
 
   // List of base classes that we skip when checking complex class ctors/dtors.
   std::set<std::string> ignored_base_classes_;
 };
 
 #endif  // TOOLS_CLANG_PLUGINS_CHROMECLASSTESTER_H_