blob: 75653de43f346f6332cd81b0981f1b1594c40d1e [file] [log] [blame]
// Copyright 2015 Google Inc. All rights reserved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef VAR_H_
#define VAR_H_
#include <string>
#include <unordered_map>
#include <unordered_set>
#include "expr.h"
#include "stmt.h"
#include "string_piece.h"
#include "symtab.h"
using namespace std;
class Evaluator;
class Value;
enum struct VarOrigin {
UNDEFINED,
DEFAULT,
ENVIRONMENT,
ENVIRONMENT_OVERRIDE,
FILE,
COMMAND_LINE,
OVERRIDE,
AUTOMATIC,
};
const char* GetOriginStr(VarOrigin origin);
class Var : public Evaluable {
public:
virtual ~Var();
virtual const char* Flavor() const = 0;
virtual VarOrigin Origin() const = 0;
virtual bool IsDefined() const { return true; }
virtual void AppendVar(Evaluator* ev, Value* v);
virtual StringPiece String() const = 0;
virtual string DebugString() const = 0;
bool ReadOnly() const { return readonly_; }
void SetReadOnly() { readonly_ = true; }
protected:
Var();
private:
bool readonly_;
};
class SimpleVar : public Var {
public:
explicit SimpleVar(VarOrigin origin);
SimpleVar(const string& v, VarOrigin origin);
virtual const char* Flavor() const override {
return "simple";
}
virtual VarOrigin Origin() const override {
return origin_;
}
virtual void Eval(Evaluator* ev, string* s) const override;
virtual void AppendVar(Evaluator* ev, Value* v) override;
virtual StringPiece String() const override;
virtual string DebugString() const override;
string* mutable_value() { return &v_; }
private:
string v_;
VarOrigin origin_;
};
class RecursiveVar : public Var {
public:
RecursiveVar(Value* v, VarOrigin origin, StringPiece orig);
virtual const char* Flavor() const override {
return "recursive";
}
virtual VarOrigin Origin() const override {
return origin_;
}
virtual void Eval(Evaluator* ev, string* s) const override;
virtual void AppendVar(Evaluator* ev, Value* v) override;
virtual StringPiece String() const override;
virtual string DebugString() const override;
private:
Value* v_;
VarOrigin origin_;
StringPiece orig_;
};
class UndefinedVar : public Var {
public:
UndefinedVar();
virtual const char* Flavor() const override {
return "undefined";
}
virtual VarOrigin Origin() const override {
return VarOrigin::UNDEFINED;
}
virtual bool IsDefined() const override { return false; }
virtual void Eval(Evaluator* ev, string* s) const override;
virtual StringPiece String() const override;
virtual string DebugString() const override;
};
extern UndefinedVar* kUndefined;
class RuleVar : public Var {
public:
RuleVar(Var* v, AssignOp op)
: v_(v), op_(op) {}
virtual ~RuleVar() {
delete v_;
}
virtual const char* Flavor() const override {
return v_->Flavor();
}
virtual VarOrigin Origin() const override {
return v_->Origin();
}
virtual bool IsDefined() const override {
return v_->IsDefined();
}
virtual void Eval(Evaluator* ev, string* s) const override {
v_->Eval(ev, s);
}
virtual void AppendVar(Evaluator* ev, Value* v) override {
v_->AppendVar(ev, v);
}
virtual StringPiece String() const override {
return v_->String();
}
virtual string DebugString() const override {
return v_->DebugString();
}
Var* v() const { return v_; }
AssignOp op() const { return op_; }
private:
Var* v_;
AssignOp op_;
};
class Vars : public unordered_map<Symbol, Var*> {
public:
~Vars();
Var* Lookup(Symbol name) const;
void Assign(Symbol name, Var* v, bool* readonly);
static void add_used_env_vars(Symbol v);
static const unordered_set<Symbol>& used_env_vars() {
return used_env_vars_;
}
private:
static unordered_set<Symbol> used_env_vars_;
};
class ScopedVar {
public:
// Does not take ownerships of arguments.
ScopedVar(Vars* vars, Symbol name, Var* var);
~ScopedVar();
private:
Vars* vars_;
Var* orig_;
Vars::iterator iter_;
};
#endif // VAR_H_