Removed 'This file is part of DevLib ...'
[bertos.git] / cfg / debug.h
old mode 100755 (executable)
new mode 100644 (file)
index 73f22eb..432d6c3
@@ -1,8 +1,33 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Simple debug facilities for hosted and embedded C/C++ applications.
 
 /*#*
  *#* $Log$
+ *#* Revision 1.14  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.13  2006/03/22 13:34:34  bernie
+ *#* MSVC support.
+ *#*
+ *#* Revision 1.12  2006/03/22 09:48:23  bernie
+ *#* Simplify.
+ *#*
+ *#* Revision 1.11  2006/02/23 11:17:16  bernie
+ *#* Documentation fixes.
+ *#*
+ *#* Revision 1.10  2006/02/23 09:10:10  bernie
+ *#* Add even more code duplication until we properly refactor debug.h.
+ *#*
  *#* Revision 1.9  2006/02/23 08:40:33  bernie
  *#* TRACEMSG() support for compilers with no variadic macros.
  *#*
 #define DEVLIB_DEBUG_H
 
 #include <cfg/os.h>
-
-#if OS_HOSTED
-       /*
-        * For now, avoid dependency on compiler.h
-        */
-       #ifndef FORMAT
-       #define FORMAT(x,y,z) /* nothing */
-       #endif
-       #ifndef INLINE
-       #define INLINE static inline
-       #endif
-       #ifndef UNUSED_ARG
-       #ifdef __cplusplus
-               #define UNUSED_ARG(type,name) type
-       #else
-               #define UNUSED_ARG(type,name) type name
-       #endif
-       #endif
-#else /* !OS_HOSTED */
-       #include <cfg/compiler.h>
-#endif /* !OS_HOSTED */
+#include <cfg/compiler.h>
 
 
 /*
 #define CONFIG_KDEBUG_ASSERT_NO_TEXT  0
 #endif
 
+#if defined(__doxygen__)
+       /**
+        * Preprocessor symbol defined only for debug builds.
+        *
+        * The build infrastructure must arrange for _DEBUG to
+        * be predefined for all the source files being compiled.
+        *
+        * This is compatible with the MSVC convention for the
+        * default Debug and Release project targets.
+        */
+       #define _DEBUG 1
+#endif
 
-/*!
- * \def _DEBUG
- *
- * This preprocessor symbol is defined only in debug builds.
- *
- * The build infrastructure must arrange for _DEBUG to
- * be predefined for all source files being compiled.
- *
- * This is compatible with the Microsoft convention for
- * the default Debug and Release targets.
- */
 #ifdef _DEBUG
 
        // STLport specific: enable extra checks
        #undef NDEBUG
        #endif
 
-       /*!
+       /**
         * This macro duplicates the old MSVC trick of redefining
         * THIS_FILE locally to avoid the overhead of many duplicate
         * strings in ASSERT().
                #define THIS_FILE  __FILE__
        #endif
 
-       /*!
+       /**
         * This macro can be used to conditionally exclude one or more
         * statements conditioned on \c _DEBUG, avoiding the clutter
         * of ifdef/endif pairs.
                {
                        fputs(str, stderr);
                }
-               /* G++ can't inline functions with variable arguments... */
-               #define kprintf(fmt, ...) fprintf(stderr, fmt, ## __VA_ARGS__)
-               #define kvprintf(fmt, ap) vfprintf(stderr, fmt, ap)
+               #if COMPILER_VARIADIC_MACROS
+                       /* G++ can't inline functions with variable arguments... */
+                       #define kprintf(fmt, ...) fprintf(stderr, fmt, ## __VA_ARGS__)
+               #else
+                       #define kvprintf(fmt, ap) vfprintf(stderr, fmt, ap)
+                       INLINE int kprintf(const char *fmt, ...)
+                       {
+                               va_list ap;
+                               int result;
+
+                               va_start(ap, fmt);
+                               result = kvprintf(fmt, ap);
+                               va_end(ap);
+
+                               return result;
+                       }
+               #endif
                void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
 
                #ifndef ASSERT
 
        #endif /* !OS_HOSTED */
 
-       /*!
+       /**
         * \name Walls to detect data corruption
         * \{
         */
        #define CHECK_WALL(name)             __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
        /*\}*/
 
-       /*!
+       /**
         * Check that the given pointer actually points to an object
         * of the specified type.
         */
                ASSERT(dynamic_cast<_t>((_o)) != NULL); \
        }
 
-       /*!
+       /**
         * \name Debug object creation and destruction.
         *
         * These macros help track some kinds of leaks in C++ programs.