You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
319 lines
9.1 KiB
319 lines
9.1 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: comstl/error/exceptions.hpp
|
|
*
|
|
* Purpose: COM-related exception classes, and their policy classes
|
|
*
|
|
* Created: 8th December 2004
|
|
* Updated: 7th March 2010
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 2004-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.
|
|
*
|
|
* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
|
|
/** \file comstl/error/exceptions.hpp
|
|
*
|
|
* \brief [C++ only] Definition of the comstl::com_exception and
|
|
* comstl::variant_type_exception exception classes, and the
|
|
* comstl::exception_policy_base exception policy class (and the
|
|
* typedefs comstl::com_exception_policy and
|
|
* comstl::variant_type_exception_policy)
|
|
* (\ref group__library__error "Error" Library).
|
|
*/
|
|
|
|
#ifndef COMSTL_INCL_COMSTL_ERROR_HPP_EXCEPTIONS
|
|
#define COMSTL_INCL_COMSTL_ERROR_HPP_EXCEPTIONS
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define COMSTL_VER_COMSTL_ERROR_HPP_EXCEPTIONS_MAJOR 2
|
|
# define COMSTL_VER_COMSTL_ERROR_HPP_EXCEPTIONS_MINOR 2
|
|
# define COMSTL_VER_COMSTL_ERROR_HPP_EXCEPTIONS_REVISION 1
|
|
# define COMSTL_VER_COMSTL_ERROR_HPP_EXCEPTIONS_EDIT 44
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Compatibility
|
|
*/
|
|
|
|
/*
|
|
[DocumentationStatus:Ready]
|
|
*/
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef COMSTL_INCL_COMSTL_H_COMSTL
|
|
# include <comstl/comstl.h>
|
|
#endif /* !COMSTL_INCL_COMSTL_H_COMSTL */
|
|
#ifndef STLSOFT_INCL_STLSOFT_ERROR_HPP_PROJECT_EXCEPTION
|
|
# include <stlsoft/error/project_exception.hpp>
|
|
#endif /* !STLSOFT_INCL_STLSOFT_ERROR_HPP_PROJECT_EXCEPTION */
|
|
#ifndef STLSOFT_INCL_STLSOFT_UTIL_HPP_EXCEPTION_STRING
|
|
# include <stlsoft/util/exception_string.hpp>
|
|
#endif /* !STLSOFT_INCL_STLSOFT_UTIL_HPP_EXCEPTION_STRING */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* 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 */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Classes
|
|
*/
|
|
|
|
/** \brief General exception class for COM-related failures.
|
|
*
|
|
* \ingroup group__library__error
|
|
*
|
|
*/
|
|
class com_exception
|
|
: public stlsoft_ns_qual(project_exception)
|
|
{
|
|
/// \name Types
|
|
/// @{
|
|
private:
|
|
typedef stlsoft_ns_qual(exception_string) string_type;
|
|
public:
|
|
typedef com_exception class_type;
|
|
typedef stlsoft_ns_qual(project_exception) parent_class_type;
|
|
/// @}
|
|
|
|
/// \name Construction
|
|
/// @{
|
|
public:
|
|
/// \brief Constructs an instance from the given result code
|
|
///
|
|
/// \param hr The result code associated with the exception
|
|
ss_explicit_k com_exception(HRESULT hr)
|
|
: m_reason()
|
|
, m_hr(hr)
|
|
{}
|
|
/// \brief Constructs an instance from the given message string and result code
|
|
///
|
|
/// \param reason The message code associated with the exception
|
|
/// \param hr The result code associated with the exception
|
|
com_exception(char const* reason, HRESULT hr)
|
|
: m_reason((NULL == reason) ? "" : reason)
|
|
, m_hr(hr)
|
|
{}
|
|
/// \brief Destructor
|
|
///
|
|
/// \note This does not do have any implementation, but is required to placate
|
|
/// the Comeau and GCC compilers, which otherwise complain about mismatched
|
|
/// exception specifications between this class and its parent
|
|
virtual ~com_exception() stlsoft_throw_0()
|
|
{}
|
|
/// @}
|
|
|
|
/// \name Accessors
|
|
/// @{
|
|
public:
|
|
virtual char const* what() const stlsoft_throw_0()
|
|
{
|
|
return m_reason.empty() ? this->real_what_(): m_reason.c_str();
|
|
}
|
|
|
|
/// \brief The error code associated with the exception
|
|
HRESULT get_hr() const
|
|
{
|
|
return m_hr;
|
|
}
|
|
|
|
/// [DEPRECATED]
|
|
///
|
|
/// \deprecated Use get_hr() instead
|
|
HRESULT hr() const
|
|
{
|
|
return m_hr;
|
|
}
|
|
/// @}
|
|
|
|
/// \name Implementation
|
|
/// @{
|
|
private:
|
|
virtual char const* real_what_() const throw()
|
|
{
|
|
return "COM exception";
|
|
}
|
|
/// @}
|
|
|
|
/// \name Members
|
|
/// @{
|
|
private:
|
|
string_type m_reason;
|
|
HRESULT m_hr;
|
|
/// @}
|
|
|
|
/// \name Not to be implemented
|
|
/// @{
|
|
private:
|
|
class_type& operator =(class_type const&);
|
|
/// @}
|
|
};
|
|
|
|
/** \brief Indicates variant type mismatches.
|
|
*
|
|
* \ingroup group__library__error
|
|
*
|
|
* \remarks This is thrown by comstl::safearray_sequence on variant type
|
|
* mismatches.
|
|
*/
|
|
class variant_type_exception
|
|
: public com_exception
|
|
{
|
|
public:
|
|
typedef com_exception parent_class_type;
|
|
typedef variant_type_exception class_type;
|
|
|
|
/// \name Construction
|
|
/// @{
|
|
public:
|
|
ss_explicit_k variant_type_exception(HRESULT hr)
|
|
: parent_class_type(hr)
|
|
{}
|
|
variant_type_exception(char const* reason, HRESULT hr)
|
|
: parent_class_type(reason, hr)
|
|
{}
|
|
/// \brief Destructor
|
|
///
|
|
/// \note This does not do have any implementation, but is required to placate
|
|
/// the Comeau and GCC compilers, which otherwise complain about mismatched
|
|
/// exception specifications between this class and its parent
|
|
virtual ~variant_type_exception() stlsoft_throw_0()
|
|
{}
|
|
/// @}
|
|
|
|
/// \name Implementation
|
|
/// @{
|
|
private:
|
|
virtual char const* real_what_() const throw()
|
|
{
|
|
return "VARIANT type exception";
|
|
}
|
|
/// @}
|
|
};
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Policies
|
|
*/
|
|
|
|
/** \brief Policy adaptor template for exception throwing
|
|
*
|
|
* \ingroup group__library__error
|
|
*
|
|
*/
|
|
template <ss_typename_param_k X>
|
|
// [[synesis:class:exception-policy: exception_policy_base]]
|
|
struct exception_policy_base
|
|
{
|
|
/// \name Member Types
|
|
/// @{
|
|
public:
|
|
/// The thrown type
|
|
typedef X thrown_type;
|
|
/// @}
|
|
|
|
/// \name Operators
|
|
/// @{
|
|
public:
|
|
/// Function call operator, taking no parameters
|
|
void operator ()() const
|
|
{
|
|
STLSOFT_THROW_X(thrown_type(::GetLastError()));
|
|
}
|
|
/// Function call operator, taking one parameter
|
|
void operator ()(HRESULT hr) const
|
|
{
|
|
STLSOFT_THROW_X(thrown_type(hr));
|
|
}
|
|
/// Function call operator, taking two parameters
|
|
void operator ()(char const* reason, HRESULT hr) const
|
|
{
|
|
STLSOFT_THROW_X(thrown_type(reason, hr));
|
|
}
|
|
/// @}
|
|
};
|
|
|
|
/** \brief The policy class, which throws a com_exception class.
|
|
*
|
|
* \ingroup group__library__error
|
|
*
|
|
*/
|
|
typedef exception_policy_base<com_exception> com_exception_policy;
|
|
|
|
/** \brief The policy class, which throws a com_exception class.
|
|
*
|
|
* \ingroup group__library__error
|
|
*
|
|
*/
|
|
typedef exception_policy_base<variant_type_exception> variant_type_exception_policy;
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/exceptions_unittest_.h"
|
|
#endif /* STLSOFT_UNITTEST */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#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_ERROR_HPP_EXCEPTIONS */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|