Colin Cross | 8e0c511 | 2015-01-23 14:15:10 -0800 | [diff] [blame] | 1 | // Copyright 2014 Google Inc. All rights reserved. |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 15 | package blueprint |
| 16 | |
| 17 | import ( |
| 18 | "blueprint/parser" |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 19 | "blueprint/proptools" |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 20 | "bytes" |
| 21 | "errors" |
| 22 | "fmt" |
| 23 | "io" |
| 24 | "os" |
| 25 | "path/filepath" |
| 26 | "reflect" |
Romain Guy | 2852965 | 2014-08-12 17:50:11 -0700 | [diff] [blame] | 27 | "runtime" |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 28 | "sort" |
Colin Cross | 6134a5c | 2015-02-10 11:26:26 -0800 | [diff] [blame] | 29 | "strconv" |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 30 | "strings" |
| 31 | "text/scanner" |
| 32 | "text/template" |
| 33 | ) |
| 34 | |
| 35 | var ErrBuildActionsNotReady = errors.New("build actions are not ready") |
| 36 | |
| 37 | const maxErrors = 10 |
| 38 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 39 | // A Context contains all the state needed to parse a set of Blueprints files |
| 40 | // and generate a Ninja file. The process of generating a Ninja file proceeds |
| 41 | // through a series of four phases. Each phase corresponds with a some methods |
| 42 | // on the Context object |
| 43 | // |
| 44 | // Phase Methods |
| 45 | // ------------ ------------------------------------------- |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 46 | // 1. Registration RegisterModuleType, RegisterSingletonType |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 47 | // |
| 48 | // 2. Parse ParseBlueprintsFiles, Parse |
| 49 | // |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 50 | // 3. Generate ResolveDependencies, PrepareBuildActions |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 51 | // |
| 52 | // 4. Write WriteBuildFile |
| 53 | // |
| 54 | // The registration phase prepares the context to process Blueprints files |
| 55 | // containing various types of modules. The parse phase reads in one or more |
| 56 | // Blueprints files and validates their contents against the module types that |
| 57 | // have been registered. The generate phase then analyzes the parsed Blueprints |
| 58 | // contents to create an internal representation for the build actions that must |
| 59 | // be performed. This phase also performs validation of the module dependencies |
| 60 | // and property values defined in the parsed Blueprints files. Finally, the |
| 61 | // write phase generates the Ninja manifest text based on the generated build |
| 62 | // actions. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 63 | type Context struct { |
| 64 | // set at instantiation |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 65 | moduleFactories map[string]ModuleFactory |
| 66 | moduleGroups map[string]*moduleGroup |
| 67 | moduleInfo map[Module]*moduleInfo |
| 68 | modulesSorted []*moduleInfo |
| 69 | singletonInfo map[string]*singletonInfo |
| 70 | mutatorInfo []*mutatorInfo |
| 71 | earlyMutatorInfo []*earlyMutatorInfo |
| 72 | variantMutatorNames []string |
| 73 | moduleNinjaNames map[string]*moduleGroup |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 74 | |
| 75 | dependenciesReady bool // set to true on a successful ResolveDependencies |
| 76 | buildActionsReady bool // set to true on a successful PrepareBuildActions |
| 77 | |
| 78 | // set by SetIgnoreUnknownModuleTypes |
| 79 | ignoreUnknownModuleTypes bool |
| 80 | |
| 81 | // set during PrepareBuildActions |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 82 | pkgNames map[*PackageContext]string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 83 | globalVariables map[Variable]*ninjaString |
| 84 | globalPools map[Pool]*poolDef |
| 85 | globalRules map[Rule]*ruleDef |
| 86 | |
| 87 | // set during PrepareBuildActions |
| 88 | buildDir *ninjaString // The builddir special Ninja variable |
| 89 | requiredNinjaMajor int // For the ninja_required_version variable |
| 90 | requiredNinjaMinor int // For the ninja_required_version variable |
| 91 | requiredNinjaMicro int // For the ninja_required_version variable |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 92 | |
| 93 | // set lazily by sortedModuleNames |
| 94 | cachedSortedModuleNames []string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 95 | } |
| 96 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 97 | // An Error describes a problem that was encountered that is related to a |
| 98 | // particular location in a Blueprints file. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 99 | type Error struct { |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 100 | Err error // the error that occurred |
| 101 | Pos scanner.Position // the relevant Blueprints file location |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | type localBuildActions struct { |
| 105 | variables []*localVariable |
| 106 | rules []*localRule |
| 107 | buildDefs []*buildDef |
| 108 | } |
| 109 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 110 | type moduleGroup struct { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 111 | name string |
| 112 | ninjaName string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 113 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 114 | modules []*moduleInfo |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 115 | } |
| 116 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 117 | type moduleInfo struct { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 118 | // set during Parse |
| 119 | typeName string |
| 120 | relBlueprintsFile string |
| 121 | pos scanner.Position |
| 122 | propertyPos map[string]scanner.Position |
| 123 | properties struct { |
| 124 | Name string |
| 125 | Deps []string |
| 126 | } |
| 127 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 128 | variantName string |
| 129 | variant variationMap |
| 130 | dependencyVariant variationMap |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 131 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 132 | logicModule Module |
| 133 | group *moduleGroup |
| 134 | moduleProperties []interface{} |
| 135 | |
| 136 | // set during ResolveDependencies |
| 137 | directDeps []*moduleInfo |
| 138 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 139 | // set during updateDependencies |
| 140 | reverseDeps []*moduleInfo |
| 141 | depsCount int |
| 142 | |
| 143 | // used by parallelVisitAllBottomUp |
| 144 | waitingCount int |
| 145 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 146 | // set during each runMutator |
| 147 | splitModules []*moduleInfo |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 148 | |
| 149 | // set during PrepareBuildActions |
| 150 | actionDefs localBuildActions |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 151 | } |
| 152 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 153 | // A Variation is a way that a variant of a module differs from other variants of the same module. |
| 154 | // For example, two variants of the same module might have Variation{"arch","arm"} and |
| 155 | // Variation{"arch","arm64"} |
| 156 | type Variation struct { |
| 157 | // Mutator is the axis on which this variation applies, i.e. "arch" or "link" |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 158 | Mutator string |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 159 | // Variation is the name of the variation on the axis, i.e. "arm" or "arm64" for arch, or |
| 160 | // "shared" or "static" for link. |
| 161 | Variation string |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 162 | } |
| 163 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 164 | // A variationMap stores a map of Mutator to Variation to specify a variant of a module. |
| 165 | type variationMap map[string]string |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 166 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 167 | func (vm variationMap) clone() variationMap { |
| 168 | newVm := make(variationMap) |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 169 | for k, v := range vm { |
| 170 | newVm[k] = v |
| 171 | } |
| 172 | |
| 173 | return newVm |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 174 | } |
| 175 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 176 | func (vm variationMap) equal(other variationMap) bool { |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 177 | return reflect.DeepEqual(vm, other) |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 178 | } |
| 179 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 180 | type singletonInfo struct { |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 181 | // set during RegisterSingletonType |
| 182 | factory SingletonFactory |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 183 | singleton Singleton |
| 184 | |
| 185 | // set during PrepareBuildActions |
| 186 | actionDefs localBuildActions |
| 187 | } |
| 188 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 189 | type mutatorInfo struct { |
| 190 | // set during RegisterMutator |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 191 | topDownMutator TopDownMutator |
| 192 | bottomUpMutator BottomUpMutator |
| 193 | name string |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 194 | } |
| 195 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 196 | type earlyMutatorInfo struct { |
| 197 | // set during RegisterEarlyMutator |
| 198 | mutator EarlyMutator |
| 199 | name string |
| 200 | } |
| 201 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 202 | func (e *Error) Error() string { |
| 203 | |
| 204 | return fmt.Sprintf("%s: %s", e.Pos, e.Err) |
| 205 | } |
| 206 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 207 | // NewContext creates a new Context object. The created context initially has |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 208 | // no module or singleton factories registered, so the RegisterModuleFactory and |
| 209 | // RegisterSingletonFactory methods must be called before it can do anything |
| 210 | // useful. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 211 | func NewContext() *Context { |
| 212 | return &Context{ |
Colin Cross | 6134a5c | 2015-02-10 11:26:26 -0800 | [diff] [blame] | 213 | moduleFactories: make(map[string]ModuleFactory), |
| 214 | moduleGroups: make(map[string]*moduleGroup), |
| 215 | moduleInfo: make(map[Module]*moduleInfo), |
| 216 | singletonInfo: make(map[string]*singletonInfo), |
| 217 | moduleNinjaNames: make(map[string]*moduleGroup), |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 218 | } |
| 219 | } |
| 220 | |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 221 | // A ModuleFactory function creates a new Module object. See the |
| 222 | // Context.RegisterModuleType method for details about how a registered |
| 223 | // ModuleFactory is used by a Context. |
| 224 | type ModuleFactory func() (m Module, propertyStructs []interface{}) |
| 225 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 226 | // RegisterModuleType associates a module type name (which can appear in a |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 227 | // Blueprints file) with a Module factory function. When the given module type |
| 228 | // name is encountered in a Blueprints file during parsing, the Module factory |
| 229 | // is invoked to instantiate a new Module object to handle the build action |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 230 | // generation for the module. If a Mutator splits a module into multiple variants, |
| 231 | // the factory is invoked again to create a new Module for each variant. |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 232 | // |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 233 | // The module type names given here must be unique for the context. The factory |
| 234 | // function should be a named function so that its package and name can be |
| 235 | // included in the generated Ninja file for debugging purposes. |
| 236 | // |
| 237 | // The factory function returns two values. The first is the newly created |
| 238 | // Module object. The second is a slice of pointers to that Module object's |
| 239 | // properties structs. Each properties struct is examined when parsing a module |
| 240 | // definition of this type in a Blueprints file. Exported fields of the |
| 241 | // properties structs are automatically set to the property values specified in |
| 242 | // the Blueprints file. The properties struct field names determine the name of |
| 243 | // the Blueprints file properties that are used - the Blueprints property name |
| 244 | // matches that of the properties struct field name with the first letter |
| 245 | // converted to lower-case. |
| 246 | // |
| 247 | // The fields of the properties struct must be either []string, a string, or |
| 248 | // bool. The Context will panic if a Module gets instantiated with a properties |
| 249 | // struct containing a field that is not one these supported types. |
| 250 | // |
| 251 | // Any properties that appear in the Blueprints files that are not built-in |
| 252 | // module properties (such as "name" and "deps") and do not have a corresponding |
| 253 | // field in the returned module properties struct result in an error during the |
| 254 | // Context's parse phase. |
| 255 | // |
| 256 | // As an example, the follow code: |
| 257 | // |
| 258 | // type myModule struct { |
| 259 | // properties struct { |
| 260 | // Foo string |
| 261 | // Bar []string |
| 262 | // } |
| 263 | // } |
| 264 | // |
| 265 | // func NewMyModule() (blueprint.Module, []interface{}) { |
| 266 | // module := new(myModule) |
| 267 | // properties := &module.properties |
| 268 | // return module, []interface{}{properties} |
| 269 | // } |
| 270 | // |
| 271 | // func main() { |
| 272 | // ctx := blueprint.NewContext() |
| 273 | // ctx.RegisterModuleType("my_module", NewMyModule) |
| 274 | // // ... |
| 275 | // } |
| 276 | // |
| 277 | // would support parsing a module defined in a Blueprints file as follows: |
| 278 | // |
| 279 | // my_module { |
| 280 | // name: "myName", |
| 281 | // foo: "my foo string", |
| 282 | // bar: ["my", "bar", "strings"], |
| 283 | // } |
| 284 | // |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 285 | // The factory function may be called from multiple goroutines. Any accesses |
| 286 | // to global variables must be synchronized. |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 287 | func (c *Context) RegisterModuleType(name string, factory ModuleFactory) { |
| 288 | if _, present := c.moduleFactories[name]; present { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 289 | panic(errors.New("module type name is already registered")) |
| 290 | } |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 291 | c.moduleFactories[name] = factory |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 292 | } |
| 293 | |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 294 | // A SingletonFactory function creates a new Singleton object. See the |
| 295 | // Context.RegisterSingletonType method for details about how a registered |
| 296 | // SingletonFactory is used by a Context. |
| 297 | type SingletonFactory func() Singleton |
| 298 | |
| 299 | // RegisterSingletonType registers a singleton type that will be invoked to |
| 300 | // generate build actions. Each registered singleton type is instantiated and |
| 301 | // and invoked exactly once as part of the generate phase. |
| 302 | // |
| 303 | // The singleton type names given here must be unique for the context. The |
| 304 | // factory function should be a named function so that its package and name can |
| 305 | // be included in the generated Ninja file for debugging purposes. |
| 306 | func (c *Context) RegisterSingletonType(name string, factory SingletonFactory) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 307 | if _, present := c.singletonInfo[name]; present { |
| 308 | panic(errors.New("singleton name is already registered")) |
| 309 | } |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 310 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 311 | c.singletonInfo[name] = &singletonInfo{ |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 312 | factory: factory, |
| 313 | singleton: factory(), |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 314 | } |
| 315 | } |
| 316 | |
| 317 | func singletonPkgPath(singleton Singleton) string { |
| 318 | typ := reflect.TypeOf(singleton) |
| 319 | for typ.Kind() == reflect.Ptr { |
| 320 | typ = typ.Elem() |
| 321 | } |
| 322 | return typ.PkgPath() |
| 323 | } |
| 324 | |
| 325 | func singletonTypeName(singleton Singleton) string { |
| 326 | typ := reflect.TypeOf(singleton) |
| 327 | for typ.Kind() == reflect.Ptr { |
| 328 | typ = typ.Elem() |
| 329 | } |
| 330 | return typ.PkgPath() + "." + typ.Name() |
| 331 | } |
| 332 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 333 | // RegisterTopDownMutator registers a mutator that will be invoked to propagate |
| 334 | // dependency info top-down between Modules. Each registered mutator |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 335 | // is invoked in registration order (mixing TopDownMutators and BottomUpMutators) |
| 336 | // once per Module, and is invoked on a module before being invoked on any of its |
| 337 | // dependencies. |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 338 | // |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 339 | // The mutator type names given here must be unique to all top down mutators in |
| 340 | // the Context. |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 341 | func (c *Context) RegisterTopDownMutator(name string, mutator TopDownMutator) { |
| 342 | for _, m := range c.mutatorInfo { |
| 343 | if m.name == name && m.topDownMutator != nil { |
| 344 | panic(fmt.Errorf("mutator name %s is already registered", name)) |
| 345 | } |
| 346 | } |
| 347 | |
| 348 | c.mutatorInfo = append(c.mutatorInfo, &mutatorInfo{ |
| 349 | topDownMutator: mutator, |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 350 | name: name, |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 351 | }) |
| 352 | } |
| 353 | |
| 354 | // RegisterBottomUpMutator registers a mutator that will be invoked to split |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 355 | // Modules into variants. Each registered mutator is invoked in registration |
| 356 | // order (mixing TopDownMutators and BottomUpMutators) once per Module, and is |
| 357 | // invoked on dependencies before being invoked on dependers. |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 358 | // |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 359 | // The mutator type names given here must be unique to all bottom up or early |
| 360 | // mutators in the Context. |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 361 | func (c *Context) RegisterBottomUpMutator(name string, mutator BottomUpMutator) { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 362 | for _, m := range c.variantMutatorNames { |
| 363 | if m == name { |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 364 | panic(fmt.Errorf("mutator name %s is already registered", name)) |
| 365 | } |
| 366 | } |
| 367 | |
| 368 | c.mutatorInfo = append(c.mutatorInfo, &mutatorInfo{ |
| 369 | bottomUpMutator: mutator, |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 370 | name: name, |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 371 | }) |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 372 | |
| 373 | c.variantMutatorNames = append(c.variantMutatorNames, name) |
| 374 | } |
| 375 | |
| 376 | // RegisterEarlyMutator registers a mutator that will be invoked to split |
| 377 | // Modules into multiple variant Modules before any dependencies have been |
| 378 | // created. Each registered mutator is invoked in registration order once |
| 379 | // per Module (including each variant from previous early mutators). Module |
| 380 | // order is unpredictable. |
| 381 | // |
| 382 | // In order for dependencies to be satisifed in a later pass, all dependencies |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 383 | // of a module either must have an identical variant or must have no variations. |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 384 | // |
| 385 | // The mutator type names given here must be unique to all bottom up or early |
| 386 | // mutators in the Context. |
| 387 | func (c *Context) RegisterEarlyMutator(name string, mutator EarlyMutator) { |
| 388 | for _, m := range c.variantMutatorNames { |
| 389 | if m == name { |
| 390 | panic(fmt.Errorf("mutator name %s is already registered", name)) |
| 391 | } |
| 392 | } |
| 393 | |
| 394 | c.earlyMutatorInfo = append(c.earlyMutatorInfo, &earlyMutatorInfo{ |
| 395 | mutator: mutator, |
| 396 | name: name, |
| 397 | }) |
| 398 | |
| 399 | c.variantMutatorNames = append(c.variantMutatorNames, name) |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 400 | } |
| 401 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 402 | // SetIgnoreUnknownModuleTypes sets the behavior of the context in the case |
| 403 | // where it encounters an unknown module type while parsing Blueprints files. By |
| 404 | // default, the context will report unknown module types as an error. If this |
| 405 | // method is called with ignoreUnknownModuleTypes set to true then the context |
| 406 | // will silently ignore unknown module types. |
| 407 | // |
| 408 | // This method should generally not be used. It exists to facilitate the |
| 409 | // bootstrapping process. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 410 | func (c *Context) SetIgnoreUnknownModuleTypes(ignoreUnknownModuleTypes bool) { |
| 411 | c.ignoreUnknownModuleTypes = ignoreUnknownModuleTypes |
| 412 | } |
| 413 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 414 | // Parse parses a single Blueprints file from r, creating Module objects for |
| 415 | // each of the module definitions encountered. If the Blueprints file contains |
| 416 | // an assignment to the "subdirs" variable, then the subdirectories listed are |
| 417 | // returned in the subdirs first return value. |
| 418 | // |
| 419 | // rootDir specifies the path to the root directory of the source tree, while |
| 420 | // filename specifies the path to the Blueprints file. These paths are used for |
| 421 | // error reporting and for determining the module's directory. |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 422 | func (c *Context) parse(rootDir, filename string, r io.Reader, |
| 423 | scope *parser.Scope) (subdirs []string, modules []*moduleInfo, errs []error, |
| 424 | outScope *parser.Scope) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 425 | |
Jamie Gennis | ec70128 | 2014-06-12 20:06:31 -0700 | [diff] [blame] | 426 | relBlueprintsFile, err := filepath.Rel(rootDir, filename) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 427 | if err != nil { |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 428 | return nil, nil, []error{err}, nil |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 429 | } |
| 430 | |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 431 | scope = parser.NewScope(scope) |
| 432 | scope.Remove("subdirs") |
Colin Cross | d1facc1 | 2015-01-08 14:56:03 -0800 | [diff] [blame] | 433 | file, errs := parser.Parse(filename, r, scope) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 434 | if len(errs) > 0 { |
| 435 | for i, err := range errs { |
| 436 | if parseErr, ok := err.(*parser.ParseError); ok { |
| 437 | err = &Error{ |
| 438 | Err: parseErr.Err, |
| 439 | Pos: parseErr.Pos, |
| 440 | } |
| 441 | errs[i] = err |
| 442 | } |
| 443 | } |
| 444 | |
| 445 | // If there were any parse errors don't bother trying to interpret the |
| 446 | // result. |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 447 | return nil, nil, errs, nil |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 448 | } |
| 449 | |
Colin Cross | d1facc1 | 2015-01-08 14:56:03 -0800 | [diff] [blame] | 450 | for _, def := range file.Defs { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 451 | var newErrs []error |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 452 | var newModule *moduleInfo |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 453 | switch def := def.(type) { |
| 454 | case *parser.Module: |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 455 | newModule, newErrs = c.processModuleDef(def, relBlueprintsFile) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 456 | |
| 457 | case *parser.Assignment: |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 458 | // Already handled via Scope object |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 459 | default: |
| 460 | panic("unknown definition type") |
| 461 | } |
| 462 | |
| 463 | if len(newErrs) > 0 { |
| 464 | errs = append(errs, newErrs...) |
| 465 | if len(errs) > maxErrors { |
| 466 | break |
| 467 | } |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 468 | } else if newModule != nil { |
| 469 | modules = append(modules, newModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 470 | } |
| 471 | } |
| 472 | |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 473 | subdirs, newErrs := c.processSubdirs(scope) |
| 474 | if len(newErrs) > 0 { |
| 475 | errs = append(errs, newErrs...) |
| 476 | } |
| 477 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 478 | return subdirs, modules, errs, scope |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 479 | } |
| 480 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 481 | type stringAndScope struct { |
| 482 | string |
| 483 | *parser.Scope |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 484 | } |
| 485 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 486 | // ParseBlueprintsFiles parses a set of Blueprints files starting with the file |
| 487 | // at rootFile. When it encounters a Blueprints file with a set of subdirs |
| 488 | // listed it recursively parses any Blueprints files found in those |
| 489 | // subdirectories. |
| 490 | // |
| 491 | // If no errors are encountered while parsing the files, the list of paths on |
| 492 | // which the future output will depend is returned. This list will include both |
| 493 | // Blueprints file paths as well as directory paths for cases where wildcard |
| 494 | // subdirs are found. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 495 | func (c *Context) ParseBlueprintsFiles(rootFile string) (deps []string, |
| 496 | errs []error) { |
| 497 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 498 | c.dependenciesReady = false |
| 499 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 500 | rootDir := filepath.Dir(rootFile) |
| 501 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 502 | blueprintsSet := make(map[string]bool) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 503 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 504 | // Channels to receive data back from parseBlueprintsFile goroutines |
| 505 | blueprintsCh := make(chan stringAndScope) |
| 506 | errsCh := make(chan []error) |
| 507 | modulesCh := make(chan []*moduleInfo) |
| 508 | depsCh := make(chan string) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 509 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 510 | // Channel to notify main loop that a parseBlueprintsFile goroutine has finished |
| 511 | doneCh := make(chan struct{}) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 512 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 513 | // Number of outstanding goroutines to wait for |
| 514 | count := 0 |
| 515 | |
| 516 | startParseBlueprintsFile := func(filename string, scope *parser.Scope) { |
| 517 | count++ |
| 518 | go func() { |
| 519 | c.parseBlueprintsFile(filename, scope, rootDir, |
| 520 | errsCh, modulesCh, blueprintsCh, depsCh) |
| 521 | doneCh <- struct{}{} |
| 522 | }() |
| 523 | } |
| 524 | |
| 525 | tooManyErrors := false |
| 526 | |
| 527 | startParseBlueprintsFile(rootFile, nil) |
| 528 | |
| 529 | loop: |
| 530 | for { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 531 | if len(errs) > maxErrors { |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 532 | tooManyErrors = true |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 533 | } |
| 534 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 535 | select { |
| 536 | case newErrs := <-errsCh: |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 537 | errs = append(errs, newErrs...) |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 538 | case dep := <-depsCh: |
| 539 | deps = append(deps, dep) |
| 540 | case modules := <-modulesCh: |
| 541 | newErrs := c.addModules(modules) |
| 542 | errs = append(errs, newErrs...) |
| 543 | case blueprint := <-blueprintsCh: |
| 544 | if tooManyErrors { |
| 545 | continue |
| 546 | } |
| 547 | if blueprintsSet[blueprint.string] { |
| 548 | continue |
| 549 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 550 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 551 | blueprintsSet[blueprint.string] = true |
| 552 | startParseBlueprintsFile(blueprint.string, blueprint.Scope) |
| 553 | case <-doneCh: |
| 554 | count-- |
| 555 | if count == 0 { |
| 556 | break loop |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 557 | } |
| 558 | } |
| 559 | } |
| 560 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 561 | return |
| 562 | } |
| 563 | |
| 564 | // parseBlueprintFile parses a single Blueprints file, returning any errors through |
| 565 | // errsCh, any defined modules through modulesCh, any sub-Blueprints files through |
| 566 | // blueprintsCh, and any dependencies on Blueprints files or directories through |
| 567 | // depsCh. |
| 568 | func (c *Context) parseBlueprintsFile(filename string, scope *parser.Scope, rootDir string, |
| 569 | errsCh chan<- []error, modulesCh chan<- []*moduleInfo, blueprintsCh chan<- stringAndScope, |
| 570 | depsCh chan<- string) { |
| 571 | |
| 572 | dir := filepath.Dir(filename) |
| 573 | |
| 574 | file, err := os.Open(filename) |
| 575 | if err != nil { |
| 576 | errsCh <- []error{err} |
| 577 | return |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 578 | } |
| 579 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 580 | subdirs, modules, errs, subScope := c.parse(rootDir, filename, file, scope) |
| 581 | if len(errs) > 0 { |
| 582 | errsCh <- errs |
| 583 | } |
| 584 | |
| 585 | err = file.Close() |
| 586 | if err != nil { |
| 587 | errsCh <- []error{err} |
| 588 | } |
| 589 | |
| 590 | modulesCh <- modules |
| 591 | |
| 592 | for _, subdir := range subdirs { |
| 593 | subdir = filepath.Join(dir, subdir) |
| 594 | |
| 595 | dirPart, filePart := filepath.Split(subdir) |
| 596 | dirPart = filepath.Clean(dirPart) |
| 597 | |
| 598 | if filePart == "*" { |
| 599 | foundSubdirs, err := listSubdirs(dirPart) |
| 600 | if err != nil { |
| 601 | errsCh <- []error{err} |
| 602 | return |
| 603 | } |
| 604 | |
| 605 | for _, foundSubdir := range foundSubdirs { |
| 606 | subBlueprints := filepath.Join(dirPart, foundSubdir, |
| 607 | "Blueprints") |
| 608 | |
| 609 | _, err := os.Stat(subBlueprints) |
| 610 | if os.IsNotExist(err) { |
| 611 | // There is no Blueprints file in this subdirectory. We |
| 612 | // need to add the directory to the list of dependencies |
| 613 | // so that if someone adds a Blueprints file in the |
| 614 | // future we'll pick it up. |
| 615 | depsCh <- filepath.Dir(subBlueprints) |
| 616 | } else { |
| 617 | depsCh <- subBlueprints |
| 618 | blueprintsCh <- stringAndScope{ |
| 619 | subBlueprints, |
| 620 | subScope, |
| 621 | } |
| 622 | } |
| 623 | } |
| 624 | |
| 625 | // We now depend on the directory itself because if any new |
| 626 | // subdirectories get added or removed we need to rebuild the |
| 627 | // Ninja manifest. |
| 628 | depsCh <- dirPart |
| 629 | } else { |
| 630 | subBlueprints := filepath.Join(subdir, "Blueprints") |
| 631 | depsCh <- subBlueprints |
| 632 | blueprintsCh <- stringAndScope{ |
| 633 | subBlueprints, |
| 634 | subScope, |
| 635 | } |
| 636 | |
| 637 | } |
| 638 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 639 | } |
| 640 | |
| 641 | func listSubdirs(dir string) ([]string, error) { |
| 642 | d, err := os.Open(dir) |
| 643 | if err != nil { |
| 644 | return nil, err |
| 645 | } |
| 646 | defer d.Close() |
| 647 | |
| 648 | infos, err := d.Readdir(-1) |
| 649 | if err != nil { |
| 650 | return nil, err |
| 651 | } |
| 652 | |
| 653 | var subdirs []string |
| 654 | for _, info := range infos { |
Jamie Gennis | 0c35b2d | 2014-09-25 13:15:10 -0700 | [diff] [blame] | 655 | isDotFile := strings.HasPrefix(info.Name(), ".") |
| 656 | if info.IsDir() && !isDotFile { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 657 | subdirs = append(subdirs, info.Name()) |
| 658 | } |
| 659 | } |
| 660 | |
| 661 | return subdirs, nil |
| 662 | } |
| 663 | |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 664 | func (c *Context) processSubdirs( |
| 665 | scope *parser.Scope) (subdirs []string, errs []error) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 666 | |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 667 | if assignment, err := scope.Get("subdirs"); err == nil { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 668 | switch assignment.Value.Type { |
| 669 | case parser.List: |
| 670 | subdirs = make([]string, 0, len(assignment.Value.ListValue)) |
| 671 | |
| 672 | for _, value := range assignment.Value.ListValue { |
| 673 | if value.Type != parser.String { |
| 674 | // The parser should not produce this. |
| 675 | panic("non-string value found in list") |
| 676 | } |
| 677 | |
| 678 | dirPart, filePart := filepath.Split(value.StringValue) |
| 679 | if (filePart != "*" && strings.ContainsRune(filePart, '*')) || |
| 680 | strings.ContainsRune(dirPart, '*') { |
| 681 | |
| 682 | errs = append(errs, &Error{ |
| 683 | Err: fmt.Errorf("subdirs may only wildcard whole " + |
| 684 | "directories"), |
| 685 | Pos: value.Pos, |
| 686 | }) |
| 687 | |
| 688 | continue |
| 689 | } |
| 690 | |
| 691 | subdirs = append(subdirs, value.StringValue) |
| 692 | } |
| 693 | |
| 694 | if len(errs) > 0 { |
| 695 | subdirs = nil |
| 696 | } |
| 697 | |
| 698 | return |
| 699 | |
| 700 | case parser.Bool, parser.String: |
| 701 | errs = []error{ |
| 702 | &Error{ |
| 703 | Err: fmt.Errorf("subdirs must be a list of strings"), |
| 704 | Pos: assignment.Pos, |
| 705 | }, |
| 706 | } |
| 707 | |
| 708 | return |
| 709 | |
| 710 | default: |
| 711 | panic(fmt.Errorf("unknown value type: %d", assignment.Value.Type)) |
| 712 | } |
| 713 | } |
| 714 | |
Colin Cross | c0dbc55 | 2015-01-02 15:19:28 -0800 | [diff] [blame] | 715 | return nil, nil |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 716 | } |
| 717 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 718 | func (c *Context) createVariations(origModule *moduleInfo, mutatorName string, |
| 719 | variationNames []string) ([]*moduleInfo, []error) { |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 720 | |
| 721 | newModules := []*moduleInfo{} |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 722 | |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 723 | var errs []error |
| 724 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 725 | for i, variationName := range variationNames { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 726 | typeName := origModule.typeName |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 727 | factory, ok := c.moduleFactories[typeName] |
| 728 | if !ok { |
| 729 | panic(fmt.Sprintf("unrecognized module type %q during cloning", typeName)) |
| 730 | } |
| 731 | |
| 732 | var newLogicModule Module |
| 733 | var newProperties []interface{} |
| 734 | |
| 735 | if i == 0 { |
| 736 | // Reuse the existing module for the first new variant |
| 737 | newLogicModule = origModule.logicModule |
| 738 | newProperties = origModule.moduleProperties |
| 739 | } else { |
| 740 | props := []interface{}{ |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 741 | &origModule.properties, |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 742 | } |
| 743 | newLogicModule, newProperties = factory() |
| 744 | |
| 745 | newProperties = append(props, newProperties...) |
| 746 | |
| 747 | if len(newProperties) != len(origModule.moduleProperties) { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 748 | panic("mismatched properties array length in " + origModule.properties.Name) |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 749 | } |
| 750 | |
| 751 | for i := range newProperties { |
| 752 | dst := reflect.ValueOf(newProperties[i]).Elem() |
| 753 | src := reflect.ValueOf(origModule.moduleProperties[i]).Elem() |
| 754 | |
| 755 | proptools.CopyProperties(dst, src) |
| 756 | } |
| 757 | } |
| 758 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 759 | newVariant := origModule.variant.clone() |
| 760 | newVariant[mutatorName] = variationName |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 761 | |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 762 | m := *origModule |
| 763 | newModule := &m |
| 764 | newModule.directDeps = append([]*moduleInfo(nil), origModule.directDeps...) |
| 765 | newModule.logicModule = newLogicModule |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 766 | newModule.variant = newVariant |
| 767 | newModule.dependencyVariant = origModule.dependencyVariant.clone() |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 768 | newModule.moduleProperties = newProperties |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 769 | |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 770 | if newModule.variantName == "" { |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 771 | newModule.variantName = variationName |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 772 | } else { |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 773 | newModule.variantName += "_" + variationName |
Colin Cross | e7daa22 | 2015-03-11 14:35:41 -0700 | [diff] [blame] | 774 | } |
| 775 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 776 | newModules = append(newModules, newModule) |
| 777 | c.moduleInfo[newModule.logicModule] = newModule |
| 778 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 779 | newErrs := c.convertDepsToVariation(newModule, mutatorName, variationName) |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 780 | if len(newErrs) > 0 { |
| 781 | errs = append(errs, newErrs...) |
| 782 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 783 | } |
| 784 | |
| 785 | // Mark original variant as invalid. Modules that depend on this module will still |
| 786 | // depend on origModule, but we'll fix it when the mutator is called on them. |
| 787 | origModule.logicModule = nil |
| 788 | origModule.splitModules = newModules |
| 789 | |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 790 | return newModules, errs |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 791 | } |
| 792 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 793 | func (c *Context) convertDepsToVariation(module *moduleInfo, |
| 794 | mutatorName, variationName string) (errs []error) { |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 795 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 796 | for i, dep := range module.directDeps { |
| 797 | if dep.logicModule == nil { |
| 798 | var newDep *moduleInfo |
| 799 | for _, m := range dep.splitModules { |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 800 | if m.variant[mutatorName] == variationName { |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 801 | newDep = m |
| 802 | break |
| 803 | } |
| 804 | } |
| 805 | if newDep == nil { |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 806 | errs = append(errs, &Error{ |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 807 | Err: fmt.Errorf("failed to find variation %q for module %q needed by %q", |
| 808 | variationName, dep.properties.Name, module.properties.Name), |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 809 | Pos: module.pos, |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 810 | }) |
| 811 | continue |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 812 | } |
| 813 | module.directDeps[i] = newDep |
| 814 | } |
| 815 | } |
Colin Cross | 174ae05 | 2015-03-03 17:37:03 -0800 | [diff] [blame] | 816 | |
| 817 | return errs |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 818 | } |
| 819 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 820 | func (c *Context) prettyPrintVariant(variant variationMap) string { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 821 | names := make([]string, 0, len(variant)) |
| 822 | for _, m := range c.variantMutatorNames { |
| 823 | if v, ok := variant[m]; ok { |
| 824 | names = append(names, m+":"+v) |
| 825 | } |
| 826 | } |
| 827 | |
| 828 | return strings.Join(names, ", ") |
| 829 | } |
| 830 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 831 | func (c *Context) processModuleDef(moduleDef *parser.Module, |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 832 | relBlueprintsFile string) (*moduleInfo, []error) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 833 | |
Colin Cross | d1facc1 | 2015-01-08 14:56:03 -0800 | [diff] [blame] | 834 | typeName := moduleDef.Type.Name |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 835 | factory, ok := c.moduleFactories[typeName] |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 836 | if !ok { |
| 837 | if c.ignoreUnknownModuleTypes { |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 838 | return nil, nil |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 839 | } |
| 840 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 841 | return nil, []error{ |
Jamie Gennis | d4c53d8 | 2014-06-22 17:02:55 -0700 | [diff] [blame] | 842 | &Error{ |
| 843 | Err: fmt.Errorf("unrecognized module type %q", typeName), |
Colin Cross | d1facc1 | 2015-01-08 14:56:03 -0800 | [diff] [blame] | 844 | Pos: moduleDef.Type.Pos, |
Jamie Gennis | d4c53d8 | 2014-06-22 17:02:55 -0700 | [diff] [blame] | 845 | }, |
| 846 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 847 | } |
| 848 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 849 | logicModule, properties := factory() |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 850 | |
| 851 | module := &moduleInfo{ |
| 852 | logicModule: logicModule, |
Jamie Gennis | ec70128 | 2014-06-12 20:06:31 -0700 | [diff] [blame] | 853 | typeName: typeName, |
Jamie Gennis | ec70128 | 2014-06-12 20:06:31 -0700 | [diff] [blame] | 854 | relBlueprintsFile: relBlueprintsFile, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 855 | } |
| 856 | |
Jamie Gennis | 8762292 | 2014-09-30 11:38:25 -0700 | [diff] [blame] | 857 | props := []interface{}{ |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 858 | &module.properties, |
Jamie Gennis | 8762292 | 2014-09-30 11:38:25 -0700 | [diff] [blame] | 859 | } |
| 860 | properties = append(props, properties...) |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 861 | module.moduleProperties = properties |
Jamie Gennis | d4c53d8 | 2014-06-22 17:02:55 -0700 | [diff] [blame] | 862 | |
Jamie Gennis | 8762292 | 2014-09-30 11:38:25 -0700 | [diff] [blame] | 863 | propertyMap, errs := unpackProperties(moduleDef.Properties, properties...) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 864 | if len(errs) > 0 { |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 865 | return nil, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 866 | } |
| 867 | |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 868 | module.pos = moduleDef.Type.Pos |
| 869 | module.propertyPos = make(map[string]scanner.Position) |
Jamie Gennis | 8762292 | 2014-09-30 11:38:25 -0700 | [diff] [blame] | 870 | for name, propertyDef := range propertyMap { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 871 | module.propertyPos[name] = propertyDef.Pos |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 872 | } |
| 873 | |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 874 | return module, nil |
| 875 | } |
| 876 | |
| 877 | func (c *Context) addModules(modules []*moduleInfo) (errs []error) { |
| 878 | for _, module := range modules { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 879 | name := module.properties.Name |
| 880 | c.moduleInfo[module.logicModule] = module |
| 881 | |
| 882 | if group, present := c.moduleGroups[name]; present { |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 883 | errs = append(errs, []error{ |
| 884 | &Error{ |
| 885 | Err: fmt.Errorf("module %q already defined", name), |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 886 | Pos: module.pos, |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 887 | }, |
| 888 | &Error{ |
| 889 | Err: fmt.Errorf("<-- previous definition here"), |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 890 | Pos: group.modules[0].pos, |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 891 | }, |
| 892 | }...) |
| 893 | continue |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 894 | } else { |
| 895 | ninjaName := toNinjaName(module.properties.Name) |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 896 | |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 897 | // The sanitizing in toNinjaName can result in collisions, uniquify the name if it |
| 898 | // already exists |
| 899 | for i := 0; c.moduleNinjaNames[ninjaName] != nil; i++ { |
| 900 | ninjaName = toNinjaName(module.properties.Name) + strconv.Itoa(i) |
| 901 | } |
| 902 | |
| 903 | c.moduleNinjaNames[ninjaName] = group |
| 904 | |
| 905 | group := &moduleGroup{ |
| 906 | name: module.properties.Name, |
| 907 | ninjaName: ninjaName, |
| 908 | modules: []*moduleInfo{module}, |
| 909 | } |
| 910 | module.group = group |
| 911 | c.moduleGroups[name] = group |
| 912 | } |
Colin Cross | 7ad621c | 2015-01-07 16:22:45 -0800 | [diff] [blame] | 913 | } |
| 914 | |
| 915 | return errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 916 | } |
| 917 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 918 | // ResolveDependencies checks that the dependencies specified by all of the |
| 919 | // modules defined in the parsed Blueprints files are valid. This means that |
| 920 | // the modules depended upon are defined and that no circular dependencies |
| 921 | // exist. |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 922 | // |
| 923 | // The config argument is made available to all of the DynamicDependerModule |
| 924 | // objects via the Config method on the DynamicDependerModuleContext objects |
| 925 | // passed to their DynamicDependencies method. |
| 926 | func (c *Context) ResolveDependencies(config interface{}) []error { |
| 927 | errs := c.resolveDependencies(config) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 928 | if len(errs) > 0 { |
| 929 | return errs |
| 930 | } |
| 931 | |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 932 | errs = c.updateDependencies() |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 933 | if len(errs) > 0 { |
| 934 | return errs |
| 935 | } |
| 936 | |
| 937 | c.dependenciesReady = true |
| 938 | return nil |
| 939 | } |
| 940 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 941 | // moduleDeps adds dependencies to a module. If the module implements the |
| 942 | // DynamicDependerModule interface then this set consists of the union of those |
| 943 | // module names listed in its "deps" property, those returned by its |
| 944 | // DynamicDependencies method, and those added by calling AddDependencies or |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 945 | // AddVariationDependencies on DynamicDependencyModuleContext. Otherwise it |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 946 | // is simply those names listed in its "deps" property. |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 947 | func (c *Context) moduleDeps(module *moduleInfo, |
| 948 | config interface{}) (errs []error) { |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 949 | |
| 950 | depNamesSet := make(map[string]bool) |
Colin Cross | a434b3f | 2015-01-13 10:59:52 -0800 | [diff] [blame] | 951 | depNames := []string{} |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 952 | |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 953 | for _, depName := range module.properties.Deps { |
Colin Cross | a434b3f | 2015-01-13 10:59:52 -0800 | [diff] [blame] | 954 | if !depNamesSet[depName] { |
| 955 | depNamesSet[depName] = true |
| 956 | depNames = append(depNames, depName) |
| 957 | } |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 958 | } |
| 959 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 960 | dynamicDepender, ok := module.logicModule.(DynamicDependerModule) |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 961 | if ok { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 962 | ddmctx := &dynamicDependerModuleContext{ |
| 963 | baseModuleContext: baseModuleContext{ |
| 964 | context: c, |
| 965 | config: config, |
| 966 | module: module, |
| 967 | }, |
| 968 | module: module, |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 969 | } |
| 970 | |
| 971 | dynamicDeps := dynamicDepender.DynamicDependencies(ddmctx) |
| 972 | |
| 973 | if len(ddmctx.errs) > 0 { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 974 | return ddmctx.errs |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 975 | } |
| 976 | |
| 977 | for _, depName := range dynamicDeps { |
Colin Cross | a434b3f | 2015-01-13 10:59:52 -0800 | [diff] [blame] | 978 | if !depNamesSet[depName] { |
| 979 | depNamesSet[depName] = true |
| 980 | depNames = append(depNames, depName) |
| 981 | } |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 982 | } |
| 983 | } |
| 984 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 985 | for _, depName := range depNames { |
| 986 | newErrs := c.addDependency(module, depName) |
| 987 | if len(newErrs) > 0 { |
| 988 | errs = append(errs, newErrs...) |
| 989 | } |
| 990 | } |
| 991 | return errs |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 992 | } |
| 993 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 994 | // resolveDependencies populates the directDeps list for every module. In doing so it checks for |
| 995 | // missing dependencies and self-dependant modules. |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 996 | func (c *Context) resolveDependencies(config interface{}) (errs []error) { |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 997 | for _, group := range c.moduleGroups { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 998 | for _, module := range group.modules { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 999 | module.directDeps = make([]*moduleInfo, 0, len(module.properties.Deps)) |
| 1000 | |
| 1001 | newErrs := c.moduleDeps(module, config) |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1002 | if len(newErrs) > 0 { |
| 1003 | errs = append(errs, newErrs...) |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 1004 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1005 | } |
| 1006 | } |
| 1007 | |
| 1008 | return |
| 1009 | } |
| 1010 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1011 | func (c *Context) addDependency(module *moduleInfo, depName string) []error { |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 1012 | depsPos := module.propertyPos["deps"] |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1013 | |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 1014 | if depName == module.properties.Name { |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1015 | return []error{&Error{ |
| 1016 | Err: fmt.Errorf("%q depends on itself", depName), |
| 1017 | Pos: depsPos, |
| 1018 | }} |
| 1019 | } |
| 1020 | |
| 1021 | depInfo, ok := c.moduleGroups[depName] |
| 1022 | if !ok { |
| 1023 | return []error{&Error{ |
| 1024 | Err: fmt.Errorf("%q depends on undefined module %q", |
Colin Cross | ed342d9 | 2015-03-11 00:57:25 -0700 | [diff] [blame] | 1025 | module.properties.Name, depName), |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1026 | Pos: depsPos, |
| 1027 | }} |
| 1028 | } |
| 1029 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1030 | for _, m := range module.directDeps { |
| 1031 | if m.group == depInfo { |
| 1032 | return nil |
| 1033 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1034 | } |
| 1035 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1036 | if len(depInfo.modules) == 1 { |
| 1037 | module.directDeps = append(module.directDeps, depInfo.modules[0]) |
| 1038 | return nil |
| 1039 | } else { |
| 1040 | for _, m := range depInfo.modules { |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1041 | if m.variant.equal(module.dependencyVariant) { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1042 | module.directDeps = append(module.directDeps, m) |
| 1043 | return nil |
| 1044 | } |
| 1045 | } |
| 1046 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1047 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1048 | return []error{&Error{ |
| 1049 | Err: fmt.Errorf("dependency %q of %q missing variant %q", |
| 1050 | depInfo.modules[0].properties.Name, module.properties.Name, |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1051 | c.prettyPrintVariant(module.dependencyVariant)), |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1052 | Pos: depsPos, |
| 1053 | }} |
| 1054 | } |
| 1055 | |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1056 | func (c *Context) addVariationDependency(module *moduleInfo, variations []Variation, |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1057 | depName string) []error { |
| 1058 | |
| 1059 | depsPos := module.propertyPos["deps"] |
| 1060 | |
| 1061 | depInfo, ok := c.moduleGroups[depName] |
| 1062 | if !ok { |
| 1063 | return []error{&Error{ |
| 1064 | Err: fmt.Errorf("%q depends on undefined module %q", |
| 1065 | module.properties.Name, depName), |
| 1066 | Pos: depsPos, |
| 1067 | }} |
| 1068 | } |
| 1069 | |
| 1070 | // We can't just append variant.Variant to module.dependencyVariants.variantName and |
| 1071 | // compare the strings because the result won't be in mutator registration order. |
| 1072 | // Create a new map instead, and then deep compare the maps. |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1073 | newVariant := module.dependencyVariant.clone() |
| 1074 | for _, v := range variations { |
| 1075 | newVariant[v.Mutator] = v.Variation |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1076 | } |
| 1077 | |
| 1078 | for _, m := range depInfo.modules { |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1079 | if newVariant.equal(m.variant) { |
| 1080 | // AddVariationDependency allows adding a dependency on itself, but only if |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1081 | // that module is earlier in the module list than this one, since we always |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1082 | // run GenerateBuildActions in order for the variants of a module |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1083 | if depInfo == module.group && beforeInModuleList(module, m, module.group.modules) { |
| 1084 | return []error{&Error{ |
| 1085 | Err: fmt.Errorf("%q depends on later version of itself", depName), |
| 1086 | Pos: depsPos, |
| 1087 | }} |
| 1088 | } |
| 1089 | module.directDeps = append(module.directDeps, m) |
| 1090 | return nil |
| 1091 | } |
| 1092 | } |
| 1093 | |
| 1094 | return []error{&Error{ |
| 1095 | Err: fmt.Errorf("dependency %q of %q missing variant %q", |
| 1096 | depInfo.modules[0].properties.Name, module.properties.Name, |
Colin Cross | f5e34b9 | 2015-03-13 16:02:36 -0700 | [diff] [blame^] | 1097 | c.prettyPrintVariant(newVariant)), |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1098 | Pos: depsPos, |
| 1099 | }} |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1100 | } |
| 1101 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1102 | func (c *Context) parallelVisitAllBottomUp(visit func(group *moduleInfo) bool) { |
| 1103 | doneCh := make(chan *moduleInfo) |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1104 | count := 0 |
Colin Cross | 8900e9b | 2015-03-02 14:03:01 -0800 | [diff] [blame] | 1105 | cancel := false |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1106 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1107 | for _, module := range c.modulesSorted { |
| 1108 | module.waitingCount = module.depsCount |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1109 | } |
| 1110 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1111 | visitOne := func(module *moduleInfo) { |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1112 | count++ |
| 1113 | go func() { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1114 | ret := visit(module) |
Colin Cross | 8900e9b | 2015-03-02 14:03:01 -0800 | [diff] [blame] | 1115 | if ret { |
| 1116 | cancel = true |
| 1117 | } |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1118 | doneCh <- module |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1119 | }() |
| 1120 | } |
| 1121 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1122 | for _, module := range c.modulesSorted { |
| 1123 | if module.waitingCount == 0 { |
| 1124 | visitOne(module) |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1125 | } |
| 1126 | } |
| 1127 | |
Colin Cross | 11e3b0d | 2015-02-04 10:41:00 -0800 | [diff] [blame] | 1128 | for count > 0 { |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1129 | select { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1130 | case doneModule := <-doneCh: |
Colin Cross | 8900e9b | 2015-03-02 14:03:01 -0800 | [diff] [blame] | 1131 | if !cancel { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1132 | for _, parent := range doneModule.reverseDeps { |
Colin Cross | 8900e9b | 2015-03-02 14:03:01 -0800 | [diff] [blame] | 1133 | parent.waitingCount-- |
| 1134 | if parent.waitingCount == 0 { |
| 1135 | visitOne(parent) |
| 1136 | } |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1137 | } |
| 1138 | } |
| 1139 | count-- |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1140 | } |
| 1141 | } |
| 1142 | } |
| 1143 | |
| 1144 | // updateDependencies recursively walks the module dependency graph and updates |
| 1145 | // additional fields based on the dependencies. It builds a sorted list of modules |
| 1146 | // such that dependencies of a module always appear first, and populates reverse |
| 1147 | // dependency links and counts of total dependencies. It also reports errors when |
| 1148 | // it encounters dependency cycles. This should called after resolveDependencies, |
| 1149 | // as well as after any mutator pass has called addDependency |
| 1150 | func (c *Context) updateDependencies() (errs []error) { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1151 | visited := make(map[*moduleInfo]bool) // modules that were already checked |
| 1152 | checking := make(map[*moduleInfo]bool) // modules actively being checked |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1153 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1154 | sorted := make([]*moduleInfo, 0, len(c.moduleInfo)) |
Colin Cross | 573a2fd | 2014-12-17 14:16:51 -0800 | [diff] [blame] | 1155 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1156 | var check func(group *moduleInfo) []*moduleInfo |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1157 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1158 | cycleError := func(cycle []*moduleInfo) { |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1159 | // We are the "start" of the cycle, so we're responsible |
| 1160 | // for generating the errors. The cycle list is in |
| 1161 | // reverse order because all the 'check' calls append |
| 1162 | // their own module to the list. |
| 1163 | errs = append(errs, &Error{ |
| 1164 | Err: fmt.Errorf("encountered dependency cycle:"), |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1165 | Pos: cycle[len(cycle)-1].pos, |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1166 | }) |
| 1167 | |
| 1168 | // Iterate backwards through the cycle list. |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1169 | curModule := cycle[len(cycle)-1] |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1170 | for i := len(cycle) - 1; i >= 0; i-- { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1171 | nextModule := cycle[i] |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1172 | errs = append(errs, &Error{ |
| 1173 | Err: fmt.Errorf(" %q depends on %q", |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1174 | curModule.properties.Name, |
| 1175 | nextModule.properties.Name), |
| 1176 | Pos: curModule.propertyPos["deps"], |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1177 | }) |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1178 | curModule = nextModule |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1179 | } |
| 1180 | } |
| 1181 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1182 | check = func(module *moduleInfo) []*moduleInfo { |
| 1183 | visited[module] = true |
| 1184 | checking[module] = true |
| 1185 | defer delete(checking, module) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1186 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1187 | deps := make(map[*moduleInfo]bool) |
| 1188 | |
| 1189 | // Add an implicit dependency ordering on all earlier modules in the same module group |
| 1190 | for _, dep := range module.group.modules { |
| 1191 | if dep == module { |
| 1192 | break |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1193 | } |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1194 | deps[dep] = true |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1195 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1196 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1197 | for _, dep := range module.directDeps { |
| 1198 | deps[dep] = true |
| 1199 | } |
| 1200 | |
| 1201 | module.reverseDeps = []*moduleInfo{} |
| 1202 | module.depsCount = len(deps) |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1203 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1204 | for dep := range deps { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1205 | if checking[dep] { |
| 1206 | // This is a cycle. |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1207 | return []*moduleInfo{dep, module} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1208 | } |
| 1209 | |
| 1210 | if !visited[dep] { |
| 1211 | cycle := check(dep) |
| 1212 | if cycle != nil { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1213 | if cycle[0] == module { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1214 | // We are the "start" of the cycle, so we're responsible |
| 1215 | // for generating the errors. The cycle list is in |
| 1216 | // reverse order because all the 'check' calls append |
| 1217 | // their own module to the list. |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1218 | cycleError(cycle) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1219 | |
| 1220 | // We can continue processing this module's children to |
| 1221 | // find more cycles. Since all the modules that were |
| 1222 | // part of the found cycle were marked as visited we |
| 1223 | // won't run into that cycle again. |
| 1224 | } else { |
| 1225 | // We're not the "start" of the cycle, so we just append |
| 1226 | // our module to the list and return it. |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1227 | return append(cycle, module) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1228 | } |
| 1229 | } |
| 1230 | } |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1231 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1232 | dep.reverseDeps = append(dep.reverseDeps, module) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1233 | } |
| 1234 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1235 | sorted = append(sorted, module) |
Colin Cross | 573a2fd | 2014-12-17 14:16:51 -0800 | [diff] [blame] | 1236 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1237 | return nil |
| 1238 | } |
| 1239 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1240 | for _, module := range c.moduleInfo { |
| 1241 | if !visited[module] { |
| 1242 | cycle := check(module) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1243 | if cycle != nil { |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1244 | if cycle[len(cycle)-1] != module { |
Colin Cross | 10b54db | 2015-03-11 14:40:30 -0700 | [diff] [blame] | 1245 | panic("inconceivable!") |
| 1246 | } |
| 1247 | cycleError(cycle) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1248 | } |
| 1249 | } |
| 1250 | } |
| 1251 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1252 | c.modulesSorted = sorted |
Colin Cross | 573a2fd | 2014-12-17 14:16:51 -0800 | [diff] [blame] | 1253 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1254 | return |
| 1255 | } |
| 1256 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 1257 | // PrepareBuildActions generates an internal representation of all the build |
| 1258 | // actions that need to be performed. This process involves invoking the |
| 1259 | // GenerateBuildActions method on each of the Module objects created during the |
| 1260 | // parse phase and then on each of the registered Singleton objects. |
| 1261 | // |
| 1262 | // If the ResolveDependencies method has not already been called it is called |
| 1263 | // automatically by this method. |
| 1264 | // |
| 1265 | // The config argument is made available to all of the Module and Singleton |
| 1266 | // objects via the Config method on the ModuleContext and SingletonContext |
| 1267 | // objects passed to GenerateBuildActions. It is also passed to the functions |
| 1268 | // specified via PoolFunc, RuleFunc, and VariableFunc so that they can compute |
| 1269 | // config-specific values. |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1270 | // |
| 1271 | // The returned deps is a list of the ninja files dependencies that were added |
| 1272 | // by the modules and singletons via the ModuleContext.AddNinjaFileDeps() and |
| 1273 | // SingletonContext.AddNinjaFileDeps() methods. |
| 1274 | func (c *Context) PrepareBuildActions(config interface{}) (deps []string, errs []error) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1275 | c.buildActionsReady = false |
| 1276 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1277 | errs = c.runEarlyMutators(config) |
| 1278 | if len(errs) > 0 { |
| 1279 | return nil, errs |
| 1280 | } |
| 1281 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1282 | if !c.dependenciesReady { |
Jamie Gennis | b9e87f6 | 2014-09-24 20:28:11 -0700 | [diff] [blame] | 1283 | errs := c.ResolveDependencies(config) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1284 | if len(errs) > 0 { |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1285 | return nil, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1286 | } |
| 1287 | } |
| 1288 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1289 | errs = c.runMutators(config) |
| 1290 | if len(errs) > 0 { |
| 1291 | return nil, errs |
| 1292 | } |
| 1293 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1294 | liveGlobals := newLiveTracker(config) |
| 1295 | |
| 1296 | c.initSpecialVariables() |
| 1297 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1298 | depsModules, errs := c.generateModuleBuildActions(config, liveGlobals) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1299 | if len(errs) > 0 { |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1300 | return nil, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1301 | } |
| 1302 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1303 | depsSingletons, errs := c.generateSingletonBuildActions(config, liveGlobals) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1304 | if len(errs) > 0 { |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1305 | return nil, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1306 | } |
| 1307 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1308 | deps = append(depsModules, depsSingletons...) |
| 1309 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1310 | if c.buildDir != nil { |
| 1311 | liveGlobals.addNinjaStringDeps(c.buildDir) |
| 1312 | } |
| 1313 | |
| 1314 | pkgNames := c.makeUniquePackageNames(liveGlobals) |
| 1315 | |
| 1316 | // This will panic if it finds a problem since it's a programming error. |
| 1317 | c.checkForVariableReferenceCycles(liveGlobals.variables, pkgNames) |
| 1318 | |
| 1319 | c.pkgNames = pkgNames |
| 1320 | c.globalVariables = liveGlobals.variables |
| 1321 | c.globalPools = liveGlobals.pools |
| 1322 | c.globalRules = liveGlobals.rules |
| 1323 | |
| 1324 | c.buildActionsReady = true |
| 1325 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1326 | return deps, nil |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1327 | } |
| 1328 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 1329 | func (c *Context) runEarlyMutators(config interface{}) (errs []error) { |
| 1330 | for _, mutator := range c.earlyMutatorInfo { |
| 1331 | for _, group := range c.moduleGroups { |
| 1332 | newModules := make([]*moduleInfo, 0, len(group.modules)) |
| 1333 | |
| 1334 | for _, module := range group.modules { |
| 1335 | mctx := &mutatorContext{ |
| 1336 | baseModuleContext: baseModuleContext{ |
| 1337 | context: c, |
| 1338 | config: config, |
| 1339 | module: module, |
| 1340 | }, |
| 1341 | name: mutator.name, |
| 1342 | } |
| 1343 | mutator.mutator(mctx) |
| 1344 | if len(mctx.errs) > 0 { |
| 1345 | errs = append(errs, mctx.errs...) |
| 1346 | return errs |
| 1347 | } |
| 1348 | |
| 1349 | if module.splitModules != nil { |
| 1350 | newModules = append(newModules, module.splitModules...) |
| 1351 | } else { |
| 1352 | newModules = append(newModules, module) |
| 1353 | } |
| 1354 | } |
| 1355 | |
| 1356 | group.modules = newModules |
| 1357 | } |
| 1358 | } |
| 1359 | |
| 1360 | return nil |
| 1361 | } |
| 1362 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1363 | func (c *Context) runMutators(config interface{}) (errs []error) { |
| 1364 | for _, mutator := range c.mutatorInfo { |
| 1365 | if mutator.topDownMutator != nil { |
| 1366 | errs = c.runTopDownMutator(config, mutator.name, mutator.topDownMutator) |
| 1367 | } else if mutator.bottomUpMutator != nil { |
| 1368 | errs = c.runBottomUpMutator(config, mutator.name, mutator.bottomUpMutator) |
| 1369 | } else { |
| 1370 | panic("no mutator set on " + mutator.name) |
| 1371 | } |
| 1372 | if len(errs) > 0 { |
| 1373 | return errs |
| 1374 | } |
| 1375 | } |
| 1376 | |
| 1377 | return nil |
| 1378 | } |
| 1379 | |
| 1380 | func (c *Context) runTopDownMutator(config interface{}, |
| 1381 | name string, mutator TopDownMutator) (errs []error) { |
| 1382 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1383 | for i := 0; i < len(c.modulesSorted); i++ { |
| 1384 | module := c.modulesSorted[len(c.modulesSorted)-1-i] |
| 1385 | mctx := &mutatorContext{ |
| 1386 | baseModuleContext: baseModuleContext{ |
| 1387 | context: c, |
| 1388 | config: config, |
| 1389 | module: module, |
| 1390 | }, |
| 1391 | name: name, |
| 1392 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1393 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1394 | mutator(mctx) |
| 1395 | if len(mctx.errs) > 0 { |
| 1396 | errs = append(errs, mctx.errs...) |
| 1397 | return errs |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1398 | } |
| 1399 | } |
| 1400 | |
| 1401 | return errs |
| 1402 | } |
| 1403 | |
| 1404 | func (c *Context) runBottomUpMutator(config interface{}, |
| 1405 | name string, mutator BottomUpMutator) (errs []error) { |
| 1406 | |
| 1407 | dependenciesModified := false |
| 1408 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1409 | for _, module := range c.modulesSorted { |
| 1410 | newModules := make([]*moduleInfo, 0, 1) |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1411 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1412 | mctx := &mutatorContext{ |
| 1413 | baseModuleContext: baseModuleContext{ |
| 1414 | context: c, |
| 1415 | config: config, |
| 1416 | module: module, |
| 1417 | }, |
| 1418 | name: name, |
| 1419 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1420 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1421 | mutator(mctx) |
| 1422 | if len(mctx.errs) > 0 { |
| 1423 | errs = append(errs, mctx.errs...) |
| 1424 | return errs |
| 1425 | } |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1426 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1427 | // Fix up any remaining dependencies on modules that were split into variants |
| 1428 | // by replacing them with the first variant |
| 1429 | for i, dep := range module.directDeps { |
| 1430 | if dep.logicModule == nil { |
| 1431 | module.directDeps[i] = dep.splitModules[0] |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1432 | } |
| 1433 | } |
| 1434 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1435 | if mctx.dependenciesModified { |
| 1436 | dependenciesModified = true |
| 1437 | } |
| 1438 | |
| 1439 | if module.splitModules != nil { |
| 1440 | newModules = append(newModules, module.splitModules...) |
| 1441 | } else { |
| 1442 | newModules = append(newModules, module) |
| 1443 | } |
| 1444 | |
| 1445 | module.group.modules = spliceModules(module.group.modules, module, newModules) |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1446 | } |
| 1447 | |
| 1448 | if dependenciesModified { |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1449 | errs = c.updateDependencies() |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1450 | if len(errs) > 0 { |
| 1451 | return errs |
| 1452 | } |
| 1453 | } |
| 1454 | |
| 1455 | return errs |
| 1456 | } |
| 1457 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1458 | func spliceModules(modules []*moduleInfo, origModule *moduleInfo, |
| 1459 | newModules []*moduleInfo) []*moduleInfo { |
| 1460 | for i, m := range modules { |
| 1461 | if m == origModule { |
| 1462 | return spliceModulesAtIndex(modules, i, newModules) |
| 1463 | } |
| 1464 | } |
| 1465 | |
| 1466 | panic("failed to find original module to splice") |
| 1467 | } |
| 1468 | |
| 1469 | func spliceModulesAtIndex(modules []*moduleInfo, i int, newModules []*moduleInfo) []*moduleInfo { |
| 1470 | spliceSize := len(newModules) |
| 1471 | newLen := len(modules) + spliceSize - 1 |
| 1472 | var dest []*moduleInfo |
| 1473 | if cap(modules) >= len(modules)-1+len(newModules) { |
| 1474 | // We can fit the splice in the existing capacity, do everything in place |
| 1475 | dest = modules[:newLen] |
| 1476 | } else { |
| 1477 | dest = make([]*moduleInfo, newLen) |
| 1478 | copy(dest, modules[:i]) |
| 1479 | } |
| 1480 | |
| 1481 | // Move the end of the slice over by spliceSize-1 |
| 1482 | copy(modules[i+spliceSize:], modules[i+1:]) |
| 1483 | |
| 1484 | // Copy the new modules into the slice |
| 1485 | copy(modules[i:], newModules) |
| 1486 | |
| 1487 | return modules |
| 1488 | } |
| 1489 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1490 | func (c *Context) initSpecialVariables() { |
| 1491 | c.buildDir = nil |
| 1492 | c.requiredNinjaMajor = 1 |
| 1493 | c.requiredNinjaMinor = 1 |
| 1494 | c.requiredNinjaMicro = 0 |
| 1495 | } |
| 1496 | |
Jamie Gennis | 6eb4d24 | 2014-06-11 18:31:16 -0700 | [diff] [blame] | 1497 | func (c *Context) generateModuleBuildActions(config interface{}, |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1498 | liveGlobals *liveTracker) ([]string, []error) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1499 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1500 | var deps []string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1501 | var errs []error |
| 1502 | |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1503 | cancelCh := make(chan struct{}) |
| 1504 | errsCh := make(chan []error) |
| 1505 | depsCh := make(chan []string) |
| 1506 | |
| 1507 | go func() { |
| 1508 | for { |
| 1509 | select { |
| 1510 | case <-cancelCh: |
| 1511 | close(cancelCh) |
| 1512 | return |
| 1513 | case newErrs := <-errsCh: |
| 1514 | errs = append(errs, newErrs...) |
| 1515 | case newDeps := <-depsCh: |
| 1516 | deps = append(deps, newDeps...) |
| 1517 | |
| 1518 | } |
| 1519 | } |
| 1520 | }() |
| 1521 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1522 | c.parallelVisitAllBottomUp(func(module *moduleInfo) bool { |
| 1523 | // The parent scope of the moduleContext's local scope gets overridden to be that of the |
| 1524 | // calling Go package on a per-call basis. Since the initial parent scope doesn't matter we |
| 1525 | // just set it to nil. |
| 1526 | prefix := moduleNamespacePrefix(module.group.ninjaName + "_" + module.variantName) |
| 1527 | scope := newLocalScope(nil, prefix) |
Colin Cross | 6134a5c | 2015-02-10 11:26:26 -0800 | [diff] [blame] | 1528 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1529 | mctx := &moduleContext{ |
| 1530 | baseModuleContext: baseModuleContext{ |
| 1531 | context: c, |
| 1532 | config: config, |
| 1533 | module: module, |
| 1534 | }, |
| 1535 | scope: scope, |
| 1536 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1537 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1538 | mctx.module.logicModule.GenerateBuildActions(mctx) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1539 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1540 | if len(mctx.errs) > 0 { |
| 1541 | errsCh <- mctx.errs |
| 1542 | return true |
| 1543 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1544 | |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1545 | depsCh <- mctx.ninjaFileDeps |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1546 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 1547 | newErrs := c.processLocalBuildActions(&module.actionDefs, |
Colin Cross | 7addea3 | 2015-03-11 15:43:52 -0700 | [diff] [blame] | 1548 | &mctx.actionDefs, liveGlobals) |
| 1549 | if len(newErrs) > 0 { |
| 1550 | errsCh <- newErrs |
| 1551 | return true |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1552 | } |
Colin Cross | 8900e9b | 2015-03-02 14:03:01 -0800 | [diff] [blame] | 1553 | return false |
Colin Cross | 691a60d | 2015-01-07 18:08:56 -0800 | [diff] [blame] | 1554 | }) |
| 1555 | |
| 1556 | cancelCh <- struct{}{} |
| 1557 | <-cancelCh |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1558 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1559 | return deps, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1560 | } |
| 1561 | |
Jamie Gennis | 6eb4d24 | 2014-06-11 18:31:16 -0700 | [diff] [blame] | 1562 | func (c *Context) generateSingletonBuildActions(config interface{}, |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1563 | liveGlobals *liveTracker) ([]string, []error) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1564 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1565 | var deps []string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1566 | var errs []error |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1567 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1568 | for name, info := range c.singletonInfo { |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 1569 | // The parent scope of the singletonContext's local scope gets overridden to be that of the |
| 1570 | // calling Go package on a per-call basis. Since the initial parent scope doesn't matter we |
| 1571 | // just set it to nil. |
| 1572 | scope := newLocalScope(nil, singletonNamespacePrefix(name)) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1573 | |
| 1574 | sctx := &singletonContext{ |
| 1575 | context: c, |
| 1576 | config: config, |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 1577 | scope: scope, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1578 | } |
| 1579 | |
| 1580 | info.singleton.GenerateBuildActions(sctx) |
| 1581 | |
| 1582 | if len(sctx.errs) > 0 { |
| 1583 | errs = append(errs, sctx.errs...) |
| 1584 | if len(errs) > maxErrors { |
| 1585 | break |
| 1586 | } |
| 1587 | continue |
| 1588 | } |
| 1589 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1590 | deps = append(deps, sctx.ninjaFileDeps...) |
| 1591 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1592 | newErrs := c.processLocalBuildActions(&info.actionDefs, |
| 1593 | &sctx.actionDefs, liveGlobals) |
| 1594 | errs = append(errs, newErrs...) |
| 1595 | if len(errs) > maxErrors { |
| 1596 | break |
| 1597 | } |
| 1598 | } |
| 1599 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 1600 | return deps, errs |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1601 | } |
| 1602 | |
| 1603 | func (c *Context) processLocalBuildActions(out, in *localBuildActions, |
| 1604 | liveGlobals *liveTracker) []error { |
| 1605 | |
| 1606 | var errs []error |
| 1607 | |
| 1608 | // First we go through and add everything referenced by the module's |
| 1609 | // buildDefs to the live globals set. This will end up adding the live |
| 1610 | // locals to the set as well, but we'll take them out after. |
| 1611 | for _, def := range in.buildDefs { |
| 1612 | err := liveGlobals.AddBuildDefDeps(def) |
| 1613 | if err != nil { |
| 1614 | errs = append(errs, err) |
| 1615 | } |
| 1616 | } |
| 1617 | |
| 1618 | if len(errs) > 0 { |
| 1619 | return errs |
| 1620 | } |
| 1621 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1622 | out.buildDefs = append(out.buildDefs, in.buildDefs...) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1623 | |
| 1624 | // We use the now-incorrect set of live "globals" to determine which local |
| 1625 | // definitions are live. As we go through copying those live locals to the |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1626 | // moduleGroup we remove them from the live globals set. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1627 | for _, v := range in.variables { |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 1628 | isLive := liveGlobals.RemoveVariableIfLive(v) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1629 | if isLive { |
| 1630 | out.variables = append(out.variables, v) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1631 | } |
| 1632 | } |
| 1633 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1634 | for _, r := range in.rules { |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 1635 | isLive := liveGlobals.RemoveRuleIfLive(r) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1636 | if isLive { |
| 1637 | out.rules = append(out.rules, r) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1638 | } |
| 1639 | } |
| 1640 | |
| 1641 | return nil |
| 1642 | } |
| 1643 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1644 | func (c *Context) visitDepsDepthFirst(topModule *moduleInfo, visit func(Module)) { |
| 1645 | visited := make(map[*moduleInfo]bool) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1646 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1647 | var walk func(module *moduleInfo) |
| 1648 | walk = func(module *moduleInfo) { |
| 1649 | visited[module] = true |
| 1650 | for _, moduleDep := range module.directDeps { |
| 1651 | if !visited[moduleDep] { |
| 1652 | walk(moduleDep) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1653 | } |
| 1654 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1655 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1656 | if module != topModule { |
| 1657 | visit(module.logicModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1658 | } |
| 1659 | } |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1660 | |
| 1661 | walk(topModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1662 | } |
| 1663 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1664 | func (c *Context) visitDepsDepthFirstIf(topModule *moduleInfo, pred func(Module) bool, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1665 | visit func(Module)) { |
| 1666 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1667 | visited := make(map[*moduleInfo]bool) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1668 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1669 | var walk func(module *moduleInfo) |
| 1670 | walk = func(module *moduleInfo) { |
| 1671 | visited[module] = true |
| 1672 | for _, moduleDep := range module.directDeps { |
| 1673 | if !visited[moduleDep] { |
| 1674 | walk(moduleDep) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1675 | } |
Jamie Gennis | 0bb5d8a | 2014-11-26 14:45:37 -0800 | [diff] [blame] | 1676 | } |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1677 | |
| 1678 | if module != topModule { |
| 1679 | if pred(module.logicModule) { |
| 1680 | visit(module.logicModule) |
| 1681 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1682 | } |
| 1683 | } |
| 1684 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1685 | walk(topModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1686 | } |
| 1687 | |
Colin Cross | c902848 | 2014-12-18 16:28:54 -0800 | [diff] [blame] | 1688 | func (c *Context) visitDirectDeps(module *moduleInfo, visit func(Module)) { |
| 1689 | for _, dep := range module.directDeps { |
| 1690 | visit(dep.logicModule) |
| 1691 | } |
| 1692 | } |
| 1693 | |
| 1694 | func (c *Context) visitDirectDepsIf(module *moduleInfo, pred func(Module) bool, |
| 1695 | visit func(Module)) { |
| 1696 | |
| 1697 | for _, dep := range module.directDeps { |
| 1698 | if pred(dep.logicModule) { |
| 1699 | visit(dep.logicModule) |
| 1700 | } |
| 1701 | } |
| 1702 | } |
| 1703 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 1704 | func (c *Context) sortedModuleNames() []string { |
| 1705 | if c.cachedSortedModuleNames == nil { |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1706 | c.cachedSortedModuleNames = make([]string, 0, len(c.moduleGroups)) |
| 1707 | for moduleName := range c.moduleGroups { |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 1708 | c.cachedSortedModuleNames = append(c.cachedSortedModuleNames, |
| 1709 | moduleName) |
| 1710 | } |
| 1711 | sort.Strings(c.cachedSortedModuleNames) |
| 1712 | } |
| 1713 | |
| 1714 | return c.cachedSortedModuleNames |
| 1715 | } |
| 1716 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1717 | func (c *Context) visitAllModules(visit func(Module)) { |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 1718 | for _, moduleName := range c.sortedModuleNames() { |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1719 | group := c.moduleGroups[moduleName] |
| 1720 | for _, module := range group.modules { |
| 1721 | visit(module.logicModule) |
| 1722 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1723 | } |
| 1724 | } |
| 1725 | |
| 1726 | func (c *Context) visitAllModulesIf(pred func(Module) bool, |
| 1727 | visit func(Module)) { |
| 1728 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 1729 | for _, moduleName := range c.sortedModuleNames() { |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 1730 | group := c.moduleGroups[moduleName] |
| 1731 | for _, module := range group.modules { |
| 1732 | if pred(module.logicModule) { |
| 1733 | visit(module.logicModule) |
| 1734 | } |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1735 | } |
| 1736 | } |
| 1737 | } |
| 1738 | |
| 1739 | func (c *Context) requireNinjaVersion(major, minor, micro int) { |
| 1740 | if major != 1 { |
| 1741 | panic("ninja version with major version != 1 not supported") |
| 1742 | } |
| 1743 | if c.requiredNinjaMinor < minor { |
| 1744 | c.requiredNinjaMinor = minor |
| 1745 | c.requiredNinjaMicro = micro |
| 1746 | } |
| 1747 | if c.requiredNinjaMinor == minor && c.requiredNinjaMicro < micro { |
| 1748 | c.requiredNinjaMicro = micro |
| 1749 | } |
| 1750 | } |
| 1751 | |
| 1752 | func (c *Context) setBuildDir(value *ninjaString) { |
| 1753 | if c.buildDir != nil { |
| 1754 | panic("buildDir set multiple times") |
| 1755 | } |
| 1756 | c.buildDir = value |
| 1757 | } |
| 1758 | |
| 1759 | func (c *Context) makeUniquePackageNames( |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1760 | liveGlobals *liveTracker) map[*PackageContext]string { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1761 | |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1762 | pkgs := make(map[string]*PackageContext) |
| 1763 | pkgNames := make(map[*PackageContext]string) |
| 1764 | longPkgNames := make(map[*PackageContext]bool) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1765 | |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1766 | processPackage := func(pctx *PackageContext) { |
| 1767 | if pctx == nil { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1768 | // This is a built-in rule and has no package. |
| 1769 | return |
| 1770 | } |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1771 | if _, ok := pkgNames[pctx]; ok { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1772 | // We've already processed this package. |
| 1773 | return |
| 1774 | } |
| 1775 | |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1776 | otherPkg, present := pkgs[pctx.shortName] |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1777 | if present { |
| 1778 | // Short name collision. Both this package and the one that's |
| 1779 | // already there need to use their full names. We leave the short |
| 1780 | // name in pkgNames for now so future collisions still get caught. |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1781 | longPkgNames[pctx] = true |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1782 | longPkgNames[otherPkg] = true |
| 1783 | } else { |
| 1784 | // No collision so far. Tentatively set the package's name to be |
| 1785 | // its short name. |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1786 | pkgNames[pctx] = pctx.shortName |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1787 | } |
| 1788 | } |
| 1789 | |
| 1790 | // We try to give all packages their short name, but when we get collisions |
| 1791 | // we need to use the full unique package name. |
| 1792 | for v, _ := range liveGlobals.variables { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1793 | processPackage(v.packageContext()) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1794 | } |
| 1795 | for p, _ := range liveGlobals.pools { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1796 | processPackage(p.packageContext()) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1797 | } |
| 1798 | for r, _ := range liveGlobals.rules { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1799 | processPackage(r.packageContext()) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1800 | } |
| 1801 | |
| 1802 | // Add the packages that had collisions using their full unique names. This |
| 1803 | // will overwrite any short names that were added in the previous step. |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1804 | for pctx := range longPkgNames { |
| 1805 | pkgNames[pctx] = pctx.fullName |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1806 | } |
| 1807 | |
| 1808 | return pkgNames |
| 1809 | } |
| 1810 | |
| 1811 | func (c *Context) checkForVariableReferenceCycles( |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 1812 | variables map[Variable]*ninjaString, pkgNames map[*PackageContext]string) { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1813 | |
| 1814 | visited := make(map[Variable]bool) // variables that were already checked |
| 1815 | checking := make(map[Variable]bool) // variables actively being checked |
| 1816 | |
| 1817 | var check func(v Variable) []Variable |
| 1818 | |
| 1819 | check = func(v Variable) []Variable { |
| 1820 | visited[v] = true |
| 1821 | checking[v] = true |
| 1822 | defer delete(checking, v) |
| 1823 | |
| 1824 | value := variables[v] |
| 1825 | for _, dep := range value.variables { |
| 1826 | if checking[dep] { |
| 1827 | // This is a cycle. |
| 1828 | return []Variable{dep, v} |
| 1829 | } |
| 1830 | |
| 1831 | if !visited[dep] { |
| 1832 | cycle := check(dep) |
| 1833 | if cycle != nil { |
| 1834 | if cycle[0] == v { |
| 1835 | // We are the "start" of the cycle, so we're responsible |
| 1836 | // for generating the errors. The cycle list is in |
| 1837 | // reverse order because all the 'check' calls append |
| 1838 | // their own module to the list. |
| 1839 | msgs := []string{"detected variable reference cycle:"} |
| 1840 | |
| 1841 | // Iterate backwards through the cycle list. |
| 1842 | curName := v.fullName(pkgNames) |
| 1843 | curValue := value.Value(pkgNames) |
| 1844 | for i := len(cycle) - 1; i >= 0; i-- { |
| 1845 | next := cycle[i] |
| 1846 | nextName := next.fullName(pkgNames) |
| 1847 | nextValue := variables[next].Value(pkgNames) |
| 1848 | |
| 1849 | msgs = append(msgs, fmt.Sprintf( |
| 1850 | " %q depends on %q", curName, nextName)) |
| 1851 | msgs = append(msgs, fmt.Sprintf( |
| 1852 | " [%s = %s]", curName, curValue)) |
| 1853 | |
| 1854 | curName = nextName |
| 1855 | curValue = nextValue |
| 1856 | } |
| 1857 | |
| 1858 | // Variable reference cycles are a programming error, |
| 1859 | // not the fault of the Blueprint file authors. |
| 1860 | panic(strings.Join(msgs, "\n")) |
| 1861 | } else { |
| 1862 | // We're not the "start" of the cycle, so we just append |
| 1863 | // our module to the list and return it. |
| 1864 | return append(cycle, v) |
| 1865 | } |
| 1866 | } |
| 1867 | } |
| 1868 | } |
| 1869 | |
| 1870 | return nil |
| 1871 | } |
| 1872 | |
| 1873 | for v := range variables { |
| 1874 | if !visited[v] { |
| 1875 | cycle := check(v) |
| 1876 | if cycle != nil { |
| 1877 | panic("inconceivable!") |
| 1878 | } |
| 1879 | } |
| 1880 | } |
| 1881 | } |
| 1882 | |
Jamie Gennis | af43556 | 2014-10-27 22:34:56 -0700 | [diff] [blame] | 1883 | // AllTargets returns a map all the build target names to the rule used to build |
| 1884 | // them. This is the same information that is output by running 'ninja -t |
| 1885 | // targets all'. If this is called before PrepareBuildActions successfully |
| 1886 | // completes then ErrbuildActionsNotReady is returned. |
| 1887 | func (c *Context) AllTargets() (map[string]string, error) { |
| 1888 | if !c.buildActionsReady { |
| 1889 | return nil, ErrBuildActionsNotReady |
| 1890 | } |
| 1891 | |
| 1892 | targets := map[string]string{} |
| 1893 | |
| 1894 | // Collect all the module build targets. |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 1895 | for _, module := range c.moduleInfo { |
| 1896 | for _, buildDef := range module.actionDefs.buildDefs { |
Jamie Gennis | af43556 | 2014-10-27 22:34:56 -0700 | [diff] [blame] | 1897 | ruleName := buildDef.Rule.fullName(c.pkgNames) |
| 1898 | for _, output := range buildDef.Outputs { |
Christian Zander | 6e2b232 | 2014-11-21 15:12:08 -0800 | [diff] [blame] | 1899 | outputValue, err := output.Eval(c.globalVariables) |
| 1900 | if err != nil { |
| 1901 | return nil, err |
| 1902 | } |
Jamie Gennis | af43556 | 2014-10-27 22:34:56 -0700 | [diff] [blame] | 1903 | targets[outputValue] = ruleName |
| 1904 | } |
| 1905 | } |
| 1906 | } |
| 1907 | |
| 1908 | // Collect all the singleton build targets. |
| 1909 | for _, info := range c.singletonInfo { |
| 1910 | for _, buildDef := range info.actionDefs.buildDefs { |
| 1911 | ruleName := buildDef.Rule.fullName(c.pkgNames) |
| 1912 | for _, output := range buildDef.Outputs { |
Christian Zander | 6e2b232 | 2014-11-21 15:12:08 -0800 | [diff] [blame] | 1913 | outputValue, err := output.Eval(c.globalVariables) |
| 1914 | if err != nil { |
Colin Cross | fea2b75 | 2014-12-30 16:05:02 -0800 | [diff] [blame] | 1915 | return nil, err |
Christian Zander | 6e2b232 | 2014-11-21 15:12:08 -0800 | [diff] [blame] | 1916 | } |
Jamie Gennis | af43556 | 2014-10-27 22:34:56 -0700 | [diff] [blame] | 1917 | targets[outputValue] = ruleName |
| 1918 | } |
| 1919 | } |
| 1920 | } |
| 1921 | |
| 1922 | return targets, nil |
| 1923 | } |
| 1924 | |
Jamie Gennis | d4e1018 | 2014-06-12 20:06:50 -0700 | [diff] [blame] | 1925 | // WriteBuildFile writes the Ninja manifeset text for the generated build |
| 1926 | // actions to w. If this is called before PrepareBuildActions successfully |
| 1927 | // completes then ErrBuildActionsNotReady is returned. |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 1928 | func (c *Context) WriteBuildFile(w io.Writer) error { |
| 1929 | if !c.buildActionsReady { |
| 1930 | return ErrBuildActionsNotReady |
| 1931 | } |
| 1932 | |
| 1933 | nw := newNinjaWriter(w) |
| 1934 | |
| 1935 | err := c.writeBuildFileHeader(nw) |
| 1936 | if err != nil { |
| 1937 | return err |
| 1938 | } |
| 1939 | |
| 1940 | err = c.writeNinjaRequiredVersion(nw) |
| 1941 | if err != nil { |
| 1942 | return err |
| 1943 | } |
| 1944 | |
| 1945 | // TODO: Group the globals by package. |
| 1946 | |
| 1947 | err = c.writeGlobalVariables(nw) |
| 1948 | if err != nil { |
| 1949 | return err |
| 1950 | } |
| 1951 | |
| 1952 | err = c.writeGlobalPools(nw) |
| 1953 | if err != nil { |
| 1954 | return err |
| 1955 | } |
| 1956 | |
| 1957 | err = c.writeBuildDir(nw) |
| 1958 | if err != nil { |
| 1959 | return err |
| 1960 | } |
| 1961 | |
| 1962 | err = c.writeGlobalRules(nw) |
| 1963 | if err != nil { |
| 1964 | return err |
| 1965 | } |
| 1966 | |
| 1967 | err = c.writeAllModuleActions(nw) |
| 1968 | if err != nil { |
| 1969 | return err |
| 1970 | } |
| 1971 | |
| 1972 | err = c.writeAllSingletonActions(nw) |
| 1973 | if err != nil { |
| 1974 | return err |
| 1975 | } |
| 1976 | |
| 1977 | return nil |
| 1978 | } |
| 1979 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 1980 | type pkgAssociation struct { |
| 1981 | PkgName string |
| 1982 | PkgPath string |
| 1983 | } |
| 1984 | |
| 1985 | type pkgAssociationSorter struct { |
| 1986 | pkgs []pkgAssociation |
| 1987 | } |
| 1988 | |
| 1989 | func (s *pkgAssociationSorter) Len() int { |
| 1990 | return len(s.pkgs) |
| 1991 | } |
| 1992 | |
| 1993 | func (s *pkgAssociationSorter) Less(i, j int) bool { |
| 1994 | iName := s.pkgs[i].PkgName |
| 1995 | jName := s.pkgs[j].PkgName |
| 1996 | return iName < jName |
| 1997 | } |
| 1998 | |
| 1999 | func (s *pkgAssociationSorter) Swap(i, j int) { |
| 2000 | s.pkgs[i], s.pkgs[j] = s.pkgs[j], s.pkgs[i] |
| 2001 | } |
| 2002 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2003 | func (c *Context) writeBuildFileHeader(nw *ninjaWriter) error { |
| 2004 | headerTemplate := template.New("fileHeader") |
| 2005 | _, err := headerTemplate.Parse(fileHeaderTemplate) |
| 2006 | if err != nil { |
| 2007 | // This is a programming error. |
| 2008 | panic(err) |
| 2009 | } |
| 2010 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2011 | var pkgs []pkgAssociation |
| 2012 | maxNameLen := 0 |
| 2013 | for pkg, name := range c.pkgNames { |
| 2014 | pkgs = append(pkgs, pkgAssociation{ |
| 2015 | PkgName: name, |
| 2016 | PkgPath: pkg.pkgPath, |
| 2017 | }) |
| 2018 | if len(name) > maxNameLen { |
| 2019 | maxNameLen = len(name) |
| 2020 | } |
| 2021 | } |
| 2022 | |
| 2023 | for i := range pkgs { |
| 2024 | pkgs[i].PkgName += strings.Repeat(" ", maxNameLen-len(pkgs[i].PkgName)) |
| 2025 | } |
| 2026 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2027 | sort.Sort(&pkgAssociationSorter{pkgs}) |
| 2028 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2029 | params := map[string]interface{}{ |
| 2030 | "Pkgs": pkgs, |
| 2031 | } |
| 2032 | |
| 2033 | buf := bytes.NewBuffer(nil) |
| 2034 | err = headerTemplate.Execute(buf, params) |
| 2035 | if err != nil { |
| 2036 | return err |
| 2037 | } |
| 2038 | |
| 2039 | return nw.Comment(buf.String()) |
| 2040 | } |
| 2041 | |
| 2042 | func (c *Context) writeNinjaRequiredVersion(nw *ninjaWriter) error { |
| 2043 | value := fmt.Sprintf("%d.%d.%d", c.requiredNinjaMajor, c.requiredNinjaMinor, |
| 2044 | c.requiredNinjaMicro) |
| 2045 | |
| 2046 | err := nw.Assign("ninja_required_version", value) |
| 2047 | if err != nil { |
| 2048 | return err |
| 2049 | } |
| 2050 | |
| 2051 | return nw.BlankLine() |
| 2052 | } |
| 2053 | |
| 2054 | func (c *Context) writeBuildDir(nw *ninjaWriter) error { |
| 2055 | if c.buildDir != nil { |
| 2056 | err := nw.Assign("builddir", c.buildDir.Value(c.pkgNames)) |
| 2057 | if err != nil { |
| 2058 | return err |
| 2059 | } |
| 2060 | |
| 2061 | err = nw.BlankLine() |
| 2062 | if err != nil { |
| 2063 | return err |
| 2064 | } |
| 2065 | } |
| 2066 | return nil |
| 2067 | } |
| 2068 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2069 | type globalEntity interface { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 2070 | fullName(pkgNames map[*PackageContext]string) string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2071 | } |
| 2072 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2073 | type globalEntitySorter struct { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 2074 | pkgNames map[*PackageContext]string |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2075 | entities []globalEntity |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2076 | } |
| 2077 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2078 | func (s *globalEntitySorter) Len() int { |
| 2079 | return len(s.entities) |
| 2080 | } |
| 2081 | |
| 2082 | func (s *globalEntitySorter) Less(i, j int) bool { |
| 2083 | iName := s.entities[i].fullName(s.pkgNames) |
| 2084 | jName := s.entities[j].fullName(s.pkgNames) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2085 | return iName < jName |
| 2086 | } |
| 2087 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2088 | func (s *globalEntitySorter) Swap(i, j int) { |
| 2089 | s.entities[i], s.entities[j] = s.entities[j], s.entities[i] |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2090 | } |
| 2091 | |
| 2092 | func (c *Context) writeGlobalVariables(nw *ninjaWriter) error { |
| 2093 | visited := make(map[Variable]bool) |
| 2094 | |
| 2095 | var walk func(v Variable) error |
| 2096 | walk = func(v Variable) error { |
| 2097 | visited[v] = true |
| 2098 | |
| 2099 | // First visit variables on which this variable depends. |
| 2100 | value := c.globalVariables[v] |
| 2101 | for _, dep := range value.variables { |
| 2102 | if !visited[dep] { |
| 2103 | err := walk(dep) |
| 2104 | if err != nil { |
| 2105 | return err |
| 2106 | } |
| 2107 | } |
| 2108 | } |
| 2109 | |
| 2110 | err := nw.Assign(v.fullName(c.pkgNames), value.Value(c.pkgNames)) |
| 2111 | if err != nil { |
| 2112 | return err |
| 2113 | } |
| 2114 | |
| 2115 | err = nw.BlankLine() |
| 2116 | if err != nil { |
| 2117 | return err |
| 2118 | } |
| 2119 | |
| 2120 | return nil |
| 2121 | } |
| 2122 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2123 | globalVariables := make([]globalEntity, 0, len(c.globalVariables)) |
| 2124 | for variable := range c.globalVariables { |
| 2125 | globalVariables = append(globalVariables, variable) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2126 | } |
| 2127 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2128 | sort.Sort(&globalEntitySorter{c.pkgNames, globalVariables}) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2129 | |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2130 | for _, entity := range globalVariables { |
| 2131 | v := entity.(Variable) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2132 | if !visited[v] { |
| 2133 | err := walk(v) |
| 2134 | if err != nil { |
| 2135 | return nil |
| 2136 | } |
| 2137 | } |
| 2138 | } |
| 2139 | |
| 2140 | return nil |
| 2141 | } |
| 2142 | |
| 2143 | func (c *Context) writeGlobalPools(nw *ninjaWriter) error { |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2144 | globalPools := make([]globalEntity, 0, len(c.globalPools)) |
| 2145 | for pool := range c.globalPools { |
| 2146 | globalPools = append(globalPools, pool) |
| 2147 | } |
| 2148 | |
| 2149 | sort.Sort(&globalEntitySorter{c.pkgNames, globalPools}) |
| 2150 | |
| 2151 | for _, entity := range globalPools { |
| 2152 | pool := entity.(Pool) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2153 | name := pool.fullName(c.pkgNames) |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2154 | def := c.globalPools[pool] |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2155 | err := def.WriteTo(nw, name) |
| 2156 | if err != nil { |
| 2157 | return err |
| 2158 | } |
| 2159 | |
| 2160 | err = nw.BlankLine() |
| 2161 | if err != nil { |
| 2162 | return err |
| 2163 | } |
| 2164 | } |
| 2165 | |
| 2166 | return nil |
| 2167 | } |
| 2168 | |
| 2169 | func (c *Context) writeGlobalRules(nw *ninjaWriter) error { |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2170 | globalRules := make([]globalEntity, 0, len(c.globalRules)) |
| 2171 | for rule := range c.globalRules { |
| 2172 | globalRules = append(globalRules, rule) |
| 2173 | } |
| 2174 | |
| 2175 | sort.Sort(&globalEntitySorter{c.pkgNames, globalRules}) |
| 2176 | |
| 2177 | for _, entity := range globalRules { |
| 2178 | rule := entity.(Rule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2179 | name := rule.fullName(c.pkgNames) |
Jamie Gennis | c15544d | 2014-09-24 20:26:52 -0700 | [diff] [blame] | 2180 | def := c.globalRules[rule] |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2181 | err := def.WriteTo(nw, name, c.pkgNames) |
| 2182 | if err != nil { |
| 2183 | return err |
| 2184 | } |
| 2185 | |
| 2186 | err = nw.BlankLine() |
| 2187 | if err != nil { |
| 2188 | return err |
| 2189 | } |
| 2190 | } |
| 2191 | |
| 2192 | return nil |
| 2193 | } |
| 2194 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2195 | type moduleSorter []*moduleInfo |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2196 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2197 | func (s moduleSorter) Len() int { |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2198 | return len(s) |
| 2199 | } |
| 2200 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2201 | func (s moduleSorter) Less(i, j int) bool { |
| 2202 | iName := s[i].properties.Name |
| 2203 | jName := s[j].properties.Name |
| 2204 | if iName == jName { |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 2205 | iName = s[i].variantName |
| 2206 | jName = s[j].variantName |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2207 | } |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2208 | return iName < jName |
| 2209 | } |
| 2210 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2211 | func (s moduleSorter) Swap(i, j int) { |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2212 | s[i], s[j] = s[j], s[i] |
| 2213 | } |
| 2214 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2215 | func (c *Context) writeAllModuleActions(nw *ninjaWriter) error { |
| 2216 | headerTemplate := template.New("moduleHeader") |
| 2217 | _, err := headerTemplate.Parse(moduleHeaderTemplate) |
| 2218 | if err != nil { |
| 2219 | // This is a programming error. |
| 2220 | panic(err) |
| 2221 | } |
| 2222 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2223 | modules := make([]*moduleInfo, 0, len(c.moduleInfo)) |
| 2224 | for _, module := range c.moduleInfo { |
| 2225 | modules = append(modules, module) |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2226 | } |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2227 | sort.Sort(moduleSorter(modules)) |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2228 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2229 | buf := bytes.NewBuffer(nil) |
| 2230 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2231 | for _, module := range modules { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2232 | buf.Reset() |
Jamie Gennis | 1ebd3b8 | 2014-06-04 15:33:08 -0700 | [diff] [blame] | 2233 | |
| 2234 | // In order to make the bootstrap build manifest independent of the |
| 2235 | // build dir we need to output the Blueprints file locations in the |
| 2236 | // comments as paths relative to the source directory. |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2237 | relPos := module.pos |
| 2238 | relPos.Filename = module.relBlueprintsFile |
Jamie Gennis | 1ebd3b8 | 2014-06-04 15:33:08 -0700 | [diff] [blame] | 2239 | |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2240 | // Get the name and location of the factory function for the module. |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2241 | factory := c.moduleFactories[module.typeName] |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2242 | factoryFunc := runtime.FuncForPC(reflect.ValueOf(factory).Pointer()) |
| 2243 | factoryName := factoryFunc.Name() |
| 2244 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2245 | infoMap := map[string]interface{}{ |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2246 | "properties": module.properties, |
| 2247 | "typeName": module.typeName, |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2248 | "goFactory": factoryName, |
Jamie Gennis | 1ebd3b8 | 2014-06-04 15:33:08 -0700 | [diff] [blame] | 2249 | "pos": relPos, |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 2250 | "variant": module.variantName, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2251 | } |
| 2252 | err = headerTemplate.Execute(buf, infoMap) |
| 2253 | if err != nil { |
| 2254 | return err |
| 2255 | } |
| 2256 | |
| 2257 | err = nw.Comment(buf.String()) |
| 2258 | if err != nil { |
| 2259 | return err |
| 2260 | } |
| 2261 | |
| 2262 | err = nw.BlankLine() |
| 2263 | if err != nil { |
| 2264 | return err |
| 2265 | } |
| 2266 | |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2267 | err = c.writeLocalBuildActions(nw, &module.actionDefs) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2268 | if err != nil { |
| 2269 | return err |
| 2270 | } |
| 2271 | |
| 2272 | err = nw.BlankLine() |
| 2273 | if err != nil { |
| 2274 | return err |
| 2275 | } |
| 2276 | } |
| 2277 | |
| 2278 | return nil |
| 2279 | } |
| 2280 | |
| 2281 | func (c *Context) writeAllSingletonActions(nw *ninjaWriter) error { |
| 2282 | headerTemplate := template.New("singletonHeader") |
| 2283 | _, err := headerTemplate.Parse(singletonHeaderTemplate) |
| 2284 | if err != nil { |
| 2285 | // This is a programming error. |
| 2286 | panic(err) |
| 2287 | } |
| 2288 | |
| 2289 | buf := bytes.NewBuffer(nil) |
| 2290 | |
Jamie Gennis | 86179fe | 2014-06-11 16:27:16 -0700 | [diff] [blame] | 2291 | singletonNames := make([]string, 0, len(c.singletonInfo)) |
| 2292 | for name := range c.singletonInfo { |
| 2293 | singletonNames = append(singletonNames, name) |
| 2294 | } |
| 2295 | sort.Strings(singletonNames) |
| 2296 | |
| 2297 | for _, name := range singletonNames { |
| 2298 | info := c.singletonInfo[name] |
| 2299 | |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2300 | // Get the name of the factory function for the module. |
| 2301 | factory := info.factory |
| 2302 | factoryFunc := runtime.FuncForPC(reflect.ValueOf(factory).Pointer()) |
| 2303 | factoryName := factoryFunc.Name() |
| 2304 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2305 | buf.Reset() |
| 2306 | infoMap := map[string]interface{}{ |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2307 | "name": name, |
| 2308 | "goFactory": factoryName, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2309 | } |
| 2310 | err = headerTemplate.Execute(buf, infoMap) |
| 2311 | if err != nil { |
| 2312 | return err |
| 2313 | } |
| 2314 | |
| 2315 | err = nw.Comment(buf.String()) |
| 2316 | if err != nil { |
| 2317 | return err |
| 2318 | } |
| 2319 | |
| 2320 | err = nw.BlankLine() |
| 2321 | if err != nil { |
| 2322 | return err |
| 2323 | } |
| 2324 | |
| 2325 | err = c.writeLocalBuildActions(nw, &info.actionDefs) |
| 2326 | if err != nil { |
| 2327 | return err |
| 2328 | } |
| 2329 | |
| 2330 | err = nw.BlankLine() |
| 2331 | if err != nil { |
| 2332 | return err |
| 2333 | } |
| 2334 | } |
| 2335 | |
| 2336 | return nil |
| 2337 | } |
| 2338 | |
| 2339 | func (c *Context) writeLocalBuildActions(nw *ninjaWriter, |
| 2340 | defs *localBuildActions) error { |
| 2341 | |
| 2342 | // Write the local variable assignments. |
| 2343 | for _, v := range defs.variables { |
| 2344 | // A localVariable doesn't need the package names or config to |
| 2345 | // determine its name or value. |
| 2346 | name := v.fullName(nil) |
| 2347 | value, err := v.value(nil) |
| 2348 | if err != nil { |
| 2349 | panic(err) |
| 2350 | } |
| 2351 | err = nw.Assign(name, value.Value(c.pkgNames)) |
| 2352 | if err != nil { |
| 2353 | return err |
| 2354 | } |
| 2355 | } |
| 2356 | |
| 2357 | if len(defs.variables) > 0 { |
| 2358 | err := nw.BlankLine() |
| 2359 | if err != nil { |
| 2360 | return err |
| 2361 | } |
| 2362 | } |
| 2363 | |
| 2364 | // Write the local rules. |
| 2365 | for _, r := range defs.rules { |
| 2366 | // A localRule doesn't need the package names or config to determine |
| 2367 | // its name or definition. |
| 2368 | name := r.fullName(nil) |
| 2369 | def, err := r.def(nil) |
| 2370 | if err != nil { |
| 2371 | panic(err) |
| 2372 | } |
| 2373 | |
| 2374 | err = def.WriteTo(nw, name, c.pkgNames) |
| 2375 | if err != nil { |
| 2376 | return err |
| 2377 | } |
| 2378 | |
| 2379 | err = nw.BlankLine() |
| 2380 | if err != nil { |
| 2381 | return err |
| 2382 | } |
| 2383 | } |
| 2384 | |
| 2385 | // Write the build definitions. |
| 2386 | for _, buildDef := range defs.buildDefs { |
| 2387 | err := buildDef.WriteTo(nw, c.pkgNames) |
| 2388 | if err != nil { |
| 2389 | return err |
| 2390 | } |
| 2391 | |
| 2392 | if len(buildDef.Args) > 0 { |
| 2393 | err = nw.BlankLine() |
| 2394 | if err != nil { |
| 2395 | return err |
| 2396 | } |
| 2397 | } |
| 2398 | } |
| 2399 | |
| 2400 | return nil |
| 2401 | } |
| 2402 | |
Colin Cross | 65569e4 | 2015-03-10 20:08:19 -0700 | [diff] [blame] | 2403 | func beforeInModuleList(a, b *moduleInfo, list []*moduleInfo) bool { |
| 2404 | found := false |
| 2405 | for _, l := range list { |
| 2406 | if l == a { |
| 2407 | found = true |
| 2408 | } else if l == b { |
| 2409 | return found |
| 2410 | } |
| 2411 | } |
| 2412 | |
| 2413 | missing := a |
| 2414 | if found { |
| 2415 | missing = b |
| 2416 | } |
| 2417 | panic(fmt.Errorf("element %v not found in list %v", missing, list)) |
| 2418 | } |
| 2419 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2420 | var fileHeaderTemplate = `****************************************************************************** |
| 2421 | *** This file is generated and should not be edited *** |
| 2422 | ****************************************************************************** |
| 2423 | {{if .Pkgs}} |
| 2424 | This file contains variables, rules, and pools with name prefixes indicating |
| 2425 | they were generated by the following Go packages: |
| 2426 | {{range .Pkgs}} |
| 2427 | {{.PkgName}} [from Go package {{.PkgPath}}]{{end}}{{end}} |
| 2428 | |
| 2429 | ` |
| 2430 | |
| 2431 | var moduleHeaderTemplate = `# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 2432 | Module: {{.properties.Name}} |
Colin Cross | ab6d790 | 2015-03-11 16:17:52 -0700 | [diff] [blame] | 2433 | Variant: {{.variant}} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2434 | Type: {{.typeName}} |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2435 | Factory: {{.goFactory}} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2436 | Defined: {{.pos}} |
| 2437 | ` |
| 2438 | |
| 2439 | var singletonHeaderTemplate = `# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 2440 | Singleton: {{.name}} |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 2441 | Factory: {{.goFactory}} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 2442 | ` |