Shinichiro Hamaji | 1d545aa | 2015-06-23 15:29:13 +0900 | [diff] [blame] | 1 | // Copyright 2015 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 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 15 | #ifndef VAR_H_ |
| 16 | #define VAR_H_ |
| 17 | |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 18 | #include <memory> |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 19 | #include <string> |
| 20 | #include <unordered_map> |
Shinichiro Hamaji | 5163e04 | 2015-07-14 03:51:44 +0900 | [diff] [blame] | 21 | #include <unordered_set> |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 22 | |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 23 | #include "eval.h" |
Shinichiro Hamaji | 645cca7 | 2015-09-24 17:04:21 +0900 | [diff] [blame] | 24 | #include "expr.h" |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 25 | #include "log.h" |
Shinichiro Hamaji | 645cca7 | 2015-09-24 17:04:21 +0900 | [diff] [blame] | 26 | #include "stmt.h" |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 27 | #include "string_piece.h" |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 28 | #include "symtab.h" |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 29 | |
| 30 | using namespace std; |
| 31 | |
| 32 | class Evaluator; |
| 33 | class Value; |
| 34 | |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 35 | enum struct VarOrigin { |
| 36 | UNDEFINED, |
| 37 | DEFAULT, |
| 38 | ENVIRONMENT, |
| 39 | ENVIRONMENT_OVERRIDE, |
| 40 | FILE, |
| 41 | COMMAND_LINE, |
| 42 | OVERRIDE, |
| 43 | AUTOMATIC, |
| 44 | }; |
| 45 | |
| 46 | const char* GetOriginStr(VarOrigin origin); |
| 47 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 48 | class Var : public Evaluable { |
| 49 | public: |
| 50 | virtual ~Var(); |
| 51 | |
| 52 | virtual const char* Flavor() const = 0; |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 53 | virtual VarOrigin Origin() const = 0; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 54 | virtual bool IsDefined() const { return true; } |
| 55 | |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 56 | virtual void AppendVar(Evaluator* ev, Value* v); |
| 57 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 58 | virtual StringPiece String() const = 0; |
| 59 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 60 | virtual string DebugString() const = 0; |
| 61 | |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 62 | bool ReadOnly() const { return readonly_; } |
| 63 | void SetReadOnly() { readonly_ = true; } |
| 64 | |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 65 | bool Deprecated() const { return message_ && !error_; } |
| 66 | void SetDeprecated(StringPiece msg) { |
| 67 | message_.reset(new string(msg.as_string())); |
| 68 | } |
| 69 | |
| 70 | bool Obsolete() const { return error_; } |
| 71 | void SetObsolete(StringPiece msg) { |
| 72 | message_.reset(new string(msg.as_string())); |
| 73 | error_ = true; |
| 74 | } |
| 75 | |
| 76 | const string& DeprecatedMessage() const { return *message_; } |
| 77 | |
| 78 | // This variable was used (either written or read from) |
| 79 | void Used(Evaluator* ev, const Symbol& sym) const { |
| 80 | if (!message_) { |
| 81 | return; |
| 82 | } |
| 83 | |
| 84 | if (error_) { |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 85 | ev->Error(StringPrintf("*** %s is obsolete%s.", sym.c_str(), |
| 86 | message_->c_str())); |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 87 | } else { |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 88 | WARN_LOC(ev->loc(), "%s has been deprecated%s.", sym.c_str(), |
| 89 | message_->c_str()); |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 90 | } |
| 91 | } |
| 92 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 93 | protected: |
| 94 | Var(); |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 95 | |
| 96 | private: |
| 97 | bool readonly_; |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 98 | unique_ptr<string> message_; |
| 99 | bool error_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 100 | }; |
| 101 | |
| 102 | class SimpleVar : public Var { |
| 103 | public: |
Shinichiro Hamaji | 90e52ce | 2016-02-10 13:53:41 +0900 | [diff] [blame] | 104 | explicit SimpleVar(VarOrigin origin); |
Shinichiro Hamaji | 5081c71 | 2015-08-14 16:49:20 +0900 | [diff] [blame] | 105 | SimpleVar(const string& v, VarOrigin origin); |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 106 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 107 | virtual const char* Flavor() const override { return "simple"; } |
| 108 | virtual VarOrigin Origin() const override { return origin_; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 109 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 110 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 111 | |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 112 | virtual void AppendVar(Evaluator* ev, Value* v) override; |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 113 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 114 | virtual StringPiece String() const override; |
| 115 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 116 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 117 | |
Shinichiro Hamaji | 90e52ce | 2016-02-10 13:53:41 +0900 | [diff] [blame] | 118 | string* mutable_value() { return &v_; } |
| 119 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 120 | private: |
Shinichiro Hamaji | 5081c71 | 2015-08-14 16:49:20 +0900 | [diff] [blame] | 121 | string v_; |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 122 | VarOrigin origin_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 123 | }; |
| 124 | |
| 125 | class RecursiveVar : public Var { |
| 126 | public: |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 127 | RecursiveVar(Value* v, VarOrigin origin, StringPiece orig); |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 128 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 129 | virtual const char* Flavor() const override { return "recursive"; } |
| 130 | virtual VarOrigin Origin() const override { return origin_; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 131 | |
| 132 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 133 | |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 134 | virtual void AppendVar(Evaluator* ev, Value* v) override; |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 135 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 136 | virtual StringPiece String() const override; |
| 137 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 138 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 139 | |
| 140 | private: |
| 141 | Value* v_; |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 142 | VarOrigin origin_; |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 143 | StringPiece orig_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 144 | }; |
| 145 | |
| 146 | class UndefinedVar : public Var { |
| 147 | public: |
| 148 | UndefinedVar(); |
| 149 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 150 | virtual const char* Flavor() const override { return "undefined"; } |
| 151 | virtual VarOrigin Origin() const override { return VarOrigin::UNDEFINED; } |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 152 | virtual bool IsDefined() const override { return false; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 153 | |
| 154 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 155 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 156 | virtual StringPiece String() const override; |
| 157 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 158 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 159 | }; |
| 160 | |
| 161 | extern UndefinedVar* kUndefined; |
| 162 | |
Shinichiro Hamaji | ffc52c3 | 2015-06-23 16:51:07 +0900 | [diff] [blame] | 163 | class RuleVar : public Var { |
| 164 | public: |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 165 | RuleVar(Var* v, AssignOp op) : v_(v), op_(op) {} |
| 166 | virtual ~RuleVar() { delete v_; } |
Shinichiro Hamaji | ffc52c3 | 2015-06-23 16:51:07 +0900 | [diff] [blame] | 167 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 168 | virtual const char* Flavor() const override { return v_->Flavor(); } |
| 169 | virtual VarOrigin Origin() const override { return v_->Origin(); } |
| 170 | virtual bool IsDefined() const override { return v_->IsDefined(); } |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 171 | virtual void Eval(Evaluator* ev, string* s) const override { |
Shinichiro Hamaji | ffc52c3 | 2015-06-23 16:51:07 +0900 | [diff] [blame] | 172 | v_->Eval(ev, s); |
| 173 | } |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 174 | virtual void AppendVar(Evaluator* ev, Value* v) override { |
Shinichiro Hamaji | ffc52c3 | 2015-06-23 16:51:07 +0900 | [diff] [blame] | 175 | v_->AppendVar(ev, v); |
| 176 | } |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 177 | virtual StringPiece String() const override { return v_->String(); } |
| 178 | virtual string DebugString() const override { return v_->DebugString(); } |
Shinichiro Hamaji | ffc52c3 | 2015-06-23 16:51:07 +0900 | [diff] [blame] | 179 | |
| 180 | Var* v() const { return v_; } |
| 181 | AssignOp op() const { return op_; } |
| 182 | |
| 183 | private: |
| 184 | Var* v_; |
| 185 | AssignOp op_; |
| 186 | }; |
| 187 | |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 188 | class Vars : public unordered_map<Symbol, Var*> { |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 189 | public: |
| 190 | ~Vars(); |
| 191 | |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 192 | Var* Lookup(Symbol name) const; |
Dan Willemsen | ff90ea3 | 2017-11-21 13:22:26 -0800 | [diff] [blame] | 193 | Var* Peek(Symbol name) const; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 194 | |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 195 | void Assign(Symbol name, Var* v, bool* readonly); |
Shinichiro Hamaji | 5163e04 | 2015-07-14 03:51:44 +0900 | [diff] [blame] | 196 | |
Shinichiro Hamaji | c9b9e5e | 2016-02-18 18:18:54 +0900 | [diff] [blame] | 197 | static void add_used_env_vars(Symbol v); |
| 198 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 199 | static const unordered_set<Symbol>& used_env_vars() { return used_env_vars_; } |
Shinichiro Hamaji | 5163e04 | 2015-07-14 03:51:44 +0900 | [diff] [blame] | 200 | |
| 201 | private: |
| 202 | static unordered_set<Symbol> used_env_vars_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 203 | }; |
| 204 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 205 | class ScopedVar { |
| 206 | public: |
| 207 | // Does not take ownerships of arguments. |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 208 | ScopedVar(Vars* vars, Symbol name, Var* var); |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 209 | ~ScopedVar(); |
| 210 | |
| 211 | private: |
| 212 | Vars* vars_; |
| 213 | Var* orig_; |
| 214 | Vars::iterator iter_; |
| 215 | }; |
| 216 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 217 | #endif // VAR_H_ |