ParamContainer is a simple and easy to use C++ class to parse command line parameters. Parameters format is derived from UNIX
getopt_long() function syntax but may contain nested parameters as well. It was developed to fit the requirements of our projects, but we'll be glad if it will be useful for somebody else. Main features of
- Easy to use.
- Structure of command line conforms object hierarchy.
- Adding/changing parameters is really easy. You don't need to modify class interfaces and anything outside of the class which new parameter corresponds to.
- Parameters can be saved to the project file and loaded later.
- When command line contains additional file names, their paths will be converted to relative in project file, so you can freely move project with all required files to a different location.
ParamContainer can be used as internal interface between presentation (GUI) and logic parts of the project. You can use the same logic part in graphics/command-line versions of your project.
- Dynamically generated help screen.
- Powerful error handling.
- Portability between Win32 and Unix systems (on Win32 systems, there must be
WIN32 preprocessor definition).
Using the code
Here is a simple way to use
ParamContainer in your project:
- Add ParamContainer.cpp and ParamContainer.h into your project.
- Include ParamContainer.h in your main CPP file:
ParamContainer object in your
- Add some parameters using
p.addParam("long-name", 'n', ParamContainer::regular,
"parameter description", "default_value");
- Obtain parameter values via
cout << p["long-name"];
- Compile and run your program, specifying your argument:
programname -n value
programname -n "value"
25.08.2004 - First version is available.