[Refactor Xcode Objects] Enable generating per file '--help' compiler flag

tools/gn/xcode_object.h

 // Copyright 2016 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_GN_XCODE_OBJECT_H_
 #define TOOLS_GN_XCODE_OBJECT_H_
 
 #include <iosfwd>
 #include <map>
 #include <memory>
@@ skipping 135 matching lines @@
   void Print(std::ostream& out, unsigned indent) const override;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(PBXAggregateTarget);
 };
 
 // PBXBuildFile ---------------------------------------------------------------
 
 class PBXBuildFile : public PBXObject {
  public:
+  enum HelpCompilerFlagEnabled { HELP_FLAG_ENABLED, HELP_FLAG_DISABLED };

[sdefresne, 2016/12/17 00:07:27]

I don't really like the redundancy of the enumeration name and value and
variable.

What about moving the enum outside of the class, renaming it to CompilerFlags,
changing it to enum class (for proper scoping) and renaming the variable as
compiler_flags_.

Something like this:

enum class CompilerFlags {
  NONE,
  HELP,
};

class PBXBuildFile : public PBXObject {
 public:
  PBXBuildFile(const PBXFileReference* file_reference,
               const PBXSourcesBuildPhase* build_phase,
               CompilerFlags compiler_flags);
  ...
};

Then you can use it like this, later in the code:

  if (compiler_flags_ == CompilerFlags::HELP) {
    std::map<std::string, std::string> ...
  }

[liaoyuke, 2016/12/19 08:02:40]

Thank you for explaining the details. This is a much better design and it would
be more flexible if one needs to add other flags.

+
   PBXBuildFile(const PBXFileReference* file_reference,
-               const PBXSourcesBuildPhase* build_phase);
+               const PBXSourcesBuildPhase* build_phase,
+               const HelpCompilerFlagEnabled help_flag_enabled);
   ~PBXBuildFile() override;
 
   // PXBObject implementation.
   PBXObjectClass Class() const override;
   std::string Name() const override;
   void Print(std::ostream& out, unsigned indent) const override;
 
  private:
   const PBXFileReference* file_reference_;
   const PBXSourcesBuildPhase* build_phase_;
+  const HelpCompilerFlagEnabled help_flag_enabled_;
 
   DISALLOW_COPY_AND_ASSIGN(PBXBuildFile);
 };
 
 // PBXFileReference -----------------------------------------------------------
 
 class PBXFileReference : public PBXObject {
  public:
   PBXFileReference(const std::string& name,
                    const std::string& path,
@@ skipping 62 matching lines @@
  public:
   PBXNativeTarget(const std::string& name,
                   const std::string& shell_script,
                   const std::string& config_name,
                   const PBXAttributes& attributes,
                   const std::string& product_type,
                   const std::string& product_name,
                   const PBXFileReference* product_reference);
   ~PBXNativeTarget() override;
 
-  void AddFileForIndexing(const PBXFileReference* file_reference);
+  void AddFileForIndexing(const PBXFileReference* file_reference,
+                          const PBXBuildFile::HelpCompilerFlagEnabled);
 
   // PBXObject implementation.
   PBXObjectClass Class() const override;
   void Print(std::ostream& out, unsigned indent) const override;
 
  private:
   const PBXFileReference* product_reference_;
   std::string product_type_;
   std::string product_name_;
 
   DISALLOW_COPY_AND_ASSIGN(PBXNativeTarget);
 };
 
 // PBXProject -----------------------------------------------------------------
 
 class PBXProject : public PBXObject {
  public:
   PBXProject(const std::string& name,
              const std::string& config_name,
              const std::string& source_path,
              const PBXAttributes& attributes);
   ~PBXProject() override;
 
-  void AddSourceFile(const std::string& source_path);
+  void AddSourceFile(
+      const std::string& source_path,
+      const PBXBuildFile::HelpCompilerFlagEnabled help_flag_enabled);
   void AddAggregateTarget(const std::string& name,
                           const std::string& shell_script);
   void AddNativeTarget(const std::string& name,
                        const std::string& type,
                        const std::string& output_name,
                        const std::string& output_type,
                        const std::string& shell_script);
 
   void SetProjectDirPath(const std::string& project_dir_path);
   void SetProjectRoot(const std::string& project_root);
@@ skipping 100 matching lines @@
   void Print(std::ostream& out, unsigned indent) const override;
 
  private:
   std::vector<std::unique_ptr<XCBuildConfiguration>> configurations_;
   const PBXObject* owner_reference_;
 
   DISALLOW_COPY_AND_ASSIGN(XCConfigurationList);
 };
 
 #endif  // TOOLS_GN_XCODE_OBJECT_H_