outputfilter.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_OUTPUTFILTER_INTERFACE_HPP_INCLUDED
#define _Wolframe_FILTER_OUTPUTFILTER_INTERFACE_HPP_INCLUDED
#include "types/sharedReference.hpp"
#include "types/docmetadata.hpp"
#include "filter/filterbase.hpp"
#include <string>
#include <cstring>
#include <stdexcept>

namespace _Wolframe {
namespace langbind {

class OutputFilter
        :public ContentFilterBase
{
public:
        enum State
        {
                Start,          
                Open,           
                EndOfBuffer,    
                Error           
        };

        OutputFilter( const char* name_, const types::DocMetaDataR& inheritMetadata_)
                :ContentFilterBase(name_)
                ,m_state(Start)
                ,m_outputChunkSize(0)
                ,m_inheritMetadata(inheritMetadata_)
        {}

        explicit OutputFilter( const char* name_)
                :ContentFilterBase(name_)
                ,m_state(Start)
                ,m_outputChunkSize(0)
        {}

        OutputFilter( const OutputFilter& o)
                :ContentFilterBase(o)
                ,m_state(o.m_state)
                ,m_outputChunkSize(o.m_outputChunkSize)
                ,m_inheritMetadata(o.m_inheritMetadata)
                ,m_metadata(o.m_metadata)
                {}

        virtual ~OutputFilter(){}

        virtual OutputFilter* copy() const=0;

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

        bool print( ElementType type, const std::string& element)
        {
                return print( type, element.c_str(), element.size());
        }

        virtual void getOutput( const void*& buf, std::size_t& bufsize)=0;

        virtual bool close()=0;

        void setMetaData( const types::DocMetaData& md)
        {
                if (state() != Start)
                {
                        throw std::runtime_error( "cannot set output meta data anymore after first call of print");
                }
                m_metadata = md;
        }

        types::DocMetaData getMetaData() const
        {
                types::DocMetaData rt( m_metadata.doctype(), m_inheritMetadata->attributes());
                rt.join( m_metadata.attributes());
                return rt;
        }

        virtual void inheritMetaData( const types::DocMetaDataR mdr)
        {
                m_inheritMetadata = mdr;
        }

        State state() const                                     {return m_state;}

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

        void setAttribute( const std::string& name_, const std::string& value_)
        {
                if (state() != Start)
                {
                        throw std::runtime_error( "cannot set output meta data anymore after first call of print");
                }
                m_metadata.setAttribute( name_, value_);
        }

        void setDoctype( const std::string& id_)
        {
                if (state() != Start)
                {
                        throw std::runtime_error( "cannot set document type anymore after first call of print");
                }
                m_metadata.setDoctype( id_);
        }

        void setOutputChunkSize( unsigned int outputChunkSize_)
        {
                m_outputChunkSize = outputChunkSize_;
        }

        unsigned int outputChunkSize() const
        {
                return m_outputChunkSize;
        }

private:
        State m_state;                                  
        unsigned int m_outputChunkSize;                 
        types::DocMetaDataR m_inheritMetadata;          
        types::DocMetaData m_metadata;                  
};

typedef types::SharedReference<OutputFilter> OutputFilterR;

}}//namespace
#endif