1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
<HTML>
<!--
***********************************************************************
FUNNELWEB MANUAL WEB PAGE
=========================
Copyright (c) Ross N. Williams 1992,1999. All rights reserved.
Permission is granted to redistribute and use this manual in
any medium, with or without modification, provided that all
notices (including, without limitation, the copyright
notice, this permission notice, any record of modification,
and all legal notices) are preserved on all copies, that all
modifications are clearly marked, and that modified versions
are not represented as the original version unless all the
modifications since the manual's original release by Ross N.
Williams (www.ross.net) consist of translations or other
transformations that alter only the manual's form, not its
content. THIS MANUAL IS PROVIDED "AS IS" AND WITHOUT ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY
LAW THERE IS ABSOLUTELY NO WARRANTY.
***********************************************************************
-->
<HEAD>
<TITLE>5.5 Fudging Conditionals</TITLE>
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
</HEAD>
<BODY BACKGROUND="binary/background.gif"
BGCOLOR="#FFFFFF"
TEXT="#000000"
VLINK="#660000"
LINK="#FF0000"
ALINK="#CC0000">
<TABLE WIDTH="490">
<TR>
<TD WIDTH="130" VALIGN="top">
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>
<FONT SIZE="2">
<BR>
<A HREF="http://www.ross.net/"
TARGET="rosshome"
onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
<IMG SRC="binary/rossnet_logo.gif"
WIDTH="64" HEIGHT="32"
BORDER="0" ALT="RossNet"
HSPACE="0" VSPACE="1"></A><BR>
<BR>
<A HREF="../index.shtml"
TARGET="funnelweb"
onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
<IMG SRC="binary/linklogo.gif"
WIDTH="64" HEIGHT="32"
BORDER="0" ALT="FunnelWeb"
HSPACE="0" VSPACE="1"></A><BR>
<BR>
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0><TR><TD BGCOLOR="#000000">
<A HREF="../reference/index.html"
TARGET="funnelwebreference"
onClick="window.open('','funnelwebreference','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
<BR>
<A HREF="../developer/index.html"
TARGET="funnelwebdeveloper"
onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
<A HREF="macro.html"><FONT COLOR="#FFFFFF">2 Macros</FONT></A><BR>
<A HREF="type.html"><FONT COLOR="#FFFFFF">3 Typesetting</FONT></A><BR>
<A HREF="example.html"><FONT COLOR="#FFFFFF">4 Example</FONT></A><BR>
<A HREF="hints.html"><FONT COLOR="#FFFFFF">5 Hints</FONT></A><BR>
<A HREF="examples.html"><FONT COLOR="#FFFFFF">6 Examples</FONT></A><BR>
<A HREF="web.html"><FONT COLOR="#FFFFFF">7 Webmaking</FONT></A><BR>
<BR>
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
</FONT>
</TD></TR></TABLE>
</TD>
<TD WIDTH="360" VALIGN="top">
<FONT SIZE="3">
<A HREF="../reference/index.html"><IMG SRC="binary/title.gif"
WIDTH="302" HEIGHT="24"
BORDER="0" ALT="FunnelWeb Tutorial Manual"
HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">5.5 Fudging Conditionals</FONT><BR>
<P>As a macro preprocessor, one facility that FunnelWeb
lacks is a conditional facility (such as C's
<SAMP>#ifdef</SAMP>). It might, therefore, come as a surprise
to know that the FunnelWeb V1 actually had a
built in conditional facility. The facility allowed the
programmer to specify a construct that would select from one
of a number of macro expressions depending on the value of a
controlling macro expression.
<P>In three years the construct was never used.
<P>The reason was that conditional constructs could be
fudged nearly as easily as they could be used. Because of
this, the inbuilt conditional feature was removed in the
FunnelWeb V2. Not only did this simplify the
program, but is also allowed recursive macros to be detected
through static analysis rather than during macro expansion.
<P>There are two basic ways to fudge a conditional. First,
the comment facility of the target programming language may
be employed. For example, in Ada, comments
commence with "<TT>--</TT>" and terminate at the end of the
line. Using this fact, it is easy to construct macros that
can be called at the start of each target line and which
turn on and off the lines so marked by defining the macro to
be the empty string (ON) or the comment symbol
(<SAMP>--</SAMP>) (OFF). For example:
<P><PRE>
@A@<Debug Macro@>
The following macro determines whether debug code
will be included in the program. All lines of
debug code commence with a call to this macro and
so we can turn all that code on or off here by
defining this macro to be either empty or the
single-line comment symbol (<SAMP>--</SAMP>). Note
the use of a quick macro name.
@$@#D@M==@{@} @! Turns the debug code ON.
@! Use this definition to turn
@! the debug code OFF: @$@#D==@{--@}
... then later in the file...
@$@<Sloth incrementing loop@>==@{@-
while sloth<walrus loop
@#D assert(sloth<walrus,"Sloth bomb.");
@#D assert(timer<timermax,"Timer bomb.");
inc(sloth);
end loop@}
</PRE>
<P>The other way to fudge a conditional is to
define a macro with a single parameter. A call to
the macro is then wrapped around all the
conditional code in the program. The macro can
then be defined to present or ignore the code of
its argument. For example:
<P>
<PRE>
@A@<Debug Macro@>
The following macro determines whether debug code
will be included in the program. All debug code is
wrapped by a call to this macro and so we can turn
all the debug code on or off here by defining this
macro to be either empty or its parameter.
@$@#D@(@1@)@M==@{@1@} @! Debug code ON.
@! Use this definition to turn the
@! debug code OFF: @$@#D@(@1@)==@{@}
... then later in the file...
@$@<Sloth incrementing loop@>==@{@-
while sloth<walrus loop
@#D@(assert(sloth<walrus,"Sloth bomb.");
assert(timer<timermax,"Timer bomb");@)
inc(sloth);
end loop@}
</PRE>
<P>In languages that allow multi-line comments (e.g. C
with <SAMP>/*</SAMP> and <SAMP>*/</SAMP>), comments can be used to
eliminate the conditioned code rather than absence. For
example:
<P>
<PRE>
@! Comments out the debug code
@$@#D@(@1@)@M==@{/* @1 */@}
</PRE>
<P>(Note: If this example were ever actually used, the
programmer would have to be careful not to place comments in
the argument code. Nested comments in C are non-portable.)
<P>The parameterized macro idea can be generalized to
support the choice of more than one mutually exclusive
alternative. For example:
<P>
<PRE>
@A This module contains non-portable code that
must execute on Hewlett Packard, Sun, and DEC
workstations. The following FunnelWeb macro is
defined to choose between these three. The first
parameter is the HP code, the second is the Sun
code, and the third is the DEC code. Whichever
parameter constitutes the body of this macro
determines which machine the code is being
targeted for.
@$@<Machine specific code@>@(@3@)@M==@{@-
@1@} @! Configure for HP.
...then later in the file...
@<Machine specific code@>@(
@"get_command_line(comline)@" @, @! HP.
@"scan_command_line(128,comline);@" @, @! Sun.
@"dcl_get_command_line(comline,256);@" @) @! DEC.
</PRE>
<P>Of course, this could also be performed using three
separate macros. The main advantage of using a single macro
is that the mutual exclusivity is enforced. Also, because
FunnelWeb ensures that the number of formal and actual
parameters are the same, this method lessens the chance that
a machine will be forgotten in some places.
<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left" VALIGN="bottom"><A HREF="hints_eols.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="hints.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right" VALIGN="bottom"><A HREF="hints_headings.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
</TR>
</TABLE>
<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>
<A HREF="copyright.html">Copyright © Ross N. Williams 1992,1999. All rights reserved.</A><BR>
</FONT>
</FONT>
</TD>
</TR>
</TABLE>
</BODY>
<!-- *********************************************************************** -->
<!-- End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/) -->
<!-- *********************************************************************** -->
</HTML>
|
