/* otf.h -- Header file for libotf (OpenType font library).

Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010

  National Institute of Advanced Industrial Science and Technology (AIST)

  Registration Number H15PRO167

This file is part of libotf.

Libotf is free software; you can redistribute it and/or modify it

under the terms of the GNU Lesser General Public License as published

by the Free Software Foundation; either version 2.1 of the License, or

(at your option) any later version.

Libotf 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 Lesser General Public

License for more details.

You should have received a copy of the GNU Lesser General Public

License along with this library, in a file named COPYING; if not,

write to the Free Software Foundation, Inc., 59 Temple Place, Suite

330, Boston, MA 02111-1307, USA.  */

#ifndef _OTF_H_

#define _OTF_H_

#ifdef __cplusplus

extern "C" {

#endif

/* Version name of this library.  */

#define LIBOTF_VERSION "0.9.12"

/* Major version number.  */

#define LIBOTF_MAJOR_VERSION 0

/* Minor version number.  */

#define LIBOTF_MINOR_VERSION 9

/* Release (i.e. patch level) number.  */

#define LIBOTF_RELEASE_NUMBER 12

/***

    Table of contents:

    (1) Structures for OTF Layout tables and OTF itself

    (1-1) Basic types

    (1-2) "head" table

    (1-3) "name" table

    (1-4) "cmap" table

    (1-5) Structures common to GDEF, GSUB, and GPOS

    (1-6) "GDEF" table

    (1-7) Structures for ScriptList, FeatureList, and LookupList

    (1-8) Structures common to GSUB and GPOS

    (1-9) "GSUB" table

    (1-10) "GPOS" table

    (1-11) Structure for OTF

    (2) API for reading OTF

    (2-1) OTF_open(), OTF_open_ft_face()

    (2-2) OTF_close()

    (2-3) OTF_get_table()

    (2-4) OTF_check_table()

    (3) API for driving OTF

    (3-1) Structure for glyph string

    (3-2) OTF_drive_cmap()

    (3-3) OTF_drive_gdef()

    (3-4) OTF_drive_gsub()

    (3-5) OTF_drive_gpos()

    (3-6) OTF_drive_tables()

    (3-7) OTF_get_unicode()

    (3-8) OTF_drive_gsub_alternate()

    (3-9) OTF_iterate_on_feature()

    (4) API for error handling

    (4-1) Error codes

    (4-2) OTF_perror()

    (5) API miscellaneous

*/

/*** (1) Structures for OTF Layout tables and OTF itself */

/*** (1-1) Basic types */

typedef unsigned OTF_Tag;

typedef unsigned OTF_GlyphID;

typedef unsigned OTF_Offset;

typedef struct

{

  unsigned high;

  unsigned low;

} OTF_Fixed;

/*** (1-2) "head" table */

typedef struct

{

  OTF_Fixed TableVersionNumber;

  OTF_Fixed fontRevision;

  unsigned checkSumAdjustment;

  unsigned magicNumber;

  unsigned flags;

  int unitsPerEm;

} OTF_head;

/*** (1-3) "name" table */

typedef struct

{

  int platformID;

  int encodingID;

  int languageID;

  int nameID;

  int length;

  int offset;

  /* If nonzero, NAME is an ASCII string.  */

  int ascii;

  unsigned char *name;

} OTF_NameRecord;

#define OTF_max_nameID 23

typedef struct

{

  int format;

  int count;

  int stringOffset;

  OTF_NameRecord *nameRecord;

  char *name[OTF_max_nameID + 1];

} OTF_name;

/*** (1-4) "cmap" table */

typedef struct

{

  unsigned char glyphIdArray[256];

} OTF_EncodingSubtable0;

typedef struct

{

  unsigned firstCode;

  unsigned entryCount;

  int idDelta;

  unsigned idRangeOffset;

} OTF_cmapSubHeader;

typedef struct

{

  unsigned short subHeaderKeys[256];

  int subHeaderCount;

  OTF_cmapSubHeader *subHeaders;

  int glyphIndexCount;

  OTF_GlyphID *glyphIndexArray;

} OTF_EncodingSubtable2;

typedef struct

{

  unsigned startCount;

  unsigned endCount;

  int idDelta;

  unsigned idRangeOffset;

} OTF_cmapSegment;

typedef struct

{

  unsigned segCountX2;

  unsigned searchRange;

  unsigned entrySelector;

  unsigned rangeShift;

  OTF_cmapSegment *segments;

  int GlyphCount;

  unsigned *glyphIdArray;

} OTF_EncodingSubtable4;

typedef struct

{

  unsigned firstCode;

  unsigned entryCount;

  unsigned *glyphIdArray;

} OTF_EncodingSubtable6;

typedef struct

{

  unsigned startCharCode;

  unsigned endCharCode;

  unsigned startGlyphID;

} OTF_cmapGroup;

typedef struct

{

  unsigned char is32[8192];

  unsigned nGroups;

  OTF_cmapGroup *Groups;

} OTF_EncodingSubtable8;

typedef struct

{

  unsigned startCharCode;

  unsigned numChars;

  unsigned *glyphs;

} OTF_EncodingSubtable10;

typedef struct

{

  unsigned nGroups;

  OTF_cmapGroup *Groups;

} OTF_EncodingSubtable12;

typedef struct

{

  unsigned unicodeValue;

  unsigned short glyphID;

} OTF_UVSMapping;

typedef struct

{

  unsigned startUnicodeValue;

  unsigned short additionalCount;

} OTF_UnicodeValueRange;

typedef struct

{

  unsigned varSelector;

  unsigned defaultUVSOffset;

  unsigned nonDefaultUVSOffset;

  /* DefaultUVS */

  unsigned numUnicodeValueRanges;

  OTF_UnicodeValueRange *unicodeValueRanges;

  /* NonDefaultUVS */

  unsigned numUVSMappings;

  OTF_UVSMapping *uvsMappings;

} OTF_VariationSelectorRecord;

typedef struct

{

  unsigned nRecords;

  OTF_VariationSelectorRecord *Records;

} OTF_EncodingSubtable14;

typedef struct

{

  unsigned format;

  unsigned length;

  unsigned language;

  union {

    OTF_EncodingSubtable0 *f0;

    OTF_EncodingSubtable2 *f2;

    OTF_EncodingSubtable4 *f4;

    OTF_EncodingSubtable6 *f6;

    OTF_EncodingSubtable8 *f8;

    OTF_EncodingSubtable10 *f10;

    OTF_EncodingSubtable12 *f12;

    OTF_EncodingSubtable14 *f14;

  }f;

} OTF_EncodingSubtable;

typedef struct

{

  unsigned platformID;

  unsigned encodingID;

  unsigned offset;

  OTF_EncodingSubtable subtable;

} OTF_EncodingRecord;

typedef struct

{

  unsigned version;

  unsigned numTables;

  OTF_EncodingRecord *EncodingRecord;

  /* Mapping table: Unicode->GlyphID (for BMP only) */

  unsigned short *unicode_table;

  /* Maximum Glyph ID that corresponds to a Unicode character.  */

  int max_glyph_id;

  /* Mapping table: GlyphID->Unicode */

  unsigned short *decode_table;

  /* Index of the EncodingRecord for Unicode->GlyphID mapping.

     -1 means that the font supports only Unicode BMP characters.  */

  int table_index;

} OTF_cmap;

/*** (1-5) Structures common to GDEF, GSUB, GPOS */

typedef struct

{

  OTF_GlyphID Start;

  OTF_GlyphID End;

  unsigned StartCoverageIndex;

} OTF_RangeRecord;

typedef struct

{

  OTF_Offset offset;

  unsigned CoverageFormat;

  unsigned Count;

  union {

    OTF_GlyphID *GlyphArray;

    OTF_RangeRecord *RangeRecord;

  } table;

} OTF_Coverage;

typedef struct

{

  OTF_Offset offset;

  unsigned StartSize;

  unsigned EndSize;

  unsigned DeltaFormat;

  char *DeltaValue;

} OTF_DeviceTable;

typedef struct

{

  OTF_GlyphID Start;

  OTF_GlyphID End;

  unsigned Class;

} OTF_ClassRangeRecord;

typedef struct

{

  OTF_Offset offset;

  unsigned ClassFormat;

  union {

    struct {

      OTF_GlyphID StartGlyph;

      unsigned GlyphCount;

      unsigned *ClassValueArray;

    } f1;

    struct {

      unsigned ClassRangeCount;

      OTF_ClassRangeRecord *ClassRangeRecord;

    } f2;

  } f;

} OTF_ClassDef;

/*** (1-6) "GDEF" table */

typedef struct

{

  OTF_Fixed Version;

  OTF_Offset GlyphClassDef;

  OTF_Offset AttachList;

  OTF_Offset LigCaretList;

  OTF_Offset MarkAttachClassDef;

} OTF_GDEFHeader;

enum OTF_GlyphClassDef

  {

    OTF_GlyphClass0 = 0,

    OTF_GlyphClassBase = 1,

    OTF_GlyphClassLigature = 2,

    OTF_GlyphClassMark = 3,

    OTF_GlyphClassComponent = 4

  };

typedef struct

{

  OTF_Offset offset;

  unsigned PointCount;

  unsigned *PointIndex;

} OTF_AttachPoint;

typedef struct

{

  OTF_Coverage Coverage;

  unsigned GlyphCount;

  OTF_AttachPoint *AttachPoint;

} OTF_AttachList;

typedef struct

{

  OTF_Offset offset;

  unsigned CaretValueFormat;	/* 1, 2, or 3 */

  union {

    union {

      int Coordinate;

    } f1;

    union {

      unsigned CaretValuePoint;

    } f2;

    union {

      int Coordinate;

      OTF_DeviceTable DeviceTable;

    } f3;

  } f;

} OTF_CaretValue;

typedef struct

{

  OTF_Offset offset;

  unsigned CaretCount;

  OTF_CaretValue *CaretValue;

} OTF_LigGlyph;

typedef struct

{

  OTF_Coverage Coverage;

  unsigned LigGlyphCount;

  OTF_LigGlyph *LigGlyph;

} OTF_LigCaretList;

typedef struct

{

  OTF_GDEFHeader header;

  OTF_ClassDef glyph_class_def;

  OTF_AttachList attach_list;

  OTF_LigCaretList lig_caret_list;

  OTF_ClassDef mark_attach_class_def;

} OTF_GDEF;

/*** (1-7) Structures for ScriptList, FeatureList, and LookupList  */

/*** The structure hierarchy

   ScriptList

     ScriptRecord[]

       ScriptTag

     Script[]

       DefaultLangSys

       LangSysRecord[]

         LangSysTag

       LangSys[]

         LookupOrder

	 ReqFeatureIndex

	 FeatureIndex[]

  FeatureList

    FeatureRecored[]

      FeatureTag

    Feature[]

      FeatureParams

      LookupListIndex[]

  LookupList

    LookupOffset[]

    Lookup[]

      LookupType

      LookupFlag

      SubTableOffset[]

      SubTable.gsub[] or SubTable.gpos[]

*/

typedef struct

{

  OTF_Offset LookupOrder;

  unsigned ReqFeatureIndex;

  unsigned FeatureCount;

  unsigned *FeatureIndex;

} OTF_LangSys;

typedef struct

{

  OTF_Tag LangSysTag;

  OTF_Offset LangSys;

} OTF_LangSysRecord;

typedef struct

{

  OTF_Tag ScriptTag;

  OTF_Offset offset;

  OTF_Offset DefaultLangSysOffset;

  OTF_LangSys DefaultLangSys;

  unsigned LangSysCount;

  OTF_LangSysRecord *LangSysRecord;

  OTF_LangSys *LangSys;

} OTF_Script;

typedef struct

{

  OTF_Offset offset;

  unsigned ScriptCount;

  OTF_Script *Script;

} OTF_ScriptList;

typedef struct

{

  OTF_Tag FeatureTag;

  OTF_Offset offset;

  OTF_Offset FeatureParams;

  unsigned LookupCount;

  unsigned *LookupListIndex;

} OTF_Feature;

typedef struct

{

  OTF_Offset offset;

  unsigned FeatureCount;

  OTF_Feature *Feature;

} OTF_FeatureList;

typedef struct OTF_LookupSubTableGSUB OTF_LookupSubTableGSUB;

typedef struct OTF_LookupSubTableGPOS OTF_LookupSubTableGPOS;

enum OTF_LookupFlagBit

  {

    OTF_RightToLeft = 0x0001,

    OTF_IgnoreBaseGlyphs = 0x0002,

    OTF_IgnoreLigatures = 0x0004,

    OTF_IgnoreMarks = 0x0008,

    OTF_Reserved = 0x00F0,

    OTF_MarkAttachmentType = 0xFF00

  };

#define OTF_LookupFlagIgnoreMask \

  (OTF_IgnoreBaseGlyphs | OTF_IgnoreLigatures | OTF_IgnoreMarks)

typedef struct

{

  OTF_Offset offset;

  unsigned LookupType;

  unsigned LookupFlag;

  unsigned SubTableCount;

  OTF_Offset *SubTableOffset;

  union {

    OTF_LookupSubTableGSUB *gsub;

    OTF_LookupSubTableGPOS *gpos;

  } SubTable;

} OTF_Lookup;

typedef struct

{

  OTF_Offset offset;

  unsigned LookupCount;

  OTF_Lookup *Lookup;

} OTF_LookupList;

/*** (1-8) Structures common to GSUB and GPOS */

/* For SubstLookupRecord (GSUB) and PosLookupRecord (GPOS).  */

typedef struct

{

  unsigned SequenceIndex;

  unsigned LookupListIndex;

} OTF_LookupRecord;

typedef struct

{

  OTF_Offset offset;

  unsigned GlyphCount;

  unsigned LookupCount;

  OTF_GlyphID *Input;		/* [<GlyphCount> - 1] */

  OTF_LookupRecord *LookupRecord; /* [<LookupCount>] */

} OTF_Rule;

typedef struct

{

  OTF_Offset offset;

  unsigned RuleCount;

  OTF_Rule *Rule;		/* [<RuleCount>] */

} OTF_RuleSet;

typedef struct

{

  OTF_Offset offset;

  unsigned GlyphCount;

  unsigned LookupCount;

  unsigned *Class;		/* [<GlyphCount> - 1] */

  OTF_LookupRecord *LookupRecord; /* [<LookupCount>] */

} OTF_ClassRule;

typedef struct

{

  OTF_Offset offset;

  unsigned ClassRuleCnt;

  OTF_ClassRule *ClassRule;	/* [<ClassRuleCnt>] */

} OTF_ClassSet;

typedef struct

{

  OTF_Offset offset;

  unsigned BacktrackGlyphCount;

  OTF_GlyphID *Backtrack;

  unsigned InputGlyphCount;

  OTF_GlyphID *Input;

  unsigned LookaheadGlyphCount;

  OTF_GlyphID *LookAhead;

  unsigned LookupCount;

  OTF_LookupRecord *LookupRecord;

} OTF_ChainRule;

typedef struct

{

  OTF_Offset offset;

  unsigned ChainRuleCount;

  OTF_ChainRule *ChainRule;

} OTF_ChainRuleSet;

typedef struct

{

  OTF_Offset offset;

  unsigned BacktrackGlyphCount;

  unsigned *Backtrack;

  unsigned InputGlyphCount;

  unsigned *Input;

  unsigned LookaheadGlyphCount;

  unsigned *LookAhead;

  unsigned LookupCount;

  OTF_LookupRecord *LookupRecord;

} OTF_ChainClassRule;

typedef struct

{

  OTF_Offset offset;

  unsigned ChainClassRuleCnt;

  OTF_ChainClassRule *ChainClassRule;

} OTF_ChainClassSet;

/* Common to OTF_GSUB/GPOS_Context1/2/3.  */

typedef struct

{

  unsigned RuleSetCount;

  OTF_RuleSet *RuleSet;		/* [<RuleSetCount>] */

} OTF_Context1;

typedef struct

{

  OTF_ClassDef ClassDef;

  unsigned ClassSetCnt;

  OTF_ClassSet *ClassSet;	/* [<ClassSetCnt>] */

} OTF_Context2;

typedef struct

{

  unsigned GlyphCount;

  unsigned LookupCount;

  OTF_Coverage *Coverage;	/* [<GlyphCount>] */

  OTF_LookupRecord *LookupRecord; /* [<LookupCount>] */

} OTF_Context3;

/* Common to OTF_GSUB/GPOS_ChainContext1/2/3.  */

typedef struct

{

  unsigned ChainRuleSetCount;

  OTF_ChainRuleSet *ChainRuleSet;

} OTF_ChainContext1;

typedef struct

{

  OTF_ClassDef BacktrackClassDef;

  OTF_ClassDef InputClassDef;

  OTF_ClassDef LookaheadClassDef;

  unsigned ChainClassSetCnt;

  OTF_ChainClassSet *ChainClassSet;

} OTF_ChainContext2;

typedef struct

{

  unsigned BacktrackGlyphCount;

  OTF_Coverage *Backtrack;

  unsigned InputGlyphCount;

  OTF_Coverage *Input;

  unsigned LookaheadGlyphCount;

  OTF_Coverage *LookAhead;

  unsigned LookupCount;

  OTF_LookupRecord *LookupRecord;

} OTF_ChainContext3;

/* Common to OTF_GSUB/GPOS.  */

typedef struct

{

  OTF_Fixed Version;

  OTF_ScriptList ScriptList;

  OTF_FeatureList FeatureList;

  OTF_LookupList LookupList;

} OTF_GSUB_GPOS;

/*** (1-9) "GSUB" table */

typedef struct

{

  int DeltaGlyphID;

} OTF_GSUB_Single1;

typedef struct

{

  unsigned GlyphCount;

  OTF_GlyphID *Substitute;

} OTF_GSUB_Single2;

typedef struct OTF_Sequence OTF_Sequence;

typedef struct

{

  unsigned SequenceCount;

  OTF_Sequence *Sequence;

} OTF_GSUB_Multiple1;

struct OTF_Sequence

{

  OTF_Offset offset;

  unsigned GlyphCount;

  OTF_GlyphID *Substitute;

};

typedef struct OTF_AlternateSet OTF_AlternateSet;

typedef struct

{

  unsigned AlternateSetCount;

  OTF_AlternateSet *AlternateSet;

} OTF_GSUB_Alternate1;

struct OTF_AlternateSet

{

  OTF_Offset offset;

  unsigned GlyphCount;

  OTF_GlyphID *Alternate;

};

typedef struct OTF_LigatureSet OTF_LigatureSet;

typedef struct OTF_Ligature OTF_Ligature;

typedef struct

{

  unsigned LigSetCount;

  OTF_LigatureSet *LigatureSet;

} OTF_GSUB_Ligature1;

struct OTF_LigatureSet

{

  OTF_Offset offset;

  unsigned LigatureCount;

  OTF_Ligature *Ligature;

};

struct OTF_Ligature

{

  OTF_Offset offset;

  OTF_GlyphID LigGlyph;

  unsigned CompCount;

  OTF_GlyphID *Component;

};

typedef OTF_Context1 OTF_GSUB_Context1;

typedef OTF_Context2 OTF_GSUB_Context2;

typedef OTF_Context3 OTF_GSUB_Context3;

typedef OTF_ChainContext1 OTF_GSUB_ChainContext1;

typedef OTF_ChainContext2 OTF_GSUB_ChainContext2;

typedef OTF_ChainContext3 OTF_GSUB_ChainContext3;

typedef struct

{

  unsigned ExtensionLookupType;

  unsigned ExtensionOffset;

  OTF_LookupSubTableGSUB *ExtensionSubtable;

} OTF_GSUB_Extension1;

typedef struct

{

  unsigned BacktrackGlyphCount;

  OTF_Coverage *Backtrack;

  unsigned LookaheadGlyphCount;

  OTF_Coverage *LookAhead;

  unsigned GlyphCount;

  OTF_GlyphID *Substitute;

} OTF_GSUB_ReverseChain1;

struct OTF_LookupSubTableGSUB

{

  unsigned Format;

  OTF_Coverage Coverage;

  union {

    /* LookupType 1 */

    OTF_GSUB_Single1 single1;

    OTF_GSUB_Single2 single2;

    /* LookupType 2 */

    OTF_GSUB_Multiple1 multiple1;

    /* LookupType 3 */

    OTF_GSUB_Alternate1 alternate1;

    /* LookupType 4 */

    OTF_GSUB_Ligature1 ligature1;

    /* LookupType 5 */

    OTF_GSUB_Context1 context1;

    OTF_GSUB_Context2 context2;

    OTF_GSUB_Context3 context3;

    /* LookupType 6 */

    OTF_GSUB_ChainContext1 chain_context1;

    OTF_GSUB_ChainContext2 chain_context2;

    OTF_GSUB_ChainContext3 chain_context3;

    /* LookupType 7 */

    OTF_GSUB_Extension1 extension1;

    /* LookupType 8 */

    OTF_GSUB_ReverseChain1 reverse_chain1;

  } u;

};

typedef OTF_GSUB_GPOS OTF_GSUB;

/*** (1-10) "GPOS" table */

enum OTF_ValueFormat

  {

    OTF_XPlacement = 0x0001,

    OTF_YPlacement = 0x0002,

    OTF_XAdvance = 0x0004,

    OTF_YAdvance = 0x0008,

    OTF_XPlaDevice = 0x0010,

    OTF_YPlaDevice = 0x0020,

    OTF_XAdvDevice = 0x0040,

    OTF_YAdvDevice = 0x0080

  };

typedef struct

{

  int XPlacement;

  int YPlacement;

  int XAdvance;

  int YAdvance;

  OTF_DeviceTable XPlaDevice;

  OTF_DeviceTable YPlaDevice;

  OTF_DeviceTable XAdvDevice;

  OTF_DeviceTable YAdvDevice;

} OTF_ValueRecord;

typedef struct

{

  OTF_Offset offset;

  unsigned AnchorFormat;

  int XCoordinate;

  int YCoordinate;

  union {

    struct {

      unsigned AnchorPoint;

    } f1;

    struct {

      OTF_DeviceTable XDeviceTable;

      OTF_DeviceTable YDeviceTable;

    } f2;

  } f;

} OTF_Anchor;

typedef struct

{

  unsigned Class;

  OTF_Anchor MarkAnchor;

} OTF_MarkRecord;

typedef struct

{

  OTF_Offset offset;

  unsigned MarkCount;

  OTF_MarkRecord *MarkRecord;

} OTF_MarkArray;

typedef struct

{

  unsigned ValueFormat;

  OTF_ValueRecord Value;

} OTF_GPOS_Single1;

typedef struct

{

  unsigned ValueFormat;

  unsigned ValueCount;

  OTF_ValueRecord *Value;  	/* [<ValueCount>] */

} OTF_GPOS_Single2;

typedef struct

{