1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.tools.picocli;
18
19 import java.io.File;
20 import java.io.PrintStream;
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25 import java.lang.reflect.Array;
26 import java.lang.reflect.Constructor;
27 import java.lang.reflect.Field;
28 import java.lang.reflect.ParameterizedType;
29 import java.lang.reflect.Type;
30 import java.lang.reflect.WildcardType;
31 import java.math.BigDecimal;
32 import java.math.BigInteger;
33 import java.net.InetAddress;
34 import java.net.MalformedURLException;
35 import java.net.URI;
36 import java.net.URISyntaxException;
37 import java.net.URL;
38 import java.nio.charset.Charset;
39 import java.nio.file.Path;
40 import java.nio.file.Paths;
41 import java.sql.Time;
42 import java.text.BreakIterator;
43 import java.text.ParseException;
44 import java.text.SimpleDateFormat;
45 import java.util.ArrayList;
46 import java.util.Arrays;
47 import java.util.Collection;
48 import java.util.Collections;
49 import java.util.Comparator;
50 import java.util.Date;
51 import java.util.HashMap;
52 import java.util.HashSet;
53 import java.util.LinkedHashMap;
54 import java.util.LinkedHashSet;
55 import java.util.LinkedList;
56 import java.util.List;
57 import java.util.Map;
58 import java.util.Queue;
59 import java.util.Set;
60 import java.util.SortedSet;
61 import java.util.Stack;
62 import java.util.TreeSet;
63 import java.util.UUID;
64 import java.util.concurrent.Callable;
65 import java.util.regex.Pattern;
66
67 import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.IStyle;
68 import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Style;
69 import org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text;
70
71 import static java.util.Locale.ENGLISH;
72 import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.SPAN;
73 import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.TRUNCATE;
74 import static org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column.Overflow.WRAP;
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 public class CommandLine {
134
135 public static final String VERSION = "2.0.3";
136
137 private final Tracer tracer = new Tracer();
138 private final Interpreter interpreter;
139 private String commandName = Help.DEFAULT_COMMAND_NAME;
140 private boolean overwrittenOptionsAllowed = false;
141 private boolean unmatchedArgumentsAllowed = false;
142 private List<String> unmatchedArguments = new ArrayList<String>();
143 private CommandLine parent;
144 private boolean usageHelpRequested;
145 private boolean versionHelpRequested;
146 private List<String> versionLines = new ArrayList<String>();
147
148
149
150
151
152
153
154
155 public CommandLine(Object command) {
156 interpreter = new Interpreter(command);
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 public CommandLine addSubcommand(String name, Object command) {
201 CommandLine commandLine = toCommandLine(command);
202 commandLine.parent = this;
203 interpreter.commands.put(name, commandLine);
204 return this;
205 }
206
207
208
209
210 public Map<String, CommandLine> getSubcommands() {
211 return new LinkedHashMap<String, CommandLine>(interpreter.commands);
212 }
213
214
215
216
217
218
219
220 public CommandLine getParent() {
221 return parent;
222 }
223
224
225
226
227
228
229 public <T> T getCommand() {
230 return (T) interpreter.command;
231 }
232
233
234
235
236 public boolean isUsageHelpRequested() { return usageHelpRequested; }
237
238
239
240
241 public boolean isVersionHelpRequested() { return versionHelpRequested; }
242
243
244
245
246
247
248
249 public boolean isOverwrittenOptionsAllowed() {
250 return overwrittenOptionsAllowed;
251 }
252
253
254
255
256
257
258
259
260
261
262 public CommandLine setOverwrittenOptionsAllowed(boolean newValue) {
263 this.overwrittenOptionsAllowed = newValue;
264 for (CommandLine command : interpreter.commands.values()) {
265 command.setOverwrittenOptionsAllowed(newValue);
266 }
267 return this;
268 }
269
270
271
272
273
274
275
276
277 public boolean isUnmatchedArgumentsAllowed() {
278 return unmatchedArgumentsAllowed;
279 }
280
281
282
283
284
285
286
287
288
289
290
291 public CommandLine setUnmatchedArgumentsAllowed(boolean newValue) {
292 this.unmatchedArgumentsAllowed = newValue;
293 for (CommandLine command : interpreter.commands.values()) {
294 command.setUnmatchedArgumentsAllowed(newValue);
295 }
296 return this;
297 }
298
299
300
301
302
303
304 public List<String> getUnmatchedArguments() {
305 return unmatchedArguments;
306 }
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 public static <T> T populateCommand(T command, String... args) {
329 CommandLine cli = toCommandLine(command);
330 cli.parse(args);
331 return command;
332 }
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348 public List<CommandLine> parse(String... args) {
349 return interpreter.parse(args);
350 }
351
352
353
354
355
356
357
358
359
360
361
362
363
364 public static interface IParseResultHandler {
365
366
367
368
369
370
371
372
373
374 List<Object> handleParseResult(List<CommandLine> parsedCommands, PrintStream out, Help.Ansi ansi) throws ExecutionException;
375 }
376
377
378
379
380
381
382
383
384
385
386
387 public static interface IExceptionHandler {
388
389
390
391
392
393
394
395
396
397 List<Object> handleException(ParameterException ex, PrintStream out, Help.Ansi ansi, String... args);
398 }
399
400
401
402
403
404
405
406
407
408 public static class DefaultExceptionHandler implements IExceptionHandler {
409 @Override
410 public List<Object> handleException(ParameterException ex, PrintStream out, Help.Ansi ansi, String... args) {
411 out.println(ex.getMessage());
412 ex.getCommandLine().usage(out, ansi);
413 return Collections.emptyList();
414 }
415 }
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432 public static boolean printHelpIfRequested(List<CommandLine> parsedCommands, PrintStream out, Help.Ansi ansi) {
433 for (CommandLine parsed : parsedCommands) {
434 if (parsed.isUsageHelpRequested()) {
435 parsed.usage(out, ansi);
436 return true;
437 } else if (parsed.isVersionHelpRequested()) {
438 parsed.printVersionHelp(out, ansi);
439 return true;
440 }
441 }
442 return false;
443 }
444 private static Object execute(CommandLine parsed) {
445 Object command = parsed.getCommand();
446 if (command instanceof Runnable) {
447 try {
448 ((Runnable) command).run();
449 return null;
450 } catch (Exception ex) {
451 throw new ExecutionException(parsed, "Error while running command (" + command + ")", ex);
452 }
453 } else if (command instanceof Callable) {
454 try {
455 return ((Callable<Object>) command).call();
456 } catch (Exception ex) {
457 throw new ExecutionException(parsed, "Error while calling command (" + command + ")", ex);
458 }
459 }
460 throw new ExecutionException(parsed, "Parsed command (" + command + ") is not Runnable or Callable");
461 }
462
463
464
465
466
467
468
469
470
471 public static class RunFirst implements IParseResultHandler {
472
473
474
475
476
477
478
479
480
481
482
483
484 public List<Object> handleParseResult(List<CommandLine> parsedCommands, PrintStream out, Help.Ansi ansi) {
485 if (printHelpIfRequested(parsedCommands, out, ansi)) { return Collections.emptyList(); }
486 return Arrays.asList(execute(parsedCommands.get(0)));
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 public static class RunLast implements IParseResultHandler {
522
523
524
525
526
527
528
529
530
531
532
533
534 public List<Object> handleParseResult(List<CommandLine> parsedCommands, PrintStream out, Help.Ansi ansi) {
535 if (printHelpIfRequested(parsedCommands, out, ansi)) { return Collections.emptyList(); }
536 CommandLine last = parsedCommands.get(parsedCommands.size() - 1);
537 return Arrays.asList(execute(last));
538 }
539 }
540
541
542
543
544
545 public static class RunAll implements IParseResultHandler {
546
547
548
549
550
551
552
553
554
555
556
557
558
559 public List<Object> handleParseResult(List<CommandLine> parsedCommands, PrintStream out, Help.Ansi ansi) {
560 if (printHelpIfRequested(parsedCommands, out, ansi)) {
561 return null;
562 }
563 List<Object> result = new ArrayList<Object>();
564 for (CommandLine parsed : parsedCommands) {
565 result.add(execute(parsed));
566 }
567 return result;
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 public List<Object> parseWithHandler(IParseResultHandler handler, PrintStream out, String... args) {
608 return parseWithHandlers(handler, out, Help.Ansi.AUTO, new DefaultExceptionHandler(), args);
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 public List<Object> parseWithHandlers(IParseResultHandler handler, PrintStream out, Help.Ansi ansi, IExceptionHandler exceptionHandler, String... args) {
653 try {
654 List<CommandLine> result = parse(args);
655 return handler.handleParseResult(result, out, ansi);
656 } catch (ParameterException ex) {
657 return exceptionHandler.handleException(ex, out, ansi, args);
658 }
659 }
660
661
662
663
664
665
666 public static void usage(Object command, PrintStream out) {
667 toCommandLine(command).usage(out);
668 }
669
670
671
672
673
674
675
676
677
678 public static void usage(Object command, PrintStream out, Help.Ansi ansi) {
679 toCommandLine(command).usage(out, ansi);
680 }
681
682
683
684
685
686
687
688
689
690 public static void usage(Object command, PrintStream out, Help.ColorScheme colorScheme) {
691 toCommandLine(command).usage(out, colorScheme);
692 }
693
694
695
696
697
698
699 public void usage(PrintStream out) {
700 usage(out, Help.Ansi.AUTO);
701 }
702
703
704
705
706
707
708
709 public void usage(PrintStream out, Help.Ansi ansi) {
710 usage(out, Help.defaultColorScheme(ansi));
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 public void usage(PrintStream out, Help.ColorScheme colorScheme) {
745 Help help = new Help(interpreter.command, colorScheme).addAllSubcommands(getSubcommands());
746 if (!Help.DEFAULT_SEPARATOR.equals(getSeparator())) {
747 help.separator = getSeparator();
748 help.parameterLabelRenderer = help.createDefaultParamLabelRenderer();
749 }
750 if (!Help.DEFAULT_COMMAND_NAME.equals(getCommandName())) {
751 help.commandName = getCommandName();
752 }
753 StringBuilder sb = new StringBuilder()
754 .append(help.headerHeading())
755 .append(help.header())
756 .append(help.synopsisHeading())
757 .append(help.synopsis(help.synopsisHeadingLength()))
758 .append(help.descriptionHeading())
759 .append(help.description())
760 .append(help.parameterListHeading())
761 .append(help.parameterList())
762 .append(help.optionListHeading())
763 .append(help.optionList())
764 .append(help.commandListHeading())
765 .append(help.commandList())
766 .append(help.footerHeading())
767 .append(help.footer());
768 out.print(sb);
769 }
770
771
772
773
774
775
776
777 public void printVersionHelp(PrintStream out) { printVersionHelp(out, Help.Ansi.AUTO); }
778
779
780
781
782
783
784
785
786
787
788
789
790 public void printVersionHelp(PrintStream out, Help.Ansi ansi) {
791 for (String versionInfo : versionLines) {
792 out.println(ansi.new Text(versionInfo));
793 }
794 }
795
796
797
798
799
800
801
802
803
804
805
806
807
808 public void printVersionHelp(PrintStream out, Help.Ansi ansi, Object... params) {
809 for (String versionInfo : versionLines) {
810 out.println(ansi.new Text(String.format(versionInfo, params)));
811 }
812 }
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832 public static <C extends Callable<T>, T> T call(C callable, PrintStream out, String... args) {
833 return call(callable, out, Help.Ansi.AUTO, args);
834 }
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880 public static <C extends Callable<T>, T> T call(C callable, PrintStream out, Help.Ansi ansi, String... args) {
881 CommandLine cmd = new CommandLine(callable);
882 List<Object> results = cmd.parseWithHandlers(new RunLast(), out, ansi, new DefaultExceptionHandler(), args);
883 return results == null || results.isEmpty() ? null : (T) results.get(0);
884 }
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902 public static <R extends Runnable> void run(R runnable, PrintStream out, String... args) {
903 run(runnable, out, Help.Ansi.AUTO, args);
904 }
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948 public static <R extends Runnable> void run(R runnable, PrintStream out, Help.Ansi ansi, String... args) {
949 CommandLine cmd = new CommandLine(runnable);
950 cmd.parseWithHandlers(new RunLast(), out, ansi, new DefaultExceptionHandler(), args);
951 }
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996 public <K> CommandLine registerConverter(Class<K> cls, ITypeConverter<K> converter) {
997 interpreter.converterRegistry.put(Assert.notNull(cls, "class"), Assert.notNull(converter, "converter"));
998 for (CommandLine command : interpreter.commands.values()) {
999 command.registerConverter(cls, converter);
1000 }
1001 return this;
1002 }
1003
1004
1005
1006 public String getSeparator() {
1007 return interpreter.separator;
1008 }
1009
1010
1011
1012
1013
1014 public CommandLine setSeparator(String separator) {
1015 interpreter.separator = Assert.notNull(separator, "separator");
1016 return this;
1017 }
1018
1019
1020
1021 public String getCommandName() {
1022 return commandName;
1023 }
1024
1025
1026
1027
1028
1029
1030 public CommandLine setCommandName(String commandName) {
1031 this.commandName = Assert.notNull(commandName, "commandName");
1032 return this;
1033 }
1034 private static boolean empty(String str) { return str == null || str.trim().length() == 0; }
1035 private static boolean empty(Object[] array) { return array == null || array.length == 0; }
1036 private static boolean empty(Text txt) { return txt == null || txt.plain.toString().trim().length() == 0; }
1037 private static String str(String[] arr, int i) { return (arr == null || arr.length == 0) ? "" : arr[i]; }
1038 private static boolean isBoolean(Class<?> type) { return type == Boolean.class || type == Boolean.TYPE; }
1039 private static CommandLine toCommandLine(Object obj) { return obj instanceof CommandLine ? (CommandLine) obj : new CommandLine(obj);}
1040 private static boolean isMultiValue(Field field) { return isMultiValue(field.getType()); }
1041 private static boolean isMultiValue(Class<?> cls) { return cls.isArray() || Collection.class.isAssignableFrom(cls) || Map.class.isAssignableFrom(cls); }
1042 private static Class<?>[] getTypeAttribute(Field field) {
1043 Class<?>[] explicit = field.isAnnotationPresent(Parameters.class) ? field.getAnnotation(Parameters.class).type() : field.getAnnotation(Option.class).type();
1044 if (explicit.length > 0) { return explicit; }
1045 if (field.getType().isArray()) { return new Class<?>[] { field.getType().getComponentType() }; }
1046 if (isMultiValue(field)) {
1047 Type type = field.getGenericType();
1048 if (type instanceof ParameterizedType) {
1049 ParameterizedType parameterizedType = (ParameterizedType) type;
1050 Type[] paramTypes = parameterizedType.getActualTypeArguments();
1051 Class<?>[] result = new Class<?>[paramTypes.length];
1052 for (int i = 0; i < paramTypes.length; i++) {
1053 if (paramTypes[i] instanceof Class) { result[i] = (Class<?>) paramTypes[i]; continue; }
1054 if (paramTypes[i] instanceof WildcardType) {
1055 WildcardType wildcardType = (WildcardType) paramTypes[i];
1056 Type[] lower = wildcardType.getLowerBounds();
1057 if (lower.length > 0 && lower[0] instanceof Class) { result[i] = (Class<?>) lower[0]; continue; }
1058 Type[] upper = wildcardType.getUpperBounds();
1059 if (upper.length > 0 && upper[0] instanceof Class) { result[i] = (Class<?>) upper[0]; continue; }
1060 }
1061 Arrays.fill(result, String.class); return result;
1062 }
1063 return result;
1064 }
1065 return new Class<?>[] {String.class, String.class};
1066 }
1067 return new Class<?>[] {field.getType()};
1068 }
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100 @Retention(RetentionPolicy.RUNTIME)
1101 @Target(ElementType.FIELD)
1102 public @interface Option {
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145 String[] names();
1146
1147
1148
1149
1150
1151
1152
1153 boolean required() default false;
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171 boolean help() default false;
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189 boolean usageHelp() default false;
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207 boolean versionHelp() default false;
1208
1209
1210
1211
1212
1213 String[] description() default {};
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254 String arity() default "";
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272 String paramLabel() default "";
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301 Class<?>[] type() default {};
1302
1303
1304
1305
1306
1307
1308
1309 String split() default "";
1310
1311
1312
1313
1314
1315 boolean hidden() default false;
1316 }
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342 @Retention(RetentionPolicy.RUNTIME)
1343 @Target(ElementType.FIELD)
1344 public @interface Parameters {
1345
1346
1347
1348
1349
1350 String index() default "*";
1351
1352
1353
1354
1355 String[] description() default {};
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365 String arity() default "";
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380 String paramLabel() default "";
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410 Class<?>[] type() default {};
1411
1412
1413
1414
1415
1416
1417
1418 String split() default "";
1419
1420
1421
1422
1423
1424 boolean hidden() default false;
1425 }
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451 @Retention(RetentionPolicy.RUNTIME)
1452 @Target({ElementType.TYPE, ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
1453 public @interface Command {
1454
1455
1456
1457
1458
1459 String name() default "<main class>";
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486 Class<?>[] subcommands() default {};
1487
1488
1489
1490
1491
1492 String separator() default "=";
1493
1494
1495
1496
1497
1498
1499
1500
1501 String[] version() default {};
1502
1503
1504
1505
1506 String headerHeading() default "";
1507
1508
1509
1510
1511
1512 String[] header() default {};
1513
1514
1515
1516
1517
1518
1519 String synopsisHeading() default "Usage: ";
1520
1521
1522
1523
1524
1525
1526
1527 boolean abbreviateSynopsis() default false;
1528
1529
1530
1531
1532
1533 String[] customSynopsis() default {};
1534
1535
1536
1537
1538 String descriptionHeading() default "";
1539
1540
1541
1542
1543
1544 String[] description() default {};
1545
1546
1547
1548
1549 String parameterListHeading() default "";
1550
1551
1552
1553
1554 String optionListHeading() default "";
1555
1556
1557
1558
1559 boolean sortOptions() default true;
1560
1561
1562
1563
1564
1565 char requiredOptionMarker() default ' ';
1566
1567
1568
1569
1570
1571 boolean showDefaultValues() default false;
1572
1573
1574
1575
1576
1577 String commandListHeading() default "Commands:%n";
1578
1579
1580
1581
1582 String footerHeading() default "";
1583
1584
1585
1586
1587
1588 String[] footer() default {};
1589 }
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628 public interface ITypeConverter<K> {
1629
1630
1631
1632
1633
1634
1635 K convert(String value) throws Exception;
1636 }
1637
1638
1639
1640 public static class Range implements Comparable<Range> {
1641
1642 public final int min;
1643
1644 public final int max;
1645 public final boolean isVariable;
1646 private final boolean isUnspecified;
1647 private final String originalValue;
1648
1649
1650
1651
1652
1653
1654
1655
1656 public Range(int min, int max, boolean variable, boolean unspecified, String originalValue) {
1657 this.min = min;
1658 this.max = max;
1659 this.isVariable = variable;
1660 this.isUnspecified = unspecified;
1661 this.originalValue = originalValue;
1662 }
1663
1664
1665
1666
1667 public static Range optionArity(Field field) {
1668 return field.isAnnotationPresent(Option.class)
1669 ? adjustForType(Range.valueOf(field.getAnnotation(Option.class).arity()), field)
1670 : new Range(0, 0, false, true, "0");
1671 }
1672
1673
1674
1675
1676 public static Range parameterArity(Field field) {
1677 return field.isAnnotationPresent(Parameters.class)
1678 ? adjustForType(Range.valueOf(field.getAnnotation(Parameters.class).arity()), field)
1679 : new Range(0, 0, false, true, "0");
1680 }
1681
1682
1683
1684 public static Range parameterIndex(Field field) {
1685 return field.isAnnotationPresent(Parameters.class)
1686 ? Range.valueOf(field.getAnnotation(Parameters.class).index())
1687 : new Range(0, 0, false, true, "0");
1688 }
1689 static Range adjustForType(Range result, Field field) {
1690 return result.isUnspecified ? defaultArity(field) : result;
1691 }
1692
1693
1694
1695
1696
1697
1698 public static Range defaultArity(Field field) {
1699 Class<?> type = field.getType();
1700 if (field.isAnnotationPresent(Option.class)) {
1701 return defaultArity(type);
1702 }
1703 if (isMultiValue(type)) {
1704 return Range.valueOf("0..1");
1705 }
1706 return Range.valueOf("1");
1707 }
1708
1709
1710
1711 public static Range defaultArity(Class<?> type) {
1712 return isBoolean(type) ? Range.valueOf("0") : Range.valueOf("1");
1713 }
1714 private int size() { return 1 + max - min; }
1715 static Range parameterCapacity(Field field) {
1716 Range arity = parameterArity(field);
1717 if (!isMultiValue(field)) { return arity; }
1718 Range index = parameterIndex(field);
1719 if (arity.max == 0) { return arity; }
1720 if (index.size() == 1) { return arity; }
1721 if (index.isVariable) { return Range.valueOf(arity.min + "..*"); }
1722 if (arity.size() == 1) { return Range.valueOf(arity.min * index.size() + ""); }
1723 if (arity.isVariable) { return Range.valueOf(arity.min * index.size() + "..*"); }
1724 return Range.valueOf(arity.min * index.size() + ".." + arity.max * index.size());
1725 }
1726
1727
1728
1729
1730
1731
1732 public static Range valueOf(String range) {
1733 range = range.trim();
1734 boolean unspecified = range.length() == 0 || range.startsWith("..");
1735 int min = -1, max = -1;
1736 boolean variable = false;
1737 int dots = -1;
1738 if ((dots = range.indexOf("..")) >= 0) {
1739 min = parseInt(range.substring(0, dots), 0);
1740 max = parseInt(range.substring(dots + 2), Integer.MAX_VALUE);
1741 variable = max == Integer.MAX_VALUE;
1742 } else {
1743 max = parseInt(range, Integer.MAX_VALUE);
1744 variable = max == Integer.MAX_VALUE;
1745 min = variable ? 0 : max;
1746 }
1747 Range result = new Range(min, max, variable, unspecified, range);
1748 return result;
1749 }
1750 private static int parseInt(String str, int defaultValue) {
1751 try {
1752 return Integer.parseInt(str);
1753 } catch (Exception ex) {
1754 return defaultValue;
1755 }
1756 }
1757
1758
1759
1760
1761 public Range min(int newMin) { return new Range(newMin, Math.max(newMin, max), isVariable, isUnspecified, originalValue); }
1762
1763
1764
1765
1766
1767 public Range max(int newMax) { return new Range(Math.min(min, newMax), newMax, isVariable, isUnspecified, originalValue); }
1768
1769
1770
1771
1772
1773
1774 public boolean contains(int value) { return min <= value && max >= value; }
1775
1776 public boolean equals(Object object) {
1777 if (!(object instanceof Range)) { return false; }
1778 Range other = (Range) object;
1779 return other.max == this.max && other.min == this.min && other.isVariable == this.isVariable;
1780 }
1781 public int hashCode() {
1782 return ((17 * 37 + max) * 37 + min) * 37 + (isVariable ? 1 : 0);
1783 }
1784 public String toString() {
1785 return min == max ? String.valueOf(min) : min + ".." + (isVariable ? "*" : max);
1786 }
1787 public int compareTo(Range other) {
1788 int result = min - other.min;
1789 return (result == 0) ? max - other.max : result;
1790 }
1791 }
1792 static void init(Class<?> cls,
1793 List<Field> requiredFields,
1794 Map<String, Field> optionName2Field,
1795 Map<Character, Field> singleCharOption2Field,
1796 List<Field> positionalParametersFields) {
1797 Field[] declaredFields = cls.getDeclaredFields();
1798 for (Field field : declaredFields) {
1799 field.setAccessible(true);
1800 if (field.isAnnotationPresent(Option.class)) {
1801 Option option = field.getAnnotation(Option.class);
1802 if (option.required()) {
1803 requiredFields.add(field);
1804 }
1805 for (String name : option.names()) {
1806 Field existing = optionName2Field.put(name, field);
1807 if (existing != null && existing != field) {
1808 throw DuplicateOptionAnnotationsException.create(name, field, existing);
1809 }
1810 if (name.length() == 2 && name.startsWith("-")) {
1811 char flag = name.charAt(1);
1812 Field existing2 = singleCharOption2Field.put(flag, field);
1813 if (existing2 != null && existing2 != field) {
1814 throw DuplicateOptionAnnotationsException.create(name, field, existing2);
1815 }
1816 }
1817 }
1818 }
1819 if (field.isAnnotationPresent(Parameters.class)) {
1820 if (field.isAnnotationPresent(Option.class)) {
1821 throw new DuplicateOptionAnnotationsException("A field can be either @Option or @Parameters, but '"
1822 + field.getName() + "' is both.");
1823 }
1824 positionalParametersFields.add(field);
1825 Range arity = Range.parameterArity(field);
1826 if (arity.min > 0) {
1827 requiredFields.add(field);
1828 }
1829 }
1830 }
1831 }
1832 static void validatePositionalParameters(List<Field> positionalParametersFields) {
1833 int min = 0;
1834 for (Field field : positionalParametersFields) {
1835 Range index = Range.parameterIndex(field);
1836 if (index.min > min) {
1837 throw new ParameterIndexGapException("Missing field annotated with @Parameter(index=" + min +
1838 "). Nearest field '" + field.getName() + "' has index=" + index.min);
1839 }
1840 min = Math.max(min, index.max);
1841 min = min == Integer.MAX_VALUE ? min : min + 1;
1842 }
1843 }
1844 private static <T> Stack<T> reverse(Stack<T> stack) {
1845 Collections.reverse(stack);
1846 return stack;
1847 }
1848
1849
1850
1851 private class Interpreter {
1852 private final Map<String, CommandLine> commands = new LinkedHashMap<String, CommandLine>();
1853 private final Map<Class<?>, ITypeConverter<?>> converterRegistry = new HashMap<Class<?>, ITypeConverter<?>>();
1854 private final Map<String, Field> optionName2Field = new HashMap<String, Field>();
1855 private final Map<Character, Field> singleCharOption2Field = new HashMap<Character, Field>();
1856 private final List<Field> requiredFields = new ArrayList<Field>();
1857 private final List<Field> positionalParametersFields = new ArrayList<Field>();
1858 private final Object command;
1859 private boolean isHelpRequested;
1860 private String separator = Help.DEFAULT_SEPARATOR;
1861 private int position;
1862
1863 Interpreter(Object command) {
1864 converterRegistry.put(Path.class, new BuiltIn.PathConverter());
1865 converterRegistry.put(Object.class, new BuiltIn.StringConverter());
1866 converterRegistry.put(String.class, new BuiltIn.StringConverter());
1867 converterRegistry.put(StringBuilder.class, new BuiltIn.StringBuilderConverter());
1868 converterRegistry.put(CharSequence.class, new BuiltIn.CharSequenceConverter());
1869 converterRegistry.put(Byte.class, new BuiltIn.ByteConverter());
1870 converterRegistry.put(Byte.TYPE, new BuiltIn.ByteConverter());
1871 converterRegistry.put(Boolean.class, new BuiltIn.BooleanConverter());
1872 converterRegistry.put(Boolean.TYPE, new BuiltIn.BooleanConverter());
1873 converterRegistry.put(Character.class, new BuiltIn.CharacterConverter());
1874 converterRegistry.put(Character.TYPE, new BuiltIn.CharacterConverter());
1875 converterRegistry.put(Short.class, new BuiltIn.ShortConverter());
1876 converterRegistry.put(Short.TYPE, new BuiltIn.ShortConverter());
1877 converterRegistry.put(Integer.class, new BuiltIn.IntegerConverter());
1878 converterRegistry.put(Integer.TYPE, new BuiltIn.IntegerConverter());
1879 converterRegistry.put(Long.class, new BuiltIn.LongConverter());
1880 converterRegistry.put(Long.TYPE, new BuiltIn.LongConverter());
1881 converterRegistry.put(Float.class, new BuiltIn.FloatConverter());
1882 converterRegistry.put(Float.TYPE, new BuiltIn.FloatConverter());
1883 converterRegistry.put(Double.class, new BuiltIn.DoubleConverter());
1884 converterRegistry.put(Double.TYPE, new BuiltIn.DoubleConverter());
1885 converterRegistry.put(File.class, new BuiltIn.FileConverter());
1886 converterRegistry.put(URI.class, new BuiltIn.URIConverter());
1887 converterRegistry.put(URL.class, new BuiltIn.URLConverter());
1888 converterRegistry.put(Date.class, new BuiltIn.ISO8601DateConverter());
1889 converterRegistry.put(Time.class, new BuiltIn.ISO8601TimeConverter());
1890 converterRegistry.put(BigDecimal.class, new BuiltIn.BigDecimalConverter());
1891 converterRegistry.put(BigInteger.class, new BuiltIn.BigIntegerConverter());
1892 converterRegistry.put(Charset.class, new BuiltIn.CharsetConverter());
1893 converterRegistry.put(InetAddress.class, new BuiltIn.InetAddressConverter());
1894 converterRegistry.put(Pattern.class, new BuiltIn.PatternConverter());
1895 converterRegistry.put(UUID.class, new BuiltIn.UUIDConverter());
1896
1897 this.command = Assert.notNull(command, "command");
1898 Class<?> cls = command.getClass();
1899 String declaredName = null;
1900 String declaredSeparator = null;
1901 boolean hasCommandAnnotation = false;
1902 while (cls != null) {
1903 init(cls, requiredFields, optionName2Field, singleCharOption2Field, positionalParametersFields);
1904 if (cls.isAnnotationPresent(Command.class)) {
1905 hasCommandAnnotation = true;
1906 Command cmd = cls.getAnnotation(Command.class);
1907 declaredSeparator = (declaredSeparator == null) ? cmd.separator() : declaredSeparator;
1908 declaredName = (declaredName == null) ? cmd.name() : declaredName;
1909 CommandLine.this.versionLines.addAll(Arrays.asList(cmd.version()));
1910
1911 for (Class<?> sub : cmd.subcommands()) {
1912 Command subCommand = sub.getAnnotation(Command.class);
1913 if (subCommand == null || Help.DEFAULT_COMMAND_NAME.equals(subCommand.name())) {
1914 throw new InitializationException("Subcommand " + sub.getName() +
1915 " is missing the mandatory @Command annotation with a 'name' attribute");
1916 }
1917 try {
1918 Constructor<?> constructor = sub.getDeclaredConstructor();
1919 constructor.setAccessible(true);
1920 CommandLine commandLine = toCommandLine(constructor.newInstance());
1921 commandLine.parent = CommandLine.this;
1922 commands.put(subCommand.name(), commandLine);
1923 }
1924 catch (InitializationException ex) { throw ex; }
1925 catch (NoSuchMethodException ex) { throw new InitializationException("Cannot instantiate subcommand " +
1926 sub.getName() + ": the class has no constructor", ex); }
1927 catch (Exception ex) {
1928 throw new InitializationException("Could not instantiate and add subcommand " +
1929 sub.getName() + ": " + ex, ex);
1930 }
1931 }
1932 }
1933 cls = cls.getSuperclass();
1934 }
1935 separator = declaredSeparator != null ? declaredSeparator : separator;
1936 CommandLine.this.commandName = declaredName != null ? declaredName : CommandLine.this.commandName;
1937 Collections.sort(positionalParametersFields, new PositionalParametersSorter());
1938 validatePositionalParameters(positionalParametersFields);
1939
1940 if (positionalParametersFields.isEmpty() && optionName2Field.isEmpty() && !hasCommandAnnotation) {
1941 throw new InitializationException(command + " (" + command.getClass() +
1942 ") is not a command: it has no @Command, @Option or @Parameters annotations");
1943 }
1944 }
1945
1946
1947
1948
1949
1950
1951
1952 List<CommandLine> parse(String... args) {
1953 Assert.notNull(args, "argument array");
1954 if (tracer.isInfo()) {tracer.info("Parsing %d command line args %s%n", args.length, Arrays.toString(args));}
1955 Stack<String> arguments = new Stack<String>();
1956 for (int i = args.length - 1; i >= 0; i--) {
1957 arguments.push(args[i]);
1958 }
1959 List<CommandLine> result = new ArrayList<CommandLine>();
1960 parse(result, arguments, args);
1961 return result;
1962 }
1963
1964 private void parse(List<CommandLine> parsedCommands, Stack<String> argumentStack, String[] originalArgs) {
1965
1966 isHelpRequested = false;
1967 CommandLine.this.versionHelpRequested = false;
1968 CommandLine.this.usageHelpRequested = false;
1969
1970 Class<?> cmdClass = this.command.getClass();
1971 if (tracer.isDebug()) {tracer.debug("Initializing %s: %d options, %d positional parameters, %d required, %d subcommands.%n", cmdClass.getName(), new HashSet<Field>(optionName2Field.values()).size(), positionalParametersFields.size(), requiredFields.size(), commands.size());}
1972 parsedCommands.add(CommandLine.this);
1973 List<Field> required = new ArrayList<Field>(requiredFields);
1974 Set<Field> initialized = new HashSet<Field>();
1975 Collections.sort(required, new PositionalParametersSorter());
1976 try {
1977 processArguments(parsedCommands, argumentStack, required, initialized, originalArgs);
1978 } catch (ParameterException ex) {
1979 throw ex;
1980 } catch (Exception ex) {
1981 int offendingArgIndex = originalArgs.length - argumentStack.size() - 1;
1982 String arg = offendingArgIndex >= 0 && offendingArgIndex < originalArgs.length ? originalArgs[offendingArgIndex] : "?";
1983 throw ParameterException.create(CommandLine.this, ex, arg, offendingArgIndex, originalArgs);
1984 }
1985 if (!isAnyHelpRequested() && !required.isEmpty()) {
1986 for (Field missing : required) {
1987 if (missing.isAnnotationPresent(Option.class)) {
1988 throw MissingParameterException.create(CommandLine.this, required, separator);
1989 } else {
1990 assertNoMissingParameters(missing, Range.parameterArity(missing).min, argumentStack);
1991 }
1992 }
1993 }
1994 if (!unmatchedArguments.isEmpty()) {
1995 if (!isUnmatchedArgumentsAllowed()) { throw new UnmatchedArgumentException(CommandLine.this, unmatchedArguments); }
1996 if (tracer.isWarn()) { tracer.warn("Unmatched arguments: %s%n", unmatchedArguments); }
1997 }
1998 }
1999
2000 private void processArguments(List<CommandLine> parsedCommands,
2001 Stack<String> args,
2002 Collection<Field> required,
2003 Set<Field> initialized,
2004 String[] originalArgs) throws Exception {
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014 while (!args.isEmpty()) {
2015 String arg = args.pop();
2016 if (tracer.isDebug()) {tracer.debug("Processing argument '%s'. Remainder=%s%n", arg, reverse((Stack<String>) args.clone()));}
2017
2018
2019
2020 if ("--".equals(arg)) {
2021 tracer.info("Found end-of-options delimiter '--'. Treating remainder as positional parameters.%n");
2022 processRemainderAsPositionalParameters(required, initialized, args);
2023 return;
2024 }
2025
2026
2027 if (commands.containsKey(arg)) {
2028 if (!isHelpRequested && !required.isEmpty()) {
2029 throw MissingParameterException.create(CommandLine.this, required, separator);
2030 }
2031 if (tracer.isDebug()) {tracer.debug("Found subcommand '%s' (%s)%n", arg, commands.get(arg).interpreter.command.getClass().getName());}
2032 commands.get(arg).interpreter.parse(parsedCommands, args, originalArgs);
2033 return;
2034 }
2035
2036
2037
2038
2039
2040 boolean paramAttachedToOption = false;
2041 int separatorIndex = arg.indexOf(separator);
2042 if (separatorIndex > 0) {
2043 String key = arg.substring(0, separatorIndex);
2044
2045 if (optionName2Field.containsKey(key) && !optionName2Field.containsKey(arg)) {
2046 paramAttachedToOption = true;
2047 String optionParam = arg.substring(separatorIndex + separator.length());
2048 args.push(optionParam);
2049 arg = key;
2050 if (tracer.isDebug()) {tracer.debug("Separated '%s' option from '%s' option parameter%n", key, optionParam);}
2051 } else {
2052 if (tracer.isDebug()) {tracer.debug("'%s' contains separator '%s' but '%s' is not a known option%n", arg, separator, key);}
2053 }
2054 } else {
2055 if (tracer.isDebug()) {tracer.debug("'%s' cannot be separated into <option>%s<option-parameter>%n", arg, separator);}
2056 }
2057 if (optionName2Field.containsKey(arg)) {
2058 processStandaloneOption(required, initialized, arg, args, paramAttachedToOption);
2059 }
2060
2061
2062 else if (arg.length() > 2 && arg.startsWith("-")) {
2063 if (tracer.isDebug()) {tracer.debug("Trying to process '%s' as clustered short options%n", arg, args);}
2064 processClusteredShortOptions(required, initialized, arg, args);
2065 }
2066
2067
2068 else {
2069 args.push(arg);
2070 if (tracer.isDebug()) {tracer.debug("Could not find option '%s', deciding whether to treat as unmatched option or positional parameter...%n", arg);}
2071 if (resemblesOption(arg)) { handleUnmatchedArguments(args.pop()); continue; }
2072 if (tracer.isDebug()) {tracer.debug("No option named '%s' found. Processing remainder as positional parameters%n", arg);}
2073 processPositionalParameter(required, initialized, args);
2074 }
2075 }
2076 }
2077 private boolean resemblesOption(String arg) {
2078 int count = 0;
2079 for (String optionName : optionName2Field.keySet()) {
2080 for (int i = 0; i < arg.length(); i++) {
2081 if (optionName.length() > i && arg.charAt(i) == optionName.charAt(i)) { count++; } else { break; }
2082 }
2083 }
2084 boolean result = count > 0 && count * 10 >= optionName2Field.size() * 9;
2085 if (tracer.isDebug()) {tracer.debug("%s %s an option: %d matching prefix chars out of %d option names%n", arg, (result ? "resembles" : "doesn't resemble"), count, optionName2Field.size());}
2086 return result;
2087 }
2088 private void handleUnmatchedArguments(String arg) {Stack<String> args = new Stack<String>(); args.add(arg); handleUnmatchedArguments(args);}
2089 private void handleUnmatchedArguments(Stack<String> args) {
2090 while (!args.isEmpty()) { unmatchedArguments.add(args.pop()); }
2091 }
2092
2093 private void processRemainderAsPositionalParameters(Collection<Field> required, Set<Field> initialized, Stack<String> args) throws Exception {
2094 while (!args.empty()) {
2095 processPositionalParameter(required, initialized, args);
2096 }
2097 }
2098 private void processPositionalParameter(Collection<Field> required, Set<Field> initialized, Stack<String> args) throws Exception {
2099 if (tracer.isDebug()) {tracer.debug("Processing next arg as a positional parameter at index=%d. Remainder=%s%n", position, reverse((Stack<String>) args.clone()));}
2100 int consumed = 0;
2101 for (Field positionalParam : positionalParametersFields) {
2102 Range indexRange = Range.parameterIndex(positionalParam);
2103 if (!indexRange.contains(position)) {
2104 continue;
2105 }
2106 @SuppressWarnings("unchecked")
2107 Stack<String> argsCopy = (Stack<String>) args.clone();
2108 Range arity = Range.parameterArity(positionalParam);
2109 if (tracer.isDebug()) {tracer.debug("Position %d is in index range %s. Trying to assign args to %s, arity=%s%n", position, indexRange, positionalParam, arity);}
2110 assertNoMissingParameters(positionalParam, arity.min, argsCopy);
2111 int originalSize = argsCopy.size();
2112 applyOption(positionalParam, Parameters.class, arity, false, argsCopy, initialized, "args[" + indexRange + "] at position " + position);
2113 int count = originalSize - argsCopy.size();
2114 if (count > 0) { required.remove(positionalParam); }
2115 consumed = Math.max(consumed, count);
2116 }
2117
2118 for (int i = 0; i < consumed; i++) { args.pop(); }
2119 position += consumed;
2120 if (tracer.isDebug()) {tracer.debug("Consumed %d arguments, moving position to index %d.%n", consumed, position);}
2121 if (consumed == 0 && !args.isEmpty()) {
2122 handleUnmatchedArguments(args.pop());
2123 }
2124 }
2125
2126 private void processStandaloneOption(Collection<Field> required,
2127 Set<Field> initialized,
2128 String arg,
2129 Stack<String> args,
2130 boolean paramAttachedToKey) throws Exception {
2131 Field field = optionName2Field.get(arg);
2132 required.remove(field);
2133 Range arity = Range.optionArity(field);
2134 if (paramAttachedToKey) {
2135 arity = arity.min(Math.max(1, arity.min));
2136 }
2137 if (tracer.isDebug()) {tracer.debug("Found option named '%s': field %s, arity=%s%n", arg, field, arity);}
2138 applyOption(field, Option.class, arity, paramAttachedToKey, args, initialized, "option " + arg);
2139 }
2140
2141 private void processClusteredShortOptions(Collection<Field> required,
2142 Set<Field> initialized,
2143 String arg,
2144 Stack<String> args)
2145 throws Exception {
2146 String prefix = arg.substring(0, 1);
2147 String cluster = arg.substring(1);
2148 boolean paramAttachedToOption = true;
2149 do {
2150 if (cluster.length() > 0 && singleCharOption2Field.containsKey(cluster.charAt(0))) {
2151 Field field = singleCharOption2Field.get(cluster.charAt(0));
2152 Range arity = Range.optionArity(field);
2153 String argDescription = "option " + prefix + cluster.charAt(0);
2154 if (tracer.isDebug()) {tracer.debug("Found option '%s%s' in %s: field %s, arity=%s%n", prefix, cluster.charAt(0), arg, field, arity);}
2155 required.remove(field);
2156 cluster = cluster.length() > 0 ? cluster.substring(1) : "";
2157 paramAttachedToOption = cluster.length() > 0;
2158 if (cluster.startsWith(separator)) {
2159 cluster = cluster.substring(separator.length());
2160 arity = arity.min(Math.max(1, arity.min));
2161 }
2162 if (arity.min > 0 && !empty(cluster)) {
2163 if (tracer.isDebug()) {tracer.debug("Trying to process '%s' as option parameter%n", cluster);}
2164 }
2165
2166
2167
2168 if (!empty(cluster)) {
2169 args.push(cluster);
2170 }
2171 int consumed = applyOption(field, Option.class, arity, paramAttachedToOption, args, initialized, argDescription);
2172
2173 if (empty(cluster) || consumed > 0 || args.isEmpty()) {
2174 return;
2175 }
2176 cluster = args.pop();
2177 } else {
2178 if (cluster.length() == 0) {
2179 return;
2180 }
2181
2182
2183 if (arg.endsWith(cluster)) {
2184 args.push(paramAttachedToOption ? prefix + cluster : cluster);
2185 if (args.peek().equals(arg)) {
2186 if (tracer.isDebug()) {tracer.debug("Could not match any short options in %s, deciding whether to treat as unmatched option or positional parameter...%n", arg);}
2187 if (resemblesOption(arg)) { handleUnmatchedArguments(args.pop()); return; }
2188 processPositionalParameter(required, initialized, args);
2189 return;
2190 }
2191
2192 if (tracer.isDebug()) {tracer.debug("No option found for %s in %s%n", cluster, arg);}
2193 handleUnmatchedArguments(args.pop());
2194 } else {
2195 args.push(cluster);
2196 if (tracer.isDebug()) {tracer.debug("%s is not an option parameter for %s%n", cluster, arg);}
2197 processPositionalParameter(required, initialized, args);
2198 }
2199 return;
2200 }
2201 } while (true);
2202 }
2203
2204 private int applyOption(Field field,
2205 Class<?> annotation,
2206 Range arity,
2207 boolean valueAttachedToOption,
2208 Stack<String> args,
2209 Set<Field> initialized,
2210 String argDescription) throws Exception {
2211 updateHelpRequested(field);
2212 int length = args.size();
2213 assertNoMissingParameters(field, arity.min, args);
2214
2215 Class<?> cls = field.getType();
2216 if (cls.isArray()) {
2217 return applyValuesToArrayField(field, annotation, arity, args, cls, argDescription);
2218 }
2219 if (Collection.class.isAssignableFrom(cls)) {
2220 return applyValuesToCollectionField(field, annotation, arity, args, cls, argDescription);
2221 }
2222 if (Map.class.isAssignableFrom(cls)) {
2223 return applyValuesToMapField(field, annotation, arity, args, cls, argDescription);
2224 }
2225 cls = getTypeAttribute(field)[0];
2226 return applyValueToSingleValuedField(field, arity, args, cls, initialized, argDescription);
2227 }
2228
2229 private int applyValueToSingleValuedField(Field field,
2230 Range arity,
2231 Stack<String> args,
2232 Class<?> cls,
2233 Set<Field> initialized,
2234 String argDescription) throws Exception {
2235 boolean noMoreValues = args.isEmpty();
2236 String value = args.isEmpty() ? null : trim(args.pop());
2237 int result = arity.min;
2238
2239
2240 if ((cls == Boolean.class || cls == Boolean.TYPE) && arity.min <= 0) {
2241
2242
2243 if (arity.max > 0 && ("true".equalsIgnoreCase(value) || "false".equalsIgnoreCase(value))) {
2244 result = 1;
2245 } else {
2246 if (value != null) {
2247 args.push(value);
2248 }
2249 Boolean currentValue = (Boolean) field.get(command);
2250 value = String.valueOf(currentValue == null ? true : !currentValue);
2251 }
2252 }
2253 if (noMoreValues && value == null) {
2254 return 0;
2255 }
2256 ITypeConverter<?> converter = getTypeConverter(cls, field);
2257 Object newValue = tryConvert(field, -1, converter, value, cls);
2258 Object oldValue = field.get(command);
2259 TraceLevel level = TraceLevel.INFO;
2260 String traceMessage = "Setting %s field '%s.%s' to '%5$s' (was '%4$s') for %6$s%n";
2261 if (initialized != null) {
2262 if (initialized.contains(field)) {
2263 if (!isOverwrittenOptionsAllowed()) {
2264 throw new OverwrittenOptionException(CommandLine.this, optionDescription("", field, 0) + " should be specified only once");
2265 }
2266 level = TraceLevel.WARN;
2267 traceMessage = "Overwriting %s field '%s.%s' value '%s' with '%s' for %s%n";
2268 }
2269 initialized.add(field);
2270 }
2271 if (tracer.level.isEnabled(level)) { level.print(tracer, traceMessage, field.getType().getSimpleName(),
2272 field.getDeclaringClass().getSimpleName(), field.getName(), String.valueOf(oldValue), String.valueOf(newValue), argDescription);
2273 }
2274 field.set(command, newValue);
2275 return result;
2276 }
2277 private int applyValuesToMapField(Field field,
2278 Class<?> annotation,
2279 Range arity,
2280 Stack<String> args,
2281 Class<?> cls,
2282 String argDescription) throws Exception {
2283 Class<?>[] classes = getTypeAttribute(field);
2284 if (classes.length < 2) { throw new ParameterException(CommandLine.this, "Field " + field + " needs two types (one for the map key, one for the value) but only has " + classes.length + " types configured."); }
2285 ITypeConverter<?> keyConverter = getTypeConverter(classes[0], field);
2286 ITypeConverter<?> valueConverter = getTypeConverter(classes[1], field);
2287 Map<Object, Object> result = (Map<Object, Object>) field.get(command);
2288 if (result == null) {
2289 result = createMap(cls);
2290 field.set(command, result);
2291 }
2292 int originalSize = result.size();
2293 consumeMapArguments(field, arity, args, classes, keyConverter, valueConverter, result, argDescription);
2294 return result.size() - originalSize;
2295 }
2296
2297 private void consumeMapArguments(Field field,
2298 Range arity,
2299 Stack<String> args,
2300 Class<?>[] classes,
2301 ITypeConverter<?> keyConverter,
2302 ITypeConverter<?> valueConverter,
2303 Map<Object, Object> result,
2304 String argDescription) throws Exception {
2305
2306 for (int i = 0; i < arity.min; i++) {
2307 consumeOneMapArgument(field, arity, args, classes, keyConverter, valueConverter, result, i, argDescription);
2308 }
2309
2310 for (int i = arity.min; i < arity.max && !args.isEmpty(); i++) {
2311 if (!field.isAnnotationPresent(Parameters.class)) {
2312 if (commands.containsKey(args.peek()) || isOption(args.peek())) {
2313 return;
2314 }
2315 }
2316 consumeOneMapArgument(field, arity, args, classes, keyConverter, valueConverter, result, i, argDescription);
2317 }
2318 }
2319
2320 private void consumeOneMapArgument(Field field,
2321 Range arity,
2322 Stack<String> args,
2323 Class<?>[] classes,
2324 ITypeConverter<?> keyConverter, ITypeConverter<?> valueConverter,
2325 Map<Object, Object> result,
2326 int index,
2327 String argDescription) throws Exception {
2328 String[] values = split(trim(args.pop()), field);
2329 for (String value : values) {
2330 String[] keyValue = value.split("=");
2331 if (keyValue.length < 2) {
2332 String splitRegex = splitRegex(field);
2333 if (splitRegex.length() == 0) {
2334 throw new ParameterException(CommandLine.this, "Value for option " + optionDescription("", field,
2335 0) + " should be in KEY=VALUE format but was " + value);
2336 } else {
2337 throw new ParameterException(CommandLine.this, "Value for option " + optionDescription("", field,
2338 0) + " should be in KEY=VALUE[" + splitRegex + "KEY=VALUE]... format but was " + value);
2339 }
2340 }
2341 Object mapKey = tryConvert(field, index, keyConverter, keyValue[0], classes[0]);
2342 Object mapValue = tryConvert(field, index, valueConverter, keyValue[1], classes[1]);
2343 result.put(mapKey, mapValue);
2344 if (tracer.isInfo()) {tracer.info("Putting [%s : %s] in %s<%s, %s> field '%s.%s' for %s%n", String.valueOf(mapKey), String.valueOf(mapValue),
2345 result.getClass().getSimpleName(), classes[0].getSimpleName(), classes[1].getSimpleName(), field.getDeclaringClass().getSimpleName(), field.getName(), argDescription);}
2346 }
2347 }
2348
2349 private void checkMaxArityExceeded(Range arity, int remainder, Field field, String[] values) {
2350 if (values.length <= remainder) { return; }
2351 String desc = arity.max == remainder ? "" + remainder : arity + ", remainder=" + remainder;
2352 throw new MaxValuesforFieldExceededException(CommandLine.this, optionDescription("", field, -1) +
2353 " max number of values (" + arity.max + ") exceeded: remainder is " + remainder + " but " +
2354 values.length + " values were specified: " + Arrays.toString(values));
2355 }
2356
2357 private int applyValuesToArrayField(Field field,
2358 Class<?> annotation,
2359 Range arity,
2360 Stack<String> args,
2361 Class<?> cls,
2362 String argDescription) throws Exception {
2363 Object existing = field.get(command);
2364 int length = existing == null ? 0 : Array.getLength(existing);
2365 Class<?> type = getTypeAttribute(field)[0];
2366 List<Object> converted = consumeArguments(field, annotation, arity, args, type, length, argDescription);
2367 List<Object> newValues = new ArrayList<Object>();
2368 for (int i = 0; i < length; i++) {
2369 newValues.add(Array.get(existing, i));
2370 }
2371 for (Object obj : converted) {
2372 if (obj instanceof Collection<?>) {
2373 newValues.addAll((Collection<?>) obj);
2374 } else {
2375 newValues.add(obj);
2376 }
2377 }
2378 Object array = Array.newInstance(type, newValues.size());
2379 field.set(command, array);
2380 for (int i = 0; i < newValues.size(); i++) {
2381 Array.set(array, i, newValues.get(i));
2382 }
2383 return converted.size();
2384 }
2385
2386 @SuppressWarnings("unchecked")
2387 private int applyValuesToCollectionField(Field field,
2388 Class<?> annotation,
2389 Range arity,
2390 Stack<String> args,
2391 Class<?> cls,
2392 String argDescription) throws Exception {
2393 Collection<Object> collection = (Collection<Object>) field.get(command);
2394 Class<?> type = getTypeAttribute(field)[0];
2395 int length = collection == null ? 0 : collection.size();
2396 List<Object> converted = consumeArguments(field, annotation, arity, args, type, length, argDescription);
2397 if (collection == null) {
2398 collection = createCollection(cls);
2399 field.set(command, collection);
2400 }
2401 for (Object element : converted) {
2402 if (element instanceof Collection<?>) {
2403 collection.addAll((Collection<?>) element);
2404 } else {
2405 collection.add(element);
2406 }
2407 }
2408 return converted.size();
2409 }
2410
2411 private List<Object> consumeArguments(Field field,
2412 Class<?> annotation,
2413 Range arity,
2414 Stack<String> args,
2415 Class<?> type,
2416 int originalSize,
2417 String argDescription) throws Exception {
2418 List<Object> result = new ArrayList<Object>();
2419
2420
2421 for (int i = 0; i < arity.min; i++) {
2422 consumeOneArgument(field, arity, args, type, result, i, originalSize, argDescription);
2423 }
2424
2425 for (int i = arity.min; i < arity.max && !args.isEmpty(); i++) {
2426 if (annotation != Parameters.class) {
2427 if (commands.containsKey(args.peek()) || isOption(args.peek())) {
2428 return result;
2429 }
2430 }
2431 consumeOneArgument(field, arity, args, type, result, i, originalSize, argDescription);
2432 }
2433 return result;
2434 }
2435
2436 private int consumeOneArgument(Field field,
2437 Range arity,
2438 Stack<String> args,
2439 Class<?> type,
2440 List<Object> result,
2441 int index,
2442 int originalSize,
2443 String argDescription) throws Exception {
2444 String[] values = split(trim(args.pop()), field);
2445 ITypeConverter<?> converter = getTypeConverter(type, field);
2446
2447 for (int j = 0; j < values.length; j++) {
2448 result.add(tryConvert(field, index, converter, values[j], type));
2449 if (tracer.isInfo()) {
2450 if (field.getType().isArray()) {
2451 tracer.info("Adding [%s] to %s[] field '%s.%s' for %s%n", String.valueOf(result.get(result.size() - 1)), type.getSimpleName(), field.getDeclaringClass().getSimpleName(), field.getName(), argDescription);
2452 } else {
2453 tracer.info("Adding [%s] to %s<%s> field '%s.%s' for %s%n", String.valueOf(result.get(result.size() - 1)), field.getType().getSimpleName(), type.getSimpleName(), field.getDeclaringClass().getSimpleName(), field.getName(), argDescription);
2454 }
2455 }
2456 }
2457
2458 return ++index;
2459 }
2460
2461 private String splitRegex(Field field) {
2462 if (field.isAnnotationPresent(Option.class)) { return field.getAnnotation(Option.class).split(); }
2463 if (field.isAnnotationPresent(Parameters.class)) { return field.getAnnotation(Parameters.class).split(); }
2464 return "";
2465 }
2466 private String[] split(String value, Field field) {
2467 String regex = splitRegex(field);
2468 return regex.length() == 0 ? new String[] {value} : value.split(regex);
2469 }
2470
2471
2472
2473
2474
2475
2476
2477 private boolean isOption(String arg) {
2478 if ("--".equals(arg)) {
2479 return true;
2480 }
2481
2482 if (optionName2Field.containsKey(arg)) {
2483 return true;
2484 }
2485 int separatorIndex = arg.indexOf(separator);
2486 if (separatorIndex > 0) {
2487 if (optionName2Field.containsKey(arg.substring(0, separatorIndex))) {
2488 return true;
2489 }
2490 }
2491 return (arg.length() > 2 && arg.startsWith("-") && singleCharOption2Field.containsKey(arg.charAt(1)));
2492 }
2493 private Object tryConvert(Field field, int index, ITypeConverter<?> converter, String value, Class<?> type)
2494 throws Exception {
2495 try {
2496 return converter.convert(value);
2497 } catch (TypeConversionException ex) {
2498 throw new ParameterException(CommandLine.this, ex.getMessage() + optionDescription(" for ", field, index));
2499 } catch (Exception other) {
2500 String desc = optionDescription(" for ", field, index) + ": " + other;
2501 throw new ParameterException(CommandLine.this, "Could not convert '" + value + "' to " + type.getSimpleName() + desc, other);
2502 }
2503 }
2504
2505 private String optionDescription(String prefix, Field field, int index) {
2506 Help.IParamLabelRenderer labelRenderer = Help.createMinimalParamLabelRenderer();
2507 String desc = "";
2508 if (field.isAnnotationPresent(Option.class)) {
2509 desc = prefix + "option '" + field.getAnnotation(Option.class).names()[0] + "'";
2510 if (index >= 0) {
2511 Range arity = Range.optionArity(field);
2512 if (arity.max > 1) {
2513 desc += " at index " + index;
2514 }
2515 desc += " (" + labelRenderer.renderParameterLabel(field, Help.Ansi.OFF, Collections.<IStyle>emptyList()) + ")";
2516 }
2517 } else if (field.isAnnotationPresent(Parameters.class)) {
2518 Range indexRange = Range.parameterIndex(field);
2519 Text label = labelRenderer.renderParameterLabel(field, Help.Ansi.OFF, Collections.<IStyle>emptyList());
2520 desc = prefix + "positional parameter at index " + indexRange + " (" + label + ")";
2521 }
2522 return desc;
2523 }
2524
2525 private boolean isAnyHelpRequested() { return isHelpRequested || versionHelpRequested || usageHelpRequested; }
2526
2527 private void updateHelpRequested(Field field) {
2528 if (field.isAnnotationPresent(Option.class)) {
2529 isHelpRequested |= is(field, "help", field.getAnnotation(Option.class).help());
2530 CommandLine.this.versionHelpRequested |= is(field, "versionHelp", field.getAnnotation(Option.class).versionHelp());
2531 CommandLine.this.usageHelpRequested |= is(field, "usageHelp", field.getAnnotation(Option.class).usageHelp());
2532 }
2533 }
2534 private boolean is(Field f, String description, boolean value) {
2535 if (value) { if (tracer.isInfo()) {tracer.info("Field '%s.%s' has '%s' annotation: not validating required fields%n", f.getDeclaringClass().getSimpleName(), f.getName(), description); }}
2536 return value;
2537 }
2538 @SuppressWarnings("unchecked")
2539 private Collection<Object> createCollection(Class<?> collectionClass) throws Exception {
2540 if (collectionClass.isInterface()) {
2541 if (List.class.isAssignableFrom(collectionClass)) {
2542 return new ArrayList<Object>();
2543 } else if (SortedSet.class.isAssignableFrom(collectionClass)) {
2544 return new TreeSet<Object>();
2545 } else if (Set.class.isAssignableFrom(collectionClass)) {
2546 return new LinkedHashSet<Object>();
2547 } else if (Queue.class.isAssignableFrom(collectionClass)) {
2548 return new LinkedList<Object>();
2549 }
2550 return new ArrayList<Object>();
2551 }
2552
2553 return (Collection<Object>) collectionClass.newInstance();
2554 }
2555 private Map<Object, Object> createMap(Class<?> mapClass) throws Exception {
2556 try {
2557 return (Map<Object, Object>) mapClass.newInstance();
2558 } catch (Exception ignored) {}
2559 return new LinkedHashMap<Object, Object>();
2560 }
2561 private ITypeConverter<?> getTypeConverter(final Class<?> type, Field field) {
2562 ITypeConverter<?> result = converterRegistry.get(type);
2563 if (result != null) {
2564 return result;
2565 }
2566 if (type.isEnum()) {
2567 return new ITypeConverter<Object>() {
2568 @SuppressWarnings("unchecked")
2569 public Object convert(String value) throws Exception {
2570 return Enum.valueOf((Class<Enum>) type, value);
2571 }
2572 };
2573 }
2574 throw new MissingTypeConverterException(CommandLine.this, "No TypeConverter registered for " + type.getName() + " of field " + field);
2575 }
2576
2577 private void assertNoMissingParameters(Field field, int arity, Stack<String> args) {
2578 if (arity > args.size()) {
2579 if (arity == 1) {
2580 if (field.isAnnotationPresent(Option.class)) {
2581 throw new MissingParameterException(CommandLine.this, "Missing required parameter for " +
2582 optionDescription("", field, 0));
2583 }
2584 Range indexRange = Range.parameterIndex(field);
2585 Help.IParamLabelRenderer labelRenderer = Help.createMinimalParamLabelRenderer();
2586 String sep = "";
2587 String names = "";
2588 int count = 0;
2589 for (int i = indexRange.min; i < positionalParametersFields.size(); i++) {
2590 if (Range.parameterArity(positionalParametersFields.get(i)).min > 0) {
2591 names += sep + labelRenderer.renderParameterLabel(positionalParametersFields.get(i),
2592 Help.Ansi.OFF, Collections.<IStyle>emptyList());
2593 sep = ", ";
2594 count++;
2595 }
2596 }
2597 String msg = "Missing required parameter";
2598 Range paramArity = Range.parameterArity(field);
2599 if (paramArity.isVariable) {
2600 msg += "s at positions " + indexRange + ": ";
2601 } else {
2602 msg += (count > 1 ? "s: " : ": ");
2603 }
2604 throw new MissingParameterException(CommandLine.this, msg + names);
2605 }
2606 if (args.isEmpty()) {
2607 throw new MissingParameterException(CommandLine.this, optionDescription("", field, 0) +
2608 " requires at least " + arity + " values, but none were specified.");
2609 }
2610 throw new MissingParameterException(CommandLine.this, optionDescription("", field, 0) +
2611 " requires at least " + arity + " values, but only " + args.size() + " were specified: " + reverse(args));
2612 }
2613 }
2614 private String trim(String value) {
2615 return unquote(value);
2616 }
2617
2618 private String unquote(String value) {
2619 return value == null
2620 ? null
2621 : (value.length() > 1 && value.startsWith("\"") && value.endsWith("\""))
2622 ? value.substring(1, value.length() - 1)
2623 : value;
2624 }
2625 }
2626 private static class PositionalParametersSorter implements Comparator<Field> {
2627 public int compare(Field o1, Field o2) {
2628 int result = Range.parameterIndex(o1).compareTo(Range.parameterIndex(o2));
2629 return (result == 0) ? Range.parameterArity(o1).compareTo(Range.parameterArity(o2)) : result;
2630 }
2631 }
2632
2633
2634
2635 private static class BuiltIn {
2636 static class PathConverter implements ITypeConverter<Path> {
2637 @Override public Path convert(final String value) { return Paths.get(value); }
2638 }
2639 static class StringConverter implements ITypeConverter<String> {
2640 public String convert(String value) { return value; }
2641 }
2642 static class StringBuilderConverter implements ITypeConverter<StringBuilder> {
2643 public StringBuilder convert(String value) { return new StringBuilder(value); }
2644 }
2645 static class CharSequenceConverter implements ITypeConverter<CharSequence> {
2646 public String convert(String value) { return value; }
2647 }
2648
2649 static class ByteConverter implements ITypeConverter<Byte> {
2650 public Byte convert(String value) { return Byte.valueOf(value); }
2651 }
2652
2653 static class BooleanConverter implements ITypeConverter<Boolean> {
2654 public Boolean convert(String value) {
2655 if ("true".equalsIgnoreCase(value) || "false".equalsIgnoreCase(value)) {
2656 return Boolean.parseBoolean(value);
2657 } else {
2658 throw new TypeConversionException("'" + value + "' is not a boolean");
2659 }
2660 }
2661 }
2662 static class CharacterConverter implements ITypeConverter<Character> {
2663 public Character convert(String value) {
2664 if (value.length() > 1) {
2665 throw new TypeConversionException("'" + value + "' is not a single character");
2666 }
2667 return value.charAt(0);
2668 }
2669 }
2670
2671 static class ShortConverter implements ITypeConverter<Short> {
2672 public Short convert(String value) { return Short.valueOf(value); }
2673 }
2674
2675 static class IntegerConverter implements ITypeConverter<Integer> {
2676 public Integer convert(String value) { return Integer.valueOf(value); }
2677 }
2678
2679 static class LongConverter implements ITypeConverter<Long> {
2680 public Long convert(String value) { return Long.valueOf(value); }
2681 }
2682 static class FloatConverter implements ITypeConverter<Float> {
2683 public Float convert(String value) { return Float.valueOf(value); }
2684 }
2685 static class DoubleConverter implements ITypeConverter<Double> {
2686 public Double convert(String value) { return Double.valueOf(value); }
2687 }
2688 static class FileConverter implements ITypeConverter<File> {
2689 public File convert(String value) { return new File(value); }
2690 }
2691 static class URLConverter implements ITypeConverter<URL> {
2692 public URL convert(String value) throws MalformedURLException { return new URL(value); }
2693 }
2694 static class URIConverter implements ITypeConverter<URI> {
2695 public URI convert(String value) throws URISyntaxException { return new URI(value); }
2696 }
2697
2698 static class ISO8601DateConverter implements ITypeConverter<Date> {
2699 public Date convert(String value) {
2700 try {
2701 return new SimpleDateFormat("yyyy-MM-dd").parse(value);
2702 } catch (ParseException e) {
2703 throw new TypeConversionException("'" + value + "' is not a yyyy-MM-dd date");
2704 }
2705 }
2706 }
2707
2708
2709 static class ISO8601TimeConverter implements ITypeConverter<Time> {
2710 public Time convert(String value) {
2711 try {
2712 if (value.length() <= 5) {
2713 return new Time(new SimpleDateFormat("HH:mm").parse(value).getTime());
2714 } else if (value.length() <= 8) {
2715 return new Time(new SimpleDateFormat("HH:mm:ss").parse(value).getTime());
2716 } else if (value.length() <= 12) {
2717 try {
2718 return new Time(new SimpleDateFormat("HH:mm:ss.SSS").parse(value).getTime());
2719 } catch (ParseException e2) {
2720 return new Time(new SimpleDateFormat("HH:mm:ss,SSS").parse(value).getTime());
2721 }
2722 }
2723 } catch (ParseException ignored) {
2724
2725 }
2726 throw new TypeConversionException("'" + value + "' is not a HH:mm[:ss[.SSS]] time");
2727 }
2728 }
2729 static class BigDecimalConverter implements ITypeConverter<BigDecimal> {
2730 public BigDecimal convert(String value) { return new BigDecimal(value); }
2731 }
2732 static class BigIntegerConverter implements ITypeConverter<BigInteger> {
2733 public BigInteger convert(String value) { return new BigInteger(value); }
2734 }
2735 static class CharsetConverter implements ITypeConverter<Charset> {
2736 public Charset convert(String s) { return Charset.forName(s); }
2737 }
2738
2739 static class InetAddressConverter implements ITypeConverter<InetAddress> {
2740 public InetAddress convert(String s) throws Exception { return InetAddress.getByName(s); }
2741 }
2742 static class PatternConverter implements ITypeConverter<Pattern> {
2743 public Pattern convert(String s) { return Pattern.compile(s); }
2744 }
2745 static class UUIDConverter implements ITypeConverter<UUID> {
2746 public UUID convert(String s) throws Exception { return UUID.fromString(s); }
2747 }
2748 private BuiltIn() {}
2749 }
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784 public static class Help {
2785
2786 protected static final String DEFAULT_COMMAND_NAME = "<main class>";
2787
2788
2789 protected static final String DEFAULT_SEPARATOR = "=";
2790
2791 private final static int usageHelpWidth = 80;
2792 private final static int optionsColumnWidth = 2 + 2 + 1 + 24;
2793 private final Object command;
2794 private final Map<String, Help> commands = new LinkedHashMap<String, Help>();
2795 final ColorScheme colorScheme;
2796
2797
2798 public final List<Field> optionFields;
2799
2800
2801 public final List<Field> positionalParametersFields;
2802
2803
2804
2805
2806 public String separator;
2807
2808
2809
2810 public String commandName = DEFAULT_COMMAND_NAME;
2811
2812
2813
2814
2815
2816 public String[] description = {};
2817
2818
2819
2820
2821
2822 public String[] customSynopsis = {};
2823
2824
2825
2826
2827
2828 public String[] header = {};
2829
2830
2831
2832
2833
2834 public String[] footer = {};
2835
2836
2837
2838
2839
2840 public IParamLabelRenderer parameterLabelRenderer;
2841
2842
2843 public Boolean abbreviateSynopsis;
2844
2845
2846 public Boolean sortOptions;
2847
2848
2849 public Boolean showDefaultValues;
2850
2851
2852 public Character requiredOptionMarker;
2853
2854
2855 public String headerHeading;
2856
2857
2858 public String synopsisHeading;
2859
2860
2861 public String descriptionHeading;
2862
2863
2864 public String parameterListHeading;
2865
2866
2867 public String optionListHeading;
2868
2869
2870 public String commandListHeading;
2871
2872
2873 public String footerHeading;
2874
2875
2876
2877
2878 public Help(Object command) {
2879 this(command, Ansi.AUTO);
2880 }
2881
2882
2883
2884
2885
2886 public Help(Object command, Ansi ansi) {
2887 this(command, defaultColorScheme(ansi));
2888 }
2889
2890
2891
2892
2893
2894 public Help(Object command, ColorScheme colorScheme) {
2895 this.command = Assert.notNull(command, "command");
2896 this.colorScheme = Assert.notNull(colorScheme, "colorScheme").applySystemProperties();
2897 List<Field> options = new ArrayList<Field>();
2898 List<Field> operands = new ArrayList<Field>();
2899 Class<?> cls = command.getClass();
2900 while (cls != null) {
2901 for (Field field : cls.getDeclaredFields()) {
2902 field.setAccessible(true);
2903 if (field.isAnnotationPresent(Option.class)) {
2904 Option option = field.getAnnotation(Option.class);
2905 if (!option.hidden()) {
2906
2907 options.add(field);
2908 }
2909 }
2910 if (field.isAnnotationPresent(Parameters.class)) {
2911 operands.add(field);
2912 }
2913 }
2914
2915 if (cls.isAnnotationPresent(Command.class)) {
2916 Command cmd = cls.getAnnotation(Command.class);
2917 if (DEFAULT_COMMAND_NAME.equals(commandName)) {
2918 commandName = cmd.name();
2919 }
2920 separator = (separator == null) ? cmd.separator() : separator;
2921 abbreviateSynopsis = (abbreviateSynopsis == null) ? cmd.abbreviateSynopsis() : abbreviateSynopsis;
2922 sortOptions = (sortOptions == null) ? cmd.sortOptions() : sortOptions;
2923 requiredOptionMarker = (requiredOptionMarker == null) ? cmd.requiredOptionMarker() : requiredOptionMarker;
2924 showDefaultValues = (showDefaultValues == null) ? cmd.showDefaultValues() : showDefaultValues;
2925 customSynopsis = empty(customSynopsis) ? cmd.customSynopsis() : customSynopsis;
2926 description = empty(description) ? cmd.description() : description;
2927 header = empty(header) ? cmd.header() : header;
2928 footer = empty(footer) ? cmd.footer() : footer;
2929 headerHeading = empty(headerHeading) ? cmd.headerHeading() : headerHeading;
2930 synopsisHeading = empty(synopsisHeading) || "Usage: ".equals(synopsisHeading) ? cmd.synopsisHeading() : synopsisHeading;
2931 descriptionHeading = empty(descriptionHeading) ? cmd.descriptionHeading() : descriptionHeading;
2932 parameterListHeading = empty(parameterListHeading) ? cmd.parameterListHeading() : parameterListHeading;
2933 optionListHeading = empty(optionListHeading) ? cmd.optionListHeading() : optionListHeading;
2934 commandListHeading = empty(commandListHeading) || "Commands:%n".equals(commandListHeading) ? cmd.commandListHeading() : commandListHeading;
2935 footerHeading = empty(footerHeading) ? cmd.footerHeading() : footerHeading;
2936 }
2937 cls = cls.getSuperclass();
2938 }
2939 sortOptions = (sortOptions == null) ? true : sortOptions;
2940 abbreviateSynopsis = (abbreviateSynopsis == null) ? false : abbreviateSynopsis;
2941 requiredOptionMarker = (requiredOptionMarker == null) ? ' ' : requiredOptionMarker;
2942 showDefaultValues = (showDefaultValues == null) ? false : showDefaultValues;
2943 synopsisHeading = (synopsisHeading == null) ? "Usage: " : synopsisHeading;
2944 commandListHeading = (commandListHeading == null) ? "Commands:%n" : commandListHeading;
2945 separator = (separator == null) ? DEFAULT_SEPARATOR : separator;
2946 parameterLabelRenderer = createDefaultParamLabelRenderer();
2947 Collections.sort(operands, new PositionalParametersSorter());
2948 positionalParametersFields = Collections.unmodifiableList(operands);
2949 optionFields = Collections.unmodifiableList(options);
2950 }
2951
2952
2953
2954
2955
2956
2957 public Help addAllSubcommands(Map<String, CommandLine> commands) {
2958 if (commands != null) {
2959 for (Map.Entry<String, CommandLine> entry : commands.entrySet()) {
2960 addSubcommand(entry.getKey(), entry.getValue().getCommand());
2961 }
2962 }
2963 return this;
2964 }
2965
2966
2967
2968
2969
2970
2971 public Help addSubcommand(String commandName, Object command) {
2972 commands.put(commandName, new Help(command));
2973 return this;
2974 }
2975
2976
2977
2978
2979
2980
2981
2982 public String synopsis() { return synopsis(0); }
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992 public String synopsis(int synopsisHeadingLength) {
2993 if (!empty(customSynopsis)) { return customSynopsis(); }
2994 return abbreviateSynopsis ? abbreviatedSynopsis()
2995 : detailedSynopsis(synopsisHeadingLength, createShortOptionArityAndNameComparator(), true);
2996 }
2997
2998
2999
3000
3001 public String abbreviatedSynopsis() {
3002 StringBuilder sb = new StringBuilder();
3003 if (!optionFields.isEmpty()) {
3004 sb.append(" [OPTIONS]");
3005 }
3006
3007 for (Field positionalParam : positionalParametersFields) {
3008 if (!positionalParam.getAnnotation(Parameters.class).hidden()) {
3009 sb.append(' ').append(parameterLabelRenderer.renderParameterLabel(positionalParam, ansi(), colorScheme.parameterStyles));
3010 }
3011 }
3012 return colorScheme.commandText(commandName).toString()
3013 + (sb.toString()) + System.getProperty("line.separator");
3014 }
3015
3016
3017
3018
3019
3020
3021 public String detailedSynopsis(Comparator<Field> optionSort, boolean clusterBooleanOptions) {
3022 return detailedSynopsis(0, optionSort, clusterBooleanOptions);
3023 }
3024
3025
3026
3027
3028
3029
3030
3031 public String detailedSynopsis(int synopsisHeadingLength, Comparator<Field> optionSort, boolean clusterBooleanOptions) {
3032 Text optionText = ansi().new Text(0);
3033 List<Field> fields = new ArrayList<Field>(optionFields);
3034 if (optionSort != null) {
3035 Collections.sort(fields, optionSort);
3036 }
3037 if (clusterBooleanOptions) {
3038 List<Field> booleanOptions = new ArrayList<Field>();
3039 StringBuilder clusteredRequired = new StringBuilder("-");
3040 StringBuilder clusteredOptional = new StringBuilder("-");
3041 for (Field field : fields) {
3042 if (field.getType() == boolean.class || field.getType() == Boolean.class) {
3043 Option option = field.getAnnotation(Option.class);
3044 String shortestName = ShortestFirst.sort(option.names())[0];
3045 if (shortestName.length() == 2 && shortestName.startsWith("-")) {
3046 booleanOptions.add(field);
3047 if (option.required()) {
3048 clusteredRequired.append(shortestName.substring(1));
3049 } else {
3050 clusteredOptional.append(shortestName.substring(1));
3051 }
3052 }
3053 }
3054 }
3055 fields.removeAll(booleanOptions);
3056 if (clusteredRequired.length() > 1) {
3057 optionText = optionText.append(" ").append(colorScheme.optionText(clusteredRequired.toString()));
3058 }
3059 if (clusteredOptional.length() > 1) {
3060 optionText = optionText.append(" [").append(colorScheme.optionText(clusteredOptional.toString())).append("]");
3061 }
3062 }
3063 for (Field field : fields) {
3064 Option option = field.getAnnotation(Option.class);
3065 if (!option.hidden()) {
3066 if (option.required()) {
3067 optionText = appendOptionSynopsis(optionText, field, ShortestFirst.sort(option.names())[0], " ", "");
3068 if (isMultiValue(field)) {
3069 optionText = appendOptionSynopsis(optionText, field, ShortestFirst.sort(option.names())[0], " [", "]...");
3070 }
3071 } else {
3072 optionText = appendOptionSynopsis(optionText, field, ShortestFirst.sort(option.names())[0], " [", "]");
3073 if (isMultiValue(field)) {
3074 optionText = optionText.append("...");
3075 }
3076 }
3077 }
3078 }
3079 for (Field positionalParam : positionalParametersFields) {
3080 if (!positionalParam.getAnnotation(Parameters.class).hidden()) {
3081 optionText = optionText.append(" ");
3082 Text label = parameterLabelRenderer.renderParameterLabel(positionalParam, colorScheme.ansi(), colorScheme.parameterStyles);
3083 optionText = optionText.append(label);
3084 }
3085 }
3086
3087 int firstColumnLength = commandName.length() + synopsisHeadingLength;
3088
3089
3090 TextTable textTable = new TextTable(ansi(), firstColumnLength, usageHelpWidth - firstColumnLength);
3091 textTable.indentWrappedLines = 1;
3092
3093
3094 Text PADDING = Ansi.OFF.new Text(stringOf('X', synopsisHeadingLength));
3095 textTable.addRowValues(new Text[] {PADDING.append(colorScheme.commandText(commandName)), optionText});
3096 return textTable.toString().substring(synopsisHeadingLength);
3097 }
3098
3099 private Text appendOptionSynopsis(Text optionText, Field field, String optionName, String prefix, String suffix) {
3100 Text optionParamText = parameterLabelRenderer.renderParameterLabel(field, colorScheme.ansi(), colorScheme.optionParamStyles);
3101 return optionText.append(prefix)
3102 .append(colorScheme.optionText(optionName))
3103 .append(optionParamText)
3104 .append(suffix);
3105 }
3106
3107
3108
3109
3110
3111 public int synopsisHeadingLength() {
3112 String[] lines = Ansi.OFF.new Text(synopsisHeading).toString().split("\\r?\\n|\\r|%n", -1);
3113 return lines[lines.length - 1].length();
3114 }
3115
3116
3117
3118
3119
3120
3121
3122
3123 public String optionList() {
3124 Comparator<Field> sortOrder = sortOptions == null || sortOptions.booleanValue()
3125 ? createShortOptionNameComparator()
3126 : null;
3127 return optionList(createDefaultLayout(), sortOrder, parameterLabelRenderer);
3128 }
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138 public String optionList(Layout layout, Comparator<Field> optionSort, IParamLabelRenderer valueLabelRenderer) {
3139 List<Field> fields = new ArrayList<Field>(optionFields);
3140 if (optionSort != null) {
3141 Collections.sort(fields, optionSort);
3142 }
3143 layout.addOptions(fields, valueLabelRenderer);
3144 return layout.toString();
3145 }
3146
3147
3148
3149
3150
3151 public String parameterList() {
3152 return parameterList(createDefaultLayout(), parameterLabelRenderer);
3153 }
3154
3155
3156
3157
3158
3159
3160 public String parameterList(Layout layout, IParamLabelRenderer paramLabelRenderer) {
3161 layout.addPositionalParameters(positionalParametersFields, paramLabelRenderer);
3162 return layout.toString();
3163 }
3164
3165 private static String heading(Ansi ansi, String values, Object... params) {
3166 StringBuilder sb = join(ansi, new String[] {values}, new StringBuilder(), params);
3167 String result = sb.toString();
3168 result = result.endsWith(System.getProperty("line.separator"))
3169 ? result.substring(0, result.length() - System.getProperty("line.separator").length()) : result;
3170 return result + new String(spaces(countTrailingSpaces(values)));
3171 }
3172 private static char[] spaces(int length) { char[] result = new char[length]; Arrays.fill(result, ' '); return result; }
3173 private static int countTrailingSpaces(String str) {
3174 if (str == null) {return 0;}
3175 int trailingSpaces = 0;
3176 for (int i = str.length() - 1; i >= 0 && str.charAt(i) == ' '; i--) { trailingSpaces++; }
3177 return trailingSpaces;
3178 }
3179
3180
3181
3182
3183
3184
3185
3186 public static StringBuilder join(Ansi ansi, String[] values, StringBuilder sb, Object... params) {
3187 if (values != null) {
3188 TextTable table = new TextTable(ansi, usageHelpWidth);
3189 table.indentWrappedLines = 0;
3190 for (String summaryLine : values) {
3191 Text[] lines = ansi.new Text(format(summaryLine, params)).splitLines();
3192 for (Text line : lines) { table.addRowValues(line); }
3193 }
3194 table.toString(sb);
3195 }
3196 return sb;
3197 }
3198 private static String format(String formatString, Object... params) {
3199 return formatString == null ? "" : String.format(formatString, params);
3200 }
3201
3202
3203
3204
3205
3206
3207 public String customSynopsis(Object... params) {
3208 return join(ansi(), customSynopsis, new StringBuilder(), params).toString();
3209 }
3210
3211
3212
3213
3214
3215
3216 public String description(Object... params) {
3217 return join(ansi(), description, new StringBuilder(), params).toString();
3218 }
3219
3220
3221
3222
3223
3224
3225 public String header(Object... params) {
3226 return join(ansi(), header, new StringBuilder(), params).toString();
3227 }
3228
3229
3230
3231
3232
3233
3234 public String footer(Object... params) {
3235 return join(ansi(), footer, new StringBuilder(), params).toString();
3236 }
3237
3238
3239
3240
3241 public String headerHeading(Object... params) {
3242 return heading(ansi(), headerHeading, params);
3243 }
3244
3245
3246
3247
3248 public String synopsisHeading(Object... params) {
3249 return heading(ansi(), synopsisHeading, params);
3250 }
3251
3252
3253
3254
3255
3256 public String descriptionHeading(Object... params) {
3257 return empty(descriptionHeading) ? "" : heading(ansi(), descriptionHeading, params);
3258 }
3259
3260
3261
3262
3263
3264 public String parameterListHeading(Object... params) {
3265 return positionalParametersFields.isEmpty() ? "" : heading(ansi(), parameterListHeading, params);
3266 }
3267
3268
3269
3270
3271
3272 public String optionListHeading(Object... params) {
3273 return optionFields.isEmpty() ? "" : heading(ansi(), optionListHeading, params);
3274 }
3275
3276
3277
3278
3279
3280 public String commandListHeading(Object... params) {
3281 return commands.isEmpty() ? "" : heading(ansi(), commandListHeading, params);
3282 }
3283
3284
3285
3286
3287 public String footerHeading(Object... params) {
3288 return heading(ansi(), footerHeading, params);
3289 }
3290
3291
3292 public String commandList() {
3293 if (commands.isEmpty()) { return ""; }
3294 int commandLength = maxLength(commands.keySet());
3295 Help.TextTable textTable = new Help.TextTable(ansi(),
3296 new Help.Column(commandLength + 2, 2, Help.Column.Overflow.SPAN),
3297 new Help.Column(usageHelpWidth - (commandLength + 2), 2, Help.Column.Overflow.WRAP));
3298
3299 for (Map.Entry<String, Help> entry : commands.entrySet()) {
3300 Help command = entry.getValue();
3301 String header = command.header != null && command.header.length > 0 ? command.header[0]
3302 : (command.description != null && command.description.length > 0 ? command.description[0] : "");
3303 textTable.addRowValues(colorScheme.commandText(entry.getKey()), ansi().new Text(header));
3304 }
3305 return textTable.toString();
3306 }
3307 private static int maxLength(Collection<String> any) {
3308 List<String> strings = new ArrayList<String>(any);
3309 Collections.sort(strings, Collections.reverseOrder(Help.shortestFirst()));
3310 return strings.get(0).length();
3311 }
3312 private static String join(String[] names, int offset, int length, String separator) {
3313 if (names == null) { return ""; }
3314 StringBuilder result = new StringBuilder();
3315 for (int i = offset; i < offset + length; i++) {
3316 result.append((i > offset) ? separator : "").append(names[i]);
3317 }
3318 return result.toString();
3319 }
3320 private static String stringOf(char chr, int length) {
3321 char[] buff = new char[length];
3322 Arrays.fill(buff, chr);
3323 return new String(buff);
3324 }
3325
3326
3327
3328 public Layout createDefaultLayout() {
3329 return new Layout(colorScheme, new TextTable(colorScheme.ansi()), createDefaultOptionRenderer(), createDefaultParameterRenderer());
3330 }
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345 public IOptionRenderer createDefaultOptionRenderer() {
3346 DefaultOptionRenderer result = new DefaultOptionRenderer();
3347 result.requiredMarker = String.valueOf(requiredOptionMarker);
3348 if (showDefaultValues != null && showDefaultValues.booleanValue()) {
3349 result.command = this.command;
3350 }
3351 return result;
3352 }
3353
3354
3355
3356 public static IOptionRenderer createMinimalOptionRenderer() {
3357 return new MinimalOptionRenderer();
3358 }
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373 public IParameterRenderer createDefaultParameterRenderer() {
3374 DefaultParameterRenderer result = new DefaultParameterRenderer();
3375 result.requiredMarker = String.valueOf(requiredOptionMarker);
3376 return result;
3377 }
3378
3379
3380
3381 public static IParameterRenderer createMinimalParameterRenderer() {
3382 return new MinimalParameterRenderer();
3383 }
3384
3385
3386
3387 public static IParamLabelRenderer createMinimalParamLabelRenderer() {
3388 return new IParamLabelRenderer() {
3389 public Text renderParameterLabel(Field field, Ansi ansi, List<IStyle> styles) {
3390 String text = DefaultParamLabelRenderer.renderParameterName(field);
3391 return ansi.apply(text, styles);
3392 }
3393 public String separator() { return ""; }
3394 };
3395 }
3396
3397
3398
3399
3400
3401 public IParamLabelRenderer createDefaultParamLabelRenderer() {
3402 return new DefaultParamLabelRenderer(separator);
3403 }
3404
3405
3406
3407 public static Comparator<Field> createShortOptionNameComparator() {
3408 return new SortByShortestOptionNameAlphabetically();
3409 }
3410
3411
3412
3413 public static Comparator<Field> createShortOptionArityAndNameComparator() {
3414 return new SortByOptionArityAndNameAlphabetically();
3415 }
3416
3417
3418 public static Comparator<String> shortestFirst() {
3419 return new ShortestFirst();
3420 }
3421
3422
3423
3424
3425 public Ansi ansi() {
3426 return colorScheme.ansi;
3427 }
3428
3429
3430
3431
3432
3433 public interface IOptionRenderer {
3434
3435
3436
3437
3438
3439
3440
3441
3442 Text[][] render(Option option, Field field, IParamLabelRenderer parameterLabelRenderer, ColorScheme scheme);
3443 }
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456 static class DefaultOptionRenderer implements IOptionRenderer {
3457 public String requiredMarker = " ";
3458 public Object command;
3459 private String sep;
3460 private boolean showDefault;
3461 public Text[][] render(Option option, Field field, IParamLabelRenderer paramLabelRenderer, ColorScheme scheme) {
3462 String[] names = ShortestFirst.sort(option.names());
3463 int shortOptionCount = names[0].length() == 2 ? 1 : 0;
3464 String shortOption = shortOptionCount > 0 ? names[0] : "";
3465 sep = shortOptionCount > 0 && names.length > 1 ? "," : "";
3466
3467 String longOption = join(names, shortOptionCount, names.length - shortOptionCount, ", ");
3468 Text longOptionText = createLongOptionText(field, paramLabelRenderer, scheme, longOption);
3469
3470 showDefault = command != null && !option.help() && !isBoolean(field.getType());
3471 Object defaultValue = createDefaultValue(field);
3472
3473 String requiredOption = option.required() ? requiredMarker : "";
3474 return renderDescriptionLines(option, scheme, requiredOption, shortOption, longOptionText, defaultValue);
3475 }
3476
3477 private Object createDefaultValue(Field field) {
3478 Object defaultValue = null;
3479 try {
3480 defaultValue = field.get(command);
3481 if (defaultValue == null) { showDefault = false; }
3482 else if (field.getType().isArray()) {
3483 StringBuilder sb = new StringBuilder();
3484 for (int i = 0; i < Array.getLength(defaultValue); i++) {
3485 sb.append(i > 0 ? ", " : "").append(Array.get(defaultValue, i));
3486 }
3487 defaultValue = sb.insert(0, "[").append("]").toString();
3488 }
3489 } catch (Exception ex) {
3490 showDefault = false;
3491 }
3492 return defaultValue;
3493 }
3494
3495 private Text createLongOptionText(Field field, IParamLabelRenderer renderer, ColorScheme scheme, String longOption) {
3496 Text paramLabelText = renderer.renderParameterLabel(field, scheme.ansi(), scheme.optionParamStyles);
3497
3498
3499 if (paramLabelText.length > 0 && longOption.length() == 0) {
3500 sep = renderer.separator();
3501
3502 int sepStart = paramLabelText.plainString().indexOf(sep);
3503 Text prefix = paramLabelText.substring(0, sepStart);
3504 paramLabelText = prefix.append(paramLabelText.substring(sepStart + sep.length()));
3505 }
3506 Text longOptionText = scheme.optionText(longOption);
3507 longOptionText = longOptionText.append(paramLabelText);
3508 return longOptionText;
3509 }
3510
3511 private Text[][] renderDescriptionLines(Option option,
3512 ColorScheme scheme,
3513 String requiredOption,
3514 String shortOption,
3515 Text longOptionText,
3516 Object defaultValue) {
3517 Text EMPTY = Ansi.EMPTY_TEXT;
3518 List<Text[]> result = new ArrayList<Text[]>();
3519 Text[] descriptionFirstLines = scheme.ansi().new Text(str(option.description(), 0)).splitLines();
3520 if (descriptionFirstLines.length == 0) {
3521 if (showDefault) {
3522 descriptionFirstLines = new Text[]{scheme.ansi().new Text(" Default: " + defaultValue)};
3523 showDefault = false;
3524 } else {
3525 descriptionFirstLines = new Text[]{ EMPTY };
3526 }
3527 }
3528 result.add(new Text[] { scheme.optionText(requiredOption), scheme.optionText(shortOption),
3529 scheme.ansi().new Text(sep), longOptionText, descriptionFirstLines[0] });
3530 for (int i = 1; i < descriptionFirstLines.length; i++) {
3531 result.add(new Text[] { EMPTY, EMPTY, EMPTY, EMPTY, descriptionFirstLines[i] });
3532 }
3533 for (int i = 1; i < option.description().length; i++) {
3534 Text[] descriptionNextLines = scheme.ansi().new Text(option.description()[i]).splitLines();
3535 for (Text line : descriptionNextLines) {
3536 result.add(new Text[] { EMPTY, EMPTY, EMPTY, EMPTY, line });
3537 }
3538 }
3539 if (showDefault) {
3540 result.add(new Text[] { EMPTY, EMPTY, EMPTY, EMPTY, scheme.ansi().new Text(" Default: " + defaultValue) });
3541 }
3542 return result.toArray(new Text[result.size()][]);
3543 }
3544 }
3545
3546
3547 static class MinimalOptionRenderer implements IOptionRenderer {
3548 public Text[][] render(Option option, Field field, IParamLabelRenderer parameterLabelRenderer, ColorScheme scheme) {
3549 Text optionText = scheme.optionText(option.names()[0]);
3550 Text paramLabelText = parameterLabelRenderer.renderParameterLabel(field, scheme.ansi(), scheme.optionParamStyles);
3551 optionText = optionText.append(paramLabelText);
3552 return new Text[][] {{ optionText,
3553 scheme.ansi().new Text(option.description().length == 0 ? "" : option.description()[0]) }};
3554 }
3555 }
3556
3557
3558 static class MinimalParameterRenderer implements IParameterRenderer {
3559 public Text[][] render(Parameters param, Field field, IParamLabelRenderer parameterLabelRenderer, ColorScheme scheme) {
3560 return new Text[][] {{ parameterLabelRenderer.renderParameterLabel(field, scheme.ansi(), scheme.parameterStyles),
3561 scheme.ansi().new Text(param.description().length == 0 ? "" : param.description()[0]) }};
3562 }
3563 }
3564
3565
3566
3567
3568 public interface IParameterRenderer {
3569
3570
3571
3572
3573
3574
3575
3576
3577 Text[][] render(Parameters parameters, Field field, IParamLabelRenderer parameterLabelRenderer, ColorScheme scheme);
3578 }
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591 static class DefaultParameterRenderer implements IParameterRenderer {
3592 public String requiredMarker = " ";
3593 public Text[][] render(Parameters params, Field field, IParamLabelRenderer paramLabelRenderer, ColorScheme scheme) {
3594 Text label = paramLabelRenderer.renderParameterLabel(field, scheme.ansi(), scheme.parameterStyles);
3595 Text requiredParameter = scheme.parameterText(Range.parameterArity(field).min > 0 ? requiredMarker : "");
3596
3597 Text EMPTY = Ansi.EMPTY_TEXT;
3598 List<Text[]> result = new ArrayList<Text[]>();
3599 Text[] descriptionFirstLines = scheme.ansi().new Text(str(params.description(), 0)).splitLines();
3600 if (descriptionFirstLines.length == 0) { descriptionFirstLines = new Text[]{ EMPTY }; }
3601 result.add(new Text[] { requiredParameter, EMPTY, EMPTY, label, descriptionFirstLines[0] });
3602 for (int i = 1; i < descriptionFirstLines.length; i++) {
3603 result.add(new Text[] { EMPTY, EMPTY, EMPTY, EMPTY, descriptionFirstLines[i] });
3604 }
3605 for (int i = 1; i < params.description().length; i++) {
3606 Text[] descriptionNextLines = scheme.ansi().new Text(params.description()[i]).splitLines();
3607 for (Text line : descriptionNextLines) {
3608 result.add(new Text[] { EMPTY, EMPTY, EMPTY, EMPTY, line });
3609 }
3610 }
3611 return result.toArray(new Text[result.size()][]);
3612 }
3613 }
3614
3615
3616 public interface IParamLabelRenderer {
3617
3618
3619
3620
3621
3622
3623
3624 Text renderParameterLabel(Field field, Ansi ansi, List<IStyle> styles);
3625
3626
3627
3628 String separator();
3629 }
3630
3631
3632
3633
3634
3635
3636 static class DefaultParamLabelRenderer implements IParamLabelRenderer {
3637
3638 public final String separator;
3639
3640 public DefaultParamLabelRenderer(String separator) {
3641 this.separator = Assert.notNull(separator, "separator");
3642 }
3643 public String separator() { return separator; }
3644 public Text renderParameterLabel(Field field, Ansi ansi, List<IStyle> styles) {
3645 boolean isOptionParameter = field.isAnnotationPresent(Option.class);
3646 Range arity = isOptionParameter ? Range.optionArity(field) : Range.parameterCapacity(field);
3647 String split = isOptionParameter ? field.getAnnotation(Option.class).split() : field.getAnnotation(Parameters.class).split();
3648 Text result = ansi.new Text("");
3649 String sep = isOptionParameter ? separator : "";
3650 Text paramName = ansi.apply(renderParameterName(field), styles);
3651 if (!empty(split)) { paramName = paramName.append("[" + split).append(paramName).append("]..."); }
3652 for (int i = 0; i < arity.min; i++) {
3653 result = result.append(sep).append(paramName);
3654 sep = " ";
3655 }
3656 if (arity.isVariable) {
3657 if (result.length == 0) {
3658 result = result.append(sep + "[").append(paramName).append("]...");
3659 } else if (!result.plainString().endsWith("...")) {
3660 result = result.append("...");
3661 }
3662 } else {
3663 sep = result.length == 0 ? (isOptionParameter ? separator : "") : " ";
3664 for (int i = arity.min; i < arity.max; i++) {
3665 if (sep.trim().length() == 0) {
3666 result = result.append(sep + "[").append(paramName);
3667 } else {
3668 result = result.append("[" + sep).append(paramName);
3669 }
3670 sep = " ";
3671 }
3672 for (int i = arity.min; i < arity.max; i++) { result = result.append("]"); }
3673 }
3674 return result;
3675 }
3676 private static String renderParameterName(Field field) {
3677 String result = null;
3678 if (field.isAnnotationPresent(Option.class)) {
3679 result = field.getAnnotation(Option.class).paramLabel();
3680 } else if (field.isAnnotationPresent(Parameters.class)) {
3681 result = field.getAnnotation(Parameters.class).paramLabel();
3682 }
3683 if (result != null && result.trim().length() > 0) {
3684 return result.trim();
3685 }
3686 String name = field.getName();
3687 if (Map.class.isAssignableFrom(field.getType())) {
3688 Class<?>[] paramTypes = getTypeAttribute(field);
3689 if (paramTypes.length < 2 || paramTypes[0] == null || paramTypes[1] == null) {
3690 name = "String=String";
3691 } else { name = paramTypes[0].getSimpleName() + "=" + paramTypes[1].getSimpleName(); }
3692 }
3693 return "<" + name + ">";
3694 }
3695 }
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705 public static class Layout {
3706 protected final ColorScheme colorScheme;
3707 protected final TextTable table;
3708 protected IOptionRenderer optionRenderer;
3709 protected IParameterRenderer parameterRenderer;
3710
3711
3712
3713
3714
3715 public Layout(ColorScheme colorScheme) { this(colorScheme, new TextTable(colorScheme.ansi())); }
3716
3717
3718
3719
3720
3721
3722 public Layout(ColorScheme colorScheme, TextTable textTable) {
3723 this(colorScheme, textTable, new DefaultOptionRenderer(), new DefaultParameterRenderer());
3724 }
3725
3726
3727
3728
3729
3730
3731 public Layout(ColorScheme colorScheme, TextTable textTable, IOptionRenderer optionRenderer, IParameterRenderer parameterRenderer) {
3732 this.colorScheme = Assert.notNull(colorScheme, "colorScheme");
3733 this.table = Assert.notNull(textTable, "textTable");
3734 this.optionRenderer = Assert.notNull(optionRenderer, "optionRenderer");
3735 this.parameterRenderer = Assert.notNull(parameterRenderer, "parameterRenderer");
3736 }
3737
3738
3739
3740
3741
3742
3743
3744 public void layout(Field field, Text[][] cellValues) {
3745 for (Text[] oneRow : cellValues) {
3746 table.addRowValues(oneRow);
3747 }
3748 }
3749
3750
3751
3752 public void addOptions(List<Field> fields, IParamLabelRenderer paramLabelRenderer) {
3753 for (Field field : fields) {
3754 Option option = field.getAnnotation(Option.class);
3755 if (!option.hidden()) {
3756 addOption(field, paramLabelRenderer);
3757 }
3758 }
3759 }
3760
3761
3762
3763
3764
3765
3766
3767 public void addOption(Field field, IParamLabelRenderer paramLabelRenderer) {
3768 Option option = field.getAnnotation(Option.class);
3769 Text[][] values = optionRenderer.render(option, field, paramLabelRenderer, colorScheme);
3770 layout(field, values);
3771 }
3772
3773
3774
3775 public void addPositionalParameters(List<Field> fields, IParamLabelRenderer paramLabelRenderer) {
3776 for (Field field : fields) {
3777 Parameters parameters = field.getAnnotation(Parameters.class);
3778 if (!parameters.hidden()) {
3779 addPositionalParameter(field, paramLabelRenderer);
3780 }
3781 }
3782 }
3783
3784
3785
3786
3787
3788
3789
3790 public void addPositionalParameter(Field field, IParamLabelRenderer paramLabelRenderer) {
3791 Parameters option = field.getAnnotation(Parameters.class);
3792 Text[][] values = parameterRenderer.render(option, field, paramLabelRenderer, colorScheme);
3793 layout(field, values);
3794 }
3795
3796 @Override public String toString() {
3797 return table.toString();
3798 }
3799 }
3800
3801 static class ShortestFirst implements Comparator<String> {
3802 public int compare(String o1, String o2) {
3803 return o1.length() - o2.length();
3804 }
3805
3806 public static String[] sort(String[] names) {
3807 Arrays.sort(names, new ShortestFirst());
3808 return names;
3809 }
3810 }
3811
3812
3813 static class SortByShortestOptionNameAlphabetically implements Comparator<Field> {
3814 public int compare(Field f1, Field f2) {
3815 Option o1 = f1.getAnnotation(Option.class);
3816 Option o2 = f2.getAnnotation(Option.class);
3817 if (o1 == null) { return 1; } else if (o2 == null) { return -1; }
3818 String[] names1 = ShortestFirst.sort(o1.names());
3819 String[] names2 = ShortestFirst.sort(o2.names());
3820 int result = names1[0].toUpperCase().compareTo(names2[0].toUpperCase());
3821 result = result == 0 ? -names1[0].compareTo(names2[0]) : result;
3822 return o1.help() == o2.help() ? result : o2.help() ? -1 : 1;
3823 }
3824 }
3825
3826 static class SortByOptionArityAndNameAlphabetically extends SortByShortestOptionNameAlphabetically {
3827 public int compare(Field f1, Field f2) {
3828 Option o1 = f1.getAnnotation(Option.class);
3829 Option o2 = f2.getAnnotation(Option.class);
3830 Range arity1 = Range.optionArity(f1);
3831 Range arity2 = Range.optionArity(f2);
3832 int result = arity1.max - arity2.max;
3833 if (result == 0) {
3834 result = arity1.min - arity2.min;
3835 }
3836 if (result == 0) {
3837 if (isMultiValue(f1) && !isMultiValue(f2)) { result = 1; }
3838 if (!isMultiValue(f1) && isMultiValue(f2)) { result = -1; }
3839 }
3840 return result == 0 ? super.compare(f1, f2) : result;
3841 }
3842 }
3843
3844
3845
3846
3847
3848 public static class TextTable {
3849
3850
3851
3852
3853 public static class Cell {
3854
3855 public final int column;
3856
3857 public final int row;
3858
3859
3860
3861 public Cell(int column, int row) { this.column = column; this.row = row; }
3862 }
3863
3864
3865 public final Column[] columns;
3866
3867
3868 protected final List<Text> columnValues = new ArrayList<Text>();
3869
3870
3871 public int indentWrappedLines = 2;
3872
3873 private final Ansi ansi;
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885 public TextTable(Ansi ansi) {
3886
3887 this(ansi, new Column[] {
3888 new Column(2, 0, TRUNCATE),
3889 new Column(2, 0, TRUNCATE),
3890 new Column(1, 0, TRUNCATE),
3891 new Column(optionsColumnWidth - 2 - 2 - 1 , 1, SPAN),
3892 new Column(usageHelpWidth - optionsColumnWidth, 1, WRAP)
3893 });
3894 }
3895
3896
3897
3898
3899
3900
3901 public TextTable(Ansi ansi, int... columnWidths) {
3902 this.ansi = Assert.notNull(ansi, "ansi");
3903 columns = new Column[columnWidths.length];
3904 for (int i = 0; i < columnWidths.length; i++) {
3905 columns[i] = new Column(columnWidths[i], 0, i == columnWidths.length - 1 ? SPAN: WRAP);
3906 }
3907 }
3908
3909
3910
3911 public TextTable(Ansi ansi, Column... columns) {
3912 this.ansi = Assert.notNull(ansi, "ansi");
3913 this.columns = Assert.notNull(columns, "columns");
3914 if (columns.length == 0) { throw new IllegalArgumentException("At least one column is required"); }
3915 }
3916
3917
3918
3919
3920
3921 public Text textAt(int row, int col) { return columnValues.get(col + (row * columns.length)); }
3922
3923
3924
3925
3926
3927
3928 public Text cellAt(int row, int col) { return textAt(row, col); }
3929
3930
3931
3932 public int rowCount() { return columnValues.size() / columns.length; }
3933
3934
3935 public void addEmptyRow() {
3936 for (int i = 0; i < columns.length; i++) {
3937 columnValues.add(ansi.new Text(columns[i].width));
3938 }
3939 }
3940
3941
3942
3943 public void addRowValues(String... values) {
3944 Text[] array = new Text[values.length];
3945 for (int i = 0; i < array.length; i++) {
3946 array[i] = values[i] == null ? Ansi.EMPTY_TEXT : ansi.new Text(values[i]);
3947 }
3948 addRowValues(array);
3949 }
3950
3951
3952
3953
3954
3955
3956
3957 public void addRowValues(Text... values) {
3958 if (values.length > columns.length) {
3959 throw new IllegalArgumentException(values.length + " values don't fit in " +
3960 columns.length + " columns");
3961 }
3962 addEmptyRow();
3963 for (int col = 0; col < values.length; col++) {
3964 int row = rowCount() - 1;
3965 Cell cell = putValue(row, col, values[col]);
3966
3967
3968 if ((cell.row != row || cell.column != col) && col != values.length - 1) {
3969 addEmptyRow();
3970 }
3971 }
3972 }
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985 public Cell putValue(int row, int col, Text value) {
3986 if (row > rowCount() - 1) {
3987 throw new IllegalArgumentException("Cannot write to row " + row + ": rowCount=" + rowCount());
3988 }
3989 if (value == null || value.plain.length() == 0) { return new Cell(col, row); }
3990 Column column = columns[col];
3991 int indent = column.indent;
3992 switch (column.overflow) {
3993 case TRUNCATE:
3994 copy(value, textAt(row, col), indent);
3995 return new Cell(col, row);
3996 case SPAN:
3997 int startColumn = col;
3998 do {
3999 boolean lastColumn = col == columns.length - 1;
4000 int charsWritten = lastColumn
4001 ? copy(BreakIterator.getLineInstance(), value, textAt(row, col), indent)
4002 : copy(value, textAt(row, col), indent);
4003 value = value.substring(charsWritten);
4004 indent = 0;
4005 if (value.length > 0) {
4006 ++col;
4007 }
4008 if (value.length > 0 && col >= columns.length) {
4009 addEmptyRow();
4010 row++;
4011 col = startColumn;
4012 indent = column.indent + indentWrappedLines;
4013 }
4014 } while (value.length > 0);
4015 return new Cell(col, row);
4016 case WRAP:
4017 BreakIterator lineBreakIterator = BreakIterator.getLineInstance();
4018 do {
4019 int charsWritten = copy(lineBreakIterator, value, textAt(row, col), indent);
4020 value = value.substring(charsWritten);
4021 indent = column.indent + indentWrappedLines;
4022 if (value.length > 0) {
4023 ++row;
4024 addEmptyRow();
4025 }
4026 } while (value.length > 0);
4027 return new Cell(col, row);
4028 }
4029 throw new IllegalStateException(column.overflow.toString());
4030 }
4031 private static int length(Text str) {
4032 return str.length;
4033 }
4034
4035 private int copy(BreakIterator line, Text text, Text columnValue, int offset) {
4036
4037 line.setText(text.plainString().replace("-", "\u00ff"));
4038 int done = 0;
4039 for (int start = line.first(), end = line.next(); end != BreakIterator.DONE; start = end, end = line.next()) {
4040 Text word = text.substring(start, end);
4041 if (columnValue.maxLength >= offset + done + length(word)) {
4042 done += copy(word, columnValue, offset + done);
4043 } else {
4044 break;
4045 }
4046 }
4047 if (done == 0 && length(text) > columnValue.maxLength) {
4048
4049 done = copy(text, columnValue, offset);
4050 }
4051 return done;
4052 }
4053 private static int copy(Text value, Text destination, int offset) {
4054 int length = Math.min(value.length, destination.maxLength - offset);
4055 value.getStyledChars(value.from, length, destination, offset);
4056 return length;
4057 }
4058
4059
4060
4061
4062 public StringBuilder toString(StringBuilder text) {
4063 int columnCount = this.columns.length;
4064 StringBuilder row = new StringBuilder(usageHelpWidth);
4065 for (int i = 0; i < columnValues.size(); i++) {
4066 Text column = columnValues.get(i);
4067 row.append(column.toString());
4068 row.append(new String(spaces(columns[i % columnCount].width - column.length)));
4069 if (i % columnCount == columnCount - 1) {
4070 int lastChar = row.length() - 1;
4071 while (lastChar >= 0 && row.charAt(lastChar) == ' ') {lastChar--;}
4072 row.setLength(lastChar + 1);
4073 text.append(row.toString()).append(System.getProperty("line.separator"));
4074 row.setLength(0);
4075 }
4076 }
4077
4078 return text;
4079 }
4080 public String toString() { return toString(new StringBuilder()).toString(); }
4081 }
4082
4083
4084 public static class Column {
4085
4086
4087
4088 public enum Overflow { TRUNCATE, SPAN, WRAP }
4089
4090
4091 public final int width;
4092
4093
4094 public final int indent;
4095
4096
4097 public final Overflow overflow;
4098 public Column(int width, int indent, Overflow overflow) {
4099 this.width = width;
4100 this.indent = indent;
4101 this.overflow = Assert.notNull(overflow, "overflow");
4102 }
4103 }
4104
4105
4106
4107
4108
4109
4110
4111
4112 public static class ColorScheme {
4113 public final List<IStyle> commandStyles = new ArrayList<IStyle>();
4114 public final List<IStyle> optionStyles = new ArrayList<IStyle>();
4115 public final List<IStyle> parameterStyles = new ArrayList<IStyle>();
4116 public final List<IStyle> optionParamStyles = new ArrayList<IStyle>();
4117 private final Ansi ansi;
4118
4119
4120 public ColorScheme() { this(Ansi.AUTO); }
4121
4122
4123
4124
4125 public ColorScheme(Ansi ansi) {this.ansi = Assert.notNull(ansi, "ansi"); }
4126
4127
4128
4129
4130 public ColorScheme commands(IStyle... styles) { return addAll(commandStyles, styles); }
4131
4132
4133
4134 public ColorScheme options(IStyle... styles) { return addAll(optionStyles, styles);}
4135
4136
4137
4138 public ColorScheme parameters(IStyle... styles) { return addAll(parameterStyles, styles);}
4139
4140
4141
4142 public ColorScheme optionParams(IStyle... styles) { return addAll(optionParamStyles, styles);}
4143
4144
4145
4146 public Ansi.Text commandText(String command) { return ansi().apply(command, commandStyles); }
4147
4148
4149
4150 public Ansi.Text optionText(String option) { return ansi().apply(option, optionStyles); }
4151
4152
4153
4154 public Ansi.Text parameterText(String parameter) { return ansi().apply(parameter, parameterStyles); }
4155
4156
4157
4158 public Ansi.Text optionParamText(String optionParam) { return ansi().apply(optionParam, optionParamStyles); }
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169 public ColorScheme applySystemProperties() {
4170 replace(commandStyles, System.getProperty("picocli.color.commands"));
4171 replace(optionStyles, System.getProperty("picocli.color.options"));
4172 replace(parameterStyles, System.getProperty("picocli.color.parameters"));
4173 replace(optionParamStyles, System.getProperty("picocli.color.optionParams"));
4174 return this;
4175 }
4176 private void replace(List<IStyle> styles, String property) {
4177 if (property != null) {
4178 styles.clear();
4179 addAll(styles, Style.parse(property));
4180 }
4181 }
4182 private ColorScheme addAll(List<IStyle> styles, IStyle... add) {
4183 styles.addAll(Arrays.asList(add));
4184 return this;
4185 }
4186
4187 public Ansi ansi() {
4188 return ansi;
4189 }
4190 }
4191
4192
4193
4194
4195
4196
4197 public static ColorScheme defaultColorScheme(Ansi ansi) {
4198 return new ColorScheme(ansi)
4199 .commands(Style.bold)
4200 .options(Style.fg_yellow)
4201 .parameters(Style.fg_yellow)
4202 .optionParams(Style.italic);
4203 }
4204
4205
4206 public enum Ansi {
4207
4208
4209 AUTO,
4210
4211 ON,
4212
4213 OFF;
4214 static Text EMPTY_TEXT = OFF.new Text(0);
4215 static final boolean isWindows = System.getProperty("os.name").startsWith("Windows");
4216 static final boolean isXterm = System.getenv("TERM") != null && System.getenv("TERM").startsWith("xterm");
4217 static final boolean ISATTY = calcTTY();
4218
4219
4220 static final boolean calcTTY() {
4221 if (isWindows && isXterm) { return true; }
4222 try { return System.class.getDeclaredMethod("console").invoke(null) != null; }
4223 catch (Throwable reflectionFailed) { return true; }
4224 }
4225 private static boolean ansiPossible() { return ISATTY && (!isWindows || isXterm); }
4226
4227
4228
4229
4230 public boolean enabled() {
4231 if (this == ON) { return true; }
4232 if (this == OFF) { return false; }
4233 return (System.getProperty("picocli.ansi") == null ? ansiPossible() : Boolean.getBoolean("picocli.ansi"));
4234 }
4235
4236
4237 public interface IStyle {
4238
4239
4240 String CSI = "\u001B[";
4241
4242
4243
4244 String on();
4245
4246
4247
4248 String off();
4249 }
4250
4251
4252
4253
4254
4255
4256 public enum Style implements IStyle {
4257 reset(0, 0), bold(1, 21), faint(2, 22), italic(3, 23), underline(4, 24), blink(5, 25), reverse(7, 27),
4258 fg_black(30, 39), fg_red(31, 39), fg_green(32, 39), fg_yellow(33, 39), fg_blue(34, 39), fg_magenta(35, 39), fg_cyan(36, 39), fg_white(37, 39),
4259 bg_black(40, 49), bg_red(41, 49), bg_green(42, 49), bg_yellow(43, 49), bg_blue(44, 49), bg_magenta(45, 49), bg_cyan(46, 49), bg_white(47, 49),
4260 ;
4261 private final int startCode;
4262 private final int endCode;
4263
4264 Style(int startCode, int endCode) {this.startCode = startCode; this.endCode = endCode; }
4265 public String on() { return CSI + startCode + "m"; }
4266 public String off() { return CSI + endCode + "m"; }
4267
4268
4269
4270
4271 public static String on(IStyle... styles) {
4272 StringBuilder result = new StringBuilder();
4273 for (IStyle style : styles) {
4274 result.append(style.on());
4275 }
4276 return result.toString();
4277 }
4278
4279
4280
4281 public static String off(IStyle... styles) {
4282 StringBuilder result = new StringBuilder();
4283 for (IStyle style : styles) {
4284 result.append(style.off());
4285 }
4286 return result.toString();
4287 }
4288
4289
4290
4291
4292
4293
4294
4295 public static IStyle fg(String str) {
4296 try { return Style.valueOf(str.toLowerCase(ENGLISH)); } catch (Exception ignored) {}
4297 try { return Style.valueOf("fg_" + str.toLowerCase(ENGLISH)); } catch (Exception ignored) {}
4298 return new Palette256Color(true, str);
4299 }
4300
4301
4302
4303
4304
4305
4306
4307 public static IStyle bg(String str) {
4308 try { return Style.valueOf(str.toLowerCase(ENGLISH)); } catch (Exception ignored) {}
4309 try { return Style.valueOf("bg_" + str.toLowerCase(ENGLISH)); } catch (Exception ignored) {}
4310 return new Palette256Color(false, str);
4311 }
4312
4313
4314
4315
4316
4317
4318 public static IStyle[] parse(String commaSeparatedCodes) {
4319 String[] codes = commaSeparatedCodes.split(",");
4320 IStyle[] styles = new IStyle[codes.length];
4321 for(int i = 0; i < codes.length; ++i) {
4322 if (codes[i].toLowerCase(ENGLISH).startsWith("fg(")) {
4323 int end = codes[i].indexOf(')');
4324 styles[i] = Style.fg(codes[i].substring(3, end < 0 ? codes[i].length() : end));
4325 } else if (codes[i].toLowerCase(ENGLISH).startsWith("bg(")) {
4326 int end = codes[i].indexOf(')');
4327 styles[i] = Style.bg(codes[i].substring(3, end < 0 ? codes[i].length() : end));
4328 } else {
4329 styles[i] = Style.fg(codes[i]);
4330 }
4331 }
4332 return styles;
4333 }
4334 }
4335
4336
4337
4338 static class Palette256Color implements IStyle {
4339 private final int fgbg;
4340 private final int color;
4341
4342 Palette256Color(boolean foreground, String color) {
4343 this.fgbg = foreground ? 38 : 48;
4344 String[] rgb = color.split(";");
4345 if (rgb.length == 3) {
4346 this.color = 16 + 36 * Integer.decode(rgb[0]) + 6 * Integer.decode(rgb[1]) + Integer.decode(rgb[2]);
4347 } else {
4348 this.color = Integer.decode(color);
4349 }
4350 }
4351 public String on() { return String.format(CSI + "%d;5;%dm", fgbg, color); }
4352 public String off() { return CSI + (fgbg + 1) + "m"; }
4353 }
4354 private static class StyledSection {
4355 int startIndex, length;
4356 String startStyles, endStyles;
4357 StyledSection(int start, int len, String style1, String style2) {
4358 startIndex = start; length = len; startStyles = style1; endStyles = style2;
4359 }
4360 StyledSection withStartIndex(int newStart) {
4361 return new StyledSection(newStart, length, startStyles, endStyles);
4362 }
4363 }
4364
4365
4366
4367
4368
4369
4370
4371
4372 public Text apply(String plainText, List<IStyle> styles) {
4373 if (plainText.length() == 0) { return new Text(0); }
4374 Text result = new Text(plainText.length());
4375 IStyle[] all = styles.toArray(new IStyle[styles.size()]);
4376 result.sections.add(new StyledSection(
4377 0, plainText.length(), Style.on(all), Style.off(reverse(all)) + Style.reset.off()));
4378 result.plain.append(plainText);
4379 result.length = result.plain.length();
4380 return result;
4381 }
4382
4383 private static <T> T[] reverse(T[] all) {
4384 for (int i = 0; i < all.length / 2; i++) {
4385 T temp = all[i];
4386 all[i] = all[all.length - i - 1];
4387 all[all.length - i - 1] = temp;
4388 }
4389 return all;
4390 }
4391
4392
4393
4394
4395
4396
4397 public class Text implements Cloneable {
4398 private final int maxLength;
4399 private int from;
4400 private int length;
4401 private StringBuilder plain = new StringBuilder();
4402 private List<StyledSection> sections = new ArrayList<StyledSection>();
4403
4404
4405
4406 public Text(int maxLength) { this.maxLength = maxLength; }
4407
4408
4409
4410
4411
4412
4413 public Text(String input) {
4414 maxLength = -1;
4415 plain.setLength(0);
4416 int i = 0;
4417
4418 while (true) {
4419 int j = input.indexOf("@|", i);
4420 if (j == -1) {
4421 if (i == 0) {
4422 plain.append(input);
4423 length = plain.length();
4424 return;
4425 }
4426 plain.append(input.substring(i, input.length()));
4427 length = plain.length();
4428 return;
4429 }
4430 plain.append(input.substring(i, j));
4431 int k = input.indexOf("|@", j);
4432 if (k == -1) {
4433 plain.append(input);
4434 length = plain.length();
4435 return;
4436 }
4437
4438 j += 2;
4439 String spec = input.substring(j, k);
4440 String[] items = spec.split(" ", 2);
4441 if (items.length == 1) {
4442 plain.append(input);
4443 length = plain.length();
4444 return;
4445 }
4446
4447 IStyle[] styles = Style.parse(items[0]);
4448 addStyledSection(plain.length(), items[1].length(),
4449 Style.on(styles), Style.off(reverse(styles)) + Style.reset.off());
4450 plain.append(items[1]);
4451 i = k + 2;
4452 }
4453 }
4454 private void addStyledSection(int start, int length, String startStyle, String endStyle) {
4455 sections.add(new StyledSection(start, length, startStyle, endStyle));
4456 }
4457 public Object clone() {
4458 try { return super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException(e); }
4459 }
4460
4461 public Text[] splitLines() {
4462 List<Text> result = new ArrayList<Text>();
4463 boolean trailingEmptyString = false;
4464 int start = 0, end = 0;
4465 for (int i = 0; i < plain.length(); i++, end = i) {
4466 char c = plain.charAt(i);
4467 boolean eol = c == '\n';
4468 eol |= (c == '\r' && i + 1 < plain.length() && plain.charAt(i + 1) == '\n' && ++i > 0);
4469 eol |= c == '\r';
4470 if (eol) {
4471 result.add(this.substring(start, end));
4472 trailingEmptyString = i == plain.length() - 1;
4473 start = i + 1;
4474 }
4475 }
4476 if (start < plain.length() || trailingEmptyString) {
4477 result.add(this.substring(start, plain.length()));
4478 }
4479 return result.toArray(new Text[result.size()]);
4480 }
4481
4482
4483
4484
4485 public Text substring(int start) {
4486 return substring(start, length);
4487 }
4488
4489
4490
4491
4492
4493 public Text substring(int start, int end) {
4494 Text result = (Text) clone();
4495 result.from = from + start;
4496 result.length = end - start;
4497 return result;
4498 }
4499
4500
4501
4502 public Text append(String string) {
4503 return append(new Text(string));
4504 }
4505
4506
4507
4508
4509 public Text append(Text other) {
4510 Text result = (Text) clone();
4511 result.plain = new StringBuilder(plain.toString().substring(from, from + length));
4512 result.from = 0;
4513 result.sections = new ArrayList<StyledSection>();
4514 for (StyledSection section : sections) {
4515 result.sections.add(section.withStartIndex(section.startIndex - from));
4516 }
4517 result.plain.append(other.plain.toString().substring(other.from, other.from + other.length));
4518 for (StyledSection section : other.sections) {
4519 int index = result.length + section.startIndex - other.from;
4520 result.sections.add(section.withStartIndex(index));
4521 }
4522 result.length = result.plain.length();
4523 return result;
4524 }
4525
4526
4527
4528
4529
4530
4531
4532
4533 public void getStyledChars(int from, int length, Text destination, int offset) {
4534 if (destination.length < offset) {
4535 for (int i = destination.length; i < offset; i++) {
4536 destination.plain.append(' ');
4537 }
4538 destination.length = offset;
4539 }
4540 for (StyledSection section : sections) {
4541 destination.sections.add(section.withStartIndex(section.startIndex - from + destination.length));
4542 }
4543 destination.plain.append(plain.toString().substring(from, from + length));
4544 destination.length = destination.plain.length();
4545 }
4546
4547
4548 public String plainString() { return plain.toString().substring(from, from + length); }
4549
4550 public boolean equals(Object obj) { return toString().equals(String.valueOf(obj)); }
4551 public int hashCode() { return toString().hashCode(); }
4552
4553
4554
4555
4556 public String toString() {
4557 if (!Ansi.this.enabled()) {
4558 return plain.toString().substring(from, from + length);
4559 }
4560 if (length == 0) { return ""; }
4561 StringBuilder sb = new StringBuilder(plain.length() + 20 * sections.size());
4562 StyledSection current = null;
4563 int end = Math.min(from + length, plain.length());
4564 for (int i = from; i < end; i++) {
4565 StyledSection section = findSectionContaining(i);
4566 if (section != current) {
4567 if (current != null) { sb.append(current.endStyles); }
4568 if (section != null) { sb.append(section.startStyles); }
4569 current = section;
4570 }
4571 sb.append(plain.charAt(i));
4572 }
4573 if (current != null) { sb.append(current.endStyles); }
4574 return sb.toString();
4575 }
4576
4577 private StyledSection findSectionContaining(int index) {
4578 for (StyledSection section : sections) {
4579 if (index >= section.startIndex && index < section.startIndex + section.length) {
4580 return section;
4581 }
4582 }
4583 return null;
4584 }
4585 }
4586 }
4587 }
4588
4589
4590
4591
4592 private static final class Assert {
4593
4594
4595
4596
4597
4598
4599
4600 static <T> T notNull(T object, String description) {
4601 if (object == null) {
4602 throw new NullPointerException(description);
4603 }
4604 return object;
4605 }
4606 private Assert() {}
4607 }
4608 private enum TraceLevel { OFF, WARN, INFO, DEBUG;
4609 public boolean isEnabled(TraceLevel other) { return ordinal() >= other.ordinal(); }
4610 private void print(Tracer tracer, String msg, Object... params) {
4611 if (tracer.level.isEnabled(this)) { tracer.stream.printf(prefix(msg), params); }
4612 }
4613 private String prefix(String msg) { return "[picocli " + this + "] " + msg; }
4614 static TraceLevel lookup(String key) { return key == null ? WARN : empty(key) || "true".equalsIgnoreCase(key) ? INFO : valueOf(key); }
4615 }
4616 private static class Tracer {
4617 TraceLevel level = TraceLevel.lookup(System.getProperty("picocli.trace"));
4618 PrintStream stream = System.err;
4619 void warn (String msg, Object... params) { TraceLevel.WARN.print(this, msg, params); }
4620 void info (String msg, Object... params) { TraceLevel.INFO.print(this, msg, params); }
4621 void debug(String msg, Object... params) { TraceLevel.DEBUG.print(this, msg, params); }
4622 boolean isWarn() { return level.isEnabled(TraceLevel.WARN); }
4623 boolean isInfo() { return level.isEnabled(TraceLevel.INFO); }
4624 boolean isDebug() { return level.isEnabled(TraceLevel.DEBUG); }
4625 }
4626
4627
4628 public static class PicocliException extends RuntimeException {
4629 private static final long serialVersionUID = -2574128880125050818L;
4630 public PicocliException(String msg) { super(msg); }
4631 public PicocliException(String msg, Exception ex) { super(msg, ex); }
4632 }
4633
4634
4635 public static class InitializationException extends PicocliException {
4636 private static final long serialVersionUID = 8423014001666638895L;
4637 public InitializationException(String msg) { super(msg); }
4638 public InitializationException(String msg, Exception ex) { super(msg, ex); }
4639 }
4640
4641
4642 public static class ExecutionException extends PicocliException {
4643 private static final long serialVersionUID = 7764539594267007998L;
4644 private final CommandLine commandLine;
4645 public ExecutionException(CommandLine commandLine, String msg) {
4646 super(msg);
4647 this.commandLine = Assert.notNull(commandLine, "commandLine");
4648 }
4649 public ExecutionException(CommandLine commandLine, String msg, Exception ex) {
4650 super(msg, ex);
4651 this.commandLine = Assert.notNull(commandLine, "commandLine");
4652 }
4653
4654
4655
4656 public CommandLine getCommandLine() { return commandLine; }
4657 }
4658
4659
4660 public static class TypeConversionException extends PicocliException {
4661 private static final long serialVersionUID = 4251973913816346114L;
4662 public TypeConversionException(String msg) { super(msg); }
4663 }
4664
4665 public static class ParameterException extends PicocliException {
4666 private static final long serialVersionUID = 1477112829129763139L;
4667 private final CommandLine commandLine;
4668
4669
4670
4671
4672
4673 public ParameterException(CommandLine commandLine, String msg) {
4674 super(msg);
4675 this.commandLine = Assert.notNull(commandLine, "commandLine");
4676 }
4677
4678
4679
4680
4681
4682 public ParameterException(CommandLine commandLine, String msg, Exception ex) {
4683 super(msg, ex);
4684 this.commandLine = Assert.notNull(commandLine, "commandLine");
4685 }
4686
4687
4688
4689
4690
4691 public CommandLine getCommandLine() { return commandLine; }
4692
4693 private static ParameterException create(CommandLine cmd, Exception ex, String arg, int i, String[] args) {
4694 String msg = ex.getClass().getSimpleName() + ": " + ex.getLocalizedMessage()
4695 + " while processing argument at or before arg[" + i + "] '" + arg + "' in " + Arrays.toString(args) + ": " + ex.toString();
4696 return new ParameterException(cmd, msg, ex);
4697 }
4698 }
4699
4700
4701
4702 public static class MissingParameterException extends ParameterException {
4703 private static final long serialVersionUID = 5075678535706338753L;
4704 public MissingParameterException(CommandLine commandLine, String msg) {
4705 super(commandLine, msg);
4706 }
4707
4708 private static MissingParameterException create(CommandLine cmd, Collection<Field> missing, String separator) {
4709 if (missing.size() == 1) {
4710 return new MissingParameterException(cmd, "Missing required option '"
4711 + describe(missing.iterator().next(), separator) + "'");
4712 }
4713 List<String> names = new ArrayList<String>(missing.size());
4714 for (Field field : missing) {
4715 names.add(describe(field, separator));
4716 }
4717 return new MissingParameterException(cmd, "Missing required options " + names.toString());
4718 }
4719 private static String describe(Field field, String separator) {
4720 String prefix = (field.isAnnotationPresent(Option.class))
4721 ? field.getAnnotation(Option.class).names()[0] + separator
4722 : "params[" + field.getAnnotation(Parameters.class).index() + "]" + separator;
4723 return prefix + Help.DefaultParamLabelRenderer.renderParameterName(field);
4724 }
4725 }
4726
4727
4728
4729
4730 public static class DuplicateOptionAnnotationsException extends InitializationException {
4731 private static final long serialVersionUID = -3355128012575075641L;
4732 public DuplicateOptionAnnotationsException(String msg) { super(msg); }
4733
4734 private static DuplicateOptionAnnotationsException create(String name, Field field1, Field field2) {
4735 return new DuplicateOptionAnnotationsException("Option name '" + name + "' is used by both " +
4736 field1.getDeclaringClass().getName() + "." + field1.getName() + " and " +
4737 field2.getDeclaringClass().getName() + "." + field2.getName());
4738 }
4739 }
4740
4741 public static class ParameterIndexGapException extends InitializationException {
4742 private static final long serialVersionUID = -1520981133257618319L;
4743 public ParameterIndexGapException(String msg) { super(msg); }
4744 }
4745
4746
4747 public static class UnmatchedArgumentException extends ParameterException {
4748 private static final long serialVersionUID = -8700426380701452440L;
4749 public UnmatchedArgumentException(CommandLine commandLine, String msg) { super(commandLine, msg); }
4750 public UnmatchedArgumentException(CommandLine commandLine, Stack<String> args) { this(commandLine, new ArrayList<String>(reverse(args))); }
4751 public UnmatchedArgumentException(CommandLine commandLine, List<String> args) { this(commandLine, "Unmatched argument" + (args.size() == 1 ? " " : "s ") + args); }
4752 }
4753
4754 public static class MaxValuesforFieldExceededException extends ParameterException {
4755 private static final long serialVersionUID = 6536145439570100641L;
4756 public MaxValuesforFieldExceededException(CommandLine commandLine, String msg) { super(commandLine, msg); }
4757 }
4758
4759 public static class OverwrittenOptionException extends ParameterException {
4760 private static final long serialVersionUID = 1338029208271055776L;
4761 public OverwrittenOptionException(CommandLine commandLine, String msg) { super(commandLine, msg); }
4762 }
4763
4764
4765
4766
4767 public static class MissingTypeConverterException extends ParameterException {
4768 private static final long serialVersionUID = -6050931703233083760L;
4769 public MissingTypeConverterException(CommandLine commandLine, String msg) { super(commandLine, msg); }
4770 }
4771 }