File: LayoutTreeAsText.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (112 lines) | stat: -rw-r--r-- 4,586 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * Copyright (C) 2003, 2006, 2008 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef LayoutTreeAsText_h
#define LayoutTreeAsText_h

#include "core/CoreExport.h"
#include "platform/text/TextStream.h"
#include "wtf/Allocator.h"
#include "wtf/Forward.h"

namespace blink {

class Color;
class PaintLayer;
class Element;
class LayoutRect;
class LocalFrame;
class LayoutBlockFlow;
class LayoutObject;
class TextStream;

enum LayoutAsTextBehaviorFlags {
  LayoutAsTextBehaviorNormal = 0,
  LayoutAsTextShowAllLayers =
      1 << 0,  // Dump all layers, not just those that would paint.
  LayoutAsTextShowLayerNesting = 1 << 1,  // Annotate the layer lists.
  LayoutAsTextShowCompositedLayers = 1
                                     << 2,  // Show which layers are composited.
  LayoutAsTextShowAddresses = 1 << 3,  // Show layer and layoutObject addresses.
  LayoutAsTextShowIDAndClass = 1 << 4,  // Show id and class attributes
  LayoutAsTextPrintingMode = 1 << 5,    // Dump the tree in printing mode.
  LayoutAsTextDontUpdateLayout =
      1 << 6,  // Don't update layout, to make it safe to call showLayerTree()
               // from the debugger inside layout or painting code.
  LayoutAsTextShowLayoutState =
      1 << 7,  // Print the various 'needs layout' bits on layoutObjects.
  LayoutAsTextShowLineTrees =
      1 << 8  // Dump the line trees for each LayoutBlockFlow.
};
typedef unsigned LayoutAsTextBehavior;

// You don't need pageWidthInPixels if you don't specify
// LayoutAsTextInPrintingMode.
CORE_EXPORT String
externalRepresentation(LocalFrame*,
                       LayoutAsTextBehavior = LayoutAsTextBehaviorNormal,
                       const PaintLayer* markedLayer = nullptr);
CORE_EXPORT String
externalRepresentation(Element*,
                       LayoutAsTextBehavior = LayoutAsTextBehaviorNormal);
void write(TextStream&,
           const LayoutObject&,
           int indent = 0,
           LayoutAsTextBehavior = LayoutAsTextBehaviorNormal);

class LayoutTreeAsText {
  STATIC_ONLY(LayoutTreeAsText);
  // FIXME: This is a cheesy hack to allow easy access to ComputedStyle colors.
  // It won't be needed if we convert it to use visitedDependentColor instead.
  // (This just involves rebaselining many results though, so for now it's
  // not being done).
 public:
  static void writeLayoutObject(TextStream&,
                                const LayoutObject&,
                                LayoutAsTextBehavior);
  static void writeLayers(TextStream&,
                          const PaintLayer* rootLayer,
                          PaintLayer*,
                          const LayoutRect& paintDirtyRect,
                          int indent = 0,
                          LayoutAsTextBehavior = LayoutAsTextBehaviorNormal,
                          const PaintLayer* markedLayer = nullptr);
  static void writeLineBoxTree(TextStream&,
                               const LayoutBlockFlow&,
                               int indent = 0);
};

// Helper function shared with SVGLayoutTreeAsText
String quoteAndEscapeNonPrintables(const String&);

CORE_EXPORT String counterValueForElement(Element*);

CORE_EXPORT String markerTextForListItem(Element*);

TextStream& operator<<(TextStream&, const Color&);

}  // namespace blink

#endif  // LayoutTreeAsText_h