HostInterface.h

Go to the documentation of this file.

// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   Free Software Foundation, Inc
// 
// This program is free software; you can redistribute it 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.
// 
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA


#ifndef GNASH_HOST_INTERFACE_H
#define GNASH_HOST_INTERFACE_H

#include <boost/variant.hpp>
#include <boost/any.hpp>
#include <string>
#include <iosfwd>

#include "dsodefs.h"

namespace gnash {

//
class CustomMessage
{
public:
    explicit CustomMessage(const std::string& s,
            const boost::any& arg = boost::blank())
        :
        _name(s),
        _arg(arg)
    {}
    const std::string& name() const { return _name; }
    const boost::any& arg() const { return _arg; }
private:
    std::string _name;
    boost::any _arg;
};

//
class HostMessage
{
public:

    //
    enum KnownEvent {

        SHOW_MOUSE,

        RESIZE_STAGE,

        UPDATE_STAGE,

        SHOW_MENU,

        SET_DISPLAYSTATE,

        SET_CLIPBOARD,

        SCREEN_RESOLUTION,

        SCREEN_DPI,

        PIXEL_ASPECT_RATIO,

        PLAYER_TYPE,

        SCREEN_COLOR,

        NOTIFY_ERROR,

        QUERY,

        EXTERNALINTERFACE_ISPLAYING,
        EXTERNALINTERFACE_PAN,
        EXTERNALINTERFACE_PLAY,
        EXTERNALINTERFACE_REWIND,
        EXTERNALINTERFACE_SETZOOMRECT,
        EXTERNALINTERFACE_STOPPLAY,
        EXTERNALINTERFACE_ZOOM
    };

    explicit HostMessage(KnownEvent e, const boost::any& arg = boost::blank())
        :
        _event(e),
        _arg(arg)
    {}

    KnownEvent event() const { return _event; }
    const boost::any& arg() const { return _arg; }

private:
    KnownEvent _event;
    boost::any _arg;
};

class FsCallback
{
public:
    virtual void notify(const std::string& cmd, const std::string& arg) = 0;
    virtual ~FsCallback() {}
};

class HostInterface
{
public:

    virtual ~HostInterface() {}

    typedef boost::variant<HostMessage, CustomMessage> Message;

    //
    //
    virtual boost::any call(const Message& e) = 0;

    //
    virtual void exit() = 0;

};

DSOEXPORT std::ostream& operator<<(std::ostream& os, const HostMessage& m);
DSOEXPORT std::ostream& operator<<(std::ostream& os, const CustomMessage& m);

DSOEXPORT std::ostream& operator<<(std::ostream& os, HostMessage::KnownEvent e);


} // namespace gnash

#endif