Wavepacket Common Headers

The Common Headers are a small set of headers (and only header files!) used to include and declare the lowest-level of expected system APIs. More...

Classes
class	wave_exception
enum	eCreateFlag {   eCreateIfNotExists = 1,   eNullIfNotExists = 0,   eErrorIfNotExists = 0 }
	used to specify object creation behavior More...
typedef unsigned char	byte_t
	basic (unsigned) 8-bit type
typedef uint16_t	word_t
	basic (unsigned) 16-bit type
typedef uint32_t	dword_t
	basic (unsigned) 32-bit type
typedef uint64_t	qword_t
	basic (unsigned) 64-bit type
typedef std::vector< std::string >	VecString
typedef std::set< std::string >	SetString
typedef std::map< std::string, std::string >	Dictionary
#define	IN
#define	OUT
#define	IO
#define	DPRINTF(args...)
#define	ASSERT(exp, args...)
#define	IMPLIES(x, y, args...)   ASSERT((!(x)) || (y), args)
#define	alloca   __builtin_alloca

---

Detailed Description

The Common Headers are a small set of headers (and only header files!) used to include and declare the lowest-level of expected system APIs.

---

Define Documentation

#define IN

Definition at line 65 of file common.h.

#define OUT

Definition at line 66 of file common.h.

#define IO

Definition at line 67 of file common.h.

#define DPRINTF

(

args...

)

Value:

{                                                               \
                fprintf(stderr, __FILE__ "(%d): ", __LINE__);           \
                fprintf(stderr, args);                                  \
                fprintf(stderr, "\n");                                  \
        }

Definition at line 91 of file common.h.

#define ASSERT	(		exp,
			args...
	)

Value:

{                                                               \
                if (!(exp)) {                                           \
                        DPRINTF("************************************");\
                        DPRINTF("ASSERTION FAILURE: %s", #exp );        \
                        DPRINTF(args);                                  \
                        DPRINTF("************************************");\
                        int * pv = NULL;                                \
                        *pv = 5;                                        \
                }                                                       \
        }

Definition at line 100 of file common.h.

#define IMPLIES	(		x,
			y,
			args...
	)			ASSERT((!(x)) || (y), args)

Definition at line 114 of file common.h.

#define alloca   __builtin_alloca

Definition at line 119 of file common.h.

---

Typedef Documentation

typedef unsigned char byte_t

basic (unsigned) 8-bit type

Definition at line 73 of file common.h.

typedef uint16_t word_t

basic (unsigned) 16-bit type

Definition at line 76 of file common.h.

typedef uint32_t dword_t

basic (unsigned) 32-bit type

Definition at line 79 of file common.h.

typedef uint64_t qword_t

basic (unsigned) 64-bit type

Definition at line 82 of file common.h.

typedef std::vector<std::string> VecString

Definition at line 86 of file common.h.

typedef std::set<std::string> SetString

Definition at line 87 of file common.h.

typedef std::map<std::string, std::string> Dictionary

Definition at line 88 of file common.h.

---

Enumeration Type Documentation

enum eCreateFlag

used to specify object creation behavior

Enumerator:

eCreateIfNotExists	yes, create if not there
eNullIfNotExists	no, return null or error
eErrorIfNotExists	same as above

Definition at line 130 of file common.h.