Skip to content

Commit

Permalink
Wordsmith HELPREXX files.
Browse files Browse the repository at this point in the history
  • Loading branch information
RossPatterson committed Jan 2, 2025
1 parent f0cc125 commit 0b18925
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 43 deletions.
3 changes: 1 addition & 2 deletions CALL.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ CALL instruction
| CALL OFF condition |
+-----------------------------------------------------------------------------+

NOTE: This implementation of REXX does not currently support the CALL ON and
CALL OFF instructions.
NOTE: bREXX does not currently support the CALL ON and CALL OFF instructions.

Call an internal routine, an external routine, or a built-in function. The
RESULT special variable is set to the value it returns, or is unset if there is
Expand Down
3 changes: 0 additions & 3 deletions CONDITIO.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ CONDITION function
| CONDITION([option]) |
+-----------------------------------------------------------------------------+

NOTE: This implementation of REXX does not currently support the CONDITION
function.

Returns the condition information associated with the current trapped
condition, as specifed by the option. Only the first character of the option
is examined, and is treated in uppper case. If the option is 'CONDITION',
Expand Down
15 changes: 7 additions & 8 deletions OPTIONS.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,15 @@ OPTIONS instruction
+-----------------------------------------------------------------------------+

Specify handling options. The expression is evaluated, and individual words
in the result that are meaningful to the Rexx implementation will be obeyed
(these might control optimizations, enforce standards, enable
implementation-dependent features, etc.). Words in the result that are not
recognized will be ignored (they are assumed to be instructions to a different
Rexx implementation).
in the result that are meaningful to bREXX will be obeyed (these might control
optimizations, enforce standards, enable implementation-dependent features,
etc.). Words in the result that are not recognized will be ignored (they are
assumed to be instructions to a different Rexx implementation).

This Rexx implementation supports the following options, which are processed
case-independently:
bREXX supports the following options, which are processed case-independently:

[NO]STORAGE_DECIMAL - Specifies how to treat the address argument of the
STORAGE() built-in function. With STORAGE_DECIMAL, it is treated as a
decimal value, as bREXX did before release 1.1.0. The default, which can be
specified by NOSTORAGE_DECIMAL, is to treat the address as a hexadecimal value.
specified by NOSTORAGE_DECIMAL, is to treat the address as a hexadecimal
value.
30 changes: 12 additions & 18 deletions PARSE.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,18 @@ a set of substrings, and stores the results in the specified variables. If the
ARG keyword is specified, the source is the argument list from the current
invocation of an internal routine, or from the invocation of the program if no
routine is active. If the AUTHOR keyword is specifed, the source is the email
address of the REXX implementation's original author. If the LINEIN keyword is
specifed, the source is the next value returned by the LINEIN() built-in
function. If the NUMERIC keyword is specifed, the source is the current
settings of NUMERIC DIGITS, NUMERIC FUZZ, and NUMERIC FORM, in that order. If
the PULL keyword is specified, the source is the next value obtained from the
console stack. If the SOURCE keyword is specifed, the source is the REXX
system name, the current invocation type, and the current filename, separated
by blanks. If the VALUE keyword is specifed, the source is the value of the
expression, which defaults to a null string, and the w1TH keyword is required.
If the VAR keyword is specifed, the source is the value of the named variable.
If the VERSION keyword is specifed, the source is the REXX language name, the
language level, and the release date of the REXX implementation, in DATE('N')
format (i.e., 'dd Mon yyyy').
address of bREXX's original author. If the LINEIN keyword is specifed, the
source is the next value returned by the LINEIN() built-in function. If the
NUMERIC keyword is specifed, the source is the current settings of NUMERIC
DIGITS, NUMERIC FUZZ, and NUMERIC FORM, in that order. If the PULL keyword is
specified, the source is the next value obtained from the console stack. If
the SOURCE keyword is specifed, the source is the REXX system name, the current
invocation type, and the current filename, separated by blanks. If the VALUE
keyword is specifed, the source is the value of the expression, which defaults
to a null string, and the w1TH keyword is required. If the VAR keyword is
specifed, the source is the value of the named variable. If the VERSION
keyword is specifed, the source is the REXX language name, the language level,
and the bREXX release date, in DATE('N') format (i.e., 'dd Mon yyyy').

The template_list parameter specifes how to separate the source into
substrings, and how to store the results. If the source is ARG, the
Expand Down Expand Up @@ -75,11 +74,6 @@ The ARG and PULL instructions are exact synonyms for PARSE UPPER ARG and PARSE
UPPER PULL, respectively. The PARSE LINEIN instruction is an exact synonym for
PARSE VALUE LINEIN().

NOTE: Most is this HELP file is based on the ANSI standard documentation.
Because PARSE is notoriously difficult to understand, this information
needs to be carefully compared to the actual implementation. This has
not yet been done.

Examples:

/* v1='This', v2='is', v3='a sentence.' */
Expand Down
2 changes: 0 additions & 2 deletions SIGNAL.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ SIGNAL instruction
| SIGNAL OFF condition |
+-----------------------------------------------------------------------------+

NOTE: This REXX implementation does not currently support the NAME keyword.

This instruction either diverts the path of execution to another instruction,
or establishes a handler for a condition that will divert at a later time. If
the labelname parameter is specified, the program diverts execution to the
Expand Down
6 changes: 3 additions & 3 deletions STORAGE.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ STORAGE function

Returns the virtual machine storage size if all arguments are omitted.

NOTE: This implementation of REXX requires the "address" parameter to be a
decimal number, not hexadecimal as the Rexx standard requires and as this
HELP information suggests.
NOTE: bREXX requires the "address" parameter to be a decimal number, not
hexadecimal as the Rexx standard requires and as this HELP information
suggests.

Returns a string composed of length bytes, which defaults to 1, of the virtual
machine's storage starting at address. If the thirds argument is specified,
Expand Down
11 changes: 4 additions & 7 deletions TRACE.HELPREXX
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ If the setting is 'ALL', then all clauses are traced.
If the setting is 'COMMANDS', then all commands are traced before execution,
and any non-zero return code is displayed.

In this Rexx implementation, if the setting is 'DEBUG' and the DEBUG option
was specified when it was compiled, the internal debugger status is toggled
between enabled and disabled.
In bREXX, if the setting is 'DEBUG' and the DEBUG option was specified when it
was compiled, the internal debugger status is toggled between enabled and
disabled.

If the setting is 'ERROR', then any comamnd with a non-zero return code is
traced with its return code.
Expand All @@ -44,7 +44,7 @@ If the setting is 'RESULTS', then all clauses are traced before execution,
along with all results of evaluation and any values assigned in ARG, PARSE,
and PULL clauses.

In this Rexx implementation, if the setting is 'SCAN', nothing happens.
In bREXX, if the setting is 'SCAN', nothing happens.

+-----------------------------------------------------------------------------+
| TRACE([option]) |
Expand All @@ -57,9 +57,6 @@ setting is specified, it must be a single letter, and will be treated as
upper case. The values are the first letter of the valid settings for the
TRACE instruction.

NOTE: In this Rexx implementation, TRACE() returns 'N' for both TRACE NORMAL
and TRACE FAILURE.

Example:

TRACE() == 'N' /* normally */
Expand Down

0 comments on commit 0b18925

Please sign in to comment.