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
|
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>1996</year>
<year>2007</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
The Initial Developer of the Original Code is Ericsson AB.
</legalnotice>
<title>erl_pp</title>
<prepared>Robert Virding</prepared>
<responsible>Bjarne Däcker</responsible>
<docno>1</docno>
<approved>Bjarne Däcker</approved>
<checked></checked>
<date>97-01-24</date>
<rev>B</rev>
<file>erl_pp.sgml</file>
</header>
<module>erl_pp</module>
<modulesummary>The Erlang Pretty Printer</modulesummary>
<description>
<p>The functions in this module are used to generate
aesthetically attractive representations of abstract
forms, which are suitable for printing. All functions return (possibly deep)
lists of characters and generate an error if the form is wrong.</p>
<p>All functions can have an optional argument which specifies a hook
that is called if an attempt is made to print an unknown form.</p>
</description>
<funcs>
<func>
<name>form(Form) -> DeepCharList</name>
<name>form(Form, HookFunction) -> DeepCharList</name>
<fsummary>Pretty print a form</fsummary>
<type>
<v>Form = term()</v>
<v>HookFunction = see separate description below.</v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>Pretty prints a
<c>Form</c> which is an abstract form of a type which is
returned by <c>erl_parse:parse_form</c>.</p>
</desc>
</func>
<func>
<name>attribute(Attribute) -> DeepCharList</name>
<name>attribute(Attribute, HookFunction) -> DeepCharList</name>
<fsummary>Pretty print an attribute</fsummary>
<type>
<v>Attribute = term()</v>
<v>HookFunction = see separate description below.</v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>The same as <c>form</c>, but only for the attribute
<c>Attribute</c>.</p>
</desc>
</func>
<func>
<name>function(Function) -> DeepCharList</name>
<name>function(Function, HookFunction) -> DeepCharList</name>
<fsummary>Pretty print a function</fsummary>
<type>
<v>Function = term()</v>
<v>HookFunction = see separate description below.</v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>The same as <c>form</c>, but only for the function
<c>Function</c>.</p>
</desc>
</func>
<func>
<name>guard(Guard) -> DeepCharList</name>
<name>guard(Guard, HookFunction) -> DeepCharList</name>
<fsummary>Pretty print a guard</fsummary>
<type>
<v>Form = term()</v>
<v>HookFunction = see separate description below.</v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>The same as <c>form</c>, but only for the guard test
<c>Guard</c>.</p>
</desc>
</func>
<func>
<name>exprs(Expressions) -> DeepCharList</name>
<name>exprs(Expressions, HookFunction) -> DeepCharList</name>
<name>exprs(Expressions, Indent, HookFunction) -> DeepCharList</name>
<fsummary>Pretty print <c>Expressions</c></fsummary>
<type>
<v>Expressions = term()</v>
<v>HookFunction = see separate description below.</v>
<v>Indent = integer()</v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>The same as <c>form</c>, but only for the sequence of
expressions in <c>Expressions</c>.</p>
</desc>
</func>
<func>
<name>expr(Expression) -> DeepCharList</name>
<name>expr(Expression, HookFunction) -> DeepCharList</name>
<name>expr(Expression, Indent, HookFunction) -> DeepCharList</name>
<name>expr(Expression, Indent, Precedence, HookFunction) ->-> DeepCharList</name>
<fsummary>Pretty print one <c>Expression</c></fsummary>
<type>
<v>Expression = term()</v>
<v>HookFunction = see separate description below.</v>
<v>Indent = integer()</v>
<v>Precedence = </v>
<v>DeepCharList = [char()|DeepCharList]</v>
</type>
<desc>
<p>This function prints one expression. It is useful for implementing hooks (see below).</p>
</desc>
</func>
</funcs>
<section>
<title>Unknown Expression Hooks</title>
<p>The optional argument <c>HookFunction</c>, shown in the functions described above, defines a function which is called when an unknown form occurs where there
should be a valid expression. It can have the following formats:</p>
<taglist>
<tag><c>Function</c></tag>
<item>
<p>The hook function is called by:</p>
<code type="none">
Function(Expr,
CurrentIndentation,
CurrentPrecedence,
HookFunction) </code>
</item>
<tag><c>none</c></tag>
<item>
<p>There is no hook function</p>
</item>
</taglist>
<p>The called hook function should return a (possibly deep) list
of characters. <c>expr/4</c> is useful in a hook.
</p>
<p>If <c>CurrentIndentation</c> is negative, there will be no line
breaks and only a space is used as a separator.</p>
</section>
<section>
<title>Bugs</title>
<p>It should be possible to have hook functions for unknown forms
at places other than expressions.</p>
</section>
<section>
<title>See Also</title>
<p><seealso marker="io">io(3)</seealso>,
<seealso marker="erl_parse">erl_parse(3)</seealso>,
<seealso marker="erl_eval">erl_eval(3)</seealso></p>
</section>
</erlref>
|
