---

DebugAids.h

Go to the documentation of this file.

#ifndef CLASSLIB_DEBUG_H
# define CLASSLIB_DEBUG_H

//<<<<<< INCLUDES                                                       >>>>>>

# include "classlib/utils/Macros.h"
# include "classlib/sysapi/IOTypes.h"
# include <cstddef>

namespace lat {
//<<<<<< PUBLIC DEFINES                                                 >>>>>>

# ifdef CLASSLIB_FUNCTION
// Define for the function name in <<ASSERT>>.
#  define ASSERT_FUNC CLASSLIB_FUNCTION
# else
#  define ASSERT_FUNC 0
# endif

# undef ASSERT_ALWAYS
# undef ASSERT
# undef VERIFY
# undef ASSERT_VALID

# if !NDEBUG
#  define ASSERT_ALWAYS(f)      \
                ((f)?(void)0:   \
                 lat::DebugAids::failed (__FILE__,__LINE__,ASSERT_FUNC,#f))
#  define ASSERT(f)             \
                ((f)?(void)0:   \
                 lat::DebugAids::failed (__FILE__,__LINE__,ASSERT_FUNC,#f))
#  define VERIFY(f)             \
                ((f)?(void)0:   \
                 lat::DebugAids::failed (__FILE__,__LINE__,ASSERT_FUNC,#f))
#  define ASSERT_VALID(p)       \
                (lat::ASSERT_VALIDATOR((p),__FILE__,__LINE__,ASSERT_FUNC,#p))

# else // NDEBUG
#  define ASSERT_ALWAYS(f)      \
                ((f)?(void)0:   \
                 lat::DebugAids::failed (__FILE__,__LINE__,ASSERT_FUNC,0))
#  define ASSERT(f)             ((void)0)
#  define VERIFY(f)             ((void)(f))
#  define ASSERT_VALID(p)       ((void)0)
# endif // !NDEBUG

//<<<<<< PUBLIC CONSTANTS                                               >>>>>>
//<<<<<< PUBLIC TYPES                                                   >>>>>>

class logstream;

//<<<<<< PUBLIC VARIABLES                                               >>>>>>
//<<<<<< CLASS DECLARATIONS                                             >>>>>>

class Debuggable
{
public:
    virtual ~Debuggable (void);

    virtual void        validate (void) const;
    virtual void        log (logstream &to) const;
};

class DebugAids
{
public:
    typedef char                (*AssertHook) (const char *message);

    // Memory validation routines
    static bool                 validate (const char *str, int length = -1);
    static bool                 validate (const void *p,
                                          STDC::size_t bytes,
                                          bool rw);

    // Assertion failure support
    static void                 failed (const char *file, int line,
                                        const char *function,
                                        const char *expr);
    static int                  failIgnore (int count = -1);
    static AssertHook           failHook (AssertHook hook = 0);
    static IOFD                 failStdxxFd (IOFD fd = IOFD_INVALID);
    static char                 failStdxx (const char *message);
# ifdef _WIN32
    static char                 failMsgBox (const char *message);
# endif

    // Miscellaneous functions
    static void                 breakpoint (void);
    static IOFD                 stacktraceFd (IOFD fd = IOFD_INVALID);
    static void                 stacktrace (IOFD fd = IOFD_INVALID);
    static void                 coredump (int sig, ...);


private:
    static AssertHook           s_assertHook;
    static int                  s_assertIgnoreCount;
    static IOFD                 s_assertOutputFd;
    static IOFD                 s_stackTraceFd;
};

//<<<<<< PUBLIC FUNCTIONS                                               >>>>>>

void            AssertValid (const void *address);
void            AssertValid (const Debuggable *object);

logstream &     operator<< (logstream &to, const Debuggable &object);

template <class T>
inline void
ASSERT_VALIDATOR (const T *object, const char *file, int line,
                  const char *function, const char *expr)
{
    if (object && DebugAids::validate (object, sizeof (*object), false))
        lat::AssertValid (object);
    else
        DebugAids::failed (file, line, function, expr);
}

//<<<<<< INLINE PUBLIC FUNCTIONS                                        >>>>>>
//<<<<<< INLINE MEMBER FUNCTIONS                                        >>>>>>

} // namespace lat
#endif // CLASSLIB_DEBUG_H

---