Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

pantheios/inserters/hex_ptr.hpp

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/inserters/hex_ptr.hpp
00003  *
00004  * Purpose:     String inserters for pointers in Hexadecimal notation.
00005  *
00006  * Created:     11th October 2006
00007  * Updated:     12th December 2010
00008  *
00009  * Home:        http://www.pantheios.org/
00010  *
00011  * Copyright (c) 2006-2010, Matthew Wilson and Synesis Software
00012  * All rights reserved.
00013  *
00014  * Redistribution and use in source and binary forms, with or without
00015  * modification, are permitted provided that the following conditions are
00016  * met:
00017  *
00018  * - Redistributions of source code must retain the above copyright notice,
00019  *   this list of conditions and the following disclaimer.
00020  * - Redistributions in binary form must reproduce the above copyright
00021  *   notice, this list of conditions and the following disclaimer in the
00022  *   documentation and/or other materials provided with the distribution.
00023  * - Neither the names of Matthew Wilson and Synesis Software nor the names
00024  *   of any contributors may be used to endorse or promote products derived
00025  *   from this software without specific prior written permission.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00028  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00029  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00031  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038  *
00039  * ////////////////////////////////////////////////////////////////////// */
00040 
00041 
00047 #ifndef PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_HEX_PTR
00048 #define PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_HEX_PTR
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_HEX_PTR_MAJOR    1
00056 # define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_HEX_PTR_MINOR    3
00057 # define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_HEX_PTR_REVISION 1
00058 # define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_HEX_PTR_EDIT     16
00059 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00060 
00061 /* /////////////////////////////////////////////////////////////////////////
00062  * Includes
00063  */
00064 
00065 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
00066 # include <pantheios/pantheios.h>
00067 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */
00068 #ifndef PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_POINTER
00069 # include <pantheios/inserters/pointer.hpp>  // for pantheios::pointer
00070 #endif /* !PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_POINTER */
00071 
00072 /* /////////////////////////////////////////////////////////////////////////
00073  * Namespace
00074  */
00075 
00076 #if !defined(PANTHEIOS_NO_NAMESPACE)
00077 namespace pantheios
00078 {
00079 
00080 #endif /* !PANTHEIOS_NO_NAMESPACE */
00081 
00082 /* /////////////////////////////////////////////////////////////////////////
00083  * Classes
00084  */
00085 
00118 class hex_ptr
00119     : public pointer
00120 {
00121 public: // Member Constants
00122     enum
00123     {
00124             pointerHexWidth = sizeof(void*) * 2 
00126 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00127         ,   bitSize = pointerHexWidth
00128 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00129     };
00130 
00131 public: // Construction
00139     hex_ptr(void const volatile *p, int flags)
00140         : pointer(p, flags)
00141     {}
00142 
00147     explicit hex_ptr(void const volatile *p)
00148         : pointer(p,  pointerHexWidth, fmt::fullHex)
00149     {}
00150 
00157     hex_ptr(void const volatile *p, int minWidth, int format)
00158         : pointer(p, minWidth, format)
00159     {}
00160 };
00161 
00162 /* /////////////////////////////////////////////////////////////////////////
00163  * Namespace
00164  */
00165 
00166 #if !defined(PANTHEIOS_NO_NAMESPACE)
00167 } /* namespace pantheios */
00168 #endif /* !PANTHEIOS_NO_NAMESPACE */
00169 
00170 /* /////////////////////////////////////////////////////////////////////////
00171  * Inclusion
00172  */
00173 
00174 #ifdef STLSOFT_PPF_pragma_once_SUPPORT
00175 # pragma once
00176 #endif /* STLSOFT_PPF_pragma_once_SUPPORT */
00177 
00178 /* ////////////////////////////////////////////////////////////////////// */
00179 
00180 #endif /* !PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_HEX_PTR */
00181 
00182 /* ///////////////////////////// end of file //////////////////////////// */

pantheios Library documentation © Matthew Wilson & Synesis Software, 2006-2011 SourceForge.net Logo