summaryrefslogtreecommitdiff
path: root/sources/ch/epfl/lamp/util/CodePrinter.java
blob: 7bce133a43a95ad862148b74ac09e4c753d8454a (plain) (blame)
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
/*     ____ ____  ____ ____  ______                                     *\
**    / __// __ \/ __// __ \/ ____/    SOcos COmpiles Scala             **
**  __\_ \/ /_/ / /__/ /_/ /\_ \       (c) 2002, LAMP/EPFL              **
** /_____/\____/\___/\____/____/                                        **
\*                                                                      */

// $Id$

package ch.epfl.lamp.util;

import java.io.Writer;
import java.io.StringWriter;
import java.io.IOException;

/**
 * This class provides methods for printing code. It has support for
 * indentation and spacing.
 */
public class CodePrinter {

    //########################################################################
    // Public Constants

    /** The default indentation string */
    public static final String STEP = "    ";

    /** The line separator */
    public static final String LINE = System.getProperty("line.separator");

    //########################################################################
    // Private Fields

    /** The underlying writer */
    private final Writer writer;

    /** The indentation string */
    private String step;

    /** The indentation level */
    private int level;

    /** Do we need to align? */
    private boolean align;

    /** Do we need to print a white space? */
    private boolean space;

    /** Is there already a empty line? */
    private boolean line;

    //########################################################################
    // Public Constructors

    /** Creates a new instance. */
    public CodePrinter() {
        this(new StringWriter());
    }

    /** Creates a new instance. */
    public CodePrinter(String step) {
        this(new StringWriter(), step);
    }

    /** Creates a new instance. */
    public CodePrinter(Writer writer) {
        this(writer, STEP);
    }

    /** Creates a new instance. */
    public CodePrinter(Writer writer, String step) {
        this.writer = writer;
        this.step = step;
        this.level = 0;
        this.align = true;
        this.space = false;
        this.line = false;
    }

    //########################################################################
    // Public Methods - Getting & Setting

    /** Returns the underlying writer. */
    public Writer getWriter() {
        return writer;
    }

    /** Returns the indentation level. */
    public int getIndentLevel() {
        return level;
    }

    /** Returns the indentation width. */
    public int getIndentWidth() {
        return step == null ? -1 : step.length();
    }

    /** Returns the indentation string. */
    public String getIndentString() {
        return step;
    }

    /** Sets the indentation level. */
    public CodePrinter setIndentLevel(int level) {
        this.level = level;
        return this;
    }

    /** Sets the indentation width. */
    public CodePrinter setIndentWidth(int width) {
        StringBuffer buffer = new StringBuffer(width);
        for (int i = 0; i < width; i++) buffer.append(' ');
        return setIndentString(buffer.toString());
    }

    /** Sets the indentation string. */
    public CodePrinter setIndentString(String step) {
        this.step = step;
        return this;
    }

    //########################################################################
    // Public Methods - Formating

    /** Increases the indentation level by one. */
    public CodePrinter indent() {
        level++;
        return this;
    }

    /** Decreases the indentation level by one. */
    public CodePrinter undent() {
        level--;
        return this;
    }

    /** Inserts a new line. */
    public CodePrinter line() {
        if (step == null) return space();
        if (line) return this;
        write(LINE);
        line = align;
        align = true;
        space = false;
        return this;
    }

    /** Inserts a white space. */
    public CodePrinter space() {
        space = !align;
        return this;
    }

    //########################################################################
    // Public Methods - Printing

    /** Prints a new line. */
    public CodePrinter println() {
        return line();
    }

    /** Prints the boolean value followed by a new line. */
    public CodePrinter println(boolean value) {
        return print(value).line();
    }

    /** Prints the byte value followed by a new line. */
    public CodePrinter println(byte value) {
        return print(value).line();
    }

    /** Prints the short value followed by a new line. */
    public CodePrinter println(short value) {
        return print(value).line();
    }

    /** Prints the char value followed by a new line. */
    public CodePrinter println(char value) {
        return print(value).line();
    }

    /** Prints the int value followed by a new line. */
    public CodePrinter println(int value) {
        return print(value).line();
    }

    /** Prints the long value followed by a new line. */
    public CodePrinter println(long value) {
        return print(value).line();
    }

    /** Prints the float value followed by a new line. */
    public CodePrinter println(float value) {
        return print(value).line();
    }

    /** Prints the double value followed by a new line. */
    public CodePrinter println(double value) {
        return print(value).line();
    }

    /** Prints the string followed by a new line. */
    public CodePrinter println(String value) {
        return print(value).line();
    }

    /** Prints the boolean value. */
    public CodePrinter print(boolean value) {
        return print(String.valueOf(value));
    }

    /** Prints the byte value. */
    public CodePrinter print(byte value) {
        return print(String.valueOf(value));
    }

    /** Prints the short value. */
    public CodePrinter print(short value) {
        return print(String.valueOf(value));
    }

    /** Prints the char value. */
    public CodePrinter print(char value) {
        return print(String.valueOf(value));
    }

    /** Prints the int value. */
    public CodePrinter print(int value) {
        return print(String.valueOf(value));
    }

    /** Prints the long value. */
    public CodePrinter print(long value) {
        return print(String.valueOf(value));
    }

    /** Prints the float value. */
    public CodePrinter print(float value) {
        return print(String.valueOf(value));
    }

    /** Prints the long value. */
    public CodePrinter print(double value) {
        return print(String.valueOf(value));
    }

    /** Prints the string. */
    public CodePrinter print(String value) {
        if (align) for (int i = 0; i < level; i++) write(step);
        if (space) write(" ");
        write(value);
        align = false;
        space = false;
        line = false;
        return this;
    }

    //########################################################################
    // Public Methods - Converting

    /** Returns the string representation of this printer. */
    public String toString() {
        return writer.toString();
    }

    //########################################################################
    // Private Methods

    private void write(String string) {
        try {
            writer.write(string);
        } catch (IOException exception) {
            throw new Error(exception);
        }
    }

    //########################################################################
}