common.h

Go to the documentation of this file.

/*
 * common.h
 *
 * Copyright 2002,2008,2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Most wavepacket programs use this header first for common definitions.
 */

#ifndef WAVEPACKET_COMMON_H__
#define WAVEPACKET_COMMON_H__


/// \ingroup wavepacket_top
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup   common Wavepacket Common Headers
///
/// The Common Headers are a small set of headers (and \em only header files!)
/// used to include and declare the lowest-level of expected system APIs.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


// includes --------------------------------------------------------------------
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <string>
#include <vector>
#include <map>
#include <set>


// function parameter decoration
#define IN      /* does nothing */
#define OUT     /* does nothing */
#define IO      /* does nothing */


// basic types

/// basic (unsigned) 8-bit type
typedef unsigned char byte_t;

/// basic (unsigned) 16-bit type
typedef uint16_t word_t;

/// basic (unsigned) 32-bit type
typedef uint32_t dword_t;

/// basic (unsigned) 64-bit type
typedef uint64_t qword_t;


// strings and collections of strings
typedef std::vector<std::string> VecString;
typedef std::set<std::string> SetString;
typedef std::map<std::string, std::string> Dictionary;


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

// there can be a lot of debug statements *after* the assertion failure,
// so this text needs to be pretty visible.
#define ASSERT(exp, args...)                                            \
        {                                                               \
                if (!(exp)) {                                           \
                        DPRINTF("************************************");\
                        DPRINTF("ASSERTION FAILURE: %s", #exp );        \
                        DPRINTF(args);                                  \
                        DPRINTF("************************************");\
                        int * pv = NULL;                                \
                        *pv = 5;                                        \
                }                                                       \
        }

//                      exit(EXIT_FAILURE);

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


// alloca() function
#ifndef alloca
#define alloca __builtin_alloca
#endif  // alloca


// include the exception header
#include "wave_ex.h"


// very common enums

/// used to specify object creation behavior
enum eCreateFlag {
        eCreateIfNotExists      = 1, ///< yes, create if not there
        eNullIfNotExists        = 0, ///< no, return null or error
        eErrorIfNotExists       = 0  ///< same as above
};



#endif  // WAVEPACKET_COMMON_H__