estar/pdebug.hpp File Reference

---

Detailed Description

Compile-time utilities for adding/removing debug messages.

This file defines a couple of macros and classes/typedefs that make it easier to implement switchable debug messages:

• PDEBUG_ERR() writes a prefixed message to stderr, using fprintf()
• PDEBUG_OUT() does the same to stdout
• PDEBUG_OFF() has the same signature, but does nothing
• PDEBUG() is the same as PDEBUG_OUT() if ESTAR_VERBOSE_DEBUG or ESTAR_DEBUG are defined
• PVDEBUG() is the same as PDEBUG_OUT() if ESTAR_VERBOSE_DEBUG is defined
• estar::vdebugos is typedefed to std::ostringstream if ESTAR_VERBOSE_DEBUG is defined, otherwise it is typedefed to estar::fakeos which does nothing.
• estar::debugos is typedefed to std::ostringstream if ESTAR_VERBOSE_DEBUG or ESTAR_DEBUG are defined, otherwise it is typedefed to estar::fakeos which does nothing.

So, the way to use this header is simple. Include it, and use PDEBUG() to write debug messages and PVDEBUG() to write verbose debug messages. In case you want to use something resembling a std::ostream, use an instance of estar::debugos or estar::vdebugos, but then after filling them with messages you have to explicitly print their str().c_str() using PDEBUG() or PVDEBUG().

#include <string>
#include <stdio.h>

Include dependency graph for pdebug.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	estar
Classes
class	estar::fakeos
	Utility for compile-time switchable debug messages. More...
Defines
#define	PDEBUG_ERR(fmt, arg...)   fprintf(stderr, "%s(): "fmt, __func__, ## arg)
#define	PDEBUG_OUT(fmt, arg...)   fprintf(stdout, "%s(): "fmt, __func__, ## arg)
#define	PDEBUG_OFF(fmt, arg...)
#define	PVDEBUG   PDEBUG_OFF
#define	PDEBUG   PDEBUG_OFF
Typedefs
typedef fakeos	estar::vdebugos
typedef fakeos	estar::debugos

---

Define Documentation

#define PDEBUG   PDEBUG_OFF

#define PDEBUG_ERR	(	fmt,
		arg...		)	fprintf(stderr, "%s(): "fmt, __func__, ## arg)

#define PDEBUG_OFF	(	fmt,
		arg...		)

#define PDEBUG_OUT	(	fmt,
		arg...		)	fprintf(stdout, "%s(): "fmt, __func__, ## arg)

#define PVDEBUG   PDEBUG_OFF

---

E* Interpolated Graph Replanner Wed Dec 12 18:55:46 2007