openrj/cpp/field.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////////
 * File:    openrj/cpp/field.hpp
 *
 * Purpose: Field class, in the C++ mapping of the Open-RJ library
 *
 * Created: 18th June 2004
 * Updated: 14th July 2006
 *
 * Home:    http://openrj.org/
 *
 * Copyright (c) 2004-2006, 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 OPENRJ_INCL_OPENRJ_CPP_H_FIELD
#define OPENRJ_INCL_OPENRJ_CPP_H_FIELD

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

#ifndef OPENRJ_DOCUMENTATION_SKIP_SECTION
# define OPENRJ_VER_OPENRJ_CPP_H_FIELD_MAJOR    1
# define OPENRJ_VER_OPENRJ_CPP_H_FIELD_MINOR    4
# define OPENRJ_VER_OPENRJ_CPP_H_FIELD_REVISION 3
# define OPENRJ_VER_OPENRJ_CPP_H_FIELD_EDIT     16
#endif /* !OPENRJ_DOCUMENTATION_SKIP_SECTION */

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

#include <openrj/cpp/openrj.hpp>

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

#include <string.h>

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

namespace openrj
{
namespace cpp
{

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

class Field
{
public:
    typedef Field   class_type;

public:
    Field(ORJField const *field)
        : m_field(field)
    {}

    Field()
        : m_field(NULL)
    {}
    Field(class_type const &rhs)
        : m_field(rhs.m_field)
    {}

    class_type &operator =(class_type const &rhs)
    {
        m_field = rhs.m_field;

        return *this;
    }

public:
    char const *GetName() const
    {
        ORJString const *name;

        ORJ_Field_GetNameA(m_field, &name);

        return name->ptr;
    }
    char const *GetValue() const
    {
        ORJString const *value;

        ORJ_Field_GetValueA(m_field, &value);

        return value->ptr;
    }

public:
    bool IsEqual(class_type const &rhs) const
    {
        return 0 == strcmp(GetName(), rhs.GetName()) && 0 == strcmp(GetValue(), rhs.GetValue());
    }

public:
    ORJField const  *GetField() const
    {
        return m_field;
    }
    ORJRecord const *GetRecord() const
    {
        openrj_assert(NULL != m_field);

        return ORJ_Field_GetRecordA(m_field);
    }

// Members
private:
    ORJField const *m_field;
};

/* /////////////////////////////////////////////////////////////////////////////
 * Operators
 */

inline bool operator ==(Field const &lhs, Field const &rhs)
{
    return lhs.IsEqual(rhs);
}

inline bool operator !=(Field const &lhs, Field const &rhs)
{
    return !lhs.IsEqual(rhs);
}

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

inline ::stlsoft::basic_shim_string<char, true> c_str_ptr_null(Field const &f)
{
    ORJField const                              *pf =   f.GetField();
    size_t                                      cch =   pf->name.len + 1 + pf->value.len;
    ::stlsoft::basic_shim_string<char, true>    ss(cch);

    if(cch < ss.size())
    {
        char    *s  =   ss.data();

        strncpy(s, pf->name.ptr, pf->name.len);
        s += pf->name.len;
        *s++ = '=';
        strncpy(s, pf->value.ptr, pf->value.len);
    }

    return ss;
}

inline ::stlsoft::basic_shim_string<char> c_str_ptr(Field const &f)
{
    ORJField const                      *pf =   f.GetField();
    size_t                              cch =   pf->name.len + 1 + pf->value.len;
    ::stlsoft::basic_shim_string<char>  ss(cch);

    if(cch < ss.size())
    {
        char    *s  =   ss.data();

        strncpy(s, pf->name.ptr, pf->name.len);
        s += pf->name.len;
        *s++ = '=';
        strncpy(s, pf->value.ptr, pf->value.len);
    }

    return ss;
}

inline ::stlsoft::basic_shim_string<char> c_str_data(Field const &f)
{
    return c_str_ptr(f);
}

inline size_t c_str_len(Field const &f)
{
    ORJField const  *pf =   f.GetField();

    return pf->name.len + 1 + pf->value.len;
}

template <class S>
inline S &operator <<(S &s, Field const &field)
{
    s << field.GetName() << "=" << field.GetValue();

    return s;
}

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

} // namespace cpp
} // namespace openrj

namespace stlsoft
{
    using ::openrj::cpp::c_str_ptr_null;
    using ::openrj::cpp::c_str_ptr;
    using ::openrj::cpp::c_str_data;
    using ::openrj::cpp::c_str_len;
}

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

#endif /* !OPENRJ_INCL_OPENRJ_CPP_H_FIELD */

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

Open-RJ Library documentation © Synesis Software Pty Ltd, 2004-2005