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.
477 lines
14 KiB
477 lines
14 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: comstl/shims/access/string/guid.hpp
|
|
*
|
|
* Purpose: Contains classes and functions for dealing with OLE/COM strings.
|
|
*
|
|
* Created: 24th May 2002
|
|
* Updated: 12th May 2010
|
|
*
|
|
* Home: http://stlsoft.org/
|
|
*
|
|
* Copyright (c) 2002-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/shims/access/string/guid.hpp
|
|
*
|
|
* \brief [C++] Definition of the string access shims for
|
|
* <code>GUID</code>
|
|
* (\ref group__concept__shim__string_access "String Access Shims" Concept).
|
|
*/
|
|
|
|
#ifndef COMSTL_INCL_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID
|
|
#define COMSTL_INCL_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
# define COMSTL_VER_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID_MAJOR 5
|
|
# define COMSTL_VER_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID_MINOR 1
|
|
# define COMSTL_VER_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID_REVISION 1
|
|
# define COMSTL_VER_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID_EDIT 114
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Includes
|
|
*/
|
|
|
|
#ifndef COMSTL_INCL_COMSTL_H_COMSTL
|
|
# include <comstl/comstl.h>
|
|
#endif /* !COMSTL_INCL_COMSTL_H_COMSTL */
|
|
#ifndef COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS
|
|
# include <comstl/string/BSTR_functions.h>
|
|
#endif /* !COMSTL_INCL_COMSTL_STRING_H_BSTR_FUNCTIONS */
|
|
#ifndef STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING
|
|
# include <stlsoft/shims/access/string.hpp>
|
|
#endif /* !STLSOFT_INCL_STLSOFT_SHIMS_ACCESS_HPP_STRING */
|
|
|
|
#ifndef STLSOFT_INCL_H_WCHAR
|
|
# define STLSOFT_INCL_H_WCHAR
|
|
# include <wchar.h>
|
|
#endif /* !STLSOFT_INCL_H_WCHAR */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* 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 */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Functions
|
|
*/
|
|
|
|
inline cs_size_t guid2string_w(GUID const& guid, cs_char_w_t buff[1 + COMSTL_CCH_GUID])
|
|
{
|
|
return static_cast<cs_size_t>(StringFromGUID2(guid, buff, 1 + COMSTL_CCH_GUID));
|
|
}
|
|
|
|
inline cs_size_t guid2string_a(GUID const& guid, cs_char_a_t buff[1 + COMSTL_CCH_GUID])
|
|
{
|
|
const cs_size_t COMSTL_CCH_GUID_AND_NULL = COMSTL_CCH_GUID + 1;
|
|
|
|
/* Don't ask! */
|
|
#ifdef STLSOFT_COMPILER_IS_BORLAND
|
|
int buff__[COMSTL_CCH_GUID_AND_NULL];
|
|
cs_char_w_t *buff_ = (wchar_t *)buff__;
|
|
#else /* ? compiler */
|
|
cs_char_w_t buff_[COMSTL_CCH_GUID_AND_NULL];
|
|
#endif /* compiler */
|
|
cs_size_t cch = guid2string_w(guid, buff_);
|
|
|
|
::WideCharToMultiByte(0, 0, buff_, COMSTL_CCH_GUID_AND_NULL, buff, COMSTL_CCH_GUID_AND_NULL, 0, 0);
|
|
|
|
return cch;
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Classes
|
|
*/
|
|
|
|
/* GUID */
|
|
|
|
/** \brief This class provides an intermediary object that may be returned by the
|
|
* c_str_ptr_null() function, such that the text of a given GUID
|
|
* may be accessed as a null-terminated string.
|
|
*
|
|
* \ingroup group__concept__shim__string_access
|
|
*
|
|
*/
|
|
template <ss_typename_param_k C>
|
|
class c_str_ptr_GUID_proxy
|
|
{
|
|
public:
|
|
typedef C char_type;
|
|
typedef c_str_ptr_GUID_proxy<C> class_type;
|
|
|
|
// Construction
|
|
public:
|
|
/// Constructs an instance of the proxy from the given GUID instance
|
|
///
|
|
/// \param guid The GUID instance from which the text will be retrieved
|
|
ss_explicit_k c_str_ptr_GUID_proxy(GUID const& guid);
|
|
|
|
/// Copy constructor
|
|
c_str_ptr_GUID_proxy(class_type const& rhs)
|
|
: m_(m_buffer)
|
|
{
|
|
for(cs_size_t i = 0; i < STLSOFT_NUM_ELEMENTS(m_buffer); ++i)
|
|
{
|
|
m_buffer[i] = rhs.m_buffer[i];
|
|
}
|
|
}
|
|
|
|
// Accessors
|
|
public:
|
|
/// Returns a null-terminated string representing the GUID contents
|
|
operator char_type const* () const
|
|
{
|
|
return m_buffer;
|
|
}
|
|
|
|
// Members
|
|
private:
|
|
char_type const* const m_;
|
|
char_type m_buffer[1 + COMSTL_CCH_GUID];
|
|
|
|
// Not to be implemented
|
|
private:
|
|
void operator =(class_type const& rhs);
|
|
};
|
|
|
|
STLSOFT_TEMPLATE_SPECIALISATION
|
|
inline c_str_ptr_GUID_proxy<cs_char_a_t>::c_str_ptr_GUID_proxy(GUID const& guid)
|
|
: m_(m_buffer)
|
|
{
|
|
#ifndef STLSOFT_COMPILER_IS_BORLAND
|
|
COMSTL_STATIC_ASSERT(STLSOFT_NUM_ELEMENTS(m_buffer) > COMSTL_CCH_GUID);
|
|
#endif /* compiler */
|
|
|
|
guid2string_a(guid, m_buffer);
|
|
}
|
|
|
|
STLSOFT_TEMPLATE_SPECIALISATION
|
|
inline c_str_ptr_GUID_proxy<cs_char_w_t>::c_str_ptr_GUID_proxy(GUID const& guid)
|
|
: m_(m_buffer)
|
|
{
|
|
#ifndef STLSOFT_COMPILER_IS_BORLAND
|
|
COMSTL_STATIC_ASSERT(STLSOFT_NUM_ELEMENTS(m_buffer) > COMSTL_CCH_GUID);
|
|
#endif /* compiler */
|
|
|
|
guid2string_w(guid, m_buffer);
|
|
}
|
|
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Equivalence testing
|
|
*/
|
|
|
|
// c_str_ptr_GUID_proxy
|
|
template <ss_typename_param_k C>
|
|
inline cs_bool_t operator ==(C const* lhs, c_str_ptr_GUID_proxy<C> const& rhs)
|
|
{
|
|
return lhs == static_cast<C const*>(rhs);
|
|
}
|
|
|
|
template <ss_typename_param_k C>
|
|
inline cs_bool_t operator ==(c_str_ptr_GUID_proxy<C> const& lhs, C const* rhs)
|
|
{
|
|
return static_cast<C const*>(lhs) == rhs;
|
|
}
|
|
|
|
template <ss_typename_param_k C>
|
|
inline cs_bool_t operator !=(C const* lhs, c_str_ptr_GUID_proxy<C> const& rhs)
|
|
{
|
|
return lhs != static_cast<C const*>(rhs);
|
|
}
|
|
|
|
template <ss_typename_param_k C>
|
|
inline cs_bool_t operator !=(c_str_ptr_GUID_proxy<C> const& lhs, C const* rhs)
|
|
{
|
|
return static_cast<C const*>(lhs) != rhs;
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* IOStream compatibility
|
|
*/
|
|
|
|
template< ss_typename_param_k C
|
|
, ss_typename_param_k S
|
|
>
|
|
inline S& operator <<(S& s, c_str_ptr_GUID_proxy<C> const& shim)
|
|
{
|
|
s << static_cast<C const*>(shim);
|
|
|
|
return s;
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* c_str_data
|
|
*
|
|
* This can be applied to an expression, and the return value is either a
|
|
* pointer to the character string or to an empty string.
|
|
*/
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_a_t> c_str_data_a(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_a_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_w_t> c_str_data_w(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_w_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_o_t> c_str_data_o(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_o_t>(guid);
|
|
}
|
|
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/** \brief Returns the corresponding possibly unterminated C-string pointer of the GUID \c guid
|
|
*
|
|
* \ingroup group__concept__shim__string_access
|
|
*
|
|
*/
|
|
inline c_str_ptr_GUID_proxy<TCHAR> c_str_data(GUID const& guid)
|
|
{
|
|
#ifdef UNICODE
|
|
return c_str_data_w(guid);
|
|
#else /* ? UNICODE */
|
|
return c_str_data_a(guid);
|
|
#endif /* UNICODE */
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* c_str_len
|
|
*
|
|
* This can be applied to an expression, and the return value is the number of
|
|
* characters in the character string in the expression.
|
|
*/
|
|
|
|
/* GUID */
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
|
|
inline cs_size_t c_str_len_a(GUID const& /* guid */)
|
|
{
|
|
return COMSTL_CCH_GUID;
|
|
}
|
|
|
|
inline cs_size_t c_str_len_w(GUID const& /* guid */)
|
|
{
|
|
return COMSTL_CCH_GUID;
|
|
}
|
|
|
|
inline cs_size_t c_str_len_o(GUID const& /* guid */)
|
|
{
|
|
return COMSTL_CCH_GUID;
|
|
}
|
|
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/** \brief Returns the length (in characters) of the GUID \c guid, <b><i>not</i></b> including the null-terminating character
|
|
*
|
|
* \ingroup group__concept__shim__string_access
|
|
*
|
|
*/
|
|
inline cs_size_t c_str_len(GUID const& /* guid */)
|
|
{
|
|
return COMSTL_CCH_GUID;
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* c_str_ptr
|
|
*
|
|
* This can be applied to an expression, and the return value is either a
|
|
* pointer to the character string or to an empty string.
|
|
*/
|
|
|
|
/* GUID */
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_a_t> c_str_ptr_a(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_a_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_w_t> c_str_ptr_w(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_w_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_o_t> c_str_ptr_o(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_o_t>(guid);
|
|
}
|
|
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/** \brief Returns the corresponding C-string pointer of the GUID \c guid
|
|
*
|
|
* \ingroup group__concept__shim__string_access
|
|
*
|
|
*/
|
|
inline c_str_ptr_GUID_proxy<TCHAR> c_str_ptr(GUID const& guid)
|
|
{
|
|
#ifdef UNICODE
|
|
return c_str_ptr_w(guid);
|
|
#else /* ? UNICODE */
|
|
return c_str_ptr_a(guid);
|
|
#endif /* UNICODE */
|
|
}
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* c_str_ptr_null
|
|
*
|
|
* This can be applied to an expression, and the return value is either a
|
|
* pointer to the character string or NULL.
|
|
*/
|
|
|
|
/* GUID */
|
|
|
|
#ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_a_t> c_str_ptr_null_a(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_a_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_w_t> c_str_ptr_null_w(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_w_t>(guid);
|
|
}
|
|
|
|
inline c_str_ptr_GUID_proxy<cs_char_o_t> c_str_ptr_null_o(GUID const& guid)
|
|
{
|
|
return c_str_ptr_GUID_proxy<cs_char_o_t>(guid);
|
|
}
|
|
|
|
#endif /* !STLSOFT_DOCUMENTATION_SKIP_SECTION */
|
|
|
|
/** \brief Returns the corresponding C-string pointer of the GUID \c guid
|
|
*
|
|
* \ingroup group__concept__shim__string_access
|
|
*
|
|
*/
|
|
inline c_str_ptr_GUID_proxy<TCHAR> c_str_ptr_null(GUID const& guid)
|
|
{
|
|
#ifdef UNICODE
|
|
return c_str_ptr_null_w(guid);
|
|
#else /* ? UNICODE */
|
|
return c_str_ptr_null_a(guid);
|
|
#endif /* UNICODE */
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////
|
|
// Unit-testing
|
|
|
|
#ifdef STLSOFT_UNITTEST
|
|
# include "./unittest/guid_unittest_.h"
|
|
#endif /* STLSOFT_UNITTEST */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#ifndef _COMSTL_NO_NAMESPACE
|
|
# if defined(_STLSOFT_NO_NAMESPACE) || \
|
|
defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
} // namespace comstl
|
|
# else
|
|
} // namespace stlsoft::comstl_project
|
|
} // namespace stlsoft
|
|
# endif /* _STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_COMSTL_NO_NAMESPACE */
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Namespace
|
|
*
|
|
* The string access shims exist either in the stlsoft namespace, or in the
|
|
* global namespace. This is required by the lookup rules.
|
|
*
|
|
*/
|
|
|
|
#ifndef _COMSTL_NO_NAMESPACE
|
|
# if !defined(_STLSOFT_NO_NAMESPACE) && \
|
|
!defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
namespace stlsoft
|
|
{
|
|
# else /* ? _STLSOFT_NO_NAMESPACE */
|
|
/* There is no stlsoft namespace, so must define in the global namespace */
|
|
# endif /* !_STLSOFT_NO_NAMESPACE */
|
|
|
|
using ::comstl::c_str_data_a;
|
|
using ::comstl::c_str_data_w;
|
|
using ::comstl::c_str_data_o;
|
|
using ::comstl::c_str_data;
|
|
|
|
using ::comstl::c_str_len_a;
|
|
using ::comstl::c_str_len_w;
|
|
using ::comstl::c_str_len_o;
|
|
using ::comstl::c_str_len;
|
|
|
|
using ::comstl::c_str_ptr_a;
|
|
using ::comstl::c_str_ptr_w;
|
|
using ::comstl::c_str_ptr_o;
|
|
using ::comstl::c_str_ptr;
|
|
|
|
using ::comstl::c_str_ptr_null_a;
|
|
using ::comstl::c_str_ptr_null_w;
|
|
using ::comstl::c_str_ptr_null_o;
|
|
using ::comstl::c_str_ptr_null;
|
|
|
|
# if !defined(_STLSOFT_NO_NAMESPACE) && \
|
|
!defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
|
|
} // namespace stlsoft
|
|
# else /* ? _STLSOFT_NO_NAMESPACE */
|
|
/* There is no stlsoft namespace, so must define in the global namespace */
|
|
# endif /* !_STLSOFT_NO_NAMESPACE */
|
|
#endif /* !_COMSTL_NO_NAMESPACE */
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* !COMSTL_INCL_COMSTL_SHIMS_ACCESS_STRING_HPP_GUID */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|