File: macro_additive.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 (314 lines) | stat: -rw-r--r-- 9,352 bytes
parent folder | download | duplicates (5)

<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 Additive Macros</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">2.4 Additive Macros</FONT><BR>



<P>Sometimes it is convenient to build up the definition
of a macro in stages throughout the input file. In
FunnelWeb, this can be done using an <STRONG>additive
                                             macro</STRONG>. An additive macro is identical to an ordinary macro
except that

<P>
<OL>
<LI>  It has <SAMP>+=</SAMP> instead of <SAMP>==</SAMP>.
<LI>  It can be defined in one or more parts throughout the input file.
The definition of the macro is the concatenation of all the parts in the
order in which they appear.
</OL>

<P>The following example shows how additive macros can be
used to scatter and regroup information, in this case
assisting in the lucid construction of a data
abstraction in a language
(Pascal) that does not support them
explicitly.

<P>
<PRE>
@!******************************

@O@&lt;prog.pas@&gt;==@{@-
program adt(input,output);
@&lt;Types@&gt;
@&lt;Variables@&gt;
@&lt;Procedures@&gt;
begin startproc; end.
@}

@!******************************

@$@&lt;Types@&gt;+=@{@-
type buffer_type =
   record
   length : integer;
   buf : array[1..100] of char;
   end;
@}

@$@&lt;Variables@&gt;+=@{@-
bigbuf : buffer_type;
@}

@$@&lt;Procedures@&gt;+=@{@-
procedure buf_init (var b : buffer_type               )
   {Body of buf_init}
procedure buf_add  (var b : buffer_type;     ch : char)
   {Body of buf_add}
procedure buf_get  (var b : buffer_type; var ch : char)
   {Body of buf_get}
@}

@!******************************

@$@&lt;Types@&gt;+=@{@-
type complex_type = record r,i : real; end;
@}

@$@&lt;Procedures@&gt;+=@{@-
procedure cm_set (var c: complex_type; a,b: real)
   {Body of cm_set}
procedure cm_add (a,b: complex_type; var c: complex_type)
   {Body of cm_add}
{Other procedures and functions}
@}

@!******************************

{...more pieces of program...}

@!******************************
</PRE>

<P>It is important to remember that the definition of each
macro does not change throughout the input file. FunnelWeb
parses the entire input file and assembles all the macro
definitions before it even starts to expand macros. As a
result, each additive macro can only have one definition,
and that definition is the concatenation of all its parts.

<P>The example above shows how additive macros can be used
to rearrange the presentation of a computer program in the
order in which the user wishes to discuss it rather than the
order in which the compiler requires that it be consumed. It
is easy, however, to abuse the feature of additive macros.
In many cases, the same effect can be obtained more clearly
by replacing each part of an additive macro in-situ using
uniquely named non-additive macros, and then collect them
together as a group at the point where the additive macro is
called. Doing this is more work, and is more error prone,
but can result in a clearer exposition. The following
program illustrates this alternative approach.

<P>
<PRE>
@!******************************

@O@&lt;prog.pas@&gt;==@{@-
program adt(input,output);
@&lt;Types@&gt;
@&lt;Variables@&gt;
@&lt;Procedures@&gt;
begin startproc; end.
@}

@$@&lt;Types@&gt;==@{@-
@&lt;Buffer type@&gt;
@&lt;Complex type@&gt;
@}

@$@&lt;Variables@&gt;==@{@-
@&lt;Buffer variable@&gt;
@}

@$@&lt;Procedures@&gt;==@{@-
@&lt;Buffer procedures@&gt;
@&lt;Complex procedures@&gt;
@}

@!******************************

@$@&lt;Buffer type@&gt;==@{@-
type buffer_type = record
                   length : integer;
                   buf : array[1..100] of char;
                   end;
@}

@$@&lt;Buffer variable@&gt;==@{@-
bigbuf : buffer_type;
@}

@$@&lt;Buffer procedures@&gt;==@{@-
procedure buf_init(var b : buffer_type)
   {Body of buf_init}
procedure buf_add(var b : buffer_type; ch : char)
   {Body of buf_add}
procedure buf_get(var b : buffer_type; var ch : char)
   {Body of buf_get}
@}

@!******************************

@$@&lt;Complex type@&gt;==@{@-
type complex_type = record r,i : real; end;
@}

@$@&lt;Complex procedures@&gt;+=@{@-
procedure cm_set(var c: complex_type; a,b : real)
   {Body of cm_set}
procedure cm_add(a,b : complex_type; var c: complex_type)
   {Body of cm_add}
{Other procedures and functions}
@}

@!******************************

{...more pieces of program...}

@!******************************
</PRE>

<P>One of advantages of FunnelWeb (and literate
programming in general) is that (as shown above) it allows
the user to lay out the program in whatever order is
desired with near total
independence from the ordering requirements of the target
programming language.

<P>Additive macros are allowed to be tagged with
<SAMP>@Z</SAMP> and <SAMP>@M</SAMP> just as other macros can,
but the tags must appear only on the first definition of the
macro. Additive macros cannot be connected directly to
product files.


<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left"   VALIGN="bottom"><A HREF="macro_indent.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="macro.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right"  VALIGN="bottom"><A HREF="macro_param.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>&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>