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

pantheios/backends/bec.WindowsDebugger.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/backends/bec.WindowsDebugger.h
00003  *
00004  * Purpose:     Declaration of the Pantheios WindowsDebugger Stock Back-end API.
00005  *
00006  * Created:     21st June 2005
00007  * Updated:     30th April 2010
00008  *
00009  * Home:        http://www.pantheios.org/
00010  *
00011  * Copyright (c) 2005-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_BACKENDS_H_BEC_WINDOWSDEBUGGER
00048 #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER_MAJOR       3
00056 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER_MINOR       1
00057 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER_REVISION    1
00058 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER_EDIT        22
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_H_BACKEND
00069 # include <pantheios/backend.h>
00070 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_BACKEND */
00071 #ifndef PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS
00072 # include <pantheios/util/backends/arguments.h>
00073 #endif /* !PANTHEIOS_INCL_PANTHEIOS_UTIL_BACKENDS_H_ARGUMENTS */
00074 
00075 /* /////////////////////////////////////////////////////////////////////////
00076  * Documentation
00077  */
00078 
00084 /* /////////////////////////////////////////////////////////////////////////
00085  * Constants
00086  */
00087 
00093 /* /////////////////////////////////////////////////////////////////////////
00094  * Typedefs
00095  */
00096 
00102 struct pan_be_WindowsDebugger_init_t
00103 {
00104 #if !defined(PANTHEIOS_DOCUMENTATION_SKIP_SECTION) && \
00105     !defined(PANTHEIOS_NO_NAMESPACE)
00106     typedef pantheios::pan_uint32_t pan_uint32_t;
00107 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION && !PANTHEIOS_NO_NAMESPACE */
00108 
00109     pan_uint32_t    version;    
00110     pan_uint32_t    flags;      
00112 #ifdef __cplusplus
00113 public: /* Construction */
00114 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00115     pan_be_WindowsDebugger_init_t();
00116 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00117 #endif /* __cplusplus */
00118 };
00119 #ifndef __cplusplus
00120 typedef struct pan_be_WindowsDebugger_init_t    pan_be_WindowsDebugger_init_t;
00121 #endif /* !__cplusplus */
00122 
00123 /* /////////////////////////////////////////////////////////////////////////
00124  * Application-defined functions
00125  */
00126 
00133 PANTHEIOS_CALL(void) pantheios_be_WindowsDebugger_getAppInit(
00134     int                             backEndId
00135 ,   pan_be_WindowsDebugger_init_t*  init
00136 ) /* throw() */;
00137 
00138 /* /////////////////////////////////////////////////////////////////////////
00139  * API
00140  */
00141 
00147 PANTHEIOS_CALL(void) pantheios_be_WindowsDebugger_getDefaultAppInit(
00148     pan_be_WindowsDebugger_init_t*  init
00149 ) /* throw() */;
00150 
00154 PANTHEIOS_CALL(int) pantheios_be_WindowsDebugger_init(
00155     PAN_CHAR_T const*                             processIdentity
00156 ,   int                                     id
00157 ,   pan_be_WindowsDebugger_init_t const*    init
00158 ,   void*                                   reserved
00159 ,   void**                                  ptoken
00160 );
00161 
00165 PANTHEIOS_CALL(void) pantheios_be_WindowsDebugger_uninit(
00166     void* token
00167 );
00168 
00172 PANTHEIOS_CALL(int) pantheios_be_WindowsDebugger_logEntry(
00173     void*               feToken
00174 ,   void*               beToken
00175 ,   int                 severity
00176 ,   PAN_CHAR_T const*   entry
00177 ,   size_t              cchEntry
00178 );
00179 
00208 #define pantheios_be_WindowsDebugger_parseArgs(num, args, init)     pantheios_be_parseStockArgs((num), (args), (NULL == (init)) ? NULL : (&(init)->flags))
00209 
00210 
00211 /* ////////////////////////////////////////////////////////////////////// */
00212 
00213 #ifdef __cplusplus
00214 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00215 inline pan_be_WindowsDebugger_init_t::pan_be_WindowsDebugger_init_t()
00216 {
00217     pantheios_be_WindowsDebugger_getDefaultAppInit(this);
00218 }
00219 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00220 #endif /* __cplusplus */
00221 
00222 /* ////////////////////////////////////////////////////////////////////// */
00223 
00224 #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_WINDOWSDEBUGGER */
00225 
00226 /* ///////////////////////////// end of file //////////////////////////// */

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