[Teem-commit] SF.net SVN: teem:[7074] teem/trunk/src/hest/hest.h

[<kin...@us...>]

Revision: 7074
          http://sourceforge.net/p/teem/code/7074
Author:   kindlmann
Date:     2023-07-11 21:58:01 +0000 (Tue, 11 Jul 2023)
Log Message:
-----------
(a previous commit should have had this message; this commit is just for this information
added to hest.h)

API NEW:
Many many non-var-args alternatives to hestOptAdd, also usefully type-specific for the
type of value to be parsed in a way that hestOptAdd_nva cannot match. These capture all
the common uses (and them some) of hest within Teem. They can be categorized, like
hestOpt->kind, in terms of the min, max number of (type T) parameters to the option:

  min == max == 0       hestOptAdd_Flag         (stand-alone flag; no parameters)
  min == max == 1       hestOptAdd_1_T          single fixed parameter
  min == max >= 2       hestOptAdd_{2,3,4,N}_T  multiple fixed parameters
  min == 0; max == 1    hestOptAdd_1v_T         single variable parameter
  min < max; max >= 2   hestOptAdd_Nv_T         multiple variable parameters

An airEnum* is passed for _Enum options; or a hestCB* for _Other options. The number of
parameters *sawP that hestParm saw on the command-line is passed for the _Nv_ options.

All declarations below were automatically generated via hestOptAddDeclsPrint (followed by
clang-format), which (like the implementation of all the functions) is done via lots of
#define macro tricks.

Modified Paths:
--------------
    teem/trunk/src/hest/hest.h

Modified: teem/trunk/src/hest/hest.h
===================================================================
--- teem/trunk/src/hest/hest.h	2023-07-11 21:36:23 UTC (rev 7073)
+++ teem/trunk/src/hest/hest.h	2023-07-11 21:58:01 UTC (rev 7074)
@@ -288,7 +288,23 @@
 
 /* adders.c */
 HEST_EXPORT void hestOptAddDeclsPrint(FILE *f);
-/* these declarations are from clang-format of hestOptAddDeclsPrint output */
+/* Many many non-var-args alternatives to hestOptAdd, also usefully type-specific for the
+type of value to be parsed in a way that hestOptAdd_nva cannot match. These capture all
+the common uses (and them some) of hest within Teem. They can be categorized, like
+hestOpt->kind, in terms of the min, max number of (type T) parameters to the option:
+
+  min == max == 0       hestOptAdd_Flag         (stand-alone flag; no parameters)
+  min == max == 1       hestOptAdd_1_T          single fixed parameter
+  min == max >= 2       hestOptAdd_{2,3,4,N}_T  multiple fixed parameters
+  min == 0; max == 1    hestOptAdd_1v_T         single variable parameter
+  min < max; max >= 2   hestOptAdd_Nv_T         multiple variable parameters
+
+An airEnum* is passed for _Enum options; or a hestCB* for _Other options. The number of
+parameters *sawP that hestParm saw on the command-line is passed for the _Nv_ options.
+
+All declarations below were automatically generated via hestOptAddDeclsPrint (followed by
+clang-format), which (like the implementation of all the functions) is done via lots of
+#define macro tricks. */
 HEST_EXPORT unsigned int hestOptAdd_Flag(hestOpt **optP, const char *flag, int *valueP,
                                          const char *info);
 HEST_EXPORT unsigned int hestOptAdd_1v_Bool(hestOpt **hoptP, const char *flag,

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.