2009-12-08 Carol Szabo <carol.szabo@nokia.com>
[WebKit-https.git] / WebCore / rendering / RenderCounter.cpp
1 /**
2  * Copyright (C) 2004 Allan Sandfeld Jensen (kde@carewolf.com)
3  * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
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 #include "config.h"
23 #include "RenderCounter.h"
24
25 #include "CounterNode.h"
26 #include "Document.h"
27 #include "HTMLNames.h"
28 #include "HTMLOListElement.h"
29 #include "RenderListItem.h"
30 #include "RenderListMarker.h"
31 #include "RenderStyle.h"
32 #include <wtf/StdLibExtras.h>
33
34 namespace WebCore {
35
36 using namespace HTMLNames;
37
38 typedef HashMap<RefPtr<AtomicStringImpl>, CounterNode*> CounterMap;
39 typedef HashMap<const RenderObject*, CounterMap*> CounterMaps;
40
41 static CounterNode* makeCounterNode(RenderObject*, const AtomicString& counterName, bool alwaysCreateCounter);
42
43 static CounterMaps& counterMaps()
44 {
45     DEFINE_STATIC_LOCAL(CounterMaps, staticCounterMaps, ());
46     return staticCounterMaps;
47 }
48
49 static inline RenderObject* previousSiblingOrParent(RenderObject* object)
50 {
51     if (RenderObject* sibling = object->previousSibling())
52         return sibling;
53     return object->parent();
54 }
55
56 static bool planCounter(RenderObject* object, const AtomicString& counterName, bool& isReset, int& value)
57 {
58     ASSERT(object);
59
60     // Real text nodes don't have their own style so they can't have counters.
61     // We can't even look at their styles or we'll see extra resets and increments!
62     if (object->isText() && !object->isBR())
63         return false;
64
65     RenderStyle* style = object->style();
66     ASSERT(style);
67
68     if (const CounterDirectiveMap* directivesMap = style->counterDirectives()) {
69         CounterDirectives directives = directivesMap->get(counterName.impl());
70         if (directives.m_reset) {
71             value = directives.m_resetValue;
72             if (directives.m_increment)
73                 value += directives.m_incrementValue;
74             isReset = true;
75             return true;
76         }
77         if (directives.m_increment) {
78             value = directives.m_incrementValue;
79             isReset = false;
80             return true;
81         }
82     }
83
84     if (counterName == "list-item") {
85         if (object->isListItem()) {
86             if (toRenderListItem(object)->hasExplicitValue()) {
87                 value = toRenderListItem(object)->explicitValue();
88                 isReset = true;
89                 return true;
90             }
91             value = 1;
92             isReset = false;
93             return true;
94         }
95         if (Node* e = object->node()) {
96             if (e->hasTagName(olTag)) {
97                 value = static_cast<HTMLOListElement*>(e)->start();
98                 isReset = true;
99                 return true;
100             }
101             if (e->hasTagName(ulTag) || e->hasTagName(menuTag) || e->hasTagName(dirTag)) {
102                 value = 0;
103                 isReset = true;
104                 return true;
105             }
106         }
107     }
108
109     return false;
110 }
111
112 // - Finds the insertion point for the counter described by counterOwner, isReset and 
113 // identifier in the CounterNode tree for identifier and sets parent and
114 // previousSibling accordingly.
115 // - The function returns true if the counter whose insertion point is searched is NOT
116 // the root of the tree.
117 // - The root of the tree is a counter reference that is not in the scope of any other
118 // counter with the same identifier.
119 // - All the counter references with the same identifier as this one that are in
120 // children or subsequent siblings of the renderer that owns the root of the tree
121 // form the rest of of the nodes of the tree.
122 // - The root of the tree is always a reset type reference.
123 // - A subtree rooted at any reset node in the tree is equivalent to all counter 
124 // references that are in the scope of the counter or nested counter defined by that
125 // reset node.
126 // - Non-reset CounterNodes cannot have descendants.
127
128 static bool findPlaceForCounter(RenderObject* counterOwner, const AtomicString& identifier, bool isReset, CounterNode*& parent, CounterNode*& previousSibling)
129 {
130     // We cannot stop searching for counters with the same identifier before we also
131     // check this renderer, because it may affect the positioning in the tree of our counter.
132     RenderObject* searchEndRenderer = previousSiblingOrParent(counterOwner);
133     // We check renderers in preOrder from the renderer that our counter is attached to
134     // towards the begining of the document for counters with the same identifier as the one
135     // we are trying to find a place for. This is the next renderer to be checked.
136     RenderObject* currentRenderer = counterOwner->previousInPreOrder();
137     previousSibling = 0;
138     while (currentRenderer) {
139         CounterNode* currentCounter = makeCounterNode(currentRenderer, identifier, false);
140         if (searchEndRenderer == currentRenderer) {
141             // We may be at the end of our search.
142             if (currentCounter) {
143                 // We have a suitable counter on the EndSearchRenderer.
144                 if (previousSibling) { // But we already found another counter that we come after.
145                     if (currentCounter->isReset()) {
146                         // We found a reset counter that is on a renderer that is a sibling of ours or a parent.
147                         if (isReset && currentRenderer->parent() == counterOwner->parent()) {
148                             // We are also a reset counter and the previous reset was on a sibling renderer
149                             // hence we are the next sibling of that counter if that reset is not a root or
150                             // we are a root node if that reset is a root.
151                             parent = currentCounter->parent();
152                             previousSibling = parent ? currentCounter : 0;
153                             return parent;
154                         }
155                         // We are not a reset node or the previous reset must be on an ancestor of our renderer
156                         // hence we must be a child of that reset counter.
157                         parent = currentCounter;
158                         ASSERT(previousSibling->parent() == currentCounter);
159                         return true;
160                     }
161                     // CurrentCounter, the counter at the EndSearchRenderer, is not reset.
162                     if (!isReset || currentRenderer->parent() != counterOwner->parent()) {
163                         // If the node we are placing is not reset or we have found a counter that is attached
164                         // to an ancestor of the placed counter's renderer we know we are a sibling of that node.
165                         ASSERT(currentCounter->parent() == previousSibling->parent());
166                         parent = currentCounter->parent();
167                         return true;
168                     }
169                 } else { 
170                     // We are at the potential end of the search, but we had no previous sibling candidate
171                     // In this case we follow pretty much the same logic as above but no ASSERTs about 
172                     // previousSibling, and when we are a sibling of the end counter we must set previousSibling
173                     // to currentCounter.
174                     if (currentCounter->isReset()) {
175                         if (isReset && currentRenderer->parent() == counterOwner->parent()) {
176                             parent = currentCounter->parent();
177                             previousSibling = currentCounter;
178                             return parent;
179                         }
180                         parent = currentCounter;
181                         return true;
182                     }
183                     if (!isReset || currentRenderer->parent() != counterOwner->parent()) {
184                         parent = currentCounter->parent();
185                         previousSibling = currentCounter;
186                         return true;
187                     }
188                     previousSibling = currentCounter;
189                 }
190             }
191             // We come here if the previous sibling or parent of our renderer had no 
192             // good counter, or we are a reset node and the counter on the previous sibling
193             // of our renderer was not a reset counter.
194             // Set a new goal for the end of the search.
195             searchEndRenderer = previousSiblingOrParent(currentRenderer);
196         } else {
197             // We are searching descendants of a previous sibling of the renderer that the
198             // counter being placed is attached to.
199             if (currentCounter) {
200                 // We found a suitable counter.
201                 if (previousSibling) {
202                     // Since we had a suitable previous counter before, we should only consider this one as our 
203                     // previousSibling if it is a reset counter and hence the current previousSibling is its child.
204                     if (currentCounter->isReset()) {
205                         previousSibling = currentCounter;
206                         // We are no longer interested in previous siblings of the currentRenderer or their children
207                         // as counters they may have attached cannot be the previous sibling of the counter we are placing.
208                         currentRenderer = currentRenderer->parent();
209                         continue;
210                     }
211                 } else
212                     previousSibling = currentCounter;
213                 currentRenderer = previousSiblingOrParent(currentRenderer);
214                 continue;
215             }
216         }
217         // This function is designed so that the same test is not done twice in an iteration, except for this one
218         // which may be done twice in some cases. Rearranging the decision points though, to accommodate this 
219         // performance improvement would create more code duplication than is worthwhile in my oppinion and may further
220         // impede the readability of this already complex algorithm.
221         if (previousSibling)
222             currentRenderer = previousSiblingOrParent(currentRenderer);
223         else
224             currentRenderer = currentRenderer->previousInPreOrder();
225     }
226     return false;
227 }
228
229 static CounterNode* makeCounterNode(RenderObject* object, const AtomicString& counterName, bool alwaysCreateCounter)
230 {
231     ASSERT(object);
232
233     if (object->m_hasCounterNodeMap)
234         if (CounterMap* nodeMap = counterMaps().get(object))
235             if (CounterNode* node = nodeMap->get(counterName.impl()))
236                 return node;
237
238     bool isReset = false;
239     int value = 0;
240     if (!planCounter(object, counterName, isReset, value) && !alwaysCreateCounter)
241         return 0;
242
243     CounterNode* newParent = 0;
244     CounterNode* newPreviousSibling = 0;
245     CounterNode* newNode;
246     if (findPlaceForCounter(object, counterName, isReset, newParent, newPreviousSibling)) {
247         newNode = new CounterNode(object, isReset, value);
248         newParent->insertAfter(newNode, newPreviousSibling, counterName);
249     } else {
250         // Make a reset node for counters that aren't inside an existing reset node.
251         newNode = new CounterNode(object, true, value);
252     }
253
254     CounterMap* nodeMap;
255     if (object->m_hasCounterNodeMap)
256         nodeMap = counterMaps().get(object);
257     else {
258         nodeMap = new CounterMap;
259         counterMaps().set(object, nodeMap);
260         object->m_hasCounterNodeMap = true;
261     }
262     nodeMap->set(counterName.impl(), newNode);
263
264     return newNode;
265 }
266
267 RenderCounter::RenderCounter(Document* node, const CounterContent& counter)
268     : RenderText(node, StringImpl::empty())
269     , m_counter(counter)
270     , m_counterNode(0)
271 {
272 }
273
274 const char* RenderCounter::renderName() const
275 {
276     return "RenderCounter";
277 }
278
279 bool RenderCounter::isCounter() const
280 {
281     return true;
282 }
283
284 PassRefPtr<StringImpl> RenderCounter::originalText() const
285 {
286     if (!parent())
287         return 0;
288
289     if (!m_counterNode)
290         m_counterNode = makeCounterNode(parent(), m_counter.identifier(), true);
291
292     CounterNode* child = m_counterNode;
293     int value = child->isReset() ? child->value() : child->countInParent();
294
295     String text = listMarkerText(m_counter.listStyle(), value);
296
297     if (!m_counter.separator().isNull()) {
298         if (!child->isReset())
299             child = child->parent();
300         while (CounterNode* parent = child->parent()) {
301             text = listMarkerText(m_counter.listStyle(), child->countInParent())
302                 + m_counter.separator() + text;
303             child = parent;
304         }
305     }
306
307     return text.impl();
308 }
309
310 void RenderCounter::calcPrefWidths(int lead)
311 {
312     setTextInternal(originalText());
313     RenderText::calcPrefWidths(lead);
314 }
315
316 void RenderCounter::invalidate(const AtomicString& identifier)
317 {
318     if (m_counter.identifier() != identifier)
319         return;
320     m_counterNode = 0;
321     setNeedsLayoutAndPrefWidthsRecalc();
322 }
323
324 static void destroyCounterNodeChildren(const AtomicString& identifier, CounterNode* node)
325 {
326     CounterNode* previous;
327     for (CounterNode* child = node->lastDescendant(); child && child != node; child = previous) {
328         previous = child->previousInPreOrder();
329         child->parent()->removeChild(child, identifier);
330         ASSERT(counterMaps().get(child->renderer())->get(identifier.impl()) == child);
331         counterMaps().get(child->renderer())->remove(identifier.impl());
332         if (!child->renderer()->documentBeingDestroyed()) {
333             RenderObjectChildList* children = child->renderer()->virtualChildren();
334             if (children)
335                 children->invalidateCounters(child->renderer(), identifier);
336         }
337         delete child;
338     }
339 }
340
341 void RenderCounter::destroyCounterNodes(RenderObject* object)
342 {
343     CounterMaps& maps = counterMaps();
344     CounterMap* map = maps.get(object);
345     if (!map)
346         return;
347     maps.remove(object);
348
349     CounterMap::const_iterator end = map->end();
350     for (CounterMap::const_iterator it = map->begin(); it != end; ++it) {
351         CounterNode* node = it->second;
352         AtomicString identifier(it->first.get());
353         destroyCounterNodeChildren(identifier, node);
354         if (CounterNode* parent = node->parent())
355             parent->removeChild(node, identifier);
356         delete node;
357     }
358
359     delete map;
360 }
361
362 } // namespace WebCore