/*  GRAPHITE2 LICENSING

    Copyright 2010, SIL International
    All rights reserved.

    This library 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 License, or
    (at your option) any later version.

    This program 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 also have received a copy of the GNU Lesser General Public
    License along with this library in the file named "LICENSE".
    If not, write to the Free Software Foundation, 51 Franklin Street,
    Suite 500, Boston, MA 02110-1335, USA or visit their web page on the
    internet at http://www.fsf.org/licenses/lgpl.html.

Alternatively, the contents of this file may be used under the terms of the
Mozilla Public License (http://mozilla.org/MPL) or the GNU General Public
License, as published by the Free Software Foundation, either version 2
of the License or (at your option) any later version.
*/
#pragma once
/*--------------------------------------------------------------------*//*:Ignore this sentence.

File: TtfTypes.h
Responsibility: Tim Eves
Last reviewed: Not yet.

Description:
Provides types required to represent the TTF basic types.
-------------------------------------------------------------------------------*//*:End Ignore*/


//**********************************************************************************************
//  Include files
//**********************************************************************************************
namespace graphite2
{
namespace TtfUtil
{
//**********************************************************************************************
//  Forward declarations
//**********************************************************************************************


//**********************************************************************************************
//  Type declarations
//**********************************************************************************************
typedef unsigned char   uint8;
typedef uint8           byte;
typedef signed char     int8;
typedef unsigned short  uint16;
typedef short           int16;
typedef unsigned int    uint32;
typedef int             int32;

typedef int16   short_frac;
typedef int32   fixed;
typedef int16   fword;
typedef uint16  ufword;
typedef int16   f2dot14;
typedef uint32  long_date_time[2];

//**********************************************************************************************
//  Constants and enum types
//**********************************************************************************************/
enum
{
    OneFix = 1<<16
};

//**********************************************************************************************
//  Table declarations
//**********************************************************************************************
namespace Sfnt
{
#pragma pack(push,1) // We need this or the structure members aren't aligned
                        // correctly.  Fortunately this form of pragma is supposed
                        // to be recognised by VS C++ too (at least according to
                        // MSDN).

    struct OffsetSubTable
    {
        uint32  scaler_type;
        uint16  num_tables,
            search_range,
            entry_selector,
            range_shift;
        struct Entry
        {
            uint32  tag,
                checksum,
                offset,
                length;
        } table_directory[1];

        enum ScalerType
        {
            TrueTypeMac = 0x74727565U,
            TrueTypeWin = 0x00010000U,
            Type1   = 0x74797031U
        };
    };




    struct CharacterCodeMap
    {
        uint16  version,
            num_subtables;
        struct
        {
            uint16  platform_id,
                platform_specific_id;
            uint32  offset;
        } encoding[1];
    };

    struct CmapSubTable
    {
        uint16  format,
            length,
            language;
    };

    struct CmapSubTableFormat4 : CmapSubTable
    {
        uint16  seg_count_x2,
            search_range,
            entry_selector,
            range_shift,
            end_code[1];
        // There are arrarys after this which need their
        // start positions calculated since end_code is
        // seg_count uint16s long.
    };

    struct CmapSubTableFormat12
    {
        fixed   format;
        uint32  length,
            language,
            num_groups;
        struct
        {
            uint32  start_char_code,
                end_char_code,
                start_glyph_id;
        } group[1];
    };



    struct FontHeader
    {
        fixed   version,
            font_revision;
        uint32  check_sum_adjustment,
            magic_number;
        uint16  flags,
            units_per_em;
        long_date_time  created,
                modified;
        fword   x_min,
            y_min,
            x_max,
            y_max;
        uint16  mac_style,
            lowest_rec_ppem;
        int16   font_direction_hint,
            index_to_loc_format,
            glyph_data_format;
        enum
        {
            MagicNumber = 0x5F0F3CF5,
            GlypDataFormat = 0
        };
        enum {ShortIndexLocFormat, LongIndexLocFormat};
    };




    struct PostScriptGlyphName
    {
        fixed   format,
            italic_angle;
        fword   underline_position,
            underline_thickness;
        uint32  is_fixed_pitch,
            min_mem_type42,
            max_mem_type42,
            min_mem_type1,
            max_mem_type1;
        enum
        {
            Format1  = 0x10000,
            Format2  = 0x20000,
            Format25 = 0x28000,
            Format3  = 0x30000,
            Format4  = 0x40000
        };
    };

    struct PostScriptGlyphName2 : PostScriptGlyphName
    {
        uint16  number_of_glyphs,
            glyph_name_index[1];
    };

    struct PostScriptGlyphName25 : PostScriptGlyphName
    {
        uint16  number_of_glyphs;
        int8    offset[1];
    };

    struct PostScriptGlyphName3 : PostScriptGlyphName {};

    struct PostScriptGlyphName4 : PostScriptGlyphName
    {
        uint16 glyph_to_char_map[1];
    };


    struct HorizontalHeader
    {
        fixed   version;
        fword   ascent,
            descent,
            line_gap;
        ufword  advance_width_max;
        fword   min_left_side_bearing,
            max_left_side_bearing,
            x_max_element;
        int16   caret_slope_rise,
            caret_slope_run;
        fword   caret_offset;
        int16   reserved[4],
            metric_data_format;
        uint16  num_long_hor_metrics;
    };

    struct MaximumProfile
    {
        fixed   version;
        uint16  num_glyphs,
            max_points,
            max_contours,
            max_component_points,
            max_component_contours,
            max_zones,
            max_twilight_points,
            max_storage,
            max_function_defs,
            max_instruction_defs,
            max_stack_elements,
            max_size_of_instructions,
            max_component_elements,
            max_component_depth;
    };


    typedef byte    Panose[10];

    struct Compatibility0
    {
        uint16  version;
        int16   x_avg_char_width;
        uint16  weight_class,
            width_class;
        int16   fs_type,
            y_subscript_x_size,
            y_subscript_y_size,
            y_subscript_x_offset,
            y_subscript_y_offset,
            y_superscript_x_size,
            y_superscript_y_size,
            y_superscript_x_offset,
            y_superscript_y_offset,
            y_strikeout_size,
            y_strikeout_position,
            family_class;
        Panose  panose;
        uint32  unicode_range[4];
        int8    ach_vend_id[4];
        uint16  fs_selection,
            fs_first_char_index,
            fs_last_char_index, // Acording to Apple's spec this is where v0 should end
            typo_ascender,
            typo_descender,
            type_linegap,
            win_ascent,
            win_descent;

        enum
        {
            Italic    =0x01,
            Underscore=0x02,
            Negative  =0x04,
            Outlined  =0x08,
            StrikeOut =0x10,
            Bold      =0x20
        };
    };

    struct Compatibility1 : Compatibility0
    {
        uint32  codepage_range[2];
    };

    struct Compatibility2 : Compatibility1
    {
            int16   x_height,
                cap_height;
            uint16  default_char,
                break_char,
                max_context;
    };

    struct Compatibility3 : Compatibility2 {};

    typedef Compatibility3  Compatibility;


    struct NameRecord
    {
        uint16  platform_id,
            platform_specific_id,
            language_id,
            name_id,
            length,
            offset;
        enum    {Unicode, Mactintosh, Reserved, Microsoft};
        enum
        {
            Copyright, Family, Subfamily, UniqueSubfamily,
            Fullname, Version, PostScript
        };
    };

    struct LangTagRecord
    {
        uint16 length,
            offset;
    };

    struct FontNames
    {
        uint16  format,
            count,
            string_offset;
        NameRecord name_record[1];
    };


    struct HorizontalMetric
    {
        uint16  advance_width;
        int16   left_side_bearing;
    };


    struct Glyph
    {
        int16   number_of_contours;
        fword   x_min,
            y_min,
            x_max,
            y_max;
    };

    struct SimpleGlyph : Glyph
    {
        uint16  end_pts_of_contours[1];
        enum
        {
            OnCurve = 0x01,
            XShort  = 0x02,
            YShort  = 0x04,
            Repeat  = 0x08,
            XIsSame = 0x10,
            XIsPos  = 0x10,
            YIsSame = 0x20,
            YIsPos  = 0x20
        };
    };

    struct CompoundGlyph : Glyph
    {
        uint16  flags,
            glyph_index;
        enum
        {
            Arg1Arg2Words   = 0x01,
            ArgsAreXYValues = 0x02,
            RoundXYToGrid   = 0x04,
            HaveScale       = 0x08,
            MoreComponents  = 0x20,
            HaveXAndYScale  = 0x40,
            HaveTwoByTwo    = 0x80,
            HaveInstructions = 0x100,
            UseMyMetrics    = 0x200,
            OverlapCompund  = 0x400,
            ScaledOffset    = 0x800,
            UnscaledOffset  = 0x1000
        };
    };

#pragma pack(pop)
} // end of namespace Sfnt

} // end of namespace TtfUtil
} // end of namespace graphite2
