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 | "fmt" |
Colin Cross | b519a7e | 2017-02-01 13:21:35 -0800 | [diff] [blame^] | 19 | "github.com/google/blueprint/pathtools" |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 20 | ) |
| 21 | |
| 22 | type Singleton interface { |
| 23 | GenerateBuildActions(SingletonContext) |
| 24 | } |
| 25 | |
| 26 | type SingletonContext interface { |
Jamie Gennis | 6eb4d24 | 2014-06-11 18:31:16 -0700 | [diff] [blame] | 27 | Config() interface{} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 28 | |
| 29 | ModuleName(module Module) string |
| 30 | ModuleDir(module Module) string |
Colin Cross | 8c602f7 | 2015-12-17 18:02:11 -0800 | [diff] [blame] | 31 | ModuleSubDir(module Module) string |
Dan Willemsen | c98e55b | 2016-07-25 15:51:50 -0700 | [diff] [blame] | 32 | ModuleType(module Module) string |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 33 | BlueprintFile(module Module) string |
| 34 | |
| 35 | ModuleErrorf(module Module, format string, args ...interface{}) |
| 36 | Errorf(format string, args ...interface{}) |
Dan Willemsen | 265d92c | 2015-12-09 18:06:23 -0800 | [diff] [blame] | 37 | Failed() bool |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 38 | |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 39 | Variable(pctx PackageContext, name, value string) |
| 40 | Rule(pctx PackageContext, name string, params RuleParams, argNames ...string) Rule |
| 41 | Build(pctx PackageContext, params BuildParams) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 42 | RequireNinjaVersion(major, minor, micro int) |
| 43 | |
Colin Cross | a259945 | 2015-11-18 16:01:01 -0800 | [diff] [blame] | 44 | // SetNinjaBuildDir sets the value of the top-level "builddir" Ninja variable |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 45 | // that controls where Ninja stores its build log files. This value can be |
Colin Cross | a259945 | 2015-11-18 16:01:01 -0800 | [diff] [blame] | 46 | // set at most one time for a single build, later calls are ignored. |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 47 | SetNinjaBuildDir(pctx PackageContext, value string) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 48 | |
Dan Willemsen | 4bb6276 | 2016-01-14 15:42:54 -0800 | [diff] [blame] | 49 | // Eval takes a string with embedded ninja variables, and returns a string |
| 50 | // with all of the variables recursively expanded. Any variables references |
| 51 | // are expanded in the scope of the PackageContext. |
| 52 | Eval(pctx PackageContext, ninjaStr string) (string, error) |
| 53 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 54 | VisitAllModules(visit func(Module)) |
| 55 | VisitAllModulesIf(pred func(Module) bool, visit func(Module)) |
Jamie Gennis | e98b8a9 | 2014-06-17 10:24:24 -0700 | [diff] [blame] | 56 | VisitDepsDepthFirst(module Module, visit func(Module)) |
| 57 | VisitDepsDepthFirstIf(module Module, pred func(Module) bool, |
| 58 | visit func(Module)) |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 59 | |
Colin Cross | 24ad587 | 2015-11-17 16:22:29 -0800 | [diff] [blame] | 60 | VisitAllModuleVariants(module Module, visit func(Module)) |
| 61 | |
| 62 | PrimaryModule(module Module) Module |
| 63 | FinalModule(module Module) Module |
| 64 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 65 | AddNinjaFileDeps(deps ...string) |
Colin Cross | 127d2ea | 2016-11-01 11:10:51 -0700 | [diff] [blame] | 66 | |
| 67 | // GlobWithDeps returns a list of files that match the specified pattern but do not match any |
| 68 | // of the patterns in excludes. It also adds efficient dependencies to rerun the primary |
| 69 | // builder whenever a file matching the pattern as added or removed, without rerunning if a |
| 70 | // file that does not match the pattern is added to a searched directory. |
| 71 | GlobWithDeps(pattern string, excludes []string) ([]string, error) |
Colin Cross | b519a7e | 2017-02-01 13:21:35 -0800 | [diff] [blame^] | 72 | |
| 73 | Fs() pathtools.FileSystem |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | var _ SingletonContext = (*singletonContext)(nil) |
| 77 | |
| 78 | type singletonContext struct { |
| 79 | context *Context |
Jamie Gennis | 6eb4d24 | 2014-06-11 18:31:16 -0700 | [diff] [blame] | 80 | config interface{} |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 81 | scope *localScope |
Dan Willemsen | 4bb6276 | 2016-01-14 15:42:54 -0800 | [diff] [blame] | 82 | globals *liveTracker |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 83 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 84 | ninjaFileDeps []string |
| 85 | errs []error |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 86 | |
| 87 | actionDefs localBuildActions |
| 88 | } |
| 89 | |
Jamie Gennis | 6eb4d24 | 2014-06-11 18:31:16 -0700 | [diff] [blame] | 90 | func (s *singletonContext) Config() interface{} { |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 91 | return s.config |
| 92 | } |
| 93 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 94 | func (s *singletonContext) ModuleName(logicModule Module) string { |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 95 | return s.context.ModuleName(logicModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 96 | } |
| 97 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 98 | func (s *singletonContext) ModuleDir(logicModule Module) string { |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 99 | return s.context.ModuleDir(logicModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 100 | } |
| 101 | |
Colin Cross | 8c602f7 | 2015-12-17 18:02:11 -0800 | [diff] [blame] | 102 | func (s *singletonContext) ModuleSubDir(logicModule Module) string { |
| 103 | return s.context.ModuleSubDir(logicModule) |
| 104 | } |
| 105 | |
Dan Willemsen | c98e55b | 2016-07-25 15:51:50 -0700 | [diff] [blame] | 106 | func (s *singletonContext) ModuleType(logicModule Module) string { |
| 107 | return s.context.ModuleType(logicModule) |
| 108 | } |
| 109 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 110 | func (s *singletonContext) BlueprintFile(logicModule Module) string { |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 111 | return s.context.BlueprintFile(logicModule) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 112 | } |
| 113 | |
Colin Cross | 0aa6a5f | 2016-01-07 13:43:09 -0800 | [diff] [blame] | 114 | func (s *singletonContext) error(err error) { |
| 115 | if err != nil { |
| 116 | s.errs = append(s.errs, err) |
| 117 | } |
| 118 | } |
| 119 | |
Colin Cross | bbfa51a | 2014-12-17 16:12:41 -0800 | [diff] [blame] | 120 | func (s *singletonContext) ModuleErrorf(logicModule Module, format string, |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 121 | args ...interface{}) { |
| 122 | |
Colin Cross | 0aa6a5f | 2016-01-07 13:43:09 -0800 | [diff] [blame] | 123 | s.error(s.context.ModuleErrorf(logicModule, format, args...)) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 124 | } |
| 125 | |
| 126 | func (s *singletonContext) Errorf(format string, args ...interface{}) { |
| 127 | // TODO: Make this not result in the error being printed as "internal error" |
Colin Cross | 0aa6a5f | 2016-01-07 13:43:09 -0800 | [diff] [blame] | 128 | s.error(fmt.Errorf(format, args...)) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 129 | } |
| 130 | |
Dan Willemsen | 265d92c | 2015-12-09 18:06:23 -0800 | [diff] [blame] | 131 | func (s *singletonContext) Failed() bool { |
| 132 | return len(s.errs) > 0 |
| 133 | } |
| 134 | |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 135 | func (s *singletonContext) Variable(pctx PackageContext, name, value string) { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 136 | s.scope.ReparentTo(pctx) |
Jamie Gennis | 0ed63ef | 2014-06-30 18:07:17 -0700 | [diff] [blame] | 137 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 138 | v, err := s.scope.AddLocalVariable(name, value) |
| 139 | if err != nil { |
| 140 | panic(err) |
| 141 | } |
| 142 | |
| 143 | s.actionDefs.variables = append(s.actionDefs.variables, v) |
| 144 | } |
| 145 | |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 146 | func (s *singletonContext) Rule(pctx PackageContext, name string, |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 147 | params RuleParams, argNames ...string) Rule { |
Jamie Gennis | cbc6f86 | 2014-06-05 20:00:22 -0700 | [diff] [blame] | 148 | |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 149 | s.scope.ReparentTo(pctx) |
Jamie Gennis | 0ed63ef | 2014-06-30 18:07:17 -0700 | [diff] [blame] | 150 | |
Jamie Gennis | cbc6f86 | 2014-06-05 20:00:22 -0700 | [diff] [blame] | 151 | r, err := s.scope.AddLocalRule(name, ¶ms, argNames...) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 152 | if err != nil { |
| 153 | panic(err) |
| 154 | } |
| 155 | |
| 156 | s.actionDefs.rules = append(s.actionDefs.rules, r) |
| 157 | |
| 158 | return r |
| 159 | } |
| 160 | |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 161 | func (s *singletonContext) Build(pctx PackageContext, params BuildParams) { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 162 | s.scope.ReparentTo(pctx) |
Jamie Gennis | 0ed63ef | 2014-06-30 18:07:17 -0700 | [diff] [blame] | 163 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 164 | def, err := parseBuildParams(s.scope, ¶ms) |
| 165 | if err != nil { |
| 166 | panic(err) |
| 167 | } |
| 168 | |
| 169 | s.actionDefs.buildDefs = append(s.actionDefs.buildDefs, def) |
| 170 | } |
| 171 | |
Dan Willemsen | 4bb6276 | 2016-01-14 15:42:54 -0800 | [diff] [blame] | 172 | func (s *singletonContext) Eval(pctx PackageContext, str string) (string, error) { |
| 173 | s.scope.ReparentTo(pctx) |
| 174 | |
| 175 | ninjaStr, err := parseNinjaString(s.scope, str) |
| 176 | if err != nil { |
| 177 | return "", err |
| 178 | } |
| 179 | |
| 180 | err = s.globals.addNinjaStringDeps(ninjaStr) |
| 181 | if err != nil { |
| 182 | return "", err |
| 183 | } |
| 184 | |
| 185 | return ninjaStr.Eval(s.globals.variables) |
| 186 | } |
| 187 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 188 | func (s *singletonContext) RequireNinjaVersion(major, minor, micro int) { |
| 189 | s.context.requireNinjaVersion(major, minor, micro) |
| 190 | } |
| 191 | |
Dan Willemsen | aeffbf7 | 2015-11-25 15:29:32 -0800 | [diff] [blame] | 192 | func (s *singletonContext) SetNinjaBuildDir(pctx PackageContext, value string) { |
Jamie Gennis | 2fb2095 | 2014-10-03 02:49:58 -0700 | [diff] [blame] | 193 | s.scope.ReparentTo(pctx) |
Jamie Gennis | 7d5b2f8 | 2014-09-24 17:51:52 -0700 | [diff] [blame] | 194 | |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 195 | ninjaValue, err := parseNinjaString(s.scope, value) |
| 196 | if err != nil { |
| 197 | panic(err) |
| 198 | } |
| 199 | |
Colin Cross | a259945 | 2015-11-18 16:01:01 -0800 | [diff] [blame] | 200 | s.context.setNinjaBuildDir(ninjaValue) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | func (s *singletonContext) VisitAllModules(visit func(Module)) { |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 204 | s.context.VisitAllModules(visit) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 205 | } |
| 206 | |
| 207 | func (s *singletonContext) VisitAllModulesIf(pred func(Module) bool, |
| 208 | visit func(Module)) { |
| 209 | |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 210 | s.context.VisitAllModulesIf(pred, visit) |
Jamie Gennis | 1bc967e | 2014-05-27 16:34:41 -0700 | [diff] [blame] | 211 | } |
Jamie Gennis | e98b8a9 | 2014-06-17 10:24:24 -0700 | [diff] [blame] | 212 | |
| 213 | func (s *singletonContext) VisitDepsDepthFirst(module Module, |
| 214 | visit func(Module)) { |
| 215 | |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 216 | s.context.VisitDepsDepthFirst(module, visit) |
Jamie Gennis | e98b8a9 | 2014-06-17 10:24:24 -0700 | [diff] [blame] | 217 | } |
| 218 | |
| 219 | func (s *singletonContext) VisitDepsDepthFirstIf(module Module, |
| 220 | pred func(Module) bool, visit func(Module)) { |
| 221 | |
Colin Cross | 4572edd | 2015-05-13 14:36:24 -0700 | [diff] [blame] | 222 | s.context.VisitDepsDepthFirstIf(module, pred, visit) |
Jamie Gennis | e98b8a9 | 2014-06-17 10:24:24 -0700 | [diff] [blame] | 223 | } |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 224 | |
Colin Cross | 24ad587 | 2015-11-17 16:22:29 -0800 | [diff] [blame] | 225 | func (s *singletonContext) PrimaryModule(module Module) Module { |
| 226 | return s.context.PrimaryModule(module) |
| 227 | } |
| 228 | |
| 229 | func (s *singletonContext) FinalModule(module Module) Module { |
| 230 | return s.context.FinalModule(module) |
| 231 | } |
| 232 | |
| 233 | func (s *singletonContext) VisitAllModuleVariants(module Module, visit func(Module)) { |
| 234 | s.context.VisitAllModuleVariants(module, visit) |
| 235 | } |
| 236 | |
Mathias Agopian | 5b8477d | 2014-06-25 17:21:54 -0700 | [diff] [blame] | 237 | func (s *singletonContext) AddNinjaFileDeps(deps ...string) { |
| 238 | s.ninjaFileDeps = append(s.ninjaFileDeps, deps...) |
| 239 | } |
Colin Cross | 127d2ea | 2016-11-01 11:10:51 -0700 | [diff] [blame] | 240 | |
| 241 | func (s *singletonContext) GlobWithDeps(pattern string, |
| 242 | excludes []string) ([]string, error) { |
| 243 | return s.context.glob(pattern, excludes) |
| 244 | } |
Colin Cross | b519a7e | 2017-02-01 13:21:35 -0800 | [diff] [blame^] | 245 | |
| 246 | func (s *singletonContext) Fs() pathtools.FileSystem { |
| 247 | return s.context.fs |
| 248 | } |