File: interface_inheritance.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 (277 lines) | stat: -rw-r--r-- 9,587 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
273
274
275
276
277

<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 File Name Inheritance</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="../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="../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>Reference</B></FONT></A><BR>
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
<A HREF="interface.html"><FONT COLOR="#FFFFFF">2 Interface</FONT></A><BR>
<A HREF="scanner.html"><FONT COLOR="#FFFFFF">3 Scanner</FONT></A><BR>
<A HREF="parser.html"><FONT COLOR="#FFFFFF">4 Parser</FONT></A><BR>
<A HREF="analyser.html"><FONT COLOR="#FFFFFF">5 Analyser</FONT></A><BR>
<A HREF="tangle.html"><FONT COLOR="#FFFFFF">6 Tangle</FONT></A><BR>
<A HREF="weave.html"><FONT COLOR="#FFFFFF">7 Weave</FONT></A><BR>
<A HREF="shell.html"><FONT COLOR="#FFFFFF">8 Shell</FONT></A><BR>
<A HREF="commands.html"><FONT COLOR="#FFFFFF">9 Commands</FONT></A><BR>
<A HREF="glossary.html"><FONT COLOR="#FFFFFF">10 Glossary</FONT></A><BR>
<A HREF="references.html"><FONT COLOR="#FFFFFF">11 References</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 Reference Manual"
 HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">2.4 File Name Inheritance</FONT><BR>



<P>During a single run of FunnelWeb, FunnelWeb can produce
many different output files. As it would be very tedious to
have to specify the name of each of these files explicitly
each time FunnelWeb is run, FunnelWeb provides a system of
defaults that allows the user to specify the minimum
required to successfully complete the run. To do this,
FunnelWeb allows file specifications to inherit fields from
one another.

<P>FunnelWeb structures filenames into three
fields which are inherited
independently. The fields are: <STRONG>directory</STRONG>,
<STRONG>name</STRONG>, and <STRONG>extension</STRONG>. On
systems having other fields (e.g. <I>network node</I>&nbsp;,
<I>device name</I>&nbsp;), the extra fields are considered to be
part of the directory field. Version numbers are ignored. A
field can inherit a value if its current value is the empty
string.

<P>The following table gives the full inheritance scheme
used in FunnelWeb.

<P>
<TABLE BORDER="3">
<TR>
<TD><STRONG>Script</STRONG> </TD>
<TD> <STRONG>Input</STRONG> </TD>
<TD> <STRONG>Include</STRONG></TD>
<TD> <STRONG>Journal</STRONG></TD>
<TD>  <STRONG>List</STRONG>  </TD>
<TD> <STRONG>TeX</STRONG>     </TD>
<TD> <STRONG>HTML</STRONG>     </TD>
<TD> <STRONG>Prod</STRONG> </TD>
</TR>
<TR>
<TD>&nbsp;           </TD>
<TD> &nbsp;          </TD>
<TD> <SAMP>@i</SAMP>   </TD>
<TD> &nbsp;           </TD>
<TD> &nbsp;           </TD>
<TD> &nbsp;            </TD>
<TD> &nbsp;             </TD>
<TD> <SAMP>@o</SAMP> </TD>
</TR>
<TR>
<TD><SAMP>+x</SAMP>    </TD>
<TD> <SAMP>+f</SAMP>   </TD>
<TD> <SAMP>+i</SAMP>    </TD>
<TD> <SAMP>+j</SAMP>    </TD>
<TD> <SAMP>+l</SAMP>    </TD>
<TD> <SAMP>+t</SAMP>     </TD>
<TD> <SAMP>+u</SAMP>      </TD>
<TD> <SAMP>+o</SAMP>  </TD>
</TR>
<TR>
<TD>"<TT>.fws</TT>" </TD>
<TD> "<TT>.fw</TT>" </TD>
<TD> "<TT>.fwi</TT>" </TD>
<TD> "<TT>.jrn</TT>" </TD>
<TD> "<TT>.lis</TT>" </TD>
<TD> "<TT>.tex</TT>"  </TD>
<TD> "<TT>.html</TT>"  </TD>
<TD> &nbsp;         </TD>
</TR>
<TR>
<TD>&nbsp;           </TD>
<TD> &nbsp;          </TD>
<TD> <SAMP>+f</SAMP>    </TD>
<TD> <SAMP>+f</SAMP>    </TD>
<TD> <SAMP>+f</SAMP>    </TD>
<TD> <SAMP>+f</SAMP>     </TD>
<TD> <SAMP>+f</SAMP>      </TD>
<TD> &nbsp;         </TD>
</TR>
<TR>
<TD>DefDir          </TD>
<TD> Defdir         </TD>
<TD> Defdir          </TD>
<TD> Defdir          </TD>
<TD> Defdir          </TD>
<TD> Defdir           </TD>
<TD> Defdir            </TD>
<TD> Defdir        </TD>
</TR>
</TABLE>

<P>The table is arranged with items of highest priority at
the top. The "<TT>+<letter></TT>" cells refer to the file
specification supplied in the given command line argument.
"<TT>+F</TT>" is the name of the input file.
"Defdir" refers to the default directory
specification provided by the operating system. Empty cells
do not contribute.

<P>The following example shows how the table is used.
Suppose that the user invoked FunnelWeb as
follows:

<P>
<PRE>
fw /usr/ross/work/sloth.fw +twalrus
</PRE>

<P>To work out what the documentation file should be
called, FunnelWeb starts with the empty string and then
works down the Document column of the table. The top entry
is empty so we ignore it and proceed to the second entry
which consists of "<TT>+T</TT>". The user specified the
string "<TT>walrus</TT>" as the value of this option, and as
our current (empty) string does not have a name field, we
insert the string "<TT>walrus</TT>" into the name field,
resulting in the string "<TT>walrus</TT>". Moving down to
the next row, we encounter the constant string
"<TT>.tex</TT>". This string consists of an empty directory
and name field, but a "<TT>.tex</TT>" file extension. As our
current string "<TT>walrus</TT>", does not already have a
file extension (i.e. the file extension field of our
current string is empty), we add in "<TT>.tex</TT>",
resulting in the string "<TT>walrus.tex</TT>". Next we
encounter the "<TT>+F</TT>" field which is the input
filename "<TT>/usr/ross/work/sloth.fw</TT>" consisting of a
directory field "<TT>/usr/ross/work/</TT>", a name field
"<TT>sloth</TT>", and a file extension field "<TT>.fw</TT>".
Our "<TT>walrus.tex</TT>" string already has name and file
extension fields, but its directory field is empty, and so
we add in the directory field from the input file
specification, resulting in the string
"<TT>/usr/ross/work/walrus.tex</TT>". Finally, we hit the
default directory specification, which is (say)
"<TT>/usr/ross/play/</TT>". However, as the directory field
of our walrus string is already full, it has no effect.

<P>In general, there is no need to remember the exact
details of FunnelWeb's filename inheritance. The important
thing is to know that it exists, and to use it.


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


</FONT>
</BODY>

<!-- *********************************************************************** -->
<!--      End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/)       -->
<!-- *********************************************************************** -->

</HTML>