-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
PrettyPrinterConfiguration.java
307 lines (269 loc) · 8.98 KB
/
PrettyPrinterConfiguration.java
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2016 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser.printer;
import sun.reflect.generics.reflectiveObjects.NotImplementedException;
import java.util.function.Function;
import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.SPACES;
import static com.github.javaparser.printer.PrettyPrinterConfiguration.IndentType.TABS;
import static com.github.javaparser.utils.Utils.EOL;
import static com.github.javaparser.utils.Utils.assertNonNegative;
import static com.github.javaparser.utils.Utils.assertNotNull;
import static com.github.javaparser.utils.Utils.assertPositive;
/**
* Configuration options for the {@link PrettyPrinter}.
*/
public class PrettyPrinterConfiguration {
public enum IndentType {
/**
* Indent with spaces.
*/
SPACES,
/**
* Indent with tabs as far as possible.
* For proper aligning, the tab width is necessary and by default 4.
*/
TABS,
/**
* Indent with tabs but align with spaces when wrapping and aligning
* method call chains and method call parameters.
*
* <p/><i>Example result:</i>
* <pre>
* class Foo {
*
* \tvoid bar() {
* \t\tfoo().bar()
* \t\t......baz(() -> {
* \t\t..........\tboo().baa()
* \t\t..........\t......bee(a,
* \t\t..........\t..........b,
* \t\t..........\t..........c);
* \t\t..........})
* \t\t......bam();
* \t}
* }
* </pre>
*/
TABS_WITH_SPACE_ALIGN
}
public static final int DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY = 5;
private boolean orderImports = false;
private boolean printComments = true;
private boolean printJavadoc = true;
private boolean columnAlignParameters = false;
private boolean columnAlignFirstMethodChain = false;
private IndentType indentType = SPACES;
private int tabWidth = 4;
private int indentSize = 4;
private String endOfLineCharacter = EOL;
private Function<PrettyPrinterConfiguration, PrettyPrintVisitor> visitorFactory = PrettyPrintVisitor::new;
private int maxEnumConstantsToAlignHorizontally = DEFAULT_MAX_ENUM_CONSTANTS_TO_ALIGN_HORIZONTALLY;
/**
* Set the string to use for indenting. For example: "\t", " ", "".
*
* @deprecated use {@link #setIndentSize(int)} and {@link #setIndentType(IndentType)}.
*/
@Deprecated
public PrettyPrinterConfiguration setIndent(String indent) {
System.err.println("PrettyPrinterConfiguration.setIndent is deprecated, please review the changes.");
if (indent.matches(" *")) {
indentSize = indent.length();
indentType = SPACES;
} else if (indent.matches("\\t+")) {
indentSize = indent.length();
indentType = TABS;
} else {
throw new NotImplementedException();
}
return this;
}
/**
* @return the string that will be used to indent.
*/
public String getIndent() {
StringBuilder indentString = new StringBuilder();
char indentChar;
switch (indentType) {
case SPACES:
indentChar = ' ';
break;
case TABS:
case TABS_WITH_SPACE_ALIGN:
indentChar = '\t';
break;
default:
throw new AssertionError("Unhandled indent type");
}
for (int i = 0; i < indentSize; i++) {
indentString.append(indentChar);
}
return indentString.toString();
}
public int getIndentSize() {
return indentSize;
}
/**
* Set the size of the indent in characters.
*/
public PrettyPrinterConfiguration setIndentSize(int indentSize) {
this.indentSize = assertNonNegative(indentSize);
return this;
}
/**
* Get the type of indent to produce.
*/
public IndentType getIndentType() {
return indentType;
}
/**
* Set the type of indent to produce.
*/
public PrettyPrinterConfiguration setIndentType(IndentType indentType) {
this.indentType = assertNotNull(indentType);
return this;
}
/**
* Get the tab width for pretty aligning.
*/
public int getTabWidth() {
return tabWidth;
}
/**
* Set the tab width for pretty aligning.
*/
public PrettyPrinterConfiguration setTabWidth(int tabWidth) {
this.tabWidth = assertPositive(tabWidth);
return this;
}
public boolean isOrderImports() {
return orderImports;
}
/**
* @deprecated this is always on.
*/
@Deprecated
public boolean isNormalizeEolInComment() {
return true;
}
/**
* @deprecated this is always on.
*/
@Deprecated
public PrettyPrinterConfiguration setNormalizeEolInComment(boolean normalizeEolInComment) {
return this;
}
public boolean isPrintComments() {
return printComments;
}
public boolean isIgnoreComments() {
return !printComments;
}
public boolean isPrintJavadoc() {
return printJavadoc;
}
public boolean isColumnAlignParameters() {
return columnAlignParameters;
}
public boolean isColumnAlignFirstMethodChain() {
return columnAlignFirstMethodChain;
}
/**
* When true, all comments will be printed, unless printJavadoc is false, then only line and block comments will be
* printed.
*/
public PrettyPrinterConfiguration setPrintComments(boolean printComments) {
this.printComments = printComments;
return this;
}
/**
* When true, Javadoc will be printed.
*/
public PrettyPrinterConfiguration setPrintJavadoc(boolean printJavadoc) {
this.printJavadoc = printJavadoc;
return this;
}
public PrettyPrinterConfiguration setColumnAlignParameters(boolean columnAlignParameters) {
this.columnAlignParameters = columnAlignParameters;
return this;
}
public PrettyPrinterConfiguration setColumnAlignFirstMethodChain(boolean columnAlignFirstMethodChain) {
this.columnAlignFirstMethodChain = columnAlignFirstMethodChain;
return this;
}
public Function<PrettyPrinterConfiguration, PrettyPrintVisitor> getVisitorFactory() {
return visitorFactory;
}
/**
* Set the factory that creates the PrettyPrintVisitor. By changing this you can make the PrettyPrinter use a custom
* PrettyPrinterVisitor.
*/
public PrettyPrinterConfiguration setVisitorFactory(Function<PrettyPrinterConfiguration, PrettyPrintVisitor> visitorFactory) {
this.visitorFactory = assertNotNull(visitorFactory);
return this;
}
public String getEndOfLineCharacter() {
return endOfLineCharacter;
}
/**
* Set the character to append when a line should end. Example values: "\n", "\r\n", "".
*/
public PrettyPrinterConfiguration setEndOfLineCharacter(String endOfLineCharacter) {
this.endOfLineCharacter = assertNotNull(endOfLineCharacter);
return this;
}
/**
* When true, orders imports by alphabetically.
*/
public PrettyPrinterConfiguration setOrderImports(boolean orderImports) {
this.orderImports = orderImports;
return this;
}
public int getMaxEnumConstantsToAlignHorizontally() {
return maxEnumConstantsToAlignHorizontally;
}
/**
* By default enum constants get aligned like this:
* <pre>
* enum X {
* A, B, C, D
* }
* </pre>
* until the amount of constants passes this value (5 by default).
* Then they get aligned like this:
* <pre>
* enum X {
* A,
* B,
* C,
* D,
* E,
* F,
* G
* }
* </pre>
* Set it to a large number to always align horizontally.
* Set it to 1 or less to always align vertically.
*/
public PrettyPrinterConfiguration setMaxEnumConstantsToAlignHorizontally(int maxEnumConstantsToAlignHorizontally) {
this.maxEnumConstantsToAlignHorizontally = maxEnumConstantsToAlignHorizontally;
return this;
}
}