Formatter.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  * Copyright (c) 2004 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 
00039 #ifndef _OASYS_FORMATTER_H_
00040 #define _OASYS_FORMATTER_H_
00041 
00042 #include <stdio.h>
00043 #include <stdarg.h>
00044 
00045 #include "DebugDumpBuf.h"
00046 #include "DebugUtils.h"
00047 
00048 namespace oasys {
00049 
00074 class Formatter {
00075 public:
00089     virtual int format(char* buf, size_t sz) const = 0;
00090 
00097     static inline void assert_valid(const Formatter* obj);
00098 
00104     int debug_dump();
00105 
00106     virtual ~Formatter() {}
00107 
00108 #ifndef NDEBUG
00109 #define FORMAT_MAGIC 0xffeeeedd
00110     Formatter() : format_magic_(FORMAT_MAGIC) {}
00111     Formatter(const Formatter&) : format_magic_(FORMAT_MAGIC) {}
00112     unsigned int format_magic_;
00113 #else
00114     Formatter() {}
00115     Formatter(const Formatter&) {}
00116 #endif // NDEBUG
00117 
00118     
00119 };
00120 
00121 void __log_assert(bool x, const char* what, const char* file, int line);
00122 
00123 inline void
00124 Formatter::assert_valid(const Formatter* obj)
00125 {
00126     (void)obj; // avoid unused variable warning
00127 #ifndef NDEBUG
00128     __log_assert(obj->format_magic_ == FORMAT_MAGIC,
00129                  "Formatter object invalid -- maybe need a cast to Formatter*",
00130                  __FILE__, __LINE__);
00131 #endif
00132 }
00133 
00134 } // namespace oasys
00135 
00136 #endif /* _OASYS_FORMATTER_H_ */

Generated on Fri Dec 22 14:47:59 2006 for DTN Reference Implementation by  doxygen 1.5.1