--- freem/doc/freem.texi 2025/05/05 13:13:39 1.48 +++ freem/doc/freem.texi 2025/05/05 15:46:50 1.52 @@ -1115,7 +1115,7 @@ See @emph{https://wiki.osdev.org/Target_ * $ZLSD():: Compute Levenshtein distance between two arguments. * $ZM():: Unknown. * $ZNAME():: Unknown. -* $ZNEXT():: Unknown. +* $ZNEXT():: Return glvn of next numeric subscript following given glvn. * $ZORDER():: Unknown. * $ZPIECE():: Unknown. * $ZPREVIOUS():: Unknown. @@ -1313,6 +1313,28 @@ The optional second argument indicates t @cindex intrinsic functions, $NEXT Deprecated. Use @code{$ORDER} instead. +Returns the next numeric subscript of the specified glvn. + +@emph{Syntax} + +@example +$NEXT(@emph{glvn}) +@end example + +@emph{Example} + +Assume the following array: + +@example +^foo(1)="" +^foo(2)="" +@end example + +And the following code: + +@example + W $ZNEXT(^foo(1)) ; => 2 +@end example @node $ORDER() @section $ORDER @@ -1713,6 +1735,8 @@ Returns the Levenshtein distance between @cindex intrinsic functions, $ZM @cindex intrinsic functions, implementation-specific +Purpose unknown. + @node $ZNAME() @section $ZNAME @cindex $ZNAME @@ -1721,13 +1745,38 @@ Returns the Levenshtein distance between Purpose unknown. +This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default). + @node $ZNEXT() @section $ZNEXT @cindex $ZNEXT @cindex intrinsic functions, $ZNEXT @cindex intrinsic functions, implementation-specific -Purpose unknown. +Returns a fully-formed variable reference of the next numeric subscript of the specified glvn. + +@emph{Syntax} + +@example +$ZNEXT(@emph{glvn}) +@end example + +@emph{Example} + +Assume the following array: + +@example +^foo(1)="" +^foo(2)="" +@end example + +And the following code: + +@example + W $ZNEXT(^foo(1)) ; => ^foo(2) +@end example + +This function relies on the value of @code{$VIEW(71)} being @code{1} (this is the default). @node $ZORDER() @section $ZORDER @@ -2048,18 +2097,18 @@ Identical to @ref{$TRANSLATE()}, except * ZBREAK:: Enable/disable ZBREAK mode. * ZCONST:: Define a constant that cannot be altered after initial definition. * ZGOTO:: @code{GOTO} with @code{BREAK} control. -* ZHALT:: Unknown. +* ZHALT:: Exit FreeM job with return value. * ZINSERT:: Insert code into routine buffer. -* ZJOB:: Invokes a job, ignoring any timeouts. +* ZJOB:: Invoke job, ignoring any timeouts. * ZLOAD:: Load routine into routine buffer. * ZMAP:: Map a global name to a non-default namespace. * ZNEW:: Unknown. * ZPRINT:: Print contents of routine buffer. -* ZQUIT:: Quits multiple stack levels at once. +* ZQUIT:: Quit multiple stack levels at once. * ZREMOVE:: Remove code from routine buffer. * ZSAVE:: Save routine buffer to disk. * ZTHROW:: Programmatically raise an error condition. -* ZTRAP:: Unknown. +* ZTRAP:: Raise a FreeM error. * ZUNMAP:: Remove a mapping of a global to a non-default namespace. * ZWATCH:: Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables. * ZWITH:: Set prefix for future variable references. @@ -3579,6 +3628,8 @@ Raises an error condition as long as the @cindex commands, non-standard @emph{FreeM Extension} +Synonymous with @ref{ZTHROW}. + @node ZUNMAP @section ZUNMAP @cindex ZUNMAP