--------------------------------
[haskell-report.git] / report / literate.verb
1 %
2 % $Header: /home/cvs/root/haskell-report/report/literate.verb,v 1.5 2002/12/02 14:53:30 simonpj Exp $
3 %
4 %**<title>The Haskell 98 Report: Literate Comments</title>
5 %**~header
6 \subsection{Literate comments}
7 \label{literate}
8 \index{literate comments}
9
10 The ``literate comment''
11 convention, first developed by Richard Bird and Philip Wadler for
12 Orwell, and inspired in turn by Donald Knuth's ``literate
13 programming'', is an alternative style for encoding \Haskell{} source
14 code. 
15 The literate style encourages comments by making them the default.  A
16 line in which ``@>@'' is the first character is treated as part of the
17 program; all other lines are comment.
18
19 The program text is recovered
20 by taking only those lines beginning with ``@>@'', 
21 and replacing the leading ``@>@'' with a space.
22 Layout and comments apply
23 exactly as described in Appendix~\ref{syntax} in the resulting text.
24
25 To capture some cases where one omits an ``@>@'' by mistake, it is an
26 error for a program line to appear adjacent to a non-blank comment line,
27 where a line is taken as blank if it consists only of whitespace.
28
29 By convention, the style of comment is indicated by the file
30 extension, with ``@.hs@'' indicating a usual Haskell file and
31 ``@.lhs@'' indicating a literate Haskell file.  Using this style, a
32 simple factorial program would be:
33 \bprog
34 @
35    This literate program prompts the user for a number
36    and prints the factorial of that number:
37
38 > main :: IO ()
39
40 > main = do putStr "Enter a number: "
41 >           l <- readLine
42 >           putStr "n!= "
43 >           print (fact (read l))
44           
45   This is the factorial function.
46
47 > fact :: Integer -> Integer
48 > fact 0 = 1
49 > fact n = n * fact (n-1)
50 @
51 \eprog
52
53
54 An alternative style of literate programming is particularly
55 suitable for use with the LaTeX text processing system.
56 In this convention, only those parts of the literate program that are
57 entirely enclosed between @\begin{code}@$\ldots$@\end{code}@ delimiters are
58 treated as program text; all other lines are comment.  More precisely:
59 \begin{itemize}
60 \item Program code begins on the first line following a line that begins @\begin{code}@.
61 \item Program code ends just before a subsequent line that begins @\end{code}@ (ignoring
62 string literals, of course).
63 \end{itemize}
64 It is not necessary
65 to insert additional blank lines before or after these delimiters, though
66 it may be stylistically desirable.  For example,
67 \bprog
68 @
69 \documentstyle{article}
70
71 \begin{document}
72
73 \section{Introduction}
74
75 This is a trivial program that prints the first 20 factorials.
76
77 \begin{code}
78 main :: IO ()
79 main =  print [ (n, product [1..n]) | n <- [1..20]]
80 \end{code}
81
82 \end{document}
83 @
84 \eprog
85 This style uses the same file extension.  It is not advisable to mix
86 these two styles in the same file.
87
88 %**~footer