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 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 #ifndef RenderTreeAsText_h

    27 #define RenderTreeAsText_h

    28 

    29 namespace WebCore {

    30 

    31 class Element;

    32 class Frame;

    33 class RenderObject;

    34 class String;

    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 };

    46 typedef unsigned RenderAsTextBehavior;

    47 

    48 // You don't need pageWidthInPixels if you don't specify RenderAsTextInPrintingMode.

    49 String externalRepresentation(Frame*, RenderAsTextBehavior = RenderAsTextBehaviorNormal);

    50 void write(TextStream&, const RenderObject&, int indent = 0, RenderAsTextBehavior = RenderAsTextBehaviorNormal);

    51 void writeIndent(TextStream&, int indent);

    52 

    53 class RenderTreeAsText {

    54 // FIXME: This is a cheesy hack to allow easy access to RenderStyle colors.  It won't be needed if we convert

    55 // it to use visitedDependentColor instead. (This just involves rebaselining many results though, so for now it's

    56 // not being done).

    57 public:

    58 static void writeRenderObject(TextStream& ts, const RenderObject& o, RenderAsTextBehavior behavior);

    59 };

    60 

    61 // Helper function shared with SVGRenderTreeAsText

    62 String quoteAndEscapeNonPrintables(const String&);

    63 

    64 String counterValueForElement(Element*);

    65 

    66 String markerTextForListItem(Element*);

    67 

    68 } // namespace WebCore

    69 

    70 #endif // RenderTreeAsText_h