/* ///////////////////////////////////////////////////////////////////////////// * File: comstl_initialisers.h (originally MOInit.h, ::SynesisCom) * * Purpose: Contains classes for initialising COM/OLE. * * Created: 8th February 1999 * Updated: 26th February 2004 * * Author: Matthew Wilson, Synesis Software Pty Ltd. * * License: (Licensed under the Synesis Software Standard Source License) * * Copyright (C) 2002-2003, Synesis Software Pty Ltd. * * All rights reserved. * * www: http://www.synesis.com.au/comstl * http://www.comstl.org/ * * email: submissions@comstl.org for submissions * admin@comstl.org for other enquiries * * Redistribution and use in source and binary forms, with or * without modification, are permitted provided that the following * conditions are met: * * (i) Redistributions of source code must retain the above * copyright notice and contact information, this list of * conditions and the following disclaimer. * * (ii) Any derived versions of this software (howsoever modified) * remain the sole property of Synesis Software. * * (iii) Any derived versions of this software (howsoever modified) * remain subject to all these conditions. * * (iv) Neither the name of Synesis Software nor the names of any * subdivisions, employees or agents of Synesis Software, nor the * names of any other contributors to this software may be used to * endorse or promote products derived from this software without * specific prior written permission. * * This source code is provided by Synesis Software "as is" and any * warranties, whether expressed or implied, including, but not * limited to, the implied warranties of merchantability and * fitness for a particular purpose are disclaimed. In no event * shall the Synesis Software be liable for any direct, indirect, * incidental, special, exemplary, or consequential damages * (including, but not limited to, procurement of substitute goods * or services; loss of use, data, or profits; or business * interruption) however caused and on any theory of liability, * whether in contract, strict liability, or tort (including * negligence or otherwise) arising in any way out of the use of * this software, even if advised of the possibility of such * damage. * * ////////////////////////////////////////////////////////////////////////// */ #ifndef COMSTL_INCL_H_COMSTL_INITIALISERS #define COMSTL_INCL_H_COMSTL_INITIALISERS #ifndef __STLSOFT_DOCUMENTATION_SKIP_SECTION # define _COMSTL_VER_H_COMSTL_INITIALISERS_MAJOR 1 # define _COMSTL_VER_H_COMSTL_INITIALISERS_MINOR 9 # define _COMSTL_VER_H_COMSTL_INITIALISERS_REVISION 1 # define _COMSTL_VER_H_COMSTL_INITIALISERS_EDIT 36 #endif /* !__STLSOFT_DOCUMENTATION_SKIP_SECTION */ /* //////////////////////////////////////////////////////////////////////////// * Includes */ #ifndef COMSTL_INCL_H_COMSTL # include "comstl.h" // Include the COMSTL root header #endif /* !COMSTL_INCL_H_COMSTL */ /* ///////////////////////////////////////////////////////////////////////////// * Namespace * * The COMSTL components are contained within the comstl namespace. This is * actually an alias for stlsoft::comstl_project, * * The definition matrix is as follows: * * _STLSOFT_NO_NAMESPACE _COMSTL_NO_NAMESPACE comstl definition * --------------------- -------------------- ----------------- * not defined not defined = stlsoft::comstl_project * not defined defined not defined * defined not defined comstl * defined defined not defined * */ #ifndef _COMSTL_NO_NAMESPACE # ifdef _STLSOFT_NO_NAMESPACE /* There is no stlsoft namespace, so must define ::comstl */ namespace comstl { # else /* Define stlsoft::comstl_project */ namespace stlsoft { namespace comstl_project { # endif /* _STLSOFT_NO_NAMESPACE */ #endif /* !_COMSTL_NO_NAMESPACE */ /* ///////////////////////////////////////////////////////////////////////////// * Classes */ /// Initialises the COM libraries /// /// This class is used to initialise the COM libraries. It can respond to /// CoInitializeEx argument flags when translated in a DCOM build. template< ss_typename_param_k IP /* Initialisation policy type */ , ss_typename_param_k XP /* Exception policy type */ > class initialiser { private: typedef initialiser class_type; public: /// The initialiation policy type typedef IP initialisation_policy_type; /// The exception type typedef XP exception_policy_type; /// The thrown type typedef ss_typename_type_k exception_policy_type::thrown_type thrown_type; // Construction public: /// Initialises via CoInitialize() initialiser(); #ifdef __COMSTL_CF_DCOM_SUPPORT /// Initialises via CoInitializeEx() taking b>COINIT_* flags ss_explicit_k initialiser(cs_dword_t dwInit /* = COINIT_APARTMENTTHREADED */); #endif /* __COMSTL_CF_DCOM_SUPPORT */ /// Uninitialises via CoUninitialize() ~initialiser() comstl_throw_0(); // Attributes public: /// Reflects whether the COM libraries were initialised cs_bool_t is_initialised() const; /// Reflects whether the COM libraries were not initialised cs_bool_t operator !() const; /// The result of the call to CoInitialize()/CoInitializeEx() HRESULT get_HRESULT() const; // Members private: HRESULT const m_hr; // Not to be implemented private: initialiser(class_type const &rhs); class_type const &operator =(class_type const &rhs); }; //////////////////////////////////////////////////////////////////////////////// // Value policies struct CoInitialize_policy { public: static HRESULT init() { return ::CoInitialize(NULL); } #ifdef __COMSTL_CF_DCOM_SUPPORT static HRESULT init(cs_dword_t coInit) { return ::CoInitializeEx(NULL, coInit); } #endif /* __COMSTL_CF_DCOM_SUPPORT */ static void uninit() { ::CoUninitialize(); } }; struct OleInitialize_policy { public: static HRESULT init() { return ::OleInitialize(NULL); } static void uninit() { ::OleUninitialize(); } }; //////////////////////////////////////////////////////////////////////////////// // Exception policies struct ignore_initialisation_exception { public: /// The exception type struct thrown_type { }; public: /// The function call operator, which does not throw an exception /// /// \param hr The HRESULT that caused the error /// \param riid The REFIID that could not be acquired void operator ()(HRESULT /* hr */, REFIID /*riid*/) comstl_throw_0() { // Do nothing } }; //////////////////////////////////////////////////////////////////////////////// // Typedefs for US-English spellers typedef initialiser com_initialiser; typedef initialiser ole_initialiser; typedef com_initialiser com_initializer; typedef ole_initialiser ole_initializer; //////////////////////////////////////////////////////////////////////////////// // Implementation // initialiser template< ss_typename_param_k IP , ss_typename_param_k XP > inline initialiser::initialiser() : m_hr(initialisation_policy_type::init()) {} #ifdef __COMSTL_CF_DCOM_SUPPORT template< ss_typename_param_k IP , ss_typename_param_k XP > inline initialiser::initialiser(cs_dword_t coInit) : m_hr(initialisation_policy_type::init(coInit)) {} #endif // __COMSTL_CF_DCOM_SUPPORT template< ss_typename_param_k IP , ss_typename_param_k XP > inline initialiser::~initialiser() comstl_throw_0() { if(is_initialised()) { initialisation_policy_type::uninit(); } } template< ss_typename_param_k IP , ss_typename_param_k XP > inline cs_bool_t initialiser::is_initialised() const { return SUCCEEDED(m_hr); } template< ss_typename_param_k IP , ss_typename_param_k XP > inline cs_bool_t initialiser::operator !() const { return !is_initialised(); } template< ss_typename_param_k IP , ss_typename_param_k XP > inline HRESULT initialiser::get_HRESULT() const { return m_hr; } /* ////////////////////////////////////////////////////////////////////////// */ #ifndef _COMSTL_NO_NAMESPACE # ifdef _STLSOFT_NO_NAMESPACE } // namespace comstl # else } // namespace stlsoft::comstl_project } // namespace stlsoft # endif /* _STLSOFT_NO_NAMESPACE */ #endif /* !_COMSTL_NO_NAMESPACE */ /* ////////////////////////////////////////////////////////////////////////// */ #endif /* !COMSTL_INCL_H_COMSTL_INITIALISERS */ /* ////////////////////////////////////////////////////////////////////////// */