summaryrefslogtreecommitdiffstats
path: root/src/modules/action/libkviaction.cpp
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-24 02:13:59 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-02-24 02:13:59 +0000
commita6d58bb6052ac8cb01805a48c4ad2f129126116f (patch)
treedd867a099fcbb263a8009a9fb22695b87855dad6 /src/modules/action/libkviaction.cpp
downloadkvirc-a6d58bb6052ac8cb01805a48c4ad2f129126116f.tar.gz
kvirc-a6d58bb6052ac8cb01805a48c4ad2f129126116f.zip
Added KDE3 version of kvirc
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/kvirc@1095341 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'src/modules/action/libkviaction.cpp')
-rw-r--r--src/modules/action/libkviaction.cpp533
1 files changed, 533 insertions, 0 deletions
diff --git a/src/modules/action/libkviaction.cpp b/src/modules/action/libkviaction.cpp
new file mode 100644
index 00000000..daf84699
--- /dev/null
+++ b/src/modules/action/libkviaction.cpp
@@ -0,0 +1,533 @@
+///////////////////////////////////////////////////////////////////////////////
+//
+// File : libkviaction.cpp
+// Creation date : Tue 7 Dec 00:05:59 2002 GMT by Szymon Stefanek
+//
+// This toolbar is part of the KVirc irc client distribution
+// Copyright (C) 2004-2005 Szymon Stefanek (pragma at kvirc dot net)
+//
+// 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 opinion) 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.
+//
+///////////////////////////////////////////////////////////////////////////////
+
+#include "kvi_module.h"
+#include "kvi_action.h"
+#include "kvi_actionmanager.h"
+#include "kvi_locale.h"
+#include "kvi_qstring.h"
+#include "kvi_parameterlist.h"
+#include "kvi_cmdformatter.h"
+#include "kvi_qstring.h"
+#include "kvi_error.h"
+#include "kvi_out.h"
+#include "kvi_iconmanager.h"
+#include "kvi_mirccntrl.h"
+#include "kvi_kvs_useraction.h"
+#include "kvi_kvs_script.h"
+
+/*
+ @doc: action.list
+ @type:
+ command
+ @title:
+ action.list
+ @short:
+ Lists the available actions
+ @syntax:
+ action.list
+ @description:
+ Lists the currently defined actions: nothing more, nothing less.
+*/
+
+static bool action_kvs_cmd_list(KviKvsModuleCommandCall * c)
+{
+ KviWindow * pOut = c->window();
+
+ KviPointerHashTableIterator<QString,KviAction> it(*(KviActionManager::instance()->actions()));
+ while(KviAction * a = it.current())
+ {
+ if(a->isKviUserActionNeverOverrideThis())
+ pOut->output(KVI_OUT_VERBOSE,__tr2qs("%cCore action: %Q"),KVI_TEXT_BOLD,&(a->name()));
+ else
+ pOut->output(KVI_OUT_VERBOSE,__tr2qs("%cUser action: %Q"),KVI_TEXT_BOLD,&(a->name()));
+ pOut->output(KVI_OUT_VERBOSE,__tr2qs("Label: %Q"),&(a->visibleName()));
+ pOut->output(KVI_OUT_VERBOSE,__tr2qs("Category: %Q"),&(a->category()->visibleName()));
+ pOut->output(KVI_OUT_VERBOSE,__tr2qs("Description: %Q"),&(a->description()));
+ pOut->output(KVI_OUT_VERBOSE," "); // spacer
+ ++it;
+ }
+ return true;
+}
+
+/*
+ @doc: action.trigger
+ @type:
+ command
+ @title:
+ action.trigger
+ @short:
+ Triggers an action
+ @syntax:
+ action.trigger [-q] <name:string>
+ @switches:
+ !sw: -q | --quiet
+ Run in quiet mode (do not print any warnings)
+ @description:
+ Triggers the action specified by <name>, if that action exists and is enabled.
+ If the -q switch is specified the command runs in quiet mode and
+ does not print warnings if the action is not defined or disabled.
+ @examples:
+ [example]
+ action.trigger connect
+ [/example]
+*/
+
+static bool action_kvs_cmd_trigger(KviKvsModuleCommandCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+
+ KviAction * a = KviActionManager::instance()->getAction(szName);
+ if(a)
+ {
+ if(a->isEnabled())
+ {
+ a->activate();
+ } else {
+ if(!c->switches()->find('q',"quiet"))
+ c->warning(__tr2qs("The action \"%1\" is disabled").arg(szName));
+ }
+ } else {
+ c->warning(__tr2qs("The action \"%1\" does not exist").arg(szName));
+ }
+
+ return true;
+}
+
+/*
+ @doc: action.enable
+ @type:
+ command
+ @title:
+ action.enable
+ @short:
+ Enables an action
+ @syntax:
+ action.enable [-q] <name:string>
+ @switches:
+ !sw: -q | --quiet
+ Run quietly, do not print any warnings
+ @description:
+ Enables the action specified by <name>, if that action exists.
+ If the action was previously enabled then this command does nothing.
+ otherwise all the toolbar buttons and menu items belonging to this
+ action will get enabled.[br]
+ Since [cmd]action.create[/cmd] command allows specifying contexts
+ for actions and the action engine is able to enable/disable the actions
+ automatically on certain events you will probably never need to use this command.
+ If the -q switch is specified the command runs in quiet mode and
+ does not print warnings if the action is not defined.
+ @seealso:
+ [cmd]action.disable[/cmd]
+*/
+
+static bool action_kvs_cmd_enable(KviKvsModuleCommandCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+
+ KviAction * a = KviActionManager::instance()->getAction(szName);
+ if(a)
+ {
+ if(!a->isEnabled())a->setEnabled(true);
+ } else {
+ if(!c->switches()->find('q',"quiet"))
+ c->warning(__tr2qs("The action \"%1\" does not exist").arg(szName));
+ }
+
+ return true;
+}
+
+/*
+ @doc: action.disable
+ @type:
+ command
+ @title:
+ action.disable
+ @short:
+ Disables an action
+ @syntax:
+ action.disable [-q] [-f] <name:string>
+ @switches:
+ !sw: -q | --quiet
+ Run quietly, do not print any warnings
+ @description:
+ Disables the action specified by <name>, if that action exists.
+ If the action was previously disabled then this command does nothing.
+ otherwise all the toolbar buttons and menu items belonging to this
+ action will get disabled.[br]
+ Since [cmd]action.create[/cmd] command allows specifying contexts
+ for actions and the action engine is able to enable/disable the actions
+ automatically on certain events you will probably never need to use this command.
+ For the same reason the action may get automatically re-enabled when
+ one of the enabling events specified at [cmd]action.create[/cmd] time happens.
+ If the -q switch is specified the command runs in quiet mode and
+ does not print warnings if the action is not defined.
+ @seealso:
+ [cmd]action.enable[/cmd]
+*/
+
+static bool action_kvs_cmd_disable(KviKvsModuleCommandCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+
+ KviAction * a = KviActionManager::instance()->getAction(szName);
+ if(a)
+ {
+ if(a->isEnabled())a->setEnabled(false);
+ } else {
+ if(!c->switches()->find('q',"quiet"))
+ c->warning(__tr2qs("The action \"%1\" does not exist").arg(szName));
+ }
+
+ return true;
+}
+
+/*
+ @doc: action.destroy
+ @type:
+ command
+ @title:
+ action.destroy
+ @short:
+ Destroy an action
+ @syntax:
+ action.destroy [-q] <name:string>
+ @switches:
+ !sw: -q | --quiet
+ Run quietly, do not print any warnings
+ @description:
+ Destroys the action specified by <name>, if that action exists.[br]
+ Destroying an action will remove it from any toolbar or popup.[br]
+ If the -q switch is specified the command runs in quiet mode and
+ does not print warnings if the action is not defined.
+ Please note that you CAN'T destroy core actions, you can destroy
+ only script actions that have been defined by the user (or other scripts).
+ @seealso:
+ # this will trigger a warning and NOT work
+ action.destroy connect
+*/
+
+static bool action_kvs_cmd_destroy(KviKvsModuleCommandCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+
+ KviAction * a = KviActionManager::instance()->getAction(szName);
+ if(a)
+ {
+ if(a->isKviUserActionNeverOverrideThis())
+ {
+ a->suicide();
+ } else {
+ if(!c->switches()->find('q',"quiet"))
+ c->warning(__tr2qs("The action \"%1\" is a core action and cannot be destroyed").arg(szName));
+ }
+ } else {
+ if(!c->switches()->find('q',"quiet"))
+ c->warning(__tr2qs("The action \"%1\" does not exist").arg(szName));
+ }
+
+ return true;
+}
+
+/*
+ @doc: action.create
+ @type:
+ command
+ @title:
+ action.create
+ @short:
+ Defines a new action
+ @syntax:
+ action.create [-i] [-c] [-l] [-w=<window_types:string>] [-s] [-t=<category:string>] (<name:string>,<visible label:string>,<description:string>,<big_icon_id:string>[,<small_icon_id:string>])
+ {
+ <action body>
+ }
+ @switches:
+ !sw: -i | --bind-to-context
+ Specifies that the action needs an IRC context to be executed.
+ When the current window does not belong to an IRC context
+ the action is automatically disabled
+
+ !sw: -c | --bind-to-connection
+ Specifies that the action needs an IRC connection to be executed.
+ When the current window has no associated IRC connection
+ the action is automatically disabled.
+ This switch implies -i.
+
+ !sw: -l | --enable-at-login
+ Specifies that the action needs to be enabled at login time, that is
+ when a link to the server has been estabilished but the login
+ operations haven't been carried out yet (and thus there is no real IRC connection).
+ This switch requires -c to work.
+
+ !sw: -w=<window_types> | --window-types=<window_type>
+ Causes the action to be enabled only when the active window
+ is one of the specified types. <window_types> may be any combination
+ of the letters 'q' (query), 'c' (channel), 'x' (console), 'd' (dccchat).
+ If this switch is omitted then the action is enabled in all the windows.[br]
+
+ !sw: -s | --selected-only
+ Specifies that the action will be activated only if the active window
+ has selected users in the userlist. This switch requires -w with a combination
+ of flags 'q','c' and 'x' (it doesn't work for dcc chat).
+
+ !sw: -t=<category> | --category=<category>
+ Causes the action to belong to the specified category.
+ <category> can be one of "irc","scripting","settings","gui","channel","tools" and "generic".
+ If this switch is omitted the "generic" category is automatically assumed.
+ The actions failing in the "tools" category will appear in the "Tools" KVIrc menu too.
+
+ !sw: -k=<key sequence> | --key-sequence=<key sequence>
+ Specifies that the action will be activated also by the <key sequence>
+ which is a string formed from up to four keyboard codes separated by
+ commas optionally combined with the modifiers "Alt","Ctrl","Shift" and "Meta".[br]
+ Examples of such sequences are: "Ctrl+X", "Ctrl+Alt+F" or "Ctrl+X,Alt+Space".
+ @description:
+ [p]
+ Defines a new script action.
+ [/p]
+ [p]
+ Each action has an unique <name> that must not collide with any core action
+ (i.e. don't use the "kvirc." prefix).
+ At any time you can check [cmd]action.list[/cmd] to verify that no core action
+ is already using your <name>. If the <name> was already used for a script action
+ then this action is simply replaced by the new one.
+ [/p]
+ [p]
+ Each action has an associated <visible label> that is the name meant to be presented to the user,
+ possibly even translated. This label will appear on the toolbar buttons, in the tooltips and
+ in the popup menu items. The string will be evaluated just before the actions is displayed
+ so the eventual runtime translation will fetch from the correct language catalogue.
+ [/p]
+ [p]
+ <description> is the descriptive text that will be displayed in the action choice dialog
+ (and maybe in other places).
+ The string will be evaluated just before the actions is displayed
+ so the eventual runtime translation will fetch from the correct language catalogue.
+ [/p]
+ [p]
+ <big_icon_id> is the [doc:image_id]image identifier[/doc] of the icon that will
+ appear on the toolbar buttons and in the action choice dialog.
+ [/p]
+ [p]
+ <small_icon_id> is optional and is the [doc:image_id]image identifier[/doc] of the icon
+ that will appear in the menu items. Since menu items can be also iconless then
+ this parameter is optional.
+ [/p]
+ [p]
+ <action body> is the callback code snippet that will be triggered when this action is activated
+ either by the means of [cmd]action.trigger[/cmd], a toolbar button or a menu item selection.
+ An empty <action body> causes this command to behave like [cmd]action.destoy[/cmd] <name>.
+ [/p]
+ @seealso:
+ [cmd]action.destroy[/cmd], [cmd]action.trigger[/cmd]
+ @examples:
+ [example]
+
+ [/example]
+*/
+
+static bool action_kvs_cmd_create(KviKvsModuleCallbackCommandCall * c)
+{
+ QString szName,szVisibleText,szDescription,szBigIconId,szSmallIconId;
+
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETER_IGNORED("visible_label")
+ KVSM_PARAMETER_IGNORED("description")
+ KVSM_PARAMETER("big_icon_id",KVS_PT_NONEMPTYSTRING,0,szBigIconId)
+ KVSM_PARAMETER("small_icon_id",KVS_PT_STRING,KVS_PF_OPTIONAL,szSmallIconId)
+ KVSM_PARAMETERS_END(c)
+
+ if(!(c->getParameterCode(1,szVisibleText) && c->getParameterCode(2,szDescription)))
+ {
+ c->error(__tr2qs("Internal error: call a head-shrinker"));
+ return false;
+ }
+
+ QString szCategory,szWindows,szKeySequence;
+
+ int iFlags = 0;
+
+ if(c->switches()->find('i',"bind-to-context"))iFlags |= KviAction::NeedsContext;
+ if(c->switches()->find('c',"bind-to-connection"))iFlags |= KviAction::NeedsConnection | KviAction::NeedsContext;
+ if(c->switches()->find('l',"enable-at-login"))
+ {
+ if(iFlags & KviAction::NeedsConnection)
+ iFlags |= KviAction::EnableAtLogin;
+ else
+ c->warning(__tr2qs("The switch -l requires -c"));
+ }
+ c->switches()->getAsStringIfExisting('t',"category",szCategory);
+ if(szCategory.isEmpty())szCategory = "generic";
+ c->switches()->getAsStringIfExisting('w',"window-types",szWindows);
+ if(!szWindows.isEmpty())
+ {
+ if(szWindows.find('c') != -1)iFlags |= KviAction::WindowChannel;
+ if(szWindows.find('x') != -1)iFlags |= KviAction::WindowConsole;
+ if(szWindows.find('d') != -1)iFlags |= KviAction::WindowDccChat;
+ if(szWindows.find('q') != -1)iFlags |= KviAction::WindowQuery;
+ }
+ if(c->switches()->find('s',"enable-on-selected"))
+ {
+ if(iFlags & (KviAction::WindowChannel | KviAction::WindowConsole | KviAction::WindowQuery))
+ iFlags |= KviAction::WindowOnlyIfUsersSelected;
+ else
+ c->warning(__tr2qs("The switch -s requires -w with a combination of flags 'c','x' and 'q'"));
+ }
+ c->switches()->getAsStringIfExisting('k',"key-sequence",szKeySequence);
+
+
+ KviAction * old = KviActionManager::instance()->getAction(szName);
+ if(old)
+ {
+ if(old->isKviUserActionNeverOverrideThis())
+ old->suicide();
+ else {
+ c->warning(__tr2qs("The action \"%1\" is already defined as core action and cannot be overridden").arg(szName));
+ return false;
+ }
+ }
+
+ QString szCmd = c->callback()->code();
+
+ if(szCmd.isEmpty())
+ {
+ // just killed it :)
+ return true;
+ }
+
+ int iOldFlags = iFlags;
+ iFlags = KviAction::validateFlags(iFlags);
+ if(iFlags != iOldFlags)
+ debug("action.validate has provided invalid flags: %d fixed to %d",iOldFlags,iFlags);
+
+ KviKvsUserAction * a = KviKvsUserAction::createInstance(KviActionManager::instance(),
+ szName,szCmd,szVisibleText,
+ szDescription,szCategory,szBigIconId,
+ szSmallIconId,iFlags,szKeySequence);
+
+ KviActionManager::instance()->registerAction(a);
+
+ return true;
+}
+
+/*
+ @doc: action.exists
+ @type:
+ function
+ @title:
+ $action.exists
+ @short:
+ Checks if an action is currently defined
+ @syntax:
+ <boolean> $action.exists(<name:string>)
+ @description:
+ Returns 1 if the action with the specified <name> is currently defined
+ and 0 otherwise.
+*/
+
+static bool action_kvs_fnc_exists(KviKvsModuleFunctionCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("action_name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+ c->returnValue()->setBoolean(KviActionManager::instance()->getAction(szName) ? true : false);
+ return true;
+}
+
+/*
+ @doc: action.isEnabled
+ @type:
+ function
+ @title:
+ $action.isEnabled
+ @short:
+ Checks if an action is currently enabled.
+ @syntax:
+ <boolean> $action.isEnabled(<name:string>)
+ @description:
+ Returns 1 if the action with the specified <name> is currently enabled
+ and 0 otherwise. If the action does not exist the function returns 0.
+*/
+
+static bool action_kvs_fnc_isEnabled(KviKvsModuleFunctionCall * c)
+{
+ QString szName;
+ KVSM_PARAMETERS_BEGIN(c)
+ KVSM_PARAMETER("action_name",KVS_PT_NONEMPTYSTRING,0,szName)
+ KVSM_PARAMETERS_END(c)
+ KviAction * a = KviActionManager::instance()->getAction(szName);
+ if(a)
+ c->returnValue()->setBoolean(a->isEnabled());
+ else
+ c->returnValue()->setBoolean(false);
+ return true;
+}
+
+
+static bool action_module_init(KviModule *m)
+{
+ // setlabel , $label , $position , move , $itempos , $itemexists , $itemtype
+ KVSM_REGISTER_SIMPLE_COMMAND(m,"list",action_kvs_cmd_list);
+ KVSM_REGISTER_SIMPLE_COMMAND(m,"trigger",action_kvs_cmd_trigger);
+ KVSM_REGISTER_SIMPLE_COMMAND(m,"enable",action_kvs_cmd_enable);
+ KVSM_REGISTER_SIMPLE_COMMAND(m,"disable",action_kvs_cmd_disable);
+ KVSM_REGISTER_SIMPLE_COMMAND(m,"destroy",action_kvs_cmd_destroy);
+
+ KVSM_REGISTER_CALLBACK_COMMAND(m,"create",action_kvs_cmd_create);
+
+ KVSM_REGISTER_FUNCTION(m,"exists",action_kvs_fnc_exists);
+ KVSM_REGISTER_FUNCTION(m,"isEnabled",action_kvs_fnc_isEnabled);
+ return true;
+}
+
+static bool action_module_cleanup(KviModule *m)
+{
+ return true;
+}
+
+KVIRC_MODULE(
+ "action", // module name
+ "1.0.0", // module version
+ "Copyright (C) 2004 Szymon Stefanek (pragma at kvirc dot net)", // author & (C)
+ "Interface to the system actions",
+ action_module_init,
+ 0,
+ 0,
+ action_module_cleanup
+)