src/variables.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef V8_VARIABLES_H_
   6 #define V8_VARIABLES_H_
   7
   8 #include "src/ast-value-factory.h"
   9 #include "src/interface.h"
  10 #include "src/zone.h"
  11
  12 namespace v8 {
  13 namespace internal {
  14
  15 // The AST refers to variables via VariableProxies - placeholders for the actual
  16 // variables. Variables themselves are never directly referred to from the AST,
  17 // they are maintained by scopes, and referred to from VariableProxies and Slots
  18 // after binding and variable allocation.
  19
  20 class Variable: public ZoneObject {
  21  public:
  22   enum Kind {
  23     NORMAL,
  24     THIS,
  25     ARGUMENTS
  26   };
  27
  28   enum Location {
  29     // Before and during variable allocation, a variable whose location is
  30     // not yet determined.  After allocation, a variable looked up as a
  31     // property on the global object (and possibly absent).  name() is the
  32     // variable name, index() is invalid.
  33     UNALLOCATED,
  34
  35     // A slot in the parameter section on the stack.  index() is the
  36     // parameter index, counting left-to-right.  The receiver is index -1;
  37     // the first parameter is index 0.
  38     PARAMETER,
  39
  40     // A slot in the local section on the stack.  index() is the variable
  41     // index in the stack frame, starting at 0.
  42     LOCAL,
  43
  44     // An indexed slot in a heap context.  index() is the variable index in
  45     // the context object on the heap, starting at 0.  scope() is the
  46     // corresponding scope.
  47     CONTEXT,
  48
  49     // A named slot in a heap context.  name() is the variable name in the
  50     // context object on the heap, with lookup starting at the current
  51     // context.  index() is invalid.
  52     LOOKUP
  53   };
  54
  55   Variable(Scope* scope,
  56            const AstRawString* name,
  57            VariableMode mode,
  58            bool is_valid_ref,
  59            Kind kind,
  60            InitializationFlag initialization_flag,
  61            Interface* interface = Interface::NewValue());
  62
  63   // Printing support
  64   static const char* Mode2String(VariableMode mode);
  65
  66   bool IsValidReference() { return is_valid_ref_; }
  67
  68   // The source code for an eval() call may refer to a variable that is
  69   // in an outer scope about which we don't know anything (it may not
  70   // be the global scope). scope() is NULL in that case. Currently the
  71   // scope is only used to follow the context chain length.
  72   Scope* scope() const { return scope_; }
  73
  74   Handle<String> name() const { return name_->string(); }
  75   const AstRawString* raw_name() const { return name_; }
  76   VariableMode mode() const { return mode_; }
  77   bool has_forced_context_allocation() const {
  78     return force_context_allocation_;
  79   }
  80   void ForceContextAllocation() {
  81     ASSERT(mode_ != TEMPORARY);
  82     force_context_allocation_ = true;
  83   }
  84   bool is_used() { return is_used_; }
  85   void set_is_used() { is_used_ = true; }
  86   bool maybe_assigned() { return maybe_assigned_; }
  87   void set_maybe_assigned() { maybe_assigned_ = true; }
  88
  89   int initializer_position() { return initializer_position_; }
  90   void set_initializer_position(int pos) { initializer_position_ = pos; }
  91
  92   bool IsVariable(Handle<String> n) const {
  93     return !is_this() && name().is_identical_to(n);
  94   }
  95
  96   bool IsUnallocated() const { return location_ == UNALLOCATED; }
  97   bool IsParameter() const { return location_ == PARAMETER; }
  98   bool IsStackLocal() const { return location_ == LOCAL; }
  99   bool IsStackAllocated() const { return IsParameter() || IsStackLocal(); }
 100   bool IsContextSlot() const { return location_ == CONTEXT; }
 101   bool IsLookupSlot() const { return location_ == LOOKUP; }
 102   bool IsGlobalObjectProperty() const;
 103
 104   bool is_dynamic() const { return IsDynamicVariableMode(mode_); }
 105   bool is_const_mode() const { return IsImmutableVariableMode(mode_); }
 106   bool binding_needs_init() const {
 107     return initialization_flag_ == kNeedsInitialization;
 108   }
 109
 110   bool is_this() const { return kind_ == THIS; }
 111   bool is_arguments() const { return kind_ == ARGUMENTS; }
 112
 113   // True if the variable is named eval and not known to be shadowed.
 114   bool is_possibly_eval(Isolate* isolate) const {
 115     return IsVariable(isolate->factory()->eval_string());
 116   }
 117
 118   Variable* local_if_not_shadowed() const {
 119     ASSERT(mode_ == DYNAMIC_LOCAL && local_if_not_shadowed_ != NULL);
 120     return local_if_not_shadowed_;
 121   }
 122
 123   void set_local_if_not_shadowed(Variable* local) {
 124     local_if_not_shadowed_ = local;
 125   }
 126
 127   Location location() const { return location_; }
 128   int index() const { return index_; }
 129   InitializationFlag initialization_flag() const {
 130     return initialization_flag_;
 131   }
 132   Interface* interface() const { return interface_; }
 133
 134   void AllocateTo(Location location, int index) {
 135     location_ = location;
 136     index_ = index;
 137   }
 138
 139   static int CompareIndex(Variable* const* v, Variable* const* w);
 140
 141  private:
 142   Scope* scope_;
 143   const AstRawString* name_;
 144   VariableMode mode_;
 145   Kind kind_;
 146   Location location_;
 147   int index_;
 148   int initializer_position_;
 149
 150   // If this field is set, this variable references the stored locally bound
 151   // variable, but it might be shadowed by variable bindings introduced by
 152   // sloppy 'eval' calls between the reference scope (inclusive) and the
 153   // binding scope (exclusive).
 154   Variable* local_if_not_shadowed_;
 155
 156   // Valid as a reference? (const and this are not valid, for example)
 157   bool is_valid_ref_;
 158
 159   // Usage info.
 160   bool force_context_allocation_;  // set by variable resolver
 161   bool is_used_;
 162   bool maybe_assigned_;
 163   InitializationFlag initialization_flag_;
 164
 165   // Module type info.
 166   Interface* interface_;
 167 };
 168
 169
 170 } }  // namespace v8::internal
 171
 172 #endif  // V8_VARIABLES_H_