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

pantheios/backends/bec.WindowsConsole.h

Go to the documentation of this file.
00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/backends/bec.WindowsConsole.h
00003  *
00004  * Purpose:     Declaration of the Pantheios WindowsConsole Stock Back-end API.
00005  *
00006  * Created:     17th July 2006
00007  * Updated:     30th April 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_BACKENDS_H_BEC_WINDOWSCONSOLE
00048 #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE
00049 
00050 /* /////////////////////////////////////////////////////////////////////////
00051  * Version information
00052  */
00053 
00054 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00055 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE_MAJOR    5
00056 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE_MINOR    1
00057 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE_REVISION 1
00058 # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE_EDIT     24
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 
00072 /* /////////////////////////////////////////////////////////////////////////
00073  * Documentation
00074  */
00075 
00082 /* /////////////////////////////////////////////////////////////////////////
00083  * Constants
00084  */
00085 
00097 #define PANTHEIOS_BE_WINDOWSCONSOLE_F_NO_COLOURS          (0x00100000)
00098 
00099 /* /////////////////////////////////////////////////////////////////////////
00100  * Typedefs
00101  */
00102 
00107 struct pan_be_WindowsConsole_init_t
00108 {
00109 #if !defined(PANTHEIOS_DOCUMENTATION_SKIP_SECTION) && \
00110     !defined(PANTHEIOS_NO_NAMESPACE)
00111     typedef pantheios::pan_uint16_t pan_uint16_t;
00112     typedef pantheios::pan_uint32_t pan_uint32_t;
00113 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION && !PANTHEIOS_NO_NAMESPACE */
00114 
00115     pan_uint32_t    version;    
00116     pan_uint32_t    flags;      
00117     pan_uint16_t    colours[8]; 
00119 #ifdef __cplusplus
00120 public: /* Construction */
00121 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00122     pan_be_WindowsConsole_init_t();
00123 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00124 #endif /* __cplusplus */
00125 };
00126 #ifndef __cplusplus
00127 typedef struct pan_be_WindowsConsole_init_t     pan_be_WindowsConsole_init_t;
00128 #endif /* !__cplusplus */
00129 
00130 /* /////////////////////////////////////////////////////////////////////////
00131  * Application-defined functions
00132  */
00133 
00162 PANTHEIOS_CALL(void) pantheios_be_WindowsConsole_getAppInit(
00163     int                             backEndId
00164 ,   pan_be_WindowsConsole_init_t*   init
00165 ) /* throw() */;
00166 
00167 /* /////////////////////////////////////////////////////////////////////////
00168  * API functions
00169  */
00170 
00183 PANTHEIOS_CALL(void) pantheios_be_WindowsConsole_getDefaultAppInit(
00184     pan_be_WindowsConsole_init_t* init
00185 ) /* throw() */;
00186 
00190 PANTHEIOS_CALL(int) pantheios_be_WindowsConsole_init(
00191     PAN_CHAR_T const*                   processIdentity
00192 ,   int                                 id
00193 ,   pan_be_WindowsConsole_init_t const* init
00194 ,   void*                               param
00195 ,   void**                              ptoken
00196 );
00197 
00201 PANTHEIOS_CALL(void) pantheios_be_WindowsConsole_uninit(
00202     void* token
00203 );
00204 
00208 PANTHEIOS_CALL(int) pantheios_be_WindowsConsole_logEntry(
00209     void*               feToken
00210 ,   void*               beToken
00211 ,   int                 severity
00212 ,   PAN_CHAR_T const*   entry
00213 ,   size_t              cchEntry
00214 );
00215 
00241 PANTHEIOS_CALL(int) pantheios_be_WindowsConsole_parseArgs(
00242     size_t                          numArgs
00243 #ifdef PANTHEIOS_NO_NAMESPACE
00244 ,   struct pan_slice_t* const       args
00245 #else /* ? PANTHEIOS_NO_NAMESPACE */
00246 ,   pantheios::pan_slice_t* const   args
00247 #endif /* PANTHEIOS_NO_NAMESPACE */
00248 ,   pan_be_WindowsConsole_init_t*   init
00249 );
00250 
00251 /* ////////////////////////////////////////////////////////////////////// */
00252 
00253 #ifdef __cplusplus
00254 # ifndef PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT
00255 inline pan_be_WindowsConsole_init_t::pan_be_WindowsConsole_init_t()
00256 {
00257     pantheios_be_WindowsConsole_getDefaultAppInit(this);
00258 }
00259 # endif /* !PANTHEIOS_BE_INIT_NO_CPP_STRUCT_INIT */
00260 #endif /* __cplusplus */
00261 
00262 /* ////////////////////////////////////////////////////////////////////// */
00263 
00264 #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_WINDOWSCONSOLE */
00265 
00266 /* ///////////////////////////// end of file //////////////////////////// */

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