STLSoft: winstl/util/struct_initialisers.hpp Source File

00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        winstl/util/struct_initialisers.hpp
00003  *
00004  * Purpose:     Functions for initialising Win32 structures.
00005  *
00006  * Created:     20th October 1994
00007  * Updated:     10th August 2009
00008  *
00009  * Home:        http://stlsoft.org/
00010  *
00011  * Copyright (c) 1994-2009, 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 met:
00016  *
00017  * - Redistributions of source code must retain the above copyright notice, this
00018  *   list of conditions and the following disclaimer.
00019  * - Redistributions in binary form must reproduce the above copyright notice,
00020  *   this list of conditions and the following disclaimer in the documentation
00021  *   and/or other materials provided with the distribution.
00022  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
00023  *   any 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 "AS IS"
00027  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00029  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00030  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00031  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00032  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00033  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00034  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00036  * POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * ////////////////////////////////////////////////////////////////////// */
00039 
00040 
00048 #ifndef WINSTL_INCL_WINSTL_UTIL_HPP_STRUCT_INITIALISERS
00049 #define WINSTL_INCL_WINSTL_UTIL_HPP_STRUCT_INITIALISERS
00050 
00051 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00052 # define WINSTL_VER_WINSTL_UTIL_HPP_STRUCT_INITIALISERS_MAJOR       4
00053 # define WINSTL_VER_WINSTL_UTIL_HPP_STRUCT_INITIALISERS_MINOR       0
00054 # define WINSTL_VER_WINSTL_UTIL_HPP_STRUCT_INITIALISERS_REVISION    4
00055 # define WINSTL_VER_WINSTL_UTIL_HPP_STRUCT_INITIALISERS_EDIT        220
00056 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00057 
00058 /* /////////////////////////////////////////////////////////////////////////
00059  * Includes
00060  */
00061 
00062 #ifndef WINSTL_INCL_WINSTL_H_WINSTL
00063 # include <winstl/winstl.h>
00064 #endif /* !WINSTL_INCL_WINSTL_H_WINSTL */
00065 
00066 /* /////////////////////////////////////////////////////////////////////////
00067  * Namespace
00068  */
00069 
00070 #ifndef _WINSTL_NO_NAMESPACE
00071 # if defined(_STLSOFT_NO_NAMESPACE) || \
00072      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00073 /* There is no stlsoft namespace, so must define ::winstl */
00074 namespace winstl
00075 {
00076 # else
00077 /* Define stlsoft::winstl_project */
00078 
00079 namespace stlsoft
00080 {
00081 
00082 namespace winstl_project
00083 {
00084 
00085 # endif /* _STLSOFT_NO_NAMESPACE */
00086 #endif /* !_WINSTL_NO_NAMESPACE */
00087 
00088 /* /////////////////////////////////////////////////////////////////////////
00089  * Functions
00090  */
00091 
00096 template <ss_typename_param_k T>
00097 inline void zero_struct(T &t)
00098 {
00099     ::ZeroMemory(&t, sizeof(T));
00100 }
00101 
00102 template <ss_typename_param_k T>
00103 struct init_traits;
00104 
00105 
00106 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00107 
00108 struct struct_has
00109 {
00110     struct no_init_member_type
00111     {};
00112 
00113     struct cb_member_type
00114     {};
00115 
00116     struct cBytes_member_type
00117     {};
00118 
00119     struct cbSize_member_type
00120     {};
00121 
00122     struct dwLength_member_type
00123     {};
00124 
00125     struct dwOSVersionInfoSize_member_type
00126     {};
00127 
00128     struct dwSize_member_type
00129     {};
00130 
00131     struct nLength_member_type
00132     {};
00133 
00134     struct uSize_member_type
00135     {};
00136 
00137 
00138     template <ss_typename_param_k T>
00139     static void init(T &t, no_init_member_type)
00140     {
00141         zero_struct(t);
00142     }
00143 
00144     template <ss_typename_param_k T>
00145     static void init(T &t, cb_member_type)
00146     {
00147         zero_struct(t);
00148         t.cb        =   sizeof(T);
00149     }
00150 
00151     template <ss_typename_param_k T>
00152     static void init(T &t, cBytes_member_type)
00153     {
00154         zero_struct(t);
00155         t.cBytes    =   sizeof(T);
00156     }
00157 
00158     template <ss_typename_param_k T>
00159     static void init(T &t, cbSize_member_type)
00160     {
00161         zero_struct(t);
00162         t.cbSize    =   sizeof(T);
00163     }
00164 
00165     template <ss_typename_param_k T>
00166     static void init(T &t, dwLength_member_type)
00167     {
00168         zero_struct(t);
00169         t.dwLength  =   sizeof(T);
00170     }
00171 
00172     template <ss_typename_param_k T>
00173     static void init(T &t, dwOSVersionInfoSize_member_type)
00174     {
00175         zero_struct(t);
00176         t.dwOSVersionInfoSize   =   sizeof(T);
00177     }
00178 
00179     template <ss_typename_param_k T>
00180     static void init(T &t, dwSize_member_type)
00181     {
00182         zero_struct(t);
00183         t.dwSize    =   sizeof(T);
00184     }
00185 
00186     template <ss_typename_param_k T>
00187     static void init(T &t, nLength_member_type)
00188     {
00189         zero_struct(t);
00190         t.nLength   =   sizeof(T);
00191     }
00192 
00193     template <ss_typename_param_k T>
00194     static void init(T &t, uSize_member_type)
00195     {
00196         zero_struct(t);
00197         t.uSize    =   sizeof(T);
00198     }
00199 };
00200 
00201 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00202 
00203 
00209 template <ss_typename_param_k T>
00210 inline void init_struct(T &t)
00211 {
00212     typedef ss_typename_type_k init_traits<T>::type     discriminator_t;
00213 
00214     struct_has::init(t, discriminator_t());
00215 }
00216 
00217 // Specialisations
00218 
00219 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00220 
00221 # define WINSTL_The_structure_(S, t)                \
00222                                                     \
00223     STLSOFT_TEMPLATE_SPECIALISATION                 \
00224     struct init_traits<S>                           \
00225     {                                               \
00226         typedef struct_##t  type;                   \
00227     }
00228 
00229 // WinBase.h:
00230 
00231 WINSTL_The_structure_(PROCESS_INFORMATION, has::no_init_member_type);
00232 WINSTL_The_structure_(OVERLAPPED, has::no_init_member_type);
00233 WINSTL_The_structure_(FILETIME, has::no_init_member_type);
00234 WINSTL_The_structure_(SYSTEMTIME, has::no_init_member_type);
00235 WINSTL_The_structure_(COMMPROP, has::no_init_member_type);
00236 WINSTL_The_structure_(COMSTAT, has::no_init_member_type);
00237 WINSTL_The_structure_(COMMTIMEOUTS, has::no_init_member_type);
00238 WINSTL_The_structure_(SYSTEM_INFO, has::no_init_member_type);
00239 WINSTL_The_structure_(EXCEPTION_DEBUG_INFO, has::no_init_member_type);
00240 WINSTL_The_structure_(CREATE_THREAD_DEBUG_INFO, has::no_init_member_type);
00241 WINSTL_The_structure_(CREATE_PROCESS_DEBUG_INFO, has::no_init_member_type);
00242 WINSTL_The_structure_(EXIT_THREAD_DEBUG_INFO, has::no_init_member_type);
00243 WINSTL_The_structure_(LOAD_DLL_DEBUG_INFO, has::no_init_member_type);
00244 WINSTL_The_structure_(UNLOAD_DLL_DEBUG_INFO, has::no_init_member_type);
00245 WINSTL_The_structure_(OUTPUT_DEBUG_STRING_INFO, has::no_init_member_type);
00246 WINSTL_The_structure_(RIP_INFO, has::no_init_member_type);
00247 WINSTL_The_structure_(DEBUG_EVENT, has::no_init_member_type);
00248 WINSTL_The_structure_(PROCESS_HEAP_ENTRY, has::no_init_member_type);
00249 WINSTL_The_structure_(BY_HANDLE_FILE_INFORMATION, has::no_init_member_type);
00250 WINSTL_The_structure_(TIME_ZONE_INFORMATION, has::no_init_member_type);
00251 WINSTL_The_structure_(WIN32_STREAM_ID, has::no_init_member_type);
00252 WINSTL_The_structure_(WIN32_FIND_DATAA, has::no_init_member_type);
00253 WINSTL_The_structure_(WIN32_FIND_DATAW, has::no_init_member_type);
00254 WINSTL_The_structure_(WIN32_FILE_ATTRIBUTE_DATA, has::no_init_member_type);
00255 WINSTL_The_structure_(SYSTEM_POWER_STATUS, has::no_init_member_type);
00256 #ifdef WINTRUST_H
00257 WINSTL_The_structure_(WIN_CERTIFICATE, has::no_init_member_type);
00258 WINSTL_The_structure_(WIN_TRUST_ACTDATA_CONTEXT_WITH_SUBJECT, has::no_init_member_type);
00259 WINSTL_The_structure_(WIN_TRUST_ACTDATA_SUBJECT_ONLY, has::no_init_member_type);
00260 WINSTL_The_structure_(WIN_TRUST_SUBJECT_FILE, has::no_init_member_type);
00261 WINSTL_The_structure_(WIN_TRUST_SUBJECT_FILE_AND_DISPLAY, has::no_init_member_type);
00262 WINSTL_The_structure_(WIN_SPUB_TRUSTED_PUBLISHER_DATA, has::no_init_member_type);
00263 #endif /* WINTRUST_H */
00264 
00265 
00266 WINSTL_The_structure_(STARTUPINFOA, has::cb_member_type);
00267 WINSTL_The_structure_(STARTUPINFOW, has::cb_member_type);
00268 
00269 WINSTL_The_structure_(OFSTRUCT, has::cBytes_member_type);
00270 
00271 WINSTL_The_structure_(MEMORYSTATUS, has::dwLength_member_type);
00272 
00273 WINSTL_The_structure_(OSVERSIONINFOA, has::dwOSVersionInfoSize_member_type);
00274 WINSTL_The_structure_(OSVERSIONINFOW, has::dwOSVersionInfoSize_member_type);
00275 #if !defined(STLSOFT_COMPILER_IS_DMC) && \
00276     (   !defined(STLSOFT_COMPILER_IS_MSVC) || \
00277         _MSC_VER >= 1200)
00278 WINSTL_The_structure_(OSVERSIONINFOEXA, has::dwOSVersionInfoSize_member_type);
00279 WINSTL_The_structure_(OSVERSIONINFOEXW, has::dwOSVersionInfoSize_member_type);
00280 #endif /* compiler */
00281 
00282 WINSTL_The_structure_(COMMCONFIG, has::dwSize_member_type);
00283 
00284 WINSTL_The_structure_(SECURITY_ATTRIBUTES, has::nLength_member_type);
00285 
00286 inline void init_struct(DCB &dcb)
00287 {
00288     zero_struct(dcb);
00289     dcb.DCBlength = sizeof(dcb);
00290 }
00291 
00292 // ShellApi.h
00293 
00294 #if defined(_INC_SHELLAPI) || \
00295     defined(_SHELLAPI_H) || \
00296     !defined(WIN32_LEAN_AND_MEAN)
00297 
00298 WINSTL_The_structure_(SHFILEOPSTRUCTA, has::no_init_member_type);
00299 WINSTL_The_structure_(SHFILEOPSTRUCTW, has::no_init_member_type);
00300 #if !defined(STLSOFT_COMPILER_IS_GCC)
00301 WINSTL_The_structure_(SHNAMEMAPPINGA, has::no_init_member_type);
00302 WINSTL_The_structure_(SHNAMEMAPPINGW, has::no_init_member_type);
00303 #endif /* compiler */
00304 WINSTL_The_structure_(SHFILEINFOA, has::no_init_member_type);
00305 WINSTL_The_structure_(SHFILEINFOW, has::no_init_member_type);
00306 
00307 
00308 #if !defined(STLSOFT_COMPILER_IS_DMC) && \
00309     !defined(STLSOFT_COMPILER_IS_GCC) && \
00310     (   !defined(STLSOFT_COMPILER_IS_MSVC) || \
00311         _MSC_VER >= 1200) && \
00312     defined(WINVER) && \
00313     WINVER >= 0x0400
00314 WINSTL_The_structure_(DRAGINFOA, has::uSize_member_type);
00315 WINSTL_The_structure_(DRAGINFOW, has::uSize_member_type);
00316 #endif /* WINVER */
00317 
00318 WINSTL_The_structure_(APPBARDATA, has::cbSize_member_type);
00319 WINSTL_The_structure_(SHELLEXECUTEINFOA, has::cbSize_member_type);
00320 WINSTL_The_structure_(SHELLEXECUTEINFOW, has::cbSize_member_type);
00321 #if !defined(STLSOFT_COMPILER_IS_DMC) && \
00322     (   !defined(STLSOFT_COMPILER_IS_GCC) || \
00323         __GNUC__ > 3 || \
00324         (   __GNUC__ == 3 && \
00325             __GNUC_MINOR__ > 2)) && \
00326     (   !defined(STLSOFT_COMPILER_IS_MSVC) || \
00327         _MSC_VER >= 1200)
00328 WINSTL_The_structure_(SHQUERYRBINFO, has::cbSize_member_type);
00329 #endif /* compiler */
00330 WINSTL_The_structure_(NOTIFYICONDATAA, has::cbSize_member_type);
00331 WINSTL_The_structure_(NOTIFYICONDATAW, has::cbSize_member_type);
00332 
00333 #endif /* _INC_SHELLAPI || _SHELLAPI_H || !WIN32_LEAN_AND_MEAN */
00334 
00335 #endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
00336 
00338 // Unit-testing
00339 
00340 #ifdef STLSOFT_UNITTEST
00341 # include "./unittest/struct_initialisers_unittest_.h"
00342 #endif /* STLSOFT_UNITTEST */
00343 
00344 /* ////////////////////////////////////////////////////////////////////// */
00345 
00346 #ifndef _WINSTL_NO_NAMESPACE
00347 # if defined(_STLSOFT_NO_NAMESPACE) || \
00348      defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00349 } // namespace winstl
00350 # else
00351 } // namespace winstl_project
00352 } // namespace stlsoft
00353 # endif /* _STLSOFT_NO_NAMESPACE */
00354 #endif /* !_WINSTL_NO_NAMESPACE */
00355 
00356 /* ////////////////////////////////////////////////////////////////////// */
00357 
00358 #endif /* !WINSTL_INCL_WINSTL_UTIL_HPP_STRUCT_INITIALISERS */
00359 
00360 /* ///////////////////////////// end of file //////////////////////////// */