From 312476bbedbc9b9407f4dc84826e2167bf69d025 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Thu, 27 Mar 2025 23:23:01 -0400 Subject: [PATCH] A simple test plugin added for testing. --- configure.ac | 2 +- src/cthulhu/cthulhuVersion.py | 2 +- src/cthulhu/plugin_system_manager.py | 2 +- .../plugins/HelloWorld/HelloWorld.plugin | 6 -- src/cthulhu/plugins/HelloWorld/HelloWorld.py | 49 ------------ src/cthulhu/plugins/HelloWorld/Makefile.am | 7 -- src/cthulhu/plugins/Makefile.am | 2 +- src/cthulhu/plugins/hello_world/Makefile.am | 6 ++ .../{HelloWorld => hello_world}/__init__.py | 0 src/cthulhu/plugins/hello_world/plugin.info | 8 ++ src/cthulhu/plugins/hello_world/plugin.py | 80 +++++++++++++++++++ src/cthulhu/settings.py | 2 +- 12 files changed, 99 insertions(+), 67 deletions(-) delete mode 100644 src/cthulhu/plugins/HelloWorld/HelloWorld.plugin delete mode 100644 src/cthulhu/plugins/HelloWorld/HelloWorld.py delete mode 100644 src/cthulhu/plugins/HelloWorld/Makefile.am create mode 100644 src/cthulhu/plugins/hello_world/Makefile.am rename src/cthulhu/plugins/{HelloWorld => hello_world}/__init__.py (100%) create mode 100644 src/cthulhu/plugins/hello_world/plugin.info create mode 100644 src/cthulhu/plugins/hello_world/plugin.py diff --git a/configure.ac b/configure.ac index c3c26e5..8b4de16 100644 --- a/configure.ac +++ b/configure.ac @@ -129,7 +129,7 @@ src/cthulhu/plugins/HelloCthulhu/Makefile src/cthulhu/plugins/PluginManager/Makefile src/cthulhu/plugins/Clipboard/Makefile src/cthulhu/plugins/DisplayVersion/Makefile -src/cthulhu/plugins/HelloWorld/Makefile +src/cthulhu/plugins/hello_world/Makefile src/cthulhu/plugins/CapsLockHack/Makefile src/cthulhu/plugins/self_voice/Makefile src/cthulhu/plugins/Date/Makefile diff --git a/src/cthulhu/cthulhuVersion.py b/src/cthulhu/cthulhuVersion.py index d54e61f..cd499af 100644 --- a/src/cthulhu/cthulhuVersion.py +++ b/src/cthulhu/cthulhuVersion.py @@ -23,5 +23,5 @@ # Fork of Orca Screen Reader (GNOME) # Original source: https://gitlab.gnome.org/GNOME/orca -version = "2025.03.26" +version = "2025.03.27" codeName = "testing" diff --git a/src/cthulhu/plugin_system_manager.py b/src/cthulhu/plugin_system_manager.py index 8fa613e..1a95189 100644 --- a/src/cthulhu/plugin_system_manager.py +++ b/src/cthulhu/plugin_system_manager.py @@ -205,7 +205,7 @@ class PluginInfo: Returns: The plugin settings. """ - return None # To be implemented + return None # To be implemented def is_builtin(self): """Check if the plugin is built-in. diff --git a/src/cthulhu/plugins/HelloWorld/HelloWorld.plugin b/src/cthulhu/plugins/HelloWorld/HelloWorld.plugin deleted file mode 100644 index 949d8b8..0000000 --- a/src/cthulhu/plugins/HelloWorld/HelloWorld.plugin +++ /dev/null @@ -1,6 +0,0 @@ -[Plugin] -Module=HelloWorld -Loader=python3 -Name=Hello World (python3) -Description=Test plugin for cthulhu -Authors=Chrys chrys@linux-a11y.org diff --git a/src/cthulhu/plugins/HelloWorld/HelloWorld.py b/src/cthulhu/plugins/HelloWorld/HelloWorld.py deleted file mode 100644 index 6a2cc57..0000000 --- a/src/cthulhu/plugins/HelloWorld/HelloWorld.py +++ /dev/null @@ -1,49 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (c) 2024 Stormux -# Copyright (c) 2010-2012 The Orca Team -# Copyright (c) 2012 Igalia, S.L. -# Copyright (c) 2005-2010 Sun Microsystems Inc. -# -# 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., Franklin Street, Fifth Floor, -# Boston MA 02110-1301 USA. -# -# Fork of Orca Screen Reader (GNOME) -# Original source: https://gitlab.gnome.org/GNOME/orca - -from cthulhu import plugin - -import gi -gi.require_version('Peas', '1.0') -from gi.repository import GObject -from gi.repository import Peas - -class HelloWorld(GObject.Object, Peas.Activatable, plugin.Plugin): - __gtype_name__ = 'helloworld' - - object = GObject.Property(type=GObject.Object) - def __init__(self): - plugin.Plugin.__init__(self) - def do_activate(self): - API = self.object - self.registerGestureByString(self.speakTest, _('hello world'), 'kb:cthulhu+z') - print('activate hello world plugin') - def do_deactivate(self): - API = self.object - print('deactivate hello world plugin') - def speakTest(self, script=None, inputEvent=None): - API = self.object - API.app.getDynamicApiManager().getAPI('CthulhuState').activeScript.presentMessage('hello world', resetStyles=False) - return True diff --git a/src/cthulhu/plugins/HelloWorld/Makefile.am b/src/cthulhu/plugins/HelloWorld/Makefile.am deleted file mode 100644 index 8793036..0000000 --- a/src/cthulhu/plugins/HelloWorld/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -cthulhu_python_PYTHON = \ - __init__.py \ - HelloWorld.plugin \ - HelloWorld.py - -cthulhu_pythondir=$(pkgpythondir)/plugins/HelloWorld - diff --git a/src/cthulhu/plugins/Makefile.am b/src/cthulhu/plugins/Makefile.am index b955a87..89e438a 100644 --- a/src/cthulhu/plugins/Makefile.am +++ b/src/cthulhu/plugins/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = Clipboard DisplayVersion HelloWorld self_voice Time MouseReview Date ByeCthulhu HelloCthulhu PluginManager CapsLockHack SimplePluginSystem +SUBDIRS = Clipboard DisplayVersion hello_world self_voice Time MouseReview Date ByeCthulhu HelloCthulhu PluginManager CapsLockHack SimplePluginSystem cthulhu_pythondir=$(pkgpythondir)/plugins diff --git a/src/cthulhu/plugins/hello_world/Makefile.am b/src/cthulhu/plugins/hello_world/Makefile.am new file mode 100644 index 0000000..95853eb --- /dev/null +++ b/src/cthulhu/plugins/hello_world/Makefile.am @@ -0,0 +1,6 @@ +cthulhu_python_PYTHON = \ + __init__.py \ + plugin.info \ + plugin.py + +cthulhu_pythondir=$(pkgpythondir)/plugins/hello_world diff --git a/src/cthulhu/plugins/HelloWorld/__init__.py b/src/cthulhu/plugins/hello_world/__init__.py similarity index 100% rename from src/cthulhu/plugins/HelloWorld/__init__.py rename to src/cthulhu/plugins/hello_world/__init__.py diff --git a/src/cthulhu/plugins/hello_world/plugin.info b/src/cthulhu/plugins/hello_world/plugin.info new file mode 100644 index 0000000..50e52cc --- /dev/null +++ b/src/cthulhu/plugins/hello_world/plugin.info @@ -0,0 +1,8 @@ +name = Hello World +version = 1.0.0 +description = Test plugin for Cthulhu +authors = Storm Dragon storm_dragon@stormux.org +website = https://stormux.org +copyright = Copyright 2025 +builtin = false +hidden = false diff --git a/src/cthulhu/plugins/hello_world/plugin.py b/src/cthulhu/plugins/hello_world/plugin.py new file mode 100644 index 0000000..526ead4 --- /dev/null +++ b/src/cthulhu/plugins/hello_world/plugin.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2025 Stormux +# +# 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., Franklin Street, Fifth Floor, +# Boston MA 02110-1301 USA. + +"""Hello World plugin for Cthulhu using pluggy.""" + +import os +import logging + +# Import from cthulhu +from cthulhu.plugin import Plugin, cthulhu_hookimpl + +logger = logging.getLogger(__name__) + +class HelloWorld(Plugin): + """Hello World plugin for Cthulhu.""" + + def __init__(self, *args, **kwargs): + """Initialize the plugin.""" + super().__init__(*args, **kwargs) + print("HelloWorld plugin initialized") + + @cthulhu_hookimpl + def activate(self): + """Activate the plugin.""" + try: + print("Activate Hello World plugin") + + # Register our keyboard shortcut, same as the original (cthulhu+z) + self.registerGestureByString( + self.speakTest, + "hello world", + "kb:cthulhu+z", + learnModeEnabled=True + ) + + return True + except Exception as e: + print(f"Error activating Hello World plugin: {e}") + return False + + @cthulhu_hookimpl + def deactivate(self): + """Deactivate the plugin.""" + try: + print("Deactivate Hello World plugin") + return True + except Exception as e: + print(f"Error deactivating Hello World plugin: {e}") + return False + + def speakTest(self, script=None, inputEvent=None): + """Speak a test message.""" + try: + if self.app: + # Use the same API call as in the original plugin + self.app.getDynamicApiManager().getAPI('CthulhuState').activeScript.presentMessage( + 'hello world', + resetStyles=False + ) + + return True + except Exception as e: + print(f"Error in speakTest: {e}") + return False diff --git a/src/cthulhu/settings.py b/src/cthulhu/settings.py index e2a6c9a..1c05ff9 100644 --- a/src/cthulhu/settings.py +++ b/src/cthulhu/settings.py @@ -413,4 +413,4 @@ presentChatRoomLast = False presentLiveRegionFromInactiveTab = False # Plugins -activePlugins = ['Clipboard', 'DisplayVersion', 'MouseReview', 'Date', 'ByeCthulhu', 'Time', 'HelloCthulhu', 'self_voice', 'PluginManager', 'SimplePluginSystem'] +activePlugins = ['Clipboard', 'DisplayVersion', 'MouseReview', 'Date', 'ByeCthulhu', 'Time', 'HelloCthulhu', 'hello_world', 'self_voice', 'PluginManager', 'SimplePluginSystem']