From d20dc3928b9d3ee075106b7684dab6111d6a5899 Mon Sep 17 00:00:00 2001 From: Armin Hasitzka Date: Thu, 30 Aug 2018 14:09:04 +0200 Subject: [PATCH] [errors] Introduce `FT_Error_String'. * include/freetype/fterrors.h (FT_Error_String), src/base/fterrors.c (FT_Error_String): Implement `FT_Error_String'. * src/base/ftbase.c, src/base/Jamfile (_source), src/base/rules.mk (BASE_SRC): Add `fterrors.c' to the build logic. * src/base/ftdebug.c (FT_Throw): Use `FT_Error_String'. --- ChangeLog | 12 ++++++++++ include/freetype/fterrors.h | 38 +++++++++++++++++++++++++++++++ src/base/Jamfile | 1 + src/base/ftbase.c | 1 + src/base/ftdebug.c | 9 +++++--- src/base/fterrors.c | 45 +++++++++++++++++++++++++++++++++++++ src/base/rules.mk | 1 + 7 files changed, 104 insertions(+), 3 deletions(-) create mode 100644 src/base/fterrors.c diff --git a/ChangeLog b/ChangeLog index d8613e5af..bcd6b4790 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2018-08-30 Armin Hasitzka + + [errors] Introduce `FT_Error_String'. + + * include/freetype/fterrors.h (FT_Error_String), + src/base/fterrors.c (FT_Error_String): Implement `FT_Error_String'. + + * src/base/ftbase.c, src/base/Jamfile (_source), + src/base/rules.mk (BASE_SRC): Add `fterrors.c' to the build logic. + + * src/base/ftdebug.c (FT_Throw): Use `FT_Error_String'. + 2018-08-30 Werner Lemberg [autofit] Trace `before' and `after' edges of strong points. diff --git a/include/freetype/fterrors.h b/include/freetype/fterrors.h index f3198111c..bed67cbf6 100644 --- a/include/freetype/fterrors.h +++ b/include/freetype/fterrors.h @@ -166,6 +166,8 @@ /* */ #ifndef FT_ERRORDEF +#define FT_INCLUDE_ERR_PROTOS + #define FT_ERRORDEF( e, v, s ) e = v, #define FT_ERROR_START_LIST enum { #define FT_ERROR_END_LIST FT_ERR_CAT( FT_ERR_PREFIX, Max ) }; @@ -228,6 +230,42 @@ #undef FT_ERR_PREFIX #endif +#ifdef FT_INCLUDE_ERR_PROTOS + + + /************************************************************************** + * + * @function: + * FT_Error_String + * + * @description: + * Retrieve the description of a valid FreeType error code. + * + * @input: + * error_code :: + * A valid FreeType error code. + * + * @return: + * A C~string or `NULL`, if any error occurred. + * + * @note: + * FreeType has to be compiled with `FT_CONFIG_OPTION_ERROR_STRINGS` or + * `FT_DEBUG_LEVEL_ERROR` to get meaningful descriptions. + * 'error_string' will be `NULL` otherwise. + * + * Module identification will be ignored: + * + * ```c + * strcmp( FT_Error_String( FT_Err_Unknown_File_Format ), + * FT_Error_String( BDF_Err_Unknown_File_Format ) ) == 0; + * ``` + */ + FT_EXPORT( const char* ) + FT_Error_String( FT_Error error_code ); + + +#endif /* FT_INCLUDE_ERR_PROTOS */ + #endif /* !(FTERRORS_H_ && __FTERRORS_H__) */ diff --git a/src/base/Jamfile b/src/base/Jamfile index a1c5fe25a..fab7ef466 100644 --- a/src/base/Jamfile +++ b/src/base/Jamfile @@ -22,6 +22,7 @@ SubDir FT2_TOP $(FT2_SRC_DIR) base ; ftcalc ftcolor ftdbgmem + fterrors ftfntfmt ftgloadr fthash diff --git a/src/base/ftbase.c b/src/base/ftbase.c index 5f7d818aa..5fe4c1d9a 100644 --- a/src/base/ftbase.c +++ b/src/base/ftbase.c @@ -23,6 +23,7 @@ #include "ftcalc.c" #include "ftcolor.c" #include "ftdbgmem.c" +#include "fterrors.c" #include "ftfntfmt.c" #include "ftgloadr.c" #include "fthash.c" diff --git a/src/base/ftdebug.c b/src/base/ftdebug.c index 19b0058d3..d5045da77 100644 --- a/src/base/ftdebug.c +++ b/src/base/ftdebug.c @@ -87,9 +87,12 @@ int line, const char* file ) { - FT_UNUSED( error ); - FT_UNUSED( line ); - FT_UNUSED( file ); + fprintf( stderr, + "%s:%d: error 0x%02x: %s\n", + file, + line, + error, + FT_Error_String( error ) ); return 0; } diff --git a/src/base/fterrors.c b/src/base/fterrors.c new file mode 100644 index 000000000..956d6af07 --- /dev/null +++ b/src/base/fterrors.c @@ -0,0 +1,45 @@ +/**************************************************************************** + * + * fterrors.c + * + * FreeType API for error code handling. + * + * Copyright 2018 by + * Armin Hasitzka, 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. + * + */ + + +#include +#include FT_ERRORS_H + + + /* documentation is in fterrors.h */ + + FT_EXPORT_DEF( const char* ) + FT_Error_String( FT_Error error_code ) + { + if ( error_code < 0 || + error_code >= FT_ERR_CAT( FT_ERR_PREFIX, Max ) ) + return NULL; + +#if defined( FT_CONFIG_OPTION_ERROR_STRINGS ) || \ + defined( FT_DEBUG_LEVEL_ERROR ) + +#undef FTERRORS_H_ +#define FT_ERROR_START_LIST switch ( FT_ERROR_BASE( error_code ) ) { +#define FT_ERRORDEF( e, v, s ) case v: return s; +#define FT_ERROR_END_LIST } + +#include FT_ERRORS_H + +#endif /* defined( FT_CONFIG_OPTION_ERROR_STRINGS ) || ... */ + + return NULL; + } diff --git a/src/base/rules.mk b/src/base/rules.mk index 214fd778f..887e4e7e8 100644 --- a/src/base/rules.mk +++ b/src/base/rules.mk @@ -40,6 +40,7 @@ BASE_SRC := $(BASE_DIR)/ftadvanc.c \ $(BASE_DIR)/ftcalc.c \ $(BASE_DIR)/ftcolor.c \ $(BASE_DIR)/ftdbgmem.c \ + $(BASE_DIR)/fterrors.c \ $(BASE_DIR)/ftfntfmt.c \ $(BASE_DIR)/ftgloadr.c \ $(BASE_DIR)/fthash.c \