chromium/third_party/blink/renderer/core/layout/layout_tree_as_text.h

/*
 * 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 THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_LAYOUT_TREE_AS_TEXT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_LAYOUT_TREE_AS_TEXT_H_

#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/text/text_stream.h"

namespace gfx {
class Point;
class PointF;
class Rect;
class RectF;
class Size;
class SizeF;
}  // namespace gfx

namespace blink {

class Color;
class PaintLayer;
class Element;
class LocalFrame;
class LayoutBlockFlow;
class LayoutObject;
class LayoutPoint;

enum LayoutAsTextBehaviorFlags {};
LayoutAsTextBehavior;

// You don't need pageWidthInPixels if you don't specify
// LayoutAsTextInPrintingMode.
CORE_EXPORT String
ExternalRepresentation(LocalFrame*,
                       LayoutAsTextBehavior = kLayoutAsTextBehaviorNormal,
                       const PaintLayer* marked_layer = nullptr);
CORE_EXPORT String
ExternalRepresentation(Element*,
                       LayoutAsTextBehavior = kLayoutAsTextBehaviorNormal);
void Write(WTF::TextStream&,
           const LayoutObject&,
           int indent = 0,
           LayoutAsTextBehavior = kLayoutAsTextBehaviorNormal);

class LayoutTreeAsText {};

// Helper function shared with SVGLayoutTreeAsText (so they are not exported).
String QuoteAndEscapeNonPrintables(const String&);
WTF::TextStream& operator<<(WTF::TextStream&, const Color&);
WTF::TextStream& operator<<(WTF::TextStream& ts, const LayoutPoint&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::Point&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::Size&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::Rect&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::SizeF&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::PointF&);
WTF::TextStream& operator<<(WTF::TextStream&, const gfx::RectF&);

CORE_EXPORT String CounterValueForElement(Element*);

CORE_EXPORT String MarkerTextForListItem(Element*);

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_LAYOUT_LAYOUT_TREE_AS_TEXT_H_