/***************************************************************************/
/* */
/*tttables.h */
/* */
/*Basic SFNT/TrueType tables definitions and interface */
/*(specification only).*/
/* */
/*Copyright 1996-2015 by */
/*David Turner, Robert Wilhelm, and Werner Lemberg.*/
/* */
/*This file is part of the FreeType project, and may only be used, */
/*modified, and distributed under the terms of the FreeType project*/
/*license, LICENSE.TXT.By continuing to use, modify, or distribute */
/*this file you indicate that you have read the license and*/
/*understand and accept it fully.*/
/* */
/***************************************************************************/
#ifndef __TTTABLES_H__
#define __TTTABLES_H__
#include
#include FT_FREETYPE_H
#ifdef FREETYPE_H
#error “freetype.h of FreeType 1 has been loaded!”
#error “Please fix the directory search order for header files”
#error “so that freetype.h of FreeType 2 is found first.”
#endif
FT_BEGIN_HEADER
/*************************************************************************/
/* */
/*
/*truetype_tables*/
/* */
/*
/*************************************************************************/
/* */
/*
/*TT_Header*/
/* */
/*
/*A structure used to model a TrueType font header table.All */
/*fields follow the TrueType specification.*/
/* */
typedef structTT_Header_
{
FT_Fixed Table_Version;
FT_Fixed Font_Revision;
FT_LongCheckSum_Adjust;
FT_LongMagic_Number;
FT_UShortFlags;
FT_UShortUnits_Per_EM;
FT_LongCreated [2];
FT_LongModified[2];
FT_Short xMin;
FT_Short yMin;
FT_Short xMax;
FT_Short yMax;
FT_UShortMac_Style;
FT_UShortLowest_Rec_PPEM;
FT_Short Font_Direction;
FT_Short Index_To_Loc_Format;
FT_Short Glyph_Data_Format;
} TT_Header;
/*************************************************************************/
/* */
/*
/*TT_HoriHeader*/
/* */
/*
/*A structure used to model a TrueType horizontal header, the `hhea’ */
/*table, as well as the corresponding horizontal metrics table,*/
/*i.e., the `hmtx’ table.*/
/* */
/*
/*Version:: The table version. */
/* */
/*Ascender :: The font’s ascender, i.e., the distance*/
/*from the baseline to the top-most of all */
/*glyph points found in the font.*/
/* */
/*This value is invalid in many fonts, as*/
/*it is usually set by the font designer,*/
/*and often reflects only a portion of the */
/*glyphs found in the font (maybe ASCII).*/
/* */
/*You should use the `sTypoAscender’ field */
/*of the OS/2 table instead if you want*/
/*the correct one. */
/* */
/*Descender:: The font’s descender, i.e., the distance */
/*from the baseline to the bottom-most of*/
/*all glyph points found in the font.It*/
/*is negative. */
/* */
/*This value is invalid in many fonts, as*/
/*it is usually set by the font designer,*/
/*and often reflects only a portion of the */
/*glyphs found in the font (maybe ASCII).*/
/* */
/*You should use the `sTypoDescender’*/
/*field of the OS/2 table instead if you */
/*want the correct one.*/
/* */
/*Line_Gap :: The font’s line gap, i.e., the distance*/
/*to add to the ascender and descender to*/
/*get the BTB, i.e., the */
/*baseline-to-baseline distance for the*/
/*font.*/
/* */
/*advance_Width_Max:: This field is the maximum of all advance */
/*widths found in the font.It can be */
/*used to compute the maximum width of an*/
/*arbitrary string of text.*/
/* */
/*min_Left_Side_Bearing:: The minimum left side bearing of all */
/*glyphs within the font.*/
/* */
/*min_Right_Side_Bearing :: The minimum right side bearing of all*/
/*glyphs within the font.*/
/* */
/*xMax_Extent:: The maximum horizontal extent (i.e., the */
/*`width’ of a glyph’s bounding box) for */
/*all glyphs in the font.*/
/* */
/*caret_Slope_Rise :: The rise coefficient of the cursor’s */
/*slope of the cursor (slope=rise/run).*/
/* */
/*caret_Slope_Run:: The run coefficient of the cursor’s*/
/*slope. */
/* */
/*Reserved :: 8~reserved bytes.*/
/* */
/*metric_Data_Format :: Always~0.*/
/* */
/*number_Of_HMetrics :: Number of HMetrics entries in the `hmtx’ */
/*table — this value can be smaller than*/
/*the total number of glyphs in the font.*/
/* */
/*long_metrics :: A pointer into the `hmtx’ table. */
/* */
/*short_metrics:: A pointer into the `hmtx’ table. */
/* */
/*
/*IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should */
/* be identical except for the names of their fields,*/
/* which are different.*/
/* */
/* This ensures that a single function in the `ttload’ */
/* module is able to read both the horizontal and vertical */
/* headers.*/
/* */
typedef structTT_HoriHeader_
{
FT_Fixed Version;
FT_Short Ascender;
FT_Short Descender;
FT_Short Line_Gap;
FT_UShortadvance_Width_Max;/* advance width maximum */
FT_Short min_Left_Side_Bearing;/* minimum left-sb */
FT_Short min_Right_Side_Bearing; /* minimum right-sb*/
FT_Short xMax_Extent;/* xmax extents*/
FT_Short caret_Slope_Rise;
FT_Short caret_Slope_Run;
FT_Short caret_Offset;
FT_Short Reserved[4];
FT_Short metric_Data_Format;
FT_UShortnumber_Of_HMetrics;
/* The following fields are not defined by the TrueType specification */
/* but they are used to connect the metrics header to the relevant*/
/* `HMTX’ table.*/
void*long_metrics;
void*short_metrics;
} TT_HoriHeader;
/*************************************************************************/
/* */
/*
/*TT_VertHeader*/
/* */
/*
/*A structure used to model a TrueType vertical header, the `vhea’ */
/*table, as well as the corresponding vertical metrics table, i.e.,*/
/*the `vmtx’ table.*/
/* */
/*
/*Version :: The table version.*/
/* */
/*Ascender:: The font’s ascender, i.e., the distance */
/* from the baseline to the top-most of*/
/* all glyph points found in the font. */
/* */
/* This value is invalid in many fonts, as */
/* it is usually set by the font designer, */
/* and often reflects only a portion of*/
/* the glyphs found in the font (maybe */
/* ASCII). */
/* */
/* You should use the `sTypoAscender’*/
/* field of the OS/2 table instead if you*/
/* want the correct one. */
/* */
/*Descender :: The font’s descender, i.e., the */
/* distance from the baseline to the */
/* bottom-most of all glyph points found */
/* in the font.It is negative. */
/* */
/* This value is invalid in many fonts, as */
/* it is usually set by the font designer, */
/* and often reflects only a portion of*/
/* the glyphs found in the font (maybe */
/* ASCII). */
/* */
/* You should use the `sTypoDescender’ */
/* field of the OS/2 table instead if you*/
/* want the correct one. */
/* */
/*Line_Gap:: The font’s line gap, i.e., the distance */
/* to add to the ascender and descender to */
/* get the BTB, i.e., the*/
/* baseline-to-baseline distance for the */
/* font. */
/* */
/*advance_Height_Max:: This field is the maximum of all*/
/* advance heights found in the font.It*/
/* can be used to compute the maximum*/
/* height of an arbitrary string of text.*/
/* */
/*min_Top_Side_Bearing:: The minimum top side bearing of all */
/* glyphs within the font. */
/* */
/*min_Bottom_Side_Bearing :: The minimum bottom side bearing of all*/
/* glyphs within the font. */
/* */
/*yMax_Extent :: The maximum vertical extent (i.e., the*/
/* `height’ of a glyph’s bounding box) for */
/* all glyphs in the font. */
/* */
/*caret_Slope_Rise:: The rise coefficient of the cursor’s*/
/* slope of the cursor (slope=rise/run). */
/* */
/*caret_Slope_Run :: The run coefficient of the cursor’s */
/* slope.*/
/* */
/*caret_Offset:: The cursor’s offset for slanted fonts.*/
/* This value is `reserved’ in vmtx*/
/* version 1.0.*/
/* */
/*Reserved:: 8~reserved bytes. */
/* */
/*metric_Data_Format:: Always~0. */
/* */
/*number_Of_HMetrics:: Number of VMetrics entries in the */
/* `vmtx’ table — this value can be */
/* smaller than the total number of glyphs */
/* in the font.*/
/* */
/*long_metrics :: A pointer into the `vmtx’ table. */
/* */
/*short_metrics:: A pointer into the `vmtx’ table. */
/* */
/*
/*IMPORTANT: The TT_HoriHeader and TT_VertHeader structures should */
/* be identical except for the names of their fields,*/
/* which are different.*/
/* */
/* This ensures that a single function in the `ttload’ */
/* module is able to read both the horizontal and vertical */
/* headers.*/
/* */
typedef structTT_VertHeader_
{
FT_Fixed Version;
FT_Short Ascender;
FT_Short Descender;
FT_Short Line_Gap;
FT_UShortadvance_Height_Max;/* advance height maximum */
FT_Short min_Top_Side_Bearing;/* minimum left-sb or top-sb */
FT_Short min_Bottom_Side_Bearing; /* minimum right-sb or bottom-sb */
FT_Short yMax_Extent; /* xmax or ymax extents*/
FT_Short caret_Slope_Rise;
FT_Short caret_Slope_Run;
FT_Short caret_Offset;
FT_Short Reserved[4];
FT_Short metric_Data_Format;
FT_UShortnumber_Of_VMetrics;
/* The following fields are not defined by the TrueType specification */
/* but they’re used to connect the metrics header to the relevant */
/* `HMTX’ or `VMTX’ table.*/
void*long_metrics;
void*short_metrics;
} TT_VertHeader;
/*************************************************************************/
/* */
/*
/*TT_OS2 */
/* */
/*
/*A structure used to model a TrueType OS/2 table.All fields */
/*comply to the OpenType specification.*/
/* */
/*Note that we now support old Mac fonts that do not include an OS/2 */
/*table.In this case, the `version’ field is always set to 0xFFFF. */
/* */
typedef structTT_OS2_
{
FT_UShortversion;/* 0x0001 – more or 0xFFFF */
FT_Short xAvgCharWidth;
FT_UShortusWeightClass;
FT_UShortusWidthClass;
FT_UShortfsType;
FT_Short ySubscriptXSize;
FT_Short ySubscriptYSize;
FT_Short ySubscriptXOffset;
FT_Short ySubscriptYOffset;
FT_Short ySuperscriptXSize;
FT_Short ySuperscriptYSize;
FT_Short ySuperscriptXOffset;
FT_Short ySuperscriptYOffset;
FT_Short yStrikeoutSize;
FT_Short yStrikeoutPosition;
FT_Short sFamilyClass;
FT_Bytepanose[10];
FT_ULong ulUnicodeRange1;/* Bits 0-31 */
FT_ULong ulUnicodeRange2;/* Bits 32-63*/
FT_ULong ulUnicodeRange3;/* Bits 64-95*/
FT_ULong ulUnicodeRange4;/* Bits 96-127 */
FT_CharachVendID[4];
FT_UShortfsSelection;
FT_UShortusFirstCharIndex;
FT_UShortusLastCharIndex;
FT_Short sTypoAscender;
FT_Short sTypoDescender;
FT_Short sTypoLineGap;
FT_UShortusWinAscent;
FT_UShortusWinDescent;
/* only version 1 and higher: */
FT_ULong ulCodePageRange1; /* Bits 0-31 */
FT_ULong ulCodePageRange2; /* Bits 32-63*/
/* only version 2 and higher: */
FT_Short sxHeight;
FT_Short sCapHeight;
FT_UShortusDefaultChar;
FT_UShortusBreakChar;
FT_UShortusMaxContext;
/* only version 5 and higher: */
FT_UShortusLowerOpticalPointSize; /* in twips (1/20th points) */
FT_UShortusUpperOpticalPointSize; /* in twips (1/20th points) */
} TT_OS2;
/*************************************************************************/
/* */
/*
/*TT_Postscript*/
/* */
/*
/*A structure used to model a TrueType PostScript table.All fields */
/*comply to the TrueType specification.This structure does not */
/*reference the PostScript glyph names, which can be nevertheless*/
/*accessed with the `ttpost’ module. */
/* */
typedef structTT_Postscript_
{
FT_FixedFormatType;
FT_FixeditalicAngle;
FT_ShortunderlinePosition;
FT_ShortunderlineThickness;
FT_ULongisFixedPitch;
FT_ULongminMemType42;
FT_ULongmaxMemType42;
FT_ULongminMemType1;
FT_ULongmaxMemType1;
/* Glyph names follow in the file, but we don’t */
/* load them by default.See the ttpost.c file.*/
} TT_Postscript;
/*************************************************************************/
/* */
/*
/*TT_PCLT*/
/* */
/*
/*A structure used to model a TrueType PCLT table.All fields */
/*comply to the TrueType specification.*/
/* */
typedef structTT_PCLT_
{
FT_Fixed Version;
FT_ULong FontNumber;
FT_UShortPitch;
FT_UShortxHeight;
FT_UShortStyle;
FT_UShortTypeFamily;
FT_UShortCapHeight;
FT_UShortSymbolSet;
FT_CharTypeFace[16];
FT_CharCharacterComplement[8];
FT_CharFileName[6];
FT_CharStrokeWeight;
FT_CharWidthType;
FT_ByteSerifStyle;
FT_ByteReserved;
} TT_PCLT;
/*************************************************************************/
/* */
/*
/*TT_MaxProfile*/
/* */
/*
/*The maximum profile is a table containing many max values, which */
/*can be used to pre-allocate arrays.This ensures that no memory */
/*allocation occurs during a glyph load. */
/* */
/*
/*version :: The version number. */
/* */
/*numGlyphs :: The number of glyphs in this TrueType */
/* font. */
/* */
/*maxPoints :: The maximum number of points in a */
/* non-composite TrueType glyph.See also */
/* the structure element */
/* `maxCompositePoints’. */
/* */
/*maxContours :: The maximum number of contours in a */
/* non-composite TrueType glyph.See also */
/* the structure element */
/* `maxCompositeContours’. */
/* */
/*maxCompositePoints:: The maximum number of points in a */
/* composite TrueType glyph.See also the */
/* structure element `maxPoints’.*/
/* */
/*maxCompositeContours:: The maximum number of contours in a */
/* composite TrueType glyph.See also the */
/* structure element `maxContours’.*/
/* */
/*maxZones:: The maximum number of zones used for*/
/* glyph hinting.*/
/* */
/*maxTwilightPoints :: The maximum number of points in the */
/* twilight zone used for glyph hinting. */
/* */
/*maxStorage:: The maximum number of elements in the */
/* storage area used for glyph hinting.*/
/* */
/*maxFunctionDefs :: The maximum number of function*/
/* definitions in the TrueType bytecode for*/
/* this font.*/
/* */
/*maxInstructionDefs:: The maximum number of instruction */
/* definitions in the TrueType bytecode for*/
/* this font.*/
/* */
/*maxStackElements:: The maximum number of stack elements used */
/* during bytecode interpretation. */
/* */
/*maxSizeOfInstructions :: The maximum number of TrueType opcodes*/
/* used for glyph hinting. */
/* */
/*maxComponentElements:: The maximum number of simple (i.e., non-*/
/* composite) glyphs in a composite glyph. */
/* */
/*maxComponentDepth :: The maximum nesting depth of composite*/
/* glyphs. */
/* */
/*
/*This structure is only used during font loading. */
/* */
typedef structTT_MaxProfile_
{
FT_Fixed version;
FT_UShortnumGlyphs;
FT_UShortmaxPoints;
FT_UShortmaxContours;
FT_UShortmaxCompositePoints;
FT_UShortmaxCompositeContours;
FT_UShortmaxZones;
FT_UShortmaxTwilightPoints;
FT_UShortmaxStorage;
FT_UShortmaxFunctionDefs;
FT_UShortmaxInstructionDefs;
FT_UShortmaxStackElements;
FT_UShortmaxSizeOfInstructions;
FT_UShortmaxComponentElements;
FT_UShortmaxComponentDepth;
} TT_MaxProfile;
/*************************************************************************/
/* */
/*
/*FT_Sfnt_Tag*/
/* */
/*
/*An enumeration used to specify the index of an SFNT table. */
/*Used in the @FT_Get_Sfnt_Table API function. */
/* */
/*
/*FT_SFNT_HEAD :: To access the font’s @TT_Header structure. */
/* */
/*FT_SFNT_MAXP :: To access the font’s @TT_MaxProfile structure. */
/* */
/*FT_SFNT_OS2:: To access the font’s @TT_OS2 structure.*/
/* */
/*FT_SFNT_HHEA :: To access the font’s @TT_HoriHeader structure. */
/* */
/*FT_SFNT_VHEA :: To access the font’s @TT_VertHeader struture.*/
/* */
/*FT_SFNT_POST :: To access the font’s @TT_Postscript structure. */
/* */
/*FT_SFNT_PCLT :: To access the font’s @TT_PCLT structure. */
/* */
typedef enumFT_Sfnt_Tag_
{
FT_SFNT_HEAD,
FT_SFNT_MAXP,
FT_SFNT_OS2,
FT_SFNT_HHEA,
FT_SFNT_VHEA,
FT_SFNT_POST,
FT_SFNT_PCLT,
FT_SFNT_MAX
} FT_Sfnt_Tag;
/* these constants are deprecated; use the corresponding `FT_Sfnt_Tag’ */
/* values instead*/
#define ft_sfnt_headFT_SFNT_HEAD
#define ft_sfnt_maxpFT_SFNT_MAXP
#define ft_sfnt_os2 FT_SFNT_OS2
#define ft_sfnt_hheaFT_SFNT_HHEA
#define ft_sfnt_vheaFT_SFNT_VHEA
#define ft_sfnt_postFT_SFNT_POST
#define ft_sfnt_pcltFT_SFNT_PCLT
/*************************************************************************/
/* */
/*
/*FT_Get_Sfnt_Table*/
/* */
/*
/*Return a pointer to a given SFNT table within a face.*/
/* */
/**/
/*face :: A handle to the source.*/
/* */
/*tag:: The index of the SFNT table. */
/* */
/*
/*A type-less pointer to the table.This will be~0 in case of */
/*error, or if the corresponding table was not found *OR* loaded */
/*from the file. */
/* */
/*Use a typecast according to `tag’ to access the structure*/
/*elements.*/
/* */
/*
/*The table is owned by the face object and disappears with it.*/
/* */
/*This function is only useful to access SFNT tables that are loaded */
/*by the sfnt, truetype, and opentype drivers.See @FT_Sfnt_Tag for */
/*a list.*/
/* */
/*Here an example how to access the `vhea’ table:*/
/* */
/*{*/
/*TT_VertHeader*vert_header; */
/* */
/* */
/*vert_header =*/
/*(TT_VertHeader*)FT_Get_Sfnt_Table( face, FT_SFNT_VHEA ); */
/*}*/
/* */
FT_EXPORT( void* )
FT_Get_Sfnt_Table( FT_Faceface,
FT_Sfnt_Tagtag );
/**************************************************************************
*
* @function:
* FT_Load_Sfnt_Table
*
* @description:
* Load any font table into client memory.
*
* @input:
* face ::
* A handle to the source face.
*
* tag ::
* The four-byte tag of the table to load.Use the value~0 if you want
* to access the whole font file.Otherwise, you can use one of the
* definitions found in the @FT_TRUETYPE_TAGS_H file, or forge a new
* one with @FT_MAKE_TAG.
*
* offset ::
* The starting offset in the table (or file if tag == 0).
*
* @output:
* buffer ::
* The target buffer address.The client must ensure that the memory
* array is big enough to hold the data.
*
* @inout:
* length ::
* If the `length’ parameter is NULL, then try to load the whole table.
* Return an error code if it fails.
*
* Else, if `*length’ is~0, exit immediately while returning the
* table’s (or file) full size in it.
*
* Else the number of bytes to read from the table or file, from the
* starting offset.
*
* @return:
* FreeType error code.0~means success.
*
* @note:
* If you need to determine the table’s length you should first call this
* function with `*length’ set to~0, as in the following example:
*
* {
* FT_ULonglength = 0;
*
*
* error = FT_Load_Sfnt_Table( face, tag, 0, NULL, &length );
* if ( error ) { … table does not exist … }
*
* buffer = malloc( length );
* if ( buffer == NULL ) { … not enough memory … }
*
* error = FT_Load_Sfnt_Table( face, tag, 0, buffer, &length );
* if ( error ) { … could not load table … }
* }
*
* Note that structures like @TT_Header or @TT_OS2 can’t be used with
* this function; they are limited to @FT_Get_Sfnt_Table.Reason is that
* those structures depend on the processor architecture, with varying
* size (e.g. 32bit vs. 64bit) or order (big endian vs. little endian).
*
*/
FT_EXPORT( FT_Error )
FT_Load_Sfnt_Table( FT_Faceface,
FT_ULong tag,
FT_Longoffset,
FT_Byte* buffer,
FT_ULong*length );
/**************************************************************************
*
* @function:
* FT_Sfnt_Table_Info
*
* @description:
* Return information on an SFNT table.
*
* @input:
* face ::
* A handle to the source face.
*
* table_index ::
* The index of an SFNT table.The function returns
* FT_Err_Table_Missing for an invalid value.
*
* @inout:
* tag ::
* The name tag of the SFNT table.If the value is NULL, `table_index’
* is ignored, and `length’ returns the number of SFNT tables in the
* font.
*
* @output:
* length ::
* The length of the SFNT table (or the number of SFNT tables, depending
* on `tag’).
*
* @return:
* FreeType error code.0~means success.
*
* @note:
* While parsing fonts, FreeType handles SFNT tables with length zero as
* missing.
*
*/
FT_EXPORT( FT_Error )
FT_Sfnt_Table_Info( FT_Faceface,
FT_UInttable_index,
FT_ULong*tag,
FT_ULong*length );
/*************************************************************************/
/* */
/*
/*FT_Get_CMap_Language_ID*/
/* */
/*
/*Return TrueType/sfnt specific cmap language ID.Definitions of*/
/*language ID values are in `ttnameid.h’.*/
/* */
/**/
/*charmap :: */
/*The target charmap.*/
/* */
/*
/*The language ID of `charmap’.If `charmap’ doesn’t belong to a*/
/*TrueType/sfnt face, just return~0 as the default value.*/
/* */
/*For a format~14 cmap (to access Unicode IVS), the return value is*/
/*0xFFFFFFFF.*/
/* */
FT_EXPORT( FT_ULong )
FT_Get_CMap_Language_ID( FT_CharMapcharmap );
/*************************************************************************/
/* */
/*
/*FT_Get_CMap_Format */
/* */
/*
/*Return TrueType/sfnt specific cmap format. */
/* */
/**/
/*charmap :: */
/*The target charmap.*/
/* */
/*
/*The format of `charmap’.If `charmap’ doesn’t belong to a */
/*TrueType/sfnt face, return -1. */
/* */
FT_EXPORT( FT_Long )
FT_Get_CMap_Format( FT_CharMapcharmap );
/* */
FT_END_HEADER
#endif /* __TTTABLES_H__ */
/* END */
Reviews
There are no reviews yet.