src/core/plugins/engineplugin.h

//------------------------------------------------------------------------------
// engineplugin.h
//------------------------------------------------------------------------------
//
// 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 2
// 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 Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
//------------------------------------------------------------------------------
// Copyright (C) 2011 "Blzut3" <admin@maniacsvault.net>
//------------------------------------------------------------------------------

#ifndef __ENGINEPLUGIN_H__
#define __ENGINEPLUGIN_H__

#include <QtContainerFwd>
#include <QString>
#include <QVector>
#include "global.h"
#include "serverapi/serverstructs.h"

#define DECLARE_PLUGIN(XEnginePlugin) \
        public: \
                static EnginePlugin *staticInstance() { return &__Static_Instance; } \
        protected: \
                static XEnginePlugin __Static_Instance;

#define INSTALL_PLUGIN(XEnginePlugin) \
        XEnginePlugin XEnginePlugin::__Static_Instance; \
        extern "C" PLUGIN_EXPORT EnginePlugin *doomSeekerInit() \
        { \
                return XEnginePlugin::staticInstance(); \
        }

class Binaries;
class ConfigurationBaseBox;
class GameCVar;
class GameMode;
class IniSection;
class IRCNetworkEntity;
class MasterClient;
class Server;
class QHostAddress;
class QPixmap;
class QWidget;

class MAIN_EXPORT EnginePlugin
{
        protected:
                enum InitFeatures
                {
                        EP_Done, 

                        EP_Author, 
                        EP_Version, 

                        EP_AllDMFlags, 
                        EP_AllowsConnectPassword, 
                        EP_AllowsEmail, 
                        EP_AllowsURL, 
                        EP_AllowsJoinPassword, 
                        EP_AllowsRConPassword, 
                        EP_AllowsMOTD, 
                        EP_DefaultMaster, 
                        EP_DefaultServerPort, 
                        EP_GameModes, 
                        EP_GameModifiers, 
                        EP_HasMasterServer, 
                        EP_InGameFileDownloads, 
                        EP_IRCChannel, 
                        EP_SupportsRandomMapRotation, 
                        EP_RefreshThreshold 
                };

                virtual void                                                    setupConfig(IniSection &config) const {}

        public:
                class Data
                {
                        public:
                                const DMFlags*                  allDMFlags;
                                bool                                    allowsConnectPassword;
                                bool                                    allowsEmail;
                                bool                                    allowsJoinPassword;
                                bool                                    allowsMOTD;
                                bool                                    allowsRConPassword;
                                bool                                    allowsURL;
                                QString                                 author;
                                QString                                 defaultMaster;
                                quint16                                 defaultServerPort;
                                const QList<GameMode>*  gameModes;
                                const QList<GameCVar>*  gameModifiers;
                                bool                                    hasMasterServer;
                                QPixmap                                 *icon;
                                bool                                    inGameFileDownloads;
                                QVector<IRCNetworkEntity> ircChannels;
                                QString                                 name;
                                IniSection                              *pConfig;
                                quint8                                  refreshThreshold;
                                bool                                    supportsRandomMapRotation;
                                bool                                    valid;
                                unsigned int                    version;

                                Data();
                };

                EnginePlugin();
                virtual ~EnginePlugin();

                void init(const char* name, const char* const icon[], ...);

                virtual ConfigurationBaseBox*   configuration(QWidget *parent) const;

                const Data                                              *data() const { return d; }
                const QPixmap                                   &icon() const { return *d->icon; }
                void                                                    setConfig(IniSection &cfg) const;

                virtual QList<GameCVar>                 limits(const GameMode& mode) const { return QList<GameCVar>(); }

                virtual MasterClient*                   masterClient() const { return NULL; }
                void                                                    masterHost(QString &host, unsigned short &port) const;

                virtual Server*                                 server(const QHostAddress &address, unsigned short port) const = 0;

        private:
                Data    *d;
};

#endif