tools/gn/builder.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_BUILDER_H_
   6 #define TOOLS_GN_BUILDER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/callback.h"
  10 #include "base/containers/hash_tables.h"
  11 #include "base/memory/ref_counted.h"
  12 #include "tools/gn/builder_record.h"
  13 #include "tools/gn/label.h"
  14 #include "tools/gn/label_ptr.h"
  15
  16 class Config;
  17 class Err;
  18 class Loader;
  19 class ParseNode;
  20
  21 class Builder : public base::RefCountedThreadSafe<Builder> {
  22  public:
  23   typedef base::Callback<void(const BuilderRecord*)> ResolvedCallback;
  24
  25   Builder(Loader* loader);
  26
  27   // The resolved callback is called whenever a target has been resolved. This
  28   // will be executed only on the main thread.
  29   void set_resolved_callback(const ResolvedCallback& cb) {
  30     resolved_callback_ = cb;
  31   }
  32
  33   Loader* loader() const { return loader_; }
  34
  35   void ItemDefined(scoped_ptr<Item> item);
  36
  37   // Returns NULL if there is not a thing with the corresponding label.
  38   const Item* GetItem(const Label& label) const;
  39   const Toolchain* GetToolchain(const Label& label) const;
  40
  41   std::vector<const BuilderRecord*> GetAllRecords() const;
  42
  43   // Returns targets which should be generated and which are defined.
  44   std::vector<const Target*> GetAllResolvedTargets() const;
  45
  46   // Returns the record for the given label, or NULL if it doesn't exist.
  47   // Mostly used for unit tests.
  48   const BuilderRecord* GetRecord(const Label& label) const;
  49   BuilderRecord* GetRecord(const Label& label);
  50
  51   // If there are any undefined references, returns false and sets the error.
  52   bool CheckForBadItems(Err* err) const;
  53
  54  private:
  55   friend class base::RefCountedThreadSafe<Builder>;
  56
  57   virtual ~Builder();
  58
  59   bool TargetDefined(BuilderRecord* record, Err* err);
  60   bool ToolchainDefined(BuilderRecord* record, Err* err);
  61
  62   // Returns the record associated with the given label. This function checks
  63   // that if we already have references for it, the type matches. If no record
  64   // exists yet, a new one will be created.
  65   //
  66   // If any of the conditions fail, the return value will be null and the error
  67   // will be set. request_from is used as the source of the error.
  68   BuilderRecord* GetOrCreateRecordOfType(const Label& label,
  69                                          const ParseNode* request_from,
  70                                          BuilderRecord::ItemType type,
  71                                          Err* err);
  72
  73   // Returns the record associated with the given label. This function checks
  74   // that it's already been resolved to the correct type.
  75   //
  76   // If any of the conditions fail, the return value will be null and the error
  77   // will be set. request_from is used as the source of the error.
  78   BuilderRecord* GetResolvedRecordOfType(const Label& label,
  79                                          const ParseNode* request_from,
  80                                          BuilderRecord::ItemType type,
  81                                          Err* err);
  82
  83   bool AddDeps(BuilderRecord* record,
  84                const LabelConfigVector& configs,
  85                Err* err);
  86   bool AddDeps(BuilderRecord* record,
  87                const LabelTargetVector& targets,
  88                Err* err);
  89   bool AddToolchainDep(BuilderRecord* record,
  90                        const Target* target,
  91                        Err* err);
  92
  93   // Given a target, sets the "should generate" bit and pushes it through the
  94   // dependency tree. Any time the bit it set, we ensure that the given item is
  95   // scheduled to be loaded.
  96   //
  97   // If the force flag is set, we'll ignore the current state of the record's
  98   // should_generate flag, and set it on the dependents every time. This is
  99   // used when defining a target: the "should generate" may have been set
 100   // before the item was defined (if it is required by something that is
 101   // required). In this case, we need to re-push the "should generate" flag
 102   // to the item's dependencies.
 103   void RecursiveSetShouldGenerate(BuilderRecord* record, bool force);
 104
 105   void ScheduleItemLoadIfNecessary(BuilderRecord* record);
 106
 107   // This takes a BuilderRecord with resolved depdencies, and fills in the
 108   // target's Label*Vectors with the resolved pointers.
 109   bool ResolveItem(BuilderRecord* record, Err* err);
 110
 111   // Fills in the pointers in the given vector based on the labels. We assume
 112   // that everything should be resolved by this point, so will return an error
 113   // if anything isn't found or if the type doesn't match.
 114   bool ResolveDeps(LabelTargetVector* deps, Err* err);
 115   bool ResolveConfigs(LabelConfigVector* configs, Err* err);
 116   bool ResolveForwardDependentConfigs(Target* target, Err* err);
 117
 118   // Given a list of unresolved records, tries to find any circular
 119   // dependencies and returns the string describing the problem. If no circular
 120   // deps were found, returns the empty string.
 121   std::string CheckForCircularDependencies(
 122       const std::vector<const BuilderRecord*>& bad_records) const;
 123
 124   // Non owning pointer.
 125   Loader* loader_;
 126
 127   // Owning pointers.
 128   typedef base::hash_map<Label, BuilderRecord*> RecordMap;
 129   RecordMap records_;
 130
 131   ResolvedCallback resolved_callback_;
 132
 133   DISALLOW_COPY_AND_ASSIGN(Builder);
 134 };
 135
 136 #endif  // TOOLS_GN_BUILDER_H_