error_functions.h

新版本TR1的stl

/* /////////////////////////////////////////////////////////////////////////
 * File:        winstl/error/error_functions.h (originally MWBase.h, ::SynesisWin)
 *
 * Purpose:     Error functions.
 *
 * Created:     7th May 2000
 * Updated:     12th March 2007
 *
 * Home:        http://stlsoft.org/
 *
 * Copyright (c) 2000-2007, 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 winstl/error/error_functions.h
 *
 * \brief [C++ only] Windows error manipulation and representation
 *   functions
 *   (\ref group__library__error "Error" Library).
 */

#ifndef WINSTL_INCL_WINSTL_ERROR_H_ERROR_FUNCTIONS
#define WINSTL_INCL_WINSTL_ERROR_H_ERROR_FUNCTIONS

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define WINSTL_VER_WINSTL_ERROR_H_ERROR_FUNCTIONS_MAJOR     4
# define WINSTL_VER_WINSTL_ERROR_H_ERROR_FUNCTIONS_MINOR     0
# define WINSTL_VER_WINSTL_ERROR_H_ERROR_FUNCTIONS_REVISION  2
# define WINSTL_VER_WINSTL_ERROR_H_ERROR_FUNCTIONS_EDIT      51
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

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

#ifndef WINSTL_INCL_WINSTL_H_WINSTL
# include <winstl/winstl.h>
#endif /* !WINSTL_INCL_WINSTL_H_WINSTL */

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

#if !defined(_WINSTL_NO_NAMESPACE) && \
    !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
# if defined(_STLSOFT_NO_NAMESPACE)
/* There is no stlsoft namespace, so must define ::winstl */
namespace winstl
{
# else
/* Define stlsoft::winstl_project */

namespace stlsoft
{

namespace winstl_project
{

# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Helper functions
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_char_a_t *winstl__fmtmsg_find_last_good_a__(ws_char_a_t *first, ws_char_a_t* last)
{
    for(;first != last; )
    {
        switch(*(last - 1))
        {
            case    ' ':
            case    '\t':
            case    '\r':
            case    '\n':
            case    '.':
                *(last - 1) = '\0';
                --last;
                break;
            default:
                first = last;
                break;
        }
    }

    return last;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_char_w_t *winstl__fmtmsg_find_last_good_w__(ws_char_w_t *first, ws_char_w_t* last)
{
    for(;first != last; )
    {
        switch(*(last - 1))
        {
            case    L' ':
            case    L'\t':
            case    L'\r':
            case    L'\n':
            case    L'.':
                *(last - 1) = L'\0';
                --last;
                break;
            default:
                first = last;
                break;
        }
    }

    return last;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__FormatMessageA__buff_inst(int flags, HINSTANCE hinst, DWORD error, ws_char_a_t *buffer, ws_uint_t cchBuffer)
{
    if(NULL != hinst)
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_SYSTEM);
        flags = flags | (FORMAT_MESSAGE_FROM_HMODULE);
    }
    else
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_HMODULE);
        flags = flags | (FORMAT_MESSAGE_FROM_SYSTEM);
    }
    flags = flags & ~(FORMAT_MESSAGE_ALLOCATE_BUFFER);

    return STLSOFT_NS_GLOBAL(FormatMessageA)(   stlsoft_static_cast(ws_dword_t, flags)
                                            ,   stlsoft_static_cast(void*, hinst)
                                            ,   error
                                            ,   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)
                                            ,   buffer
                                            ,   cchBuffer
                                            ,   NULL);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__FormatMessageW__buff_inst(int flags, HINSTANCE hinst, DWORD error, ws_char_w_t *buffer, ws_uint_t cchBuffer)
{
    if(NULL != hinst)
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_SYSTEM);
        flags = flags | (FORMAT_MESSAGE_FROM_HMODULE);
    }
    else
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_HMODULE);
        flags = flags | (FORMAT_MESSAGE_FROM_SYSTEM);
    }
    flags = flags & ~(FORMAT_MESSAGE_ALLOCATE_BUFFER);

    return STLSOFT_NS_GLOBAL(FormatMessageW)(   stlsoft_static_cast(ws_dword_t, flags)
                                            ,   stlsoft_static_cast(void*, hinst)
                                            ,   error
                                            ,   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)
                                            ,   buffer
                                            ,   cchBuffer
                                            ,   NULL);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__FormatMessageA__alloc_inst(int flags, HINSTANCE hinst, DWORD error, ws_char_a_t **buffer)
{
    if(NULL != hinst)
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_SYSTEM);
        flags = flags | (FORMAT_MESSAGE_FROM_HMODULE);
    }
    else
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_HMODULE);
        flags = flags | (FORMAT_MESSAGE_FROM_SYSTEM);
    }
    flags = flags | (FORMAT_MESSAGE_ALLOCATE_BUFFER);

    return STLSOFT_NS_GLOBAL(FormatMessageA)(   stlsoft_static_cast(ws_dword_t, flags)
                                            ,   stlsoft_static_cast(void*, hinst)
                                            ,   error
                                            ,   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)
                                            ,   stlsoft_reinterpret_cast(LPSTR, buffer)
                                            ,   0
                                            ,   NULL);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__FormatMessageW__alloc_inst(int flags, HINSTANCE hinst, DWORD error, ws_char_w_t **buffer)
{
    if(NULL != hinst)
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_SYSTEM);
        flags = flags | (FORMAT_MESSAGE_FROM_HMODULE);
    }
    else
    {
        flags = flags & ~(FORMAT_MESSAGE_FROM_HMODULE);
        flags = flags | (FORMAT_MESSAGE_FROM_SYSTEM);
    }
    flags = flags | (FORMAT_MESSAGE_ALLOCATE_BUFFER);

    return STLSOFT_NS_GLOBAL(FormatMessageW)(   stlsoft_static_cast(ws_dword_t, flags)
                                            ,   stlsoft_static_cast(void*, hinst)
                                            ,   error
                                            ,   MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT)
                                            ,   stlsoft_reinterpret_cast(LPWSTR, buffer)
                                            ,   0
                                            ,   NULL);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE void winstl__fmtmsg_LocalFree__(void *pv)
{
    STLSOFT_NS_GLOBAL(LocalFree)(pv);
}

#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * C functions
 */

/** \brief Translates the given error to an error string and
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_buff_inst_a(DWORD error, HINSTANCE hinst, ws_char_a_t *buffer, ws_uint_t cchBuffer)
{
    ws_dword_t  res = winstl__FormatMessageA__buff_inst(FORMAT_MESSAGE_MAX_WIDTH_MASK, hinst, error, buffer, cchBuffer);

    if(res != 0)
    {
        /* Now trim the trailing space */
        ws_char_a_t* last_good = winstl__fmtmsg_find_last_good_a__(buffer, buffer + res);

        WINSTL_ASSERT((last_good - buffer) >= 0);

        *last_good = 0;
        res = stlsoft_static_cast(ws_dword_t, last_good - buffer);
    }

    return res;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_buff_inst_w(DWORD error, HINSTANCE hinst, ws_char_w_t *buffer, ws_uint_t cchBuffer)
{
    ws_dword_t  res = winstl__FormatMessageW__buff_inst(FORMAT_MESSAGE_MAX_WIDTH_MASK, hinst, error, buffer, cchBuffer);

    if(res != 0)
    {
        /* Now trim the trailing space */
        ws_char_w_t* last_good = winstl__fmtmsg_find_last_good_w__(buffer, buffer + res);

        WINSTL_ASSERT((last_good - buffer) >= 0);

        *last_good = 0;
        res = stlsoft_static_cast(ws_dword_t, last_good - buffer);
    }

    return res;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_buff_a(DWORD error, ws_char_a_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_inst_a(error, NULL, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_buff_w(DWORD error, ws_char_w_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_inst_w(error, NULL, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_alloc_a(DWORD error, HINSTANCE hinst, ws_char_a_t **buffer)
{
    ws_dword_t  res = winstl__FormatMessageA__alloc_inst(FORMAT_MESSAGE_MAX_WIDTH_MASK, hinst, error, buffer);

    if(res != 0)
    {
        /* Now trim the trailing space */
        ws_char_a_t* last_good = winstl__fmtmsg_find_last_good_a__(*buffer, *buffer + res);

        WINSTL_ASSERT((last_good - *buffer) >= 0);

        *last_good = 0;
        res = stlsoft_static_cast(ws_dword_t, last_good - *buffer);
    }

    return res;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE ws_dword_t winstl__format_message_alloc_w(DWORD error, HINSTANCE hinst, ws_char_w_t **buffer)
{
    ws_dword_t  res = winstl__FormatMessageW__alloc_inst(FORMAT_MESSAGE_MAX_WIDTH_MASK, hinst, error, buffer);

    if(res != 0)
    {
        /* Now trim the trailing space */
        ws_char_w_t* last_good = winstl__fmtmsg_find_last_good_w__(*buffer, *buffer + res);

        WINSTL_ASSERT((last_good - *buffer) >= 0);

        *last_good = 0;
        res = stlsoft_static_cast(ws_dword_t, last_good - *buffer);
    }

    return res;
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE void winstl__format_message_free_buff_a(ws_char_a_t *buffer)
{
    winstl__fmtmsg_LocalFree__(buffer);
}

/** 
 *
 * \ingroup group__library__error
 */
STLSOFT_INLINE void winstl__format_message_free_buff_w(ws_char_w_t *buffer)
{
    winstl__fmtmsg_LocalFree__(buffer);
}

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

#ifdef STLSOFT_DOCUMENTATION_SKIP_SECTION
namespace winstl
{
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * C++ functions
 */

#if defined(__cplusplus)

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, HINSTANCE hinst, ws_char_a_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_inst_a(error, hinst, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, HINSTANCE hinst, ws_char_w_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_inst_w(error, hinst, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, ws_char_a_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_a(error, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, ws_char_w_t *buffer, ws_uint_t cchBuffer)
{
    return winstl__format_message_buff_w(error, buffer, cchBuffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, HINSTANCE hinst, ws_char_a_t **buffer)
{
    return winstl__format_message_alloc_a(error, hinst, buffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline ws_dword_t format_message(ws_dword_t error, HINSTANCE hinst, ws_char_w_t **buffer)
{
    return winstl__format_message_alloc_w(error, hinst, buffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline void format_message_free_buff(ws_char_a_t *buffer)
{
    winstl__format_message_free_buff_a(buffer);
}

/** 
 *
 * \ingroup group__library__error
 */
inline void format_message_free_buff(ws_char_w_t *buffer)
{
    winstl__format_message_free_buff_w(buffer);
}

#endif /* __cplusplus */

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

#ifndef _WINSTL_NO_NAMESPACE
# if defined(_STLSOFT_NO_NAMESPACE) || \
     defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
} /* namespace winstl */
# else
} /* namespace winstl_project */
} /* namespace stlsoft */
# endif /* _STLSOFT_NO_NAMESPACE */
#endif /* !_WINSTL_NO_NAMESPACE */

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

#endif /* WINSTL_INCL_WINSTL_ERROR_H_ERROR_FUNCTIONS */

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