commandHandler.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_CMDBIND_COMMAND_HANDLER_HPP_INCLUDED
#define _Wolframe_CMDBIND_COMMAND_HANDLER_HPP_INCLUDED
#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>
#include "types/doctypeinfo.hpp"
#include "processor/procProviderInterface.hpp"

namespace _Wolframe {

namespace proc {
class ExecContext;
}//namespace proc

namespace cmdbind {

class CommandHandler
{
public:
        enum Operation  {
                READ,                   
                WRITE,                  
                CLOSE                   
        };

        CommandHandler()
                :m_execContext(0){}

        virtual ~CommandHandler(){}

        virtual Operation nextOperation()=0;

        virtual void putInput( const void* begin, std::size_t bytesTransferred, bool eod)=0;

        virtual void getOutput( const void*& begin, std::size_t& bytesToTransfer)=0;


        const char* lastError() const
        {
                return m_lastError.empty()?0:m_lastError.c_str();
        }

        void setLastError( const std::string& msg)
        {
                m_lastError = msg;
        }

        virtual void setExecContext( proc::ExecContext* c)
        {
                m_execContext = c;
        }

        proc::ExecContext* execContext()
        {
                return m_execContext;
        }

        const types::DoctypeInfo* doctypeInfo() const
        {
                return m_doctypeinfo.get();
        }

        virtual void setDoctypeInfo( const types::DoctypeInfoR& doctypeinfo_)
        {
                m_doctypeinfo = doctypeinfo_;
        }

        std::size_t outputChunkSize() const
        {
                return m_outputChunkSize;
        }

        virtual void setOutputChunkSize( std::size_t outputChunkSize_)
        {
                m_outputChunkSize = outputChunkSize_;
        }

private:
        std::string m_lastError;                
        proc::ExecContext* m_execContext;       
        types::DoctypeInfoR m_doctypeinfo;      
        std::size_t m_outputChunkSize;          
};

typedef boost::shared_ptr<CommandHandler> CommandHandlerR;


class CommandHandlerUnit
{
public:
        virtual ~CommandHandlerUnit(){}

        virtual bool loadPrograms( const proc::ProcessorProviderInterface* provider)=0;

        virtual std::vector<std::string> commands() const=0;

        virtual CommandHandler* createCommandHandler( const std::string& cmdname, const std::string& docformat)=0;
};

typedef boost::shared_ptr<CommandHandlerUnit> CommandHandlerUnitR;


}}//namespace
#endif