src/func-name-inferrer.h

   1 // Copyright 2006-2009 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_FUNC_NAME_INFERRER_H_
  29 #define V8_FUNC_NAME_INFERRER_H_
  30
  31 namespace v8 { namespace internal {
  32
  33 // FuncNameInferrer is a stateful class that is used to perform name
  34 // inference for anonymous functions during static analysis of source code.
  35 // Inference is performed in cases when an anonymous function is assigned
  36 // to a variable or a property (see test-func-name-inference.cc for examples.)
  37
  38 // The basic idea is that during AST traversal LHSs of expressions are
  39 // always visited before RHSs. Thus, during visiting the LHS, a name can be
  40 // collected, and during visiting the RHS, a function literal can be collected.
  41 // Inference is performed while leaving the assignment node.
  42
  43 class FuncNameInferrer BASE_EMBEDDED {
  44  public:
  45   FuncNameInferrer() :
  46       entries_stack_(10),
  47       names_stack_(5),
  48       func_to_infer_(NULL),
  49       dot_(Factory::NewStringFromAscii(CStrVector("."))) {
  50   }
  51
  52   bool IsOpen() const { return !entries_stack_.is_empty(); }
  53
  54   void PushEnclosingName(Handle<String> name);
  55
  56   void Enter() {
  57     entries_stack_.Add(names_stack_.length());
  58   }
  59
  60   void Leave() {
  61     ASSERT(IsOpen());
  62     names_stack_.Rewind(entries_stack_.RemoveLast());
  63   }
  64
  65   void PushName(Handle<String> name) {
  66     if (IsOpen()) {
  67       names_stack_.Add(name);
  68     }
  69   }
  70
  71   void SetFuncToInfer(FunctionLiteral* func_to_infer) {
  72     if (IsOpen()) {
  73       // If we encounter another function literal after already having
  74       // encountered one, the second one replaces the first.
  75       func_to_infer_ = func_to_infer;
  76     }
  77   }
  78
  79   void InferAndLeave() {
  80     ASSERT(IsOpen());
  81     MaybeInferFunctionName();
  82     Leave();
  83   }
  84
  85  private:
  86   Handle<String> MakeNameFromStack();
  87   Handle<String> MakeNameFromStackHelper(int pos, Handle<String> prev);
  88   void MaybeInferFunctionName();
  89
  90   List<int> entries_stack_;
  91   List<Handle<String> > names_stack_;
  92   FunctionLiteral* func_to_infer_;
  93   Handle<String> dot_;
  94
  95   DISALLOW_COPY_AND_ASSIGN(FuncNameInferrer);
  96 };
  97
  98
  99 // A wrapper class that automatically calls InferAndLeave when
 100 // leaving scope.
 101 class ScopedFuncNameInferrer BASE_EMBEDDED {
 102  public:
 103   explicit ScopedFuncNameInferrer(FuncNameInferrer* inferrer) :
 104       inferrer_(inferrer),
 105       is_entered_(false) {}
 106   ~ScopedFuncNameInferrer() {
 107     if (is_entered_) {
 108       inferrer_->InferAndLeave();
 109     }
 110   }
 111
 112   void Enter() {
 113     inferrer_->Enter();
 114     is_entered_ = true;
 115   }
 116
 117  private:
 118   FuncNameInferrer* inferrer_;
 119   bool is_entered_;
 120
 121   DISALLOW_COPY_AND_ASSIGN(ScopedFuncNameInferrer);
 122 };
 123
 124
 125 } }  // namespace v8::internal
 126
 127 #endif  // V8_FUNC_NAME_INFERRER_H_