Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / rendering / RenderTreeAsText.h
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
30 namespace WebCore {
31
32 class Element;
33 class Frame;
34 class RenderObject;
35 class TextStream;
36
37 enum RenderAsTextBehaviorFlags {
38     RenderAsTextBehaviorNormal          = 0,
39     RenderAsTextShowAllLayers           = 1 << 0, // Dump all layers, not just those that would paint.
40     RenderAsTextShowLayerNesting        = 1 << 1, // Annotate the layer lists.
41     RenderAsTextShowCompositedLayers    = 1 << 2, // Show which layers are composited.
42     RenderAsTextShowAddresses           = 1 << 3, // Show layer and renderer addresses.
43     RenderAsTextShowIDAndClass          = 1 << 4, // Show id and class attributes
44     RenderAsTextPrintingMode            = 1 << 5, // Dump the tree in printing mode.
45     RenderAsTextDontUpdateLayout        = 1 << 6, // Don't update layout, to make it safe to call showLayerTree() from the debugger inside layout or painting code.
46     RenderAsTextShowLayoutState         = 1 << 7, // Print the various 'needs layout' bits on renderers.
47     RenderAsTextShowOverflow            = 1 << 8, // Print layout and visual overflow.
48     RenderAsTextShowSVGGeometry         = 1 << 9, // Print additional geometry for SVG objects.
49 };
50 typedef unsigned RenderAsTextBehavior;
51
52 // You don't need pageWidthInPixels if you don't specify RenderAsTextInPrintingMode.
53 WEBCORE_EXPORT String externalRepresentation(Frame*, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
54 WEBCORE_EXPORT String externalRepresentation(Element*, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
55 void write(TextStream&, const RenderObject&, int indent = 0, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
56 void writeDebugInfo(TextStream&, const RenderObject&, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
57
58 class RenderTreeAsText {
59 // FIXME: This is a cheesy hack to allow easy access to RenderStyle colors.  It won't be needed if we convert
60 // it to use visitedDependentColor instead. (This just involves rebaselining many results though, so for now it's
61 // not being done).
62 public:
63     static void writeRenderObject(TextStream&, const RenderObject&, RenderAsTextBehavior);
64 };
65
66 // Helper function shared with SVGRenderTreeAsText
67 String quoteAndEscapeNonPrintables(StringView);
68
69 WEBCORE_EXPORT String counterValueForElement(Element*);
70 WEBCORE_EXPORT String markerTextForListItem(Element*);
71
72 } // namespace WebCore