Source/WebCore/rendering/shapes/Shape.h

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