comstl/util/creation_functions.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        comstl/util/creation_functions.hpp
 *
 * Purpose:     COM instance creation helper functions
 *
 * Created:     21st September 2005
 * Updated:     6th June 2010
 *
 * Thanks:      To Adi Shavit for demanding more usability in these
 *              functions, which led to the adoption of stlsoft::ref_ptr<X>
 *              as the unit of currency throughout COMSTL.
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2005-2010, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name(s) of Matthew Wilson and Synesis Software nor the names of
 *   any contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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_COMSTL_UTIL_HPP_CREATION_FUNCTIONS
#define COMSTL_INCL_COMSTL_UTIL_HPP_CREATION_FUNCTIONS

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define COMSTL_VER_COMSTL_UTIL_HPP_CREATION_FUNCTIONS_MAJOR    2
# define COMSTL_VER_COMSTL_UTIL_HPP_CREATION_FUNCTIONS_MINOR    3
# define COMSTL_VER_COMSTL_UTIL_HPP_CREATION_FUNCTIONS_REVISION 2
# define COMSTL_VER_COMSTL_UTIL_HPP_CREATION_FUNCTIONS_EDIT     22
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#ifndef COMSTL_INCL_COMSTL_H_COMSTL
# include <comstl/comstl.h>
#endif /* !COMSTL_INCL_COMSTL_H_COMSTL */
#ifndef COMSTL_INCL_COMSTL_UTIL_HPP_INTERFACE_TRAITS
# include <comstl/util/interface_traits.hpp>
#endif /* !COMSTL_INCL_COMSTL_UTIL_HPP_INTERFACE_TRAITS */
#ifndef STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_REF_PTR
# include <stlsoft/smartptr/ref_ptr.hpp>
#endif /* !STLSOFT_INCL_STLSOFT_SMARTPTR_HPP_REF_PTR */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#ifndef _COMSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
/* 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 */

/* /////////////////////////////////////////////////////////////////////////
 * Functions
 */

template <ss_typename_param_k I>
inline HRESULT co_create_instance(
    REFCLSID    clsid
,   I**         ppi
,   DWORD       dwClsContext = CLSCTX_ALL
)
{
    return ::CoCreateInstance(clsid, NULL, dwClsContext, IID_traits<I>::iid(), reinterpret_cast<void**>(ppi));
}

template <ss_typename_param_k I>
inline HRESULT co_create_instance(
    LPCOLESTR   id
,   I**         ppi
,   DWORD       dwClsContext = CLSCTX_ALL
)
{
    CLSID   clsid;
    HRESULT hr = ::CLSIDFromProgID(id, &clsid);

    if(FAILED(hr))
    {
        hr = ::CLSIDFromString(const_cast<LPOLESTR>(id), &clsid);
    }

    if(SUCCEEDED(hr))
    {
        hr = co_create_instance(clsid, ppi, dwClsContext);
    }

    return hr;
}


template<   ss_typename_param_k T
        ,   ss_typename_param_k I
        ,   ss_typename_param_k U
        >
inline HRESULT co_create_instance(
    REFCLSID                            clsid
,   stlsoft_ns_qual(ref_ptr)<T, I, U>&  wi
,   DWORD                               dwClsContext = CLSCTX_ALL
)
{
    I*      pi;
    HRESULT hr = co_create_instance(clsid, &pi, dwClsContext);

    if(FAILED(hr))
    {
        pi = NULL;
    }

    wi.set(pi, false); // Eat the reference

    return hr;
}

template<   ss_typename_param_k T
        ,   ss_typename_param_k I
        ,   ss_typename_param_k U
        >
inline HRESULT co_create_instance(
    LPCOLESTR                           id
,   stlsoft_ns_qual(ref_ptr)<T, I, U>&  wi
,   DWORD                               dwClsContext = CLSCTX_ALL
)
{
    I*      pi;
    HRESULT hr = co_create_instance(id, &pi, dwClsContext);

    if(FAILED(hr))
    {
        pi = NULL;
    }

    wi = stlsoft_ns_qual(ref_ptr)<T, I, U>(pi, false); // Eat the reference

    return hr;
}

/* ////////////////////////////////////////////////////////////////////// */

#ifndef _COMSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
} // namespace comstl
# else
} // namespace comstl_project
} // namespace stlsoft
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_COMSTL_NO_NAMESPACE */

/* ////////////////////////////////////////////////////////////////////// */

#endif /* !COMSTL_INCL_COMSTL_UTIL_HPP_CREATION_FUNCTIONS */

/* ///////////////////////////// end of file //////////////////////////// */

---