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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">
<erlref>
<header>
<copyright>
<year>1996</year>
<year>2022</year>
<holder>Ericsson AB, All Rights Reserved</holder>
</copyright>
<legalnotice>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions 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>1997-01-24</date>
<rev>B</rev>
<file>erl_pp.xml</file>
</header>
<module since="">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>
<p>Note that if the functions in this module are used to convert
abstract code back to Erlang source code, the enclosing function
should first be processed by <seemfa
marker="#legalize_vars/1"><c>legalize_vars/1</c></seemfa> in order
to ensure that the output is semantically equivalent to the
abstract code.</p>
</description>
<datatypes>
<datatype>
<name name="hook_function"/>
<desc>
<p>Optional argument <marker id="hook_function"/><c>HookFunction</c>,
shown in the functions described in this module, defines a function
that is called when an unknown form occurs where there
is to be a valid expression. If <c>HookFunction</c> is equal to
<c>none</c>, there is no hook function.</p>
<p>The called hook function is to return a (possibly deep) list of
characters. Function <seemfa marker="#expr/4"><c>expr/4</c></seemfa>
is useful in a hook.</p>
<p>If <c><anno>CurrentIndentation</anno></c> is negative, there are no
line breaks and only a space is used as a separator.</p>
</desc>
</datatype>
<datatype>
<name name="option"/>
<desc>
<p>The option <c>quote_singleton_atom_types</c>
is used to add quotes to all singleton atom types.</p>
<p>The option <c>linewidth</c> controls the maximum line
width for formatted lines (defaults to 72 characters).</p>
<p>The option <c>indent</c> controls the
indention for formatted lines (defaults to 4 spaces).</p>
</desc>
</datatype>
<datatype>
<name name="options"/>
</datatype>
</datatypes>
<funcs>
<func>
<name name="attribute" arity="1" since=""/>
<name name="attribute" arity="2" since=""/>
<fsummary>Pretty print an attribute.</fsummary>
<desc>
<p>Same as <seemfa marker="#form/1"><c>form/1,2</c></seemfa>,
but only for attribute <c><anno>Attribute</anno></c>.</p>
</desc>
</func>
<func>
<name name="expr" arity="1" since=""/>
<name name="expr" arity="2" since=""/>
<name name="expr" arity="3" since=""/>
<name name="expr" arity="4" since=""/>
<fsummary>Pretty print one <c>Expression</c>.</fsummary>
<desc>
<p>Prints one expression. It is useful for implementing hooks (see
section
<seeerl marker="#knownlimitations">Known Limitations</seeerl>).</p>
</desc>
</func>
<func>
<name name="exprs" arity="1" since=""/>
<name name="exprs" arity="2" since=""/>
<name name="exprs" arity="3" since=""/>
<fsummary>Pretty print <c>Expressions</c>.</fsummary>
<desc>
<p>Same as <seemfa marker="#form/1"><c>form/1,2</c></seemfa>,
but only for the sequence of
expressions in <c><anno>Expressions</anno></c>.</p>
</desc>
</func>
<func>
<name name="form" arity="1" since=""/>
<name name="form" arity="2" since=""/>
<fsummary>Pretty print a form.</fsummary>
<desc>
<p>Pretty prints a
<c><anno>Form</anno></c>, which is an abstract form of a type that is
returned by <seemfa marker="erl_parse#parse_form/1">
<c>erl_parse:parse_form/1</c></seemfa>.</p>
</desc>
</func>
<func>
<name name="function" arity="1" since=""/>
<name name="function" arity="2" since=""/>
<fsummary>Pretty print a function.</fsummary>
<desc>
<p>Same as <seemfa marker="#form/1"><c>form/1,2</c></seemfa>,
but only for function <c><anno>Function</anno></c>.</p>
</desc>
</func>
<func>
<name name="guard" arity="1" since=""/>
<name name="guard" arity="2" since=""/>
<fsummary>Pretty print a guard.</fsummary>
<desc>
<p>Same as <seemfa marker="#form/1"><c>form/1,2</c></seemfa>,
but only for the guard test <c><anno>Guard</anno></c>.</p>
</desc>
</func>
<func>
<name name="legalize_vars" arity="1" since="OTP 25.0"/>
<fsummary>Ensure all variable names are valid.</fsummary>
<desc>
<p>The Erlang compiler will, when expanding records to tuples,
introduce new variables in the abstract representation. As the
expansion is done on the abstract representation, the compiler
can safely name the new variables with names that are not
syntactically valid in Erlang source code (the name starts
with a lowercase letter), thus ensuring the uniqueness of the
new names.</p>
<p>The above strategy leads to problems if a user wants to
convert the abstract representation, using the functions of
this module back to Erlang source code. Typically, pattern
variables are output as atoms thus changing the sematics of
the program. To solve this problem <c>legalize_vars/1</c>,
when run on the abstract representation of a function, will
return an equivalent function where all variables will have
syntactically valid names.</p>
</desc>
</func>
</funcs>
<section>
<marker id="knownlimitations"/>
<title>Known Limitations</title>
<p>It is not possible to have hook functions for unknown forms
at other places than expressions.</p>
</section>
<section>
<title>See Also</title>
<p><seeerl marker="erl_eval"><c>erl_eval(3)</c></seeerl>,
<seeerl marker="erl_parse"><c>erl_parse(3)</c></seeerl>,
<seeerl marker="io"><c>io(3)</c></seeerl></p>
</section>
</erlref>
|
