src/variables.h

   1 // Copyright 2006-2008 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 // Variables and AST expression nodes can track their "type" to enable
  37 // optimizations and removal of redundant checks when generating code.
  38
  39 class StaticType {
  40  public:
  41   enum Kind {
  42     UNKNOWN,
  43     LIKELY_SMI
  44   };
  45
  46   StaticType() : kind_(UNKNOWN) {}
  47
  48   bool Is(Kind kind) const { return kind_ == kind; }
  49
  50   bool IsKnown() const { return !Is(UNKNOWN); }
  51   bool IsUnknown() const { return Is(UNKNOWN); }
  52   bool IsLikelySmi() const { return Is(LIKELY_SMI); }
  53
  54   void CopyFrom(StaticType* other) {
  55     kind_ = other->kind_;
  56   }
  57
  58   static const char* Type2String(StaticType* type);
  59
  60   // LIKELY_SMI accessors
  61   void SetAsLikelySmi() {
  62     kind_ = LIKELY_SMI;
  63   }
  64
  65   void SetAsLikelySmiIfUnknown() {
  66     if (IsUnknown()) {
  67       SetAsLikelySmi();
  68     }
  69   }
  70
  71  private:
  72   Kind kind_;
  73
  74   DISALLOW_COPY_AND_ASSIGN(StaticType);
  75 };
  76
  77
  78 // The AST refers to variables via VariableProxies - placeholders for the actual
  79 // variables. Variables themselves are never directly referred to from the AST,
  80 // they are maintained by scopes, and referred to from VariableProxies and Slots
  81 // after binding and variable allocation.
  82
  83 class Variable: public ZoneObject {
  84  public:
  85   enum Mode {
  86     // User declared variables:
  87     VAR,       // declared via 'var', and 'function' declarations
  88
  89     CONST,     // declared via 'const' declarations
  90
  91     // Variables introduced by the compiler:
  92     DYNAMIC,         // always require dynamic lookup (we don't know
  93                      // the declaration)
  94
  95     DYNAMIC_GLOBAL,  // requires dynamic lookup, but we know that the
  96                      // variable is global unless it has been shadowed
  97                      // by an eval-introduced variable
  98
  99     DYNAMIC_LOCAL,   // requires dynamic lookup, but we know that the
 100                      // variable is local and where it is unless it
 101                      // has been shadowed by an eval-introduced
 102                      // variable
 103
 104     INTERNAL,        // like VAR, but not user-visible (may or may not
 105                      // be in a context)
 106
 107     TEMPORARY        // temporary variables (not user-visible), never
 108                      // in a context
 109   };
 110
 111   enum Kind {
 112     NORMAL,
 113     THIS,
 114     ARGUMENTS
 115   };
 116
 117   Variable(Scope* scope,
 118            Handle<String> name,
 119            Mode mode,
 120            bool is_valid_lhs,
 121            Kind kind);
 122
 123   // Printing support
 124   static const char* Mode2String(Mode mode);
 125
 126   // Type testing & conversion
 127   Property* AsProperty();
 128   Variable* AsVariable();
 129   bool IsValidLeftHandSide() { return is_valid_LHS_; }
 130
 131   // The source code for an eval() call may refer to a variable that is
 132   // in an outer scope about which we don't know anything (it may not
 133   // be the global scope). scope() is NULL in that case. Currently the
 134   // scope is only used to follow the context chain length.
 135   Scope* scope() const  { return scope_; }
 136
 137   Handle<String> name() const  { return name_; }
 138   Mode mode() const  { return mode_; }
 139   bool is_accessed_from_inner_scope() const  {
 140     return is_accessed_from_inner_scope_;
 141   }
 142   bool is_used() { return is_used_; }
 143   void set_is_used(bool flag) { is_used_ = flag; }
 144
 145   bool IsVariable(Handle<String> n) const {
 146     return !is_this() && name().is_identical_to(n);
 147   }
 148
 149   bool IsStackAllocated() const;
 150
 151   bool is_dynamic() const {
 152     return (mode_ == DYNAMIC ||
 153             mode_ == DYNAMIC_GLOBAL ||
 154             mode_ == DYNAMIC_LOCAL);
 155   }
 156
 157   bool is_global() const;
 158   bool is_this() const { return kind_ == THIS; }
 159   bool is_arguments() const { return kind_ == ARGUMENTS; }
 160
 161   // True if the variable is named eval and not known to be shadowed.
 162   bool is_possibly_eval() const {
 163     return IsVariable(Factory::eval_symbol()) &&
 164         (mode_ == DYNAMIC || mode_ == DYNAMIC_GLOBAL);
 165   }
 166
 167   Variable* local_if_not_shadowed() const {
 168     ASSERT(mode_ == DYNAMIC_LOCAL && local_if_not_shadowed_ != NULL);
 169     return local_if_not_shadowed_;
 170   }
 171
 172   void set_local_if_not_shadowed(Variable* local) {
 173     local_if_not_shadowed_ = local;
 174   }
 175
 176   Expression* rewrite() const  { return rewrite_; }
 177   Slot* slot() const;
 178
 179   StaticType* type() { return &type_; }
 180
 181  private:
 182   Scope* scope_;
 183   Handle<String> name_;
 184   Mode mode_;
 185   bool is_valid_LHS_;
 186   Kind kind_;
 187
 188   Variable* local_if_not_shadowed_;
 189
 190   // Usage info.
 191   bool is_accessed_from_inner_scope_;  // set by variable resolver
 192   bool is_used_;
 193
 194   // Static type information
 195   StaticType type_;
 196
 197   // Code generation.
 198   // rewrite_ is usually a Slot or a Property, but may be any expression.
 199   Expression* rewrite_;
 200
 201   friend class Scope;  // Has explicit access to rewrite_.
 202 };
 203
 204
 205 } }  // namespace v8::internal
 206
 207 #endif  // V8_VARIABLES_H_