gameclientrunner.h

//------------------------------------------------------------------------------
// gameclientrunner.h
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2010 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef id50da6ce1_f633_485e_9e5f_e808731b1e2e
#define id50da6ce1_f633_485e_9e5f_e808731b1e2e

#include "dptr.h"
#include "global.h"
#include "pathfinder/pathfinder.h"
#include "serverapi/joinerror.h"
#include "serverapi/polymorphism.h"
#include "serverapi/serverptr.h"
#include <QObject>
#include <QString>

class CommandLineInfo;
class Message;
class Server;

class MAIN_EXPORT ServerConnectParams
{
public:
        ServerConnectParams();
        ServerConnectParams(const ServerConnectParams &other);
        ServerConnectParams &operator=(const ServerConnectParams &other);
        virtual ~ServerConnectParams();

        const QString &connectPassword() const;
        const QString &demoName() const;
        const QString &inGamePassword() const;

        void setConnectPassword(const QString &val);
        void setDemoName(const QString &val);
        void setInGamePassword(const QString &val);

private:
        DPtr<ServerConnectParams> d;
};

class MAIN_EXPORT GameClientRunner : public QObject
{
        Q_OBJECT

public:
        GameClientRunner(ServerPtr server);
        virtual ~GameClientRunner() override;

        JoinError createJoinCommandLine(CommandLineInfo &cli,
                const ServerConnectParams &params);

        JoinError joinError() const;

protected:
        void addConnectCommand();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addConnectCommand, ())
        void addConnectCommand_default();

        void addCustomParameters();
        void addDemoRecordCommand();

        void addExtra();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addExtra, ())
        void addExtra_default();

        void addGamePaths();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addGamePaths, ())
        void addGamePaths_default();
        void addInGamePassword();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addInGamePassword, ())
        void addInGamePassword_default();
        void addIwad();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addIwad, ())
        void addIwad_default();

        void addWads();
        void addPwads();

        void addModFiles(const QStringList &files);
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addModFiles, (const QStringList &))
        void addModFiles_default(const QStringList &files);
        void addModFiles_prefixOnce(const QStringList &files);

        void addPassword();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, addPassword, ())
        void addPassword_default();

        QStringList &args();

        const QString &argForBexLoading() const;

        const QString &argForConnect() const;

        const QString &argForConnectPassword() const;

        const QString &argForDehLoading() const;

        const QString &argForInGamePassword() const;

        const QString &argForIwadLoading() const;

        const QString &argForPort() const;

        const QString &argForOptionalWadLoading() const;

        const QString &argForPwadLoading() const;

        const QString &argForDemoRecord() const;

        void createCommandLineArguments();
        POLYMORPHIC_SETTER_DECLARE(void, GameClientRunner, createCommandLineArguments, ())
        void createCommandLineArguments_default();

        const QString &connectPassword() const;
        const QString &demoName() const;

        QString findWad(const QString &wad) const;

        const QString &inGamePassword() const;

        bool isIwadFound() const;
        const QString &iwadPath() const;

        void markPwadAsMissing(const PWad &pwadName);

        void markPwadAsIncompatible(const PWad &pwadName);

        PathFinder &pathFinder();

        ServerConnectParams &serverConnectParams();

        void setArgForBexLoading(const QString &arg);
        void setArgForConnect(const QString &arg);
        void setArgForConnectPassword(const QString &arg);
        void setArgForDehLoading(const QString &arg);
        void setArgForDemoRecord(const QString &arg);
        void setArgForInGamePassword(const QString &arg);
        void setArgForIwadLoading(const QString &arg);
        void setArgForOptionalWadLoading(const QString &arg);
        void setArgForPort(const QString &arg);
        void setArgForPwadLoading(const QString &arg);

        void setExecutable(const QString &path);
        void setWorkingDir(const QString &path);

        void setJoinError(const JoinError &e);

        QString wadTargetDirectory() const;

private:
        class GamePaths
        {
        public:
                QString clientExe;
                QString workingDir;

                bool isValid() const
                {
                        return !clientExe.isEmpty();
                }
        };

        DPtr<GameClientRunner> d;

        bool canDownloadWadsInGame() const;
        bool isFatalError() const;
        QString fileLoadingPrefix(const QString &file) const;
        QString findIwad() const;
        GamePaths gamePaths();
        const QString &pluginName() const;
        void saveDemoMetaData();

        void setupPathFinder();
};

#endif