home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d848 / cweb.lha / CWeb / CWeb27.lha / cwebman.tex (.txt) < prev    next >
Encoding:
Texinfo Document  |  1993-03-13  |  62.8 KB  |  1,166 lines

  1. \input cwebmac
  2. \parskip 0pt plus 1pt
  3. \def\RA{\char'31 } % right arrow
  4. \def\hang{\hangindent 4em\ignorespaces}
  5. \font\eightrm=cmr8
  6. \font\ninerm=cmr9
  7. \font\ninett=cmtt9
  8. \font\eighttt=cmtt8
  9. \def\Pascal{Pascal}
  10. \font\quoterm=cmssq8
  11. \font\quoteit=cmssqi8
  12. \def\pb{\.{|...|}}
  13. \def\v{\.{\char'174}} % vertical (|) in typewriter font
  14. \def\lpile{\def\cr{\hfill\endline}\matrix} % I only use \lpile by itself
  15. \abovedisplayskip=.5\abovedisplayskip
  16. \belowdisplayskip=.5\belowdisplayskip
  17. \abovedisplayshortskip=.5\abovedisplayshortskip
  18. \belowdisplayshortskip=.5\belowdisplayshortskip
  19. \advance\pageheight by \baselineskip % the manual just got a bit longer
  20. \advance\fullpageheight by \baselineskip
  21. \setpage
  22. \outer\def\section #1.{\penalty-50\vskip 6pt plus 3pt minus 3pt
  23.   \noindent{\bf #1.}\quad\ignorespaces}
  24. \def\lheader{\mainfont\the\pageno\hfill\sc\runninghead\hfill}
  25. \def\rheader{\hfill\sc\runninghead\hfill\mainfont\the\pageno}
  26. \def\runninghead{{\tentt CWEB} USER MANUAL}
  27. % This verbatim mode assumes that ! marks are !! in the text being copied.
  28. \def\verbatim{\begingroup
  29.   \def\do##1{\catcode`##1=12 } \dospecials
  30.   \parskip 0pt \parindent 0pt \let\!=!
  31.   \catcode`\ =13 \catcode`\^^M=13
  32.   \tt \catcode`\!=0 \verbatimdefs \verbatimgobble}
  33. {\catcode`\^^M=13{\catcode`\ =13\gdef\verbatimdefs{\def^^M{\ \par}\let =\ }} %
  34.   \gdef\verbatimgobble#1^^M{}}
  35. \null\vfill
  36. \noindent
  37. Copyright \copyright\ 1987,\thinspace1990 Silvio Levy and Donald E. Knuth
  38. \bigskip\noindent
  39. Permission is granted to make and distribute verbatim copies of this
  40. document provided that the copyright notice and this permission notice
  41. are preserved on all copies.
  42. \smallskip\noindent
  43. Permission is granted to copy and distribute modified versions of this
  44. document under the conditions for verbatim copying, provided that the
  45. entire resulting derived work is distributed under the terms of a
  46. permission notice identical to this one.
  47. \pageno=0 \titletrue\eject
  48. \centerline{\titlefont The {\ttitlefont CWEB} System of
  49.     Structured Documentation}
  50. \vskip 15pt plus 3pt minus 3pt
  51. \noindent
  52. This document describes a version of Don Knuth's \.{WEB} system,
  53. adapted to \Cee\ by Silvio Levy.  Knuth's original Pascal programs have been
  54. entirely rewritten in \Cee; many changes were made to take
  55. advantage of features offered by \Cee\ but non-existent in \Pascal.
  56. Readers who are familiar with Knuth's memo ``The \.{WEB} System of Structured
  57. Documentation'' will be able
  58. to skim this material rapidly, because \.{CWEB} is essentially a
  59. simplified subset of \.{WEB}. \.{CWEB} does not need \.{WEB}'s features
  60. for macro definition and string handling, because \Cee\ and its
  61. preprocessor already take care of macros and strings. Similarly, the \.{WEB}
  62. conventions of denoting octal and hexadecimal constants by \.{@'77}
  63. and \.{@"3f} are replaced by \Cee's conventions \.{\v077\v} and
  64. \.{\v0x3f\v}, respectively. All other features of \.{WEB} have been
  65. retained, and a few new features have been added.
  66. \section Introduction.
  67. The philosophy behind \.{WEB} is
  68. that an experienced system programmer, who wants to provide the best
  69. possible documentation of software products, needs two things
  70. simultaneously:  a language like \TeX\ for formatting, and a language like
  71. \Cee\ for programming. Neither type of language can provide the
  72. best documentation by itself. But when both are appropriately combined, we
  73. obtain a system that is much more useful than either language separately.
  74. The structure of a software program may be thought of as a ``web'' that is
  75. made up of many interconnected pieces. To document such a program, we want
  76. to explain each individual part of the web and how it relates to its
  77. neighbors. The typographic tools provided by \TeX\ give us an opportunity
  78. to explain the local structure of each part by making that structure
  79. visible, and the programming tools provided by \Cee\ make it possible
  80. for us to specify the algorithms formally and unambiguously. By combining
  81. the two, we can develop a style of programming that maximizes our ability
  82. to perceive the structure of a complex piece of software, and at the same
  83. time the documented programs can be mechanically translated into a working
  84. software system that matches the documentation.
  85. The \.{WEB} system consists of two programs named \.{WEAVE} and \.{TANGLE}.
  86. More precisely, \.{CWEB} calls them \.{CWEAVE} and \.{CTANGLE}.
  87. When writing a \.{CWEB} program the user keeps the
  88. \Cee\ code and the documentation in the same file, called the \.{WEB}
  89. file and generally named \.{something.w}.  The command
  90. `\.{cweave something}' creates an output file \.{something.tex}, which
  91. can then be fed to \TeX, yielding a ``pretty printed'' version of
  92. \.{something.w} that correctly handles
  93. typographic details like page layout and the use of indentation,
  94. italics, boldface, and mathematical symbols. The typeset output also
  95. includes extensive cross-index
  96. information that is gathered automatically.  Similarly, if you run the
  97. command `\.{ctangle something}' you will get a \Cee\ file \.{something.c},
  98. with can then be compiled to yield executable code.
  99. Besides providing a documentation tool, \.{WEB} enhances the \Cee\
  100. language by providing the
  101. ability to permute pieces of the program text, so that a large system can
  102. be understood entirely in terms of small modules and their local
  103. interrelationships.  The \.{TANGLE} program is so named because it takes a
  104. given web and moves the modules from their web structure into the order
  105. required by \Cee; the advantage of programming in \.{WEB} is that the
  106. algorithms can be expressed in ``untangled'' form, with each module
  107. explained separately.  The \.{WEAVE} program is so named because it takes
  108. a given web and intertwines the \TeX\ and \Cee\ portions contained in
  109. each module, then it knits the whole fabric into a structured document.
  110. (Get it? Wow.)  Perhaps there is some deep connection here with the fact
  111. that the German word for ``weave'' is ``{\it web\/}'', and the
  112. corresponding Latin imperative is ``{\it texe\/}''!
  113. A user of \.{CWEB} should be fairly familiar with the \Cee\
  114. programming language.  A minimal amount of acquaintance with \TeX\ is also
  115. desirable, but in fact it can be acquired as one uses \.{WEB}, since
  116. straight text can be typeset in \TeX\ with virtually no knowledge of
  117. that language.  To someone familiar with both \Cee\ and \TeX\ the amount of
  118. effort necessary to learn the commands of \.{WEB} is small.
  119. \section The language.
  120. Two kinds of material go into \.{WEB} files: \TeX\ text and \Cee\ text.
  121. A programmer writing in \.{WEB} should be thinking both of the
  122. documentation and of the \Cee\ program being created;
  123. i.e., the programmer should be instinctively aware of the different
  124. actions that \.{WEAVE} and \.{TANGLE} will perform on the \.{WEB} file.
  125. \TeX\ text is essentially copied without change by \.{WEAVE}, and it is
  126. entirely deleted by \.{TANGLE}; the \TeX\ text is ``pure
  127. documentation.'' \Cee\ text, on the other hand, is formatted by
  128. \.{WEAVE} and it is shuffled around by \.{TANGLE}, according to rules that
  129. will become clear later. For now the important point to keep in mind is
  130. that there are two kinds of text. Writing \.{WEB} programs is something
  131. like writing \TeX\ documents, but with an additional ``\Cee\ mode''
  132. that is added to \TeX's horizontal mode, vertical mode, and math mode.
  133. A \.{WEB} file is built up from units called {\sl modules\/} that are more
  134. or less self-contained.  Each module has three parts:
  135. \yskip\item{1)} A \TeX\ part, containing explanatory material about what
  136. is going on in the module.
  137. \item{2)} A definition part, containing macro definitions that serve as
  138. abbreviations for \Cee\ constructions that would be less comprehensible
  139. if written out in full each time. They are turned by \.{TANGLE} into
  140. preprocessor macro definitions.
  141. \item{3)} A \Cee\ part, containing a piece of the program that
  142. \.{TANGLE} will produce. This \Cee\ code should ideally be about a
  143. dozen lines long, so that it is easily comprehensible as a unit and so
  144. that its structure is readily perceived.
  145. \yskip\noindent The three parts of each module must appear in this order;
  146. i.e., the \TeX\ commentary must come first, then the definitions, and
  147. finally the \Cee\ code. Any of the parts may be empty.
  148. A module begins with either of the symbols `\.{@\ }' or `\.{@*}', where
  149. `\.{\ }' denotes a blank space. A module ends
  150. at the beginning of the next module (i.e., at the next
  151. `\.{@\ }' or `\.{@*}'), or at the end of the file, whichever comes first.
  152. The \.{WEB} file may also contain material that is not part of any module
  153. at all, namely the text (if any) that occurs before the first module.
  154. Such text is said to be ``in limbo''; it is ignored by \.{TANGLE}
  155. and copied essentially verbatim by \.{WEAVE}, so its function is to
  156. provide any additional formatting instructions that may be desired in the
  157. \TeX\ output. Indeed, it is customary to begin a \.{WEB} file with
  158. \TeX\ code in limbo that loads special fonts, defines special macros,
  159. changes the page sizes, and/or produces a title page.
  160. Modules are numbered consecutively, starting with 1. These numbers appear
  161. at the beginning of each module of the \TeX\ documentation output by
  162. \.{WEAVE}, and they appear
  163. as bracketed comments at the beginning and end of the code generated by that
  164. module in the \Cee\ program output by \.{TANGLE}.
  165. Fortunately, you never mention these numbers yourself when you are writing
  166. in \.{WEB}. You just say `\.{@\ }' or `\.{@*}' at the beginning of each
  167. new module, and the numbers are supplied automatically by \.{WEAVE} and
  168. \.{TANGLE}. As far as you are concerned, a module has a
  169. {\sl name\/} instead of a number; its name is specified by writing
  170. `\.{@<}' followed by \TeX\ text followed by `\.{@>}'. When \.{WEAVE}
  171. outputs a module name, it replaces the `\.{@<}' and `\.{@>}' by
  172. angle brackets and inserts the module number in small type. Thus, when you
  173. read the output of \.{WEAVE} it is easy to locate any module that is
  174. referred to in another module.
  175. For expository purposes, a module name should be a good description of the
  176. contents of that module; i.e., it should stand for the abstraction
  177. represented by the module. Then the module can be ``plugged into'' one or
  178. more other modules in such a way
  179. that unimportant details of its inner workings
  180. are suppressed.  A module name therefore ought to be long enough to convey
  181. the necessary meaning. Unfortunately, however, it is laborious to type
  182. such long names over and over again, and it is also difficult to specify a
  183. long name twice in exactly the same way so that \.{WEAVE} and \.{TANGLE}
  184. will be able to match the names to the modules. To ameliorate this difficulty,
  185. \.{WEAVE} and \.{TANGLE} let you abbreviate a module name
  186. after its first appearance in the \.{WEB} file; you can type simply
  187. `\.{@<$\alpha$...@>}', where $\alpha$ is any string that is a prefix of
  188. exactly one module name appearing in the file. For example, `\.{@<Clear
  189. the arrays@>}' can be abbreviated to `\.{@<Clear...@>}' if no other module
  190. name begins with the five letters `\.{Clear}'. Module names must otherwise
  191. match character for character, except that consecutive blank spaces and/or
  192. tab marks are treated as equivalent to single spaces, and such spaces are
  193. deleted at the beginning and end of the name. Thus, `\.{@< Clear { }the
  194. arrays @>}' will also match the name in the previous example.
  195. We have said that a module begins with `\.{@\ }' or `\.{@*}', but we
  196. didn't say how it gets divided up into a \TeX\ part, a definition part,
  197. and a \Cee\ part. The definition part begins with the first appearance
  198. of `\.{@d}' or `\.{@f}' in the module, and the \Cee\ part begins with
  199. the first appearance of `\.{@c}' or `\.{@<}'. The latter option `\.{@<}'
  200. stands for the beginning of a module name, which is the name of the module
  201. itself. An equals sign (\.=) must follow the `\.{@>}' at the end of this
  202. module name; you are saying, in effect, that the module name stands for
  203. the \Cee\ text that follows, so you say `$\langle\,$module
  204. name$\,\rangle=\null$\Cee\ text'. Alternatively, if the \Cee\ part
  205. begins with `\.{@c}' instead of a module name, the current module is said
  206. to be {\sl unnamed}. Note that module names cannot appear in the
  207. definition part of a module, because the first `\.{@<}' in a module
  208. signals the beginning of its \Cee\ part.  But any number of module names
  209. might appear in the \Cee\ part, once it has started.
  210. The general idea of \.{TANGLE} is to make a \Cee\ program out of these
  211. modules in the following way: First all the macro definitions
  212. indicated by `\.{@d}' are turned into \Cee\ preprocessor macro definitions
  213. and copied at the beginning.
  214. Then the \Cee\ parts of unnamed modules are copied down,
  215. in order; this constitutes the initial
  216. approximation $T_0$ to the text of the program. (There should be at least
  217. one unnamed module, otherwise there will be no program.) Then all module
  218. names that appear in the initial text $T_0$ are replaced by the \Cee\
  219. parts of the corresponding modules, and this substitution process
  220. continues until no module names remain. All comments are removed, because
  221. the \Cee\ program is intended only for the eyes of the \Cee\ compiler.
  222. If the same name has been given to more than one module, the \Cee\ text
  223. for that name is obtained by putting together all of the \Cee\ parts in
  224. the corresponding modules. This feature is useful, for example, in a
  225. module named `Global variables in the outer block', since one can then
  226. declare global variables in whatever modules those variables are
  227. introduced. When several modules have the same name, \.{WEAVE} assigns the
  228. first module number as the number corresponding to that name, and it
  229. inserts a note at the bottom of that module telling the reader to `See
  230. also sections so-and-so'; this footnote gives the numbers of all the other
  231. modules having the same name as the present one. The \Cee\ text
  232. corresponding to a module is usually formatted by \.{WEAVE} so that the
  233. output has an equivalence sign in place of the equals sign in the \.{WEB}
  234. file; i.e., the output says `$\langle\,$module
  235. name$\,\rangle\equiv\null$\Cee\ text'. However, in the case of the second
  236. and subsequent appearances of a module with the same name, this `$\equiv$'
  237. sign is replaced by `$\mathrel+\equiv$', as an indication that the 
  238. following \Cee\ text is being appended to the \Cee\ text of another module.
  239. As \.{TANGLE} enters and leaves modules, it insert preprocessor
  240. \.{\#line} commands into the \Cee\ output file.  This means that
  241. when the compiler gives you error messages, or when you debug your program,
  242. the messages refer to line numbers in the \.{WEB} file, and not in the
  243. \Cee\ file.  In most cases you can therefore
  244. forget about the \Cee\ file altogether.
  245. The general idea of \.{WEAVE} is to make a \.{TEX} file from the \.{WEB}
  246. file in the following way: The first line of the \.{TEX} file
  247. tells \TeX\ to input a file with macros that
  248. define \.{CWEB}'s documentation conventions. The next lines of the file
  249. will be copied from whatever \TeX\ text is in limbo before the first
  250. module.  Then comes the output for each module in turn, possibly
  251. interspersed with end-of-page marks.  Finally, \.{WEAVE} will generate a
  252. cross-reference index that lists each module number in which each \Cee\
  253. identifier appears, and it will also generate an alphabetized list
  254. of the module names, as well as a table of contents that
  255. shows the page and module numbers for each ``starred'' module.
  256. What is a ``starred'' module, you ask? A module that begins with `\.{@*}'
  257. instead of `\.{@\ }' is slightly special in that it denotes a new major
  258. group of modules. The `\.{@*}' should be followed by the title of this
  259. group, followed by a period. Such modules will always start on a new page
  260. in the \TeX\ output, and the group title will appear as a running headline
  261. on all subsequent pages until the next starred module. The title will also
  262. appear in the table of contents, and in boldface type at the beginning of
  263. its module. Caution:  Do not use \TeX\ control sequences in such titles,
  264. unless you know that the \.{cwebmac} macros will do the right thing with
  265. them. The reason is that these titles are converted to uppercase when
  266. they appear as running heads, and they are converted to boldface when they
  267. appear at the beginning of their modules, and they are also written out to
  268. a table-of-contents file used for temporary storage while \TeX\ is
  269. working; whatever control sequences you use must be meaningful in all
  270. three of these modes.
  271. The \TeX\ output produced by \.{WEAVE} for each module consists of
  272. the following: First comes the module number (e.g., `\.{\\M123.}'
  273. at the beginning of module 123, except that `\.{\\N}' appears in place of
  274. `\.{\\M}' at the beginning of a starred module). Then comes the
  275. \TeX\ part of the module, copied almost verbatim except as noted
  276. below. Then comes the definition part and the \Cee\ part, formatted
  277. so that there will be a little extra space between them if both are
  278. nonempty. The definition and \Cee\ parts are obtained by inserting
  279. a bunch of funny looking \TeX\ macros into the \Cee\ program; these
  280. macros handle typographic details about fonts and proper math spacing,
  281. as well as line breaks and indentation.
  282. When you are typing \TeX\ text, you will probably want to make frequent
  283. reference to variables and other quantities in your \Cee\ code, and you
  284. will want those variables to have the same typographic treatment
  285. when they appear in your text as when they appear in your
  286. program.  Therefore the \.{WEB} language allows you to get the effect of
  287. \Cee\ editing within \TeX\ text, if you place `\.|' marks before and
  288. after the \Cee\ material. For example, suppose you want to say something
  289. like this:
  290. $$\hbox{ If \\{pa} is declared as `\&{int} ${}{*}\\{pa}$',
  291. the assignment $\\{pa}\K{\AND}\|a[\T{0}]$ makes \\{pa}
  292. point to the zeroth element of \|a.}$$
  293. The \TeX\ text would look like this in your \.{WEB} file:
  294. $$\lpile{\.{If |pa| is declared as `|int *pa|', the}\cr
  295. \.{assignment |pa=\&a[0]| makes |pa| point
  296. to the zeroth element of |a|.}\cr}$$
  297. And \.{WEAVE} translates this into something you are glad you didn't have
  298. to type:
  299. $$\lpile{\.{If \\\\\{pa\} is declared as
  300.   `\\\&\{int\} \$\{\}\{*\}\\\\\{pa\}\$',}\cr
  301. \.{the assignment \$\\\\\{pa\}\\K\{\\AND\}\\|a[\\T\{0\}]\$}\cr
  302. \.{makes \\\\\{pa\} point to the zeroth element of \\|a.}\cr}$$
  303. Incidentally, the cross-reference index that \.{WEAVE} would make, in
  304. the presence of a comment like this, would include
  305. the current module number as one of the index entries for \\{pa},
  306. even though \\{pa} might not appear in the \Cee\ part of
  307. this module. Thus, the index covers references to identifiers in
  308. the explanatory comments as well as in the program itself; you will
  309. soon learn to appreciate this feature. However, the identifiers
  310. \&{int} and \|a\ would not be indexed,
  311. because \.{WEAVE} does not make index entries for reserved words or
  312. single-letter identifiers. Such identifiers are felt to be so ubiquitous
  313. that it would be pointless to mention every place where they occur.
  314. Although a module begins with \TeX\ text and ends with \Cee\ text, we
  315. have noted that the dividing line isn't sharp, since \Cee\ text can be
  316. included in \TeX\ text if it is enclosed in `\pb'.  Conversely, \TeX\ text
  317. also appears frequently within \Cee\ text, because everything in
  318. comments (i.e., between \.{/*} and \.{*/}) is treated as \TeX\ text.
  319. Furthermore, a module name consists of \TeX\ text; thus, a \.{WEB} file
  320. typically involves constructions like `\.{if} \.{(x==0)}
  321. \.{@<Empty} \.{the} \.{|buffer|} \.{array@>}' where we go back and forth
  322. between \Cee\ and \TeX\ conventions in a natural way.
  323. \section Macros.
  324. The control code \.{@d} followed by
  325. $$\\{identifier}\.{ }\hbox{\Cee\ text}\qquad\hbox{or by}\qquad
  326. \\{identifier}\.(\\{par}_1,\ldots,\\{par}_n\.{) }\hbox{\Cee\ text}$$
  327. (where there is no blank between the
  328. \\{identifier} and the parentheses in the second case) is
  329. transformed by \.{TANGLE} into a preprocessor command, starting with
  330. \.{\#define}, which is printed at the top of the \Cee\ output file
  331. as explained earlier.
  332. A `\.{@d}' macro definition can go on for several lines, and the
  333. newlines don't have to be protected by backslashes, since \.{TANGLE}
  334. itself inserts the backslashes.   If
  335. for any reason you need a \.{\#define} command at a specific spot in
  336. your \Cee\ file, you can treat it as \Cee\ code, instead of as a
  337. \.{WEB} macro; but then you do have to protect newlines yourself.
  338. \section Strings and constants.
  339. If you want a string to appear in the \Cee\ file, delimited by pairs of
  340. \.' or \." marks as usual, you can type it exactly so in the \.{WEB} file,
  341. except that the character `\.@' should be typed `\.{@@}' (it becomes a
  342. control code, the only one that can appear in strings; see below).
  343. Strings should end on the same line as they begin, unless there's a
  344. backslash at the end of lines within them.
  345. \TeX\ and \Cee\ have different ways to refer to octal and hex constants,
  346. because \TeX\ is oriented to technical writing while \Cee\ is oriented to
  347. computer processing.  In \TeX\ you
  348. make a constant octal or hexadecimal by prepending \.' or \.",
  349. respectively, to it; in \Cee\ the constant should be preceded by \.0
  350. or \.{0x}.  In \.{WEB} it seems reasonable to let each convention hold
  351. in its respective realm; so in \Cee\ text you get $40_8$ by typing
  352. `\.{040}', which \.{TANGLE} faithfully copies into the \Cee\ file (for
  353. the compiler's benefit) and which \.{WEAVE} prints as $\T{\~40}$.
  354. Similarly, \.{WEAVE} prints the hexadecimal \Cee\ constant `\.{0x20}'
  355. as \T{\^20}. The use of italic font for octal digits and typewriter font
  356. for hexadecimal digits makes the meaning of such constants clearer in
  357. a document. For consistency, then, you
  358. should type `\.{|040|}'  or `\.{|0x20|}'
  359. in the \TeX\ part of the module.
  360. \section Control codes.
  361. A \.{WEB} {\sl control code\/}
  362. is a two-character combination of which the first is `\.@'.
  363. We've already seen the meaning of several control codes; here is a
  364. complete list of all of them.
  365. The letters $L$, $T$,
  366. $C$, $M$, $\\{Co}$, and/or $S$ following each code indicate whether or not that
  367. code is allowable in limbo, in \TeX\ text, in \Cee\ text, in module
  368. names, in comments, and/or in strings.  A bar over such a letter means
  369. that the control code terminates the present part of the \.{WEB} file; for
  370. example, $\overline L$ means that this control code ends the limbo material
  371. before the first module.
  372. \gdef\@#1[#2] {\penalty-100\yskip\hangindent 2em\noindent\.{@#1\unskip
  373.   \spacefactor1000{ }}$[#2]$\quad}
  374. \def\more{\hangindent 2em \hangafter0}
  375. \def\oP{\overline C}
  376. \def\oT{\overline T\mskip1mu}
  377. \@@ [\\{Co},L,M,C,S,T] A double \.@ denotes the single character `\.@'. This is
  378. the only control code that is legal in limbo, in comments, and in strings.
  379. Note that you must use this convention if you are giving an internet
  380. email address in a \.{WEB} file (e.g., \.{levy@@math.berkeley.edu}).
  381. \@\ [\overline L,\oP,\oT] This denotes the beginning of a new
  382. (unstarred) module. A tab mark or form feed or end-of-line character
  383. is equivalent to a space when it follows an \.@ sign (and in most
  384. other cases).
  385. \@* [\overline L,\oP,\oT] This denotes the beginning of a new starred
  386. module, i.e., a module that begins a new major group. The title of the new
  387. group should appear after the \.{@*}, followed by a period. As explained
  388. above, \TeX\ control sequences should be avoided in such titles unless
  389. they are quite simple. When \.{WEAVE} and \.{TANGLE} read a \.{@*}, they
  390. print an asterisk on the terminal
  391. followed by the current module number, so that the user
  392. can see some indication of progress. The very first module should be starred.
  393. \@d [\oP,\oT] Macro definitions begin with \.{@d} (or \.{@D}), followed by
  394. an identifier and optional parameters and \Cee\ text as explained earlier.
  395. \@f [\oP,\oT] Format definitions begin with \.{@f} (or \.{@F}); they cause
  396. \.{WEAVE} to treat identifiers in a special way when they appear in
  397. \Cee\ text. The general form of a format definition is `\.{@f} \|l
  398. \|r', followed by an optional comment enclosed between
  399. \.{/*} and \.{*/}, where \|l and \|r
  400. are identifiers; \.{WEAVE} will subsequently treat identifier \|l as it
  401. currently treats \|r. This feature allows a \.{WEB} programmer to invent
  402. new reserved words and/or to unreserve some of \Cee's reserved
  403. identifiers. If \|r is the special identifier `\\{TeX}', identifier \|l
  404. will be formatted as a \TeX\ control sequence; for example,
  405. `\.{@f foo TeX}' in the \.{WEB} file will cause identifier \\{foo} to
  406. be output as \.{\\foo} by \.{WEAVE}. The programmer should define
  407. \.{\\foo} to have whatever custom format is desired, assuming \TeX\
  408. math mode. (Each underline
  409. character is converted to \.{x} when making the \TeX\ control sequence;
  410. thus \\{foo\_bar} becomes \.{\\fooxbar}.)
  411. \@s [\oP,\oT] Same as \.{@f}, but \.{WEAVE} does not show the format
  412. definition in the output. This is used mostly in \.{@i} files.
  413. \more \.{WEAVE} knows that identifiers being
  414. defined with a \&{typedef} should become reserved words; thus you
  415. don't need format definitions very often.
  416. The definition part of each module consists of any number of
  417. macro definitions (beginning with \.{@d}) and format definitions (beginning
  418. with \.{@f} or \.{@s}), intermixed in any order.
  419. \@c [\oP,\oT] The \Cee\ part of an unnamed module begins with \.{@c}
  420. (or \.{@C}). This causes \.{TANGLE} to append the following \Cee\ code
  421. to the initial program text $T_0$ as explained above. The \.{WEAVE}
  422. processor does not cause a `\.{@c}' to appear explicitly in the \TeX\
  423. output, so if you are creating a \.{WEB} file based on a \TeX-printed
  424. \.{WEB} documentation you have to remember to insert \.{@c} in the
  425. appropriate places of the unnamed modules.
  426. \@p [\oP,\oT] The \Cee\ part of an unnamed module may alternatively begin
  427. with \.{@p} (or \.{@P}), for compatibility with other \.{WEB} systems.
  428. \.{CWEB} treats \.{@c} and \.{@p} identically.
  429. \more Because of the rules by which every module is broken into three parts,
  430. the control codes `\.{@d}', `\.{@f}', `\.{@c}', and `\.{@p}'
  431. are not allowed to occur once the \Cee\ part of a module has begun.
  432. \@< [C,\oT] A module name begins with \.{@<} followed by \TeX\ text followed
  433. by \.{@>}. The \TeX\ text should not contain any \.{WEB} control codes
  434. except \.{@@}, unless these control codes appear in \Cee\ text that
  435. is delimited by \pb. The module name may be abbreviated, after its first
  436. appearance in a \.{WEB} file, by giving any unique prefix followed by \.{...},
  437. where the three dots immediately precede the closing \.{@>}. Module names may
  438. not appear in \Cee\ text that is enclosed in \pb, nor may they appear
  439. in the definition part of a module (since the appearance of a module name
  440. ends the definition part and begins the \Cee\ part).
  441. \@' [C] This control code is dangerous because it has quite different
  442. meanings in \.{CWEB} and the original \.{WEB}. In \.{CWEB} it produces the
  443. decimal constant corresponding to the ASCII code for a string of length~1
  444. (e.g., \.{@'a'} is \.{TANGLE}d into \.{97} and \.{@'\\t'} into
  445. \.9). You might want to use this if you need to work in ASCII on a
  446. non-ASCII machine; but in most cases the \Cee\ conventions of
  447. \.{<ctype.h>} are adequate for character-set-independent programming.
  448. \@\& [C] The \.{@\&} operation causes whatever is on its left to be
  449. adjacent to whatever is on its right, in the \Cee\ output. No spaces or
  450. line breaks will separate these two items.
  451. \@\^ [C,T] The ``control text'' that follows, up to the next
  452. `\.{@>}', will be entered into the index together with the identifiers of
  453. the \Cee\ program; this text will appear in roman type. For example, to
  454. put the phrase ``system dependencies'' into the index, type
  455. `\.{@\^system dependencies@>}' in each module
  456. that you want to index as system dependent. A control text
  457. must end on the same line of the \.{WEB} file as it began.  Furthermore,
  458. no \.{WEB} control codes are allowed in a control text, not even
  459. \.{@@}. (If you need an \.{@} sign you can get around this restriction by
  460. typing `\.{\{\\AT\}}'.)
  461. \@. [C,T] The ``control text'' that follows will be entered into the index
  462. in \.{typewriter} \.{type}; see the rules for `\.{@\^}', which is analogous.
  463. \@: [C,T] The ``control text'' that follows will be entered into the index
  464. in a format controlled by the \TeX\ macro `\.{\\9}', which the user
  465. should define as desired; see the rules for `\.{@\^}', which is analogous.
  466. \@t [C] The ``control text'' that follows, up to the next `\.{@>}', will
  467. be put into a \TeX\ \.{\\hbox} and formatted along with the neighboring
  468. \Cee\ program. This text is ignored by \.{TANGLE}, but it can be used
  469. for various purposes within \.{WEAVE}. For example, you can make comments
  470. that mix \Cee\ and classical mathematics, as in `$\\{size}<2^{15}$', by
  471. typing `\.{|size < @t\$2\^\{15\}\$@>|}'.  A control text must end on the
  472. same line of the \.{WEB} file as it began, and it may not contain any
  473. \.{WEB} control codes.
  474. \@= [C] The ``control text'' that follows, up to the next `\.{@>}', will
  475. be passed verbatim to the \Cee\ program.
  476. \@q [C,T] The ``control text'' text that follows, up to the next `\.{@>}', will
  477. be totally ignored; it's a comment for readers of the \.{WEB} file only.
  478. \@! [C,T] The module number in an index entry will be underlined if `\.{@!}'
  479. immediately precedes the identifier or control text being indexed. This
  480. convention is used to distinguish the modules where an identifier is
  481. defined, or where it is explained in some special way, from the modules
  482. where it is used. A~reserved word or an identifier of length one will not
  483. be indexed except for underlined entries. An `\.{@!}' is implicitly inserted
  484. by \.{WEAVE} when an identifier is being defined or declared in \Cee\
  485. code; for example, the definition 
  486. $$\hbox{\&{int} \\{array}[\\{max\_dim}], \\{count}${}=\\{old\_count};$}$$
  487. makes the names \\{array} and \\{count} get an underlined entry in the
  488. index.  Statement tags, function definitions like
  489. $\\{main}(\\{argc},\39\\{argv})$ and \&{typedef} definitions also
  490. imply underlining. A function definition doesn't define its arguments;
  491. \\{argc} and \\{argv} will, however, be defined
  492. (i.e., their index entries will be underlined), if their types are
  493. declared before the body of \\{main} (e.g., `\.{int}~\\{argc};
  494. \.{char}~${**}\\{argv}$; $\{\,\ldots\,\}$').
  495. \@, [C] This control code inserts a thin space in \.{WEAVE}'s output; it is
  496. ignored by \.{TANGLE}. Sometimes you need this extra space if you are using
  497. macros in an unusual way, e.g., if two identifiers are adjacent.
  498. \@/ [C] This control code causes a line break to occur within a \Cee\
  499. program formatted by \.{WEAVE}; it is ignored by \.{TANGLE}. Line breaks
  500. are chosen automatically by \TeX\ according to a scheme that works 99\%\
  501. of the time, but sometimes you will prefer to force a line break so that
  502. the program is segmented according to logical rather than visual
  503. criteria.
  504. \@| [C] This control code specifies an optional line break in the midst of
  505. an expression. For example, if you have
  506. a long expression on the right-hand side of an assignment
  507. statement, you can use `\.{@|}' to specify breakpoints more logical than
  508. the ones that \TeX\ might choose on visual grounds.
  509. \@\# [C] This control code forces a line break, like \.{@/} does,
  510. and it also causes a little extra white space to appear between the lines at
  511. this break. You might use it, for example,
  512. between groups of macro definitions that are logically separate but within
  513. the same module. \.{CWEB} automatically inserts this extra space
  514. between functions, between external declarations and functions, and
  515. between declarations and statements within a function.
  516. \@+ [C] This control code cancels a line break that might otherwise be
  517. inserted by \.{WEAVE}, e.g., before the word `\&{else}', if you want to
  518. put a short if--else construction on a single line. It is ignored by
  519. \.{TANGLE}. If you say `\.{\{@+}' at the beginning of a compound statement
  520. that is the body of a function, the first declaration or
  521. statement of the function will appear on the same line as the
  522. left brace, and it will be indented by the same amount as the
  523. second declaration or statement on the next line.
  524. \@; [C] This control code is treated like a semicolon, for formatting
  525. purposes, except that it is invisible. You can use it, for example, after
  526. a module name or macro when the \Cee\ text represented by that module or macro
  527. is a compound statement or ends
  528. with a semicolon. Consider constructions like
  529. $$\lpile{\.{if (condition) macro @;}\cr
  530. \.{else break;}\cr}$$
  531. here \\{macro} is defined to be a compound statement (enclosed in braces).
  532. This is a well-known infelicity of \Cee\ syntax.
  533. \@{[} [C] Place this before a macro argument that isn't otherwise formatted
  534. correctly.
  535. \@] [C] Place this after a macro argument that isn't otherwise formatted
  536. correctly.
  537. \yskip\noindent
  538. The last eight control codes (namely `\.{@,}', `\.{@/}', `\.{@|}', `\.{@\#}',
  539. `\.{@+}', `\.{@;}', `\.{@[}', and `\.{@]}') have no effect on the \Cee\
  540. program output by \.{TANGLE}; they merely help to improve the readability
  541. of the \TeX-formatted \Cee\ that is output by \.{WEAVE}, in unusual
  542. circumstances. \.{WEAVE}'s built-in formatting method is fairly good
  543. when dealing with syntactically correct \Cee\ text, but
  544. it is incapable of handling all possible cases, because it must deal with
  545. fragments of text involving macros and module names; these fragments do
  546. not necessarily obey \Cee's syntax. Although \.{WEB} allows you to
  547. override the automatic formatting, your best strategy is not to worry
  548. about such things until you have seen what \.{WEAVE} produces automatically,
  549. since you will probably need to make only a few corrections when you are
  550. touching up your documentation.
  551. \@{x @y @z}[\\{change\_file}]
  552. \.{WEAVE} and \.{TANGLE} are designed to work with two input files,
  553. called \\{web\_file} and \\{change\_file}, where \\{change\_file} contains
  554. data that overrides selected portions of \\{web\_file}. The resulting merged
  555. text is actually what has been called the \.{WEB} file elsewhere in this
  556. report.
  557. \more Here's how it works: The change file consists of zero or more ``changes,''
  558. where a change has the form `\.{@x}$\langle$old lines$\rangle$\.{@y}$\langle$%
  559. new lines$\rangle$\.{@z}'. The special control codes \.{@x}, \.{@y}, \.{@z},
  560. which are allowed only in change files, must appear at the beginning of a line;
  561. the remainder of such a line is ignored.
  562. The $\langle$old lines$\rangle$ represent material that exactly matches
  563. consecutive lines of the \\{web\_file}; the $\langle$new lines$\rangle$
  564. represent zero or more lines that are supposed to replace the old. Whenever
  565. the first ``old line'' of a change is found to match a line in the
  566. \\{web\_file}, all the other lines in that change must match too.
  567. \more Between changes, before the first change, and after the last change,
  568. the change file can have any number of lines that do not begin with
  569. `\.{@x}', `\.{@y}', or~`\.{@z}'. Such lines are bypassed and not used for
  570. matching purposes.
  571. \more This dual-input feature is useful when working with a master \.{WEB} file
  572. that has been received from elsewhere (e.g., \.{tangle.w} or
  573. \.{weave.w} or \.{tex.web}), when changes are desirable to customize the
  574. program for your local computer system. You will be able to debug your
  575. system-dependent changes without clobbering the master web file; and once
  576. your changes are working, you will be able to incorporate them readily
  577. into new releases of the master web file that you might receive from time
  578. to time.
  579. \@i [\\{web\_file}] Furthermore the \\{web\_file} itself can be a combination of
  580. several files.  When either \.{CWEAVE} or \.{CTANGLE} is reading a file and
  581. encounters the control code \.{@i} at the beginning of a line, it
  582. interrupts normal reading and start looking at the file named after the
  583. \.{@i}, much as the \Cee\ preprocessor does when it encounters an \.{\#include}
  584. line.  After the included file has been entirely read, the program
  585. goes back to the next line
  586. of the original file.  The file name following \.{@i} can be
  587. surrounded by \." characters, but such delimiters are
  588. optional. Include files can nest. Change files cannot use the \.{@i} feature.
  589. \@( [C,\oT] A module name can begin with \.{@(} instead of \.{@<}.
  590. Everything works exactly as before, except that \.{@(foo@>} denotes
  591. a special module name all of whose \Cee\ code is written by \.{CTANGLE}
  592. to file \.{foo}. In this way you can get multiple file output from
  593. a single \.{WEB} file. (The \.{@d} definitions are not output
  594. to such files, only to the master \.{.c} file.)
  595. \section Additional features and caveats.
  596. 1. In certain installations of \.{CWEB} that
  597. {\def\\#1#2{`{\tentex\char'#1#2}'}%
  598. have an extended character set, the characters
  599. \\13, \\01, \\31, \\32, \\34, \\35,
  600. \\36, \\37, \\04, \\20, and \\21}
  601. can be typed as abbreviations for `\.{++}', `\.{--}', `\.{->}',
  602. `\.{!=}', `\.{<=}', `\.{>=}', `\.{==}', `\.{\v\v}', `\.{\&\&}',
  603. `\.{<<}', and `\.{>>}',
  604. respectively.
  605. 2. If you have an extended character set, all of the characters listed
  606. in Appendix~C of {\sl The \TeX book\/} can be used in strings. But you should
  607. stick to standard ASCII characters if you want to write programs that will
  608. be useful to all the poor souls out there who don't have extended
  609. character sets.
  610. 3. The \TeX\ file output by \.{WEAVE} is broken into lines having at most
  611. 80 characters each. The algorithm that does this line breaking is unaware
  612. of \TeX's convention about comments following `\.\%' signs on a line. When
  613. \TeX\ text is being copied, the existing line breaks are copied as well,
  614. so there is no problem with `\.\%' signs unless the original \.{WEB} file
  615. contains a line more than eighty characters long or a line with \Cee\
  616. text in \pb\ that expands to more than eighty characters long. Such lines
  617. should not have `\.\%' signs.
  618. 4. \Cee\ text is translated by a ``bottom up'' procedure that
  619. identifies each token as a ``part of speech'' and combines parts of speech
  620. into larger and larger phrases as much as possible according to a special
  621. grammar that is explained in the documentation of \.{WEAVE}. It is easy to
  622. learn the translation scheme for simple constructions like single
  623. identifiers and short expressions, just by looking at a few examples of
  624. what \.{WEAVE} does, but the general mechanism is somewhat complex because
  625. it must handle much more than \Cee\ itself. Furthermore the output
  626. contains embedded codes that cause \TeX\ to indent and break lines as
  627. necessary, depending on the fonts used and the desired page width. For
  628. best results it is wise to avoid enclosing long \Cee\ texts in \pb, since the
  629. indentation and line breaking codes are omitted when the \pb\ text is
  630. translated from \Cee\ to \TeX. Stick to simple expressions or
  631. statements.  If a \Cee\ preprocessor command is enclosed in \pb,
  632. the \.\# that introduces it must be at the beginning of a line,
  633. or \.{WEAVE} won't print it correctly.
  634. 5. Comments and module names are not permitted in \pb\ text. After a `\.|'
  635. signals the change from \TeX\ text to \Cee\ text, the next `\.|' that is
  636. not part of a string or control text ends the \Cee\ text.
  637. 6. A comment must have properly nested occurrences of left and right
  638. braces, otherwise \.{WEAVE} will complain. But it
  639. does try to balance the braces, so that \TeX\ won't foul up too much.
  640. 7. When you're debugging a program and decide to omit some of your
  641. \Cee\ code, do NOT simply ``comment it out.'' Such comments are not
  642. in the spirit of \.{WEB} documentation; they will appear to readers
  643. as if they were explanations of the uncommented-out instructions.
  644. Furthermore, comments of a program must be valid \TeX\ text; hence
  645. \.{WEAVE} will get confused if you enclose \Cee\ statements in
  646. \.{/*...*/} instead of in \.{/*|...|*/}.
  647. 8. The \.{@f} feature allows you to define one identifier to act like
  648. another, and these format definitions are carried out sequentially.
  649. However, a given identifier has only one printed format
  650. throughout the entire document (and this format will even be used before
  651. the \.{@f} that defines it). The reason is that \.{WEAVE} operates in two
  652. passes; it processes \.{@f}'s and cross-references on the first pass and
  653. it does the output on the second.
  654. 9. Sometimes it is desirable to insert spacing into \Cee\ code that is
  655. more general than the thin space provided by `\.{@,}'. The \.{@t} feature
  656. can be used for this purpose; e.g., `\.{@t\\hskip 1in@>}' will
  657. leave one inch of blank space. Furthermore, `\.{@t\\4@>}' can be
  658. used to backspace by one unit of indentation, since the control sequence
  659. \.{\\4} is defined in \.{cwebmac} to be such a backspace. (This
  660. control sequence is used, for example, at the beginning of lines that
  661. contain labeled statements, so that the label will stick out a little at
  662. the left.) You can also use `\.{@t\}\\3\{-5@>}' to force a break
  663. in the middle of an expression.
  664. \section Running the programs.
  665. The \UNIX\ command line for \.{CTANGLE} is
  666. $$\.{ctangle [options] web\_file[.w] [change\_file[.ch] [out\_file]]}$$
  667. and the same conventions apply to \.{CWEAVE}. If no change file is
  668. specified, the change file is null. The extensions \.{.w} and \.{.ch}
  669. are appended only if the given file names contain no dot. If the
  670. web file defined in this way cannot be found, the extension \.{.web}
  671. will be tried. For example, `\.{cweave} \.{cob}' will try to read
  672. \.{cob.w}; failing that, it will try \.{cob.web} before giving up.
  673. If no output file name is specified, the name of the \Cee\ file output by
  674. \.{CTANGLE} is obtained by appending the extension \.{.c};
  675. the name of the \TeX\ file output by \.{CWEAVE} gets the extension \.{.tex}.
  676. Programmers who like terseness might choose to set up their
  677.  operating shell so that `\.{wv}' expands to
  678. `\.{cweave -bhp}'; this will suppress most terminal output from \.{CWEAVE}
  679. except for error messages.
  680. Options are introduced either by a \.- sign, to turn an option off,
  681. or by a \.+ sign to turn one off. For example, `\.{-fb}' turns off
  682. options \.f and \.b; `\.{+s}' turns on option \.s. Options can be
  683. specified before the file names, after the file names, or both. The following
  684. options are currently implemented:
  685. \yskip
  686. \def\option#1 {\textindent{\.#1}\hangindent2\parindent}
  687. \option b Print a banner line at the beginning of execution. (On
  688. by default.)
  689. \option f Force line breaks after each \Cee\ statement formatted
  690. by \.{WEAVE}. (On by default; \.{-f} saves paper but looks less \Cee-like
  691. to some people.) (Has no effect on \.{TANGLE}.)
  692. \option h Print a happy message at the conclusion of a successful
  693. run. (On by default.)
  694. \option p Give progress reports as the program runs. (On by default.)
  695. \option s Show statistics about memory usage after the program
  696. runs to completion. (Off by default.) This feature works only if
  697. the programs have been compiled with the \.{-DSTAT} switch. If you
  698. have large \.{WEB} files or modules, you may need to see
  699. how close you come to exceeding the capacity of \.{TANGLE} and/or \.{WEAVE}.
  700. \option x Include indexes and a table of contents in the \TeX\ file
  701. output by \.{WEAVE}. (On by default.) (Has no effect on \.{TANGLE}.)
  702. \section Further details about formatting.
  703. You may not like the way \.{WEAVE} handles certain
  704. situations. If you're desperate, you can customize \.{WEAVE}
  705. by changing its grammar.  This means changing the source code,
  706. a task that you might find amusing. A table of grammar rules
  707. appears in the \.{WEAVE} source listing, and you can make a separate
  708. copy of that table by copying the file \.{prod.w} found in the \.{cweb}
  709. sources and saying `\.{cweave}~\.{-x}~\.{prod}'.
  710. If you compile \.{WEAVE} with the \.{-DDEBUG} option on the command
  711. line, you will be able to see exactly
  712. how \.{WEAVE} is parsing your \Cee\ code by preceding
  713. it with the line `\.{@ @c @2}'. (The control code `\.{@2}'
  714. turns on a ``peeping'' mode, and `\.{@0}' turns it off.)
  715. For example, if you run \.{WEAVE} on the file
  716. \medskip
  717. \begingroup
  718. \verbatim
  719. @ @c @2
  720. main (argc,argv)
  721. char **argv;
  722. { for (;argc>0;argc--) printf("%s\n",argv[argc-1]); }
  723. !endgroup
  724. \endgroup
  725. \medskip\noindent
  726. you get the following gibberish on your screen:
  727. \medskip
  728. \begingroup
  729. \verbatim
  730. [...]
  731. 4:*exp ( +exp+ )...
  732. 8:*exp +exp+ int...
  733. 5:*+exp+ int +unorbinop+...
  734. [...]
  735. 45: +fn_decl+*+{+ -stmt- +}-
  736. 40:*+fn_decl+ -stmt-
  737. 37:*+function-
  738. [...]
  739. !endgroup
  740. \endgroup
  741. \medskip
  742. The first line says that grammar rule 4 has just been applied, and \.{WEAVE}
  743. currently has in its memory a sequence of chunks of \TeX\ code (called
  744. ``scraps'') that are respectively
  745. of type \\{exp} (for expression), open-parenthesis,
  746. \\{exp} again, close-parenthesis, and further scraps that haven't yet
  747. been considered by the parser.  (The \.+ and \.- signs stipulate that
  748. \TeX\ should be in or out of math mode at the scrap boundaries. The \.* shows
  749. the parser's current position.)
  750. Then rule 8 is applied, and
  751. the sequence $(\,exp\,)$ becomes an \\{exp} and so on.  In the
  752. end the whole \Cee\ text has become one big scrap of type \\{function}.
  753. Sometimes things don't work as smoothly, and you get a bunch of
  754. lines lumped together.  This means that \.{WEAVE} could not
  755. digest something in your \Cee\ code.  For instance, suppose
  756. `\.{@<Argument definitions@>}' had appeared instead of
  757. `\.{char **argv;}' in the program above. Then \.{WEAVE} would have
  758. been somewhat mystified, since it thinks that module names
  759. are just \\{exp}s.  Thus it would tell \TeX\ to format
  760. `\X2:Argument declarations\X' on the same line as
  761. `$\\{main}(\\{argc},\39\\{argv}{}$)'.
  762. In this case you should help \.{WEAVE} by putting `\.{@/}' after
  763. `\.{main(argc,argv)}'.
  764. \.{CWEAVE} automatically inserts a bit of extra space between declarations
  765. and the first apparent statement of a block. One way to defeat this is
  766. $$\vbox{\halign{#\hfil\cr
  767. \.{int x;@+@t@>@;@/}\cr
  768. \.{@<Other locals@>@;@\#}\cr}}$$
  769. the `\.{@\#}' will put extra space after `$\langle\,$Other locals$\,\rangle$'.
  770. \section Acknowledgments.
  771. The authors wish to thank all who contributed suggestions and criticism to
  772. the development of \.{CWEB}. We are especially grateful to Norman Ramsey,
  773. from whom the code for multiple output files is borrowed, and who has made
  774. literate programming accessible to users of yet other languages by means of
  775. his \.{SPIDER} system [see {\sl Communications of the ACM\/ \bf32} (1989),
  776. 1051--1055].
  777. \section Appendices.
  778. The basic ideas of \.{WEB} can be understood most easily by looking at
  779. examples of ``real'' programs. Appendix~A shows the \.{CWEB} input that
  780. generated modules 17--18 of the \.{common.w} file, which contains
  781. routines common to \.{CWEAVE} and \.{CTANGLE}. 
  782. Appendix~B shows the corresponding \Cee\ code output by \.{CTANGLE}. 
  783. Appendix~C shows the
  784. corresponding \TeX\ code output by \.{CWEAVE},
  785. and Appendix~D shows how that output looks when printed out.
  786. Appendix E is the file that sets \TeX\ up to accept
  787. the output of \.{CWEAVE}, and Appendix~F discusses how to use some of those
  788. macros to vary the output formats.
  789. \vfil\eject
  790. \def\runninghead{APPENDIX A --- {\tentt WEB} FILE FORMAT}
  791. \section Appendix A.
  792. The following is an excerpt of the file \.{common.w},
  793. which contains routines shared by \.{CWEAVE} and \.{CTANGLE}.
  794. Note that some of the lines are indented to show the program structure.
  795. The indentation is ignored by \.{WEAVE} and \.{TANGLE}, but users find
  796. that \.{WEB} files are quite readable if they have some such indentation.
  797. The reader should first compare Appendix~A to Appendix~B; then the
  798. same material should be compared to Appendices~C and~D.
  799. \vskip 6pt
  800. \begingroup \def\tt{\eighttt} \baselineskip9pt
  801. \verbatim
  802. @ Procedure |prime_the_change_buffer| sets |change_buffer| in preparation
  803. for the next matching operation. Since blank lines in the change file are
  804. not used for matching, we have |(change_limit==change_buffer && !!changing)|
  805. if and only if the change file is exhausted. This procedure is called only
  806. when |changing| is 1; hence error messages will be reported correctly.
  807. @<Func...@>=
  808. prime_the_change_buffer()
  809.   change_limit=change_buffer; /* this value is used if the change file ends */
  810.   @<Skip over comment lines in the change file; |return| if end of file@>;
  811.   @<Skip to the next nonblank line; |return| if end of file@>;
  812.   @<Move |buffer| and |limit| to |change_buffer| and |change_limit|@>;
  813. @ While looking for a line that begins with \.{@@x} in the change file,
  814. we allow lines that begin with \.{@@}, as long as they don't begin with
  815. \.{@@y} or \.{@@z} (which would probably indicate that the change file is
  816. fouled up).
  817. @<Skip over comment lines in the change file...@>=
  818. while(1) {
  819.   change_line++;
  820.   if (!!input_ln(change_file)) return;
  821.   if (limit<buffer+2) continue;
  822.   if (buffer[0]!!='@@') continue;
  823.   if (isupper(buffer[1])) buffer[1]=tolower(buffer[1]);
  824.   @<Check for erroneous \.{@@i}@>;
  825.   if (buffer[1]=='x') break;
  826.   if (buffer[1]=='y' || buffer[1]=='z') {
  827.     loc=buffer+2;
  828.     err_print("!! Where is the matching @@x?");
  829. @.Where is the match...@>
  830. @ We do not allow includes in a change file, so as to avoid confusion.
  831. @<Check for erron...@>= {
  832.   if (buffer[1]=='i') {
  833.     loc=buffer+2;
  834.     err_print("!! No includes allowed in change file");
  835. @.No includes allowed...@>
  836. !endgroup
  837. \endgroup
  838. \vfill\eject
  839. \def\runninghead{APPENDIX B  --- TRANSLATION BY {\tentt TANGLE}}
  840. \section Appendix B.
  841. Here's the portion of the \Cee\ code generated by \.{TANGLE} that corresponds
  842. to Appendix~A.  Notice that modules~13, 14, 15,
  843. and~16 have been tangled into module~12.
  844. \vskip6pt
  845. \begingroup \def\tt{\eighttt} \baselineskip9pt
  846. \verbatim
  847. /*:9*//*12:*/
  848. #line 238 "common.w"
  849. prime_the_change_buffer()
  850. change_limit= change_buffer;
  851. /*13:*/
  852. #line 252 "common.w"
  853. while(1){
  854. change_line++;
  855. if(!!input_ln(change_file))return;
  856. if(limit<buffer+2)continue;
  857. if(buffer[0]!!='@')continue;
  858. if(isupper(buffer[1]))buffer[1]= tolower(buffer[1]);
  859. /*14:*/
  860. #line 270 "common.w"
  861. if(buffer[1]=='i'){
  862. loc= buffer+2;
  863. err_print("!! No includes allowed in change file");
  864. /*:14*/
  865. #line 259 "common.w"
  866. if(buffer[1]=='x')break;
  867. if(buffer[1]=='y'||buffer[1]=='z'){
  868. loc= buffer+2;
  869. err_print("!! Where is the matching @x?");
  870. /*:13*/
  871. #line 242 "common.w"
  872. /*15:*/
  873. #line 280 "common.w"
  874. change_line++;
  875. if(!!input_ln(change_file)){
  876. err_print("!! Change file ended after @x");
  877. return;
  878. }while(limit==buffer);
  879. /*:15*/
  880. #line 243 "common.w"
  881. /*16:*/
  882. #line 290 "common.w"
  883. change_limit= change_buffer-buffer+limit;
  884. strncpy(change_buffer,buffer,limit-buffer+1);
  885. /*:16*/
  886. #line 244 "common.w"
  887. /*:12*//*17:*/
  888. !endgroup
  889. \endgroup
  890. \vfill\eject
  891. \def\runninghead{APPENDIX C --- TRANSLATION BY {\tentt WEAVE}}
  892. \section Appendix C.
  893. This excerpt from \.{common.tex} corresponds to Appendix A.
  894. \vskip6pt
  895. \begingroup \def\tt{\eighttt} \baselineskip9pt
  896. \verbatim
  897. \M12. Procedure \\{prime\_the\_change\_buffer} sets \\{change\_buffer} in
  898. preparation
  899. for the next matching operation. Since blank lines in the change file are
  900. not used for matching, we have $(\\{change\_limit}\E\\{change\_buffer}\W\R%
  901. \\{changing})$
  902. if and only if the change file is exhausted. This procedure is called only
  903. when \\{changing} is 1; hence error messages will be reported correctly.
  904. \Y\B\4\X4:Functions\X${}\mathrel+\E{}$\6
  905. \\{prime\_the\_change\_buffer}(\,)\1\1\2\2\6
  906. ${}\{{}$\1\6
  907. ${}\\{change\_limit}\K\\{change\_buffer}{}$;\C{ this value is used if the
  908. change file ends }\6
  909. \X13:Skip over comment lines in the change file; \&{return} if end of file\X;\6
  910. \X15:Skip to the next nonblank line; \&{return} if end of file\X;\6
  911. \X16:Move \\{buffer} and \\{limit} to \\{change\_buffer} and \\{change\_limit}%
  912. \X;\6
  913. \4${}\}{}$\2\par
  914. \M13. While looking for a line that begins with \.{@x} in the change file,
  915. we allow lines that begin with \.{@}, as long as they don't begin with
  916. \.{@y} or \.{@z} (which would probably indicate that the change file is
  917. fouled up).
  918. \Y\B\4\X13:Skip over comment lines in the change file; \&{return} if end of
  919. file\X${}\E{}$\6
  920. \&{while} (\T{1})\5
  921. ${}\{{}$\1\6
  922. ${}\\{change\_line}\PP;{}$\6
  923. \&{if} ${}(\R\\{input\_ln}(\\{change\_file})){}$\1\5
  924. \&{return};\2\6
  925. \&{if} ${}(\\{limit}<\\{buffer}+\T{2}){}$\1\5
  926. \&{continue};\2\6
  927. \&{if} ${}(\\{buffer}[\T{0}]\I\.{'@'}){}$\1\5
  928. \&{continue};\2\6
  929. \&{if} (\\{isupper}(\\{buffer}[\T{1}]))\1\5
  930. ${}\\{buffer}[\T{1}]\K\\{tolower}(\\{buffer}[\T{1}]);{}$\2\6
  931. \X14:Check for erroneous \.{@i}\X;\6
  932. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'x'}){}$\1\5
  933. \&{break};\2\6
  934. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'y'}\V\\{buffer}[\T{1}]\E\.{'z'}){}$\5
  935. ${}\{{}$\1\6
  936. ${}\\{loc}\K\\{buffer}+\T{2};{}$\6
  937. \\{err\_print}(\.{"!!\ Where\ is\ the\ matc}\)\.{hing\ @x?"});\6
  938. \4${}\}{}$\2\6
  939. \4${}\}{}$\2\par
  940. \U12.\fi
  941. \M14. We do not allow includes in a change file, so as to avoid confusion.
  942. \Y\B\4\X14:Check for erroneous \.{@i}\X${}\E{}$\6
  943. ${}\{{}$\1\6
  944. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'i'}){}$\5
  945. ${}\{{}$\1\6
  946. ${}\\{loc}\K\\{buffer}+\T{2};{}$\6
  947. \\{err\_print}(\.{"!!\ No\ includes\ allow}\)\.{ed\ in\ change\ file"});\6
  948. \4${}\}{}$\2\6
  949. \4${}\}{}$\2\par
  950. \Us13\ET25.\fi
  951. !endgroup
  952. \endgroup
  953. \vfil\eject
  954. \def\runninghead{APPENDIX D --- FINAL DOCUMENT}
  955. \section Appendix D.
  956. Here's what Appendix~C looks like when typeset. Appendix G contains the
  957. entire context.
  958. \M12. Procedure \\{prime\_the\_change\_buffer} sets \\{change\_buffer} in
  959. preparation
  960. for the next matching operation. Since blank lines in the change file are
  961. not used for matching, we have $(\\{change\_limit}\E\\{change\_buffer}\W\R%
  962. \\{changing})$
  963. if and only if the change file is exhausted. This procedure is called only
  964. when \\{changing} is 1; hence error messages will be reported correctly.
  965. \Y\B\4\X4:Functions\X${}\mathrel+\E{}$\6
  966. \\{prime\_the\_change\_buffer}(\,)\1\1\2\2\6
  967. ${}\{{}$\1\6
  968. ${}\\{change\_limit}\K\\{change\_buffer}{}$;\C{ this value is used if the
  969. change file ends }\6
  970. \X13:Skip over comment lines in the change file; \&{return} if end of file\X;\6
  971. \X15:Skip to the next nonblank line; \&{return} if end of file\X;\6
  972. \X16:Move \\{buffer} and \\{limit} to \\{change\_buffer} and \\{change\_limit}%
  973. \X;\6
  974. \4${}\}{}$\2\par
  975. \M13. While looking for a line that begins with \.{@x} in the change file,
  976. we allow lines that begin with \.{@}, as long as they don't begin with
  977. \.{@y} or \.{@z} (which would probably indicate that the change file is
  978. fouled up).
  979. \Y\B\4\X13:Skip over comment lines in the change file; \&{return} if end of
  980. file\X${}\E{}$\6
  981. \&{while} (\T{1})\5
  982. ${}\{{}$\1\6
  983. ${}\\{change\_line}\PP;{}$\6
  984. \&{if} ${}(\R\\{input\_ln}(\\{change\_file})){}$\1\5
  985. \&{return};\2\6
  986. \&{if} ${}(\\{limit}<\\{buffer}+\T{2}){}$\1\5
  987. \&{continue};\2\6
  988. \&{if} ${}(\\{buffer}[\T{0}]\I\.{'@'}){}$\1\5
  989. \&{continue};\2\6
  990. \&{if} (\\{isupper}(\\{buffer}[\T{1}]))\1\5
  991. ${}\\{buffer}[\T{1}]\K\\{tolower}(\\{buffer}[\T{1}]);{}$\2\6
  992. \X14:Check for erroneous \.{@i}\X;\6
  993. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'x'}){}$\1\5
  994. \&{break};\2\6
  995. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'y'}\V\\{buffer}[\T{1}]\E\.{'z'}){}$\5
  996. ${}\{{}$\1\6
  997. ${}\\{loc}\K\\{buffer}+\T{2};{}$\6
  998. \\{err\_print}(\.{"!\ Where\ is\ the\ matc}\)\.{hing\ @x?"});\6
  999. \4${}\}{}$\2\6
  1000. \4${}\}{}$\2\par
  1001. \U12.\fi
  1002. \M14. We do not allow includes in a change file, so as to avoid confusion.
  1003. \Y\B\4\X14:Check for erroneous \.{@i}\X${}\E{}$\6
  1004. ${}\{{}$\1\6
  1005. \&{if} ${}(\\{buffer}[\T{1}]\E\.{'i'}){}$\5
  1006. ${}\{{}$\1\6
  1007. ${}\\{loc}\K\\{buffer}+\T{2};{}$\6
  1008. \\{err\_print}(\.{"!\ No\ includes\ allow}\)\.{ed\ in\ change\ file"});\6
  1009. \4${}\}{}$\2\6
  1010. \4${}\}{}$\2\par
  1011. \Us13\ET25.\fi
  1012. \vfil\eject
  1013. \def\runninghead{APPENDIX E --- MACROS FOR FORMATTING}
  1014. \section Appendix E: The \.{cwebmac.tex} file.
  1015. This is the file that extends ``plain \TeX'' format in order to support the
  1016. features needed by the output of \.{WEAVE}.
  1017. \vskip6pt
  1018. \begingroup \def\tt{\eighttt} \baselineskip9pt
  1019. \def\printmacs{\input cwebmac}
  1020. \verbatim
  1021. !printmacs
  1022. !endgroup
  1023. \endgroup
  1024. \vfill\eject
  1025. \def\runninghead{APPENDIX F --- NOTES ON FORMATTING}
  1026. \section Appendix F: How to use \.{CWEB} macros.
  1027. The macros in \.{cwebmac} make it possible to produce a variety of formats
  1028. without editing the output of \.{CWEAVE}, and the purpose of this appendix
  1029. is to explain some of the possibilities.
  1030. \def\point#1.{\yskip\indent#1.\quad\ignorespaces}
  1031. \point 1. Four fonts have been declared in addition to the standard fonts of
  1032. \.{PLAIN} format: You can say `\.{\{\\mc UNIX\}}' to get {\mc UNIX} in
  1033. medium-size caps; you can say `\.{\{\\sc STUFF\}}' to get {\sc STUFF}
  1034. in small caps; and you can select the largish fonts \.{\\titlefont}
  1035. and \.{\\ttitlefont} in the title of your document, where \.{\\ttitlefont}
  1036. is a typewriter style of type. There are macros \.{\\UNIX} and \.{\\Cee}
  1037. to refer to \UNIX\ and \Cee\ with medium-size caps.
  1038. \point 2. When you mention an identifier in \TeX\ text, you normally call
  1039. it `\.{|identifier|}'. But you can also say `\.{\\\\\{identifier\}}'. The
  1040. output will look the same in both cases, but the second alternative
  1041. doesn't put \\{identifier} into the index, since
  1042. it bypasses \.{WEAVE}'s translation from \Cee\ mode. In the second
  1043. case you have to put a backslash before each underline character
  1044. in the identifier.
  1045. \point 3. To get typewriter-like type, as when referring to `\.{WEB}', you
  1046. can use the `\.{\\.}' macro (e.g., `\.{\\.\{WEB\}}'). In the argument to
  1047. this macro you should insert an additional backslash before the symbols
  1048. listed as `special string characters' in the index to \.{WEAVE}, i.e.,
  1049. before backslashes and dollar signs and the like.
  1050. A `\.{\\\ }' here will result in the visible space symbol; to get an
  1051. invisible space following a control sequence you can say `\.{\{\ \}}'.
  1052. If the string is long, you can break it up into substrings that
  1053. are separated by `\.{\\)}'; the latter gives a discretionary backslash
  1054. if \TeX\ has to break a line here.
  1055. \point 4. The three control sequences \.{\\pagewidth}, \.{\\pageheight},
  1056. and \.{\\fullpageheight} can be redefined in the limbo section at the
  1057. beginning of your \.{WEB} file, to change the dimensions of each page.
  1058. The default settings
  1059. $$\lpile{\.{\\pagewidth=6.5in}\cr
  1060.   \.{\\pageheight=8.7in}\cr
  1061.   \.{\\fullpageheight=9in}\cr}$$
  1062. were used to prepare the present report; \.{\\fullpageheight} is
  1063. \.{\\pageheight} plus room for the additional heading and page numbers at
  1064. the top of each page. If you change any of these quantities, you should
  1065. call the macro \.{\\setpage} immediately after making the change.
  1066. \point 5. The \.{\\pageshift} macro defines an amount by which right-hand
  1067. pages (i.e., odd-numbered pages) are shifted right with respect to
  1068. left-hand (even-numbered) ones. By adjusting this amount you may be
  1069. able to get two-sided output in which the page numbers line up on
  1070. opposite sides of each sheet.
  1071. \point 6. The \.{\\title} macro will appear at the top of each page
  1072. in small caps; it is the job name unless redefined.
  1073. \point 7. The first page usually is assigned page
  1074. number 1. To start on page 16, with contents
  1075. on page 15, say this: `\.{\\def\\contentspagenumber\{15\}}
  1076. \.{\\pageno=\\contentspagenumber} \.{\\advance\\pageno by 1}'.
  1077. \point 8. The macro \.{\\iftitle} will suppress the header line if it is
  1078. defined by `\.{\\titletrue}'. The normal value is \.{\\titlefalse}
  1079. except for the table of contents; thus, the contents
  1080. page is usually unnumbered.
  1081. Two macros are provided to give flexibility to the table of
  1082. contents: \.{\\topofcontents} is invoked just before the contents
  1083. info is read, and \.{\\botofcontents} is invoked just after.
  1084. Here's a typical definition, taken from the original \.{WEB} manual:
  1085. $$\lpile{\.{\\def\\topofcontents\{\\null\\vfill}\cr
  1086.   \.{ { }\\titlefalse \% include headline on the contents page}\cr
  1087.   \.{ { }\\def\\rheader\{\\mainfont The \{\\tt WEAVE\}{ }processor\\hfil\}}\cr
  1088.   \.{ { }\\centerline\{\\titlefont The \{\\ttitlefont WEAVE\}{ }processor\}}\cr
  1089.   \.{ { }\\vskip 15pt \\centerline\{(Version 2.5)\}{ }\\vfill\}}\cr}$$
  1090. Redefining \.{\\rheader}, which is the headline for right-hand pages,
  1091. suffices in this case to put the desired information at the top of the
  1092. contents page.
  1093. \point 9. Data for the table of contents is written to a file that
  1094. is read after the indexes have been \TeX ed; there's one line of data
  1095. for every starred module. The file \.{common.toc} might look like this:
  1096. $$\lpile{\.{\\Z \{{ }Introduction\}\{1\}\{2\}}\cr
  1097.   \.{\\Z \{{ }The character set\}\{5\}\{3\}}\cr}$$
  1098. and so on. The \.{\\topofcontents} macro could
  1099. redefine \.{\\Z} so that the information appears in any desired format.
  1100. \point 10. Sometimes it is necessary or desirable to divide the output of
  1101. \.{WEAVE} into subfiles that can be processed separately. For example,
  1102. the listing of \TeX\ runs to more than 500 pages, and that is enough to
  1103. exceed the capacity of many printing devices and/or their software.
  1104. When an extremely large job isn't cut into smaller pieces, the entire
  1105. process might be spoiled by a single error of some sort, making it
  1106. necessary to start everything over.
  1107. Here's a safe way to break a woven file into three parts:
  1108. Say the pieces are $\alpha$,
  1109. $\beta$, and $\gamma$, where each piece begins with a starred module.
  1110. All macros should be defined in the opening limbo section of $\alpha$,
  1111. and copies of this \TeX\ code should be placed at the
  1112. beginning of $\beta$ and of $\gamma$. In order to process the parts
  1113. separately, we need to take care of two things: The starting page
  1114. numbers of $\beta$ and $\gamma$ need to be set up properly, and
  1115. the table of contents data from all three runs needs to be
  1116. accumulated.
  1117. The \.{webmac} macros include two control sequences \.{\\contentsfile} and
  1118. \.{\\readcontents} that facilitate the necessary processing.  We include
  1119. `\.{\\def\\contentsfile\{CONT1\}}' in the limbo section of $\alpha$, and
  1120. we include `\.{\\def\\contentsfile\{CONT2\}}' in the limbo section of
  1121. $\beta$; this causes \TeX\ to write the contents data for $\alpha$ and $\beta$
  1122. into \.{CONT1.TEX} and \.{CONT2.TEX}. Now in $\gamma$ we say
  1123. $$\.{\\def\\readcontents\{\\input CONT1 \\input CONT2 \\input CONTENTS\}};$$
  1124. this brings in the data from all three pieces, in the proper order.
  1125. However, we still need to solve the page-numbering problem. One way to
  1126. do it is to include the following in the limbo material for $\beta$:
  1127. $$\lpile{\.{\\message\{Please type the last page number of part 1: \}}\cr
  1128.   \.{\\read -1 to \\temp \\pageno=\\temp \\advance\\pageno by 1}\cr}$$
  1129. Then you simply provide the necessary data when \TeX\ requests
  1130. it; a similar construction is used at the beginning of $\gamma$.
  1131. This method can, of course, be used to divide a woven file into
  1132. any number of pieces.
  1133. \point 11. Sometimes it is nice to include things in the index that are
  1134. typeset in a special way. For example, we might want to have an
  1135. index entry for `\TeX'. \.{WEAVE} provides two simple ways to
  1136. typeset an index entry (unless the entry is an identifier or a reserved word):
  1137. `\.{@\^}' gives roman type, and `\.{@.}' gives typewriter type.
  1138. But if we try to typeset `\TeX' in roman type by saying, e.g.,
  1139. `\.{@\^\\TeX@>}', the backslash character gets in the way,
  1140. and this entry wouldn't appear in the index with the T's.
  1141. The solution is to use the `\.{@:}' feature, declaring a macro that
  1142. simply removes a sort key as follows:
  1143. $$\.{\\def\\9\#1\{\}}$$
  1144. Now you can say, e.g., `\.{@:TeX\}\{\\TeX@>}' in your \.{WEB} file; \.{WEAVE}
  1145. puts it into the index alphabetically, based on the sort key, and
  1146. produces the macro call `\.{\\9\{TeX\}\{\\TeX\}}' which will ensure that
  1147. the sort key isn't printed.
  1148. A similar idea can be used to insert hidden material into module
  1149. names so that they are alphabetized in whatever way you might wish.
  1150. Some people call these tricks ``special refinements''; others call
  1151. them ``kludges''.
  1152. \point 12. The control sequence \.{\\modno} is set to the number of the
  1153. module being typeset.
  1154. \point 13. If you want to list only the modules that have changed,
  1155. together with the index, put the command `\.{\\let\\maybe=\\iffalse}' in
  1156. the limbo section before the first module of your \.{WEB} file. It's
  1157. customary to make this the first change in your change file.
  1158. \point 14. To get output in languages other than English, redefine the
  1159. macros \.{\\A}, \.{\\As}, \.{\\ET}, \.{\\ETs}, \.{\\U}, \.{\\Us},
  1160. \.{\\ch}, \.{\\fin}, and \.{\\con}. \.{CWEAVE} itself need not be changed.
  1161. \point 15. All accents and special text symbols of plain \TeX\ format
  1162. will work in \.{CWEB} documents just as they are described in
  1163. Chapter~9 of {\sl The \TeX book}, with one exception.
  1164. The dot accent (normally \.{\\.}) must be typed \.{\\:} instead.
  1165. \vfill\end
  1166.