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 | |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 35 | enum struct VarOrigin : char { |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 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; |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 53 | |
| 54 | VarOrigin Origin() { return origin_; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 55 | virtual bool IsDefined() const { return true; } |
| 56 | |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 57 | virtual void AppendVar(Evaluator* ev, Value* v); |
| 58 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 59 | virtual StringPiece String() const = 0; |
| 60 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 61 | virtual string DebugString() const = 0; |
| 62 | |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 63 | bool ReadOnly() const { return readonly_; } |
| 64 | void SetReadOnly() { readonly_ = true; } |
| 65 | |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 66 | bool Deprecated() const { return deprecated_; } |
| 67 | void SetDeprecated(const StringPiece& msg); |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 68 | |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 69 | bool Obsolete() const { return obsolete_; } |
| 70 | void SetObsolete(const StringPiece& msg); |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 71 | |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 72 | const string& DeprecatedMessage() const; |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 73 | |
| 74 | // This variable was used (either written or read from) |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 75 | void Used(Evaluator* ev, const Symbol& sym) const; |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 76 | |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 77 | AssignOp op() const { return assign_op_; } |
| 78 | void SetAssignOp(AssignOp op) { assign_op_ = op; } |
| 79 | |
Dan Willemsen | ee57a3f | 2018-11-05 16:18:44 -0800 | [diff] [blame] | 80 | static Var* Undefined(); |
Dan Willemsen | 276e96a | 2017-10-03 14:24:48 -0700 | [diff] [blame] | 81 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 82 | protected: |
| 83 | Var(); |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 84 | explicit Var(VarOrigin origin); |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 85 | |
| 86 | private: |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 87 | const VarOrigin origin_; |
| 88 | AssignOp assign_op_; |
Dan Willemsen | ee57a3f | 2018-11-05 16:18:44 -0800 | [diff] [blame] | 89 | bool readonly_ : 1; |
| 90 | bool deprecated_ : 1; |
| 91 | bool obsolete_ : 1; |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 92 | |
Dan Willemsen | ee57a3f | 2018-11-05 16:18:44 -0800 | [diff] [blame] | 93 | const char* diagnostic_message_text() const; |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 94 | |
Dan Willemsen | ee57a3f | 2018-11-05 16:18:44 -0800 | [diff] [blame] | 95 | static unordered_map<const Var*, string> diagnostic_messages_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 96 | }; |
| 97 | |
| 98 | class SimpleVar : public Var { |
| 99 | public: |
Shinichiro Hamaji | 90e52ce | 2016-02-10 13:53:41 +0900 | [diff] [blame] | 100 | explicit SimpleVar(VarOrigin origin); |
Shinichiro Hamaji | 5081c71 | 2015-08-14 16:49:20 +0900 | [diff] [blame] | 101 | SimpleVar(const string& v, VarOrigin origin); |
Sasha Smundak | ae1d58c | 2018-08-22 09:39:42 -0700 | [diff] [blame] | 102 | SimpleVar(VarOrigin, Evaluator* ev, Value* v); |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 103 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 104 | virtual const char* Flavor() const override { return "simple"; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 105 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 106 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 107 | |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 108 | virtual void AppendVar(Evaluator* ev, Value* v) override; |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 109 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 110 | virtual StringPiece String() const override; |
| 111 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 112 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 113 | |
| 114 | private: |
Shinichiro Hamaji | 5081c71 | 2015-08-14 16:49:20 +0900 | [diff] [blame] | 115 | string v_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 116 | }; |
| 117 | |
| 118 | class RecursiveVar : public Var { |
| 119 | public: |
Shinichiro Hamaji | f62e9a7 | 2015-06-26 04:18:21 +0900 | [diff] [blame] | 120 | RecursiveVar(Value* v, VarOrigin origin, StringPiece orig); |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 121 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 122 | virtual const char* Flavor() const override { return "recursive"; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 123 | |
| 124 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 125 | |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 126 | virtual void AppendVar(Evaluator* ev, Value* v) override; |
Shinichiro Hamaji | 4c469b3 | 2015-06-15 19:53:36 +0900 | [diff] [blame] | 127 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 128 | virtual StringPiece String() const override; |
| 129 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 130 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 131 | |
| 132 | private: |
| 133 | Value* v_; |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 134 | StringPiece orig_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 135 | }; |
| 136 | |
| 137 | class UndefinedVar : public Var { |
| 138 | public: |
| 139 | UndefinedVar(); |
| 140 | |
Dan Willemsen | 3ce083f | 2017-10-11 22:17:48 -0700 | [diff] [blame] | 141 | virtual const char* Flavor() const override { return "undefined"; } |
Shinichiro Hamaji | 4b351ab | 2016-02-12 19:42:30 +0900 | [diff] [blame] | 142 | virtual bool IsDefined() const override { return false; } |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 143 | |
| 144 | virtual void Eval(Evaluator* ev, string* s) const override; |
| 145 | |
Shinichiro Hamaji | 81699be | 2015-06-22 18:07:38 +0900 | [diff] [blame] | 146 | virtual StringPiece String() const override; |
| 147 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 148 | virtual string DebugString() const override; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 149 | }; |
| 150 | |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 151 | class Vars : public unordered_map<Symbol, Var*> { |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 152 | public: |
| 153 | ~Vars(); |
| 154 | |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 155 | Var* Lookup(Symbol name) const; |
Dan Willemsen | ff90ea3 | 2017-11-21 13:22:26 -0800 | [diff] [blame] | 156 | Var* Peek(Symbol name) const; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 157 | |
Dan Willemsen | f87d49e | 2016-09-29 20:09:47 -0700 | [diff] [blame] | 158 | void Assign(Symbol name, Var* v, bool* readonly); |
Shinichiro Hamaji | 5163e04 | 2015-07-14 03:51:44 +0900 | [diff] [blame] | 159 | |
Shinichiro Hamaji | c9b9e5e | 2016-02-18 18:18:54 +0900 | [diff] [blame] | 160 | static void add_used_env_vars(Symbol v); |
| 161 | |
Sasha Smundak | 8174f9b | 2018-08-13 11:07:30 -0700 | [diff] [blame] | 162 | static const SymbolSet used_env_vars() { return used_env_vars_; } |
Shinichiro Hamaji | 5163e04 | 2015-07-14 03:51:44 +0900 | [diff] [blame] | 163 | |
| 164 | private: |
Sasha Smundak | 8174f9b | 2018-08-13 11:07:30 -0700 | [diff] [blame] | 165 | static SymbolSet used_env_vars_; |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 166 | }; |
| 167 | |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 168 | class ScopedVar { |
| 169 | public: |
| 170 | // Does not take ownerships of arguments. |
Shinichiro Hamaji | e799275 | 2015-06-29 18:38:35 +0900 | [diff] [blame] | 171 | ScopedVar(Vars* vars, Symbol name, Var* var); |
Shinichiro Hamaji | cf0cd68 | 2015-06-18 16:18:13 +0900 | [diff] [blame] | 172 | ~ScopedVar(); |
| 173 | |
| 174 | private: |
| 175 | Vars* vars_; |
| 176 | Var* orig_; |
| 177 | Vars::iterator iter_; |
| 178 | }; |
| 179 | |
Shinichiro Hamaji | 776ca30 | 2015-06-06 03:52:48 +0900 | [diff] [blame] | 180 | #endif // VAR_H_ |