BSTR_functions.h

/* /////////////////////////////////////////////////////////////////////////
 * File:    comstl/string/BSTR_functions.h (originally MOBStrFn.h, ::SynesisCom)
 *
 * Purpose: Contains classes and functions for dealing with BSTR strings.
 *
 * Created: 24th June 2002
 * Updated: 24th December 2024
 *
 * Home:    http://stlsoft.org/
 *
 * Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 * Copyright (c) 2002-2019, 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 Information Systems
 *   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/string/BSTR_functions.h
 *
 * \brief [C, C++] Functions for manipulating BSTR strings
 *   (\ref group__library__String "String" Library).
 */

#ifndef COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS
#define COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
# define COMSTL_VER_COMSTL_STRING_H_BSTR_FUNCTIONS_MAJOR    4
# define COMSTL_VER_COMSTL_STRING_H_BSTR_FUNCTIONS_MINOR    4
# define COMSTL_VER_COMSTL_STRING_H_BSTR_FUNCTIONS_REVISION 9
# define COMSTL_VER_COMSTL_STRING_H_BSTR_FUNCTIONS_EDIT     108
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */


/* /////////////////////////////////////////////////////////////////////////
 * includes
 */

#ifndef COMSTL_INCL_COMSTL_H_COMSTL
# include <comstl/comstl.h>
#endif /* !COMSTL_INCL_COMSTL_H_COMSTL */
#ifdef STLSOFT_TRACE_INCLUDE
# pragma message(__FILE__)
#endif /* STLSOFT_TRACE_INCLUDE */

#ifndef STLSOFT_INCL_STLSOFT_QUALITY_H_CONTRACT
# include <stlsoft/quality/contract.h>
#endif /* !STLSOFT_INCL_STLSOFT_QUALITY_H_CONTRACT */
#ifndef STLSOFT_INCL_STLSOFT_QUALITY_H_COVER
# include <stlsoft/quality/cover.h>
#endif /* !STLSOFT_INCL_STLSOFT_QUALITY_H_COVER */

#ifndef WINSTL_INCL_WINSTL_API_external_h_ErrorHandling
# include <winstl/api/external/ErrorHandling.h>
#endif /* !WINSTL_INCL_WINSTL_API_external_h_ErrorHandling */
#ifndef WINSTL_INCL_WINSTL_API_external_h_UnicodeAndCharacterSet
# include <winstl/api/external/UnicodeAndCharacterSet.h>
#endif /* !WINSTL_INCL_WINSTL_API_external_h_UnicodeAndCharacterSet */

#ifndef STLSOFT_INCL_STLSOFT_API_external_h_string
# include <stlsoft/api/external/string.h>
#endif /* !STLSOFT_INCL_STLSOFT_API_external_h_string */


/* /////////////////////////////////////////////////////////////////////////
 * namespace
 */

#if !defined(COMSTL_NO_NAMESPACE) && \
    !defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
# if defined(STLSOFT_NO_NAMESPACE)
/* 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 */


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

/** [C] Retrieves the length of a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The string whose length is to be determined
 *
 * \result The length of the BSTR
 */
STLSOFT_INLINE
cs_size_t
comstl_C_BSTR_len(BSTR bstr)
{
    return STLSOFT_NS_GLOBAL(SysStringLen)(bstr);
}

/** [C] Creates a BSTR from a Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
STLSOFT_INLINE
BSTR
comstl_C_BSTR_create_w(
    cs_char_w_t const* s
)
{
    return STLSOFT_NS_GLOBAL(SysAllocString)(s);
}

/** [C] Creates a BSTR from a (part of a) Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
STLSOFT_INLINE
BSTR
comstl_C_BSTR_create_len_w(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    COMSTL_MESSAGE_ASSERT("Cannot pass size_t(-1) as length!", 0 != len + 1);

    COMSTL_ASSERT(NULL == s || !STLSOFT_NS_GLOBAL(IsBadStringPtrW(s, len)));

    return STLSOFT_NS_GLOBAL(SysAllocStringLen)(s, stlsoft_static_cast(UINT, len));
}

/** [C] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
STLSOFT_INLINE
BSTR
comstl_C_BSTR_create_a(
    cs_char_a_t const* s
)
{
    BSTR bstr = NULL;

    if (s != NULL)
    {
        const cs_size_t len     =   STLSOFT_NS_GLOBAL(strlen)(s);
        cs_char_w_t*    pwsz    =   stlsoft_static_cast(cs_char_w_t*, STLSOFT_NS_GLOBAL(CoTaskMemAlloc)((1 + len) * sizeof(cs_char_w_t)));

        if (NULL != pwsz)
        {
            int n = WINSTL_API_EXTERNAL_UnicodeAndCharacterSet_MultiByteToWideChar(0, 0, s, -1, pwsz, stlsoft_static_cast(int, 1 + len));

            if (0 != n)
            {
                if (stlsoft_static_cast(cs_size_t, n) < len)
                {
                    pwsz[n] = L'\0';
                }

                bstr = comstl_C_BSTR_create_w(pwsz);
            }

            STLSOFT_NS_GLOBAL(CoTaskMemFree)(pwsz);
        }
    }

    return bstr;
}

/** [C] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
STLSOFT_INLINE
BSTR
comstl_C_BSTR_create_len_a(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    BSTR bstr = NULL;

    COMSTL_MESSAGE_ASSERT("Cannot pass size_t(-1) as length!", 0 != len + 1);

    if (s != NULL)
    {
        cs_char_w_t* pwsz = stlsoft_static_cast(cs_char_w_t*, STLSOFT_NS_GLOBAL(CoTaskMemAlloc)((1 + len) * sizeof(cs_char_w_t)));

        if (NULL != pwsz)
        {
            int n = WINSTL_API_EXTERNAL_UnicodeAndCharacterSet_MultiByteToWideChar(0, 0, s, stlsoft_static_cast(int, len), pwsz, stlsoft_static_cast(int, 1 + len));

#ifdef STLSOFT_DEBUG
            if (0 == n)
            {
                WINSTL_API_EXTERNAL_ErrorHandling_GetLastError();
            }
#endif /* STLSOFT_DEBUG */
            if (0 != n)
            {
                bstr = comstl_C_BSTR_create_len_w(pwsz, len);
            }

            STLSOFT_NS_GLOBAL(CoTaskMemFree)(pwsz);
        }
    }

    return bstr;
}

/** [C] Destroys a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The BSTR to destroy
 */
STLSOFT_INLINE
void
comstl_C_BSTR_destroy(
    BSTR bstr
)
{
    STLSOFT_NS_GLOBAL(SysFreeString)(bstr);
}

/** [C] Duplicates a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The BSTR to duplicate
 * \return The copied BSTR
 */
STLSOFT_INLINE
BSTR
comstl_C_BSTR_dup(
    BSTR bstr
)
{
    return comstl_C_BSTR_create_len_w(bstr, STLSOFT_NS_GLOBAL(SysStringLen)(bstr));
}

/** [C] Compares two BSTR strings
 *
 * \ingroup group__library__String
 *
 * \param s1 The first BSTR to compare. May be \c nullptr
 * \param s2 The second BSTR to compare. May be \c nullptr
 *
 * \return An integer value representing the relationship between the strings
 * \retval <0 s1 is lexicographically less than s2
 * \retval 0 s1 is lexicographically equal than s2
 * \retval >0 s1 is lexicographically greater than s2
 */
STLSOFT_INLINE
int
comstl_C_BSTR_compare(
    BSTR    s1
,   BSTR    s2
)
{
    if (NULL == s1)
    {
        if (NULL == s2)
        {
            return 0;   /* Two NULLs are equal */
        }
        else
        {
            return -1;
        }
    }
    else
    {
        if (NULL == s2)
        {
            return +1;
        }
        else
        {
            return STLSOFT_NS_GLOBAL(wcscmp)(s1, s2);
        }
    }
}


/* /////////////////////////////////////////////////////////////////////////
 * namespace
 */

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


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

#ifdef __cplusplus

/** [C++] Retrieves the length of a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The string whose length is to be determined
 *
 * \result The length of the BSTR
 */
inline
cs_size_t
BSTR_len(
    BSTR bstr
)
{
    return comstl_C_BSTR_len(bstr);
}

/** [C++] Creates a BSTR from a Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create_w(
    cs_char_w_t const* s
)
{
    return comstl_C_BSTR_create_w(s);
}

/** [C++] Creates a BSTR from a Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create_w(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    return comstl_C_BSTR_create_len_w(s, len);
}

/** [C++] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create_a(
    cs_char_a_t const* s
)
{
    return comstl_C_BSTR_create_a(s);
}

/** [C++] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create_a(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    return comstl_C_BSTR_create_len_a(s, len);
}

/** [C++] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create(
    cs_char_a_t const* s
)
{
    return BSTR_create_a(s);
}

/** [C++] Creates a BSTR from an ANSI string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create_a(s, len);
}

/** [C++] Creates a BSTR from a Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create(
    cs_char_w_t const* s
)
{
    return BSTR_create_w(s);
}

/** [C++] Creates a BSTR from a Unicode string
 *
 * \ingroup group__library__String
 *
 * \param s The string from which to create the BSTR
 * \param len The number of characters of \c s to copy into the result
 *
 * \result The created BSTR
 */
inline
BSTR
BSTR_create(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create_w(s, len);
}

/** [C++] Destroys a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The BSTR to destroy
 */
inline
void
BSTR_destroy(
    BSTR bstr
)
{
    comstl_C_BSTR_destroy(bstr);
}

/** [C++] Duplicates a BSTR
 *
 * \ingroup group__library__String
 *
 * \param bstr The BSTR to duplicate
 * \return The copied BSTR
 */
inline
BSTR
BSTR_dup(
    BSTR bstr
)
{
    return comstl_C_BSTR_dup(bstr);
}

/** [C++] Compares two BSTR strings
 *
 * \ingroup group__library__String
 *
 * \param s1 The first BSTR to compare. May be \c nullptr
 * \param s2 The second BSTR to compare. May be \c nullptr
 *
 * \return An integer value representing the relationship between the strings
 * \retval <0 s1 is lexicographically less than s2
 * \retval 0 s1 is lexicographically equal than s2
 * \retval >0 s1 is lexicographically greater than s2
 */
inline
int
BSTR_compare(
    BSTR    s1
,   BSTR    s2
)
{
    return comstl_C_BSTR_compare(s1, s2);
}

#endif /* __cplusplus */


/* /////////////////////////////////////////////////////////////////////////
 * backwards compatibility
 */

#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION

STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_create_w, comstl_C_bstr_create_w)
STLSOFT_INLINE
BSTR
comstl__bstr_create_w(
    cs_char_w_t const* s
)
{
    return comstl_C_BSTR_create_w(s);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_create_len_w, comstl_C_bstr_create_len_w)
STLSOFT_INLINE
BSTR
comstl__bstr_create_len_w(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    return comstl_C_BSTR_create_len_w(s, len);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_create_a, comstl_C_bstr_create_a)
STLSOFT_INLINE
BSTR
comstl__bstr_create_a(
    cs_char_a_t const* s
)
{
    return comstl_C_BSTR_create_a(s);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_create_len_a, comstl_C_bstr_create_len_a)
STLSOFT_INLINE
BSTR
comstl__bstr_create_len_a(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    return comstl_C_BSTR_create_len_a(s, len);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_destroy, comstl_C_bstr_destroy)
STLSOFT_INLINE
void
comstl__bstr_destroy(
    BSTR bstr
)
{
    comstl_C_BSTR_destroy(bstr);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_dup, comstl_C_bstr_dup)
STLSOFT_INLINE
BSTR
comstl__bstr_dup(
    BSTR bstr
)
{
    return comstl_C_BSTR_dup(bstr);
}
STLSOFT_DECLARE_FUNCTION_DEPRECATION_IN_FAVOUR_OF(comstl__bstr_compare, comstl_C_bstr_compare)
STLSOFT_INLINE
int
comstl__bstr_compare(
    BSTR    s1
,   BSTR    s2
)
{
    return comstl_C_BSTR_compare(s1, s2);
}

# ifdef __cplusplus
inline
BSTR
bstr_create_w(
    cs_char_w_t const* s
)
{
    return BSTR_create_w(s);
}
inline
BSTR
bstr_create_w(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create_w(s, len);
}
inline
BSTR
bstr_create_a(
    cs_char_a_t const* s
)
{
    return BSTR_create_a(s);
}
inline
BSTR
bstr_create_a(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create_a(s, len);
}
inline
BSTR
bstr_create(
    cs_char_a_t const* s
)
{
    return BSTR_create(s);
}
inline
BSTR
bstr_create(
    cs_char_a_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create(s, len);
}
inline
BSTR
bstr_create(
    cs_char_w_t const* s
)
{
    return BSTR_create(s);
}
inline
BSTR
bstr_create(
    cs_char_w_t const*  s
,   cs_size_t           len
)
{
    return BSTR_create(s, len);
}
inline
void
bstr_destroy(
    BSTR bstr
)
{
    BSTR_destroy(bstr);
}
inline
BSTR
bstr_dup(
    BSTR bstr
)
{
    return BSTR_dup(bstr);
}
inline
int
bstr_compare(
    BSTR    s1
,   BSTR    s2
)
{
    return BSTR_compare(s1, s2);
}
# endif /* __cplusplus */

#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */

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

#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 */


/* /////////////////////////////////////////////////////////////////////////
 * inclusion control
 */

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

#endif /* !COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS */

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