wtlstl.hpp

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

/* /////////////////////////////////////////////////////////////////////////
 * File:        wtlstl/wtlstl.hpp (formerly wtlstl.h)
 *
 * Purpose:     Root header for the WTLSTL libraries. Performs various compiler
 *              and platform discriminations, and definitions of types.
 *
 * Created:     12th May 2003
 * Updated:     10th June 2006
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2003-2006, 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 WTLSTL_INCL_WTLSTL_HPP_WTLSTL
#define WTLSTL_INCL_WTLSTL_HPP_WTLSTL
#define WTLSTL_INCL_H_WTLSTL

/* File version */
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define _WTLSTL_VER_WTLSTL_HPP_WTLSTL_MAJOR    2
# define _WTLSTL_VER_WTLSTL_HPP_WTLSTL_MINOR    3
# define _WTLSTL_VER_WTLSTL_HPP_WTLSTL_REVISION 1
# define _WTLSTL_VER_WTLSTL_HPP_WTLSTL_EDIT     31
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/** \file wtlstl/wtlstl.hpp \brief [C++ only; requires WTL library] The root header for the \ref group__project__wtlstl "WTLSTL" project. */

/* /////////////////////////////////////////////////////////////////////////
 * WTLSTL version
 *
 * The libraries version information is comprised of major, minor and revision
 * components.
 *
 * The major version is denoted by the _WTLSTL_VER_MAJOR preprocessor symbol.
 * A changes to the major version component implies that a dramatic change has
 * occurred in the libraries, such that considerable changes to source dependent
 * on previous versions would need to be effected.
 *
 * The minor version is denoted by the _WTLSTL_VER_MINOR preprocessor symbol.
 * Changes to the minor version component imply that a significant change has
 * occurred to the libraries, either in the addition of new functionality or in
 * the destructive change to one or more components such that recomplilation and
 * code change may be necessitated.
 *
 * The revision version is denoted by the _WTLSTL_VER_REVISIO preprocessor
 * symbol. Changes to the revision version component imply that a bug has been
 * fixed. Dependent code should be recompiled in order to pick up the changes.
 *
 * In addition to the individual version symbols - _WTLSTL_VER_MAJOR,
 * _WTLSTL_VER_MINOR and _WTLSTL_VER_REVISION - a composite symbol _WTLSTL_VER
 * is defined, where the upper 8 bits are 0, bits 16-23 represent the major
 * component,  bits 8-15 represent the minor component, and bits 0-7 represent
 * the revision component.
 *
 * Each release of the libraries will bear a different version, and that version
 * will also have its own symbol: Version 1.0.1 specifies _WTLSTL_VER_1_0_1.
 *
 * Thus the symbol _WTLSTL_VER may be compared meaningfully with a specific
 * version symbol, e.g. #if _WTLSTL_VER >= _WTLSTL_VER_1_0_1
 */

/** \def _WTLSTL_VER_MAJOR
 * The major version number of WTLSTL
 */

/** \def _WTLSTL_VER_MINOR
 * The minor version number of WTLSTL
 */

/** \def _WTLSTL_VER_REVISION
 * The revision version number of WTLSTL
 */

/** \def _WTLSTL_VER
 * The current composite version number of WTLSTL
 */

#define _WTLSTL_VER_MAJOR       1
#define _WTLSTL_VER_MINOR       1
#define _WTLSTL_VER_REVISION    2
#define _WTLSTL_VER_1_0_1       0x00010001  /*!< Version 1.0.1 */
#define _WTLSTL_VER_1_1_1       0x00010101  /*!< Version 1.1.1 */
#define _WTLSTL_VER_1_1_2       0x00010102  /*!< Version 1.1.2 */
#define _WTLSTL_VER_1_2_1       0x00010201  /*!< Version 1.2.1 */

#define _WTLSTL_VER             _WTLSTL_VER_1_2_1

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

#ifndef STLSOFT_INCL_STLSOFT_H_STLSOFT
# include <stlsoft/stlsoft.h>
#endif /* !STLSOFT_INCL_STLSOFT_H_STLSOFT */

/* In order to be compatible with Visual C++ 5.0, we need to define a few
 * things before we include the WTL headers to convince WTL 3.1 that we are
 * valid.
 */

#if defined(STLSOFT_COMPILER_IS_MSVC) && \
    _MSC_VER < 1200

# ifndef MIDL_INTERFACE
#  define MIDL_INTERFACE(x)         struct
# endif /* !MIDL_INTERFACE */

# ifndef LONG_PTR
#  define LONG_PTR                  LONG
# endif /* !LONG_PTR */

# ifndef UINT_PTR
#  define UINT_PTR                  unsigned int
# endif /* !UINT_PTR */

# ifndef _ATL_NO_MSIMG
#  define _ATL_NO_MSIMG
# endif /* !_ATL_NO_MSIMG */

# ifndef ATLASSERT
#  define ATLASSERT                 _ASSERTE
# endif /* !ATLASSERT */

# ifndef _WIN32_IE
#  define _WIN32_IE                 0x0300
# endif /* !_WIN32_IE */

#endif /* _MSC_VER < 1200 */

/* Now we include AtlApp.h here */

#ifdef STLSOFT_UNITTEST
# include <atlbase.h>
#endif /* STLSOFT_UNITTEST */

#include <atlapp.h>    // WTL base header


#if !defined(_WTL_VER) || \
    _WTL_VER < 0x0310
# error WTLSTL supports WTL version 3.1 and above only
#endif /* _WTL_VER < 0x0310 */

/* /////////////////////////////////////////////////////////////////////////
 * STLSoft version compatibility
 */

#if !defined(_STLSOFT_VER_1_9_1) || \
    _STLSOFT_VER < _STLSOFT_VER_1_9_1
# error This version of the WTLSTL libraries requires STLSoft version 1.9.1 or later
#endif /* _STLSOFT_VER < _STLSOFT_VER_1_9_1 */

/* /////////////////////////////////////////////////////////////////////////
 * Compiler compatibility
 *
 * Currently the only compilers supported by the WTLSTL libraries are
 *
 * Borland C++ 5.5, 5.51, 5.6
 * Digital Mars C/C++ 8.26 - 8.32
 * Metrowerks 2.4 & 3.0 (CodeWarrior 7.0 & 8.0)
 * Intel C/C++ 6.0
 * Visual C++ 5.0, 6.0, 7.0
 */

#if defined(STLSOFT_COMPILER_IS_BORLAND)
/* Borland C++ */
# if __BORLANDC__ < 0x0550
#  error Versions of Borland C++ prior to 5.5 are not supported by the WTLSTL libraries
# endif /* __BORLANDC__ */

#elif defined(STLSOFT_COMPILER_IS_DMC)
/* Digital Mars C/C++ */
# if __DMC__ < 0x0826
#  error Versions of Digital Mars C/C++ prior to 8.26 are not supported by the WTLSTL libraries
# endif /* __DMC__ */

#elif defined(STLSOFT_COMPILER_IS_INTEL)
/* Intel C++ */
# if (__INTEL_COMPILER < 600)
#  error Versions of Intel C++ prior to 6.0 are not supported by the WTLSTL libraries
# endif /* __INTEL_COMPILER */

#elif defined(STLSOFT_COMPILER_IS_MWERKS)
/* Metrowerks C++ */
# if (__MWERKS__ & 0xFF00) < 0x2400
#  error Versions of Metrowerks CodeWarrior C++ prior to 7.0 are not supported by the WTLSTL libraries
# endif /* __MWERKS__ */

#elif defined(STLSOFT_COMPILER_IS_MSVC)
/* Visual C++ */
# if _MSC_VER < 1100
#  error Versions of Visual C++ prior to 5.0 are not supported by the WTLSTL libraries
# endif /* _MSC_VER */

#else /* ? compiler */
/* No recognised compiler */
# ifdef _STLSOFT_FORCE_ANY_COMPILER
#  define _WTLSTL_COMPILER_IS_UNKNOWN
#  ifdef _STLSOFT_COMPILE_VERBOSE
#   pragma message("Compiler is unknown to WTLSTL")
#  endif /* _STLSOFT_COMPILE_VERBOSE */
# else /* ? _STLSOFT_FORCE_ANY_COMPILER */
#  error Currently only Borland C++, Digital Mars C/C++, Intel C/C++, Metrowerks CodeWarrior and Visual C++ compilers are supported by the WTLSTL libraries
# endif /* _STLSOFT_FORCE_ANY_COMPILER */
#endif /* compiler */

/* /////////////////////////////////////////////////////////////////////////
 * Debugging
 *
 * The macro wtlstl_assert provides standard debug-mode assert functionality.
 */

/// Defines a runtime assertion
///
/// \param _x Must be non-zero, or an assertion will be fired
#define WTLSTL_ASSERT(_x)               STLSOFT_ASSERT(_x)

/// Defines a runtime assertion, with message
///
/// \param _x Must be non-zero, or an assertion will be fired
/// \param _m The literal character string message to be included in the assertion
#define WTLSTL_MESSAGE_ASSERT(_m, _x)   STLSOFT_MESSAGE_ASSERT(_m, _x)

/// Defines a compile-time assertion
///
/// \param _x Must be non-zero, or compilation will fail
#define WTLSTL_STATIC_ASSERT(_x)        STLSOFT_STATIC_ASSERT(_x)



#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define wtlstl_assert(expr)                WTLSTL_ASSERT(expr)
# define wtlstl_message_assert(msg, expr)   WTLSTL_MESSAGE_ASSERT(msg, expr)
# define wtlstl_static_assert(expr)         WTLSTL_STATIC_ASSERT(expr)
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 *
 * The WTLSTL components are contained within the wtlstl namespace. This is