zsh-workers
 help / color / mirror / code / Atom feed
* [PATCH] Update PARAMDEF in zsh-development-guide
@ 2023-02-01  1:16 Bart Schaefer
  0 siblings, 0 replies; only message in thread
From: Bart Schaefer @ 2023-02-01  1:16 UTC (permalink / raw)
  To: Zsh hackers list

[-- Attachment #1: Type: text/plain, Size: 136 bytes --]

Noticed while noodling with a new module that the description of the
PARAMDEF macro predated the introduction of the "gsu" union.  Wow.

[-- Attachment #2: zdevg.txt --]
[-- Type: text/plain, Size: 1741 bytes --]

diff --git a/Etc/zsh-development-guide b/Etc/zsh-development-guide
index 565b0b1d9..da6932003 100644
--- a/Etc/zsh-development-guide
+++ b/Etc/zsh-development-guide
@@ -612,7 +612,7 @@ For defining parameters, a module can call `createparam()' directly or
 use a table to describe them, e.g.:
 
   static struct paramdef patab[] = {
-    PARAMDEF("foo", PM_INTEGER, NULL, get_foo, set_foo, unset_foo),
+    PARAMDEF("foo", PM_INTEGER, NULL, foo_gsu),
     INTPARAMDEF("exint", &intparam),
     STRPARAMDEF("exstr", &strparam),
     ARRPARAMDEF("exarr", &arrparam),
@@ -626,9 +626,9 @@ There are four macros used:
       in zsh.h)
     - optionally a pointer to a variable holding the value of the
       parameter
-    - three functions that will be used to get the value of the
-      parameter, store a value in the parameter, and unset the
-      parameter
+    - a GSU pointer to the three functions that will be used to get
+      the value of the parameter, store a value in the parameter,
+      and unset the parameter
   - the other macros provide simple ways to define the most common
     types of parameters; they get the name of the parameter and a
     pointer to a variable holding the value as arguments; they are
@@ -636,6 +636,9 @@ There are four macros used:
     variables whose addresses are given should be of type `long',
     `char *', and `char **', respectively
 
+GSU (get, set, unset) structures are defined in Src/zsh.h for each of
+the parameter types scalar, integer, float, array, and hash.
+
 For a description of how to write functions for getting or setting the 
 value of parameters, or how to write a function to unset a parameter,
 see the description of the following functions in the `params.c' file:

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2023-02-01  1:16 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-02-01  1:16 [PATCH] Update PARAMDEF in zsh-development-guide Bart Schaefer

Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).