xfa/fde/css/fde_css.h

// Copyright 2014 PDFium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com

#ifndef XFA_FDE_CSS_FDE_CSS_H_
#define XFA_FDE_CSS_FDE_CSS_H_

#include "core/fxge/fx_dib.h"
#include "xfa/fgas/crt/fgas_stream.h"
#include "xfa/fgas/crt/fgas_utils.h"
#include "xfa/fgas/font/cfgas_fontmgr.h"

class CFDE_CSSAccelerator;
class CFDE_CSSDeclaration;
class CFDE_CSSSelector;
class CXFA_CSSTagProvider;
class IFDE_CSSBoundaryStyle;
class IFDE_CSSComputedStyle;
class IFDE_CSSFontStyle;
class IFDE_CSSParagraphStyle;
class IFDE_CSSPositionStyle;
class IFDE_CSSRule;
class IFDE_CSSStyleSheet;
class IFDE_CSSValue;
class IFDE_CSSValueList;

#define FDE_CSSMEDIATYPE_Braille 0x01
#define FDE_CSSMEDIATYPE_Emboss 0x02
#define FDE_CSSMEDIATYPE_Handheld 0x04
#define FDE_CSSMEDIATYPE_Print 0x08
#define FDE_CSSMEDIATYPE_Projection 0x10
#define FDE_CSSMEDIATYPE_Screen 0x20
#define FDE_CSSMEDIATYPE_TTY 0x40
#define FDE_CSSMEDIATYPE_TV 0x80
#define FDE_CSSMEDIATYPE_ALL 0xFF

enum FDE_CSSVALUETYPE {
  FDE_CSSVALUETYPE_Primitive = 1 << 0,
  FDE_CSSVALUETYPE_List = 1 << 1,
  FDE_CSSVALUETYPE_Shorthand = 1 << 2,
  // Note the values below this comment must be > 0x0F so we can mask the above.
  FDE_CSSVALUETYPE_MaybeNumber = 1 << 4,
  FDE_CSSVALUETYPE_MaybeEnum = 1 << 5,
  FDE_CSSVALUETYPE_MaybeURI = 1 << 6,
  FDE_CSSVALUETYPE_MaybeString = 1 << 7,
  FDE_CSSVALUETYPE_MaybeColor = 1 << 8,
  FDE_CSSVALUETYPE_MaybeFunction = 1 << 9
};

enum class FDE_CSSPrimitiveType : uint8_t {
  Unknown = 0,
  Number,
  Percent,
  EMS,
  EXS,
  Pixels,
  CentiMeters,
  MilliMeters,
  Inches,
  Points,
  Picas,
  String,
  URI,
  RGB,
  Enum,
  Function,
};

enum class FDE_CSSPropertyValue : uint8_t {
  Bolder = 0,
  LowerLatin,
  Lowercase,
  LowerGreek,
  Sesame,
  None,
  NwResize,
  WResize,
  Dot,
  End,
  Ltr,
  Pre,
  Rtl,
  Sub,
  Top,
  Visible,
  Filled,
  SwResize,
  NoRepeat,
  Default,
  Transparent,
  Ridge,
  Right,
  HorizontalTb,
  DistributeLetter,
  DoubleCircle,
  Ruby,
  Collapse,
  Normal,
  Avoid,
  UpperRoman,
  Auto,
  Text,
  XSmall,
  Thin,
  Repeat,
  Small,
  NeResize,
  NoContent,
  Outside,
  EResize,
  TableRow,
  Bottom,
  Underline,
  CjkIdeographic,
  SeResize,
  Fixed,
  Double,
  Solid,
  RubyBaseGroup,
  OpenQuote,
  Lighter,
  LowerRoman,
  Strict,
  TableCaption,
  Oblique,
  Decimal,
  Loose,
  Hebrew,
  Hidden,
  Dashed,
  Embed,
  TableRowGroup,
  TableColumn,
  Static,
  Outset,
  DecimalLeadingZero,
  KeepWords,
  KatakanaIroha,
  Super,
  Center,
  TableHeaderGroup,
  Inside,
  XxLarge,
  Triangle,
  RubyTextGroup,
  Circle,
  Hiragana,
  RepeatX,
  RepeatY,
  Move,
  HiraganaIroha,
  RubyBase,
  Scroll,
  Smaller,
  TableFooterGroup,
  Baseline,
  Separate,
  Armenian,
  Open,
  Relative,
  Thick,
  Justify,
  Middle,
  Always,
  DistributeSpace,
  LineEdge,
  PreWrap,
  Medium,
  NResize,
  ListItem,
  Show,
  Currentcolor,
  NoCloseQuote,
  VerticalLr,
  VerticalRl,
  Pointer,
  XxSmall,
  Bold,
  Both,
  SmallCaps,
  Katakana,
  After,
  Horizontal,
  Dotted,
  Disc,
  Georgian,
  Inline,
  Overline,
  Wait,
  BreakAll,
  UpperAlpha,
  Capitalize,
  Nowrap,
  TextBottom,
  NoOpenQuote,
  Groove,
  Progress,
  Larger,
  CloseQuote,
  TableCell,
  PreLine,
  Absolute,
  InlineTable,
  BidiOverride,
  InlineBlock,
  Inset,
  Crosshair,
  UpperLatin,
  Help,
  Hide,
  Uppercase,
  SResize,
  Table,
  Blink,
  Block,
  Start,
  TableColumnGroup,
  Italic,
  LineThrough,
  KeepAll,
  LowerAlpha,
  RunIn,
  Square,
  XLarge,
  Large,
  Before,
  Left,
  TextTop,
  RubyText,
  NoDisplay
};

enum class FDE_CSSProperty : uint8_t {
  WritingMode,
  ColumnRuleWidth,
  BorderLeft,
  ColumnRule,
  Height,
  CounterReset,
  Content,
  RubyPosition,
  BackgroundColor,
  Width,
  Src,
  Top,
  Margin,
  BorderColor,
  Widows,
  BorderBottomColor,
  TextIndent,
  Right,
  TextEmphasisStyle,
  PaddingLeft,
  ColumnWidth,
  MarginLeft,
  Border,
  BorderTop,
  RubyOverhang,
  PageBreakBefore,
  MaxHeight,
  MinWidth,
  BorderLeftColor,
  Bottom,
  Quotes,
  MaxWidth,
  PaddingRight,
  ListStyleImage,
  WhiteSpace,
  BorderBottom,
  ListStyleType,
  WordBreak,
  OverflowX,
  OverflowY,
  BorderTopColor,
  FontFamily,
  Cursor,
  RubyAlign,
  ColumnRuleColor,
  FontWeight,
  BorderRightStyle,
  MinHeight,
  Color,
  LetterSpacing,
  EmptyCells,
  TextAlign,
  RubySpan,
  Position,
  BorderStyle,
  BorderBottomStyle,
  BorderCollapse,
  ColumnCount,
  BorderRightWidth,
  UnicodeBidi,
  VerticalAlign,
  PaddingTop,
  Columns,
  Overflow,
  TableLayout,
  FontVariant,
  ListStyle,
  BackgroundPosition,
  BorderWidth,
  TextEmphasisColor,
  BorderLeftStyle,
  PageBreakInside,
  TextEmphasis,
  BorderBottomWidth,
  ColumnGap,
  Orphans,
  BorderRight,
  FontSize,
  PageBreakAfter,
  CaptionSide,
  BackgroundRepeat,
  BorderTopStyle,
  BorderSpacing,
  TextTransform,
  FontStyle,
  Font,
  LineHeight,
  MarginRight,
  Float,
  BorderLeftWidth,
  Display,
  Clear,
  ColumnRuleStyle,
  TextCombine,
  ListStylePosition,
  Visibility,
  PaddingBottom,
  BackgroundAttachment,
  BackgroundImage,
  LineBreak,
  Background,
  BorderTopWidth,
  WordSpacing,
  BorderRightColor,
  CounterIncrement,
  Left,
  TextDecoration,
  Padding,
  MarginBottom,
  MarginTop,
  Direction
};

enum class FDE_CSSPseudo : uint8_t { After, Before, NONE };

enum class FDE_CSSSelectorType : uint8_t {
  Element = 0,
  Descendant,
  Class,
  Pseudo,
  ID,
};

enum class FDE_CSSRuleType : uint8_t { Style, Media, FontFace };

enum class FDE_CSSSyntaxStatus : uint8_t {
  Error,
  EOS,
  None,
  Charset,
  ImportRule,
  ImportClose,
  PageRule,
  StyleRule,
  FontFaceRule,
  MediaRule,
  MediaType,
  URI,
  Selector,
  DeclOpen,
  DeclClose,
  PropertyName,
  PropertyValue,
};

enum class FDE_CSSLengthUnit : uint8_t {
  Auto,
  None,
  Normal,
  Point,
  Percent,
};

enum class FDE_CSSDisplay : uint8_t {
  None,
  ListItem,
  Block,
  Inline,
  InlineBlock,
  InlineTable,
};

enum class FDE_CSSFontStyle : uint8_t {
  Normal,
  Italic,
};

enum class FDE_CSSTextAlign : uint8_t {
  Left,
  Right,
  Center,
  Justify,
  JustifyAll,
};

enum class FDE_CSSVerticalAlign : uint8_t {
  Baseline,
  Sub,
  Super,
  Top,
  TextTop,
  Middle,
  Bottom,
  TextBottom,
  Number,
};

enum class FDE_CSSFontVariant : uint8_t {
  Normal,
  SmallCaps,
};

enum FDE_CSSTEXTDECORATION {
  FDE_CSSTEXTDECORATION_None = 0,
  FDE_CSSTEXTDECORATION_Underline = 1 << 0,
  FDE_CSSTEXTDECORATION_Overline = 1 << 1,
  FDE_CSSTEXTDECORATION_LineThrough = 1 << 2,
  FDE_CSSTEXTDECORATION_Blink = 1 << 3,
  FDE_CSSTEXTDECORATION_Double = 1 << 4,
};

enum class FDE_CSSStyleSheetGroup : uint8_t {
  UserAgent = 0,
  User,
  Author,
};

enum class FDE_CSSStyleSheetPriority : uint8_t {
  High = 0,
  Mid,
  Low,
};

class IFDE_CSSValue {
 public:
  virtual ~IFDE_CSSValue() {}
  virtual FDE_CSSVALUETYPE GetType() const = 0;
};

class IFDE_CSSPrimitiveValue : public IFDE_CSSValue {
 public:
  // IFDE_CSSValue
  FDE_CSSVALUETYPE GetType() const override;

  virtual FDE_CSSPrimitiveType GetPrimitiveType() const = 0;
  virtual FX_ARGB GetRGBColor() const = 0;
  virtual FX_FLOAT GetFloat() const = 0;
  virtual const FX_WCHAR* GetString(int32_t& iLength) const = 0;
  virtual FDE_CSSPropertyValue GetEnum() const = 0;
  virtual const FX_WCHAR* GetFuncName() const = 0;
  virtual int32_t CountArgs() const = 0;
  virtual IFDE_CSSValue* GetArgs(int32_t index) const = 0;
};

class IFDE_CSSValueList : public IFDE_CSSValue {
 public:
  // IFDE_CSSValue
  FDE_CSSVALUETYPE GetType() const override;

  virtual int32_t CountValues() const = 0;
  virtual IFDE_CSSValue* GetValue(int32_t index) const = 0;
};

class IFDE_CSSRule {
 public:
  virtual ~IFDE_CSSRule() {}
  virtual FDE_CSSRuleType GetType() const = 0;
};

class IFDE_CSSStyleRule : public IFDE_CSSRule {
 public:
  // IFDE_CSSValue
  FDE_CSSRuleType GetType() const override;

  virtual int32_t CountSelectorLists() const = 0;
  virtual CFDE_CSSSelector* GetSelectorList(int32_t index) const = 0;
  virtual CFDE_CSSDeclaration* GetDeclaration() = 0;
};

class IFDE_CSSMediaRule : public IFDE_CSSRule {
 public:
  // IFDE_CSSValue
  FDE_CSSRuleType GetType() const override;

  virtual uint32_t GetMediaList() const = 0;
  virtual int32_t CountRules() const = 0;
  virtual IFDE_CSSRule* GetRule(int32_t index) = 0;
};

class IFDE_CSSFontFaceRule : public IFDE_CSSRule {
 public:
  // IFDE_CSSValue
  FDE_CSSRuleType GetType() const override;

  virtual CFDE_CSSDeclaration* GetDeclaration() = 0;
};

class IFDE_CSSStyleSheet : public IFX_Retainable {
 public:
  static IFDE_CSSStyleSheet* LoadHTMLStandardStyleSheet();
  static IFDE_CSSStyleSheet* LoadFromStream(
      const CFX_WideString& szUrl,
      const CFX_RetainPtr<IFGAS_Stream>& pStream,
      uint16_t wCodePage,
      uint32_t dwMediaList = FDE_CSSMEDIATYPE_ALL);
  static IFDE_CSSStyleSheet* LoadFromBuffer(
      const CFX_WideString& szUrl,
      const FX_WCHAR* pBuffer,
      int32_t iBufSize,
      uint16_t wCodePage,
      uint32_t dwMediaList = FDE_CSSMEDIATYPE_ALL);
  virtual bool GetUrl(CFX_WideString& szUrl) = 0;
  virtual uint32_t GetMediaList() const = 0;
  virtual uint16_t GetCodePage() const = 0;

  virtual int32_t CountRules() const = 0;
  virtual IFDE_CSSRule* GetRule(int32_t index) = 0;
};

struct FDE_CSSLENGTH {
  FDE_CSSLENGTH() {}

  explicit FDE_CSSLENGTH(FDE_CSSLengthUnit eUnit) : m_unit(eUnit) {}

  FDE_CSSLENGTH(FDE_CSSLengthUnit eUnit, FX_FLOAT fValue)
      : m_unit(eUnit), m_fValue(fValue) {}

  FDE_CSSLENGTH& Set(FDE_CSSLengthUnit eUnit) {
    m_unit = eUnit;
    return *this;
  }

  FDE_CSSLENGTH& Set(FDE_CSSLengthUnit eUnit, FX_FLOAT fValue) {
    m_unit = eUnit;
    m_fValue = fValue;
    return *this;
  }

  FDE_CSSLengthUnit GetUnit() const { return m_unit; }

  FX_FLOAT GetValue() const { return m_fValue; }
  bool NonZero() const { return static_cast<int>(m_fValue) != 0; }

 private:
  FDE_CSSLengthUnit m_unit;
  FX_FLOAT m_fValue;
};

struct FDE_CSSRECT {
  FDE_CSSRECT() {}

  FDE_CSSRECT(FDE_CSSLengthUnit eUnit, FX_FLOAT val)
      : left(eUnit, val),
        top(eUnit, val),
        right(eUnit, val),
        bottom(eUnit, val) {}

  FDE_CSSRECT& Set(FDE_CSSLengthUnit eUnit) {
    left.Set(eUnit);
    top.Set(eUnit);
    right.Set(eUnit);
    bottom.Set(eUnit);
    return *this;
  }
  FDE_CSSRECT& Set(FDE_CSSLengthUnit eUnit, FX_FLOAT fValue) {
    left.Set(eUnit, fValue);
    top.Set(eUnit, fValue);
    right.Set(eUnit, fValue);
    bottom.Set(eUnit, fValue);
    return *this;
  }

  FDE_CSSLENGTH left, top, right, bottom;
};

class IFDE_CSSFontStyle {
 public:
  virtual ~IFDE_CSSFontStyle() {}

  virtual int32_t CountFontFamilies() const = 0;
  virtual const FX_WCHAR* GetFontFamily(int32_t index) const = 0;
  virtual uint16_t GetFontWeight() const = 0;
  virtual FDE_CSSFontVariant GetFontVariant() const = 0;
  virtual FDE_CSSFontStyle GetFontStyle() const = 0;
  virtual FX_FLOAT GetFontSize() const = 0;
  virtual FX_ARGB GetColor() const = 0;
  virtual void SetFontWeight(uint16_t wFontWeight) = 0;
  virtual void SetFontVariant(FDE_CSSFontVariant eFontVariant) = 0;
  virtual void SetFontStyle(FDE_CSSFontStyle eFontStyle) = 0;
  virtual void SetFontSize(FX_FLOAT fFontSize) = 0;
  virtual void SetColor(FX_ARGB dwFontColor) = 0;
};

class IFDE_CSSBoundaryStyle {
 public:
  virtual ~IFDE_CSSBoundaryStyle() {}

  virtual const FDE_CSSRECT* GetBorderWidth() const = 0;
  virtual const FDE_CSSRECT* GetMarginWidth() const = 0;
  virtual const FDE_CSSRECT* GetPaddingWidth() const = 0;
  virtual void SetMarginWidth(const FDE_CSSRECT& rect) = 0;
  virtual void SetPaddingWidth(const FDE_CSSRECT& rect) = 0;
};

class IFDE_CSSPositionStyle {
 public:
  virtual ~IFDE_CSSPositionStyle() {}
  virtual FDE_CSSDisplay GetDisplay() const = 0;
};

class IFDE_CSSParagraphStyle {
 public:
  virtual ~IFDE_CSSParagraphStyle() {}

  virtual FX_FLOAT GetLineHeight() const = 0;
  virtual const FDE_CSSLENGTH& GetTextIndent() const = 0;
  virtual FDE_CSSTextAlign GetTextAlign() const = 0;
  virtual FDE_CSSVerticalAlign GetVerticalAlign() const = 0;
  virtual FX_FLOAT GetNumberVerticalAlign() const = 0;
  virtual uint32_t GetTextDecoration() const = 0;
  virtual const FDE_CSSLENGTH& GetLetterSpacing() const = 0;
  virtual void SetLineHeight(FX_FLOAT fLineHeight) = 0;
  virtual void SetTextIndent(const FDE_CSSLENGTH& textIndent) = 0;
  virtual void SetTextAlign(FDE_CSSTextAlign eTextAlign) = 0;
  virtual void SetNumberVerticalAlign(FX_FLOAT fAlign) = 0;
  virtual void SetTextDecoration(uint32_t dwTextDecoration) = 0;
  virtual void SetLetterSpacing(const FDE_CSSLENGTH& letterSpacing) = 0;
};

class IFDE_CSSComputedStyle : public IFX_Retainable {
 public:
  virtual IFDE_CSSFontStyle* GetFontStyles() = 0;
  virtual IFDE_CSSBoundaryStyle* GetBoundaryStyles() = 0;
  virtual IFDE_CSSPositionStyle* GetPositionStyles() = 0;
  virtual IFDE_CSSParagraphStyle* GetParagraphStyles() = 0;
  virtual bool GetCustomStyle(const CFX_WideStringC& wsName,
                              CFX_WideString& wsValue) const = 0;
};

#endif  // XFA_FDE_CSS_FDE_CSS_H_