structDescriptionBase.hpp

Go to the documentation of this file.

/************************************************************************
Copyright (C) 2011 - 2014 Project Wolframe.
All rights reserved.

This file is part of Project Wolframe.

Commercial Usage
Licensees holding valid Project Wolframe Commercial licenses may
use this file in accordance with the Project Wolframe
Commercial License Agreement provided with the Software or,
alternatively, in accordance with the terms contained
in a written agreement between the licensee and Project Wolframe.

GNU General Public License Usage
Alternatively, you can redistribute this file and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Wolframe is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Wolframe. If not, see <http://www.gnu.org/licenses/>.

If you have questions regarding the use of this file, please contact
Project Wolframe.

************************************************************************/
#ifndef _Wolframe_SERIALIZE_STRUCT_DESCRIPTION_BASE_HPP_INCLUDED
#define _Wolframe_SERIALIZE_STRUCT_DESCRIPTION_BASE_HPP_INCLUDED
#include "filter/typedfilter.hpp"
#include "types/variant.hpp"
#include "serialize/mapContext.hpp"
#include "serialize/struct/parseStack.hpp"
#include "serialize/struct/serializeStack.hpp"
#include <cstddef>
#include <string>
#include <vector>
#include <limits>

namespace _Wolframe {
namespace serialize {

class StructDescriptionBase
{
public:
        enum ElementType
        {
                Atomic,         
                Struct,         
                Vector          
        };

        typedef std::vector<std::pair<std::string,StructDescriptionBase> > Map;
        typedef bool (*Parse)( langbind::TypedInputFilter& flt, Context& ctx, ParseStateStack& stk);
        typedef bool (*Fetch)( Context& ctx, SerializeStateStack& stk);
        typedef bool (*Constructor)( void* obj);
        typedef void (*Destructor)( void* obj);

        Parse parse() const             {return m_parse;}
        Fetch fetch() const             {return m_fetch;}

        enum ElementRequirement
        {
                NoRequirement,          
                Mandatory,              
                Optional                
        };
        StructDescriptionBase( Constructor c, Destructor d, const char* tn, std::size_t os, std::size_t sz, ElementType t, Parse pa, Fetch pr, ElementRequirement req_);
        StructDescriptionBase( const char* tn, std::size_t os, std::size_t sz, ElementType t, Parse pa, Fetch pr, ElementRequirement req_);
        StructDescriptionBase( const StructDescriptionBase& o);
        StructDescriptionBase();

        bool parse( void* obj, langbind::TypedInputFilter& in, Context& ctx, ParseStateStack& stk) const;

        bool setAtomicValue( void* obj, std::size_t idx, const std::string& value) const;

        bool init( void* obj) const
        {
                return (m_constructor)?m_constructor( obj):true;
        }

        void done( void* obj) const
        {
                if (m_destructor) m_destructor( obj);
        }

        std::size_t size() const
        {
                return m_size;
        }

        std::size_t ofs() const
        {
                return m_ofs;
        }

        ElementType type() const
        {
                return m_type;
        }

        Map::const_iterator find( const std::string& name) const;
        Map::const_iterator find_cis( const std::string& name) const;
        std::string names( const char* sep) const;

        Map::const_iterator begin() const {return m_elem.begin();}
        Map::const_iterator end() const {return m_elem.end();}

        void define( const std::string& name, const StructDescriptionBase& dd)
        {
                m_elem.push_back( Map::value_type(name,dd));
        }

        std::size_t nof_attributes() const
        {
                return m_nof_attributes;
        }

        void defineEndOfAttributes()
        {
                m_nof_attributes = m_elem.size();
        }

        std::size_t nof_elements() const
        {
                return m_elem.size();
        }

        const char* typeName() const
        {
                return m_typename;
        }

        bool mandatory() const                          {return m_requirement == Mandatory;}
        bool optional() const                           {return m_requirement == Optional;}
        void requirement( ElementRequirement requirement_){m_requirement = requirement_;}

protected:
        StructDescriptionBase& last()
        {
                if (m_elem.empty()) throw std::logic_error( "access of last element in empty structure");
                return m_elem.back().second;
        }

private:
        Constructor m_constructor;
        Destructor m_destructor;
        const char* m_typename;
        std::size_t m_ofs;
        std::size_t m_size;
        std::size_t m_nof_attributes;
        Map m_elem;
        ElementType m_type;
        Parse m_parse;
        Fetch m_fetch;
        ElementRequirement m_requirement;
};

struct EmptyStruct
{
        static const serialize::StructDescriptionBase* getStructDescription();
};

}}//namespace
#endif