File: design_syntax.html

package info (click to toggle)
funnelweb-doc 3.2d-4.2
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,744 kB
  • sloc: perl: 241; makefile: 23
file content (272 lines) | stat: -rw-r--r-- 8,299 bytes parent folder | download | duplicates (5)
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
269
270
271
272
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
            "http://www.w3.org/TR/REC-html40/loose.dtd">

<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>2.4 A Review Of FunnelWeb Syntax</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="../tutorial/index.html"
 TARGET="funnelwebtutorial"
 onClick="window.open('','funnelwebtutorial','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<A HREF="compile.html"><FONT COLOR="#FFFFFF">1 Compile</FONT></A><BR>
<A HREF="design.html"><FONT COLOR="#FFFFFF">2 Design</FONT></A><BR>
<A HREF="implement.html"><FONT COLOR="#FFFFFF">3 Implement</FONT></A><BR>
<A HREF="modify.html"><FONT COLOR="#FFFFFF">4 Modify</FONT></A><BR>
<A HREF="misc.html"><FONT COLOR="#FFFFFF">5 Misc</FONT></A><BR>
<A HREF="gpl.html"><FONT COLOR="#FFFFFF">6 Licence</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="index.html"><IMG SRC="binary/title.gif"
 WIDTH="316" HEIGHT="24"
 BORDER="0" ALT="FunnelWeb Developer Manual"
 HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">2.4 A Review Of FunnelWeb Syntax</FONT><BR>



<P>One of the disadvantages of FunnelWeb is its
clumsy macro definition and calling syntax. Compared to
(say) the C preprocessor, FunnelWeb's macro call syntax is
like a freight train in a china shop. Unfortunately, all
attempts to convert this syntax to something more elgant
have failed, because the existing syntax is the simplest
from a conceptual point of view and is the least likely
to cause semantic confusion. This page discusses and
justifies the FunnelWeb syntax.

<P><BR><FONT SIZE="4"><STRONG>Macro Definition Syntax</STRONG></FONT><BR>


<P>FunnelWeb's macro definition syntax results in
definitions that look like this:

<P><PRE>
@$@&lt;Put out the cat@&gt;==@{@-
Open the door
Say out
Close the door@}
</PRE>

<P>Here's why this syntax was chosen:

<P><BLOCKQUOTE><B>Dollars:</B> The <SAMP>@$</SAMP> is necessary to cue a
                               definition. Without it, the definition might somehow be
                               mistaken for an invocation.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>Name delimiters:</B>  The <SAMP>@&lt;</SAMP> and
                                       <SAMP>@&gt;</SAMP> are required to delimit the name and to
                                       resonate syntactically with macro calls.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>Content delimiters:</B>  The <SAMP>@{</SAMP> and
                                          <SAMP>@}</SAMP> delimit the content of the macro.</BLOCKQUOTE>

<P><BLOCKQUOTE><B>EOL suppressor:</B> The <SAMP>@-</SAMP> is a
                                      result of the simplifying rule that the content of a macro
                                      is "exactly the text between the
                                          <SAMP>@{</SAMP> and <SAMP>@}</SAMP>."</BLOCKQUOTE>

<P>The only real target for a syntax purge the
"<TT>==</TT>" which is optional anyway.

<P>An alternative minimalist approach to macro definitions
is:

<P><PRE>
@&lt;Put out the cat@&gt;
Open the door
Say out
Close the door@}
</PRE>

<P>but this is too dangerous for my tastes as there
is no syntax surrounding the name of the macro to
indicate that it is a macro definition and not a macro
call.

<P><BR><FONT SIZE="4"><STRONG>Parameterized Macro Definition Syntax</STRONG></FONT><BR>

<P>The definitions of parameterized macros are even messier
than the normal definitions.

<P><PRE>
@$@&lt;Put out the cat@&gt;@(@3@)==@{@-
Open the door
Say out
Close the door@}
</PRE>

This is messy, but the "natural" alternative is even worse:

<P><PRE>
@$@&lt;Put out the cat@&gt;@(@1@,@2@,@3@)==@{@-
Open the door
Say out
Close the door@}
</PRE>

<P>Given that the parameters don't have names, it seems cleaner
just to specify the number of parameters.
pecifying the number of parameters seems sensible.

<P><BR><FONT SIZE="4"><STRONG>Macro Call Syntax</STRONG></FONT><BR>


<P>Here are some syntaxes that were considered for
FunnelWeb macro calls.

<P>
<PRE>
Open the door
@&lt;Say Out@&gt;         @! Current style.
Close the door

Open the door
@&lt;Say out&gt;@
Close the door

Open the door
@"Say out@"
Close the door

Open the door
@(Say out@)
Close the door

Open the door
@&lt;Say out&gt;
Close the door
</PRE>

<P>Of these, the first was chosen.

<P><BR><FONT SIZE="4"><STRONG>Parameterized Macro Call Syntax</STRONG></FONT><BR>


<P>FunnelWeb&nbsp;V1 provided a messy parameterized macro
call syntax:

<P><PRE>
@&lt;Say Out@&gt;@(@"firstparam@"  @,
   @"Secondparam@" @,
   @"thirdparam@" @)
</PRE>

<P>This syntax was cleaned up considerably in V3.0 by making
the <SAMP>@"</SAMP> symbols optional:

<P><PRE>
@&lt;Say Out@&gt;@(firstparam@,@-
Secondparam@,thirdparam@)
</PRE>


<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left"   VALIGN="bottom"><A HREF="design_indentation.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="design.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right"  VALIGN="bottom"><A HREF="design_structure.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
</TR>
</TABLE>



<P>
<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>&nbsp;&nbsp;&nbsp;
<A HREF="copyright.html">Copyright &copy; 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>