nuclear@0: /***************************************************************************/ nuclear@0: /* */ nuclear@0: /* ftbdf.h */ nuclear@0: /* */ nuclear@0: /* FreeType API for accessing BDF-specific strings (specification). */ nuclear@0: /* */ nuclear@0: /* Copyright 2002, 2003, 2004, 2006, 2009 by */ nuclear@0: /* David Turner, Robert Wilhelm, and Werner Lemberg. */ nuclear@0: /* */ nuclear@0: /* This file is part of the FreeType project, and may only be used, */ nuclear@0: /* modified, and distributed under the terms of the FreeType project */ nuclear@0: /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ nuclear@0: /* this file you indicate that you have read the license and */ nuclear@0: /* understand and accept it fully. */ nuclear@0: /* */ nuclear@0: /***************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifndef __FTBDF_H__ nuclear@0: #define __FTBDF_H__ nuclear@0: nuclear@0: #include nuclear@0: #include FT_FREETYPE_H nuclear@0: nuclear@0: #ifdef FREETYPE_H nuclear@0: #error "freetype.h of FreeType 1 has been loaded!" nuclear@0: #error "Please fix the directory search order for header files" nuclear@0: #error "so that freetype.h of FreeType 2 is found first." nuclear@0: #endif nuclear@0: nuclear@0: nuclear@0: FT_BEGIN_HEADER nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /*
*/ nuclear@0: /* bdf_fonts */ nuclear@0: /* */ nuclear@0: /* */ nuclear@0: /* BDF and PCF Files */ nuclear@0: /* */ nuclear@0: /* <Abstract> */ nuclear@0: /* BDF and PCF specific API. */ nuclear@0: /* */ nuclear@0: /* <Description> */ nuclear@0: /* This section contains the declaration of functions specific to BDF */ nuclear@0: /* and PCF fonts. */ nuclear@0: /* */ nuclear@0: /*************************************************************************/ nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @enum: nuclear@0: * FT_PropertyType nuclear@0: * nuclear@0: * @description: nuclear@0: * A list of BDF property types. nuclear@0: * nuclear@0: * @values: nuclear@0: * BDF_PROPERTY_TYPE_NONE :: nuclear@0: * Value~0 is used to indicate a missing property. nuclear@0: * nuclear@0: * BDF_PROPERTY_TYPE_ATOM :: nuclear@0: * Property is a string atom. nuclear@0: * nuclear@0: * BDF_PROPERTY_TYPE_INTEGER :: nuclear@0: * Property is a 32-bit signed integer. nuclear@0: * nuclear@0: * BDF_PROPERTY_TYPE_CARDINAL :: nuclear@0: * Property is a 32-bit unsigned integer. nuclear@0: */ nuclear@0: typedef enum BDF_PropertyType_ nuclear@0: { nuclear@0: BDF_PROPERTY_TYPE_NONE = 0, nuclear@0: BDF_PROPERTY_TYPE_ATOM = 1, nuclear@0: BDF_PROPERTY_TYPE_INTEGER = 2, nuclear@0: BDF_PROPERTY_TYPE_CARDINAL = 3 nuclear@0: nuclear@0: } BDF_PropertyType; nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @type: nuclear@0: * BDF_Property nuclear@0: * nuclear@0: * @description: nuclear@0: * A handle to a @BDF_PropertyRec structure to model a given nuclear@0: * BDF/PCF property. nuclear@0: */ nuclear@0: typedef struct BDF_PropertyRec_* BDF_Property; nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @struct: nuclear@0: * BDF_PropertyRec nuclear@0: * nuclear@0: * @description: nuclear@0: * This structure models a given BDF/PCF property. nuclear@0: * nuclear@0: * @fields: nuclear@0: * type :: nuclear@0: * The property type. nuclear@0: * nuclear@0: * u.atom :: nuclear@0: * The atom string, if type is @BDF_PROPERTY_TYPE_ATOM. nuclear@0: * nuclear@0: * u.integer :: nuclear@0: * A signed integer, if type is @BDF_PROPERTY_TYPE_INTEGER. nuclear@0: * nuclear@0: * u.cardinal :: nuclear@0: * An unsigned integer, if type is @BDF_PROPERTY_TYPE_CARDINAL. nuclear@0: */ nuclear@0: typedef struct BDF_PropertyRec_ nuclear@0: { nuclear@0: BDF_PropertyType type; nuclear@0: union { nuclear@0: const char* atom; nuclear@0: FT_Int32 integer; nuclear@0: FT_UInt32 cardinal; nuclear@0: nuclear@0: } u; nuclear@0: nuclear@0: } BDF_PropertyRec; nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @function: nuclear@0: * FT_Get_BDF_Charset_ID nuclear@0: * nuclear@0: * @description: nuclear@0: * Retrieve a BDF font character set identity, according to nuclear@0: * the BDF specification. nuclear@0: * nuclear@0: * @input: nuclear@0: * face :: nuclear@0: * A handle to the input face. nuclear@0: * nuclear@0: * @output: nuclear@0: * acharset_encoding :: nuclear@0: * Charset encoding, as a C~string, owned by the face. nuclear@0: * nuclear@0: * acharset_registry :: nuclear@0: * Charset registry, as a C~string, owned by the face. nuclear@0: * nuclear@0: * @return: nuclear@0: * FreeType error code. 0~means success. nuclear@0: * nuclear@0: * @note: nuclear@0: * This function only works with BDF faces, returning an error otherwise. nuclear@0: */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_Get_BDF_Charset_ID( FT_Face face, nuclear@0: const char* *acharset_encoding, nuclear@0: const char* *acharset_registry ); nuclear@0: nuclear@0: nuclear@0: /********************************************************************** nuclear@0: * nuclear@0: * @function: nuclear@0: * FT_Get_BDF_Property nuclear@0: * nuclear@0: * @description: nuclear@0: * Retrieve a BDF property from a BDF or PCF font file. nuclear@0: * nuclear@0: * @input: nuclear@0: * face :: A handle to the input face. nuclear@0: * nuclear@0: * name :: The property name. nuclear@0: * nuclear@0: * @output: nuclear@0: * aproperty :: The property. nuclear@0: * nuclear@0: * @return: nuclear@0: * FreeType error code. 0~means success. nuclear@0: * nuclear@0: * @note: nuclear@0: * This function works with BDF _and_ PCF fonts. It returns an error nuclear@0: * otherwise. It also returns an error if the property is not in the nuclear@0: * font. nuclear@0: * nuclear@0: * A `property' is a either key-value pair within the STARTPROPERTIES nuclear@0: * ... ENDPROPERTIES block of a BDF font or a key-value pair from the nuclear@0: * `info->props' array within a `FontRec' structure of a PCF font. nuclear@0: * nuclear@0: * Integer properties are always stored as `signed' within PCF fonts; nuclear@0: * consequently, @BDF_PROPERTY_TYPE_CARDINAL is a possible return value nuclear@0: * for BDF fonts only. nuclear@0: * nuclear@0: * In case of error, `aproperty->type' is always set to nuclear@0: * @BDF_PROPERTY_TYPE_NONE. nuclear@0: */ nuclear@0: FT_EXPORT( FT_Error ) nuclear@0: FT_Get_BDF_Property( FT_Face face, nuclear@0: const char* prop_name, nuclear@0: BDF_PropertyRec *aproperty ); nuclear@0: nuclear@0: /* */ nuclear@0: nuclear@0: FT_END_HEADER nuclear@0: nuclear@0: #endif /* __FTBDF_H__ */ nuclear@0: nuclear@0: nuclear@0: /* END */