fastformat/sinks/shim_string.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        fastformat/sinks/shim_string.hpp
 *
 * Purpose:     A FastFormat sink for STLSoft's shim_string class template.
 *
 * Created:     12th November 2008
 * Updated:     30th April 2010
 *
 * Home:        http://www.fastformat.org/
 *
 * Copyright (c) 2008-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 names 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 FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_SHIM_STRING
#define FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_SHIM_STRING

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION
# define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_SHIM_STRING_SINK_MAJOR      1
# define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_SHIM_STRING_SINK_MINOR      0
# define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_SHIM_STRING_SINK_REVISION   5
# define FASTFORMAT_VER_FASTFORMAT_SINK_HPP_SHIM_STRING_SINK_EDIT       8
#endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Language
 */

#ifndef __cplusplus
# error This file can only be included in C++ compilation units
#endif /* !__cplusplus */

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

#include <fastformat/fastformat.h>
#include <fastformat/quality/contract.h>
#include <fastformat/util/sinks/helpers.hpp>
#include <fastformat/format/standard_flags.hpp>

#include <stlsoft/shims/access/string/std/c_string.h>
#include <stlsoft/string/shim_string.hpp>

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

#if !defined(FASTFORMAT_NO_NAMESPACE)
namespace fastformat
{
namespace sinks
{
#endif /* !FASTFORMAT_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Compatibility
 */

#if _STLSOFT_VER < 0x010a0000 && \
    defined(_STLSOFT_1_10_VER)
# if _STLSOFT_1_10_VER < 0x010a0109
#  error This file cannot be used with STLSoft 1.10.1 alpha 1 - STLSoft 1.10.1 alpha 8, and is not necessary with STLSoft 1.10.1 alpha 9+ (for which it is not necessary)
# endif /* _STLSOFT_1_10_VER */
#endif /* _STLSOFT_VER */

/* /////////////////////////////////////////////////////////////////////////
 * Classes
 */

class shim_string_sink
    : public stlsoft::basic_shim_string<ff_char_t>
{
public: // Member Types
    typedef shim_string_sink                        class_type;
    typedef stlsoft::basic_shim_string<ff_char_t>   parent_class_type;
    typedef parent_class_type::size_type            size_type;
private:

public: // Construction

    shim_string_sink()
        : parent_class_type(size_type(0))
#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)
        , m_len(0)
#endif
    {}
    explicit shim_string_sink(size_type n)
        : parent_class_type(n)
#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)
        , m_len(0)
#endif
    {}
private:
    class_type& operator =(class_type const& rhs); // Not supported

public: // Operations

    void reserve(size_type n)
    {
#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)

        parent_class_type::buffer_type& buffer = parent_class_type::get_buffer();

        if(buffer.resize(n + 1))
        {
            buffer[n] = '\0';
        }

#else
        parent_class_type::reserve(n);
#endif
    }

    class_type& append(ff_char_t const* s, size_type n)
    {
#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)

        parent_class_type::buffer_type& buffer = parent_class_type::get_buffer();

        if(m_len + n + 1 > buffer.size())
        {
            if(!buffer.resize(m_len + n + 1))
            {
                buffer[0] = '\0';
                m_len = 0;

                return *this;
            }
        }

        ::memcpy(&buffer[0] + m_len, s, sizeof(ff_char_t) * n);
        m_len += n;
        buffer[m_len] = '\0';

#else
        parent_class_type::append(s, n);
#endif

        return *this;
    }

    class_type& append(ff_char_t const* s)
    {
#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)

        append(s, stlsoft::c_str_len(s));

#else
        parent_class_type::append(s);
#endif

        return *this;
    }

    void truncate(size_type n)
    {
        parent_class_type::truncate(n);
    }

#if _STLSOFT_VER < 0x010a0000 && \
    !defined(_STLSOFT_1_10_VER)

public: // Accessors

    size_type size() const
    {
        STLSOFT_ASSERT(m_len < const_cast<class_type*>(this)->parent_class_type::get_buffer().size());

        return m_len;
    }

    operator size_type() const
    {
        return size();
    }

private:
    size_type   m_len;
#endif
};

/* /////////////////////////////////////////////////////////////////////////
 * Action Shims
 */

/* /////////////////////////////////////////////////////////////////////////
 * Shims
 */

#ifdef FASTFORMAT_USE_WIDE_STRINGS
inline wchar_t const* c_str_data_w(
#else /* ? FASTFORMAT_USE_WIDE_STRINGS */
inline char const* c_str_data_a(
#endif /* FASTFORMAT_USE_WIDE_STRINGS */
    shim_string_sink const& sink
)
{
    return sink.data();
}

inline ff_char_t const* c_str_data(
    shim_string_sink const& sink
)
{
    return sink.data();
}

#ifdef FASTFORMAT_USE_WIDE_STRINGS
inline size_t c_str_len_w(
#else /* ? FASTFORMAT_USE_WIDE_STRINGS */
inline size_t c_str_len_a(
#endif /* FASTFORMAT_USE_WIDE_STRINGS */
    shim_string_sink const& sink
)
{
    return sink.size();
}

inline size_t c_str_len(
    shim_string_sink const& sink
)
{
    return size_t(sink.size());
}

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

#if !defined(FASTFORMAT_NO_NAMESPACE)
} /* namespace sinks */
} /* namespace fastformat */
#endif /* !FASTFORMAT_NO_NAMESPACE */

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

#endif /* FASTFORMAT_INCL_FASTFORMAT_SINK_HPP_SHIM_STRING_SINK */

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

FastFormat Library documentation © Matthew Wilson, 2006-2009