[Gnash-commit] gnash ChangeLog libbase/log.h

[Sandro Santilli]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Sandro Santilli <strk>  07/04/16 09:08:38

Modified files:
        .              : ChangeLog 
        libbase        : log.h 

Log message:
        * libbase/log.h: draft documentation for the log_* functions.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.2883&r2=1.2884
http://cvs.savannah.gnu.org/viewcvs/gnash/libbase/log.h?cvsroot=gnash&r1=1.45&r2=1.46

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.2883
retrieving revision 1.2884
diff -u -b -r1.2883 -r1.2884
--- ChangeLog   16 Apr 2007 08:07:56 -0000      1.2883
+++ ChangeLog   16 Apr 2007 09:08:38 -0000      1.2884
@@ -1,5 +1,6 @@
 2007-04-16 Sandro Santilli <address@hidden>
 
+       * libbase/log.h: draft documentation for the log_* functions.
        * testsuite/misc-ming.all/matrix_test.c: add test for skewX() matrix
          (failures are just precision-related).
        * server/debugger.{cpp,h}: (matchWatchPoint) const-corrected

Index: libbase/log.h
===================================================================
RCS file: /sources/gnash/gnash/libbase/log.h,v
retrieving revision 1.45
retrieving revision 1.46
diff -u -b -r1.45 -r1.46
--- libbase/log.h       10 Apr 2007 18:06:37 -0000      1.45
+++ libbase/log.h       16 Apr 2007 09:08:38 -0000      1.46
@@ -14,7 +14,7 @@
 // along with this program; if not, write to the Free Software
 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
-/* $Id: log.h,v 1.45 2007/04/10 18:06:37 strk Exp $ */
+/* $Id: log.h,v 1.46 2007/04/16 09:08:38 strk Exp $ */
 
 #ifndef GNASH_LOG_H
 #define GNASH_LOG_H
@@ -163,30 +163,81 @@
 DSOEXPORT unsigned char *hexify(unsigned char *p, const unsigned char *s, int 
length, bool ascii);
 
 #ifdef __GNUC__
-DSOEXPORT void log_msg(const char* fmt, ...) __attribute__((format (printf, 1, 
2)));
-DSOEXPORT void log_error(const char* fmt, ...) __attribute__((format (printf, 
1, 2)));
-DSOEXPORT void log_warning(const char* fmt, ...) __attribute__((format 
(printf, 1, 2)));
-DSOEXPORT void log_trace(const char* fmt, ...) __attribute__((format (printf, 
1, 2)));
-DSOEXPORT void log_debug(const char* fmt, ...) __attribute__((format (printf, 
1, 2)));
-DSOEXPORT void log_action(const char* fmt, ...) __attribute__((format (printf, 
1, 2)));
-DSOEXPORT void log_parse(const char* fmt, ...) __attribute__((format (printf, 
1, 2)));
-DSOEXPORT void log_security(const char* fmt, ...) __attribute__((format 
(printf, 1, 2)));
-DSOEXPORT void log_swferror(const char* fmt, ...) __attribute__((format 
(printf, 1, 2)));
-DSOEXPORT void log_aserror(const char* fmt, ...) __attribute__((format 
(printf, 1, 2)));
-#else
-// Printf-style interfaces.
-DSOEXPORT void log_msg(const char* fmt, ...);
-DSOEXPORT void log_error(const char* fmt, ...);
-DSOEXPORT void log_warning(const char* fmt, ...);
-DSOEXPORT void log_trace(const char* fmt, ...);
-DSOEXPORT void log_debug(const char* fmt, ...);
-DSOEXPORT void log_action(const char* fmt, ...);
-DSOEXPORT void log_parse(const char* fmt, ...);
-DSOEXPORT void log_security(const char* fmt, ...);
-DSOEXPORT void log_swferror(const char* fmt, ...);
-DSOEXPORT void log_aserror(const char* fmt, ...);
+#define GNUC_LOG_ATTRS __attribute__((format (printf, 1, 2)))
 #endif
 
+/// Log a generic message. This is usually used for debugging, so I guess
+/// should be log_debug instead.
+//
+DSOEXPORT void log_msg(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log a error
+//
+/// Errors have to be used to warn user about missing Gnash features.
+///
+/// NOTE: it has to be decided what difference this makes with
+///       log_warning...
+///
+DSOEXPORT void log_error(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log a warning
+//
+/// Warnings have to be used to warn user about missing Gnash features.
+///
+/// NOTE: it has to be decided what difference this makes with
+///       log_error...
+///
+DSOEXPORT void log_warning(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Use only for explicit user traces
+//
+/// Current users are Global.cpp for _global.trace() and
+/// ASHandlers.cpp for ActionTrace
+///
+DSOEXPORT void log_trace(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log debug info (unused! deprecated?)
+DSOEXPORT void log_debug(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log action execution info
+//
+/// Wrap all calls to this function (and other related statements)
+/// into an IF_VERBOSE_ACTION macro, so to allow completely
+/// removing all the overhead at compile time and reduce it
+/// at runtime.
+///
+DSOEXPORT void log_action(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log parsing information
+//
+/// Wrap all calls to this function (and other related statements)
+/// into an IF_VERBOSE_PARSE macro, so to allow completely
+/// removing all the overhead at compile time and reduce it
+/// at runtime.
+///
+DSOEXPORT void log_parse(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log security information
+DSOEXPORT void log_security(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log a malformed SWF error
+//
+/// Wrap all calls to this function (and other related statements)
+/// into an IF_VERBOSE_MALFORMED_SWF macro, so to allow completely
+/// removing all the overhead at compile time and reduce it
+/// at runtime.
+///
+DSOEXPORT void log_swferror(const char* fmt, ...) GNUC_LOG_ATTRS;
+
+/// Log an ActionScript error
+//
+/// Wrap all calls to this function (and other related statements)
+/// into an IF_VERBOSE_ASCODING_ERRORS macro, so to allow completely
+/// removing all the overhead at compile time and reduce it
+/// at runtime.
+///
+DSOEXPORT void log_aserror(const char* fmt, ...) GNUC_LOG_ATTRS;
+
 // Define to 0 to completely remove parse debugging at compile-time
 #ifndef VERBOSE_PARSE
 #define VERBOSE_PARSE 1