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#ifndef Shape_h
31#define Shape_h
32
33#include "LayoutRect.h"
34#include "Path.h"
35#include "WritingMode.h"
36
37namespace WebCore {
38
39struct LineSegment {
40    LineSegment(float logicalLeft, float logicalRight)
41        : logicalLeft(logicalLeft)
42        , logicalRight(logicalRight)
43    {
44    }
45
46    float logicalLeft;
47    float logicalRight;
48};
49
50class BasicShape;
51class Image;
52class RoundedRect;
53
54typedef Vector<LineSegment> SegmentList;
55
56
57// A representation of a BasicShape that enables layout code to determine how to break a line up into segments
58// that will fit within or around a shape. The line is defined by a pair of logical Y coordinates and the
59// computed segments are returned as pairs of logical X coordinates. The BasicShape itself is defined in
60// physical coordinates.
61
62class Shape {
63public:
64    struct DisplayPaths {
65        Path shape;
66        Path marginShape;
67    };
68
69    static std::unique_ptr<Shape> createShape(const BasicShape*, const LayoutSize& logicalBoxSize, WritingMode, float margin);
70    static std::unique_ptr<Shape> createRasterShape(Image*, float threshold, const LayoutRect& imageRect, const LayoutRect& marginRect, WritingMode, float margin);
71    static std::unique_ptr<Shape> createBoxShape(const RoundedRect&, WritingMode, float margin);
72
73    virtual ~Shape() { }
74
75    virtual LayoutRect shapeMarginLogicalBoundingBox() const = 0;
76    virtual bool isEmpty() const = 0;
77    virtual void getExcludedIntervals(LayoutUnit logicalTop, LayoutUnit logicalHeight, SegmentList&) const = 0;
78
79    bool lineOverlapsShapeMarginBounds(LayoutUnit lineTop, LayoutUnit lineHeight) const { return lineOverlapsBoundingBox(lineTop, lineHeight, shapeMarginLogicalBoundingBox()); }
80
81    virtual void buildDisplayPaths(DisplayPaths&) const = 0;
82
83protected:
84    float shapeMargin() const { return m_margin; }
85
86private:
87    bool lineOverlapsBoundingBox(LayoutUnit lineTop, LayoutUnit lineHeight, const LayoutRect& rect) const
88    {
89        if (rect.isEmpty())
90            return false;
91        return (lineTop < rect.maxY() && lineTop + lineHeight > rect.y()) || (!lineHeight && lineTop == rect.y());
92    }
93
94    WritingMode m_writingMode;
95    float m_margin;
96};
97
98} // namespace WebCore
99
100#endif // Shape_h
101