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
|
<!-- Title = the 'pretty' command -->
<TABLE BORDER=0 CELLSPACING=5 CELLPADDING=5 COLS=1 WIDTH="100%" BGCOLOR="#3366FF" NOSAVE >
<TR NOSAVE>
<TD NOSAVE>
<CENTER><FONT COLOR="#FFFFFF" SIZE=+3><B>The <TT>pretty</TT> Command</B></FONT></CENTER>
</TD>
</TR>
</TABLE>
<BR><BR><BR>
<TABLE BORDER=0 COLS=1 WIDTH="100%" BGCOLOR="#3366FF" NOSAVE >
<TR NOSAVE>
<TD NOSAVE><FONT COLOR="#FFFFFF" SIZE="+2">Usage</FONT></TD>
</TR>
</TABLE>
<P>
<TT>pretty [options] <class_name> ...</TT>
</P>
<P>
Command <TT>pretty</TT> is the SmartEiffel pretty printer for Eiffel
source files.
The <TT>class_name</TT> argument can be a classic Eiffel class name
as for example "INTEGER" or the name of some file as for example
"<TT>integer.e</TT>".
The class file to be treated by <TT>pretty</TT> is always searched in
the current working directory.
<BR>
One can specify more than one class name (or more than one file name)
at a time in order to apply pretty on many files.
All the corresponding files are reprinted in a <TT>pretty</TT> way.
</P>
<P>
There are four modes of pretty printing <I>-zen</I>, <I>-default</I>,
<I>-end</I> and <I>-parano</I> mode. Only one mode can be selected and
mode <I>-default</I> is the default mode.
</P>
<TABLE BORDER=0 COLS=1 WIDTH="100%" BGCOLOR="#3366FF" NOSAVE >
<TR NOSAVE>
<TD NOSAVE><FONT COLOR="#FFFFFF" SIZE="+2">Options for Pretty Printing</FONT></TD>
</TR>
</TABLE>
<P>
<DL COMPACT>
<DT>
<I>-help</I>:<BR>
<DD>
Display a brief summary of the command-line syntax and a complete
list of <TT>pretty</TT> options.
<BR><BR>
<DT>
<DT>
<I>-version</I>:<BR>
<DD>
Show the number of the version of SmartEiffel you're using.
<BR><BR>
<DT><I>
-zen</I>:<BR><DD>
The less you can print (i.e. very compact output).
No end mark comment for routines.
No end comments for statements (if, inspect, debug, ...).
<BR><BR>
<DT><I>
-default</I>:<BR><DD>
The default mode. This is close to what we are using for our library.
<BR><BR>
<DT><I>
-end</I>:<BR><DD>
Same printing as for previous mode but also print end mark comments
for all routines.
<BR><BR>
<DT><I>
-parano</I>:<BR><DD>
Same printing as for previous mode but also print end mark comments
for all statements (if, inspect, debug, ...).
<BR><BR>
<DT>
<I>-no_style_warning</I>:<BR><DD>
Suppress output for warning messages related to non respect of standard Eiffel
style guidelines (for example <CODE>ItEm</CODE> will not trigger a warning).
<BR><BR>
<DT><I>
-no_warning</I>:<BR><DD>
Suppress output for all warning messages (error messages
are still printed).
<BR><BR>
</DL>
</P>
<TABLE BORDER=0 COLS=1 WIDTH="100%" BGCOLOR="#3366FF" NOSAVE >
<TR NOSAVE>
<TD NOSAVE><FONT COLOR="#FFFFFF" SIZE="+2">Security and BackUp File</FONT></TD>
</TR>
</TABLE>
<P>
For the security of sources files, a backup file is created
before writing the new file (system or command <TT>pretty</TT> may
crash during printing of the new file).
The backup file name is "foo.bak" when source file name is
"foo.e". Backup file is written in the same directory as
source file.
<BR><BR>
If an old backup file already exists before pretty printing,
command <TT>pretty</TT> exit with an error message.
To be sure that the pretty printing is well done, the output
file is parsed again.
<BR><BR>
Even if second parsing gives no errors, backup file is NOT
removed. Thus you can recompile your Eiffel code to check
new file before removing backup file by yourself.
</P>
<CENTER>
<IMG SRC="se-line.gif" ALT="[Line]">
<BR>
<FONT SIZE="-1"><I>
Copyright © Dominique COLNET and Suzanne COLLIN -
<A HREF="mailto:SmartEiffel@loria.fr"><SmartEiffel@loria.fr></A>
<BR>
<!-- hhmts start -->
Last modified: Tue Feb 11 12:16:31 CET 2003
<!-- hhmts end -->
<BR>
</I></FONT><BR></CENTER>
|
