inputfilter.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_FILTER_INPUTFILTER_INTERFACE_HPP_INCLUDED
#define _Wolframe_FILTER_INPUTFILTER_INTERFACE_HPP_INCLUDED
#include "types/sharedReference.hpp"
#include "types/docmetadata.hpp"
#include "filter/filterbase.hpp"
#include <string>
#include <stdexcept>
#include <cstring>
#include <cstdlib>
#include <boost/shared_ptr.hpp>

namespace _Wolframe {
namespace langbind {

class InputFilter
        :public ContentFilterBase
{
public:
        enum State
        {
                Start,          
                Open,           
                EndOfMessage,   
                Error           
        };

        explicit InputFilter( const char* name_)
                :ContentFilterBase(name_)
                ,m_state(Start)
                ,m_metadata( new types::DocMetaData()){}

        InputFilter( const char* name_, const types::DocMetaData& metadata)
                :ContentFilterBase(name_)
                ,m_state(Start)
                ,m_metadata( new types::DocMetaData( metadata)){}

        InputFilter( const InputFilter& o)
                :ContentFilterBase(o)
                ,m_state(o.m_state)
                ,m_metadata( new types::DocMetaData( *o.m_metadata)){}

        virtual ~InputFilter(){}

        virtual InputFilter* copy() const=0;

        virtual void putInput( const void* ptr, std::size_t size, bool end)=0;

        virtual bool getNext( ElementType& type, const void*& element, std::size_t& elementsize)=0;

        State state() const                                             {return m_state;}

        void setState( State s, const char* msg=0)                      {m_state=s; setError(msg);}

        virtual const types::DocMetaData* getMetaData()=0;

        virtual const types::DocMetaDataR& getMetaDataRef() const       {return m_metadata;}

        void setAttribute( const std::string& name_, const std::string& value_)
        {
                m_metadata->setAttribute( name_, value_);
        }

        void setDoctype( const std::string& doctype_)
        {
                m_metadata->setDoctype( doctype_);
        }

        virtual bool checkMetaData( const types::DocMetaData&)
        {
                return true;
        }

private:
        State m_state;                          
        types::DocMetaDataR m_metadata;         
};

typedef types::SharedReference<InputFilter> InputFilterR;


}}//namespace
#endif