kopetecommandhandler.h

Go to the documentation of this file.

/*
    kopetecommandhandler.h - Command Handler

    Copyright (c) 2003      by Jason Keirstead       <jason@keirstead.org>
    Kopete    (c) 2002-2003 by the Kopete developers <kopete-devel@kde.org>

    *************************************************************************
    *                                                                       *
    * 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 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETECOMMANDHANDLER_H
#define KOPETECOMMANDHANDLER_H

#include <QtCore/QMultiHash>

#include <kshortcut.h>
#include "kopetemessage.h"

#include "kopete_export.h"

class K3Process;

struct CommandHandlerPrivate;

class KopeteView;
class KopeteCommandGUIClient;

namespace Kopete
{

class ChatSession;
class Plugin;
class Protocol;
class Command;

typedef QMultiHash<QString, Command*> CommandList;

class KOPETE_EXPORT CommandHandler : public QObject
{
    friend class ::KopeteCommandGUIClient;

    Q_OBJECT

    public:
        enum CommandType { Normal, SystemAlias, UserAlias, Undefined };

        static CommandHandler *commandHandler();

        void registerCommand( QObject *parent, const QString &command, const char* handlerSlot,
            const QString &help = QString(), uint minArgs = 0, int maxArgs = -1,
            const KShortcut &cut = KShortcut(), const QString &pix = QString() );

        void registerAlias( QObject *parent,
            const QString &alias,
            const QString &formatString,
            const QString &help = QString(),
            CommandType = SystemAlias,
            uint minArgs = 0,
            int maxArgs = -1,
            const KShortcut &cut = KShortcut(),
            const QString &pix = QString() );

        void unregisterCommand( QObject *parent, const QString &command );

        void unregisterAlias( QObject *parent, const QString &alias );

        bool processMessage( Message &msg, ChatSession *manager );

        bool processMessage( const QString &msg, ChatSession *manager );

        static QStringList parseArguments( const QString &args );

        bool commandHandled( const QString &command );

        bool commandHandledByProtocol( const QString &command, Protocol *protocol);

    private slots:
        void slotPluginLoaded( Kopete::Plugin * );
        void slotPluginDestroyed( QObject * );
        void slotExecReturnedData(K3Process *proc, char *buff, int bufflen );
        void slotExecFinished(K3Process *proc);
        void slotViewCreated( KopeteView *view );

        void slotHelpCommand( const QString & args, Kopete::ChatSession *manager );
        void slotClearCommand( const QString & args, Kopete::ChatSession *manager );
        void slotPartCommand( const QString & args, Kopete::ChatSession *manager );
        void slotCloseCommand( const QString & args, Kopete::ChatSession *manager );
        void slotOpenLastUrl( const QString & args, Kopete::ChatSession *manager );
        //void slotMeCommand( const QString & args, Kopete::ChatSession *manager );
        void slotExecCommand( const QString & args, Kopete::ChatSession *manager );
        void slotAwayCommand( const QString & args, Kopete::ChatSession *manager );
        void slotAwayAllCommand( const QString & args, Kopete::ChatSession *manager );
        void slotSayCommand( const QString & args, Kopete::ChatSession *manager );

    private:
        CommandList commands( Protocol * );

        void addCommands( CommandList &from, CommandList &to, CommandType type = Undefined );

        CommandHandler();
        ~CommandHandler();

        static CommandHandlerPrivate *p;
};

}

#endif