From 50a1e7d73778e375f180f304a162caa9220ceb6c Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Fri, 16 Feb 2007 09:00:22 +0100 Subject: [PATCH] split out assert from debug.h --- SConstruct | 2 + samples/main-debug.cc | 1 + src/core/assert.cc | 41 +++++++++++++++++++ src/core/assert.h | 95 +++++++++++++++++++++++++++++++++++++++++++ src/core/debug.cc | 18 +------- src/core/debug.h | 65 +++-------------------------- 6 files changed, 145 insertions(+), 77 deletions(-) create mode 100644 src/core/assert.cc create mode 100644 src/core/assert.h diff --git a/SConstruct b/SConstruct index db6f8c9b5..dea42ab6f 100644 --- a/SConstruct +++ b/SConstruct @@ -19,6 +19,7 @@ core.add_sources([ 'reference-list-test.cc', 'callback-test.cc', 'debug.cc', + 'assert.cc', 'ptr.cc', 'test.cc' ]) @@ -41,6 +42,7 @@ core.add_inst_headers([ 'callback.h', 'ptr.h', 'debug.h', + 'assert.h', 'test.h' ]) diff --git a/samples/main-debug.cc b/samples/main-debug.cc index 303775582..396fcdb0c 100644 --- a/samples/main-debug.cc +++ b/samples/main-debug.cc @@ -1,5 +1,6 @@ /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ #include "ns3/debug.h" +#include "ns3/assert.h" NS_DEBUG_COMPONENT_DEFINE ("MyComponentA"); diff --git a/src/core/assert.cc b/src/core/assert.cc new file mode 100644 index 000000000..c780a37ea --- /dev/null +++ b/src/core/assert.cc @@ -0,0 +1,41 @@ +/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ +/* + * Copyright (c) 2006 INRIA + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation; + * + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * Author: Mathieu Lacage + */ + +#include "assert.h" + +namespace ns3 { + +void +AssertBreakpoint (void) +{ + int *a = 0; + /** + * we test here to allow a debugger to change the value of + * the variable 'a' to allow the debugger to avoid the + * subsequent segfault. + */ + if (a == 0) + { + *a = 0; + } +} + +}//namespace ns3 diff --git a/src/core/assert.h b/src/core/assert.h new file mode 100644 index 000000000..bf3fed648 --- /dev/null +++ b/src/core/assert.h @@ -0,0 +1,95 @@ +/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ +/* + * Copyright (c) 2006 INRIA + * All rights reserved. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation; + * + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * Author: Mathieu Lacage + */ +#ifndef ASSERT_H +#define ASSERT_H + +/** + * \defgroup assert + * \brief assert functions and macros + * + * The assert macros are used to verify + * at runtime that a certain condition is true. If it is + * not true, the program halts. These checks are built + * into the program only in debugging builds. They are + * removed in optimized builds. + */ + +namespace ns3 { + +/** + * \ingroup debugging + * + * When an NS_ASSERT cannot verify its condition, + * this function is called. This is where you should + * be able to put a breakpoint with a debugger if + * you want to catch assertions before the program + * halts. + */ +void AssertBreakpoint (void); + +}//namespace ns3 + +#ifdef NS3_ASSERT_ENABLE + +#include + +/** + * \ingroup assert + * \param condition condition to verifiy. + * + * At runtime, in debugging builds, if this condition is not + * true, the program prints the source file, line number and + * unverified condition and halts in the ns3::AssertBreakpoint + * function. + */ +#define NS_ASSERT(condition) \ + if (!(condition)) \ + { \ + std::cout << "assert failed. file=" << __FILE__ << \ + ", line=" << __LINE__ << ", cond=\""#condition << \ + "\"" << std::endl; \ + ns3::AssertBreakpoint (); \ + } + +/** + * \ingroup assert + * \param condition condition to verifiy. + * \param message message to output + * + * At runtime, in debugging builds, if this condition is not + * true, the program prints the message to output and + * halts in the ns3::AssertBreakpoint function. + */ +#define NS_ASSERT_MSG(condition, message) \ + if (!(condition)) \ + { \ + std::cout << message << std::endl; \ + ns3::AssertBreakpoint (); \ + } + +#else /* NS3_ASSERT_ENABLE */ + +#define NS_ASSERT(cond) +#define NS_ASSERT_MSG(cond,msg) + +#endif /* NS3_ASSERT_ENABLE */ + +#endif /* ASSERT_H */ diff --git a/src/core/debug.cc b/src/core/debug.cc index 162e23578..a250be103 100644 --- a/src/core/debug.cc +++ b/src/core/debug.cc @@ -96,7 +96,7 @@ DebugComponentEnableEnvVar (void) } -DebugComponent::DebugComponent (std::string name) +DebugComponent::DebugComponent (char const * name) : m_isEnabled (false) { for (ComponentListI i = g_components.begin (); @@ -168,22 +168,6 @@ DebugComponentPrintList (void) } } -void -AssertBreakpoint (void) -{ - int *a = 0; - /** - * we test here to allow a debugger to change the value of - * the variable 'a' to allow the debugger to avoid the - * subsequent segfault. - */ - if (a == 0) - { - *a = 0; - } -} - - }; // namespace ns3 diff --git a/src/core/debug.h b/src/core/debug.h index 51705241b..31253d4a8 100644 --- a/src/core/debug.h +++ b/src/core/debug.h @@ -21,22 +21,10 @@ #ifndef DEBUG_H #define DEBUG_H -#include -#include - /** * \defgroup debugging * \brief Debugging functions and macros * - * The ns3 debugging support provides a few simple macros - * for debugging and sending out messages to the user. There - * two classes of functionality: - * - ASSERT functionality: macros which are used to verify - * at runtime that a certain condition is true. If it is - * not true, the program halts. These checks are built - * into the program only in debugging builds. They are - * removed in optimized builds. - * * - DEBUG functionality: macros which allow developers to * send information out on screen only in debugging builds. * All debug messages are disabled by default. To enable @@ -75,7 +63,7 @@ void DebugComponentPrintList (void); class DebugComponent { public: - DebugComponent (std::string name); + DebugComponent (char const *name); bool IsEnabled (void); void Enable (void); void Disable (void); @@ -83,22 +71,15 @@ private: bool m_isEnabled; }; -/** - * \ingroup debugging - * - * When an NS_ASSERT cannot verify its condition, - * this function is called. This is where you should - * be able to put a breakpoint with a debugger if - * you want to catch assertions before the program - * halts. - */ -void AssertBreakpoint (void); - }; // namespace ns3 #ifdef NS3_DEBUG_ENABLE +#include +#include + + /** * \ingroup debugging * \param name a string @@ -130,46 +111,10 @@ void AssertBreakpoint (void); std::cout << msg << std::endl; \ } -/** - * \ingroup debugging - * \param condition condition to verifiy. - * - * At runtime, in debugging builds, if this condition is not - * true, the program prints the source file, line number and - * unverified condition and halts in the ns3::AssertBreakpoint - * function. - */ -#define NS_ASSERT(condition) \ - if (!(condition)) \ - { \ - std::cout << "assert failed. file=" << __FILE__ << \ - ", line=" << __LINE__ << ", cond=\""#condition << \ - "\"" << std::endl; \ - ns3::AssertBreakpoint (); \ - } - -/** - * \ingroup debugging - * \param condition condition to verifiy. - * \param message message to output - * - * At runtime, in debugging builds, if this condition is not - * true, the program prints the message to output and - * halts in the ns3::AssertBreakpoint function. - */ -#define NS_ASSERT_MSG(condition, message) \ - if (!(condition)) \ - { \ - std::cout << message << std::endl; \ - ns3::AssertBreakpoint (); \ - } - #else /* NS3_DEBUG_ENABLE */ #define NS_DEBUG_COMPONENT_DEFINE(name) #define NS_DEBUG(x) -#define NS_ASSERT(cond) -#define NS_ASSERT_MSG(cond,msg) #endif /* NS3_DEBUG_ENABLE */