Source/WebCore/layout/FormattingContext.h

   1 /*
   2  * Copyright (C) 2018 Apple Inc. 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  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #pragma once
  27
  28 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
  29
  30 #include "DisplayBox.h"
  31 #include <wtf/IsoMalloc.h>
  32 #include <wtf/WeakPtr.h>
  33
  34 namespace WebCore {
  35
  36 class LayoutPoint;
  37 class LayoutUnit;
  38
  39 namespace Layout {
  40
  41 class Box;
  42 class Container;
  43 class FormattingState;
  44 class LayoutState;
  45
  46 class FormattingContext {
  47     WTF_MAKE_ISO_ALLOCATED(FormattingContext);
  48 public:
  49     FormattingContext(const Box& formattingContextRoot, FormattingState&);
  50     virtual ~FormattingContext();
  51
  52     virtual void layout() const = 0;
  53     void layoutOutOfFlowDescendants(const Box&) const;
  54
  55     struct InstrinsicWidthConstraints {
  56         LayoutUnit minimum;
  57         LayoutUnit maximum;
  58     };
  59     virtual InstrinsicWidthConstraints instrinsicWidthConstraints() const = 0;
  60
  61     static Display::Box mapBoxToAncestor(const LayoutState&, const Box&, const Container& ancestor);
  62     static Position mapTopLeftToAncestor(const LayoutState&, const Box&, const Container& ancestor);
  63     static Position mapCoordinateToAncestor(const LayoutState&, Position, const Container& containingBlock, const Container& ancestor);
  64
  65 protected:
  66     using LayoutQueue = Vector<const Box*>;
  67
  68     FormattingState& formattingState() const;
  69     LayoutState& layoutState() const;
  70     const Box& root() const { return *m_root; }
  71
  72     void computeBorderAndPadding(const Box&) const;
  73
  74 #ifndef NDEBUG
  75     virtual void validateGeometryConstraintsAfterLayout() const;
  76 #endif
  77
  78     // This class implements generic positioning and sizing.
  79     class Geometry {
  80     public:
  81         static VerticalGeometry outOfFlowVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
  82         static HorizontalGeometry outOfFlowHorizontalGeometry(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
  83
  84         static HeightAndMargin floatingHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
  85         static WidthAndMargin floatingWidthAndMargin(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
  86
  87         static HeightAndMargin inlineReplacedHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
  88         static WidthAndMargin inlineReplacedWidthAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { },
  89             std::optional<LayoutUnit> precomputedMarginLeft = { }, std::optional<LayoutUnit> precomputedMarginRight = { });
  90
  91         static LayoutSize inFlowPositionedPositionOffset(const LayoutState&, const Box&);
  92
  93         static HeightAndMargin complicatedCases(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
  94         static LayoutUnit shrinkToFitWidth(LayoutState&, const Box&);
  95
  96         static Edges computedBorder(const LayoutState&, const Box&);
  97         static std::optional<Edges> computedPadding(const LayoutState&, const Box&);
  98
  99         static HorizontalEdges computedNonCollapsedHorizontalMarginValue(const LayoutState&, const Box&);
 100         static VerticalEdges computedNonCollapsedVerticalMarginValue(const LayoutState&, const Box&);
 101
 102         static std::optional<LayoutUnit> computedValueIfNotAuto(const Length& geometryProperty, LayoutUnit containingBlockWidth);
 103         static std::optional<LayoutUnit> fixedValue(const Length& geometryProperty);
 104
 105         static std::optional<LayoutUnit> computedMinHeight(const LayoutState&, const Box&);
 106         static std::optional<LayoutUnit> computedMaxHeight(const LayoutState&, const Box&);
 107
 108     protected:
 109         enum class HeightType { Min, Max, Normal };
 110         static std::optional<LayoutUnit> computedHeightValue(const LayoutState&, const Box&, HeightType);
 111
 112     private:
 113         static VerticalGeometry outOfFlowReplacedVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
 114         static HorizontalGeometry outOfFlowReplacedHorizontalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
 115
 116         static VerticalGeometry outOfFlowNonReplacedVerticalGeometry(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
 117         static HorizontalGeometry outOfFlowNonReplacedHorizontalGeometry(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
 118
 119         static HeightAndMargin floatingReplacedHeightAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedHeight = { });
 120         static WidthAndMargin floatingReplacedWidthAndMargin(const LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
 121
 122         static WidthAndMargin floatingNonReplacedWidthAndMargin(LayoutState&, const Box&, std::optional<LayoutUnit> usedWidth = { });
 123     };
 124
 125 private:
 126     void computeOutOfFlowVerticalGeometry(const Box&) const;
 127     void computeOutOfFlowHorizontalGeometry(const Box&) const;
 128
 129     WeakPtr<const Box> m_root;
 130     FormattingState& m_formattingState;
 131 };
 132
 133 }
 134 }
 135 #endif