This repository has been archived by the owner on Sep 22, 2022. It is now read-only.
forked from checkstyle/checkstyle
/
Main.java
749 lines (664 loc) · 30.1 KB
/
Main.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.logging.ConsoleHandler;
import java.util.logging.Filter;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.google.common.io.Closeables;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.RootModule;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
/**
* Wrapper command line program for the Checker.
* @author the original author or authors.
* @noinspection UseOfSystemOutOrSystemErr
**/
public final class Main {
/**
* A key pointing to the error counter
* message in the "messages.properties" file.
*/
public static final String ERROR_COUNTER = "Main.errorCounter";
/**
* A key pointing to the load properties exception
* message in the "messages.properties" file.
*/
public static final String LOAD_PROPERTIES_EXCEPTION = "Main.loadProperties";
/**
* A key pointing to the create listener exception
* message in the "messages.properties" file.
*/
public static final String CREATE_LISTENER_EXCEPTION = "Main.createListener";
/** Logger for Main. */
private static final Log LOG = LogFactory.getLog(Main.class);
/** Width of CLI help option. */
private static final int HELP_WIDTH = 100;
/** Exit code returned when execution finishes with {@link CheckstyleException}. */
private static final int EXIT_WITH_CHECKSTYLE_EXCEPTION_CODE = -2;
/** Name for the option 'v'. */
private static final String OPTION_V_NAME = "v";
/** Name for the option 'c'. */
private static final String OPTION_C_NAME = "c";
/** Name for the option 'f'. */
private static final String OPTION_F_NAME = "f";
/** Name for the option 'p'. */
private static final String OPTION_P_NAME = "p";
/** Name for the option 'o'. */
private static final String OPTION_O_NAME = "o";
/** Name for the option 't'. */
private static final String OPTION_T_NAME = "t";
/** Name for the option '--tree'. */
private static final String OPTION_TREE_NAME = "tree";
/** Name for the option '-T'. */
private static final String OPTION_CAPITAL_T_NAME = "T";
/** Name for the option '--treeWithComments'. */
private static final String OPTION_TREE_COMMENT_NAME = "treeWithComments";
/** Name for the option '-j'. */
private static final String OPTION_J_NAME = "j";
/** Name for the option '--javadocTree'. */
private static final String OPTION_JAVADOC_TREE_NAME = "javadocTree";
/** Name for the option '-J'. */
private static final String OPTION_CAPITAL_J_NAME = "J";
/** Name for the option '--treeWithJavadoc'. */
private static final String OPTION_TREE_JAVADOC_NAME = "treeWithJavadoc";
/** Name for the option '-d'. */
private static final String OPTION_D_NAME = "d";
/** Name for the option '--debug'. */
private static final String OPTION_DEBUG_NAME = "debug";
/** Name for the option 'e'. */
private static final String OPTION_E_NAME = "e";
/** Name for the option '--exclude'. */
private static final String OPTION_EXCLUDE_NAME = "exclude";
/** Name for the option '--executeIgnoredModules'. */
private static final String OPTION_EXECUTE_IGNORED_MODULES_NAME = "executeIgnoredModules";
/** Name for the option 'x'. */
private static final String OPTION_X_NAME = "x";
/** Name for the option '--exclude-regexp'. */
private static final String OPTION_EXCLUDE_REGEXP_NAME = "exclude-regexp";
/** Name for the option '-C'. */
private static final String OPTION_CAPITAL_C_NAME = "C";
/** Name for the option '--checker-threads-number'. */
private static final String OPTION_CHECKER_THREADS_NUMBER_NAME = "checker-threads-number";
/** Name for the option '-W'. */
private static final String OPTION_CAPITAL_W_NAME = "W";
/** Name for the option '--tree-walker-threads-number'. */
private static final String OPTION_TREE_WALKER_THREADS_NUMBER_NAME =
"tree-walker-threads-number";
/** Name for 'xml' format. */
private static final String XML_FORMAT_NAME = "xml";
/** Name for 'plain' format. */
private static final String PLAIN_FORMAT_NAME = "plain";
/** A string value of 1. */
private static final String ONE_STRING_VALUE = "1";
/** Don't create instance of this class, use {@link #main(String[])} method instead. */
private Main() {
}
/**
* Loops over the files specified checking them for errors. The exit code
* is the number of errors found in all the files.
* @param args the command line arguments.
* @throws IOException if there is a problem with files access
* @noinspection CallToPrintStackTrace
**/
public static void main(String... args) throws IOException {
int errorCounter = 0;
boolean cliViolations = false;
// provide proper exit code based on results.
final int exitWithCliViolation = -1;
int exitStatus = 0;
try {
//parse CLI arguments
final CommandLine commandLine = parseCli(args);
// show version and exit if it is requested
if (commandLine.hasOption(OPTION_V_NAME)) {
System.out.println("Checkstyle version: "
+ Main.class.getPackage().getImplementationVersion());
exitStatus = 0;
}
else {
final List<File> filesToProcess = getFilesToProcess(getExclusions(commandLine),
commandLine.getArgs());
// return error if something is wrong in arguments
final List<String> messages = validateCli(commandLine, filesToProcess);
cliViolations = !messages.isEmpty();
if (cliViolations) {
exitStatus = exitWithCliViolation;
errorCounter = 1;
messages.forEach(System.out::println);
}
else {
errorCounter = runCli(commandLine, filesToProcess);
exitStatus = errorCounter;
}
}
}
catch (ParseException pex) {
// something wrong with arguments - print error and manual
cliViolations = true;
exitStatus = exitWithCliViolation;
errorCounter = 1;
System.out.println(pex.getMessage());
printUsage();
}
catch (CheckstyleException ex) {
exitStatus = EXIT_WITH_CHECKSTYLE_EXCEPTION_CODE;
errorCounter = 1;
ex.printStackTrace();
}
finally {
// return exit code base on validation of Checker
// two ifs exist till https://github.com/hcoles/pitest/issues/377
if (errorCounter != 0) {
if (!cliViolations) {
final LocalizedMessage errorCounterMessage = new LocalizedMessage(0,
Definitions.CHECKSTYLE_BUNDLE, ERROR_COUNTER,
new String[] {String.valueOf(errorCounter)}, null, Main.class, null);
System.out.println(errorCounterMessage.getMessage());
}
}
if (exitStatus != 0) {
System.exit(exitStatus);
}
}
}
/**
* Parses and executes Checkstyle based on passed arguments.
* @param args
* command line parameters
* @return parsed information about passed parameters
* @throws ParseException
* when passed arguments are not valid
*/
private static CommandLine parseCli(String... args)
throws ParseException {
// parse the parameters
final CommandLineParser clp = new DefaultParser();
// always returns not null value
return clp.parse(buildOptions(), args);
}
/**
* Gets the list of exclusions provided through the command line argument.
* @param commandLine command line object
* @return List of exclusion patterns.
*/
private static List<Pattern> getExclusions(CommandLine commandLine) {
final List<Pattern> result = new ArrayList<>();
if (commandLine.hasOption(OPTION_E_NAME)) {
for (String value : commandLine.getOptionValues(OPTION_E_NAME)) {
result.add(Pattern.compile("^" + Pattern.quote(new File(value).getAbsolutePath())
+ "$"));
}
}
if (commandLine.hasOption(OPTION_X_NAME)) {
for (String value : commandLine.getOptionValues(OPTION_X_NAME)) {
result.add(Pattern.compile(value));
}
}
return result;
}
/**
* Do validation of Command line options.
* @param cmdLine command line object
* @param filesToProcess List of files to process found from the command line.
* @return list of violations
*/
// -@cs[CyclomaticComplexity] Breaking apart will damage encapsulation
private static List<String> validateCli(CommandLine cmdLine, List<File> filesToProcess) {
final List<String> result = new ArrayList<>();
if (filesToProcess.isEmpty()) {
result.add("Files to process must be specified, found 0.");
}
// ensure there is no conflicting options
else if (cmdLine.hasOption(OPTION_T_NAME) || cmdLine.hasOption(OPTION_CAPITAL_T_NAME)
|| cmdLine.hasOption(OPTION_J_NAME) || cmdLine.hasOption(OPTION_CAPITAL_J_NAME)) {
if (cmdLine.hasOption(OPTION_C_NAME) || cmdLine.hasOption(OPTION_P_NAME)
|| cmdLine.hasOption(OPTION_F_NAME) || cmdLine.hasOption(OPTION_O_NAME)) {
result.add("Option '-t' cannot be used with other options.");
}
else if (filesToProcess.size() > 1) {
result.add("Printing AST is allowed for only one file.");
}
}
// ensure a configuration file is specified
else if (cmdLine.hasOption(OPTION_C_NAME)) {
final String configLocation = cmdLine.getOptionValue(OPTION_C_NAME);
try {
// test location only
CommonUtils.getUriByFilename(configLocation);
}
catch (CheckstyleException ignored) {
result.add(String.format("Could not find config XML file '%s'.", configLocation));
}
// validate optional parameters
if (cmdLine.hasOption(OPTION_F_NAME)) {
final String format = cmdLine.getOptionValue(OPTION_F_NAME);
if (!PLAIN_FORMAT_NAME.equals(format) && !XML_FORMAT_NAME.equals(format)) {
result.add(String.format("Invalid output format."
+ " Found '%s' but expected '%s' or '%s'.",
format, PLAIN_FORMAT_NAME, XML_FORMAT_NAME));
}
}
if (cmdLine.hasOption(OPTION_P_NAME)) {
final String propertiesLocation = cmdLine.getOptionValue(OPTION_P_NAME);
final File file = new File(propertiesLocation);
if (!file.exists()) {
result.add(String.format("Could not find file '%s'.", propertiesLocation));
}
}
verifyThreadsNumberParameter(cmdLine, result, OPTION_CAPITAL_C_NAME,
"Checker threads number must be greater than zero",
"Invalid Checker threads number");
verifyThreadsNumberParameter(cmdLine, result, OPTION_CAPITAL_W_NAME,
"TreeWalker threads number must be greater than zero",
"Invalid TreeWalker threads number");
}
else {
result.add("Must specify a config XML file.");
}
return result;
}
/**
* Verifies threads number CLI parameter value.
* @param cmdLine a command line
* @param result a resulting list of errors
* @param cliParameterName a CLI parameter name
* @param mustBeGreaterThanZeroMessage a message which should be reported
* if the number of threads is less than or equal to zero
* @param invalidNumberMessage a message which should be reported if the passed value
* is not a valid number
*/
private static void verifyThreadsNumberParameter(CommandLine cmdLine, List<String> result,
String cliParameterName, String mustBeGreaterThanZeroMessage,
String invalidNumberMessage) {
if (cmdLine.hasOption(cliParameterName)) {
final String checkerThreadsNumberStr =
cmdLine.getOptionValue(cliParameterName);
if (CommonUtils.isInt(checkerThreadsNumberStr)) {
final int checkerThreadsNumber = Integer.parseInt(checkerThreadsNumberStr);
if (checkerThreadsNumber < 1) {
result.add(mustBeGreaterThanZeroMessage);
}
}
else {
result.add(invalidNumberMessage);
}
}
}
/**
* Do execution of CheckStyle based on Command line options.
* @param commandLine command line object
* @param filesToProcess List of files to process found from the command line.
* @return number of violations
* @throws IOException if a file could not be read.
* @throws CheckstyleException if something happens processing the files.
*/
private static int runCli(CommandLine commandLine, List<File> filesToProcess)
throws IOException, CheckstyleException {
int result = 0;
// create config helper object
final CliOptions config = convertCliToPojo(commandLine, filesToProcess);
if (commandLine.hasOption(OPTION_T_NAME)) {
// print AST
final File file = config.files.get(0);
final String stringAst = AstTreeStringPrinter.printFileAst(file, false);
System.out.print(stringAst);
}
else if (commandLine.hasOption(OPTION_CAPITAL_T_NAME)) {
final File file = config.files.get(0);
final String stringAst = AstTreeStringPrinter.printFileAst(file, true);
System.out.print(stringAst);
}
else if (commandLine.hasOption(OPTION_J_NAME)) {
final File file = config.files.get(0);
final String stringAst = DetailNodeTreeStringPrinter.printFileAst(file);
System.out.print(stringAst);
}
else if (commandLine.hasOption(OPTION_CAPITAL_J_NAME)) {
final File file = config.files.get(0);
final String stringAst = AstTreeStringPrinter.printJavaAndJavadocTree(file);
System.out.print(stringAst);
}
else {
if (commandLine.hasOption(OPTION_D_NAME)) {
final Logger parentLogger = Logger.getLogger(Main.class.getName()).getParent();
final ConsoleHandler handler = new ConsoleHandler();
handler.setLevel(Level.FINEST);
handler.setFilter(new Filter() {
private final String packageName = Main.class.getPackage().getName();
@Override
public boolean isLoggable(LogRecord record) {
return record.getLoggerName().startsWith(packageName);
}
});
parentLogger.addHandler(handler);
parentLogger.setLevel(Level.FINEST);
}
if (LOG.isDebugEnabled()) {
LOG.debug("Checkstyle debug logging enabled");
LOG.debug("Running Checkstyle with version: "
+ Main.class.getPackage().getImplementationVersion());
}
// run Checker
result = runCheckstyle(config);
}
return result;
}
/**
* Util method to convert CommandLine type to POJO object.
* @param cmdLine command line object
* @param filesToProcess List of files to process found from the command line.
* @return command line option as POJO object
*/
private static CliOptions convertCliToPojo(CommandLine cmdLine, List<File> filesToProcess) {
final CliOptions conf = new CliOptions();
conf.format = cmdLine.getOptionValue(OPTION_F_NAME);
if (conf.format == null) {
conf.format = PLAIN_FORMAT_NAME;
}
conf.outputLocation = cmdLine.getOptionValue(OPTION_O_NAME);
conf.configLocation = cmdLine.getOptionValue(OPTION_C_NAME);
conf.propertiesLocation = cmdLine.getOptionValue(OPTION_P_NAME);
conf.files = filesToProcess;
conf.executeIgnoredModules = cmdLine.hasOption(OPTION_EXECUTE_IGNORED_MODULES_NAME);
final String checkerThreadsNumber = cmdLine.getOptionValue(
OPTION_CAPITAL_C_NAME, ONE_STRING_VALUE);
conf.checkerThreadsNumber = Integer.parseInt(checkerThreadsNumber);
final String treeWalkerThreadsNumber = cmdLine.getOptionValue(
OPTION_CAPITAL_W_NAME, ONE_STRING_VALUE);
conf.treeWalkerThreadsNumber = Integer.parseInt(treeWalkerThreadsNumber);
return conf;
}
/**
* Executes required Checkstyle actions based on passed parameters.
* @param cliOptions
* pojo object that contains all options
* @return number of violations of ERROR level
* @throws FileNotFoundException
* when output file could not be found
* @throws CheckstyleException
* when properties file could not be loaded
*/
private static int runCheckstyle(CliOptions cliOptions)
throws CheckstyleException, FileNotFoundException {
// setup the properties
final Properties props;
if (cliOptions.propertiesLocation == null) {
props = System.getProperties();
}
else {
props = loadProperties(new File(cliOptions.propertiesLocation));
}
// create a configuration
final ThreadModeSettings multiThreadModeSettings =
new ThreadModeSettings(
cliOptions.checkerThreadsNumber, cliOptions.treeWalkerThreadsNumber);
final Configuration config = ConfigurationLoader.loadConfiguration(
cliOptions.configLocation, new PropertiesExpander(props),
!cliOptions.executeIgnoredModules, multiThreadModeSettings);
// create a listener for output
final AuditListener listener = createListener(cliOptions.format, cliOptions.outputLocation);
// create RootModule object and run it
final int errorCounter;
final ClassLoader moduleClassLoader = Checker.class.getClassLoader();
final RootModule rootModule = getRootModule(config.getName(), moduleClassLoader);
try {
rootModule.setModuleClassLoader(moduleClassLoader);
rootModule.configure(config);
rootModule.addListener(listener);
// run RootModule
errorCounter = rootModule.process(cliOptions.files);
}
finally {
rootModule.destroy();
}
return errorCounter;
}
/**
* Creates a new instance of the root module that will control and run
* Checkstyle.
* @param name The name of the module. This will either be a short name that
* will have to be found or the complete package name.
* @param moduleClassLoader Class loader used to load the root module.
* @return The new instance of the root module.
* @throws CheckstyleException if no module can be instantiated from name
*/
private static RootModule getRootModule(String name, ClassLoader moduleClassLoader)
throws CheckstyleException {
final ModuleFactory factory = new PackageObjectFactory(
Checker.class.getPackage().getName(), moduleClassLoader);
return (RootModule) factory.createModule(name);
}
/**
* Loads properties from a File.
* @param file
* the properties file
* @return the properties in file
* @throws CheckstyleException
* when could not load properties file
*/
private static Properties loadProperties(File file)
throws CheckstyleException {
final Properties properties = new Properties();
FileInputStream fis = null;
try {
fis = new FileInputStream(file);
properties.load(fis);
}
catch (final IOException ex) {
final LocalizedMessage loadPropertiesExceptionMessage = new LocalizedMessage(0,
Definitions.CHECKSTYLE_BUNDLE, LOAD_PROPERTIES_EXCEPTION,
new String[] {file.getAbsolutePath()}, null, Main.class, null);
throw new CheckstyleException(loadPropertiesExceptionMessage.getMessage(), ex);
}
finally {
Closeables.closeQuietly(fis);
}
return properties;
}
/**
* Creates the audit listener.
*
* @param format format of the audit listener
* @param outputLocation the location of output
* @return a fresh new {@code AuditListener}
* @exception FileNotFoundException when provided output location is not found
* @noinspection IOResourceOpenedButNotSafelyClosed
*/
private static AuditListener createListener(String format,
String outputLocation)
throws FileNotFoundException {
// setup the output stream
final OutputStream out;
final boolean closeOutputStream;
if (outputLocation == null) {
out = System.out;
closeOutputStream = false;
}
else {
out = new FileOutputStream(outputLocation);
closeOutputStream = true;
}
// setup a listener
final AuditListener listener;
if (XML_FORMAT_NAME.equals(format)) {
listener = new XMLLogger(out, closeOutputStream);
}
else if (PLAIN_FORMAT_NAME.equals(format)) {
listener = new DefaultLogger(out, closeOutputStream, out, false);
}
else {
if (closeOutputStream) {
CommonUtils.close(out);
}
final LocalizedMessage outputFormatExceptionMessage = new LocalizedMessage(0,
Definitions.CHECKSTYLE_BUNDLE, CREATE_LISTENER_EXCEPTION,
new String[] {format, PLAIN_FORMAT_NAME, XML_FORMAT_NAME}, null,
Main.class, null);
throw new IllegalStateException(outputFormatExceptionMessage.getMessage());
}
return listener;
}
/**
* Determines the files to process.
* @param patternsToExclude The list of directory patterns to exclude from searching.
* @param filesToProcess
* arguments that were not processed yet but shall be
* @return list of files to process
*/
private static List<File> getFilesToProcess(List<Pattern> patternsToExclude,
String... filesToProcess) {
final List<File> files = new LinkedList<>();
for (String element : filesToProcess) {
files.addAll(listFiles(new File(element), patternsToExclude));
}
return files;
}
/**
* Traverses a specified node looking for files to check. Found files are added to a specified
* list. Subdirectories are also traversed.
* @param node
* the node to process
* @param patternsToExclude The list of directory patterns to exclude from searching.
* @return found files
*/
private static List<File> listFiles(File node, List<Pattern> patternsToExclude) {
// could be replaced with org.apache.commons.io.FileUtils.list() method
// if only we add commons-io library
final List<File> result = new LinkedList<>();
if (node.canRead()) {
if (node.isDirectory()) {
if (!isDirectoryExcluded(node.getAbsolutePath(), patternsToExclude)) {
final File[] files = node.listFiles();
// listFiles() can return null, so we need to check it
if (files != null) {
for (File element : files) {
result.addAll(listFiles(element, patternsToExclude));
}
}
}
}
else if (node.isFile()) {
result.add(node);
}
}
return result;
}
/**
* Checks if a directory {@code path} should be excluded based on if it matches one of the
* patterns supplied.
* @param path The path of the directory to check
* @param patternsToExclude The list of directory patterns to exclude from searching.
* @return True if the directory matches one of the patterns.
*/
private static boolean isDirectoryExcluded(String path, List<Pattern> patternsToExclude) {
boolean result = false;
for (Pattern pattern : patternsToExclude) {
if (pattern.matcher(path).find()) {
result = true;
break;
}
}
return result;
}
/** Prints the usage information. **/
private static void printUsage() {
final HelpFormatter formatter = new HelpFormatter();
formatter.setWidth(HELP_WIDTH);
formatter.printHelp(String.format("java %s [options] -c <config.xml> file...",
Main.class.getName()), buildOptions());
}
/**
* Builds and returns list of parameters supported by cli Checkstyle.
* @return available options
*/
private static Options buildOptions() {
final Options options = new Options();
options.addOption(OPTION_C_NAME, true, "Sets the check configuration file to use.");
options.addOption(OPTION_O_NAME, true, "Sets the output file. Defaults to stdout");
options.addOption(OPTION_P_NAME, true, "Loads the properties file");
options.addOption(OPTION_F_NAME, true, String.format(
"Sets the output format. (%s|%s). Defaults to %s",
PLAIN_FORMAT_NAME, XML_FORMAT_NAME, PLAIN_FORMAT_NAME));
options.addOption(OPTION_V_NAME, false, "Print product version and exit");
options.addOption(OPTION_T_NAME, OPTION_TREE_NAME, false,
"Print Abstract Syntax Tree(AST) of the file");
options.addOption(OPTION_CAPITAL_T_NAME, OPTION_TREE_COMMENT_NAME, false,
"Print Abstract Syntax Tree(AST) of the file including comments");
options.addOption(OPTION_J_NAME, OPTION_JAVADOC_TREE_NAME, false,
"Print Parse tree of the Javadoc comment");
options.addOption(OPTION_CAPITAL_J_NAME, OPTION_TREE_JAVADOC_NAME, false,
"Print full Abstract Syntax Tree of the file");
options.addOption(OPTION_D_NAME, OPTION_DEBUG_NAME, false,
"Print all debug logging of CheckStyle utility");
options.addOption(OPTION_E_NAME, OPTION_EXCLUDE_NAME, true,
"Directory path to exclude from CheckStyle");
options.addOption(OPTION_X_NAME, OPTION_EXCLUDE_REGEXP_NAME, true,
"Regular expression of directory to exclude from CheckStyle");
options.addOption(OPTION_EXECUTE_IGNORED_MODULES_NAME, false,
"Allows ignored modules to be run.");
options.addOption(OPTION_CAPITAL_C_NAME, OPTION_CHECKER_THREADS_NUMBER_NAME, true,
"(experimental) The number of Checker threads (must be greater than zero)");
options.addOption(OPTION_CAPITAL_W_NAME, OPTION_TREE_WALKER_THREADS_NUMBER_NAME, true,
"(experimental) The number of TreeWalker threads (must be greater than zero)");
return options;
}
/** Helper structure to clear show what is required for Checker to run. **/
private static class CliOptions {
/** Properties file location. */
private String propertiesLocation;
/** Config file location. */
private String configLocation;
/** Output format. */
private String format;
/** Output file location. */
private String outputLocation;
/** List of file to validate. */
private List<File> files;
/** Switch whether to execute ignored modules or not. */
private boolean executeIgnoredModules;
/** The checker threads number. */
private int checkerThreadsNumber;
/** The tree walker threads number. */
private int treeWalkerThreadsNumber;
}
}