src/variables.h

   1 // Copyright 2011 the V8 project authors. All rights reserved.
   2 // Redistribution and use in source and binary forms, with or without
   3 // modification, are permitted provided that the following conditions are
   4 // met:
   5 //
   6 //     * Redistributions of source code must retain the above copyright
   7 //       notice, this list of conditions and the following disclaimer.
   8 //     * Redistributions in binary form must reproduce the above
   9 //       copyright notice, this list of conditions and the following
  10 //       disclaimer in the documentation and/or other materials provided
  11 //       with the distribution.
  12 //     * Neither the name of Google Inc. nor the names of its
  13 //       contributors may be used to endorse or promote products derived
  14 //       from this software without specific prior written permission.
  15 //
  16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 #ifndef V8_VARIABLES_H_
  29 #define V8_VARIABLES_H_
  30
  31 #include "zone.h"
  32
  33 namespace v8 {
  34 namespace internal {
  35
  36 // The AST refers to variables via VariableProxies - placeholders for the actual
  37 // variables. Variables themselves are never directly referred to from the AST,
  38 // they are maintained by scopes, and referred to from VariableProxies and Slots
  39 // after binding and variable allocation.
  40
  41 class Variable: public ZoneObject {
  42  public:
  43   enum Kind {
  44     NORMAL,
  45     THIS,
  46     ARGUMENTS
  47   };
  48
  49   enum Location {
  50     // Before and during variable allocation, a variable whose location is
  51     // not yet determined.  After allocation, a variable looked up as a
  52     // property on the global object (and possibly absent).  name() is the
  53     // variable name, index() is invalid.
  54     UNALLOCATED,
  55
  56     // A slot in the parameter section on the stack.  index() is the
  57     // parameter index, counting left-to-right.  The reciever is index -1;
  58     // the first parameter is index 0.
  59     PARAMETER,
  60
  61     // A slot in the local section on the stack.  index() is the variable
  62     // index in the stack frame, starting at 0.
  63     LOCAL,
  64
  65     // An indexed slot in a heap context.  index() is the variable index in
  66     // the context object on the heap, starting at 0.  scope() is the
  67     // corresponding scope.
  68     CONTEXT,
  69
  70     // A named slot in a heap context.  name() is the variable name in the
  71     // context object on the heap, with lookup starting at the current
  72     // context.  index() is invalid.
  73     LOOKUP
  74   };
  75
  76   Variable(Scope* scope,
  77            Handle<String> name,
  78            VariableMode mode,
  79            bool is_valid_lhs,
  80            Kind kind,
  81            InitializationFlag initialization_flag);
  82
  83   // Printing support
  84   static const char* Mode2String(VariableMode mode);
  85
  86   bool IsValidLeftHandSide() { return is_valid_LHS_; }
  87
  88   // The source code for an eval() call may refer to a variable that is
  89   // in an outer scope about which we don't know anything (it may not
  90   // be the global scope). scope() is NULL in that case. Currently the
  91   // scope is only used to follow the context chain length.
  92   Scope* scope() const { return scope_; }
  93
  94   Handle<String> name() const { return name_; }
  95   VariableMode mode() const { return mode_; }
  96   bool has_forced_context_allocation() const {
  97     return force_context_allocation_;
  98   }
  99   void ForceContextAllocation() {
 100     ASSERT(mode_ != TEMPORARY);
 101     force_context_allocation_ = true;
 102   }
 103   bool is_used() { return is_used_; }
 104   void set_is_used(bool flag) { is_used_ = flag; }
 105
 106   int initializer_position() { return initializer_position_; }
 107   void set_initializer_position(int pos) { initializer_position_ = pos; }
 108
 109   bool IsVariable(Handle<String> n) const {
 110     return !is_this() && name().is_identical_to(n);
 111   }
 112
 113   bool IsUnallocated() const { return location_ == UNALLOCATED; }
 114   bool IsParameter() const { return location_ == PARAMETER; }
 115   bool IsStackLocal() const { return location_ == LOCAL; }
 116   bool IsStackAllocated() const { return IsParameter() || IsStackLocal(); }
 117   bool IsContextSlot() const { return location_ == CONTEXT; }
 118   bool IsLookupSlot() const { return location_ == LOOKUP; }
 119
 120   bool is_dynamic() const {
 121     return (mode_ == DYNAMIC ||
 122             mode_ == DYNAMIC_GLOBAL ||
 123             mode_ == DYNAMIC_LOCAL);
 124   }
 125   bool is_const_mode() const {
 126     return (mode_ == CONST ||
 127             mode_ == CONST_HARMONY);
 128   }
 129   bool binding_needs_init() const {
 130     return initialization_flag_ == kNeedsInitialization;
 131   }
 132
 133   bool is_global() const;
 134   bool is_this() const { return kind_ == THIS; }
 135   bool is_arguments() const { return kind_ == ARGUMENTS; }
 136
 137   // True if the variable is named eval and not known to be shadowed.
 138   bool is_possibly_eval() const {
 139     return IsVariable(FACTORY->eval_symbol());
 140   }
 141
 142   Variable* local_if_not_shadowed() const {
 143     ASSERT(mode_ == DYNAMIC_LOCAL && local_if_not_shadowed_ != NULL);
 144     return local_if_not_shadowed_;
 145   }
 146
 147   void set_local_if_not_shadowed(Variable* local) {
 148     local_if_not_shadowed_ = local;
 149   }
 150
 151   Location location() const { return location_; }
 152   int index() const { return index_; }
 153   InitializationFlag initialization_flag() const {
 154     return initialization_flag_;
 155   }
 156
 157   void AllocateTo(Location location, int index) {
 158     location_ = location;
 159     index_ = index;
 160   }
 161
 162  private:
 163   Scope* scope_;
 164   Handle<String> name_;
 165   VariableMode mode_;
 166   Kind kind_;
 167   Location location_;
 168   int index_;
 169   int initializer_position_;
 170
 171   // If this field is set, this variable references the stored locally bound
 172   // variable, but it might be shadowed by variable bindings introduced by
 173   // non-strict 'eval' calls between the reference scope (inclusive) and the
 174   // binding scope (exclusive).
 175   Variable* local_if_not_shadowed_;
 176
 177   // Valid as a LHS? (const and this are not valid LHS, for example)
 178   bool is_valid_LHS_;
 179
 180   // Usage info.
 181   bool force_context_allocation_;  // set by variable resolver
 182   bool is_used_;
 183   InitializationFlag initialization_flag_;
 184 };
 185
 186
 187 } }  // namespace v8::internal
 188
 189 #endif  // V8_VARIABLES_H_