[BACK]Return to freem.texi CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/freem.texi between versions 1.44 and 1.52

version 1.44, 2025/05/05 05:16:34 version 1.52, 2025/05/05 15:46:50
Line 271  Refers to an M intrinsic special variabl Line 271  Refers to an M intrinsic special variabl
 Indicates a @emph{list} of the following item, e.g., @emph{L gvn} means @emph{list of global variable names}.  Indicates a @emph{list} of the following item, e.g., @emph{L gvn} means @emph{list of global variable names}.
 @item @emph{lvn}  @item @emph{lvn}
 Refers to the name of an M local variable.  Refers to the name of an M local variable.
   @item @emph{postcondition}
   A @emph{tvexpr} immediately following a command verb affecting that command's execution.
 @item @emph{strlit}  @item @emph{strlit}
 Refers to an M string literal.  Refers to an M string literal.
 @item @emph{ssvn}  @item @emph{ssvn}
 Refers to the name of an M structured system variable.  Refers to the name of an M structured system variable.
 @item @emph{tvexpr}  @item @emph{tvexpr}
 Refers to a truth-valued expression.  Refers to a truth-valued expression, i.e., an expression interpreted as a truth value.
 @end table  @end table
   
 @node A Note on Standards  @node A Note on Standards
Line 1113  See @emph{https://wiki.osdev.org/Target_ Line 1115  See @emph{https://wiki.osdev.org/Target_
 * $ZLSD()::                             Compute Levenshtein distance between two arguments.  * $ZLSD()::                             Compute Levenshtein distance between two arguments.
 * $ZM()::                               Unknown.  * $ZM()::                               Unknown.
 * $ZNAME()::                            Unknown.  * $ZNAME()::                            Unknown.
 * $ZNEXT()::                            Unknown.  * $ZNEXT()::                            Return glvn of next numeric subscript following given glvn.
 * $ZORDER()::                           Unknown.  * $ZORDER()::                           Unknown.
 * $ZPIECE()::                           Unknown.  * $ZPIECE()::                           Unknown.
 * $ZPREVIOUS()::                        Unknown.  * $ZPREVIOUS()::                        Unknown.
Line 1311  The optional second argument indicates t Line 1313  The optional second argument indicates t
 @cindex intrinsic functions, $NEXT  @cindex intrinsic functions, $NEXT
   
 Deprecated. Use @code{$ORDER} instead.  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()  @node $ORDER()
 @section $ORDER  @section $ORDER
Line 1711  Returns the Levenshtein distance between Line 1735  Returns the Levenshtein distance between
 @cindex intrinsic functions, $ZM  @cindex intrinsic functions, $ZM
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZNAME()  @node $ZNAME()
 @section $ZNAME  @section $ZNAME
 @cindex $ZNAME  @cindex $ZNAME
Line 1719  Returns the Levenshtein distance between Line 1745  Returns the Levenshtein distance between
   
 Purpose unknown.  Purpose unknown.
   
   This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default).
   
 @node $ZNEXT()  @node $ZNEXT()
 @section $ZNEXT  @section $ZNEXT
 @cindex $ZNEXT  @cindex $ZNEXT
 @cindex intrinsic functions, $ZNEXT  @cindex intrinsic functions, $ZNEXT
 @cindex intrinsic functions, implementation-specific  @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()  @node $ZORDER()
 @section $ZORDER  @section $ZORDER
Line 2011  Identical to @ref{$TRANSLATE()}, except Line 2062  Identical to @ref{$TRANSLATE()}, except
 * !::                                   Run an external program or command.  * !::                                   Run an external program or command.
 * !!::                                  Launch a subshell from FreeM direct mode.  * !!::                                  Launch a subshell from FreeM direct mode.
 * ABLOCK::                              Increment the block counter for one or more event classes.  * ABLOCK::                              Increment the block counter for one or more event classes.
 * ASSERT::                              Raise error when a conditional expression evaluates @emph{false}.  
 * ASTART::                              Enable asynchronous event handling for one or more event classes.  * ASTART::                              Enable asynchronous event handling for one or more event classes.
 * ASTOP::                               Disable asynchronous event handling for one or more event classes.  * ASTOP::                               Disable asynchronous event handling for one or more event classes.
 * AUNBLOCK::                            Decrement the block counter for one or more event classes.  * AUNBLOCK::                            Decrement the block counter for one or more event classes.
Line 2043  Identical to @ref{$TRANSLATE()}, except Line 2093  Identical to @ref{$TRANSLATE()}, except
 * VIEW::                                Modify FreeM internal parameters.  * VIEW::                                Modify FreeM internal parameters.
 * WRITE::                               Write output to current input/output device.  * WRITE::                               Write output to current input/output device.
 * XECUTE::                              Interpret string as M code.  * XECUTE::                              Interpret string as M code.
 * ZBREAK::                              Unknown.  * 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.  * ZCONST::                              Define a constant that cannot be altered after initial definition.
 * ZGO::                                 Unknown.  * ZGOTO::                               @code{GOTO} with @code{BREAK} control.
 * ZHALT::                               Unknown.  * ZHALT::                               Exit FreeM job with return value.
 * ZINSERT::                             Insert code into routine buffer.  * 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.  * ZLOAD::                               Load routine into routine buffer.
 * ZMAP::                                Map a global name to a non-default namespace.  * ZMAP::                                Map a global name to a non-default namespace.
 * ZNEW::                                Unknown.  * ZNEW::                                Unknown.
 * ZPRINT::                              Print contents of routine buffer.  * 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.  * ZREMOVE::                             Remove code from routine buffer.
 * ZSAVE::                               Save routine buffer to disk.  * ZSAVE::                               Save routine buffer to disk.
 * ZTHROW::                              Programmatically raise an error condition.  * 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.  * 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.  * 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.  * ZWITH::                               Set prefix for future variable references.
Line 2182  In its inclusive form, @code{ABLOCK} inc Line 2233  In its inclusive form, @code{ABLOCK} inc
   
 In its exclusive form, @code{ABLOCK} increments the block counters for all event classes @emph{except for} those named in the list, provided the optional @emph{postcondition} is either @emph{true} or omitted.  In its exclusive form, @code{ABLOCK} increments the block counters for all event classes @emph{except for} those named in the list, provided the optional @emph{postcondition} is either @emph{true} or omitted.
   
 @node ASSERT  
 @section ASSERT  
 @cindex ASSERT  
 @cindex commands, ASSERT  
 @cindex commands, debugging  
 @cindex commands, implementation-specific  
 @cindex commands, non-standard  
 @emph{FreeM Extension}  
   
 Triggers error @code{ASSERT} if the supplied truth-valued expression @emph{tvexpr} is @emph{false} (@emph{1} is @emph{true}, and @emph{0} is @emph{false}), and that the optional @emph{postcondition} evaluates to @emph{true} or is omitted.  
   
 The @code{ASSERT} error is catchable whether using standard-style, FreeM-style, or DSM 2.0-style error processing.  
   
 @emph{Syntax}  
   
 @example  
  ASSERT@emph{:postcondition} @emph{<tvexpr>}  
 @end example  
   
 @emph{Example}  
   
 @example  
 DEFAULT.USER> SET DEBUG=1  
   
   
 DEFAULT.USER> ASSERT:DEBUG 1=1  
   
   
 DEFAULT.USER> ASSERT:DEBUG 1=0  
    
    
 >> Error ZASSERT:  programmer assertion failed in SYSTEM::^%SYSINIT  [$STACK = 0]  
 >> ASSERT:DEBUG 1=0  
                    ^  
 @end example  
   
 @node ASTART  @node ASTART
 @section ASTART  @section ASTART
Line 3353  VIEW 133:@emph{tvexpr} Line 3369  VIEW 133:@emph{tvexpr}
 @cindex XECUTE  @cindex XECUTE
 @cindex commands, XECUTE  @cindex commands, XECUTE
   
   @node ZASSERT
   @section ZASSERT
   @cindex ZASSERT
   @cindex commands, ZASSERT
   @cindex commands, debugging
   @cindex commands, implementation-specific
   @cindex commands, non-standard
   @emph{FreeM Extension}
   
   Triggers error @code{ZASSERT} if the supplied truth-valued expression @emph{tvexpr} is @emph{false} (@emph{1} is @emph{true}, and @emph{0} is @emph{false}), and that the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
   
   The @code{ZASSERT} error is catchable whether using standard-style, FreeM-style, or DSM 2.0-style error processing.
   
   @emph{Syntax}
   
   @example
    ZASSERT@emph{:postcondition} @emph{<tvexpr>}
   @end example
   
   @emph{Example}
   
   @example
   DEFAULT.USER> SET DEBUG=1
   
   
   DEFAULT.USER> ZASSERT:DEBUG 1=1
   
   
   DEFAULT.USER> ZASSERT:DEBUG 1=0
    
    
   >> Error ZASSERT:  programmer assertion failed in SYSTEM::^%SYSINIT  [$STACK = 0]
   >> ZASSERT:DEBUG 1=0
                      ^
   @end example
   
 @node ZBREAK  @node ZBREAK
 @section ZBREAK  @section ZBREAK
 @cindex ZBREAK  @cindex ZBREAK
Line 3362  VIEW 133:@emph{tvexpr} Line 3414  VIEW 133:@emph{tvexpr}
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   Sets or clears the @code{ZBREAK} flag@footnote{NOTE: FreeM team needs to investigate how @code{zbreakon} and @code{zbflag} affect program execution.}, based on the result of evaluating @emph{tvexpr}.
   
   @emph{Syntax}
   
   @example
   ZBREAK @emph{tvexpr}
   @end example
   
 @node ZCONST  @node ZCONST
 @section ZCONST  @section ZCONST
 @cindex ZCONST  @cindex ZCONST
Line 3379  Constants must only be locals, and globa Line 3439  Constants must only be locals, and globa
 @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}  @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}
 @end example  @end example
   
 @node ZGO  @node ZGOTO
 @section ZGO  @section ZGOTO
 @cindex ZGO  @cindex ZGOTO
 @cindex commands, ZGO  @cindex commands, ZGOTO
 @cindex commands, implementation-specific  @cindex commands, implementation-specific
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   In its argumented form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}.
   
   @emph{Syntax}
   
   @example
   ZGOTO @emph{entryref}
   @end example
   
   In its argumented form, resumes execution after a @code{BREAK}.
   
   @emph{Syntax}
   
   @example
   ZGOTO
   @end example
   
 @node ZHALT  @node ZHALT
 @section ZHALT  @section ZHALT
 @cindex ZHALT  @cindex ZHALT
Line 3395  Constants must only be locals, and globa Line 3471  Constants must only be locals, and globa
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   In its single-argumented form, @code{ZHALT} command is used to exit the FreeM process with a specific return value @emph{intexpr}.
   
   @emph{Syntax}
   
   @example
   ZHALT @emph{intexpr}
   @end example
   
   In its argumentless form, @code{ZHALT} is synonymous with @code{HALT}.
   
   @emph{Syntax}
   
   @example
   ZHALT
   @end example
   
 @node ZINSERT  @node ZINSERT
 @section ZINSERT  @section ZINSERT
 @cindex ZINSERT  @cindex ZINSERT
Line 3536  Raises an error condition as long as the Line 3628  Raises an error condition as long as the
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   Synonymous with @ref{ZTHROW}.
   
 @node ZUNMAP  @node ZUNMAP
 @section ZUNMAP  @section ZUNMAP
 @cindex ZUNMAP  @cindex ZUNMAP
Line 4944  If you use other M implementations, you Line 5038  If you use other M implementations, you
 @cindex object-oriented programming  @cindex object-oriented programming
 @cindex programming, object-oriented  @cindex programming, object-oriented
   
   @menu
   * Classes::                             The organizing concept of object-oriented programming.
   * Inheritance::                         Making one class derive from another.
   * Methods::                             Attach code to classes.
   * Public and Private Variables::        Determining accessibility.
   * Instantiating Objects::               Creating instances of classes.
   @end menu
   
   @node Classes
 @section Classes  @section Classes
 @subsection Class Overview  @subsection Class Overview
   
Line 5000  DESTROY(THIS) ; Line 5102  DESTROY(THIS) ;
   Q    Q
 @end example  @end example
   
   @node Inheritance
 @section Inheritance  @section Inheritance
   
 Every class you create will automatically inherit the methods and functionality of the @code{OBJECT} class, supplied with FreeM.  Every class you create will automatically inherit the methods and functionality of the @code{OBJECT} class, supplied with FreeM.
Line 5018  You can achieve runtime polymorphism by Line 5121  You can achieve runtime polymorphism by
   
 Note that the overridden method in the subclass can take a different set or number of arguments than the @emph{formallist} of the superclass method would specify.  Note that the overridden method in the subclass can take a different set or number of arguments than the @emph{formallist} of the superclass method would specify.
   
   @node Methods
 @section Methods  @section Methods
 Class methods are defined as tags with @emph{formallist}s in a class routine, and per the typical FreeM object pattern, must take at least one argument, being @code{THIS} (representing a reference to the object instance being accessed).  Class methods are defined as tags with @emph{formallist}s in a class routine, and per the typical FreeM object pattern, must take at least one argument, being @code{THIS} (representing a reference to the object instance being accessed).
   
Line 5040  DEFAULT.USER> W MYOBJ.MYMETHOD() Line 5144  DEFAULT.USER> W MYOBJ.MYMETHOD()
 VALUE  VALUE
 @end example  @end example
   
   @node Public and Private Variables
 @section Public and Private Variables  @section Public and Private Variables
   
 FreeM supports private fields with the @code{:PRIVATE} specifier in the @code{SET} command, enforcing classical object-oriented data encapsulation. The @code{:PUBLIC} specifier is provided for completeness, and is the default.  FreeM supports private fields with the @code{:PRIVATE} specifier in the @code{SET} command, enforcing classical object-oriented data encapsulation. The @code{:PUBLIC} specifier is provided for completeness, and is the default.
Line 5062  Either of the following commands will cr Line 5167  Either of the following commands will cr
   
 Attempting to access private fields from outside of the class will raise error condition @code{ZOBJFLDACCV}.   Attempting to access private fields from outside of the class will raise error condition @code{ZOBJFLDACCV}. 
   
   @node Instantiating Objects
 @section Instantiating Objects  @section Instantiating Objects
   
 To instantiate an object (i.e., create an object from a certain class), you will use the @code{NEW} command as follows:  To instantiate an object (i.e., create an object from a certain class), you will use the @code{NEW} command as follows:
Line 5072  NEW MYSTR=$#^%STRING("myString") Line 5178  NEW MYSTR=$#^%STRING("myString")
   
 This will create a local variable called MYSTR of type STRING, and initialize it with the value myString.   This will create a local variable called MYSTR of type STRING, and initialize it with the value myString. 
   
 @section Determining Object Class  @subsection Determining Object Class
   
 To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:  To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:
   
Line 5669  Raised when you attempt to use multiple Line 5775  Raised when you attempt to use multiple
 Raised when attempts are made to set @code{$ECODE} to an invalid error code value. Obsolete and replaced by standard error code @code{M101}.  Raised when attempts are made to set @code{$ECODE} to an invalid error code value. Obsolete and replaced by standard error code @code{M101}.
   
 @item @code{ZASSERT} - @emph{programmer assertion failed}  @item @code{ZASSERT} - @emph{programmer assertion failed}
 Raised when an @code{ASSERT} expression's result is not true.  Raised when an @code{ZASSERT} expression's result is not true.
   
 @item @code{ZUSERERR} - @emph{user-defined error}  @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{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}.
Removed from v.1.44  
changed lines
  Added in v.1.52

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>