| /***************************************************************************/ |
| /* */ |
| /* ftsnames.h */ |
| /* */ |
| /* Simple interface to access SFNT name tables (which are used */ |
| /* to hold font names, copyright info, notices, etc.) (specification). */ |
| /* */ |
| /* This is _not_ used to retrieve glyph names! */ |
| /* */ |
| /* 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 __FT_SFNT_NAMES_H__ |
| #define __FT_SFNT_NAMES_H__ |
| |
| |
| #include <ft2build.h> |
| #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 |
| |
| |
| /*************************************************************************/ |
| /* */ |
| /* <Section> */ |
| /* sfnt_names */ |
| /* */ |
| /* <Title> */ |
| /* SFNT Names */ |
| /* */ |
| /* <Abstract> */ |
| /* Access the names embedded in TrueType and OpenType files. */ |
| /* */ |
| /* <Description> */ |
| /* The TrueType and OpenType specifications allow the inclusion of */ |
| /* a special `names table' in font files. This table contains */ |
| /* textual (and internationalized) information regarding the font, */ |
| /* like family name, copyright, version, etc. */ |
| /* */ |
| /* The definitions below are used to access them if available. */ |
| /* */ |
| /* Note that this has nothing to do with glyph names! */ |
| /* */ |
| /*************************************************************************/ |
| |
| |
| /*************************************************************************/ |
| /* */ |
| /* <Struct> */ |
| /* FT_SfntName */ |
| /* */ |
| /* <Description> */ |
| /* A structure used to model an SFNT `name' table entry. */ |
| /* */ |
| /* <Fields> */ |
| /* platform_id :: The platform ID for `string'. */ |
| /* */ |
| /* encoding_id :: The encoding ID for `string'. */ |
| /* */ |
| /* language_id :: The language ID for `string'. */ |
| /* */ |
| /* name_id :: An identifier for `string'. */ |
| /* */ |
| /* string :: The `name' string. Note that its format differs */ |
| /* depending on the (platform,encoding) pair. It can */ |
| /* be a Pascal String, a UTF-16 one, etc. */ |
| /* */ |
| /* Generally speaking, the string is not */ |
| /* zero-terminated. Please refer to the TrueType */ |
| /* specification for details. */ |
| /* */ |
| /* string_len :: The length of `string' in bytes. */ |
| /* */ |
| /* <Note> */ |
| /* Possible values for `platform_id', `encoding_id', `language_id', */ |
| /* and `name_id' are given in the file `ttnameid.h'. For details */ |
| /* please refer to the TrueType or OpenType specification. */ |
| /* */ |
| /* See also @TT_PLATFORM_XXX, @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, */ |
| /* @TT_ISO_ID_XXX, and @TT_MS_ID_XXX. */ |
| /* */ |
| typedef struct FT_SfntName_ |
| { |
| FT_UShort platform_id; |
| FT_UShort encoding_id; |
| FT_UShort language_id; |
| FT_UShort name_id; |
| |
| FT_Byte* string; /* this string is *not* null-terminated! */ |
| FT_UInt string_len; /* in bytes */ |
| |
| } FT_SfntName; |
| |
| |
| /*************************************************************************/ |
| /* */ |
| /* <Function> */ |
| /* FT_Get_Sfnt_Name_Count */ |
| /* */ |
| /* <Description> */ |
| /* Retrieve the number of name strings in the SFNT `name' table. */ |
| /* */ |
| /* <Input> */ |
| /* face :: A handle to the source face. */ |
| /* */ |
| /* <Return> */ |
| /* The number of strings in the `name' table. */ |
| /* */ |
| FT_EXPORT( FT_UInt ) |
| FT_Get_Sfnt_Name_Count( FT_Face face ); |
| |
| |
| /*************************************************************************/ |
| /* */ |
| /* <Function> */ |
| /* FT_Get_Sfnt_Name */ |
| /* */ |
| /* <Description> */ |
| /* Retrieve a string of the SFNT `name' table for a given index. */ |
| /* */ |
| /* <Input> */ |
| /* face :: A handle to the source face. */ |
| /* */ |
| /* idx :: The index of the `name' string. */ |
| /* */ |
| /* <Output> */ |
| /* aname :: The indexed @FT_SfntName structure. */ |
| /* */ |
| /* <Return> */ |
| /* FreeType error code. 0~means success. */ |
| /* */ |
| /* <Note> */ |
| /* The `string' array returned in the `aname' structure is not */ |
| /* null-terminated. The application should deallocate it if it is no */ |
| /* longer in use. */ |
| /* */ |
| /* Use @FT_Get_Sfnt_Name_Count to get the total number of available */ |
| /* `name' table entries, then do a loop until you get the right */ |
| /* platform, encoding, and name ID. */ |
| /* */ |
| FT_EXPORT( FT_Error ) |
| FT_Get_Sfnt_Name( FT_Face face, |
| FT_UInt idx, |
| FT_SfntName *aname ); |
| |
| |
| /*************************************************************************** |
| * |
| * @constant: |
| * FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY |
| * |
| * @description: |
| * A constant used as the tag of @FT_Parameter structures to make |
| * FT_Open_Face() ignore preferred family subfamily names in `name' |
| * table since OpenType version 1.4. For backwards compatibility with |
| * legacy systems that have a 4-face-per-family restriction. |
| * |
| */ |
| #define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY FT_MAKE_TAG( 'i', 'g', 'p', 'f' ) |
| |
| |
| /*************************************************************************** |
| * |
| * @constant: |
| * FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY |
| * |
| * @description: |
| * A constant used as the tag of @FT_Parameter structures to make |
| * FT_Open_Face() ignore preferred subfamily names in `name' table since |
| * OpenType version 1.4. For backwards compatibility with legacy |
| * systems that have a 4-face-per-family restriction. |
| * |
| */ |
| #define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY FT_MAKE_TAG( 'i', 'g', 'p', 's' ) |
| |
| /* */ |
| |
| |
| FT_END_HEADER |
| |
| #endif /* __FT_SFNT_NAMES_H__ */ |
| |
| |
| /* END */ |
