/*
 * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
 *           (C) 2000 Antti Koivisto (koivisto@kde.org)
 *           (C) 2000 Dirk Mueller (mueller@kde.org)
 * Copyright (C) 2003, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
 * Copyright (C) 2006 Graham Dennis (graham.dennis@gmail.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef StyleRareNonInheritedData_h
#define StyleRareNonInheritedData_h

#include "core/CoreExport.h"
#include "core/css/StyleColor.h"
#include "core/style/ClipPathOperation.h"
#include "core/style/ComputedStyleConstants.h"
#include "core/style/CounterDirectives.h"
#include "core/style/DataPersistent.h"
#include "core/style/DataRef.h"
#include "core/style/FillLayer.h"
#include "core/style/LineClampValue.h"
#include "core/style/NinePieceImage.h"
#include "core/style/OutlineValue.h"
#include "core/style/ShapeValue.h"
#include "core/style/StyleContentAlignmentData.h"
#include "core/style/StyleScrollSnapData.h"
#include "core/style/StyleSelfAlignmentData.h"
#include "platform/LengthPoint.h"
#include "wtf/PassRefPtr.h"
#include "wtf/RefCounted.h"
#include "wtf/Vector.h"
#include <memory>

namespace blink {

class ContentData;
class CSSAnimationData;
class CSSTransitionData;
class ShadowList;
class StyleDeprecatedFlexibleBoxData;
class StyleFilterData;
class StyleFlexibleBoxData;
class StyleGridData;
class StyleGridItemData;
class StyleMultiColData;
class StyleNonInheritedVariables;
class StyleReflection;
class StyleTransformData;
class StyleWillChangeData;

// Page size type.
// StyleRareNonInheritedData::m_pageSize is meaningful only when
// StyleRareNonInheritedData::m_pageSizeType is PAGE_SIZE_RESOLVED.
enum PageSizeType {
  PAGE_SIZE_AUTO,            // size: auto
  PAGE_SIZE_AUTO_LANDSCAPE,  // size: landscape
  PAGE_SIZE_AUTO_PORTRAIT,   // size: portrait
  PAGE_SIZE_RESOLVED         // Size is fully resolved.
};

// This struct is for rarely used non-inherited CSS3, CSS2, and WebKit-specific
// properties.  By grouping them together, we save space, and only allocate this
// object when someone actually uses one of these properties.
// TODO(sashab): Move this into a private class on ComputedStyle, and remove
// all methods on it, merging them into copy/creation methods on ComputedStyle
// instead. Keep the allocation logic, only allocating a new object if needed.
class CORE_EXPORT StyleRareNonInheritedData
    : public RefCounted<StyleRareNonInheritedData> {
 public:
  static PassRefPtr<StyleRareNonInheritedData> create() {
    return adoptRef(new StyleRareNonInheritedData);
  }
  PassRefPtr<StyleRareNonInheritedData> copy() const {
    return adoptRef(new StyleRareNonInheritedData(*this));
  }
  ~StyleRareNonInheritedData();

  bool operator==(const StyleRareNonInheritedData&) const;
  bool operator!=(const StyleRareNonInheritedData& o) const {
    return !(*this == o);
  }

  bool contentDataEquivalent(const StyleRareNonInheritedData&) const;
  bool counterDataEquivalent(const StyleRareNonInheritedData&) const;
  bool shadowDataEquivalent(const StyleRareNonInheritedData&) const;
  bool reflectionDataEquivalent(const StyleRareNonInheritedData&) const;
  bool animationDataEquivalent(const StyleRareNonInheritedData&) const;
  bool transitionDataEquivalent(const StyleRareNonInheritedData&) const;
  bool shapeOutsideDataEquivalent(const StyleRareNonInheritedData&) const;
  bool clipPathDataEquivalent(const StyleRareNonInheritedData&) const;
  bool hasFilters() const;
  bool hasBackdropFilters() const;
  bool hasOpacity() const { return opacity < 1; }

  float opacity;  // Whether or not we're transparent.

  float m_perspective;
  float m_shapeImageThreshold;

  int m_order;

  LengthPoint m_perspectiveOrigin;
  LengthPoint m_objectPosition;

  LineClampValue lineClamp;  // An Apple extension.
  DraggableRegionMode m_draggableRegionMode;

  DataRef<StyleDeprecatedFlexibleBoxData>
      m_deprecatedFlexibleBox;  // Flexible box properties
  DataRef<StyleFlexibleBoxData> m_flexibleBox;
  DataRef<StyleMultiColData> m_multiCol;  //  CSS3 multicol properties
  DataRef<StyleTransformData>
      m_transform;  // Transform properties (rotate, scale, skew, etc.)
  DataRef<StyleWillChangeData> m_willChange;  // CSS Will Change

  DataPersistent<StyleFilterData>
      m_filter;  // Filter operations (url, sepia, blur, etc.)
  DataPersistent<StyleFilterData>
      m_backdropFilter;  // Backdrop filter operations (url, sepia, blur, etc.)

  DataRef<StyleGridData> m_grid;
  DataRef<StyleGridItemData> m_gridItem;
  DataRef<StyleScrollSnapData> m_scrollSnap;

  Persistent<ContentData> m_content;
  std::unique_ptr<CounterDirectiveMap> m_counterDirectives;
  std::unique_ptr<CSSAnimationData> m_animations;
  std::unique_ptr<CSSTransitionData> m_transitions;

  RefPtr<ShadowList> m_boxShadow;

  RefPtr<StyleReflection> m_boxReflect;

  Persistent<ShapeValue> m_shapeOutside;
  RefPtr<ClipPathOperation> m_clipPath;

  FillLayer m_mask;
  NinePieceImage m_maskBoxImage;

  FloatSize m_pageSize;
  Length m_shapeMargin;

  OutlineValue m_outline;

  StyleColor m_textDecorationColor;
  StyleColor m_visitedLinkTextDecorationColor;
  StyleColor m_visitedLinkBackgroundColor;
  StyleColor m_visitedLinkOutlineColor;
  StyleColor m_visitedLinkBorderLeftColor;
  StyleColor m_visitedLinkBorderRightColor;
  StyleColor m_visitedLinkBorderTopColor;
  StyleColor m_visitedLinkBorderBottomColor;

  Vector<String> m_callbackSelectors;

  std::unique_ptr<Vector<Persistent<StyleImage>>> m_paintImages;

  std::unique_ptr<StyleNonInheritedVariables> m_variables;

  StyleContentAlignmentData m_alignContent;
  StyleSelfAlignmentData m_alignItems;
  StyleSelfAlignmentData m_alignSelf;
  StyleContentAlignmentData m_justifyContent;
  StyleSelfAlignmentData m_justifyItems;
  StyleSelfAlignmentData m_justifySelf;

  unsigned m_pageSizeType : 2;        // PageSizeType
  unsigned m_transformStyle3D : 1;    // ETransformStyle3D
  unsigned m_backfaceVisibility : 1;  // EBackfaceVisibility

  unsigned userDrag : 2;      // EUserDrag
  unsigned textOverflow : 1;  // Whether or not lines that spill out should be
                              // truncated with "..."
  unsigned marginBeforeCollapse : 2;  // EMarginCollapse
  unsigned marginAfterCollapse : 2;   // EMarginCollapse
  unsigned m_appearance : 6;          // EAppearance

  unsigned m_textDecorationStyle : 3;  // TextDecorationStyle

  unsigned m_hasCurrentOpacityAnimation : 1;
  unsigned m_hasCurrentTransformAnimation : 1;
  unsigned m_hasCurrentFilterAnimation : 1;
  unsigned m_hasCurrentBackdropFilterAnimation : 1;
  unsigned m_runningOpacityAnimationOnCompositor : 1;
  unsigned m_runningTransformAnimationOnCompositor : 1;
  unsigned m_runningFilterAnimationOnCompositor : 1;
  unsigned m_runningBackdropFilterAnimationOnCompositor : 1;

  unsigned m_isStackingContext : 1;

  unsigned m_effectiveBlendMode : 5;  // EBlendMode

  unsigned m_touchAction : TouchActionBits;  // TouchAction

  unsigned m_objectFit : 3;  // ObjectFit

  unsigned m_isolation : 1;  // Isolation

  unsigned m_contain : 4;  // Containment

  // ScrollBehavior. 'scroll-behavior' has 2 accepted values, but ScrollBehavior
  // has a third value (that can only be specified using CSSOM scroll APIs) so 2
  // bits are needed.
  unsigned m_scrollBehavior : 2;

  unsigned m_scrollSnapType : 2;  // ScrollSnapType

  // Plugins require accelerated compositing for reasons external to blink.
  // In which case, we need to update the ComputedStyle on the
  // LayoutEmbeddedObject, so store this bit so that the style actually changes
  // when the plugin becomes composited.
  unsigned m_requiresAcceleratedCompositingForExternalReasons : 1;

  // Whether the transform (if it exists) is stored in the element's inline
  // style.
  unsigned m_hasInlineTransform : 1;
  unsigned m_resize : 2;  // EResize
  unsigned m_hasCompositorProxy : 1;

  // Style adjustment for appearance is disabled when certain properties are
  // set.
  unsigned m_hasAuthorBackground : 1;  // Whether there is a author-defined
                                       // background.
  unsigned m_hasAuthorBorder : 1;  // Whether there is a author-defined border.

 private:
  StyleRareNonInheritedData();
  StyleRareNonInheritedData(const StyleRareNonInheritedData&);
};

}  // namespace blink

#endif  // StyleRareNonInheritedData_h