--- freem/doc/freem.texi 2025/05/19 12:45:01 1.61 +++ freem/doc/freem.texi 2025/05/20 14:36:06 1.64 @@ -4,7 +4,7 @@ @settitle The FreeM Manual @copying -This manual is for FreeM, (version 0.65.1-rc0), which is a free software implementation of the M programming language. +This manual is for FreeM, (version 0.65.1-rc1), which is a free software implementation of the M programming language. Print-optimized versions of this book are typeset in @emph{Computer Modern} by the author using the @emph{GNU Texinfo} tools. @@ -19,7 +19,7 @@ Permission is granted to copy, distribut @title The FreeM Manual @subtitle @sc{The Official Manual of FreeM} -@subtitle Version 0.65.1-rc0 +@subtitle Version 0.65.1-rc1 @c@vskip 10pt @c@center @image{freem-logo-sm,,,,.png} @author Serena Willis @@ -445,7 +445,7 @@ Attempting to start a FreeM interpreter The FreeM direct-mode environment is the mode entered when FreeM is invoked without the use of @option{-r @emph{}} or @option{--routine=@emph{}}: @example -Coherent Logic Development FreeM version 0.65.1-rc0 (x86_64-pc-linux-gnu) +Coherent Logic Development FreeM version 0.65.1-rc1 (x86_64-pc-linux-gnu) Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC @@ -2660,7 +2660,7 @@ In the above @emph{inclusive} form, @cod @cartouche @quotation @emph{Note} -The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.65.1-rc0, but are planned for a future release. +The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.65.1-rc1, but are planned for a future release. @end quotation @end cartouche @@ -2695,7 +2695,7 @@ In the above @emph{inclusive} form, @cod @cartouche @quotation @emph{Note} -The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.65.1-rc0, but are planned for a future release. +The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.65.1-rc1, but are planned for a future release. @end quotation @end cartouche @@ -3475,11 +3475,13 @@ ZEDIT@emph{[:postcondition]} @emph{}, provided the optional @emph{postcondition} is @emph{true} or omitted. +If the specified routine does not exist, it will be created. + Routine names must not be quoted, and must not included a leading caret (@code{^}). @emph{Errors} -@code{ZEDIT} will raise @code{ZNOPGM} if the routine cannot be found, or there is no routine currently loaded in argumentless form. +@code{ZEDIT} will raise @code{ZNOPGM} in its argumentless form if there is no routine currently loaded. @node ZGOTO @section ZGOTO @@ -4103,11 +4105,61 @@ The following subscripts are supported: @table @asis +@item @code{$IO} +R -U -D +Returns the current value of @code{$IO} for the job. + +@item @code{$PDISPLAY} +R -U -D +Returns the value of @code{$PDISPLAY} for the job. + +@item @code{$PRINCIPAL} +R -U -D +Returns the value of @code{$PRINCIPAL} for the job. + +@item @code{$TLEVEL} +R -U -D +Returns the current transaction level (value of @code{$TLEVEL} for the job. + +@item @code{BREAK_HANDLER} +R +U -D +Contains M code to be executed when the @code{BREAK} command is run. + +@item @code{CHARACTER} +R -U -D +Returns the character set of the job. + +@item @code{CWD} +R +U -D +Returns or sets the current working directory of the job. + +@item @code{EVENT} +R +U +D +The subtree contained under @code{^$JOB($J,"EVENT")} defines asynchronous event handlers for the current job. Please see @emph{Asynchronous Event Handling} for more information. + +@item @code{GLOBAL} +R -U -D +Returns the global environment of the job. + +@item @code{GROUP} +R -U -D +Returns the GID of the group owning the job. + @item @code{GVNDEFAULT} +R +U +D Contains a default expression to be evaluated if a global variable access attempt results in an @code{M7} error. Equivalent to wrapping all global accesses in @code{$GET(@emph{global-name},@emph{string-expr})}. +@item @code{GVNQOVAL} +R +U +D +Contains the data value (if any) at the subscripted global variable reference from the most recent @code{$ORDER} or @code{$QUERY} operation. + +This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional data file scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations. + +@item @code{GVN_CASE_SENSITIVE} +R +U -D +Returns or sets the case sensitivity of global names. If set to @code{0}, global names are case-insensitive. If set to @code{1}, global names are case-sensitive. + +@item @code{GVN_NAME_SUB_LENGTH} +R +U -D +Returns or sets the maximum number of characters of a global name plus all of its subscripts, from 1-255. + +@item @code{GVN_SUB_LENGTH} +R +U -D +Returns or sets the maximum number of characters of a single global subscript, from 1-255. + +@item @code{GVN_UNIQUE_CHARS} +R +U -D +Returns or sets the number of characters of a global name that make it unique, from 1 to 255. + +@item @code{IOPATH} +R +U -D +Returns or sets the @emph{I/O path} to be used by the @code{OPEN} command. + @item @code{LVNDEFAULT} +R +U +D Contains a default expression to be evaluated if a local variable access attempt results in an @code{M6} error. @@ -4118,150 +4170,111 @@ Contains the data value (if any) at the This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional symbol table scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations. -@item @code{GVNQOVAL} +R +U +D -Contains the data value (if any) at the subscripted global variable reference from the most recent @code{$ORDER} or @code{$QUERY} operation. +@item @code{MATH} +R +U -D +Returns or sets the mode in which decimal comparisons and arithmetic calculations are conducted. Valid values are @code{FIXED}, for fixed-point decimals having up to 20,000 digits of precision, as determined by the @code{$ZPRECISION} intrinsic special variable, and @code{IEEE754}, to use IEEE 754 floating-point decimals. When in @code{IEEE754} mode, floating-point numbers support up to 16 digits of numeric precision. -This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional data file scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations. +@code{IEEE754} mode will make mathematical calculations significantly faster, especially when accelerated by a floating-point processor, at the expense of precision and accuracy. -@item @code{ZCOMMANDS} +R +U -D -Contains a space-delimited list of @code{Z}-commands to be treated as intrinsic. Any @code{Z}-command not appearing in this list will be treated as a user-defined command. +@code{FIXED} mode is recommended for financial calculations, or where precision and accuracy are valued over performance. @code{FIXED} is the default mode of FreeM operation. -For instance, if command @code{ZFOO} does @emph{not} appear in this list, FreeM will attempt to run @code{^%ZFOO} as a subroutine when the @code{ZFOO} command is encountered in program code. +Attempting to @code{SET} this node to values other than @code{FIXED} or @code{IEEE754} will set @code{$ECODE} to @code{M29}. -If you remove a command from this list, you may provide your own private M implementation of the command in the manner described above. +@item @code{NAMESPACE} +R +U -D +Returns or sets the name of the job's currently-active namespace. -If an argument is passed to a @code{Z}-command you implement in M, it is made available to your M code in a variable whose name is specified in @code{^$JOB($JOB,"ZCOMMAND_ARGUMENT_NAME")}, which defaults to @code{%}. +@item @code{OPEN} +R -U -D +The @code{^$JOB($JOB,"OPEN",} subscripts list the open I/O channels in the specified job. @item @code{PIPE_GLVN} +R +U -D Contains an M local or global variable to be used as standard input or standard output for the external shell commands run by @code{!<} and @code{!>}. -@item @code{ZCOMMAND_ARGUMENT_NAME} +R +U -D -Returns or sets the variable name in which arguments to user-defined @code{Z}-commands are passed. Defaults to @code{%}. - -@item @code{ZFUNCTIONS} +R +U -D -Contains a space-delimited list of @code{Z} functions to be treated as intrinsic. Any @code{Z} function not appearing in this list will be treated as a user-defined extrinsic function. - -For instance, if function @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function. - -If you remove a function from this list, you may provide your own private M implementation of the function in the manner described above. - -@item @code{ZSVS} +R +U -D -Contains a space-delimited list of @code{Z} special variables to be treated as intrinsic. Any @code{Z} special variable not appearing in this list will be treated as a user-defined extrinsic function taking no arguments. +@item @code{PRIORITY} +R +U -D +Returns or sets the @emph{nice} value of the FreeM job. -For instance, if the special variable @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function. +@item @code{REVSTR} +R +U -D +When set to 1, allows @code{$EXTRACT} to accept negative values. -If you remove a built-in special variable from this list, you may provide your own private M implementation of the special variable in the manner described above. +@item @code{ROUTINE} +R -U -D +Returns the name of the routine currently being executed by the job. -@item @code{BREAK_HANDLER} +R +U -D -Contains M code to be executed when the @code{BREAK} command is run. +@item @code{ROUTINE_BUFFER_AUTO_ADJUST} +R +U -D +Determines whether or not the size of routine buffers will be automatically adjusted at runtime. If set to @code{0}, routine buffers will be fixed to the byte size specified in @code{ROUTINE_BUFFER_SIZE} and may be manually resized using @code{ROUTINE_BUFFER_SIZE}. If set to @code{1}, routine buffers will grow automatically as necessary. +@item @code{ROUTINE_BUFFER_COUNT} +R +U -D +Returns or sets the number of routine buffers that FreeM will store in memory concurrently. Raising this value will increase memory usage, but will also increase performance if your applications call many different routines repeatedly. @item @code{ROUTINE_BUFFER_SIZE} +R +U -D Returns or sets the number of bytes allocated to each routine buffer. If @code{ROUTINE_BUFFER_AUTO_ADJUST} is set to @code{0}, this determines the maximum size of routines that FreeM will execute. -@item @code{ROUTINE_BUFFER_COUNT} +R +U -D -Returns or sets the number of routine buffers that FreeM will store in memory concurrently. Raising this value will increase memory usage, but will also increase performance if your applications call many different routines repeatedly. - -@item @code{ROUTINE_BUFFER_AUTO_ADJUST} +R +U -D -Determines whether or not the size of routine buffers will be automatically adjusted at runtime. If set to @code{0}, routine buffers will be fixed to the byte size specified in @code{ROUTINE_BUFFER_SIZE} and may be manually resized using @code{ROUTINE_BUFFER_SIZE}. If set to @code{1}, routine buffers will grow automatically as necessary. +@item @code{SINGLE_USER} +R +U -D +If set to @code{1}, FreeM will skip all file locking operations on globals. If set to @code{0}, FreeM will enforce file locking on both. -@item @code{SYMBOL_TABLE_SIZE} +R +U -D -Returns or sets the number of bytes allocated to each of the two FreeM symbol tables. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed size of the two symbol tables. +Setting @code{SINGLE_USER} to @code{1} will improve FreeM performance, but you must @emph{ONLY} use this on systems where you are absolutely sure that only one FreeM process will run at any given time, as running multiple instances of FreeM concurrently when any of them are set to @code{SINGLE_USER} mode @emph{will} cause global data corruption. @item @code{SYMBOL_TABLE_AUTO_ADJUST} +R +U -D Determines whether or not the size of the two FreeM symbol tables will be automatically adjusted at runtime. If set to @code{0}, the symbol table will be fixed to the byte size specified in @code{SYMBOL_TABLE_SIZE} and may be manually resized by modifying @code{SYMBOL_TABLE_SIZE}. If set to @code{1}, the two symbol tables will grow automatically as necessary. +@item @code{SYMBOL_TABLE_SIZE} +R +U -D +Returns or sets the number of bytes allocated to each of the two FreeM symbol tables. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed size of the two symbol tables. -@item @code{USER_DEFINED_ISV_TABLE_SIZE} +R +U -D -Returns or sets the number of bytes allocated to the FreeM user-defined intrinsic special variable table. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed byte size of the user-defined intrinsic special variable table. +@item @code{USER} +R -U -D +Returns the UID of the user owning the job. @item @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} +R +U -D Determines whether or not the size of the FreeM user-defined intrinsic special variable table will be automatically adjusted at runtime. If set to @code{0}, the user-defined ISV table will be fixed to the byte size specified in @code{USER_DEFINED_ISV_TABLE_SIZE} and may be manually resized by modifying @code{USER_DEFINED_ISV_TABLE_SIZE}. If set to @code{1}, the user-defined ISV table will grow automatically as necessary. -@item @code{GVN_UNIQUE_CHARS} +R +U -D -Returns or sets the number of characters of a global name that make it unique, from 1 to 255. - -@item @code{GVN_CASE_SENSITIVE} +R +U -D -Returns or sets the case sensitivity of global names. If set to @code{0}, global names are case-insensitive. If set to @code{1}, global names are case-sensitive. - -@item @code{GVN_NAME_SUB_LENGTH} +R +U -D -Returns or sets the maximum number of characters of a global name plus all of its subscripts, from 1-255. - -@item @code{GVN_SUB_LENGTH} +R +U -D -Returns or sets the maximum number of characters of a single global subscript, from 1-255. - -@item @code{SINGLE_USER} +R +U -D -If set to @code{1}, FreeM will skip all file locking operations on globals. If set to @code{0}, FreeM will enforce file locking on both. +@item @code{USER_DEFINED_ISV_TABLE_SIZE} +R +U -D +Returns or sets the number of bytes allocated to the FreeM user-defined intrinsic special variable table. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed byte size of the user-defined intrinsic special variable table. -Setting @code{SINGLE_USER} to @code{1} will improve FreeM performance, but you must @emph{ONLY} use this on systems where you are absolutely sure that only one FreeM process will run at any given time, as running multiple instances of FreeM concurrently when any of them are set to @code{SINGLE_USER} mode @emph{will} cause global data corruption. +@item @code{USER_ERRORS} +R +U +D -@item @code{CHARACTER} +R -U -D -Returns the character set of the job. +Custom error messages for @code{ZUSERERR} may be set in @code{^$JOB($JOB,"USER_ERRORS",)}, where @code{} represents the custom error code. -@item @code{CWD} +R +U -D -Returns or sets the current working directory of the job. +For example: -@item @code{OPEN} +R -U -D -The @code{^$JOB($JOB,"OPEN",} subscripts list the open I/O channels in the specified job. +@example +DEFAULT.USER> S ^$JOB($JOB,"USER_ERRORS","UBLACKHOLE")="black hole encountered" -@item @code{BERKELEYDB,FLUSH_THRESHOLD} +R +U -D -Returns or sets the number of write operations that will be cached in the BerkeleyDB global handler prior to flushing BerkeleyDB's cache to disk. -@item @code{EVENT} +R +U +D -The subtree contained under @code{^$JOB($J,"EVENT")} defines asynchronous event handlers for the current job. Please see @emph{Asynchronous Event Handling} for more information. +DEFAULT.USER> ZTHROW UBLACKHOLE -@item @code{GLOBAL} +R -U -D -Returns the global environment of the job. -@item @code{IOPATH} +R +U -D -Returns or sets the @emph{I/O path} to be used by the @code{OPEN} command. - -@item @code{PRIORITY} +R +U -D -Returns or sets the @emph{nice} value of the FreeM job. +>> Error UBLACKHOLE: black hole encountered in SYSTEM::^%SYSINIT [$STACK = 0] +>> ZTHROW UBLACKHOLE + ^ +@end example -@item @code{REVSTR} +R +U -D -When set to 1, allows @code{$EXTRACT} to accept negative values. +Note that the error code must begin with @code{U}. -@item @code{ROUTINE} +R -U -D -Returns the name of the routine currently being executed by the job. +@item @code{ZCOMMANDS} +R +U -D +Contains a space-delimited list of @code{Z}-commands to be treated as intrinsic. Any @code{Z}-command not appearing in this list will be treated as a user-defined command. -@item @code{SYMTAB} +R +U -D -Returns or sets the current local variable symbol table in use. +For instance, if command @code{ZFOO} does @emph{not} appear in this list, FreeM will attempt to run @code{^%ZFOO} as a subroutine when the @code{ZFOO} command is encountered in program code. -FreeM supports two unique and independent symbol tables, allowing FreeM programs to maintain two independent sets of identically- or differently-named local variables per process. +If you remove a command from this list, you may provide your own private M implementation of the command in the manner described above. -The default symbol table is @code{0}, and the alternate symbol table is @code{1}, corresponding to the valid values for @code{^$JOB($JOB,"SYMTAB")}. +If an argument is passed to a @code{Z}-command you implement in M, it is made available to your M code in a variable whose name is specified in @code{^$JOB($JOB,"ZCOMMAND_ARGUMENT_NAME")}, which defaults to @code{%}. -Setting this subscript to values other than @code{0} or @code{1} will result in a @code{ZINVEXPR} error. +@item @code{ZCOMMAND_ARGUMENT_NAME} +R +U -D +Returns or sets the variable name in which arguments to user-defined @code{Z}-commands are passed. Defaults to @code{%}. -@item @code{$PDISPLAY} +R -U -D -Returns the value of @code{$PDISPLAY} for the job. +@item @code{ZFUNCTIONS} +R +U -D +Contains a space-delimited list of @code{Z} functions to be treated as intrinsic. Any @code{Z} function not appearing in this list will be treated as a user-defined extrinsic function. -@item @code{$PRINCIPAL} +R -U -D -Returns the value of @code{$PRINCIPAL} for the job. +For instance, if function @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function. -@item @code{$TLEVEL} +R -U -D -Returns the current transaction level (value of @code{$TLEVEL} for the job. +If you remove a function from this list, you may provide your own private M implementation of the function in the manner described above. -@item @code{$IO} +R -U -D -Returns the current value of @code{$IO} for the job. +@item @code{ZSVS} +R +U -D +Contains a space-delimited list of @code{Z} special variables to be treated as intrinsic. Any @code{Z} special variable not appearing in this list will be treated as a user-defined extrinsic function taking no arguments. -@item @code{USER} +R -U -D -Returns the UID of the user owning the job. +For instance, if the special variable @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function. -@item @code{GROUP} +R -U -D -Returns the GID of the group owning the job. +If you remove a built-in special variable from this list, you may provide your own private M implementation of the special variable in the manner described above. -@item @code{NAMESPACE} +R +U -D -Returns or sets the name of the job's currently-active namespace. -@item @code{MATH} +R +U -D -Returns or sets the mode in which decimal comparisons and arithmetic calculations are conducted. Valid values are @code{FIXED}, for fixed-point decimals having up to 20,000 digits of precision, as determined by the @code{$ZPRECISION} intrinsic special variable, and @code{IEEE754}, to use IEEE 754 floating-point decimals. When in @code{IEEE754} mode, floating-point numbers support up to 16 digits of numeric precision. -@code{IEEE754} mode will make mathematical calculations significantly faster, especially when accelerated by a floating-point processor, at the expense of precision and accuracy. -@code{FIXED} mode is recommended for financial calculations, or where precision and accuracy are valued over performance. @code{FIXED} is the default mode of FreeM operation. -Attempting to @code{SET} this node to values other than @code{FIXED} or @code{IEEE754} will set @code{$ECODE} to @code{M29}. @end table @@ -5858,7 +5871,7 @@ Raised when attempts are made to set @co Raised when an @code{ZASSERT} expression's result is not true. @item @code{ZUSERERR} - @emph{user-defined error} -Raised when program code calls @code{THROW} with an error code argument for which the first character is @code{U}, or when @code{$ECODE} is set to an error code for which the first character is @code{U}. +Raised when program code calls @code{ZTHROW} with an error code argument for which the first character is @code{U}, or when @code{$ECODE} is set to an error code for which the first character is @code{U}. Custom error messages for @code{ZUSERERR} may be set in @code{^$JOB($JOB,"USER_ERRORS",)}, where @code{} represents the custom error code. @@ -5868,11 +5881,11 @@ For example: DEFAULT.USER> S ^$JOB($JOB,"USER_ERRORS","UBLACKHOLE")="black hole encountered" -DEFAULT.USER> THROW UBLACKHOLE +DEFAULT.USER> ZTHROW UBLACKHOLE >> Error UBLACKHOLE: black hole encountered in SYSTEM::^%SYSINIT [$STACK = 0] ->> THROW UBLACKHOLE +>> ZTHROW UBLACKHOLE ^ @end example