diff options
author | Trygve Aaberge <trygveaa@gmail.com> | 2022-10-22 15:27:06 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2022-12-11 15:13:31 +0100 |
commit | ebc63d1b8303a479c9ed347c1152448984fffa67 (patch) | |
tree | 0f881dd620a7100d460f795f2644365f231b9b62 /doc/it | |
parent | 1bfc8b9cf8771c1f979f20baffa20c1fe7671726 (diff) | |
download | weechat-ebc63d1b8303a479c9ed347c1152448984fffa67.zip |
scripts: Send null values to config section callbacks
The callback_read and callback_create_option functions in the scripting
APIs always get the value as a string, never as null. This means that if
the value is null, there is no way for the script to distinguish this
from an empty string for string options. This makes it impossible to
properly make options with fallback values, like the irc server and
server_default options, as far as I can see.
All the scripting languages except Tcl use that language's equivalent
for null. For JavaScript which has both null and undefined, null is
used. For Tcl, the magic null string defined in commit 197a7a01e is used
and the documentation is updated to describe that.
I tested this with these scripts:
https://gist.github.com/trygveaa/2d49c609addf9773d2ed16e15d1e3447
You can load all of those scripts and see the result with this command
(assuming you have the scripts in the current directory):
weechat -t -r "/filter add script * * script; /script load $(echo script_config.*)"
Diffstat (limited to 'doc/it')
-rw-r--r-- | doc/it/weechat_plugin_api.it.adoc | 4 | ||||
-rw-r--r-- | doc/it/weechat_scripting.it.adoc | 13 |
2 files changed, 14 insertions, 3 deletions
diff --git a/doc/it/weechat_plugin_api.it.adoc b/doc/it/weechat_plugin_api.it.adoc index 29cfe044f..52bc4cc66 100644 --- a/doc/it/weechat_plugin_api.it.adoc +++ b/doc/it/weechat_plugin_api.it.adoc @@ -6691,7 +6691,7 @@ def config_new_section(config_file: str, name: str, callback_delete_option: str, callback_delete_option_data: str) -> str: ... # esempio -def my_section_read_cb(data: str, config_file: str, section: str, option_name: str, value: str) -> int: +def my_section_read_cb(data: str, config_file: str, section: str, option_name: str, value: str | None) -> int: # ... return weechat.WEECHAT_CONFIG_OPTION_SET_OK_CHANGED # return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE @@ -6706,7 +6706,7 @@ def my_section_write_default_cb(data: str, config_file: str, section_name: str) # ... return weechat.WEECHAT_CONFIG_WRITE_OK -def my_section_create_option_cb(data: str, config_file: str, section: str, option_name: str, value: str) -> int: +def my_section_create_option_cb(data: str, config_file: str, section: str, option_name: str, value: str | None) -> int: # ... return weechat.WEECHAT_CONFIG_OPTION_SET_OK_SAME_VALUE diff --git a/doc/it/weechat_scripting.it.adoc b/doc/it/weechat_scripting.it.adoc index c31bffdf6..95e703e9d 100644 --- a/doc/it/weechat_scripting.it.adoc +++ b/doc/it/weechat_scripting.it.adoc @@ -210,12 +210,23 @@ Functions are called with `+weechat.xxx(arg1, arg2, ...)+`. Functions are called with `+weechat::xxx arg1 arg2 ...+`. +// TRANSLATION MISSING +[[tcl_null]] +===== Null values + Since Tcl only has string types, there's no null type to pass as an argument -when a function accepts null values. To overcome this you can use the constant +when a function accepts null values or to get as an argument in a callback +function. To overcome this the WeeChat API defines the constant `$::weechat::WEECHAT_NULL` which acts as a null value. This constant is defined as `\uFFFF\uFFFF\uFFFFWEECHAT_NULL\uFFFF\uFFFF\uFFFF`, so it's very unlikely to appear unintentionally. +You can pass this constant when a function accepts null as an argument and you +will get it as the value of an argument in a callback function if the argument +value is null. To see which functions accept null values and passes null values +to callbacks, look at the Python prototypes in the +link:weechat_plugin_api.en.html[WeeChat plugin API reference ^↗^,window=_blank]. + [[language_guile]] ==== Guile (Scheme) |