dotnetstl.hpp

用STL的方式封装了WindowsAPI、COM调用、ACE、ATL、MFC、WTL等多种组件

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 *
 * The .netSTL components are contained within the dotnetstl namespace. This is
 * usually an alias for stlsoft::dotnetstl_project,
 *
 * When compilers support namespaces they are defined by default. They can be
 * undefined using a cascasing system, as follows:
 *
 * DOTNETSTL_NO_NAMESPACES may not be defined.
 *
 * If _STLSOFT_NO_NAMESPACE is defined (whence the namespace stlsoft does not
 * exist), then the .netSTL constructs are defined within the dotnetstl
 * namespace. The definition matrix is as follows:
 *
 * _STLSOFT_NO_NAMESPACE     dotnetstl definition
 * ---------------------     -----------------
 *  not defined               = stlsoft::dotnetstl_project
 *  defined                   dotnetstl
 *
 * The macro dotnetstl_ns_qual() macro can be used to refer to elements in the
 * .netSTL libraries irrespective of whether they are in the
 * stlsoft::dotnetstl_project or dotnetstl namespaces.
 *
 * Furthermore, some compilers do not support the standard library in the std
 * namespace, so the dotnetstl_ns_qual_std() macro can be used to refer to elements
 * in the .netSTL libraries irrespective of whether they are in the std namespace
 * or in the global namespace.
 */

/* Cannot define .netSTL entities within the global namespace */
#if defined(DOTNETSTL_NO_NAMESPACE)
# error .netSTL constructs cannot be defined to be in the global namespace
#endif /* DOTNETSTL_NO_NAMESPACE */


#ifdef _STLSOFT_NO_NAMESPACE
/* There is no stlsoft namespace, so must define ::dotnetstl */
/// The dotnetstl namespace - \c dotnetstl (aliased to \c stlsoft::dotnetstl_project) - is
/// the namespace for the .netSTL project.
namespace dotnetstl
{
# else
/* Define stlsoft::dotnetstl_project */

namespace stlsoft
{

namespace dotnetstl_project
{

#endif /* _STLSOFT_NO_NAMESPACE */

/** \def dotnetstl_ns_qual(x)
 * Qualifies with <b>dotnetstl::</b> if .netSTL is using namespaces or, if not, does not qualify
 */

/** \def dotnetstl_ns_using(x)
 * Declares a using directive (with respect to <b>dotnetstl</b>) if .netSTL is using namespaces or, if not, does nothing
 */

#define dotnetstl_ns_qual(x)            ::dotnetstl::x
#define dotnetstl_ns_using(x)           using ::dotnetstl::x;

/** \def dotnetstl_ns_qual_std(x)
 * Qualifies with <b>std::</b> if .netSTL is being translated in the context of the standard library being within the <b>std</b> namespace or, if not, does not qualify
 */

/** \def dotnetstl_ns_using_std(x)
 * Declares a using directive (with respect to <b>std</b>) if .netSTL is being translated in the context of the standard library being within the <b>std</b> namespace or, if not, does nothing
 */

#ifdef STLSOFT_CF_std_NAMESPACE
# define dotnetstl_ns_qual_std(x)       ::std::x
# define dotnetstl_ns_using_std(x)      using ::std::x;
#else /* ? STLSOFT_CF_std_NAMESPACE */
# define dotnetstl_ns_qual_std(x)       x
# define dotnetstl_ns_using_std(x)
#endif /* !STLSOFT_CF_std_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * CLR / VC++ versions
 */

#if defined(_MSC_VER) && \
    _MSC_VER >= 1400
# define DOTNETSTL_HAT_SYNTAX_SUPPORT
#else /* ? _MSC_VER */
#endif /* _MSC_VER */

/* /////////////////////////////////////////////////////////////////////////
 * Typedefs
 *
 * The .netSTL uses a number of typedefs to aid in compiler-independence in the
 * libraries' main code.
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION

typedef stlsoft_ns_qual(ss_char_a_t)        ds_char_a_t;    //!< Ansi char type
typedef stlsoft_ns_qual(ss_char_w_t)        ds_char_w_t;    //!< Unicode char type
typedef stlsoft_ns_qual(ss_sint8_t)         ds_sint8_t;     //!< 8-bit signed integer
typedef stlsoft_ns_qual(ss_uint8_t)         ds_uint8_t;     //!< 8-bit unsigned integer
typedef stlsoft_ns_qual(ss_int16_t)         ds_int16_t;     //!< 16-bit integer
typedef stlsoft_ns_qual(ss_sint16_t)        ds_sint16_t;    //!< 16-bit signed integer
typedef stlsoft_ns_qual(ss_uint16_t)        ds_uint16_t;    //!< 16-bit unsigned integer
typedef stlsoft_ns_qual(ss_int32_t)         ds_int32_t;     //!< 32-bit integer
typedef stlsoft_ns_qual(ss_sint32_t)        ds_sint32_t;    //!< 32-bit signed integer
typedef stlsoft_ns_qual(ss_uint32_t)        ds_uint32_t;    //!< 32-bit unsigned integer
#ifdef STLSOFT_CF_64BIT_INT_SUPPORT
typedef stlsoft_ns_qual(ss_int64_t)         ds_int64_t;     //!< 64-bit integer
typedef stlsoft_ns_qual(ss_sint64_t)        ds_sint64_t;    //!< 64-bit signed integer
typedef stlsoft_ns_qual(ss_uint64_t)        ds_uint64_t;    //!< 64-bit unsigned integer
#endif /* STLSOFT_CF_64BIT_INT_SUPPORT */
typedef stlsoft_ns_qual(ss_int_t)           ds_int_t;       //!< integer
typedef stlsoft_ns_qual(ss_sint_t)          ds_sint_t;      //!< signed integer
typedef stlsoft_ns_qual(ss_uint_t)          ds_uint_t;      //!< unsigned integer
typedef stlsoft_ns_qual(ss_long_t)          ds_long_t;      //!< long
typedef stlsoft_ns_qual(ss_bool_t)          ds_bool_t;      //!< bool
typedef stlsoft_ns_qual(ss_size_t)          ds_size_t;      //!< size
typedef stlsoft_ns_qual(ss_ptrdiff_t)       ds_ptrdiff_t;   //!< ptr diff
typedef stlsoft_ns_qual(ss_streampos_t)     ds_streampos_t; //!< streampos
typedef stlsoft_ns_qual(ss_streamoff_t)     ds_streamoff_t; //!< streamoff

#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Values
 *
 * Since the boolean type may not be supported natively on all compilers, the
 * values of true and false may also not be provided. Hence the values of
 * ds_true_v and ds_false_v are defined, and are used in all code.
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION

#define ds_true_v       ss_true_v
#define ds_false_v      ss_false_v

#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
/* /////////////////////////////////////////////////////////////////////////
 * Code modification macros
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
/* Exception signatures. */
# define dotnetstl_throw_0()                                stlsoft_throw_0()
# define dotnetstl_throw_1(x1)                              stlsoft_throw_1(x1)
# define dotnetstl_throw_2(x1, x2)                          stlsoft_throw_2(x1, x2)
# define dotnetstl_throw_3(x1, x2, x3)                      stlsoft_throw_3(x1, x2, x3)
# define dotnetstl_throw_4(x1, x2, x3, x4)                  stlsoft_throw_4(x1, x2, x3, x4)
# define dotnetstl_throw_5(x1, x2, x3, x4, x5)              stlsoft_throw_5(x1, x2, x3, x4, x5)
# define dotnetstl_throw_6(x1, x2, x3, x4, x5, x6)          stlsoft_throw_6(x1, x2, x3, x4, x5, x6)
# define dotnetstl_throw_7(x1, x2, x3, x4, x5, x6, x7)      stlsoft_throw_7(x1, x2, x3, x4, x5, x6, x7)
# define dotnetstl_throw_8(x1, x2, x3, x4, x5, x6, x7, x8)  stlsoft_throw_8(x1, x2, x3, x4, x5, x6, x7, x8)
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/// Evaluates, at compile time, to the number of elements within the given vector entity
///
/// \param ar An array whose dimension is to be evaluated
#define DOTNETSTL_NUM_ELEMENTS(ar)                          STLSOFT_NUM_ELEMENTS(ar)
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define dotnetstl_num_elements(ar)                         DOTNETSTL_NUM_ELEMENTS(ar)
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/** \brief [DEPRECATED] Destroys the given instance \c p of the given type (\c t and \c _type)
 *
 * \deprecated This is <b>heavily</b> deprecated in favour of \ref STLSOFT_DESTROY_INSTANCE().
 */
#define dotnetstl_destroy_instance(t, _type, p)             STLSOFT_DESTROY_INSTANCE(t, _type, p)

/** \brief [DEPRECATED] Generates an opaque type with the name \c _htype
 *
 * \deprecated This is <b>heavily</b> deprecated in favour of \ref STLSOFT_GEN_OPAQUE().
 */
#define dotnetstl_gen_opaque(_htype)                        STLSOFT_GEN_OPAQUE(_htype)

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

#ifndef DOTNETSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
} // namespace dotnetstl
# else
} // namespace dotnetstl_project
} // namespace stlsoft
namespace dotnetstl = ::stlsoft::dotnetstl_project;
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !DOTNETSTL_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Inclusion
 */

#ifdef STLSOFT_CF_PRAGMA_ONCE_SUPPORT
# pragma once
#endif /* STLSOFT_CF_PRAGMA_ONCE_SUPPORT */

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

#endif /* DOTNETSTL_INCL_DOTNETSTL_HPP_DOTNETSTL */

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