Support more configurability in GN toolchains

tools/gn/tool.h

+// Copyright 2014 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_TOOL_H_
+#define TOOLS_GN_TOOL_H_
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/logging.h"
+#include "tools/gn/substitution_list.h"
+#include "tools/gn/substitution_pattern.h"
+
+class Tool {
+ public:
+  enum DepsFormat {
+    DEPS_GCC = 0,
+    DEPS_MSVC = 1
+  };
+
+  Tool();
+  ~Tool();
+
+  // Getters/setters ----------------------------------------------------------

[jamesr, 2014/08/19 19:30:42]

seems like this should just be a struct with public members

[brettw, 2014/08/19 21:29:57]

I wanted to have the DCHECKs for verifying that it is not modiofied at the wrong
time.

+  //
+  // After the tool has had its attributes set, the caller must call
+  // SetComplete(), at which point no other changes can be made.
+
+  // Command to run.
+  const SubstitutionPattern& command() const {
+    return command_;
+  }
+  void set_command(const SubstitutionPattern& cmd) {
+    DCHECK(!complete_);
+    command_ = cmd;
+  }
+
+  // Should include a leading "." if nonempty.
+  const std::string& default_output_extension() const {
+    return default_output_extension_;
+  }
+  void set_default_output_extension(const std::string& ext) {
+    DCHECK(!complete_);
+    DCHECK(ext.empty() || ext[0] == '.');
+    default_output_extension_ = ext;
+  }
+
+  // Dependency file (if supported).
+  const SubstitutionPattern& depfile() const {
+    return depfile_;
+  }
+  void set_depfile(const SubstitutionPattern& df) {
+    DCHECK(!complete_);
+    depfile_ = df;
+  }
+  DepsFormat depsformat() const {
+    return depsformat_;
+  }
+  void set_depsformat(DepsFormat f) {
+    DCHECK(!complete_);
+    depsformat_ = f;
+  }
+
+  const SubstitutionPattern& description() const {
+    return description_;
+  }
+  void set_description(const SubstitutionPattern& desc) {
+    DCHECK(!complete_);
+    description_ = desc;
+  }
+
+  // Switch prefixes for libs and lib dirs.
+  const std::string& lib_switch() const {
+    return lib_switch_;
+  }
+  void set_lib_switch(const std::string& s) {
+    DCHECK(!complete_);
+    lib_switch_ = s;
+  }
+  const std::string& lib_dir_switch() const {

[jamesr, 2014/08/19 19:30:42]

either put a blank line between different getter/setter pairs or don't, having a
mix in this file is jarring to read

[brettw, 2014/08/19 21:29:57]

Done.

+    return lib_dir_switch_;
+  }
+  void set_lib_dir_switch(const std::string& s) {
+    DCHECK(!complete_);
+    lib_dir_switch_ = s;
+  }
+
+  const SubstitutionList& outputs() const {
+    return outputs_;
+  }
+  void set_outputs(const SubstitutionList& out) {
+    DCHECK(!complete_);
+    outputs_ = out;
+  }
+
+  // Should match files in the outputs() if nonempty.
+  const SubstitutionPattern& link_output() const {
+    return link_output_;
+  }
+  void set_link_output(const SubstitutionPattern& link_out) {
+    DCHECK(!complete_);
+    link_output_ = link_out;
+  }
+  const SubstitutionPattern& depend_output() const {
+    return depend_output_;
+  }
+  void set_depend_output(const SubstitutionPattern& dep_out) {
+    DCHECK(!complete_);
+    depend_output_ = dep_out;
+  }
+
+  const std::string& output_prefix() const {
+    return output_prefix_;
+  }
+  void set_output_prefix(const std::string& s) {
+    DCHECK(!complete_);
+    output_prefix_ = s;
+  }
+
+  const std::string& pool() const {
+    return pool_;
+  }
+  void set_pool(const std::string& s) {
+    DCHECK(!complete_);
+    pool_ = s;
+  }
+
+  bool restat() const {
+    return restat_;
+  }
+  void set_restat(bool r) {
+    DCHECK(!complete_);
+    restat_ = r;
+  }
+
+  const SubstitutionPattern& rspfile() const {
+    return rspfile_;
+  }
+  void set_rspfile(const SubstitutionPattern& rsp) {
+    DCHECK(!complete_);
+    rspfile_ = rsp;
+  }
+
+  const SubstitutionPattern& rspfile_content() const {
+    return rspfile_content_;
+  }
+  void set_rspfile_content(const SubstitutionPattern& content) {
+    DCHECK(!complete_);
+    rspfile_content_ = content;
+  }
+
+  // Other functions ----------------------------------------------------------
+
+  // Called when the toolchain is saving this tool, after everything is filled
+  // in.
+  void SetComplete();
+
+  // Returns true if this tool has separate outputs for dependency tracking
+  // and linking.
+  bool has_separate_solink_files() const {
+    return !link_output_.empty() || !depend_output_.empty();
+  }
+
+  // Substitutions required by this tool.
+  const SubstitutionBits& substitution_bits() const {
+    DCHECK(complete_);
+    return substitution_bits_;
+  }
+
+ public:
+  SubstitutionPattern command_;
+  std::string default_output_extension_;
+  SubstitutionPattern depfile_;
+  DepsFormat depsformat_;
+  SubstitutionPattern description_;
+  std::string lib_switch_;
+  std::string lib_dir_switch_;
+  SubstitutionList outputs_;
+  SubstitutionPattern link_output_;
+  SubstitutionPattern depend_output_;
+  std::string output_prefix_;
+  std::string pool_;
+  bool restat_;
+  SubstitutionPattern rspfile_;
+  SubstitutionPattern rspfile_content_;
+
+  bool complete_;
+
+  SubstitutionBits substitution_bits_;
+
+  DISALLOW_COPY_AND_ASSIGN(Tool);
+};
+
+#endif  // TOOLS_GN_TOOL_H_