Try to improve CLI parsing #8

cosmo-ray · 2016-12-30T17:39:00Z

Try to fix this:
https://wiki.xoreos.org/index.php?title=TODO#Command_line_parsing_in_the_tools
I've try to keep backward compatibility, so the usage should be just the same as before, I was unable to test every options of every program, but the one I've try was working, I hope I've break nothing.

DrMcCoy · 2016-12-30T17:51:26Z

Neat, thanks! :)

I probably won't have time to look at it in detail before January 1st, though.

One minor thing I can see immediately: the commit message should begin with an uppercase letter after the module tag. I.e. "COMMON: Add a new CLI class" instead of "COMMON: add a new CLI class".

cosmo-ray · 2017-01-03T12:27:37Z

commit messages are now fix

cosmo-ray · 2017-02-23T12:48:21Z

ping

DrMcCoy

I'm really sorry, but didn't find any time for this earlier.

In principle, I like your implementation, good work! :)

There are a lot of style-issues, though, most prominently a lot of trailing whitespace (in more than just the places I marked). And the Callbacks leak. It's nothing major, but if you could fix those, that would be great.

I'm also not too sure I like the --help text output that much. In the manual ones, I introduced some groupings via newlines and I also hand-wrapped a few strings that overflowed 80 characters. If you know of a neat way to do that for your automatic text as well, I'd appreciate it.

DrMcCoy · 2017-02-24T17:59:19Z

src/common/cli.cpp

+	helpStr += "  ";
+	helpStr += optionArgs;
+	for (int i = (maxArgLength - strlen(longName) - strlen(optionArgs) - 4); i > 0; --i) {
+		helpStr += " ";		


Trailing whitespace

DrMcCoy · 2017-02-24T18:01:23Z

src/common/cli.cpp

+		_val.insert(args[j]);
+	return j - i;
+}
+


Trailing whitespace

DrMcCoy · 2017-02-24T18:01:54Z

src/common/cli.cpp

+	}
+}
+
+void Parser::addOption(const char *longName, char shortName, const char *help, OptionRet ret, 


Trailing whitespace

DrMcCoy · 2017-02-24T18:02:26Z

src/common/cli.cpp

+fail:
+	_returnVal = 1;
+	this->printUsage(_helpStr);
+	return false;	


Trailing whitespace

DrMcCoy · 2017-02-24T18:02:49Z

src/common/cli.h

+									    _print(aPrinter),
+									    _printerStr(str) {}
+
+


Trailing whitespace

DrMcCoy · 2017-02-24T18:30:33Z

src/tlk2xml.cpp

+	NoOption inFileOpt(false, new ValGetter<Common::UString &>(inFile, "input files"));
+	NoOption outFileOpt(true, new ValGetter<Common::UString &>(outFile, "output files"));
+	Parser parser(argv[0], "BioWare TLK to XML converter",
+		      "If no output file is given, the output is written to stdout.\n\n"


Add a \n at the start of that string too, please, and for the explanatory texts in other tools too.

DrMcCoy · 2017-02-24T22:04:13Z

src/convert2da.cpp

-	std::fprintf(stream, "column layout. They will be pasted together and printed as one GDA.\n\n");
-	std::fprintf(stream, "If no output file is given, the output is written to stdout.\n");
-}
+// std::fprintf(stream, "  -o <file> --output <file>     Write the output to this file\n");


Any reason you kept this?

DrMcCoy · 2017-02-24T22:06:39Z

src/fixpremiumgff.cpp

+		      "If no ID is given is given, it is guessed from the file name.",
+		      returnValue, makeEndArgs(&inFileOpt, &outFileOpt));
+
+


Trailing whitespace

DrMcCoy · 2017-02-24T22:25:24Z

src/gff2xml.cpp

+	parser.addOption("dragonage2", "Use Dragon Age II encodings", kContinueParsing,
+			 makeAssigners(new ValAssigner<GameID>(Aurora::kGameIDDragonAge2, game)));
+	parser.addOption("encoding", "Override an encoding", kContinueParsing,
+			 new Callback<EncodingOverrides &>("str", parseEncodingOverride, encOverrides));


valgrind says that this line leaks, the new Callback

DrMcCoy · 2017-02-24T22:28:29Z

src/unerf.cpp

+			 makeAssigners(new ValAssigner<GameID>(Aurora::kGameIDJade, game)));
+	parser.addOption("pass", "Decryption password, if required, in hex notation",
+			 kContinueParsing,
+			 new Callback<std::vector<byte> &>("hex", parsePassword, password));


Here too the Callback (and in the lines below) leak

The goal of this new class is to simplifie the arguments parsing, I've take inspiration from glib Commandline option parser: https://developer.gnome.org/glib/stable/glib-Commandline-option-parser.html, exept that with glib you need to specifie with a flag the type of each options, here options type are automatically determine when adding an option with parser.addOption. Basically most of the job is made in the parser contructor, here you can set the name of the program, summary, and arguments that are not options. Option like "--nwm" are set with addOption function. "--help" is automatically generated with arguments you've use in addOption and in the contructor, "--version" is generated too, and call Version::printVersion.

In this file, "Usage: xml2ssf [<options>] [<input file>] <output file>" change to "Usage: ./bin/xml2ssf [<options>] <[input file] <output file>>". I had to use an array of stings to get input file and output file, this is because input file is the optinal argument and is before ouput file, I would be harder to handle this case automatically in cli.h, as I would need to check if there is non optinal argument after the optinal one. I could do that, but as this file is the only one that need that, I don't think it worth the effort so I just get all arguments in a vector, and let some bytes of the old parser do what's left of the job

Signed-off-by: Matthias Gatto <uso.cosmo.ray@gmail.com>

cosmo-ray · 2017-04-13T16:30:44Z

thanks for the review and sorry for the time I take to answer.
I've try to fix all issues, I add a Parse::addSpace() method to handle groupings via newlines,
I didn't add "\n" in any explanatory texts, but I've made Parser::process automatically prepend a "\n" to the explanatory text if the string isn't empty.

DrMcCoy · 2017-04-13T18:49:07Z

Very nice, thank you! :)

I merged it with this push: f0dc347...1b6d66a.

…reos/xoreos-tools#8 )

cosmo-ray force-pushed the cli branch from 306416d to f1b8470 Compare January 1, 2017 16:25

DrMcCoy requested changes Feb 24, 2017

View reviewed changes

cosmo-ray force-pushed the cli branch 2 times, most recently from e543567 to bb16123 Compare March 4, 2017 20:09

cosmo-ray force-pushed the cli branch from bb16123 to 5c99cd9 Compare March 30, 2017 11:25

Matthias Gatto and others added 20 commits April 12, 2017 18:03

TLK2XML: Use CLI class

362d83d

GFF2XML: Use CLI class

ed5e7b1

CBGT2TGA: Use CLI class

2f72d72

CDPTH2TGA: Use CLI class

a3d3740

CONVERT2DA: Use CLI class

df17c5e

DESMALL: Use CLI class

24e55e6

FIXPREMIUMGFF: Use CLI class

8393bb3

NBFS2TGA: Use CLI class

3bfea1f

NCGR2TGA: Use CLI class

0ba50ba

SSF2XML: Use CLI class

56c1aff

NCSDIS: Use CLI class

d3b7e72

UNRIM: Use CLI class

177f738

UNHERF: Use CLI class

9fb72b5

UNERF: Use CLI class

3c2a2b5

UNKEYBIF: Use CLI class

888f8aa

UNNDS: Use CLI class

f33bffa

UNNSBTX: Use CLI class

423d1c3

XOREOSTEX2TGA: Use CLI class

effc78e

cosmo-ray force-pushed the cli branch from 5c99cd9 to effc78e Compare April 12, 2017 16:19

XML2TLK: Use CLI class

ef12281

Signed-off-by: Matthias Gatto <uso.cosmo.ray@gmail.com>

DrMcCoy approved these changes Apr 13, 2017

View reviewed changes

DrMcCoy closed this Apr 13, 2017

DrMcCoy pushed a commit to xoreos/xoreos-wiki that referenced this pull request Jun 6, 2018

/* Command line parsing in the tools */ Implemented by cosmo-ray ( xo…

a7f364f

…reos/xoreos-tools#8 )

Try to improve CLI parsing #8

Try to improve CLI parsing #8

cosmo-ray commented Dec 30, 2016

DrMcCoy commented Dec 30, 2016 •

edited

cosmo-ray commented Jan 3, 2017 •

edited

cosmo-ray commented Feb 23, 2017

DrMcCoy left a comment

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

DrMcCoy Feb 24, 2017

cosmo-ray commented Apr 13, 2017

DrMcCoy commented Apr 13, 2017

		"If no ID is given is given, it is guessed from the file name.",
		returnValue, makeEndArgs(&inFileOpt, &outFileOpt));

Try to improve CLI parsing #8

Try to improve CLI parsing #8

Conversation

cosmo-ray commented Dec 30, 2016

DrMcCoy commented Dec 30, 2016 • edited

cosmo-ray commented Jan 3, 2017 • edited

cosmo-ray commented Feb 23, 2017

DrMcCoy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cosmo-ray commented Apr 13, 2017

DrMcCoy commented Apr 13, 2017

DrMcCoy commented Dec 30, 2016 •

edited

cosmo-ray commented Jan 3, 2017 •

edited