include/pantheios/inserters/character.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        pantheios/inserters/character.hpp
 *
 * Purpose:     String inserters for fundamental types
 *
 * Created:     21st June 2005
 * Updated:     1st September 2006
 *
 * Author:      Matthew Wilson
 *
 * Home:        http://www.pantheios.org/
 *
 * Copyright:   Matthew Wilson and Synesis Software Pty Ltd, 1999-2005.
 *              Matthew Wilson, 2005-2006.
 *
 * 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 PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_CHARACTER
#define PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_CHARACTER

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

#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_CHARACTER_MAJOR      1
# define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_CHARACTER_MINOR      0
# define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_CHARACTER_REVISION   1
# define PANTHEIOS_VER_PANTHEIOS_INSERTERS_HPP_CHARACTER_EDIT       1
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */

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

#include <pantheios/pantheios.hpp>
#include <pantheios/inserters/fmt.hpp>

#include <stlsoft/shims/access/string/fwd.h>

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

#if !defined(PANTHEIOS_NO_NAMESPACE)
namespace pantheios
{

#endif /* !PANTHEIOS_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Inserter classes
 */

class character
{
public:
    typedef character   class_type;

public:
    explicit character(char value);

private:
    explicit character(int); // Prevents implicit conversion from an integer

public:
    char const  *data() const;
    char const  *c_str() const;
    size_t      length() const;

private:
    char    m_value[2];

private:
#if !defined(STLSOFT_COMPILER_IS_GCC)
    character(class_type const &);
#endif /* compiler */
    class_type &operator =(class_type const &);
};

/* /////////////////////////////////////////////////////////////////////////
 * String Access Shims
 */

inline char const *c_str_data_a(character const &r)
{
    return r.data();
}
inline char const *c_str_data(character const &r)
{
    return r.data();
}

inline size_t c_str_len_a(character const &r)
{
    return r.length();
}
inline size_t c_str_len(character const &r)
{
    return r.length();
}

inline char const *c_str_ptr_a(character const &r)
{
    return r.c_str();
}
inline char const *c_str_ptr(character const &r)
{
    return r.c_str();
}

/* /////////////////////////////////////////////////////////////////////////
 * Implementation
 */

inline /* explicit */ character::character(char value)
{
    m_value[0]  =   value;
    m_value[1]  =   '\0';
}

inline char const *character::data() const
{
    return m_value;
}

inline char const *character::c_str() const
{
    return m_value;
}

inline size_t character::length() const
{
    return 1;
}

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

#if !defined(PANTHEIOS_NO_NAMESPACE)
} /* namespace pantheios */

namespace stlsoft
{
    // 'Export' the string access shims into the STLSoft namespace
    //
    // c_str_ptr(_a) is not necessary for version 1.0 of Pantheios, but it's
    // defined and exported in order to allow for the case where someone
    // may find a legitimate use for the conversion classes additional to
    // the type-tunnelling of the Panthieos API.

    using ::pantheios::c_str_data_a;
    using ::pantheios::c_str_data;

    using ::pantheios::c_str_len;
    using ::pantheios::c_str_len_a;

    using ::pantheios::c_str_ptr_a;
    using ::pantheios::c_str_ptr;
}

#endif /* !PANTHEIOS_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Inclusion
 */

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

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

#endif /* !PANTHEIOS_INCL_PANTHEIOS_INSERTERS_HPP_CHARACTER */

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

pantheios Library documentation © Matthew Wilson, 2006