third_party/WebKit/Source/platform/geometry/LayoutRectOutsets.h

/*
 * Copyright (c) 2012, Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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 LayoutRectOutsets_h
#define LayoutRectOutsets_h

#include "platform/LayoutUnit.h"
#include "platform/PlatformExport.h"
#include "platform/geometry/FloatRectOutsets.h"
#include "platform/geometry/IntRectOutsets.h"
#include "platform/text/TextDirection.h"
#include "platform/text/WritingMode.h"
#include "wtf/Allocator.h"

namespace blink {

// Specifies LayoutUnit lengths to be used to expand a rectangle.
// For example, |top()| returns the distance the top edge should be moved
// upward.
//
// Negative lengths can be used to express insets.
class PLATFORM_EXPORT LayoutRectOutsets {
  DISALLOW_NEW();

 public:
  LayoutRectOutsets() {}
  LayoutRectOutsets(LayoutUnit top,
                    LayoutUnit right,
                    LayoutUnit bottom,
                    LayoutUnit left)
      : m_top(top), m_right(right), m_bottom(bottom), m_left(left) {}
  LayoutRectOutsets(int top, int right, int bottom, int left)
      : m_top(LayoutUnit(top)),
        m_right(LayoutUnit(right)),
        m_bottom(LayoutUnit(bottom)),
        m_left(LayoutUnit(left)) {}

  LayoutRectOutsets(const IntRectOutsets& outsets)
      : m_top(LayoutUnit(outsets.top())),
        m_right(LayoutUnit(outsets.right())),
        m_bottom(LayoutUnit(outsets.bottom())),
        m_left(LayoutUnit(outsets.left())) {}

  LayoutRectOutsets(const FloatRectOutsets& outsets)
      : m_top(LayoutUnit(outsets.top())),
        m_right(LayoutUnit(outsets.right())),
        m_bottom(LayoutUnit(outsets.bottom())),
        m_left(LayoutUnit(outsets.left())) {}

  LayoutUnit top() const { return m_top; }
  LayoutUnit right() const { return m_right; }
  LayoutUnit bottom() const { return m_bottom; }
  LayoutUnit left() const { return m_left; }

  void setTop(LayoutUnit value) { m_top = value; }
  void setRight(LayoutUnit value) { m_right = value; }
  void setBottom(LayoutUnit value) { m_bottom = value; }
  void setLeft(LayoutUnit value) { m_left = value; }

  LayoutUnit logicalTop(WritingMode) const;
  LayoutUnit logicalBottom(WritingMode) const;
  LayoutUnit logicalLeft(WritingMode) const;
  LayoutUnit logicalRight(WritingMode) const;

  // Produces a new LayoutRectOutsets whose |top| is the |logicalTop| of this
  // one, and so on.
  LayoutRectOutsets logicalOutsets(WritingMode) const;

  // The same as |logicalOutsets|, but also adjusting for flipped lines.
  LayoutRectOutsets logicalOutsetsWithFlippedLines(WritingMode) const;

  LayoutUnit before(WritingMode) const;
  LayoutUnit after(WritingMode) const;
  LayoutUnit start(WritingMode, TextDirection) const;
  LayoutUnit end(WritingMode, TextDirection) const;
  LayoutUnit over(WritingMode) const;
  LayoutUnit under(WritingMode) const;

  void setBefore(WritingMode, LayoutUnit);
  void setAfter(WritingMode, LayoutUnit);
  void setStart(WritingMode, TextDirection, LayoutUnit);
  void setEnd(WritingMode, TextDirection, LayoutUnit);

  bool operator==(const LayoutRectOutsets other) const {
    return top() == other.top() && right() == other.right() &&
           bottom() == other.bottom() && left() == other.left();
  }

 private:
  LayoutUnit m_top;
  LayoutUnit m_right;
  LayoutUnit m_bottom;
  LayoutUnit m_left;
};

}  // namespace blink

#endif  // LayoutRectOutsets_h