Describe error values and strings in the documentation.
This commit is contained in:
parent
f9be567f5f
commit
b3fce59d52
|
@ -119,3 +119,17 @@
|
||||||
/* lcd_filtering */
|
/* lcd_filtering */
|
||||||
/* */
|
/* */
|
||||||
/***************************************************************************/
|
/***************************************************************************/
|
||||||
|
|
||||||
|
/***************************************************************************/
|
||||||
|
/* */
|
||||||
|
/* <Chapter> */
|
||||||
|
/* error_codes */
|
||||||
|
/* */
|
||||||
|
/* <Title> */
|
||||||
|
/* Error Codes */
|
||||||
|
/* */
|
||||||
|
/* <Sections> */
|
||||||
|
/* error_enumerations */
|
||||||
|
/* error_code_values */
|
||||||
|
/* */
|
||||||
|
/***************************************************************************/
|
||||||
|
|
|
@ -16,18 +16,43 @@
|
||||||
/***************************************************************************/
|
/***************************************************************************/
|
||||||
|
|
||||||
|
|
||||||
/*******************************************************************/
|
/*************************************************************************/
|
||||||
/*******************************************************************/
|
/* */
|
||||||
/***** *****/
|
/* <Section> */
|
||||||
/***** LIST OF ERROR CODES/MESSAGES *****/
|
/* error_code_values */
|
||||||
/***** *****/
|
/* */
|
||||||
/*******************************************************************/
|
/* <Title> */
|
||||||
/*******************************************************************/
|
/* Error Code Values */
|
||||||
|
/* */
|
||||||
|
/* <Abstract> */
|
||||||
|
/* All possible error codes returned by FreeType functions. */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* The list below is taken verbatim from the file `fterrdef.h' */
|
||||||
|
/* (loaded automatically by including `FT_FREETYPE_H'). The first */
|
||||||
|
/* argument of the `FT_ERROR_DEF_' macro is the error label; by */
|
||||||
|
/* default, the prefix `FT_Err_' gets added so that you get error */
|
||||||
|
/* names like `FT_Err_Cannot_Open_Resource'. The second argument is */
|
||||||
|
/* the error code, and the last argument an error string, which is not */
|
||||||
|
/* used by FreeType. */
|
||||||
|
/* */
|
||||||
|
/* Within your application you should *only* use error names and */
|
||||||
|
/* *never* its numeric values! The latter might (and actually do) */
|
||||||
|
/* change in forthcoming FreeType versions. */
|
||||||
|
/* */
|
||||||
|
/* Macro `FT_NOERRORDEF_' defines `FT_Err_Ok', which is always zero. */
|
||||||
|
/* See the `Error Enumerations' subsection how to automatically */
|
||||||
|
/* generate a list of error strings. */
|
||||||
|
/* */
|
||||||
|
/*************************************************************************/
|
||||||
|
|
||||||
|
|
||||||
/* You need to define both FT_ERRORDEF_ and FT_NOERRORDEF_ before */
|
/*************************************************************************/
|
||||||
/* including this file. */
|
/* */
|
||||||
|
/* <Enum> */
|
||||||
|
/* FT_Err_XXX */
|
||||||
|
/* */
|
||||||
|
/*************************************************************************/
|
||||||
|
|
||||||
/* generic errors */
|
/* generic errors */
|
||||||
|
|
||||||
|
@ -245,5 +270,7 @@
|
||||||
FT_ERRORDEF_( Corrupted_Font_Glyphs, 0xBA,
|
FT_ERRORDEF_( Corrupted_Font_Glyphs, 0xBA,
|
||||||
"Font glyphs corrupted or missing fields" )
|
"Font glyphs corrupted or missing fields" )
|
||||||
|
|
||||||
|
/* */
|
||||||
|
|
||||||
|
|
||||||
/* END */
|
/* END */
|
||||||
|
|
|
@ -18,68 +18,86 @@
|
||||||
|
|
||||||
/*************************************************************************/
|
/*************************************************************************/
|
||||||
/* */
|
/* */
|
||||||
/* This special header file is used to define the handling of FT2 */
|
/* <Section> */
|
||||||
/* enumeration constants. It can also be used to generate error message */
|
/* error_enumerations */
|
||||||
/* strings with a small macro trick explained below. */
|
|
||||||
/* */
|
/* */
|
||||||
/* I - Error Formats */
|
/* <Title> */
|
||||||
/* ----------------- */
|
/* Error Enumerations */
|
||||||
|
/* */
|
||||||
|
/* <Abstract> */
|
||||||
|
/* How to handle errors and error strings. */
|
||||||
|
/* */
|
||||||
|
/* <Description> */
|
||||||
|
/* The header file `fterrors.h' (which is automatically included by */
|
||||||
|
/* `freetype.h' defines the handling of FreeType's enumeration */
|
||||||
|
/* constants. It can also be used to generate error message strings */
|
||||||
|
/* with a small macro trick explained below. */
|
||||||
|
/* */
|
||||||
|
/* *Error* *Formats* */
|
||||||
/* */
|
/* */
|
||||||
/* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be */
|
/* The configuration macro FT_CONFIG_OPTION_USE_MODULE_ERRORS can be */
|
||||||
/* defined in ftoption.h in order to make the higher byte indicate */
|
/* defined in `ftoption.h' in order to make the higher byte indicate */
|
||||||
/* the module where the error has happened (this is not compatible */
|
/* the module where the error has happened (this is not compatible */
|
||||||
/* with standard builds of FreeType 2). See the file `ftmoderr.h' for */
|
/* with standard builds of FreeType 2, however). See the file */
|
||||||
/* more details. */
|
/* `ftmoderr.h' for more details. */
|
||||||
/* */
|
/* */
|
||||||
|
/* *Error* *Message* *Strings* */
|
||||||
/* */
|
/* */
|
||||||
/* II - Error Message strings */
|
/* Error definitions are set up with special macros that allow client */
|
||||||
/* -------------------------- */
|
/* applications to build a table of error message strings. The */
|
||||||
/* */
|
/* strings are not included in a normal build of FreeType 2 to */
|
||||||
/* The error definitions below are made through special macros that */
|
/* save space (most client applications do not use them). */
|
||||||
/* allow client applications to build a table of error message strings */
|
|
||||||
/* if they need it. The strings are not included in a normal build of */
|
|
||||||
/* FreeType 2 to save space (most client applications do not use */
|
|
||||||
/* them). */
|
|
||||||
/* */
|
/* */
|
||||||
/* To do so, you have to define the following macros before including */
|
/* To do so, you have to define the following macros before including */
|
||||||
/* this file: */
|
|
||||||
/* */
|
|
||||||
/* FT_ERROR_START_LIST :: */
|
|
||||||
/* This macro is called before anything else to define the start of */
|
|
||||||
/* the error list. It is followed by several FT_ERROR_DEF calls */
|
|
||||||
/* (see below). */
|
|
||||||
/* */
|
|
||||||
/* FT_ERROR_DEF( e, v, s ) :: */
|
|
||||||
/* This macro is called to define one single error. */
|
|
||||||
/* `e' is the error code identifier (e.g. FT_Err_Invalid_Argument). */
|
|
||||||
/* `v' is the error numerical value. */
|
|
||||||
/* `s' is the corresponding error string. */
|
|
||||||
/* */
|
|
||||||
/* FT_ERROR_END_LIST :: */
|
|
||||||
/* This macro ends the list. */
|
|
||||||
/* */
|
|
||||||
/* Additionally, you have to undefine __FTERRORS_H__ before #including */
|
|
||||||
/* this file. */
|
/* this file. */
|
||||||
/* */
|
/* */
|
||||||
/* Here is a simple example: */
|
/* { */
|
||||||
|
/* FT_ERROR_START_LIST */
|
||||||
|
/* } */
|
||||||
/* */
|
/* */
|
||||||
|
/* This macro is called before anything else to define the start of */
|
||||||
|
/* the error list. It is followed by several FT_ERROR_DEF calls. */
|
||||||
|
/* */
|
||||||
|
/* { */
|
||||||
|
/* FT_ERROR_DEF( e, v, s ) */
|
||||||
|
/* } */
|
||||||
|
/* */
|
||||||
|
/* This macro is called to define one single error. `e' is the error */
|
||||||
|
/* code identifier (e.g., `Invalid_Argument'), `v' is the error's */
|
||||||
|
/* numerical value, and `s' is the corresponding error string. */
|
||||||
|
/* */
|
||||||
|
/* { */
|
||||||
|
/* FT_ERROR_END_LIST */
|
||||||
|
/* } */
|
||||||
|
/* */
|
||||||
|
/* This macro ends the list. */
|
||||||
|
/* */
|
||||||
|
/* Additionally, you have to undefine `__FTERRORS_H__' before */
|
||||||
|
/* #including this file. */
|
||||||
|
/* */
|
||||||
|
/* Here is a simple example. */
|
||||||
|
/* */
|
||||||
|
/* { */
|
||||||
|
/* #undef __FTERRORS_H__ */
|
||||||
|
/* #define FT_ERRORDEF( e, v, s ) { e, s }, */
|
||||||
|
/* #define FT_ERROR_START_LIST { */
|
||||||
|
/* #define FT_ERROR_END_LIST { 0, NULL } }; */
|
||||||
|
/* */
|
||||||
|
/* const struct */
|
||||||
/* { */
|
/* { */
|
||||||
/* #undef __FTERRORS_H__ */
|
/* int err_code; */
|
||||||
/* #define FT_ERRORDEF( e, v, s ) { e, s }, */
|
/* const char* err_msg; */
|
||||||
/* #define FT_ERROR_START_LIST { */
|
/* } ft_errors[] = */
|
||||||
/* #define FT_ERROR_END_LIST { 0, 0 } }; */
|
|
||||||
/* */
|
/* */
|
||||||
/* const struct */
|
/* #include FT_ERRORS_H */
|
||||||
/* { */
|
/* } */
|
||||||
/* int err_code; */
|
|
||||||
/* const char* err_msg; */
|
|
||||||
/* } ft_errors[] = */
|
|
||||||
/* */
|
/* */
|
||||||
/* #include FT_ERRORS_H */
|
/* Note that `FT_Err_Ok' is _not_ defined with `FT_ERRORDEF' but with */
|
||||||
/* } */
|
/* `FT_NOERRORDEF'; it is always zero. */
|
||||||
/* */
|
/* */
|
||||||
/*************************************************************************/
|
/*************************************************************************/
|
||||||
|
|
||||||
|
/* */
|
||||||
|
|
||||||
#ifndef __FTERRORS_H__
|
#ifndef __FTERRORS_H__
|
||||||
#define __FTERRORS_H__
|
#define __FTERRORS_H__
|
||||||
|
|
Loading…
Reference in New Issue