X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=cfg%2Fdebug.h;h=432d6c39fa890831eaf645584add840b24ba14ed;hb=9ba9dcf2a59a952609e19154e11de3e2478cbf42;hp=26dbdf0acd80517ac8951bd9e1c6e430fab76e93;hpb=2ee09ed277f39d19bb1bd814de808432bbfa4ac9;p=bertos.git

diff --git a/cfg/debug.h b/cfg/debug.h
old mode 100755
new mode 100644
index 26dbdf0a..432d6c39
--- a/cfg/debug.h
+++ b/cfg/debug.h
@@ -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.
@@ -17,6 +42,39 @@
 
 /*#*
  *#* $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.
+ *#*
+ *#* Revision 1.8  2006/02/23 08:33:04  bernie
+ *#* Fix for compilers without variadic macros support.
+ *#*
+ *#* Revision 1.7  2006/02/20 02:01:56  bernie
+ *#* Depend on cfg/os.h.
+ *#*
+ *#* Revision 1.6  2006/02/17 22:28:37  bernie
+ *#* Support TRACE() and TRACEMSG() on hosted targets.
+ *#*
+ *#* Revision 1.5  2005/11/04 16:09:03  bernie
+ *#* Doxygen workaround.
+ *#*
+ *#* Revision 1.4  2005/07/03 15:18:52  bernie
+ *#* Typo.
+ *#*
  *#* Revision 1.3  2005/06/27 21:23:55  bernie
  *#* Rename cfg/config.h to appconfig.h.
  *#*
@@ -53,37 +111,8 @@
 #ifndef DEVLIB_DEBUG_H
 #define DEVLIB_DEBUG_H
 
-/*
- * Try to guess whether we're running in a hosted or embedded environment.
- */
-#ifndef OS_HOSTED
-	#if defined(__unix__) || defined(_WIN32)
-		#define OS_HOSTED  1
-	#else
-		#define OS_HOSTED  0
-	#endif
-#endif /* !OS_HOSTED */
-
-#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/os.h>
+#include <cfg/compiler.h>
 
 
 /*
@@ -97,18 +126,19 @@
 #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 prepredefined 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
@@ -127,7 +157,7 @@
 	#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().
@@ -136,10 +166,10 @@
 		#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.
+	 * of ifdef/endif pairs.
 	 *
 	 * \code
 	 *     struct FooBar
@@ -170,17 +200,33 @@
 		{
 			fputs(str, stderr);
 		}
-		/* G++ can't inline functions with variable arguments... */
-		#define kprintf(fmt, ...) fprintf(stderr, fmt, ## __VA_ARGS__)
+		#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
 			#include <assert.h>
 			#define ASSERT(x) assert(x)
 		#endif /* ASSERT */
+		#define ASSERT2(x, help)  ASSERT(help && x)
 
-		/*!
-		 * Check that the given pointer is not NULL or pointing to raw memory.
+		/**
+		 * Check that the given pointer is either NULL or pointing to valid memory.
 		 *
 		 * The assumption here is that valid pointers never point to low
 		 * memory regions.  This helps catching pointers taken from
@@ -188,7 +234,32 @@
 		 */
 		#define ASSERT_VALID_PTR(p)  ASSERT((unsigned long)(p) > 0x200)
 
+		/**
+		 * Check that the given pointer is not pointing to invalid memory.
+		 *
+		 * \see ASSERT_VALID_PTR()
+		 */
 		#define ASSERT_VALID_PTR_OR_NULL(p)  ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
+
+		#if !CONFIG_KDEBUG_DISABLE_TRACE
+			#define TRACE  kprintf("%s()\n", __func__)
+			#if COMPILER_VARIADIC_MACROS
+				#define TRACEMSG(msg,...) kprintf("%s(): " msg, __func__, ## __VA_ARGS__)
+			#else
+				INLINE void TRACEMSG(const char *fmt, ...)
+				{
+					va_list va;
+					va_start(va, fmt);
+					kprintf("%s(): ", __func__);
+					kvprintf(fmt, va);
+					va_end(va);
+				}
+			#endif
+		#else
+			#define TRACE  do {} while(0)
+			#define TRACEMSG(...)  do {} while(0)
+		#endif
+
 	#else /* !OS_HOSTED */
 
 		#include <appconfig.h>  /* CONFIG_KDEBUG_ASSERT_NO_TEXT */
@@ -248,7 +319,7 @@
 
 	#endif /* !OS_HOSTED */
 
-	/*!
+	/**
 	 * \name Walls to detect data corruption
 	 * \{
 	 */
@@ -260,7 +331,7 @@
 	#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.
 	 */
@@ -269,7 +340,7 @@
 		ASSERT(dynamic_cast<_t>((_o)) != NULL); \
 	}
 
-	/*!
+	/**
 	 * \name Debug object creation and destruction.
 	 *
 	 * These macros help track some kinds of leaks in C++ programs.
@@ -334,7 +405,14 @@
 	#define ASSERT_VALID_PTR_OR_NULL(p)  ((void)0)
 	#define ASSERT_VALID_OBJ(_t, _o)     ((void)0)
 	#define TRACE                        do {} while (0)
-	#define TRACEMSG(x,...)              do {} while (0)
+	#if COMPILER_VARIADIC_MACROS
+		#define TRACEMSG(x, ...)         do {} while (0)
+	#else
+		INLINE void TRACEMSG(UNUSED_ARG(const char *, msg), ...)
+		{
+			/* NOP */
+		}
+	#endif
 
 	#define DECLARE_WALL(name, size)     /* nothing */
 	#define FWD_DECLARE_WALL(name, size) /* nothing */
@@ -354,12 +432,12 @@
 	INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ }
 	INLINE void kdump(UNUSED_ARG(const void *, buf), UNUSED_ARG(size_t, len)) { /* nop */ }
 
-	#ifdef __cplusplus
+	#if defined(__cplusplus) && COMPILER_VARIADIC_MACROS
 		/* G++ can't inline functions with variable arguments... */
 		#define kprintf(fmt,...) do { (void)(fmt); } while(0)
 	#else
 		/* ...but GCC can. */
-		INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
+	    INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
 	#endif
 
 #endif /* _DEBUG */