Avoid heap allocating the root scope chain node for eval and closure free functions
[WebKit.git] / JavaScriptCore / kjs / scope_chain.h
1 /*
2  *  This file is part of the KDE libraries
3  *  Copyright (C) 2003 Apple Computer, Inc.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Library General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Library General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Library General Public License
16  *  along with this library; see the file COPYING.LIB.  If not, write to
17  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  *  Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #ifndef KJS_SCOPE_CHAIN_H
23 #define KJS_SCOPE_CHAIN_H
24
25 #include <wtf/Assertions.h>
26
27 namespace KJS {
28
29     class JSObject;
30     class ExecState;
31     
32     class ScopeChainNode {
33     public:
34         ScopeChainNode(ScopeChainNode *n, JSObject *o)
35             : next(n), object(o), refCount(1) { }
36
37         ScopeChainNode *next;
38         JSObject *object;
39         int refCount;
40     };
41
42     class ScopeChainIterator {
43     public:
44         ScopeChainIterator(ScopeChainNode *node) : m_node(node) {}
45
46         JSObject * const & operator*() const { return m_node->object; }
47         JSObject * const * operator->() const { return &(operator*()); }
48     
49         ScopeChainIterator& operator++() { m_node = m_node->next; return *this; }
50
51         // postfix ++ intentionally omitted
52
53         bool operator==(const ScopeChainIterator& other) const { return m_node == other.m_node; }
54         bool operator!=(const ScopeChainIterator& other) const { return m_node != other.m_node; }
55
56     private:
57         ScopeChainNode *m_node;
58     };
59
60     class ScopeChain {
61     public:
62         typedef ScopeChainIterator const_iterator;
63         typedef JSObject* ValueType;
64
65         ScopeChain() : _node(0) { }
66         ~ScopeChain() { deref(); }
67
68         ScopeChain(const ScopeChain& c)
69             : _node(c._node)
70         {
71             if (_node)
72                 ++_node->refCount;
73         }
74
75         ScopeChain(JSObject* o)
76             : _node(new ScopeChainNode(0, o))
77         {
78         }
79
80         ScopeChain &operator=(const ScopeChain &);
81
82         bool isEmpty() const { return !_node; }
83         JSObject *top() const { return _node->object; }
84
85         JSObject *bottom() const;
86
87         ScopeChainIterator begin() const { return ScopeChainIterator(_node); }
88         ScopeChainIterator end() const { return ScopeChainIterator(0); }
89
90         void clear() { deref(); _node = 0; }
91         void push(JSObject *);
92         void push(const ScopeChain &);
93         void push(ScopeChainNode*);
94         void replaceTop(JSObject*);
95         void pop();
96         
97         void mark();
98
99 #ifndef NDEBUG        
100         void print();
101 #endif
102         
103     private:
104         ScopeChainNode *_node;
105         
106         void deref() { if (_node && --_node->refCount == 0) release(); }
107         void ref() const;
108         
109         void release();
110     };
111
112 inline void ScopeChain::ref() const
113 {
114     for (ScopeChainNode *n = _node; n; n = n->next) {
115         if (n->refCount++ != 0)
116             break;
117     }
118 }
119
120 inline ScopeChain &ScopeChain::operator=(const ScopeChain &c)
121 {
122     c.ref();
123     deref();
124     _node = c._node;
125     return *this;
126 }
127
128 inline JSObject *ScopeChain::bottom() const
129 {
130     ScopeChainNode *last = 0;
131     for (ScopeChainNode *n = _node; n; n = n->next)
132         last = n;
133     if (!last)
134         return 0;
135     return last->object;
136 }
137
138 inline void ScopeChain::push(JSObject *o)
139 {
140     ASSERT(o);
141     _node = new ScopeChainNode(_node, o);
142 }
143
144 inline void ScopeChain::push(ScopeChainNode *node)
145 {
146     ASSERT(node);
147     ASSERT(node->object);
148     node->refCount++;
149     node->next = _node;
150     _node = node;
151 }
152
153 inline void ScopeChain::replaceTop(JSObject* o)
154 {
155     ASSERT(o);
156     _node->object = o;
157 }
158
159 inline void ScopeChain::pop()
160 {
161     ScopeChainNode *oldNode = _node;
162     ASSERT(oldNode);
163     ScopeChainNode *newNode = oldNode->next;
164     _node = newNode;
165     
166     if (--oldNode->refCount != 0) {
167         if (newNode)
168             ++newNode->refCount;
169     } else {
170         delete oldNode;
171     }
172 }
173
174 } // namespace KJS
175
176 #endif // KJS_SCOPE_CHAIN_H