02cb0b0a71854eaf54be074ed6554be3b50f96f7
[WebKit-https.git] / WebCore / kwq / KWQRenderTreeDebug.cpp
1 /*
2  * Copyright (C) 2003 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "KWQRenderTreeDebug.h"
27
28 #include "dom_docimpl.h"
29 #include "dom_position.h"
30 #include "htmltags.h"
31 #include "jsediting.h"
32 #include "khtmlview.h"
33 #include "render_canvas.h"
34 #include "render_replaced.h"
35 #include "render_table.h"
36 #include "render_text.h"
37 #include "render_br.h"
38 #include "selection.h"
39
40 #include "KWQKHTMLPart.h"
41 #include "KWQTextStream.h"
42
43 using DOM::DocumentImpl;
44 using DOM::JSEditor;
45 using DOM::NodeImpl;
46 using DOM::Position;
47
48 using khtml::BorderValue;
49 using khtml::EBorderStyle;
50 using khtml::InlineTextBox;
51 using khtml::RenderLayer;
52 using khtml::RenderObject;
53 using khtml::RenderTableCell;
54 using khtml::RenderWidget;
55 using khtml::RenderText;
56 using khtml::RenderCanvas;
57 using khtml::RenderBR;
58 using khtml::Selection;
59 using khtml::transparentColor;
60
61 static void writeLayers(QTextStream &ts, const RenderLayer* rootLayer, RenderLayer* l,
62                         const QRect& paintDirtyRect, int indent=0);
63
64 static QTextStream &operator<<(QTextStream &ts, const QRect &r)
65 {
66     return ts << "at (" << r.x() << "," << r.y() << ") size " << r.width() << "x" << r.height();
67 }
68
69 static void writeIndent(QTextStream &ts, int indent)
70 {
71     for (int i = 0; i != indent; ++i) {
72         ts << "  ";
73     }
74 }
75
76 static void printBorderStyle(QTextStream &ts, const RenderObject &o, const EBorderStyle borderStyle)
77 {
78     switch (borderStyle) {
79         case khtml::BNONE:
80             ts << "none";
81             break;
82         case khtml::BHIDDEN:
83             ts << "hidden";
84             break;
85         case khtml::INSET:
86             ts << "inset";
87             break;
88         case khtml::GROOVE:
89             ts << "groove";
90             break;
91         case khtml::RIDGE:
92             ts << "ridge";
93             break;
94         case khtml::OUTSET:
95             ts << "outset";
96             break;
97         case khtml::DOTTED:
98             ts << "dotted";
99             break;
100         case khtml::DASHED:
101             ts << "dashed";
102             break;
103         case khtml::SOLID:
104             ts << "solid";
105             break;
106         case khtml::DOUBLE:
107             ts << "double";
108             break;
109     }
110     
111     ts << " ";
112 }
113
114 static QTextStream &operator<<(QTextStream &ts, const RenderObject &o)
115 {
116     ts << o.renderName();
117     
118     if (o.style() && o.style()->zIndex()) {
119         ts << " zI: " << o.style()->zIndex();
120     }
121     
122     if (o.element()) {
123         QString tagName(getTagName(o.element()->id()).string());
124         if (!tagName.isEmpty()) {
125             ts << " {" << tagName << "}";
126         }
127     }
128     
129     // FIXME: Will remove this <br> code once all layout tests pass.  Until then, we can't really change
130     // all the results easily.
131     bool usePositions = true;
132     if (o.isBR()) {
133         const RenderBR* br = static_cast<const RenderBR*>(&o);
134         usePositions = (br->firstTextBox() && br->firstTextBox()->isText());
135     }
136     QRect r(usePositions ? o.xPos() : 0, usePositions ? o.yPos() : 0, o.width(), o.height());
137     ts << " " << r;
138     
139     if (!o.isText()) {
140         if (o.parent() && (o.parent()->style()->color() != o.style()->color()))
141             ts << " [color=" << o.style()->color().name() << "]";
142         if (o.parent() && (o.parent()->style()->backgroundColor() != o.style()->backgroundColor()) &&
143             o.style()->backgroundColor().isValid() && 
144             o.style()->backgroundColor().rgb() != khtml::transparentColor)
145             // Do not dump invalid or transparent backgrounds, since that is the default.
146             ts << " [bgcolor=" << o.style()->backgroundColor().name() << "]";
147     
148         if (o.borderTop() || o.borderRight() || o.borderBottom() || o.borderLeft()) {
149             ts << " [border:";
150             
151             BorderValue prevBorder;
152             if (o.style()->borderTop() != prevBorder) {
153                 prevBorder = o.style()->borderTop();
154                 if (!o.borderTop())
155                     ts << " none";
156                 else {
157                     ts << " (" << o.borderTop() << "px ";
158                     printBorderStyle(ts, o, o.style()->borderTopStyle());
159                     QColor col = o.style()->borderTopColor();
160                     if (!col.isValid()) col = o.style()->color();
161                     ts << col.name() << ")";
162                 }
163             }
164             
165             if (o.style()->borderRight() != prevBorder) {
166                 prevBorder = o.style()->borderRight();
167                 if (!o.borderRight())
168                     ts << " none";
169                 else {
170                     ts << " (" << o.borderRight() << "px ";
171                     printBorderStyle(ts, o, o.style()->borderRightStyle());
172                     QColor col = o.style()->borderRightColor();
173                     if (!col.isValid()) col = o.style()->color();
174                     ts << col.name() << ")";
175                 }
176             }
177             
178             if (o.style()->borderBottom() != prevBorder) {
179                 prevBorder = o.style()->borderBottom();
180                 if (!o.borderBottom())
181                     ts << " none";
182                 else {
183                     ts << " (" << o.borderBottom() << "px ";
184                     printBorderStyle(ts, o, o.style()->borderBottomStyle());
185                     QColor col = o.style()->borderBottomColor();
186                     if (!col.isValid()) col = o.style()->color();
187                     ts << col.name() << ")";
188                 }
189             }
190             
191             if (o.style()->borderLeft() != prevBorder) {
192                 prevBorder = o.style()->borderLeft();
193                 if (!o.borderLeft())
194                     ts << " none";
195                 else {                    
196                     ts << " (" << o.borderLeft() << "px ";
197                     printBorderStyle(ts, o, o.style()->borderLeftStyle());
198                     QColor col = o.style()->borderLeftColor();
199                     if (!col.isValid()) col = o.style()->color();
200                     ts << col.name() << ")";
201                 }
202             }
203             
204             ts << "]";
205         }
206     }
207     
208     if (o.isTableCell()) {
209         const RenderTableCell &c = static_cast<const RenderTableCell &>(o);
210         ts << " [r=" << c.row() << " c=" << c.col() << " rs=" << c.rowSpan() << " cs=" << c.colSpan() << "]";
211     }
212
213     return ts;
214 }
215
216 static QString quoteAndEscapeNonPrintables(const QString &s)
217 {
218     QString result;
219     result += '"';
220     for (uint i = 0; i != s.length(); ++i) {
221         QChar c = s.at(i);
222         if (c == '\\') {
223             result += "\\\\";
224         } else if (c == '"') {
225             result += "\\\"";
226         } else if (c == '\n' || c.unicode() == 0x00A0) {
227             result += ' ';
228         } else {
229             ushort u = c.unicode();
230             if (u >= 0x20 && u < 0x7F) {
231                 result += c;
232             } else {
233                 QString hex;
234                 hex.sprintf("\\x{%X}", u);
235                 result += hex;
236             }
237         }
238     }
239     result += '"';
240     return result;
241 }
242
243 static void writeTextRun(QTextStream &ts, const RenderText &o, const InlineTextBox &run)
244 {
245     ts << "text run at (" << run.m_x << "," << run.m_y << ") width " << run.m_width << ": "
246         << quoteAndEscapeNonPrintables(o.data().string().mid(run.m_start, run.m_len))
247         << "\n"; 
248 }
249
250 static void write(QTextStream &ts, const RenderObject &o, int indent = 0)
251 {
252     writeIndent(ts, indent);
253     
254     ts << o << "\n";
255     
256     if (o.isText() && !o.isBR()) {
257         const RenderText &text = static_cast<const RenderText &>(o);
258         for (InlineTextBox* box = text.firstTextBox(); box; box = box->nextTextBox()) {
259             writeIndent(ts, indent+1);
260             writeTextRun(ts, text, *box);
261         }
262     }
263
264     for (RenderObject *child = o.firstChild(); child; child = child->nextSibling()) {
265         if (child->layer()) {
266             continue;
267         }
268         write(ts, *child, indent + 1);
269     }
270     
271     if (o.isWidget()) {
272         QWidget *widget = static_cast<const RenderWidget &>(o).widget();
273         if (widget && widget->inherits("KHTMLView")) {
274             KHTMLView *view = static_cast<KHTMLView *>(widget);
275             RenderObject *root = KWQ(view->part())->renderer();
276             if (root) {
277                 view->layout();
278                 RenderLayer* l = root->layer();
279                 if (l)
280                     writeLayers(ts, l, l, QRect(l->xPos(), l->yPos(), l->width(), l->height()), indent+1);
281             }
282         }
283     }
284 }
285
286 static void write(QTextStream &ts, RenderLayer &l,
287                   const QRect& layerBounds, const QRect& backgroundClipRect, const QRect& clipRect,
288                   int layerType = 0, int indent = 0)
289 {
290     writeIndent(ts, indent);
291     
292     ts << "layer";
293     ts << " " << layerBounds;
294
295     if (layerBounds != layerBounds.intersect(backgroundClipRect))
296         ts << " backgroundClip " << backgroundClipRect;
297     if (layerBounds != layerBounds.intersect(clipRect))
298         ts << " clip " << clipRect;
299
300     if (l.renderer()->hasOverflowClip()) {
301         if (l.scrollXOffset())
302             ts << " scrollX " << l.scrollXOffset();
303         if (l.scrollYOffset())
304             ts << " scrollY " << l.scrollYOffset();
305         if (l.renderer()->clientWidth() != l.scrollWidth())
306             ts << " scrollWidth " << l.scrollWidth();
307         if (l.renderer()->clientHeight() != l.scrollHeight())
308             ts << " scrollHeight " << l.scrollHeight();
309     }
310
311     if (layerType == -1)
312         ts << " layerType: background only";
313     else if (layerType == 1)
314         ts << " layerType: foreground only";
315     
316     ts << "\n";
317
318     if (layerType != -1)
319         write(ts, *l.renderer(), indent + 1);
320 }
321     
322 static void writeLayers(QTextStream &ts, const RenderLayer* rootLayer, RenderLayer* l,
323                         const QRect& paintDirtyRect, int indent)
324 {
325     // Calculate the clip rects we should use.
326     QRect layerBounds, damageRect, clipRectToApply;
327     l->calculateRects(rootLayer, paintDirtyRect, layerBounds, damageRect, clipRectToApply);
328     
329     // Ensure our z-order lists are up-to-date.
330     l->updateZOrderLists();
331
332     bool shouldPaint = l->intersectsDamageRect(layerBounds, damageRect);
333     QPtrVector<RenderLayer>* negList = l->negZOrderList();
334     if (shouldPaint && negList && negList->count() > 0)
335         write(ts, *l, layerBounds, damageRect, clipRectToApply, -1, indent);
336
337     if (negList) {
338         for (unsigned i = 0; i != negList->count(); ++i)
339             writeLayers(ts, rootLayer, negList->at(i), paintDirtyRect, indent);
340     }
341
342     if (shouldPaint)
343         write(ts, *l, layerBounds, damageRect, clipRectToApply, negList && negList->count() > 0, indent);
344
345     QPtrVector<RenderLayer>* posList = l->posZOrderList();
346     if (posList) {
347         for (unsigned i = 0; i != posList->count(); ++i)
348             writeLayers(ts, rootLayer, posList->at(i), paintDirtyRect, indent);
349     }
350 }
351
352 static QString nodePositionRelativeToRoot(NodeImpl *node, NodeImpl *root)
353 {
354     QString result;
355
356     NodeImpl *n = node;
357     while (1) {
358         NodeImpl *p = n->parentNode();
359         if (!p || n == root) {
360             result += " of root {" + getTagName(n->id()).string() + "}";
361             break;
362         }
363         if (n != node)
364             result +=  " of ";
365         int count = 1;
366         for (NodeImpl *search = p->firstChild(); search != n; search = search->nextSibling())
367             count++;
368         result +=  "child " + QString::number(count) + " {" + getTagName(n->id()).string() + "}";
369         n = p;
370     }
371     
372     return result;
373 }
374
375 static void writeSelection(QTextStream &ts, const RenderObject *o)
376 {
377     NodeImpl *n = o->element();
378     if (!n || !n->isDocumentNode())
379         return;
380
381     DocumentImpl *doc = static_cast<DocumentImpl *>(n);
382     if (!doc->part())
383         return;
384     
385     Selection selection = doc->part()->selection();
386     if (selection.isNone())
387         return;
388
389     if (!selection.start().node()->isContentEditable() || !selection.end().node()->isContentEditable())
390         return;
391
392     Position startPosition = selection.start();
393     Position endPosition = selection.end();
394
395     QString startNodeTagName(getTagName(startPosition.node()->id()).string());
396     QString endNodeTagName(getTagName(endPosition.node()->id()).string());
397     
398     NodeImpl *rootNode = doc->getElementById("root");
399     
400     if (selection.isCaret()) {
401         Position upstream = startPosition.upstream(DOM::StayInBlock);
402         Position downstream = startPosition.downstream(DOM::StayInBlock);
403         QString positionString = nodePositionRelativeToRoot(startPosition.node(), rootNode);
404         QString upstreamString = nodePositionRelativeToRoot(upstream.node(), rootNode);
405         QString downstreamString = nodePositionRelativeToRoot(downstream.node(), rootNode);
406         ts << "selection is CARET:\n" << 
407             "start:      position " << startPosition.offset() << " of " << positionString << "\n"
408             "upstream:   position " << upstream.offset() << " of " << upstreamString << "\n"
409             "downstream: position " << downstream.offset() << " of " << downstreamString << "\n"; 
410     }
411     else if (selection.isRange()) {
412         QString startString = nodePositionRelativeToRoot(startPosition.node(), rootNode);
413         Position upstreamStart = startPosition.upstream(DOM::StayInBlock);
414         QString upstreamStartString = nodePositionRelativeToRoot(upstreamStart.node(), rootNode);
415         Position downstreamStart = startPosition.downstream(DOM::StayInBlock);
416         QString downstreamStartString = nodePositionRelativeToRoot(downstreamStart.node(), rootNode);
417         QString endString = nodePositionRelativeToRoot(endPosition.node(), rootNode);
418         Position upstreamEnd = endPosition.upstream(DOM::StayInBlock);
419         QString upstreamEndString = nodePositionRelativeToRoot(upstreamEnd.node(), rootNode);
420         Position downstreamEnd = endPosition.downstream(DOM::StayInBlock);
421         QString downstreamEndString = nodePositionRelativeToRoot(downstreamEnd.node(), rootNode);
422         ts << "selection is RANGE:\n" <<
423             "start:      position " << startPosition.offset() << " of " << startString << "\n" <<
424             "upstream:   position " << upstreamStart.offset() << " of " << upstreamStartString << "\n"
425             "downstream: position " << downstreamStart.offset() << " of " << downstreamStartString << "\n"
426             "end:        position " << endPosition.offset() << " of " << endString << "\n"
427             "upstream:   position " << upstreamEnd.offset() << " of " << upstreamEndString << "\n"
428             "downstream: position " << downstreamEnd.offset() << " of " << downstreamEndString << "\n"; 
429     }
430 }
431
432 static bool debuggingRenderTreeFlag = false;
433
434 bool debuggingRenderTree()
435 {
436     return debuggingRenderTreeFlag;
437 }
438
439 QString externalRepresentation(RenderObject *o)
440 {
441     debuggingRenderTreeFlag = true;
442     JSEditor::setSupportsPasteCommand(true);
443
444     QString s;
445     {
446         QTextStream ts(&s);
447         if (o) {
448             // FIXME: Hiding the vertical scrollbar is a total hack to preserve the
449             // layout test results until I can figure out what the heck is going on. -dwh
450             o->canvas()->view()->setVScrollBarMode(QScrollView::AlwaysOff);
451             o->canvas()->view()->layout();
452             RenderLayer* l = o->layer();
453             if (l) {
454                 writeLayers(ts, l, l, QRect(l->xPos(), l->yPos(), l->width(), l->height()));
455                 writeSelection(ts, o);
456             }
457         }
458     }
459     return s;
460 }