/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsFont_h___

#define nsFont_h___

#include <stdint.h>                     // for uint8_t, uint16_t

#include <sys/types.h>                  // for int16_t

#include "gfxFontFamilyList.h"

#include "gfxFontConstants.h"           // for NS_FONT_KERNING_AUTO, etc

#include "gfxFontFeatures.h"

#include "gfxFontVariations.h"

#include "mozilla/FontPropertyTypes.h"

#include "mozilla/RefPtr.h"             // for RefPtr

#include "nsColor.h"                    // for nsColor and NS_RGBA

#include "nsCoord.h"                    // for nscoord

#include "nsTArray.h"                   // for nsTArray

struct gfxFontStyle;

// IDs for generic fonts

// NOTE: 0, 1 are reserved for the special IDs of the default variable

// and fixed fonts in the presentation context, see nsPresContext.h

const uint8_t kGenericFont_NONE         = 0x00;

// Special

const uint8_t kGenericFont_moz_variable = 0x00; // for the default variable width font

const uint8_t kGenericFont_moz_fixed    = 0x01; // our special "use the user's fixed font"

// CSS

const uint8_t kGenericFont_serif        = 0x02;

const uint8_t kGenericFont_sans_serif   = 0x04;

const uint8_t kGenericFont_monospace    = 0x08;

const uint8_t kGenericFont_cursive      = 0x10;

const uint8_t kGenericFont_fantasy      = 0x20;

// Font structure.

struct nsFont {

  typedef mozilla::FontStretch FontStretch;

  typedef mozilla::FontSlantStyle FontSlantStyle;

  typedef mozilla::FontWeight FontWeight;

  // List of font families, either named or generic.

  // This contains a RefPtr and a uint32_t field.

  mozilla::FontFamilyList fontlist;

  // Font features from CSS font-feature-settings

  nsTArray<gfxFontFeature> fontFeatureSettings;

  // Font variations from CSS font-variation-settings

  nsTArray<gfxFontVariation> fontVariationSettings;

  // -- list of value tags for font-specific alternate features

  nsTArray<gfxAlternateValue> alternateValues;

  // -- object used to look these up once the font is matched

  RefPtr<gfxFontFeatureValueSet> featureValueLookup;

  // The logical size of the font, in nscoord units

  nscoord size = 0;

  // The aspect-value (ie., the ratio actualsize:actualxheight) that any

  // actual physical font created from this font structure must have when

  // rendering or measuring a string. A value of -1.0 means no adjustment

  // needs to be done; otherwise the value must be nonnegative.

  float sizeAdjust = -1.0f;

  // The estimated background color behind the text. Enables a special

  // rendering mode when NS_GET_A(.) > 0. Only used for text in the chrome.

  nscolor fontSmoothingBackgroundColor = NS_RGBA(0,0,0,0);

  // Language system tag, to override document language;

  // this is an OpenType "language system" tag represented as a 32-bit integer

  // (see http://www.microsoft.com/typography/otspec/languagetags.htm).

  uint32_t languageOverride = 0;

  // Font-selection/rendering properties corresponding to CSS font-style,

  // font-weight, font-stretch. These are all 16-bit types.

  FontSlantStyle style = FontSlantStyle::Normal();

  FontWeight weight = FontWeight::Normal();

  FontStretch stretch = FontStretch::Normal();

  // Some font-variant-alternates property values require

  // font-specific settings defined via @font-feature-values rules.

  // These are resolved *after* font matching occurs.

  // -- bitmask for both enumerated and functional propvals

  uint16_t variantAlternates = NS_FONT_VARIANT_ALTERNATES_NORMAL;

  // Variant subproperties

  uint16_t variantLigatures = NS_FONT_VARIANT_LIGATURES_NORMAL;

  uint16_t variantEastAsian = NS_FONT_VARIANT_EAST_ASIAN_NORMAL;

  uint8_t variantCaps = NS_FONT_VARIANT_CAPS_NORMAL;

  uint8_t variantNumeric = NS_FONT_VARIANT_NUMERIC_NORMAL;

  uint8_t variantPosition = NS_FONT_VARIANT_POSITION_NORMAL;

  uint8_t variantWidth = NS_FONT_VARIANT_WIDTH_NORMAL;

  // Smoothing - controls subpixel-antialiasing (currently OSX only)

  uint8_t smoothing = NS_FONT_SMOOTHING_AUTO;

  // Kerning

  uint8_t kerning = NS_FONT_KERNING_AUTO;

  // Whether automatic optical sizing should be applied to variation fonts

  // that include an 'opsz' axis

  uint8_t opticalSizing = NS_FONT_OPTICAL_SIZING_AUTO;

  // Synthesis setting, controls use of fake bolding/italics

  uint8_t synthesis = NS_FONT_SYNTHESIS_WEIGHT | NS_FONT_SYNTHESIS_STYLE;

  // Force this font to not be considered a 'generic' font, even if

  // the name is the same as a CSS generic font family.

  bool systemFont = false;

  // initialize the font with a fontlist

  nsFont(const mozilla::FontFamilyList& aFontlist, nscoord aSize);

  // initialize the font with a single generic

  nsFont(mozilla::FontFamilyType aGenericType, nscoord aSize);

  // Make a copy of the given font

  nsFont(const nsFont& aFont);

  // leave members uninitialized

  nsFont();

  ~nsFont();

  bool operator==(const nsFont& aOther) const {

    return Equals(aOther);

  }

  bool operator!=(const nsFont& aOther) const {

    return !Equals(aOther);

  }

  bool Equals(const nsFont& aOther) const;

  nsFont& operator=(const nsFont& aOther);

  enum class MaxDifference : uint8_t {

    eNone,

    eVisual,

    eLayoutAffecting

  };

  MaxDifference CalcDifference(const nsFont& aOther) const;

  void CopyAlternates(const nsFont& aOther);

  // Add featureSettings into style

  void AddFontFeaturesToStyle(gfxFontStyle *aStyle,

                              bool aVertical) const;

  void AddFontVariationsToStyle(gfxFontStyle *aStyle) const;

};

#define NS_FONT_VARIANT_NORMAL            0

#define NS_FONT_VARIANT_SMALL_CAPS        1

#endif /* nsFont_h___ */