diff --git a/ChangeLog b/ChangeLog index 0b5030e56..30b422ce5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2020-12-07 Werner Lemberg + + */*: s/FT_LOGGING/FT_DEBUG_LOGGING/. + 2020-12-05 Werner Lemberg * builds/toplevel.mk (do-dist): Remove `submodules` directory. diff --git a/README.git b/README.git index 1da3fa83c..265643df8 100644 --- a/README.git +++ b/README.git @@ -35,9 +35,9 @@ Similarly, a build with `cmake' can be done directly from the git repository. -For using the `FT_LOGGING' macro while debugging (see `docs/DEBUG' for -more information) use the following git commands to checkout `dlg' -library as a git submodule. +For using the `FT_DEBUG_LOGGING' macro while debugging (see +`docs/DEBUG' for more information) use the following git commands to +checkout `dlg' library as a git submodule. git submodule init git submodule update diff --git a/builds/unix/configure.raw b/builds/unix/configure.raw index f5cf34a94..1b637e6bd 100644 --- a/builds/unix/configure.raw +++ b/builds/unix/configure.raw @@ -1128,9 +1128,9 @@ fi if test "$have_pthread" != no; then CFLAGS="$CFLAGS $PTHREAD_CFLAGS" LDFLAGS="$LDFLAGS $PTHREAD_CFLAGS $PTHREAD_LIBS" - ftoption_set FT_LOGGING + ftoption_set FT_DEBUG_LOGGING else - ftoption_unset FT_LOGGING + ftoption_unset FT_DEBUG_LOGGING fi AC_SUBST([CFLAGS]) @@ -1185,7 +1185,7 @@ fi if test $have_pthread = no; then AC_MSG_WARN([ - \`FT_LOGGING' will not work since the \`pthread' library is not available. + \`FT_DEBUG_LOGGING' will not work since the \`pthread' library is not available. ]) fi diff --git a/builds/windows/ftdebug.c b/builds/windows/ftdebug.c index 389b9d8a9..11d7ff6f2 100644 --- a/builds/windows/ftdebug.c +++ b/builds/windows/ftdebug.c @@ -46,7 +46,7 @@ #include -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /************************************************************************** * @@ -87,7 +87,7 @@ dlg_handler ft_default_log_handler = NULL; FT_Custom_Log_Handler custom_output_handler = NULL; -#endif /* FT_LOGGING*/ +#endif /* FT_DEBUG_LOGGING*/ #ifdef FT_DEBUG_LEVEL_ERROR @@ -255,7 +255,7 @@ const char* ft2_debug = NULL; -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING if ( ft_custom_trace_level != NULL ) ft2_debug = ft_custom_trace_level; else @@ -276,7 +276,7 @@ if ( *p == ' ' || *p == '\t' || *p == ',' || *p == ';' || *p == '=' ) continue; -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /* check extra arguments for logging */ if ( *p == '-' ) @@ -317,7 +317,7 @@ } } -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ /* read toggle name, followed by ':' */ q = p; @@ -423,7 +423,7 @@ #endif /* !FT_DEBUG_LEVEL_TRACE */ -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /************************************************************************** * @@ -621,7 +621,7 @@ va_end( ap ); } -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ /* END */ diff --git a/builds/windows/vc2010/freetype.vcxproj b/builds/windows/vc2010/freetype.vcxproj index 41080feb7..0ae9d8ce3 100644 --- a/builds/windows/vc2010/freetype.vcxproj +++ b/builds/windows/vc2010/freetype.vcxproj @@ -90,7 +90,7 @@ Disabled ..\..\..\src\dlg\;$(UserOptionDirectory);..\..\..\include;$(UserIncludeDirectories);%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;DLL_EXPORT;FT_LOGGING;$(UserDefines);%(PreprocessorDefinitions) + WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;DLL_EXPORT;FT_DEBUG_LOGGING;$(UserDefines);%(PreprocessorDefinitions) EnableFastChecks MultiThreadedDebugDLL false @@ -119,7 +119,7 @@ Disabled ..\..\..\src\dlg\;$(UserOptionDirectory);..\..\..\include;$(UserIncludeDirectories);%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;DLL_EXPORT;FT_LOGGING;$(UserDefines);%(PreprocessorDefinitions) + WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;DLL_EXPORT;FT_DEBUG_LOGGING;$(UserDefines);%(PreprocessorDefinitions) EnableFastChecks MultiThreadedDebugDLL false @@ -148,7 +148,7 @@ Disabled ..\..\..\src\dlg;$(UserOptionDirectory);..\..\..\include;$(UserIncludeDirectories);%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;FT_LOGGING;DLG_STATIC;$(UserDefines);%(PreprocessorDefinitions) + WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;FT_DEBUG_LOGGING;DLG_STATIC;$(UserDefines);%(PreprocessorDefinitions) EnableFastChecks MultiThreadedDebug false @@ -177,7 +177,7 @@ Disabled ..\..\..\src\dlg;$(UserOptionDirectory);..\..\..\include;$(UserIncludeDirectories);%(AdditionalIncludeDirectories) - WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;FT_LOGGING;DLG_STATIC;$(UserDefines);%(PreprocessorDefinitions) + WIN32;_DEBUG;_LIB;_CRT_SECURE_NO_WARNINGS;FT_DEBUG_LEVEL_ERROR;FT_DEBUG_LEVEL_TRACE;FT2_BUILD_LIBRARY;FT_DEBUG_LOGGING;DLG_STATIC;$(UserDefines);%(PreprocessorDefinitions) EnableFastChecks MultiThreadedDebug false diff --git a/devel/ftoption.h b/devel/ftoption.h index 7162b706d..a84520799 100644 --- a/devel/ftoption.h +++ b/devel/ftoption.h @@ -443,7 +443,7 @@ FT_BEGIN_HEADER * to a file, FreeType uses an the external `dlg` library (the source * code is in `src/dlg`). */ -#define FT_LOGGING +#define FT_DEBUG_LOGGING /************************************************************************** diff --git a/docs/CHANGES b/docs/CHANGES index bdd949624..7aba98ba9 100644 --- a/docs/CHANGES +++ b/docs/CHANGES @@ -12,10 +12,10 @@ CHANGES BETWEEN 2.10.4 and 2.11.0 - `ttdebug' didn't show changed point coordinates (bug introduced in version 2.10.3). - - A new configuration macro `FT_LOGGING` is available. It provides - extended debugging capabilities for FreeType, for example showing - a time stamp or displaying the component a tracing message comes - from. See file `docs/DEBUG` for more information. + - A new configuration macro `FT_DEBUG_LOGGING` is available. It + provides extended debugging capabilities for FreeType, for example + showing a time stamp or displaying the component a tracing message + comes from. See file `docs/DEBUG` for more information. This work was Priyesh Kumar's GSoC 2020 project. diff --git a/docs/DEBUG b/docs/DEBUG index 48bea346a..8366d5094 100644 --- a/docs/DEBUG +++ b/docs/DEBUG @@ -44,7 +44,7 @@ located in the file `ftoption.h'. The macros are: When `FT2_DEBUG_MEMORY' isn't defined at runtime, the debugging memory manager is ignored, and performance is unaffected. - FT_LOGGING + FT_DEBUG_LOGGING #define this macro for enhanced logging support; it automatically sets `FT_DEBUG_LEVEL_TRACE' and `FT_DEBUG_LEVEL_ERROR'. @@ -165,7 +165,7 @@ behaviour of FreeType at runtime. the memory and io components, which are set to the trace levels 5 and 4, respectively. - If `FT_LOGGING' is defined, two more options are available. + If `FT_DEBUG_LOGGING' is defined, two more options are available. * -v: Print also the name of FreeType's component from which the current log is produced. @@ -190,8 +190,8 @@ behaviour of FreeType at runtime. FT_LOGGING_FILE This variable is only used if FreeType is built with the - `FT_LOGGING' macro defined. It contains the path to the file - where the user wants to put his log file. If it is not set, + `FT_DEBUG_LOGGING' macro defined. It contains the path to the + file where the user wants to put his log file. If it is not set, FreeType uses stderr. Examples: @@ -254,10 +254,10 @@ behaviour of FreeType at runtime. freed blocks are released at runtime. -IV. Additional Capabilities with `FT_LOGGING' ---------------------------------------------- +IV. Additional Capabilities with `FT_DEBUG_LOGGING' +--------------------------------------------------- -If `FT_LOGGING' is defined, four APIs are available to provide +If `FT_DEBUG_LOGGING' is defined, four APIs are available to provide additional debugging support. Use #include diff --git a/include/freetype/config/ftoption.h b/include/freetype/config/ftoption.h index 4d6bfa165..147fe6da2 100644 --- a/include/freetype/config/ftoption.h +++ b/include/freetype/config/ftoption.h @@ -445,7 +445,7 @@ FT_BEGIN_HEADER * * This option needs a C99 compiler. */ -/* #define FT_LOGGING */ +/* #define FT_DEBUG_LOGGING */ /************************************************************************** diff --git a/include/freetype/ftlogging.h b/include/freetype/ftlogging.h index 6f65ec7ad..2880f9492 100644 --- a/include/freetype/ftlogging.h +++ b/include/freetype/ftlogging.h @@ -36,11 +36,11 @@ FT_BEGIN_HEADER * External Debugging APIs * * @abstract: - * Public APIs to control the `FT_LOGGING` macro. + * Public APIs to control the `FT_DEBUG_LOGGING` macro. * * @description: * This section contains the declarations of public functions that - * enables fine control of what the `FT_LOGGING` macro outputs. + * enables fine control of what the `FT_DEBUG_LOGGING` macro outputs. * */ @@ -66,8 +66,8 @@ FT_BEGIN_HEADER * ``` * * @note: - * This function is only available if compilation option `@FT_LOGGING` - * is set. + * This function is only available if compilation option + * `FT_DEBUG_LOGGING` is set. */ FT_EXPORT( void ) FT_Trace_Set_Level( const char* tracing_level ); @@ -85,8 +85,8 @@ FT_BEGIN_HEADER * * * @note: - * This function is only available if compilation option `@FT_LOGGING` - * is set. + * This function is only available if compilation option + * `FT_DEBUG_LOGGING` is set. */ FT_EXPORT( void ) FT_Trace_Set_Default_Level( void ); @@ -131,8 +131,8 @@ FT_BEGIN_HEADER * New logging function. * * @note: - * This function is only available if compilation option `@FT_LOGGING` - * is set. + * This function is only available if compilation option + * `FT_DEBUG_LOGGING` is set. */ FT_EXPORT( void ) FT_Set_Log_Handler( FT_Custom_Log_Handler handler ); @@ -148,8 +148,8 @@ FT_BEGIN_HEADER * log handler to FreeType's built-in version. * * @note: - * This function is only available if compilation option `@FT_LOGGING` - * is set. + * This function is only available if compilation option + * `FT_DEBUG_LOGGING` is set. */ FT_EXPORT( void ) FT_Set_Default_Log_Handler( void ); diff --git a/include/freetype/internal/ftdebug.h b/include/freetype/internal/ftdebug.h index 9d83f9757..655b50abd 100644 --- a/include/freetype/internal/ftdebug.h +++ b/include/freetype/internal/ftdebug.h @@ -31,20 +31,20 @@ #include "compiler-macros.h" -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING #include <../src/dlg/dlg/dlg.h> #include <../src/dlg/dlg/output.h> #include -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ FT_BEGIN_HEADER - /* force the definition of FT_DEBUG_LEVEL_TRACE if FT_LOGGING is */ - /* already defined. */ - /* */ -#ifdef FT_LOGGING + /* force the definition of FT_DEBUG_LEVEL_TRACE if FT_DEBUG_LOGGING is */ + /* already defined. */ + /* */ +#ifdef FT_DEBUG_LOGGING #undef FT_DEBUG_LEVEL_TRACE #define FT_DEBUG_LEVEL_TRACE #endif @@ -104,11 +104,11 @@ FT_BEGIN_HEADER /************************************************************************* * - * If FT_LOGGING is enabled, tracing messages are sent to dlg's API. - * If FT_LOGGING is disabled, tracing messages are sent to `FT_Message` - * (defined in ftdebug.c). + * If FT_DEBUG_LOGGING is enabled, tracing messages are sent to dlg's API. + * If FT_DEBUG_LOGGING is disabled, tracing messages are sent to + * `FT_Message` (defined in ftdebug.c). */ -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /* we need two macros to convert the names of `FT_COMPONENT` to a string */ #define FT_LOGGING_TAG( x ) FT_LOGGING_TAG_( x ) @@ -132,7 +132,7 @@ FT_BEGIN_HEADER ft_remove_tag( dlg_tag ); \ } while( 0 ) -#else /* !FT_LOGGING */ +#else /* !FT_DEBUG_LOGGING */ #define FT_LOG( level, varformat ) \ do \ @@ -141,7 +141,7 @@ FT_BEGIN_HEADER FT_Message varformat; \ } while ( 0 ) -#endif /* !FT_LOGGING */ +#endif /* !FT_DEBUG_LOGGING */ #ifdef FT_DEBUG_LEVEL_TRACE @@ -259,14 +259,14 @@ FT_BEGIN_HEADER #ifdef FT_DEBUG_LEVEL_ERROR - /************************************************************************* + /************************************************************************** * - * If FT_LOGGING is enabled, error messages are sent to dlg's API. - * If FT_LOGGING is disabled, error messages are sent to `FT_Message` + * If FT_DEBUG_LOGGING is enabled, error messages are sent to dlg's API. + * If FT_DEBUG_LOGGING is disabled, error messages are sent to `FT_Message` * (defined in ftdebug.c). * */ -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING #define FT_ERROR( varformat ) \ do \ @@ -279,11 +279,11 @@ FT_BEGIN_HEADER ft_remove_tag( dlg_tag ); \ } while ( 0 ) -#else /* !FT_LOGGING */ +#else /* !FT_DEBUG_LOGGING */ #define FT_ERROR( varformat ) FT_Message varformat -#endif /* !FT_LOGGING */ +#endif /* !FT_DEBUG_LOGGING */ #else /* !FT_DEBUG_LEVEL_ERROR */ @@ -358,7 +358,7 @@ FT_BEGIN_HEADER ft_debug_init( void ); -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /************************************************************************** * @@ -388,7 +388,7 @@ FT_BEGIN_HEADER /************************************************************************** * - * If FT_LOGGING macro is enabled, FreeType needs to initialize and + * If FT_DEBUG_LOGGING macro is enabled, FreeType needs to initialize and * un-initialize `FILE*`. * * These functions are defined in `ftdebug.c`. @@ -425,7 +425,7 @@ FT_BEGIN_HEADER FT_Logging_Callback( const char* fmt, ... ); -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ FT_END_HEADER diff --git a/src/base/ftdebug.c b/src/base/ftdebug.c index c8340bbd2..3230a022a 100644 --- a/src/base/ftdebug.c +++ b/src/base/ftdebug.c @@ -46,7 +46,7 @@ #include -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /************************************************************************** * @@ -87,7 +87,7 @@ dlg_handler ft_default_log_handler = NULL; FT_Custom_Log_Handler custom_output_handler = NULL; -#endif /* FT_LOGGING*/ +#endif /* FT_DEBUG_LOGGING*/ #ifdef FT_DEBUG_LEVEL_ERROR @@ -242,7 +242,7 @@ const char* ft2_debug = NULL; -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING if ( ft_custom_trace_level != NULL ) ft2_debug = ft_custom_trace_level; else @@ -263,7 +263,7 @@ if ( *p == ' ' || *p == '\t' || *p == ',' || *p == ';' || *p == '=' ) continue; -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /* check extra arguments for logging */ if ( *p == '-' ) @@ -304,7 +304,7 @@ } } -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ /* read toggle name, followed by ':' */ q = p; @@ -410,7 +410,7 @@ #endif /* !FT_DEBUG_LEVEL_TRACE */ -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING /************************************************************************** * @@ -608,7 +608,7 @@ va_end( ap ); } -#endif /* FT_LOGGING */ +#endif /* FT_DEBUG_LOGGING */ /* END */ diff --git a/src/base/ftinit.c b/src/base/ftinit.c index 7f9b65a4a..5dededd4f 100644 --- a/src/base/ftinit.c +++ b/src/base/ftinit.c @@ -202,7 +202,7 @@ FT_Memory memory; -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING ft_logging_init(); #endif @@ -252,7 +252,7 @@ /* discard memory manager */ FT_Done_Memory( memory ); -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING ft_logging_deinit(); #endif diff --git a/src/base/ftobjs.c b/src/base/ftobjs.c index 5b66848ab..83351ad93 100644 --- a/src/base/ftobjs.c +++ b/src/base/ftobjs.c @@ -5292,12 +5292,12 @@ if ( !memory || !alibrary ) return FT_THROW( Invalid_Argument ); -#ifndef FT_LOGGING +#ifndef FT_DEBUG_LOGGING #ifdef FT_DEBUG_LEVEL_ERROR /* init debugging support */ ft_debug_init(); #endif /* FT_DEBUG_LEVEL_ERROR */ -#endif /* !FT_LOGGING */ +#endif /* !FT_DEBUG_LOGGING */ /* first of all, allocate the library object */ if ( FT_NEW( library ) ) diff --git a/src/dlg/dlgwrap.c b/src/dlg/dlgwrap.c index ea034fb84..1a5d274a3 100644 --- a/src/dlg/dlgwrap.c +++ b/src/dlg/dlgwrap.c @@ -24,7 +24,7 @@ #include -#ifdef FT_LOGGING +#ifdef FT_DEBUG_LOGGING #include "dlg.c" #else /* ANSI C doesn't like empty source files */