[mapleall][utils] Add commandline library in utils · Pull Request !1064 · 方舟编译器/OpenArkCompiler

This library makes it easy to work with command line options.
This library allows to create and register the options with
one line of code:
    
cl::Option<bool> opt1({"--key"}, "Description"); // bool option
cl::Option<std::string> opt2({"--key2"}, ""); // string option
cl::Option<int32_t> opt3({"--key3"}, ""); // int option
    
All options are parsed with:
cl::CommandLine::GetCommandLine()->Parse(argc, (char **)argv);
    
Then you can use these options like this:
if (opt1 == true) {
   //your code
}
std::string data = opt2;
int32_t dig = opt3;
    
Also it supports the following features:
* Joined Options: cl::kValueJoined allows to register joined options,
  like -DMACRO. Example:
  cl::Option<std::string> macro({"-D"}, "", cl::kValueJoined);
    
* Options with required and optional value:
  cl::kValueRequired/kValueOptional/kValueDisallowed allows to
  configure whether the option can be used without a value (--key),
  or value is required (--key value). Example:
    
  cl::Option<int32_t> reqVal({"--reqval"}, "", cl::kValueRequired);
  cl::Option<int32_t> optVal({"--optval"}, "", cl::kValueOptional);
  cl::Option<int32_t> woVal({"--woval"}, "", cl::kValueDisallowed);
   
* Default Value: cl::Init allows to set default option value. If you
  do not set the option with command line, this option will use
  this default value. Example:
  cl::Option<std::string> defaultString({"--defstring"}, "", cl::Init("Default String"));
    
* cl::DisableWith: The library allows to add special name for the options to turn off them.
  Example:
  cl::Option<bool> enable({"--enable"}, "", cl::Init(true), cl::DisableWith("--no-enable"));
    
* These features can be set in any order. Example:
  cl::Option<int32_t> reqVal1({"--reqval1"}, "", cl::kValueRequired, cl::Init(-42));
  cl::Option<int32_t> reqVal2({"--reqval2"}, "", cl::Init(-42), cl::kValueRequired);
  In this example, the order of kValueRequired and cl::Init is different, but the library
  can handle both cases.

* Categories: To register different options for the different tools
  (driver, hir2mpl, cg, etc...), the categories are implemented.
  This allows to register the options for different categories. Some
  options can be available in one category, but not be available in
  another. Example:
  cl::OptionCategory testCategory1;
  cl::OptionCategory testCategory2;
  cl::Option<bool> cat1Opt1({"--c1opt1"}, "", {&testCategory1});
  cl::Option<bool> cat12Opt({"--c12opt"}, "", {&testCategory1, &testCategory2});

These features are tested with unit tests.
/mapleall/test folder contains UT tests.
It uses google test framework for the tests.
    
To build the test:
make mapleallUT
    
To Run the test:
mapleallUT
    
The Output should be:
Running main() from gmock_main.cc
[==========] Running 37 tests from 1 test suite.
[----------] Global test environment set-up.
[----------] 37 tests from clOptions
[ RUN      ] clOptions.boolOpt
[       OK ] clOptions.boolOpt (0 ms)
[ RUN      ] clOptions.comaparableOpt1
[       OK ] clOptions.comaparableOpt1 (0 ms)
[ RUN      ] clOptions.IncorrectVal
[       OK ] clOptions.IncorrectVal (0 ms)
[ RUN      ] clOptions.digitTestMaxVal
[       OK ] clOptions.digitTestMaxVal (0 ms)
[ RUN      ] clOptions.digitTestNegativeVal1
[       OK ] clOptions.digitTestNegativeVal1 (0 ms)
[ RUN      ] clOptions.digitTestNegativeVal2
[       OK ] clOptions.digitTestNegativeVal2 (0 ms)
[ RUN      ] clOptions.digitTestNegativeVal3
[       OK ] clOptions.digitTestNegativeVal3 (0 ms)
[ RUN      ] clOptions.digitIncorrectPrefix
[       OK ] clOptions.digitIncorrectPrefix (0 ms)
[ RUN      ] clOptions.digitIncorrectVal
[       OK ] clOptions.digitIncorrectVal (0 ms)
[ RUN      ] clOptions.digitTestOutOfRange1
[       OK ] clOptions.digitTestOutOfRange1 (0 ms)
[ RUN      ] clOptions.digitTestOutOfRange2
[       OK ] clOptions.digitTestOutOfRange2 (0 ms)
[ RUN      ] clOptions.digitTestOutOfRange3
[       OK ] clOptions.digitTestOutOfRange3 (0 ms)
[ RUN      ] clOptions.digitTestOutOfRange4
[       OK ] clOptions.digitTestOutOfRange4 (0 ms)
[ RUN      ] clOptions.doubleDef1
[       OK ] clOptions.doubleDef1 (0 ms)
[ RUN      ] clOptions.doubleDef2
[       OK ] clOptions.doubleDef2 (0 ms)
[ RUN      ] clOptions.defaultVal
[       OK ] clOptions.defaultVal (0 ms)
[ RUN      ] clOptions.disableOpt1
[       OK ] clOptions.disableOpt1 (0 ms)
[ RUN      ] clOptions.disableOpt2
[       OK ] clOptions.disableOpt2 (0 ms)
[ RUN      ] clOptions.joinedOpt
[       OK ] clOptions.joinedOpt (0 ms)
[ RUN      ] clOptions.equalOpt
[       OK ] clOptions.equalOpt (0 ms)
[ RUN      ] clOptions.equalOptErr
[       OK ] clOptions.equalOptErr (0 ms)
[ RUN      ] clOptions.joinedEqualOpt
[       OK ] clOptions.joinedEqualOpt (0 ms)
[ RUN      ] clOptions.expectedVal1
[       OK ] clOptions.expectedVal1 (0 ms)
[ RUN      ] clOptions.expectedVal2
[       OK ] clOptions.expectedVal2 (0 ms)
[ RUN      ] clOptions.expectedVal3
[       OK ] clOptions.expectedVal3 (0 ms)
[ RUN      ] clOptions.expectedVal4
[       OK ] clOptions.expectedVal4 (0 ms)
[ RUN      ] clOptions.expectedVal5
[       OK ] clOptions.expectedVal5 (0 ms)
[ RUN      ] clOptions.expectedVal6
[       OK ] clOptions.expectedVal6 (0 ms)
[ RUN      ] clOptions.expectedVal7
[       OK ] clOptions.expectedVal7 (0 ms)
[ RUN      ] clOptions.optCategory1
[       OK ] clOptions.optCategory1 (0 ms)
[ RUN      ] clOptions.optCategory2
[       OK ] clOptions.optCategory2 (0 ms)
[ RUN      ] clOptions.optCategory3
[       OK ] clOptions.optCategory3 (0 ms)
[ RUN      ] clOptions.ownOptionType1
[       OK ] clOptions.ownOptionType1 (0 ms)
[ RUN      ] clOptions.ownOptionType2
[       OK ] clOptions.ownOptionType2 (0 ms)
[ RUN      ] clOptions.ownOptionType3
[       OK ] clOptions.ownOptionType3 (0 ms)
[ RUN      ] clOptions.duplicatedOptions
[       OK ] clOptions.duplicatedOptions (118 ms)
[ RUN      ] clOptions.description
[       OK ] clOptions.description (0 ms)
[----------] 37 tests from clOptions (119 ms total)

[----------] Global test environment tear-down
[==========] 37 tests from 1 test suite ran. (119 ms total)
[  PASSED  ] 37 tests.

GVP方舟编译器/OpenArkCompiler

搜索帮助

GVP 方舟编译器/OpenArkCompiler