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

pantheios/util/backends/context.hpp

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/util/backends/context.hpp
00003  *
00004  * Purpose:     Implementation class to assist in the creation of back-ends.
00005  *
00006  * Created:     16th December 2006
00007  * Updated:     26th November 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 name(s) of Matthew Wilson and Synesis Software nor the
00024  *   names of any contributors may be used to endorse or promote products
00025  *   derived 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_UTIL_BACKENDS_HPP_CONTEXT
00048 #define PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT_MAJOR    3
00056 # define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT_MINOR    3
00057 # define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT_REVISION 2
00058 # define PANTHEIOS_VER_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT_EDIT     33
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_QUALITY_H_CONTRACT
00069 # include <pantheios/quality/contract.h>
00070 #endif /* !PANTHEIOS_INCL_PANTHEIOS_QUALITY_H_CONTRACT */
00071 
00072 #ifndef __cplusplus
00073 # error This file can only be used in C++ compilation units
00074 #endif /* !__cplusplus */
00075 
00076 /* /////////////////////////////////////////////////////////////////////////
00077  * Namespace
00078  */
00079 
00080 #if !defined(PANTHEIOS_NO_NAMESPACE)
00081 namespace pantheios
00082 {
00083 namespace util
00084 {
00085 namespace backends
00086 {
00087 #endif /* !PANTHEIOS_NO_NAMESPACE */
00088 
00089 /* /////////////////////////////////////////////////////////////////////////
00090  * Classes
00091  */
00092 
00141 class Context
00142 {
00145 public:
00146     typedef Context     class_type;
00148 
00151 protected:
00152     enum { rawLogArrayDimension = 10 };
00154 
00157 protected:
00167     Context(pan_char_t const* processIdentity, int id, pan_uint32_t flags, int severityMask);
00168     virtual ~Context() throw();
00170 
00173 public:
00185     int logEntry(int severity, pan_char_t const* entry, size_t cchEntry);
00187 
00190 private:
00193     virtual int rawLogEntry(int severity4, int severityX, const pan_slice_t (&ar)[rawLogArrayDimension], size_t cchTotal) = 0;
00194 
00199     virtual int rawLogEntry(int severity4, int severityX, pan_char_t const* entry, size_t cchEntry);
00201 
00204 protected:
00206     static size_t concatenateSlices(pan_char_t* dest, size_t cchDest, size_t numSlices, pan_slice_t const* slices);
00208 
00211 public:
00217     pan_char_t const*   getProcessIdentity() const;
00218     int                 getBackEndId() const;
00220 
00223 protected:
00224     pan_char_t* const   m_processIdentity;
00225     int const           m_id;
00226     pan_uint32_t const  m_flags;
00227     int const           m_severityMask;
00228 private:
00229     // 0: "["
00230     // 1: process Id
00231     // 2: "."
00232     // 3: thread Id
00233     // 4: "; "
00234     // 5: time
00235     // 6: ";  "
00236     // 5: severity
00237     // 8: "]: "
00238     // 9: entry
00239 
00240     pan_slice_t     m_slice0;
00241     pan_slice_t     m_slice1;
00242     pan_slice_t     m_slice2;
00243     pan_slice_t     m_slice4;
00244     pan_slice_t     m_slice6;
00245     pan_slice_t     m_slice8;
00247 
00250 private:
00251     Context(class_type const&);
00252     class_type& operator =(class_type const&);
00254 };
00255 
00256 /* /////////////////////////////////////////////////////////////////////////
00257  * Namespace
00258  */
00259 
00260 #if !defined(PANTHEIOS_NO_NAMESPACE)
00261 } // namespace backends
00262 } // namespace util
00263 } // namespace pantheios
00264 #endif /* !PANTHEIOS_NO_NAMESPACE */
00265 
00266 /* ////////////////////////////////////////////////////////////////////// */
00267 
00268 #endif /* !PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_HPP_CONTEXT */
00269 
00270 /* ///////////////////////////// end of file //////////////////////////// */

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