SOUL macro facility - Revision history

Dme: /* Macro dummy strings */

2019-07-16T12:25:15Z

Macro dummy strings

← Older revision		Revision as of 12:25, 16 July 2019
Line 63:		Line 63:
	clause in the record object declaration will be replaced by the value of		clause in the record object declaration will be replaced by the value of
	the global variable <code>HENGE</code>:		the global variable <code>HENGE</code>:
	<p class="code">%sites in object recordset in file ?&HENGE		<p class="code">%sites is object recordset in file ?&HENGE
	</p>		</p>
	Note that the name <code>HENGE</code> is written completely in uppercase.		Note that the name <code>HENGE</code> is written completely in uppercase.

Dme: /* Macro dummy strings */

2019-07-16T12:24:18Z

Macro dummy strings

← Older revision		Revision as of 12:24, 16 July 2019
Line 86:		Line 86:
	<p class="code">!def henge avebury		<p class="code">!def henge avebury
	...		...
	%sites in object recordset in file ?!HENGE		%sites is object recordset in file ?!HENGE
	</p>		</p>

Line 145:		Line 145:
	concatenation operator. </li>		concatenation operator. </li>
	</ul>		</ul>

	==!DUPEXIT [var]==		==!DUPEXIT [var]==
	The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it		The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it

Dme at 12:13, 16 July 2019

2019-07-16T12:13:40Z

← Older revision		Revision as of 12:13, 16 July 2019
Line 1:		Line 1:
	The ~~User Language Macro Facility~~		The SOUL macro facility
	consists of <var class="product">SOUL</var>		consists of <var class="product">SOUL</var>
	'''macro statements''' that allow code to be conditionally compiled.		'''macro statements''' that allow code to be conditionally compiled.
Line 50:		Line 50:
	<p class="code">!DEF .		<p class="code">!DEF .
	</p>		</p>

	==Macro dummy strings==		==Macro dummy strings==
	In any request that contains any macro language statements, macro dummy		In any request that contains any macro language statements, macro dummy
Line 92:		Line 92:
	be written completely in uppercase, even if the declaration of the variables		be written completely in uppercase, even if the declaration of the variables
	used mixed case.		used mixed case.

	===Handling ?! characters in program code===		===Handling ?! characters in program code===
	<p>		<p>
Line 98:		Line 98:
	Thus if a program happens to contain the <code>?!</code> characters,		Thus if a program happens to contain the <code>?!</code> characters,
	perhaps in a comment or a literal, no compilation errors will result. </p>		perhaps in a comment or a literal, no compilation errors will result. </p>
	<p>		<p>
	However, if a single macro statement should appear in a program, macro dummy		However, if a single macro statement should appear in a program, macro dummy
	string substitution is enabled.		string substitution is enabled.
Line 131:		Line 131:
	Unfortunately, as with <var>Include</var> parameter and global dummy strings, macro dummy		Unfortunately, as with <var>Include</var> parameter and global dummy strings, macro dummy
	string substitution is performed on comments. </li>		string substitution is performed on comments. </li>

	<li>If inside a literal string, move the quotes to separate the question mark		<li>If inside a literal string, move the quotes to separate the question mark
	from the exclamation mark:		from the exclamation mark:
Line 145:		Line 145:
	concatenation operator. </li>		concatenation operator. </li>
	</ul>		</ul>

	==!DUPEXIT [var]==		==!DUPEXIT [var]==
	The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it		The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it
Line 210:		Line 210:
	</ul>		</ul>
	This can be done with a <var>!DUPEXIT</var> or with a <var>!IFNDEF</var> and a <var>!DEF</var>.		This can be done with a <var>!DUPEXIT</var> or with a <var>!IFNDEF</var> and a <var>!DEF</var>.

	==!DEF var==		==!DEF var==
	The <var>!DEF</var> statement sets the indicated macro variable to ''defined''.		The <var>!DEF</var> statement sets the indicated macro variable to ''defined''.
Line 231:		Line 231:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSE==		==!ELSE==
	The <var>!ELSE</var> statement compiles the <var class="product">SOUL</var> instructions that follow it —		The <var>!ELSE</var> statement compiles the <var class="product">SOUL</var> instructions that follow it —
Line 241:		Line 241:
	The subroutine below		The subroutine below
	compiles calls to a <var>$LOG</var> function if the <var>$LOG</var> macro variable is defined.		compiles calls to a <var>$LOG</var> function if the <var>$LOG</var> macro variable is defined.
	Otherwise, it calls a <var class="product">~~User Language~~</var> subroutine which (presumably) calculates		Otherwise, it calls a <var class="product">SOUL</var> subroutine which (presumably) calculates
	logs in <var class="product">SOUL</var>:		logs in <var class="product">SOUL</var>:
	<p class="code">SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)		<p class="code">SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)
Line 256:		Line 256:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSEIFDEF var==		==!ELSEIFDEF var==
	The <var>!ELSEIFDEF</var> statement compiles the <var class="product">~~User Language~~</var> instructions that follow it		The <var>!ELSEIFDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it
	— if the indicated variable is ''defined'', and if no <var>!IFDEF</var>, <var>!IFNDEF</var>,		— if the indicated variable is ''defined'', and if no <var>!IFDEF</var>, <var>!IFNDEF</var>,
	<var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var> at the same level was evaluated as true.		<var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var> at the same level was evaluated as true.
Line 288:		Line 288:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSEIFNDEF var==		==!ELSEIFNDEF var==
	The <var>!ELSEIFNDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it		The <var>!ELSEIFNDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it
Line 321:		Line 321:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ENDIF==		==!ENDIF==
	The <var>!ENDIF</var> statement marks the end of a <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>,		The <var>!ENDIF</var> statement marks the end of a <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>,
Line 337:		Line 337:
	!ENDIF		!ENDIF
	</p>		</p>

	==!IFDEF var==		==!IFDEF var==
	The <var>!IFDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it		The <var>!IFDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it
Line 360:		Line 360:
	!ENDIF		!ENDIF
	</p>		</p>

	==!IFNDEF var==		==!IFNDEF var==
	The <var>!IFNDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it		The <var>!IFNDEF</var> statement compiles the <var class="product">SOUL</var> instructions that follow it
Line 383:		Line 383:
	!ENDIF		!ENDIF
	</p>		</p>

	[[Category: User Language syntax enhancements]]		[[Category: User Language syntax enhancements]]

	==!UNDEF var==		==!UNDEF var==
	The <var>!UNDEF</var> statement sets the indicated macro variable to ''undefined''.		The <var>!UNDEF</var> statement sets the indicated macro variable to ''undefined''.
Line 408:		Line 408:
	!UNDEF DEBUGGING		!UNDEF DEBUGGING
	</p>		</p>


	[[Category:SOUL macro facility]]		[[Category:SOUL macro facility]]
	[[Category: User Language syntax enhancements]]		[[Category: User Language syntax enhancements]]

Dme: /* !UNDEF var */

2019-07-16T12:02:59Z

!UNDEF var

← Older revision		Revision as of 12:02, 16 July 2019
Line 410:		Line 410:


	[[Category:~~User Language~~ macro facility]]		[[Category:SOUL macro facility]]
	[[Category: User Language syntax enhancements]]		[[Category: User Language syntax enhancements]]

Dme: Dme moved page User Language Macro Facility to SOUL macro facility

2019-07-16T11:56:56Z

Dme moved page User Language Macro Facility to SOUL macro facility

← Older revision	Revision as of 11:56, 16 July 2019
(No difference)

JAL at 18:03, 16 April 2014

2014-04-16T18:03:03Z

Show changes

JAL2: /* !UNDEF var */

2012-09-12T15:58:32Z

!UNDEF var

← Older revision		Revision as of 15:58, 12 September 2012
Line 410:		Line 410:
	</p>		</p>


			[[Category:User Language macro facility]]
	[[Category: User Language syntax enhancements]]		[[Category: User Language syntax enhancements]]

JAL2 at 15:53, 12 September 2012

2012-09-12T15:53:21Z

← Older revision		Revision as of 15:53, 12 September 2012
Line 52:		Line 52:
	<p class="code">!DEF .		<p class="code">!DEF .
	</p>		</p>

	==Macro dummy strings==		==Macro dummy strings==
	In any request that contains any macro language statements, macro dummy		In any request that contains any macro language statements, macro dummy
Line 145:		Line 146:
	concatenation operator.		concatenation operator.
	</ul>		</ul>

	==!DUPEXIT [var]==		==!DUPEXIT [var]==
	The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it		The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it
Line 229:		Line 231:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSE==		==!ELSE==
	The <var>!ELSE</var> statement compiles the <var class="product">User Language</var> instructions that follow it		The <var>!ELSE</var> statement compiles the <var class="product">User Language</var> instructions that follow it
Line 254:		Line 257:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSEIFDEF var==		==!ELSEIFDEF var==
	The <var>!ELSEIFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it		The <var>!ELSEIFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
Line 285:		Line 289:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ELSEIFNDEF var==		==!ELSEIFNDEF var==
	The <var>!ELSEIFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it		The <var>!ELSEIFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
Line 317:		Line 322:
	!ENDIF		!ENDIF
	</p>		</p>

	==!ENDIF==		==!ENDIF==
	The <var>!ENDIF</var> statement marks the end of a <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>,		The <var>!ENDIF</var> statement marks the end of a <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>,
Line 332:		Line 338:
	!ENDIF		!ENDIF
	</p>		</p>

	==!IFDEF var==		==!IFDEF var==
	The <var>!IFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it		The <var>!IFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
Line 354:		Line 361:
	!ENDIF		!ENDIF
	</p>		</p>

	==!IFNDEF var==		==!IFNDEF var==
	The <var>!IFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it		The <var>!IFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it

JAL2: /* !IFNDEF var */

2011-09-07T20:18:48Z

!IFNDEF var

← Older revision		Revision as of 20:18, 7 September 2011
Line 376:		Line 376:
	!ENDIF		!ENDIF
	</p>		</p>

			[[Category: User Language syntax enhancements]]

	==!UNDEF var==		==!UNDEF var==
	The <var>!UNDEF</var> statement sets the indicated macro variable to ''undefined''.		The <var>!UNDEF</var> statement sets the indicated macro variable to ''undefined''.

JAL2: Created page with " The User Language Macro Facility consists of some new `User Language` '''macro statements''' that allow code to be conditionally compiled. This facilit..."

2011-09-07T20:15:53Z

Created page with " The User Language Macro Facility consists of some new <var class="product">User Language</var> '''macro statements''' that allow code to be conditionally compiled. This facilit..."

New page

The User Language Macro Facility
consists of some new <var class="product">User Language</var>
'''macro statements''' that allow code to be conditionally compiled.
This facility was available with <var class="product">Sirius Performance Enhancements</var>2. in <var class="product">Sirius Mods</var> version 5.6 and later,
and it is now available to all <var class="product">[[Janus SOAP]]</var> (and other Sirius API) customers.

The facility's macro statements must be the first to appear on a logical line
(a physical line and any continuation lines), and they must begin with the
exclamation character (<tt>!</tt>).
Many of the macro statements also refer to '''macro variables''',
which are different from %variables or global variables.
Macro variables have their names and attributes stored in CCATEMP,
and they can be used to control the evaluation of macro statements.
Macro variables have no special format for their names, except
they cannot contain <var class="product">User Language</var> separator characters such as blanks.

Macro statements are evaluated at compile time, so they have ''no''
effect on evaluation-time table sizes or CCATEMP usage other than effects
resulting from compilation or non-compilation of non-macro <var class="product">User Language</var>
statements.
In addition, macro statements cannot be used to control execution of
<var class="product">Model 204</var> commands outside the compiler.

Currently, macro variables can only have one of two attributes:
'''defined''' or '''undefined'''.

All macro language clauses (such as <var>!IF</var> or <var>!ELSE</var> clauses) are implicitly
terminated when the procedure in which they were started is closed.
For example, if the following procedure is closed,
the <code>!IFDEF CHUCKLES</code> clause is terminated.
PROCEDURE EXAMPLE

PRINT 'In procedure EXAMPLE'

!IFDEF CHUCKLES
PRINT 'CHUCKLES is defined'

END PROCEDURE


Macro statements are evaluated ''after'' dummy string substitution.
A statement like
!DEF .?&DEBUG

is evaluated as the following statement,
if the global <var>DEBUG</var> is set to "DEBUG":
!DEF .DEBUG

The initial statement is evaluated as the following statement,
if the global <var>DEBUG</var> is not set.
!DEF .

==Macro dummy strings==
In any request that contains any macro language statements, macro dummy
string substitution will be performed.
<var class="product">Model 204</var> dummy strings are strings that begin with a question mark (<tt>?</tt>)
and some other
special character, either another question mark or an ampersand (<tt>&</tt>).
These are replaced, as the lines are being read, with either an <var>Include</var>
parameter or a global variable value.

For example, in the following request, the filename in the <code>In</code>
clause in the record object declaration will be replaced by the value of
the global variable <code>HENGE</code>:
%sites in object recordset in file ?&HENGE

Note that the name <code>HENGE</code> is written completely in uppercase.
This is because dummy string substitution is performed before <var>ToUpper</var>
processing and <var class="product">Model 204</var> considers lowercase characters to not be part of
dummy string names.
For more information on global and <var>Include</var> parameter dummy strings, see the
[http://www.cca-int.com/custsupp/zips/userlang.zip ''Model 204 User Language Manual''].

Macro dummy strings behave almost exactly the same way as <var>Include</var> parameters
and global dummy strings, with the following exceptions:
<ul>
<li>They are indicated by an exclamation mark following the question mark, as
in <code>?!henge</code>.
<li>Their values come from the macro variable whose name is indicated in the
dummy string.
<li>If no macro variable is defined with the indicated name, an error message
results.
<li>Substitution is only performed during compilation (since macro variables
are only available during compilation).
</ul>

So, in the following example, the <var>Recordset</var> object declaration would be
for the file <code>AVEBURY</code>:
!def henge avebury
...
%sites in object recordset in file ?!HENGE


As with global variable dummy strings, macro variable dummy string names must
be written completely in uppercase, even if the declaration of the variables
used mixed case.
 '''Note:'''For backward compatibility reasons, no macro dummy string substitution
is attempted in any program that contains no macro statements.
Thus if a program happens to contain the <code>?!</code> characters,
perhaps in a comment or a literal, no compilation errors will result.

However, if a single macro statement should appear in a program, macro dummy
string substitution is enabled.
If any old code in the program happened
to contain a <code>?!</code> pair, a compilation error is likely.
If the first macro statement appears after a <code>?!</code> pair, a compilation
error will also result, since it is assumed that the previous <code>?!</code>
might have been intended as a macro dummy string.
There is still the chance, however, that the facility will miss a reference
to an undefined macro variable because the program contains '''no'''
macro statements.
If this is a concern, a dummy macro statement could be placed at the start
of any program that '''might''' use macro variables:
Begin

!undef nothing

...

As this example illustrates, an <code>!undef</code> is a good macro language
no-op, since whatever variable is being undefined is guaranteed to be
undefined already at the start of the program.

In the event that you are using macro statements but want to have a <code>?!</code> pair
in a program, there are a few ways to get around the fact that the
macro langauge facility will insist on trying to do macro dummy string
substitution for such a reference.
<ul>
<li>If inside a comment, simply put a blank between the question mark and
exclamation mark.
Unfortunately, as with <var>Include</var> parameter and global dummy strings, macro dummy
string substitution is performed on comments.
<li>If inside a literal string, move the quotes to separate the question mark
from the exclamation mark:
%x = 'Qe5 ?'!

In such a case, <var class="product">Model 204</var> treats the string as if the text from the quote to the
first delimiter character (including space) is inside the quote.
If spaces or other delimiters follow the <code>?!</code>, the exclamation mark could
simply be quoted:
%x = 'Fischer did Qe5 ?'!', and Spassky frowned.'

Another way to accomplish the same thing would be to use the <code>With</code>
concatenation operator.
</ul>
==!DUPEXIT [var]==
The <var>!DUPEXIT</var> statement conditionally closes the current procedure, and it
continues compilation in the procedure (or command level statement)
that <var>INCLUDE</var>'d the current procedure.

As such, <var>!DUPEXIT</var> is not a valid statement at command level.
It conditionally closes the current procedure
if the explicit or implicit macro variable is ''defined''.
If the macro variable is not ''defined'', the variable is set to
<code>defined</code>, and processing continues in the current procedure.
<var>!DUPEXIT</var> really performs the work of two macro statements: <var>!IFNDEF</var> and
<var>!DEF</var>.

<var>!DUPEXIT</var> can, optionally, be followed by the name of a macro variable.
If the macro variable name is not specified, it defaults to the name of
the current procedure.
In this latter case, the length of the procedure name ''must'' be less
than the setting of the <var>LAUDIT</var> system parameter (unless the parameter is set
to 255).

<var>!DUPEXIT</var> can be useful for preventing one-time-only definitions (%variable
or subroutine) from being performed more than once.
For example, the <var>!DUPEXIT</var> statement in the following example
prevents subroutine <code>COMMON</code> from being defined more than once, as long
as the subroutine is only defined in procedure <code>COMPLEX</code>:
PROCEDURE COMPLEX

!DUPEXIT

SUBROUTINE COMMON(%INPUT IS FLOAT)

. . . . . .

END SUBROUTINE

END PROCEDURE

The first time <code>COMPLEX</code> is <var>INCLUDE</var>'d, the <var>!DUPEXIT</var> will not
close <code>COMPLEX</code> (because <code>COMPLEX</code>
will be ''undefined''), but it will then ''define'' <code>COMPLEX</code>.
Any subsequent time that <code>COMPLEX</code> is <var>INCLUDE</var>'d, the <var>!DUPEXIT</var> will cause it to be
closed immediately, because at that point <code>COMPLEX</code> will be ''defined''.

If subroutine <code>COMMON</code> might be defined in other procedures,
<code>COMPLEX</code> might be changed as follows:
PROCEDURE COMPLEX

!DUPEXIT COMMON

SUBROUTINE COMMON(%INPUT IS FLOAT)

. . . . . .

END SUBROUTINE

END PROCEDURE

This tactic will only work as long as other procedures that define subroutine
<code>COMMON</code> also:
<ul>
<li>Define it conditionally based on whether <code>COMMON</code> is ''defined''.
<li>''Define'' <code>COMMON</code> if they define the subroutine.
</ul>
This can be done with a <var>!DUPEXIT</var> or with a <var>!IFNDEF</var> and a <var>!DEF</var>.
==!DEF var==
The <var>!DEF</var> statement sets the indicated macro variable to ''defined''.
If the variable is already ''defined'', it remains ''defined''.

The <var>!DEF</var> statement can be useful to set a flag that can later be used to
conditionally compile some <var class="product">User Language</var>.

In the following example, the <var>!DEF</var> statement
''defines'' a macro variable that is later used to conditionally compile
some debugging statements:
!DEF DEBUGGING

. . . . .

!IFDEF DEBUGGING
PRINT '%X = ' %X
PRINT '%Y = ' %Y
PRINT '%Z = ' %Z
!ENDIF

==!ELSE==
The <var>!ELSE</var> statement compiles the <var class="product">User Language</var> instructions that follow it
—
if no <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var> statement at the same level
was evaluated as true.

The <var>!ELSE</var> clause is terminated by an <var>!ENDIF</var> statement.

The subroutine below
compiles calls to a <var>$LOG</var> function if the <var>$LOG</var> macro variable is defined.
Otherwise, it calls a <var class="product">User Language</var> subroutine which (presumably) calculates
logs in <var class="product">User Language</var>:
SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)

%X IS FLOAT
%Y IS FLOAT

!IFDEF $LOG
%X = $LOG(%MIN)
%Y = $LOG(%MAX)
!ELSE
CALL ULLOG(%MIN, %X)
CALL ULLOG(%MAX, %Y)
!ENDIF

==!ELSEIFDEF var==
The <var>!ELSEIFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
— if the indicated variable is ''defined'', and if no <var>!IFDEF</var>, <var>!IFNDEF</var>,
<var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var> at the same level was evaluated as true.

The <var>!ELSEIFDEF</var> clause is terminated by an <var>!ELSE</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>, or
<var>!ENDIF</var> statement.

If the variable specified in the <var>!ELSEIFDEF</var> statement is ''defined'',
and no previous <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var>
clause has been executed, both of these result:
<ul>
<li>The clause that follows is compiled.
<li>No code in any subsequent <var>!ELSE</var>, <var>!ELSEIFDEF</var>, or
<var>!ELSEIFNDEF</var> clause associated with the <var>!IFDEF</var> statement is compiled.
</ul>

The subroutine below
compiles an <var>AUDIT</var> statement at the start of subroutine <code>MESSY</code>, if the <code>DEVELOPMENT</code>
macro variable is not ''defined'' but the <code>TEST</code> macro variable
is ''defined'':
SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)

!IFDEF DEVELOPMENT
PRINT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ELSEIFDEF TEST
AUDIT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ENDIF

==!ELSEIFNDEF var==
The <var>!ELSEIFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
— if the indicated variable is not ''defined'',
and if no <var>!IFDEF</var>, <var>!IFNDEF</var>,
<var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var> at the same level was evaluated as true.

The <var>!ELSEIFNDEF</var> clause is terminated by an <var>!ELSE</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>, or
<var>!ENDIF</var> statement.

If the variable specified in the <var>!ELSEIFNDEF</var> statement is not ''defined'',
and no previous <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, or <var>!ELSEIFNDEF</var>
clause has been executed, both of these result:
<ul>
<li>The clause that follows is compiled.
<li>No code in any subsequent <var>!ELSE</var>, <var>!ELSEIFDEF</var>, or
<var>!ELSEIFNDEF</var> clause associated with the <var>!IFDEF</var> statement is compiled.
</ul>

The subroutine below
compiles an <var>AUDIT</var> statement at the start of subroutine <code>MESSY</code>, if the <code>DEVELOPMENT</code>
macro variable is not ''defined'' and the <code>PRODUCTION</code> macro variable is
not ''defined''.
SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)

!IFDEF DEVELOPMENT
PRINT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ELSEIFNDEF PRODUCTION
AUDIT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ENDIF

==!ENDIF==
The <var>!ENDIF</var> statement marks the end of a <var>!IFDEF</var>, <var>!IFNDEF</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>,
or <var>!ELSE</var> clause and closes out the current <var>!IF</var> level.

The end of a procedure implies an <var>!ENDIF</var> statement for all <var>!IF</var> levels started
inside that procedure.

In the following example,
the <var>!ENDIF</var> marks the end of debugging code, and statements after the <var>!ENDIF</var>
will be compiled.
!IFDEF DEBUG
PRINT 'Return code from $COMMNDL = ' %RC
. . . . . . .
!ENDIF

==!IFDEF var==
The <var>!IFDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
if the indicated variable is ''defined''.

The <var>!IFDEF</var> clause is terminated by an <var>!ELSE</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>, or
<var>!ENDIF</var> statement.

If the variable specified in the <var>!IFDEF</var> statement is ''defined'', the
clause that follows is compiled, and no code in any
subsequent <var>!ELSE</var>, <var>!ELSEIFDEF</var>, or
<var>!ELSEIFNDEF</var> clause associated with the <var>!IFDEF</var> statement will be compiled.

The <var>!IFDEF</var> statement below
compiles an <var>AUDIT</var> statement at the start of subroutine <code>MESSY</code>, if the <code>DEVELOPMENT</code>
macro variable is ''defined'':
 SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)

!IFDEF DEVELOPMENT
AUDIT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ENDIF

==!IFNDEF var==
The <var>!IFNDEF</var> statement compiles the <var class="product">User Language</var> instructions that follow it
if the indicated variable is ''undefined''.

The <var>!IFNDEF</var> clause is terminated by an <var>!ELSE</var>, <var>!ELSEIFDEF</var>, <var>!ELSEIFNDEF</var>, or
<var>!ENDIF</var> statement.

If the variable specified in the <var>!IFNDEF</var> statement is ''undefined'', the
clause that follows it is compiled, and no code in any
subsequent <var>!ELSE</var>, <var>!ELSEIFDEF</var>, or
<var>!ELSEIFNDEF</var> clause associated with the <var>!IFNDEF</var> statement will be compiled.

The <var>!IFNDEF</var> statement below
compiles an <var>AUDIT</var> statement at the start of subroutine <code>MESSY</code>, if the <code>PRODUCTION</code>
macro variable is ''undefined'':
SUBROUTINE MESSY(%MIN IS FLOAT, %MAX IS FLOAT)

!IFNDEF PRODUCTION
AUDIT 'Entering MESSY, %MIN = ' %MIN -
'%MAX = ' %MAX
!ENDIF

==!UNDEF var==
The <var>!UNDEF</var> statement sets the indicated macro variable to ''undefined''.
If the variable is already ''undefined'', it remains ''undefined''.

The <var>!UNDEF</var> statement can be useful to clear a flag that might have been set earlier.
For example, the <var>!UNDEF</var> statement below
''undefines'' a macro variable being used as a debugging flag, so only some
of the debugging <var>PRINT</var> statements in the program are compiled.
!DEF DEBUGGING

. . . . .

!IFDEF DEBUGGING
PRINT '%X = ' %X
PRINT '%Y = ' %Y
PRINT '%Z = ' %Z
!ENDIF

. . . . .

!UNDEF DEBUGGING


[[Category: User Language syntax enhancements]]

SOUL macro facility - Revision history

Dme: /* Macro dummy strings */

Dme: /* Macro dummy strings */

Dme at 12:13, 16 July 2019

Dme: /* !UNDEF var */

Dme: Dme moved page User Language Macro Facility to SOUL macro facility

JAL at 18:03, 16 April 2014

JAL2: /* !UNDEF var */

JAL2 at 15:53, 12 September 2012

JAL2: /* !IFNDEF var */

JAL2: Created page with " The User Language Macro Facility consists of some new User Language '''macro statements''' that allow code to be conditionally compiled. This facilit..."

JAL2: Created page with " The User Language Macro Facility consists of some new `User Language` '''macro statements''' that allow code to be conditionally compiled. This facilit..."