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#ifndef RenderTreeAsText_h
27#define RenderTreeAsText_h
28#include "TextStream.h"
29
30#include <wtf/Forward.h>
31
32namespace WebCore {
33
34class Element;
35class Frame;
36class RenderObject;
37class TextStream;
38
39enum RenderAsTextBehaviorFlags {
40    RenderAsTextBehaviorNormal = 0,
41    RenderAsTextShowAllLayers = 1 << 0, // Dump all layers, not just those that would paint.
42    RenderAsTextShowLayerNesting = 1 << 1, // Annotate the layer lists.
43    RenderAsTextShowCompositedLayers = 1 << 2, // Show which layers are composited.
44    RenderAsTextShowAddresses = 1 << 3, // Show layer and renderer addresses.
45    RenderAsTextShowIDAndClass = 1 << 4, // Show id and class attributes
46    RenderAsTextPrintingMode = 1 << 5, // Dump the tree in printing mode.
47    RenderAsTextDontUpdateLayout = 1 << 6, // Don't update layout, to make it safe to call showLayerTree() from the debugger inside layout or painting code.
48    RenderAsTextShowLayoutState = 1 << 7, // Print the various 'needs layout' bits on renderers.
49    RenderAsTextShowOverflow = 1 << 8 // Print layout and visual overflow.
50};
51typedef unsigned RenderAsTextBehavior;
52
53// You don't need pageWidthInPixels if you don't specify RenderAsTextInPrintingMode.
54String externalRepresentation(Frame*, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
55String externalRepresentation(Element*, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
56void write(TextStream&, const RenderObject&, int indent = 0, RenderAsTextBehavior = RenderAsTextBehaviorNormal);
57
58class 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).
62public:
63static void writeRenderObject(TextStream& ts, const RenderObject& o, RenderAsTextBehavior behavior);
64};
65
66// Helper function shared with SVGRenderTreeAsText
67String quoteAndEscapeNonPrintables(const String&);
68
69String counterValueForElement(Element*);
70
71String markerTextForListItem(Element*);
72
73} // namespace WebCore
74
75#endif // RenderTreeAsText_h
76