tools/gn/setup.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef TOOLS_GN_SETUP_H_
   6 #define TOOLS_GN_SETUP_H_
   7
   8 #include <vector>
   9
  10 #include "base/files/file_path.h"
  11 #include "base/macros.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "tools/gn/build_settings.h"
  14 #include "tools/gn/builder.h"
  15 #include "tools/gn/label_pattern.h"
  16 #include "tools/gn/loader.h"
  17 #include "tools/gn/scheduler.h"
  18 #include "tools/gn/scope.h"
  19 #include "tools/gn/settings.h"
  20 #include "tools/gn/token.h"
  21 #include "tools/gn/toolchain.h"
  22
  23 class InputFile;
  24 class ParseNode;
  25
  26 namespace base {
  27 class CommandLine;
  28 }
  29
  30 extern const char kDotfile_Help[];
  31
  32 // Helper class to setup the build settings and environment for the various
  33 // commands to run.
  34 class Setup {
  35  public:
  36   Setup();
  37   ~Setup();
  38
  39   // Configures the build for the current command line. On success returns
  40   // true. On failure, prints the error and returns false.
  41   //
  42   // The parameter is the string the user specified for the build directory. We
  43   // will try to interpret this as a SourceDir if possible, and will fail if is
  44   // is malformed.
  45   //
  46   // With force_create = false, setup will fail if the build directory doesn't
  47   // alreay exist with an args file in it. With force_create set to true, the
  48   // directory will be created if necessary. Commands explicitly doing
  49   // generation should set this to true to create it, but querying commands
  50   // should set it to false to prevent creating oddly-named directories in case
  51   // the user omits the build directory argument (which is easy to do).
  52   bool DoSetup(const std::string& build_dir, bool force_create);
  53
  54   // Runs the load, returning true on success. On failure, prints the error
  55   // and returns false. This includes both RunPreMessageLoop() and
  56   // RunPostMessageLoop().
  57   bool Run();
  58
  59   Scheduler& scheduler() { return scheduler_; }
  60
  61   // Returns the file used to store the build arguments. Note that the path
  62   // might not exist.
  63   SourceFile GetBuildArgFile() const;
  64
  65   // Sets whether the build arguments should be filled during setup from the
  66   // command line/build argument file. This will be true by default. The use
  67   // case for setting it to false is when editing build arguments, we don't
  68   // want to rely on them being valid.
  69   void set_fill_arguments(bool fa) { fill_arguments_ = fa; }
  70
  71   // After a successful run, setting this will additionally cause the public
  72   // headers to be checked. Defaults to false.
  73   void set_check_public_headers(bool s) {
  74     check_public_headers_ = s;
  75   }
  76
  77   // Read from the .gn file, these are the targets to check. If the .gn file
  78   // does not specify anything, this will be null. If the .gn file specifies
  79   // the empty list, this will be non-null but empty.
  80   const std::vector<LabelPattern>* check_patterns() const {
  81     return check_patterns_.get();
  82   }
  83
  84   BuildSettings& build_settings() { return build_settings_; }
  85   Builder* builder() { return builder_.get(); }
  86   LoaderImpl* loader() { return loader_.get(); }
  87
  88   // Name of the file in the root build directory that contains the build
  89   // arguements.
  90   static const char kBuildArgFileName[];
  91
  92  private:
  93   // Performs the two sets of operations to run the generation before and after
  94   // the message loop is run.
  95   void RunPreMessageLoop();
  96   bool RunPostMessageLoop();
  97
  98   // Fills build arguments. Returns true on success.
  99   bool FillArguments(const base::CommandLine& cmdline);
 100
 101   // Fills the build arguments from the command line or from the build arg file.
 102   bool FillArgsFromCommandLine(const std::string& args);
 103   bool FillArgsFromFile();
 104
 105   // Given an already-loaded args_input_file_, parses and saves the resulting
 106   // arguments. Backend for the different FillArgs variants.
 107   bool FillArgsFromArgsInputFile();
 108
 109   // Writes the build arguments to the build arg file.
 110   bool SaveArgsToFile();
 111
 112   // Fills the root directory into the settings. Returns true on success.
 113   bool FillSourceDir(const base::CommandLine& cmdline);
 114
 115   // Fills the build directory given the value the user has specified.
 116   // Must happen after FillSourceDir so we can resolve source-relative
 117   // paths. If require_exists is false, it will fail if the dir doesn't exist.
 118   bool FillBuildDir(const std::string& build_dir, bool require_exists);
 119
 120   // Fills the python path portion of the command line. On failure, sets
 121   // it to just "python".
 122   void FillPythonPath();
 123
 124   // Run config file.
 125   bool RunConfigFile();
 126
 127   bool FillOtherConfig(const base::CommandLine& cmdline);
 128
 129   BuildSettings build_settings_;
 130   scoped_refptr<LoaderImpl> loader_;
 131   scoped_refptr<Builder> builder_;
 132
 133   SourceFile root_build_file_;
 134
 135   bool check_public_headers_;
 136
 137   // See getter for info.
 138   scoped_ptr<std::vector<LabelPattern>> check_patterns_;
 139
 140   Scheduler scheduler_;
 141
 142   // These settings and toolchain are used to interpret the command line and
 143   // dot file.
 144   Settings dotfile_settings_;
 145   Scope dotfile_scope_;
 146
 147   // State for invoking the dotfile.
 148   base::FilePath dotfile_name_;
 149   scoped_ptr<InputFile> dotfile_input_file_;
 150   std::vector<Token> dotfile_tokens_;
 151   scoped_ptr<ParseNode> dotfile_root_;
 152
 153   // Set to true when we should populate the build arguments from the command
 154   // line or build argument file. See setter above.
 155   bool fill_arguments_;
 156
 157   // State for invoking the command line args. We specifically want to keep
 158   // this around for the entire run so that Values can blame to the command
 159   // line when we issue errors about them.
 160   scoped_ptr<InputFile> args_input_file_;
 161   std::vector<Token> args_tokens_;
 162   scoped_ptr<ParseNode> args_root_;
 163
 164   DISALLOW_COPY_AND_ASSIGN(Setup);
 165 };
 166
 167 #endif  // TOOLS_GN_SETUP_H_