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 class FuncNameInferrer BASE_EMBEDDED {
  43  public:
  44   FuncNameInferrer()
  45       : entries_stack_(10),
  46         names_stack_(5),
  47         funcs_to_infer_(4),
  48         dot_(Factory::NewStringFromAscii(CStrVector("."))) {
  49   }
  50
  51   // Returns whether we have entered name collection state.
  52   bool IsOpen() const { return !entries_stack_.is_empty(); }
  53
  54   // Pushes an enclosing the name of enclosing function onto names stack.
  55   void PushEnclosingName(Handle<String> name);
  56
  57   // Enters name collection state.
  58   void Enter() {
  59     entries_stack_.Add(names_stack_.length());
  60   }
  61
  62   // Pushes an encountered name onto names stack when in collection state.
  63   void PushName(Handle<String> name) {
  64     if (IsOpen()) {
  65       names_stack_.Add(name);
  66     }
  67   }
  68
  69   // Adds a function to infer name for.
  70   void AddFunction(FunctionLiteral* func_to_infer) {
  71     if (IsOpen()) {
  72       funcs_to_infer_.Add(func_to_infer);
  73     }
  74   }
  75
  76   // Infers a function name and leaves names collection state.
  77   void InferAndLeave() {
  78     ASSERT(IsOpen());
  79     if (!funcs_to_infer_.is_empty()) {
  80       InferFunctionsNames();
  81     }
  82     names_stack_.Rewind(entries_stack_.RemoveLast());
  83   }
  84
  85  private:
  86   // Constructs a full name in dotted notation from gathered names.
  87   Handle<String> MakeNameFromStack();
  88
  89   // A helper function for MakeNameFromStack.
  90   Handle<String> MakeNameFromStackHelper(int pos, Handle<String> prev);
  91
  92   // Performs name inferring for added functions.
  93   void InferFunctionsNames();
  94
  95   ZoneList<int> entries_stack_;
  96   ZoneList<Handle<String> > names_stack_;
  97   ZoneList<FunctionLiteral*> funcs_to_infer_;
  98   Handle<String> dot_;
  99
 100   DISALLOW_COPY_AND_ASSIGN(FuncNameInferrer);
 101 };
 102
 103
 104 // A wrapper class that automatically calls InferAndLeave when
 105 // leaving scope.
 106 class ScopedFuncNameInferrer BASE_EMBEDDED {
 107  public:
 108   explicit ScopedFuncNameInferrer(FuncNameInferrer* inferrer)
 109       : inferrer_(inferrer),
 110         is_entered_(false) {}
 111
 112   ~ScopedFuncNameInferrer() {
 113     if (is_entered_) {
 114       inferrer_->InferAndLeave();
 115     }
 116   }
 117
 118   // Triggers the wrapped inferrer into name collection state.
 119   void Enter() {
 120     inferrer_->Enter();
 121     is_entered_ = true;
 122   }
 123
 124  private:
 125   FuncNameInferrer* inferrer_;
 126   bool is_entered_;
 127
 128   DISALLOW_COPY_AND_ASSIGN(ScopedFuncNameInferrer);
 129 };
 130
 131
 132 } }  // namespace v8::internal
 133
 134 #endif  // V8_FUNC_NAME_INFERRER_H_