/*

 * Copyright © 2007,2008,2009  Red Hat, Inc.

 * Copyright © 2010,2011,2012  Google, Inc.

 *

 *  This is part of HarfBuzz, a text shaping library.

 *

 * Permission is hereby granted, without written agreement and without

 * license or royalty fees, to use, copy, modify, and distribute this

 * software and its documentation for any purpose, provided that the

 * above copyright notice and the following two paragraphs appear in

 * all copies of this software.

 *

 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR

 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES

 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN

 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH

 * DAMAGE.

 *

 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,

 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS

 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO

 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

 *

 * Red Hat Author(s): Behdad Esfahbod

 * Google Author(s): Behdad Esfahbod

 */

#ifndef HB_OT_LAYOUT_GDEF_TABLE_HH

#define HB_OT_LAYOUT_GDEF_TABLE_HH

#include "hb-ot-layout-common-private.hh"

#include "hb-font-private.hh"

namespace OT {

/*

 * Attachment List Table

 */

typedef ArrayOf<USHORT> AttachPoint;    /* Array of contour point indices--in

                                         * increasing numerical order */

struct AttachList

{

  inline unsigned int get_attach_points (hb_codepoint_t glyph_id,

                                         unsigned int start_offset,

                                         unsigned int *point_count /* IN/OUT */,

                                         unsigned int *point_array /* OUT */) const

  {

    unsigned int index = (this+coverage).get_coverage (glyph_id);

    if (index == NOT_COVERED)

    {

      if (point_count)

        *point_count = 0;

      return 0;

    }

    const AttachPoint &points = this+attachPoint[index];

    if (point_count) {

      const USHORT *array = points.sub_array (start_offset, point_count);

      unsigned int count = *point_count;

      for (unsigned int i = 0; i < count; i++)

        point_array[i] = array[i];

    }

    return points.len;

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (coverage.sanitize (c, this) && attachPoint.sanitize (c, this));

  }

  protected:

  OffsetTo<Coverage>

                coverage;               /* Offset to Coverage table -- from

                                         * beginning of AttachList table */

  OffsetArrayOf<AttachPoint>

                attachPoint;            /* Array of AttachPoint tables

                                         * in Coverage Index order */

  public:

  DEFINE_SIZE_ARRAY (4, attachPoint);

};

/*

 * Ligature Caret Table

 */

struct CaretValueFormat1

{

  friend struct CaretValue;

  private:

  inline hb_position_t get_caret_value (hb_font_t *font, hb_direction_t direction, hb_codepoint_t glyph_id HB_UNUSED) const

  {

    return HB_DIRECTION_IS_HORIZONTAL (direction) ? font->em_scale_x (coordinate) : font->em_scale_y (coordinate);

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (c->check_struct (this));

  }

  protected:

  USHORT        caretValueFormat;       /* Format identifier--format = 1 */

  SHORT         coordinate;             /* X or Y value, in design units */

  public:

  DEFINE_SIZE_STATIC (4);

};

struct CaretValueFormat2

{

  friend struct CaretValue;

  private:

  inline hb_position_t get_caret_value (hb_font_t *font, hb_direction_t direction, hb_codepoint_t glyph_id) const

  {

    hb_position_t x, y;

    if (font->get_glyph_contour_point_for_origin (glyph_id, caretValuePoint, direction, &x, &y))

      return HB_DIRECTION_IS_HORIZONTAL (direction) ? x : y;

    else

      return 0;

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (c->check_struct (this));

  }

  protected:

  USHORT        caretValueFormat;       /* Format identifier--format = 2 */

  USHORT        caretValuePoint;        /* Contour point index on glyph */

  public:

  DEFINE_SIZE_STATIC (4);

};

struct CaretValueFormat3

{

  friend struct CaretValue;

  inline hb_position_t get_caret_value (hb_font_t *font, hb_direction_t direction, hb_codepoint_t glyph_id HB_UNUSED) const

  {

    return HB_DIRECTION_IS_HORIZONTAL (direction) ?

           font->em_scale_x (coordinate) + (this+deviceTable).get_x_delta (font) :

           font->em_scale_y (coordinate) + (this+deviceTable).get_y_delta (font);

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (c->check_struct (this) && deviceTable.sanitize (c, this));

  }

  protected:

  USHORT        caretValueFormat;       /* Format identifier--format = 3 */

  SHORT         coordinate;             /* X or Y value, in design units */

  OffsetTo<Device>

                deviceTable;            /* Offset to Device table for X or Y

                                         * value--from beginning of CaretValue

                                         * table */

  public:

  DEFINE_SIZE_STATIC (6);

};

struct CaretValue

{

  inline hb_position_t get_caret_value (hb_font_t *font, hb_direction_t direction, hb_codepoint_t glyph_id) const

  {

    switch (u.format) {

    case 1: return u.format1.get_caret_value (font, direction, glyph_id);

    case 2: return u.format2.get_caret_value (font, direction, glyph_id);

    case 3: return u.format3.get_caret_value (font, direction, glyph_id);

    default:return 0;

    }

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    if (!u.format.sanitize (c)) return_trace (false);

    switch (u.format) {

    case 1: return_trace (u.format1.sanitize (c));

    case 2: return_trace (u.format2.sanitize (c));

    case 3: return_trace (u.format3.sanitize (c));

    default:return_trace (true);

    }

  }

  protected:

  union {

  USHORT                format;         /* Format identifier */

  CaretValueFormat1     format1;

  CaretValueFormat2     format2;

  CaretValueFormat3     format3;

  } u;

  public:

  DEFINE_SIZE_UNION (2, format);

};

struct LigGlyph

{

  inline unsigned int get_lig_carets (hb_font_t *font,

                                      hb_direction_t direction,

                                      hb_codepoint_t glyph_id,

                                      unsigned int start_offset,

                                      unsigned int *caret_count /* IN/OUT */,

                                      hb_position_t *caret_array /* OUT */) const

  {

    if (caret_count) {

      const OffsetTo<CaretValue> *array = carets.sub_array (start_offset, caret_count);

      unsigned int count = *caret_count;

      for (unsigned int i = 0; i < count; i++)

        caret_array[i] = (this+array[i]).get_caret_value (font, direction, glyph_id);

    }

    return carets.len;

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (carets.sanitize (c, this));

  }

  protected:

  OffsetArrayOf<CaretValue>

                carets;                 /* Offset array of CaretValue tables

                                         * --from beginning of LigGlyph table

                                         * --in increasing coordinate order */

  public:

  DEFINE_SIZE_ARRAY (2, carets);

};

struct LigCaretList

{

  inline unsigned int get_lig_carets (hb_font_t *font,

                                      hb_direction_t direction,

                                      hb_codepoint_t glyph_id,

                                      unsigned int start_offset,

                                      unsigned int *caret_count /* IN/OUT */,

                                      hb_position_t *caret_array /* OUT */) const

  {

    unsigned int index = (this+coverage).get_coverage (glyph_id);

    if (index == NOT_COVERED)

    {

      if (caret_count)

        *caret_count = 0;

      return 0;

    }

    const LigGlyph &lig_glyph = this+ligGlyph[index];

    return lig_glyph.get_lig_carets (font, direction, glyph_id, start_offset, caret_count, caret_array);

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (coverage.sanitize (c, this) && ligGlyph.sanitize (c, this));

  }

  protected:

  OffsetTo<Coverage>

                coverage;               /* Offset to Coverage table--from

                                         * beginning of LigCaretList table */

  OffsetArrayOf<LigGlyph>

                ligGlyph;               /* Array of LigGlyph tables

                                         * in Coverage Index order */

  public:

  DEFINE_SIZE_ARRAY (4, ligGlyph);

};

struct MarkGlyphSetsFormat1

{

  inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const

  { return (this+coverage[set_index]).get_coverage (glyph_id) != NOT_COVERED; }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (coverage.sanitize (c, this));

  }

  protected:

  USHORT        format;                 /* Format identifier--format = 1 */

  ArrayOf<OffsetTo<Coverage, ULONG> >

                coverage;               /* Array of long offsets to mark set

                                         * coverage tables */

  public:

  DEFINE_SIZE_ARRAY (4, coverage);

};

struct MarkGlyphSets

{

  inline bool covers (unsigned int set_index, hb_codepoint_t glyph_id) const

  {

    switch (u.format) {

    case 1: return u.format1.covers (set_index, glyph_id);

    default:return false;

    }

  }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    if (!u.format.sanitize (c)) return_trace (false);

    switch (u.format) {

    case 1: return_trace (u.format1.sanitize (c));

    default:return_trace (true);

    }

  }

  protected:

  union {

  USHORT                format;         /* Format identifier */

  MarkGlyphSetsFormat1  format1;

  } u;

  public:

  DEFINE_SIZE_UNION (2, format);

};

/*

 * GDEF -- The Glyph Definition Table

 */

struct GDEF

{

  static const hb_tag_t tableTag        = HB_OT_TAG_GDEF;

  enum GlyphClasses {

    UnclassifiedGlyph   = 0,

    BaseGlyph           = 1,

    LigatureGlyph       = 2,

    MarkGlyph           = 3,

    ComponentGlyph      = 4

  };

  inline bool has_glyph_classes (void) const { return glyphClassDef != 0; }

  inline unsigned int get_glyph_class (hb_codepoint_t glyph) const

  { return (this+glyphClassDef).get_class (glyph); }

  inline void get_glyphs_in_class (unsigned int klass, hb_set_t *glyphs) const

  { (this+glyphClassDef).add_class (glyphs, klass); }

  inline bool has_mark_attachment_types (void) const { return markAttachClassDef != 0; }

  inline unsigned int get_mark_attachment_type (hb_codepoint_t glyph) const

  { return (this+markAttachClassDef).get_class (glyph); }

  inline bool has_attach_points (void) const { return attachList != 0; }

  inline unsigned int get_attach_points (hb_codepoint_t glyph_id,

                                         unsigned int start_offset,

                                         unsigned int *point_count /* IN/OUT */,

                                         unsigned int *point_array /* OUT */) const

  { return (this+attachList).get_attach_points (glyph_id, start_offset, point_count, point_array); }

  inline bool has_lig_carets (void) const { return ligCaretList != 0; }

  inline unsigned int get_lig_carets (hb_font_t *font,

                                      hb_direction_t direction,

                                      hb_codepoint_t glyph_id,

                                      unsigned int start_offset,

                                      unsigned int *caret_count /* IN/OUT */,

                                      hb_position_t *caret_array /* OUT */) const

  { return (this+ligCaretList).get_lig_carets (font, direction, glyph_id, start_offset, caret_count, caret_array); }

  inline bool has_mark_sets (void) const { return version.to_int () >= 0x00010002u && markGlyphSetsDef[0] != 0; }

  inline bool mark_set_covers (unsigned int set_index, hb_codepoint_t glyph_id) const

  { return version.to_int () >= 0x00010002u && (this+markGlyphSetsDef[0]).covers (set_index, glyph_id); }

  inline bool sanitize (hb_sanitize_context_t *c) const

  {

    TRACE_SANITIZE (this);

    return_trace (version.sanitize (c) &&

                  likely (version.major == 1) &&

                  glyphClassDef.sanitize (c, this) &&

                  attachList.sanitize (c, this) &&

                  ligCaretList.sanitize (c, this) &&

                  markAttachClassDef.sanitize (c, this) &&

                  (version.to_int () < 0x00010002u || markGlyphSetsDef[0].sanitize (c, this)));

  }

  /* glyph_props is a 16-bit integer where the lower 8-bit have bits representing

   * glyph class and other bits, and high 8-bit gthe mark attachment type (if any).

   * Not to be confused with lookup_props which is very similar. */

  inline unsigned int get_glyph_props (hb_codepoint_t glyph) const

  {

    unsigned int klass = get_glyph_class (glyph);

    ASSERT_STATIC ((unsigned int) HB_OT_LAYOUT_GLYPH_PROPS_BASE_GLYPH == (unsigned int) LookupFlag::IgnoreBaseGlyphs);

    ASSERT_STATIC ((unsigned int) HB_OT_LAYOUT_GLYPH_PROPS_LIGATURE == (unsigned int) LookupFlag::IgnoreLigatures);

    ASSERT_STATIC ((unsigned int) HB_OT_LAYOUT_GLYPH_PROPS_MARK == (unsigned int) LookupFlag::IgnoreMarks);

    switch (klass) {

    default:                    return 0;

    case BaseGlyph:             return HB_OT_LAYOUT_GLYPH_PROPS_BASE_GLYPH;

    case LigatureGlyph:         return HB_OT_LAYOUT_GLYPH_PROPS_LIGATURE;

    case MarkGlyph:

          klass = get_mark_attachment_type (glyph);

          return HB_OT_LAYOUT_GLYPH_PROPS_MARK | (klass << 8);

    }

  }

  protected:

  FixedVersion  version;                /* Version of the GDEF table--currently

                                         * 0x00010002u */

  OffsetTo<ClassDef>

                glyphClassDef;          /* Offset to class definition table

                                         * for glyph type--from beginning of

                                         * GDEF header (may be Null) */

  OffsetTo<AttachList>

                attachList;             /* Offset to list of glyphs with

                                         * attachment points--from beginning

                                         * of GDEF header (may be Null) */

  OffsetTo<LigCaretList>

                ligCaretList;           /* Offset to list of positioning points

                                         * for ligature carets--from beginning

                                         * of GDEF header (may be Null) */

  OffsetTo<ClassDef>

                markAttachClassDef;     /* Offset to class definition table for

                                         * mark attachment type--from beginning

                                         * of GDEF header (may be Null) */

  OffsetTo<MarkGlyphSets>

                markGlyphSetsDef[VAR];  /* Offset to the table of mark set

                                         * definitions--from beginning of GDEF

                                         * header (may be NULL).  Introduced

                                         * in version 00010002. */

  public:

  DEFINE_SIZE_ARRAY (12, markGlyphSetsDef);

};

} /* namespace OT */

#endif /* HB_OT_LAYOUT_GDEF_TABLE_HH */