1 | /* |
2 | * Copyright (C) 2003, 2006, 2008 Apple 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 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 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 | #pragma once |
27 | |
28 | #include <wtf/Forward.h> |
29 | #include <wtf/OptionSet.h> |
30 | |
31 | namespace WTF { |
32 | class TextStream; |
33 | } |
34 | |
35 | namespace WebCore { |
36 | |
37 | class Element; |
38 | class Frame; |
39 | class RenderObject; |
40 | |
41 | enum class RenderAsTextFlag { |
42 | BehaviorNormal = 0, |
43 | ShowAllLayers = 1 << 0, // Dump all layers, not just those that would paint. |
44 | ShowLayerNesting = 1 << 1, // Annotate the layer lists. |
45 | ShowCompositedLayers = 1 << 2, // Show which layers are composited. |
46 | ShowOverflow = 1 << 3, // Print layout and visual overflow. |
47 | ShowSVGGeometry = 1 << 4, // Print additional geometry for SVG objects. |
48 | ShowLayerFragments = 1 << 5, // Print additional info about fragmented RenderLayers |
49 | ShowAddresses = 1 << 6, // Show layer and renderer addresses. |
50 | ShowIDAndClass = 1 << 7, // Show id and class attributes |
51 | PrintingMode = 1 << 8, // Dump the tree in printing mode. |
52 | DontUpdateLayout = 1 << 9, // Don't update layout, to make it safe to call showLayerTree() from the debugger inside layout or painting code. |
53 | ShowLayoutState = 1 << 10, // Print the various 'needs layout' bits on renderers. |
54 | }; |
55 | |
56 | // You don't need pageWidthInPixels if you don't specify RenderAsTextInPrintingMode. |
57 | WEBCORE_EXPORT String externalRepresentation(Frame*, OptionSet<RenderAsTextFlag> = { }); |
58 | WEBCORE_EXPORT String externalRepresentation(Element*, OptionSet<RenderAsTextFlag> = { }); |
59 | void write(WTF::TextStream&, const RenderObject&, OptionSet<RenderAsTextFlag> = { }); |
60 | void writeDebugInfo(WTF::TextStream&, const RenderObject&, OptionSet<RenderAsTextFlag> = { }); |
61 | |
62 | class RenderTreeAsText { |
63 | // FIXME: This is a cheesy hack to allow easy access to RenderStyle colors. It won't be needed if we convert |
64 | // it to use visitedDependentColor instead. (This just involves rebaselining many results though, so for now it's |
65 | // not being done). |
66 | public: |
67 | static void writeRenderObject(WTF::TextStream&, const RenderObject&, OptionSet<RenderAsTextFlag>); |
68 | }; |
69 | |
70 | // Helper function shared with SVGRenderTreeAsText |
71 | String quoteAndEscapeNonPrintables(StringView); |
72 | |
73 | WEBCORE_EXPORT String counterValueForElement(Element*); |
74 | WEBCORE_EXPORT String markerTextForListItem(Element*); |
75 | |
76 | } // namespace WebCore |
77 | |