1/*
2 * Copyright (C) 2012 Adobe Systems Incorporated. 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 *
8 * 1. Redistributions of source code must retain the above
9 * copyright notice, this list of conditions and the following
10 * disclaimer.
11 * 2. Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following
13 * disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
19 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
20 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
27 * OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30#pragma once
31
32#include "LayoutRect.h"
33#include "Path.h"
34#include "WritingMode.h"
35
36namespace WebCore {
37
38struct LineSegment {
39 LineSegment()
40 : logicalLeft(0)
41 , logicalRight(0)
42 , isValid(false)
43 {
44 }
45
46 LineSegment(float logicalLeft, float logicalRight)
47 : logicalLeft(logicalLeft)
48 , logicalRight(logicalRight)
49 , isValid(true)
50 {
51 }
52
53 float logicalLeft;
54 float logicalRight;
55 bool isValid;
56};
57
58class BasicShape;
59class Image;
60class RoundedRect;
61
62// A representation of a BasicShape that enables layout code to determine how to break a line up into segments
63// that will fit within or around a shape. The line is defined by a pair of logical Y coordinates and the
64// computed segments are returned as pairs of logical X coordinates. The BasicShape itself is defined in
65// physical coordinates.
66
67class Shape {
68 WTF_MAKE_FAST_ALLOCATED;
69public:
70 struct DisplayPaths {
71 Path shape;
72 Path marginShape;
73 };
74
75 static std::unique_ptr<Shape> createShape(const BasicShape&, const LayoutSize& logicalBoxSize, WritingMode, float margin);
76 static std::unique_ptr<Shape> createRasterShape(Image*, float threshold, const LayoutRect& imageRect, const LayoutRect& marginRect, WritingMode, float margin);
77 static std::unique_ptr<Shape> createBoxShape(const RoundedRect&, WritingMode, float margin);
78
79 virtual ~Shape() = default;
80
81 virtual LayoutRect shapeMarginLogicalBoundingBox() const = 0;
82 virtual bool isEmpty() const = 0;
83 virtual LineSegment getExcludedInterval(LayoutUnit logicalTop, LayoutUnit logicalHeight) const = 0;
84
85 bool lineOverlapsShapeMarginBounds(LayoutUnit lineTop, LayoutUnit lineHeight) const { return lineOverlapsBoundingBox(lineTop, lineHeight, shapeMarginLogicalBoundingBox()); }
86
87 virtual void buildDisplayPaths(DisplayPaths&) const = 0;
88
89protected:
90 float shapeMargin() const { return m_margin; }
91
92private:
93 bool lineOverlapsBoundingBox(LayoutUnit lineTop, LayoutUnit lineHeight, const LayoutRect& rect) const
94 {
95 if (rect.isEmpty())
96 return false;
97 return (lineTop < rect.maxY() && lineTop + lineHeight > rect.y()) || (!lineHeight && lineTop == rect.y());
98 }
99
100 WritingMode m_writingMode;
101 float m_margin;
102};
103
104} // namespace WebCore
105