1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/*
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 <tqdict.h>
#include <tdeshortcut.h>
#include "kopetemessage.h"
#include "kopete_export.h"
class TDEProcess;
struct CommandHandlerPrivate;
class KopeteView;
class KopeteCommandGUIClient;
namespace Kopete
{
class ChatSession;
class Plugin;
class Protocol;
class Command;
typedef TQDict<Command> CommandList;
/**
* @author Jason Keirstead <jason@keirstead.org>
*
* The Kopete::CommandHandler can handle /action like messages
*/
class KOPETE_EXPORT CommandHandler : public TQObject
{
friend class ::KopeteCommandGUIClient;
Q_OBJECT
public:
/**
* an enum defining the type of a command
*/
enum CommandType { Normal, SystemAlias, UserAlias, Undefined };
/**
* Returns a pointer to the command handler
*/
static CommandHandler *commandHandler();
/**
* \brief Register a command with the command handler.
*
* Command matching is case insensitive. All commands are registered,
* regardless of whether or not they are already handled by another
* handler. This is so that if the first plugin is unloaded, the next
* handler in the sequence will handle the command. However, there are
* certain commands which are reserved (internally handled by the
* Kopete::CommandHandler). These commands can also be overridden by
* registering a new duplicate command.
*
* @param parent The plugin who owns this command
* @param command The command we want to handle, not including the '/'
* @param handlerSlot The slot used to handle the command. This slot must
* accept two parameters, a TQString of arguments, and a Kopete::ChatSession
* pointer to the manager under which the command was sent.
* @param help An optional help string to be shown when the user uses
* /help \<command\>
* @param minArgs the minimum number of arguments for this command
* @param maxArgs the maximum number of arguments this command takes
* @param cut a default keyboard shortcut
* @param pix icon name, the icon will be shown in menus
*/
void registerCommand( TQObject *parent, const TQString &command, const char* handlerSlot,
const TQString &help = TQString(), uint minArgs = 0, int maxArgs = -1,
const TDEShortcut &cut = 0, const TQString &pix = TQString() );
/**
* \brief Register a command alias.
*
* @param parent The plugin who owns this alias
* @param alias The command for the alias
* @param formatString This is the string that will be transformed into another
* command. The formatString should begin with an already existing command,
* followed by any other arguments. The variables %1, %2... %9 will be substituted
* with the arguments passed into the alias. The variable %s will be substituted with
* the entire argument string
* @param help An optional help string to be shown when the user uses
* /help \<command\>
* @param minArgs the minimum number of arguments for this command
* @param maxArgs the maximum number of arguments this command takes
* @param cut a default keyboard shortcut
* @param pix icon name, the icon will be shown in menus
*/
void registerAlias( TQObject *parent,
const TQString &alias,
const TQString &formatString,
const TQString &help = TQString(),
CommandType = SystemAlias,
uint minArgs = 0,
int maxArgs = -1,
const TDEShortcut &cut = 0,
const TQString &pix = TQString() );
/**
* \brief Unregister a command.
*
* When a plugin unloads, all commands are automaticlly unregistered and deleted.
* This function should only be called in the case of a plugin which loads and
* unloads commands dynamically.
*
* @param parent The plugin who owns this command
* @param command The command to unload
*/
void unregisterCommand( TQObject *parent, const TQString &command );
/**
* \brief Unregister an alias.
*
* \see unregisterCommand( TQObject *parent, const TQString &command )
* @param parent The plugin who owns this alias
* @param alias The alais to unload
*/
void unregisterAlias( TQObject *parent, const TQString &alias );
/**
* \brief Process a message to see if any commands should be handled
*
* @param msg The message to process
* @param manager The manager who owns this message
* @return True if the command was handled, false if not
*/
bool processMessage( Message &msg, ChatSession *manager );
/**
* \brief Process a message to see if any commands should be handled
*
* \see processMessage( Kopete::Message &msg, Kopete::ChatSession *manager)
* \param msg A TQString contain the message
* \param manager the Kopete::ChatSession who will own the message
* \return true if the command was handled, false if the command was not handled.
*/
bool processMessage( const TQString &msg, ChatSession *manager );
/**
* Parses a string of command arguments into a TQStringList. Quoted
* blocks within the arguments string are treated as one argument.
*/
static TQStringList parseArguments( const TQString &args );
/**
* \brief Check if a command is already handled
*
* @param command The command to check
* @return True if the command is already being handled, False if not
*/
bool commandHandled( const TQString &command );
/**
* \brief Check if a command is already handled by a spesific protocol
*
* @param command The command to check
* @param protocol The protocol to check
* @return True if the command is already being handled, False if not
*/
bool commandHandledByProtocol( const TQString &command, Protocol *protocol);
private slots:
void slotPluginLoaded( Kopete::Plugin * );
void slotPluginDestroyed( TQObject * );
void slotExecReturnedData(TDEProcess *proc, char *buff, int bufflen );
void slotExecFinished(TDEProcess *proc);
void slotViewCreated( KopeteView *view );
void slotHelpCommand( const TQString & args, Kopete::ChatSession *manager );
void slotClearCommand( const TQString & args, Kopete::ChatSession *manager );
void slotPartCommand( const TQString & args, Kopete::ChatSession *manager );
void slotCloseCommand( const TQString & args, Kopete::ChatSession *manager );
//void slotMeCommand( const TQString & args, Kopete::ChatSession *manager );
void slotExecCommand( const TQString & args, Kopete::ChatSession *manager );
void slotAwayCommand( const TQString & args, Kopete::ChatSession *manager );
void slotAwayAllCommand( const TQString & args, Kopete::ChatSession *manager );
void slotSayCommand( const TQString & args, Kopete::ChatSession *manager );
private:
/**
* Helper function. Returns all the commands that can be used by a KMM of this protocol
* (all non-protocol commands, plus this protocols commands)
*/
CommandList commands( Protocol * );
/**
* Helper function for commands()
*/
void addCommands( CommandList &from, CommandList &to, CommandType type = Undefined );
CommandHandler();
~CommandHandler();
static CommandHandlerPrivate *p;
};
}
#endif
|
