--- freem/doc/freem.texi 2025/05/17 17:00:05 1.57 +++ freem/doc/freem.texi 2025/05/19 13:14:35 1.62 @@ -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 @@ -49,6 +49,7 @@ This is the official manual for the Free * The FreeM Environment Daemon:: Managing shared resources in the FreeM environment. * The FreeM Direct-Mode Environment:: Executing M programs interactively. * Debugging:: The program development cycle of FreeM. +* Program Development Cycle:: How to create, edit, test, and run FreeM programs. * Directives:: Per-Routine Language Directives. * Intrinsic Special Variables:: Intrinsic Special Variables. @@ -429,7 +430,7 @@ If the daemon is started with @option{-- The @option{--environment} option will start the daemon for the specified @emph{environment-name}. The default environment, if unspecified, is called @code{DEFAULT}. If using an environment other than @code{DEFAULT}, interpreter processes that wish to also connect to the same environment must also use the @option{--environment} option when starting, and @code{libfreem} clients must also pass the environment name as the first argument to the @code{freem_init()} function. Environments allow you to run multiple, isolated instances of FreeM on the same machine, whose globals and routines are distinct and unique. -The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 4194304 bytes. Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size. +The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 16,777,216 bytes (16 megabytes). Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size. Attempting to start a FreeM interpreter process without a daemon running with the same environment name will result in an error. @@ -444,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 @@ -606,7 +607,7 @@ FreeM includes an interactive debugger, If you would like to enter the debugger automatically each time an error is encountered, add the following to your @code{LCLINIT} routine: @example -S $ETR="B ""DEBUG""" +S $ETRAP="B ""DEBUG""" @end example @section Debugging Commands @@ -633,6 +634,12 @@ Halts the process being debugged and ret With no arguments, toggles watchpoints on and off. With @code{+}, adds @emph{} to the watchlist. With @code{-}, removes @emph{} from the watchlist. With @code{?}, queries the watch status of @emph{}. @end table +@node Program Development Cycle +@chapter Program Development Cycle +@cindex program development + +This chapter covers the essential activities of program development in the FreeM environment, including viewing, creating, editing, and running routines. + @node Directives @chapter Directives @cindex directives @@ -2099,6 +2106,7 @@ Identical to @ref{$TRANSLATE()}, except * ZASSERT:: Raise error when a conditional expression evaluates @emph{false}. * ZBREAK:: Enable/disable ZBREAK mode. * ZCONST:: Define a constant that cannot be altered after initial definition. +* ZEDIT:: Edit a routine using an external editor. * ZGOTO:: @code{GOTO} with @code{BREAK} control. * ZHALT:: Exit FreeM job with return value. * ZINSERT:: Insert code into routine buffer. @@ -2652,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 @@ -2687,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 @@ -3442,6 +3450,37 @@ Constants must only be locals, and globa @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}} @end example +@node ZEDIT +@section ZEDIT +@cindex ZEDIT +@cindex commands, ZEDIT +@cindex commands, non-standard +@emph{FreeM Extension} + +Edits a routine using an external editor. Uses environment variable @code{$EDITOR} if defined; otherwise, uses @code{vi}. + +@emph{Syntax} + +@example +ZEDIT@emph{[:postcondition]} +@end example + +In its argumentless form, edits the currently-active routine, provided the optional @emph{postcondition} is @emph{true} or omitted. + +@emph{Syntax} + +@example +ZEDIT@emph{[:postcondition]} @emph{} +@end example + +In its single-argument form, edits @emph{}, provided the optional @emph{postcondition} is @emph{true} or omitted. + +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. + @node ZGOTO @section ZGOTO @cindex ZGOTO @@ -3450,7 +3489,7 @@ Constants must only be locals, and globa @cindex commands, non-standard @emph{FreeM Extension} -In its argumented form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}. +In its single-argument form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}. @emph{Syntax} @@ -3458,7 +3497,7 @@ In its argumented form, enables @code{BR ZGOTO @emph{entryref} @end example -In its argumented form, resumes execution after a @code{BREAK}. +In its argumentless form, resumes execution after a @code{BREAK}. @emph{Syntax} @@ -3498,6 +3537,16 @@ ZHALT @cindex commands, non-standard @emph{FreeM Extension} +Inserts a line of M code into the currently-active routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. + +@emph{Syntax} + +@example +ZINSERT@emph{:postcondition} @emph{expr V mcode}[:@emph{label}] +@end example + +Above, @emph{expr V mcode} is an expression returning a string giving M code. If @emph{label} is omitted, the code will be inserted at the insertion point, which is typically the end of the routine. Otherwise, the code will be inserted at the line immediately following @emph{label}. + @node ZJOB @section ZJOB @cindex ZJOB @@ -3558,7 +3607,7 @@ ZMAP[@emph{:postcondition}] GLOBAL @emph @cindex commands, non-standard @emph{FreeM Extension} -Prints the contents of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. +In argumentless form, prints the contents of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. @emph{Syntax} @@ -3566,6 +3615,16 @@ Prints the contents of the current routi ZPRINT@emph{:postcondition} @end example +In argumented form, prints a subset of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. + +@emph{Syntax} + +@example +ZPRINT@emph{:postcondition} @emph{start}[:@emph{end}] +@end example + +In the above syntax, @emph{start} and @emph{end} can be a tag in the current routine, or @code{*} to indicate the routine buffer insertion point (typically the end of the routine). + @node ZQUIT @section ZQUIT @cindex ZQUIT @@ -3592,6 +3651,24 @@ In its argumentless form, quits from @co @cindex commands, non-standard @emph{FreeM Extension} +In argumentless form, removes all M code from the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. + +@emph{Syntax} + +@example +ZREMOVE@emph{:postcondition} +@end example + +In argumented form, removes a subset of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted. + +@emph{Syntax} + +@example +ZREMOVE@emph{:postcondition} @emph{start}[:@emph{end}] +@end example + +In the above syntax, @emph{start} and @emph{end} can be a tag in the current routine, or @code{*} to indicate the routine buffer insertion point (typically the end of the routine). + @node ZSAVE @section ZSAVE @cindex ZSAVE