2000-07-19 19:13:03 +02:00
|
|
|
/***************************************************************************/
|
|
|
|
|
/* */
|
2001-03-20 15:50:04 +01:00
|
|
|
/* ftsnames.h */
|
2000-07-19 19:13:03 +02:00
|
|
|
/* */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* Simple interface to access SFNT `name' tables (which are used */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* to hold font names, copyright info, notices, etc.) (specification). */
|
2000-07-19 19:13:03 +02:00
|
|
|
/* */
|
2000-07-20 08:57:41 +02:00
|
|
|
/* This is _not_ used to retrieve glyph names! */
|
2000-07-19 19:13:03 +02:00
|
|
|
/* */
|
2017-01-04 20:16:34 +01:00
|
|
|
/* Copyright 1996-2017 by */
|
2000-07-19 19:13:03 +02:00
|
|
|
/* 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. */
|
|
|
|
|
/* */
|
|
|
|
|
/***************************************************************************/
|
|
|
|
|
|
2000-07-20 08:57:41 +02:00
|
|
|
|
2016-01-12 21:37:13 +01:00
|
|
|
#ifndef FTSNAMES_H_
|
|
|
|
|
#define FTSNAMES_H_
|
2000-07-19 19:13:03 +02:00
|
|
|
|
2000-12-09 01:45:38 +01:00
|
|
|
|
|
|
|
|
#include <ft2build.h>
|
|
|
|
|
#include FT_FREETYPE_H
|
|
|
|
|
|
2003-11-04 08:44:19 +01:00
|
|
|
#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
|
|
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
|
|
|
|
|
FT_BEGIN_HEADER
|
2000-08-01 15:17:04 +02:00
|
|
|
|
|
|
|
|
|
2001-01-11 10:27:49 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Section> */
|
|
|
|
|
/* sfnt_names */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Title> */
|
|
|
|
|
/* SFNT Names */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Abstract> */
|
|
|
|
|
/* Access the names embedded in TrueType and OpenType files. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2008-06-26 21:56:51 +02:00
|
|
|
/* The TrueType and OpenType specifications allow the inclusion of */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* a special names table (`name') in font files. This table contains */
|
2001-01-11 10:27:49 +01:00
|
|
|
/* 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! */
|
|
|
|
|
/* */
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
2001-01-10 12:15:48 +01:00
|
|
|
|
2000-10-17 05:38:43 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Struct> */
|
|
|
|
|
/* FT_SfntName */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* A structure used to model an SFNT `name' table entry. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Fields> */
|
|
|
|
|
/* platform_id :: The platform ID for `string'. */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* See @TT_PLATFORM_XXX for possible values. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* encoding_id :: The encoding ID for `string'. */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* See @TT_APPLE_ID_XXX, @TT_MAC_ID_XXX, */
|
|
|
|
|
/* @TT_ISO_ID_XXX, @TT_MS_ID_XXX, and @TT_ADOBE_ID_XXX */
|
|
|
|
|
/* for possible values. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* language_id :: The language ID for `string'. */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* See @TT_MAC_LANGID_XXX and @TT_MS_LANGID_XXX for */
|
|
|
|
|
/* possible values. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
2017-01-27 00:06:52 +01:00
|
|
|
/* Registered OpenType values for `language_id' are */
|
|
|
|
|
/* always smaller than 0x8000; values equal or larger */
|
|
|
|
|
/* than 0x8000 usually indicate a language tag string */
|
|
|
|
|
/* (introduced in OpenType version 1.6). Use function */
|
|
|
|
|
/* @FT_Get_Sfnt_LangTag with `language_id' as its */
|
|
|
|
|
/* argument to retrieve the associated language tag. */
|
|
|
|
|
/* */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* name_id :: An identifier for `string'. */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* See @TT_NAME_ID_XXX for possible values. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
2001-03-20 15:50:04 +01:00
|
|
|
/* string :: The `name' string. Note that its format differs */
|
2017-01-27 00:06:52 +01:00
|
|
|
/* depending on the (platform,encoding) pair, being */
|
|
|
|
|
/* either a string of bytes (without a terminating */
|
|
|
|
|
/* NULL byte) or containing UTF-16BE entities. */
|
2001-03-20 15:50:04 +01:00
|
|
|
/* */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* string_len :: The length of `string' in bytes. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
2017-01-17 12:39:53 +01:00
|
|
|
/* Please refer to the TrueType or OpenType specification for more */
|
|
|
|
|
/* details. */
|
2006-05-12 10:00:13 +02:00
|
|
|
/* */
|
2000-07-20 08:57:41 +02:00
|
|
|
typedef struct FT_SfntName_
|
2000-07-19 19:13:03 +02:00
|
|
|
{
|
|
|
|
|
FT_UShort platform_id;
|
|
|
|
|
FT_UShort encoding_id;
|
|
|
|
|
FT_UShort language_id;
|
|
|
|
|
FT_UShort name_id;
|
2000-10-24 07:44:59 +02:00
|
|
|
|
2000-10-17 05:38:43 +02:00
|
|
|
FT_Byte* string; /* this string is *not* null-terminated! */
|
2017-01-17 12:39:53 +01:00
|
|
|
FT_UInt string_len; /* in bytes */
|
2000-10-24 07:44:59 +02:00
|
|
|
|
2000-07-19 19:13:03 +02:00
|
|
|
} FT_SfntName;
|
|
|
|
|
|
|
|
|
|
|
2000-10-17 05:38:43 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Get_Sfnt_Name_Count */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2008-06-26 21:56:51 +02:00
|
|
|
/* Retrieve the number of name strings in the SFNT `name' table. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* face :: A handle to the source face. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* The number of strings in the `name' table. */
|
|
|
|
|
/* */
|
2001-06-28 09:17:51 +02:00
|
|
|
FT_EXPORT( FT_UInt )
|
|
|
|
|
FT_Get_Sfnt_Name_Count( FT_Face face );
|
2000-10-17 05:38:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Get_Sfnt_Name */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2008-06-26 21:56:51 +02:00
|
|
|
/* Retrieve a string of the SFNT `name' table for a given index. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* face :: A handle to the source face. */
|
|
|
|
|
/* */
|
2002-04-01 16:25:28 +02:00
|
|
|
/* idx :: The index of the `name' string. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Output> */
|
2006-05-12 10:00:13 +02:00
|
|
|
/* aname :: The indexed @FT_SfntName structure. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
2008-06-26 21:56:51 +02:00
|
|
|
/* FreeType error code. 0~means success. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* The `string' array returned in the `aname' structure is not */
|
2017-01-11 16:25:52 +01:00
|
|
|
/* null-terminated. Note that you don't have to deallocate `string' */
|
|
|
|
|
/* by yourself; FreeType takes care of it if you call @FT_Done_Face. */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* */
|
2006-05-12 10:00:13 +02:00
|
|
|
/* Use @FT_Get_Sfnt_Name_Count to get the total number of available */
|
2000-10-17 05:38:43 +02:00
|
|
|
/* `name' table entries, then do a loop until you get the right */
|
|
|
|
|
/* platform, encoding, and name ID. */
|
|
|
|
|
/* */
|
2017-01-27 00:06:52 +01:00
|
|
|
/* `name' table format~1 entries can use language tags also, see */
|
|
|
|
|
/* @FT_Get_Sfnt_LangTag. */
|
|
|
|
|
/* */
|
2001-06-28 09:17:51 +02:00
|
|
|
FT_EXPORT( FT_Error )
|
|
|
|
|
FT_Get_Sfnt_Name( FT_Face face,
|
2002-04-01 16:25:28 +02:00
|
|
|
FT_UInt idx,
|
2001-06-28 09:17:51 +02:00
|
|
|
FT_SfntName *aname );
|
2001-01-11 10:27:49 +01:00
|
|
|
|
|
|
|
|
|
2017-01-27 00:06:52 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Struct> */
|
|
|
|
|
/* FT_SfntLangTag */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* A structure to model a language tag entry from an SFNT `name' */
|
|
|
|
|
/* table. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Fields> */
|
|
|
|
|
/* string :: The language tag string, encoded in UTF-16BE */
|
|
|
|
|
/* (without trailing NULL bytes). */
|
|
|
|
|
/* */
|
|
|
|
|
/* string_len :: The length of `string' in *bytes*. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* Please refer to the TrueType or OpenType specification for more */
|
|
|
|
|
/* details. */
|
|
|
|
|
/* */
|
|
|
|
|
typedef struct FT_SfntLangTag_
|
|
|
|
|
{
|
|
|
|
|
FT_Byte* string; /* this string is *not* null-terminated! */
|
|
|
|
|
FT_UInt string_len; /* in bytes */
|
|
|
|
|
|
|
|
|
|
} FT_SfntLangTag;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Get_Sfnt_LangTag */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Retrieve the language tag associated with a language ID of an SFNT */
|
|
|
|
|
/* `name' table entry. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* face :: A handle to the source face. */
|
|
|
|
|
/* */
|
|
|
|
|
/* langID :: The language ID, as returned by @FT_Get_Sfnt_Name. */
|
|
|
|
|
/* This is always a value larger than 0x8000. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Output> */
|
|
|
|
|
/* alangTag :: The language tag associated with the `name' table */
|
|
|
|
|
/* entry's language ID. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0~means success. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* The `string' array returned in the `alangTag' structure is not */
|
|
|
|
|
/* null-terminated. Note that you don't have to deallocate `string' */
|
|
|
|
|
/* by yourself; FreeType takes care of it if you call @FT_Done_Face. */
|
|
|
|
|
/* */
|
|
|
|
|
/* Only `name' table format~1 supports language tags. For format~0 */
|
|
|
|
|
/* tables, this function always returns FT_Err_Invalid_Table. For */
|
|
|
|
|
/* invalid format~1 language ID values, FT_Err_Invalid_Argument is */
|
|
|
|
|
/* returned. */
|
|
|
|
|
/* */
|
|
|
|
|
FT_EXPORT( FT_Error )
|
|
|
|
|
FT_Get_Sfnt_LangTag( FT_Face face,
|
|
|
|
|
FT_UInt langID,
|
|
|
|
|
FT_SfntLangTag *alangTag );
|
|
|
|
|
|
|
|
|
|
|
2010-01-29 15:18:34 +01:00
|
|
|
/***************************************************************************
|
|
|
|
|
*
|
|
|
|
|
* @constant:
|
2017-01-24 17:00:36 +01:00
|
|
|
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
|
2010-02-11 14:57:59 +01:00
|
|
|
*
|
|
|
|
|
* @description:
|
2017-01-24 17:00:36 +01:00
|
|
|
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
|
|
|
|
|
* family names in the `name' table (introduced in OpenType version
|
2017-05-03 23:54:29 +02:00
|
|
|
* 1.4). Use this for backward compatibility with legacy systems that
|
2017-01-24 17:00:36 +01:00
|
|
|
* have a four-faces-per-family restriction.
|
2010-02-11 14:57:59 +01:00
|
|
|
*
|
|
|
|
|
*/
|
2017-01-24 17:00:36 +01:00
|
|
|
#define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY \
|
|
|
|
|
FT_MAKE_TAG( 'i', 'g', 'p', 'f' )
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* this constant is deprecated */
|
|
|
|
|
#define FT_PARAM_TAG_IGNORE_PREFERRED_FAMILY \
|
|
|
|
|
FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_FAMILY
|
2010-02-11 14:57:59 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/***************************************************************************
|
|
|
|
|
*
|
|
|
|
|
* @constant:
|
2017-01-24 17:00:36 +01:00
|
|
|
* FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
|
2010-01-29 15:18:34 +01:00
|
|
|
*
|
|
|
|
|
* @description:
|
2017-01-24 17:00:36 +01:00
|
|
|
* A tag for @FT_Parameter to make @FT_Open_Face ignore typographic
|
|
|
|
|
* subfamily names in the `name' table (introduced in OpenType version
|
2017-05-03 23:54:29 +02:00
|
|
|
* 1.4). Use this for backward compatibility with legacy systems that
|
2017-01-24 17:00:36 +01:00
|
|
|
* have a four-faces-per-family restriction.
|
2010-01-29 15:18:34 +01:00
|
|
|
*
|
|
|
|
|
*/
|
2017-01-24 17:00:36 +01:00
|
|
|
#define FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY \
|
|
|
|
|
FT_MAKE_TAG( 'i', 'g', 'p', 's' )
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/* this constant is deprecated */
|
|
|
|
|
#define FT_PARAM_TAG_IGNORE_PREFERRED_SUBFAMILY \
|
|
|
|
|
FT_PARAM_TAG_IGNORE_TYPOGRAPHIC_SUBFAMILY
|
2010-01-29 15:18:34 +01:00
|
|
|
|
2001-01-10 12:15:48 +01:00
|
|
|
/* */
|
2000-07-19 19:13:03 +02:00
|
|
|
|
2001-01-11 10:27:49 +01:00
|
|
|
|
2000-12-01 00:12:33 +01:00
|
|
|
FT_END_HEADER
|
2000-08-01 15:17:04 +02:00
|
|
|
|
2016-01-12 21:37:13 +01:00
|
|
|
#endif /* FTSNAMES_H_ */
|
2000-07-20 08:57:41 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/* END */
|
