fergalmoran/picard
1
0
Fork 0
mirror of https://github.com/fergalmoran/picard.git synced 2025-12-26 11:18:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2497 from phw/missing-function-tooltip

Browse Source 
PICARD-2912: Show a tooltip for missing functions in script editor
This commit is contained in:
Laurent Monin
2024-05-26 16:31:56 +02:00
committed by GitHub
parent 27a6caac1d f95ac57379
commit 1676cf1dba
2 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
picard/script/__init__.py
View File

@@ -4,7 +4,7 @@
# #
# Copyright (C) 2006-2009, 2012 Lukáš Lalinský # Copyright (C) 2006-2009, 2012 Lukáš Lalinský
# Copyright (C) 2007 Javier Kohen # Copyright (C) 2007 Javier Kohen
# Copyright (C) 2008-2011, 2014-2015, 2018-2021, 2023 Philipp Wolfer # Copyright (C) 2008-2011, 2014-2015, 2018-2021, 2023-2024 Philipp Wolfer
# Copyright (C) 2009 Carlin Mangar # Copyright (C) 2009 Carlin Mangar
# Copyright (C) 2009 Nikolai Prokoschenko # Copyright (C) 2009 Nikolai Prokoschenko
# Copyright (C) 2011-2012 Michael Wiencek # Copyright (C) 2011-2012 Michael Wiencek
@@ -70,18 +70,26 @@ class ScriptFunctionDocError(Exception):
pass pass
class ScriptFunctionDocUnknownFunctionError(ScriptFunctionDocError):
pass
class ScriptFunctionDocNoDocumentationError(ScriptFunctionDocError):
pass
def script_function_documentation(name, fmt, functions=None, postprocessor=None): def script_function_documentation(name, fmt, functions=None, postprocessor=None):
if functions is None: if functions is None:
functions = dict(script_functions.ext_point_script_functions) functions = dict(script_functions.ext_point_script_functions)
if name not in functions: if name not in functions:
raise ScriptFunctionDocError("no such function: %s (known functions: %r)" % (name, [name for name in functions])) raise ScriptFunctionDocUnknownFunctionError("no such function: %s (known functions: %r)" % (name, [name for name in functions]))
if fmt == 'html': if fmt == 'html':
return functions[name].htmldoc(postprocessor) return functions[name].htmldoc(postprocessor)
elif fmt == 'markdown': elif fmt == 'markdown':
return functions[name].markdowndoc(postprocessor) return functions[name].markdowndoc(postprocessor)
else: else:
raise ScriptFunctionDocError("no such documentation format: %s (known formats: html, markdown)" % fmt) raise ScriptFunctionDocNoDocumentationError("no such documentation format: %s (known formats: html, markdown)" % fmt)
def script_function_names(functions=None): def script_function_names(functions=None):

9
picard/ui/widgets/scripttextedit.py
View File

@@ -4,7 +4,7 @@
# #
# Copyright (C) 2006-2007, 2009 Lukáš Lalinský # Copyright (C) 2006-2007, 2009 Lukáš Lalinský
# Copyright (C) 2014 m42i # Copyright (C) 2014 m42i
# Copyright (C) 2020-2023 Philipp Wolfer # Copyright (C) 2020-2024 Philipp Wolfer
# Copyright (C) 2020-2024 Laurent Monin # Copyright (C) 2020-2024 Laurent Monin
# Copyright (C) 2021-2022 Bob Swift # Copyright (C) 2021-2022 Bob Swift
# #
@@ -48,6 +48,7 @@ from picard.const.sys import IS_MACOS
from picard.i18n import gettext as _ from picard.i18n import gettext as _
from picard.script import ( from picard.script import (
ScriptFunctionDocError, ScriptFunctionDocError,
ScriptFunctionDocUnknownFunctionError,
script_function_documentation, script_function_documentation,
script_function_names, script_function_names,
) )
@@ -279,6 +280,12 @@ class FunctionScriptToken(DocumentedScriptToken):
function = self._read_allowed_chars(position + 1) function = self._read_allowed_chars(position + 1)
try: try:
return script_function_documentation(function, 'html') return script_function_documentation(function, 'html')
except ScriptFunctionDocUnknownFunctionError:
return _(
'<em>Function <code>$%s</code> does not exist.<br>'
'<br>'
'Are you missing a plugin?'
'</em>') % function
except ScriptFunctionDocError: except ScriptFunctionDocError:
return None return None