cmdline 一个命令行解析库 java 实现

yjh777

初学 java 写个命令行解析库练练手，

see: https://github.com/tcler/cmdline-java/

特色: inspired by https://github.com/tcler/getopt.tcl
  - 支持 --long 写成 -long
  - 支持选项参数列表类型
  - 自动生成 Usage 信息，并保证输出顺序跟选项生命列表一致
  - 支持多个选项名(不只是一个 short 一个 long)  # 这个需求很小众，用来兼容相同功能但使用不同option name的程序
  - 提供 forward 类型的选项 # 用来传递选项给 sub command
  - 提供 hide 属性，不在 Usage 中出现 # 用来向用户隐藏某些选项


demo:

1. import java.util.Arrays;
   
2. import java.util.ArrayList;
   
3. import com.github.tcler.cmdline.*;
   
4. 
   
5. class CmdlineTest {
   
6.         public static void main(String[] argv) {
   
7.                 if (argv.length < 1) {
   
8.                         System.out.println("argv is emplty, use test argv instead:");
   
9.                         argv = new String[]{ "-h", "-H", "-f", "file", "--file", "file2", "-e", "s/abc/xyz/", "-r", "-n", "-s=A", "-oa=b", "-S", "", "-i", "-x", "xfile", "--wenj=file3", "--www", "-aa", "-vvv", "-S", "DD", "--", "-0", "-y" };
   
10.                 }
    
11.                 System.out.printf("argv: %s\n", Arrays.toString(argv));
    
12.                 System.out.printf("----------------------------------------------------------------\n\n");
    
13.                 ArrayList<Option> optionList = new ArrayList<Option>();
    
14.                 optionList.add(new Option("Options group1:"));
    
15.                 optionList.add(new Option("help h H 帮助", Option.ArgType.N, "print this help"));
    
16.                 optionList.add(new Option("file f", Option.ArgType.M, "specify file"));
    
17.                 optionList.add(new Option("conf c", Option.ArgType.Y, "config file"));
    
18.                 optionList.add(new Option("o", Option.ArgType.O, "mount option", ""));
    
19.                 optionList.add(new Option("v", Option.ArgType.N, "verbose output, -vvv means verbose level 3"));
    
20.                 optionList.add(new Option("x", Option.ArgType.Y, "dump binary file to text"));
    
21.                 optionList.add(new Option("s", Option.ArgType.Y, "enable smart mode"));
    
22.                 optionList.add(new Option("S", Option.ArgType.Y, "", "s", true));
    
23. 
    
24.                 optionList.add(new Option("\nOptions group2:"));
    
25.                 optionList.add(new Option("e", Option.ArgType.M, "sed -e option, will forward to child sed process", true));
    
26.                 optionList.add(new Option("r", Option.ArgType.N, "sed -r option, will forward to child sed process", true));
    
27.                 optionList.add(new Option("n", Option.ArgType.N, "sed -n option, will forward to child sed process", true));
    
28. 
    
29.                 Cmdline cl = new Cmdline(optionList, argv);
    
30. 
    
31.                 if (cl.hasOption("help")) {
    
32.                         cl.getUsage(optionList);
    
33.                 }
    
34.                 if (cl.hasOption("file")) {
    
35.                         System.out.println("opt(file): " + cl.getOptionArgList("file").toString());
    
36.                 }
    
37.                 if (cl.hasOption("conf")) {
    
38.                         System.out.println("opt(conf): " + cl.getOptionArgString("conf"));
    
39.                 }
    
40.                 if (cl.hasOption("o")) {
    
41.                         System.out.println("opt(o): " + cl.getOptionArgString("o"));
    
42.                 }
    
43. 
    
44.                 if (cl.hasOption("v")) {
    
45.                         int verboselevel = cl.getOptionNumber("v");
    
46.                         System.out.println("opt(v): " + verboselevel);
    
47.                 }
    
48.                 if (cl.hasOption("s")) {
    
49.                         System.out.println("opt(s): " + cl.getOptionArgString("s"));
    
50.                 }
    
51. 
    
52.                 System.out.println("invalidOptions: " + cl.getInvalidOptions().toString());
    
53.                 System.out.println("forwardOptions: " + cl.getForwardOptions().toString());
    
54.                 System.out.println("args: " + cl.getArgs().toString());
    
55.         }
    
56. }

复制代码

yjh777

1. $ java -jar cmdline.jar
   
2. argv is emplty, use test argv instead:
   
3. argv: [-h, -H, -f, file, --file, file2, -e, s/abc/xyz/, -r, -n, -s=A, -oa=b, -S, , -i, -x, xfile, --wenj=file3, --www, -aa, -vvv, -S, DD, --, -0, -y]
   
4. ----------------------------------------------------------------
   
5. 
   
6. Options group1:
   
7.      -h -H --help --帮助         print this help
   
8.      -f --file {arg}           specify file
   
9.      -c --conf <arg>           config file
   
10.      -o [arg]                  mount option
    
11.      -v                        verbose output, -vvv means verbose level 3
    
12.      -x <arg>                  dump binary file to text
    
13.      -s <arg>                  enable smart mode
    
14. 
    
15. Options group2:
    
16.      -e {arg}                  sed -e option, will forward to child sed process
    
17.      -r                        sed -r option, will forward to child sed process
    
18.      -n                        sed -n option, will forward to child sed process
    
19. 
    
20. Comments:
    
21.     *  [arg] means arg is optional, need use --opt=arg to specify an argument
    
22.        <arg> means arg is required, and -f a -f b will get the latest 'b'
    
23.        {arg} means arg is required, and -f a -f b will get a list 'a b'
    
24. 
    
25.     *  if arg is required, '--opt arg' is same as '--opt=arg'
    
26. 
    
27.     *  '-opt' will be treated as:
    
28.            '--opt'    if 'opt' is defined;
    
29.            '-o -p -t' if 'opt' is undefined;
    
30.            '-o -p=t'  if 'opt' is undefined and '-p' need an argument;
    
31. 
    
32. opt(file): [file, file2]
    
33. opt(o): a=b
    
34. opt(v): 3
    
35. opt(s): DD
    
36. invalidOptions: [option: 'i' undefined, option: 'wenj=file3' undefined, option: 'www' undefined, option: 'a' undefined, option: 'a' undefined]
    
37. forwardOptions: [-e s/abc/xyz/, -r, -n]
    
38. args: [-0, -y]
    
39. 
    

复制代码