2 * Copyright (C) 2003, 2006, 2008 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
26 #ifndef LayoutTreeAsText_h
27 #define LayoutTreeAsText_h
29 #include "core/CoreExport.h"
30 #include "platform/text/TextStream.h"
31 #include "wtf/Allocator.h"
32 #include "wtf/Forward.h"
37 class DeprecatedPaintLayer
;
42 class LayoutBlockFlow
;
46 enum LayoutAsTextBehaviorFlags
{
47 LayoutAsTextBehaviorNormal
= 0,
48 LayoutAsTextShowAllLayers
= 1 << 0, // Dump all layers, not just those that would paint.
49 LayoutAsTextShowLayerNesting
= 1 << 1, // Annotate the layer lists.
50 LayoutAsTextShowCompositedLayers
= 1 << 2, // Show which layers are composited.
51 LayoutAsTextShowAddresses
= 1 << 3, // Show layer and layoutObject addresses.
52 LayoutAsTextShowIDAndClass
= 1 << 4, // Show id and class attributes
53 LayoutAsTextPrintingMode
= 1 << 5, // Dump the tree in printing mode.
54 LayoutAsTextDontUpdateLayout
= 1 << 6, // Don't update layout, to make it safe to call showLayerTree() from the debugger inside layout or painting code.
55 LayoutAsTextShowLayoutState
= 1 << 7, // Print the various 'needs layout' bits on layoutObjects.
56 LayoutAsTextShowLineTrees
= 1 << 8 // Dump the line trees for each LayoutBlockFlow.
58 typedef unsigned LayoutAsTextBehavior
;
60 // You don't need pageWidthInPixels if you don't specify LayoutAsTextInPrintingMode.
61 CORE_EXPORT String
externalRepresentation(LocalFrame
*, LayoutAsTextBehavior
= LayoutAsTextBehaviorNormal
);
62 CORE_EXPORT String
externalRepresentation(Element
*, LayoutAsTextBehavior
= LayoutAsTextBehaviorNormal
);
63 void write(TextStream
&, const LayoutObject
&, int indent
= 0, LayoutAsTextBehavior
= LayoutAsTextBehaviorNormal
);
65 class LayoutTreeAsText
{
66 STATIC_ONLY(LayoutTreeAsText
);
67 // FIXME: This is a cheesy hack to allow easy access to ComputedStyle colors. It won't be needed if we convert
68 // it to use visitedDependentColor instead. (This just involves rebaselining many results though, so for now it's
71 static void writeLayoutObject(TextStream
&, const LayoutObject
&, LayoutAsTextBehavior
);
72 static void writeLayers(TextStream
&, const DeprecatedPaintLayer
* rootLayer
, DeprecatedPaintLayer
*, const LayoutRect
& paintDirtyRect
, int indent
= 0, LayoutAsTextBehavior
= LayoutAsTextBehaviorNormal
);
73 static void writeLineBoxTree(TextStream
&, const LayoutBlockFlow
&, int indent
= 0);
76 // Helper function shared with SVGLayoutTreeAsText
77 String
quoteAndEscapeNonPrintables(const String
&);
79 CORE_EXPORT String
counterValueForElement(Element
*);
81 CORE_EXPORT String
markerTextForListItem(Element
*);
83 CORE_EXPORT String
nodePositionAsStringForTesting(Node
*);
85 TextStream
& operator<<(TextStream
&, const Color
&);
89 #endif // LayoutTreeAsText_h