/* * Copyright (c) Facebook, Inc. and its affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ #pragma once #include "YGNode.h" #include "Yoga-internal.h" #include "CompactValue.h" // This struct is an helper model to hold the data for step 4 of flexbox algo, // which is collecting the flex items in a line. // // - itemsOnLine: Number of items which can fit in a line considering the // available Inner dimension, the flex items computed flexbasis and their // margin. It may be different than the difference between start and end // indicates because we skip over absolute-positioned items. // // - sizeConsumedOnCurrentLine: It is accumulation of the dimensions and margin // of all the children on the current line. This will be used in order to // either set the dimensions of the node if none already exist or to compute // the remaining space left for the flexible children. // // - totalFlexGrowFactors: total flex grow factors of flex items which are to be // layed in the current line // // - totalFlexShrinkFactors: total flex shrink factors of flex items which are // to be layed in the current line // // - endOfLineIndex: Its the end index of the last flex item which was examined // and it may or may not be part of the current line(as it may be absolutely // positioned or including it may have caused to overshoot availableInnerDim) // // - relativeChildren: Maintain a vector of the child nodes that can shrink // and/or grow. struct YGCollectFlexItemsRowValues { uint32_t itemsOnLine; float sizeConsumedOnCurrentLine; float totalFlexGrowFactors; float totalFlexShrinkScaledFactors; uint32_t endOfLineIndex; std::vector relativeChildren; float remainingFreeSpace; // The size of the mainDim for the row after considering size, padding, margin // and border of flex items. This is used to calculate maxLineDim after going // through all the rows to decide on the main axis size of owner. float mainDim; // The size of the crossDim for the row after considering size, padding, // margin and border of flex items. Used for calculating containers crossSize. float crossDim; }; bool YGValueEqual(const YGValue& a, const YGValue& b); inline bool YGValueEqual( facebook::yoga::detail::CompactValue a, facebook::yoga::detail::CompactValue b) { return YGValueEqual((YGValue) a, (YGValue) b); } // This custom float equality function returns true if either absolute // difference between two floats is less than 0.0001f or both are undefined. bool YGFloatsEqual(const float a, const float b); bool YGDoubleEqual(const double a, const double b); float YGFloatMax(const float a, const float b); YGFloatOptional YGFloatOptionalMax( const YGFloatOptional op1, const YGFloatOptional op2); float YGFloatMin(const float a, const float b); // This custom float comparison function compares the array of float with // YGFloatsEqual, as the default float comparison operator will not work(Look // at the comments of YGFloatsEqual function). template bool YGFloatArrayEqual( const std::array& val1, const std::array& val2) { bool areEqual = true; for (std::size_t i = 0; i < size && areEqual; ++i) { areEqual = YGFloatsEqual(val1[i], val2[i]); } return areEqual; } // This function returns 0 if YGFloatIsUndefined(val) is true and val otherwise float YGFloatSanitize(const float val); YGFlexDirection YGFlexDirectionCross( const YGFlexDirection flexDirection, const YGDirection direction); inline bool YGFlexDirectionIsRow(const YGFlexDirection flexDirection) { return flexDirection == YGFlexDirectionRow || flexDirection == YGFlexDirectionRowReverse; } inline YGFloatOptional YGResolveValue( const YGValue value, const float ownerSize) { switch (value.unit) { case YGUnitPoint: return YGFloatOptional{value.value}; case YGUnitPercent: return YGFloatOptional{value.value * ownerSize * 0.01f}; default: return YGFloatOptional{}; } } inline YGFloatOptional YGResolveValue( yoga::detail::CompactValue value, float ownerSize) { return YGResolveValue((YGValue) value, ownerSize); } inline bool YGFlexDirectionIsColumn(const YGFlexDirection flexDirection) { return flexDirection == YGFlexDirectionColumn || flexDirection == YGFlexDirectionColumnReverse; } inline YGFlexDirection YGResolveFlexDirection( const YGFlexDirection flexDirection, const YGDirection direction) { if (direction == YGDirectionRTL) { if (flexDirection == YGFlexDirectionRow) { return YGFlexDirectionRowReverse; } else if (flexDirection == YGFlexDirectionRowReverse) { return YGFlexDirectionRow; } } return flexDirection; } inline YGFloatOptional YGResolveValueMargin( yoga::detail::CompactValue value, const float ownerSize) { return value.isAuto() ? YGFloatOptional{0} : YGResolveValue(value, ownerSize); } void throwLogicalErrorWithMessage(const char* message);