Sam Bromley$Revision: 1.7 ${Command line parsing} {C implementation}

The Tk C library provides developers with a Tk_ParseArgv() function that allows command line parsing of options of the "-option" form. Archived discussions on and on the Wiki indicate that a desire for similar functionality without Tk has arisen several times in the past. This TIP presents a Tk-free implementation of Tk_ParseArgv() named Tcl_ParseArgvObj, that developers can use to parse "-option" style command options in C implementations of Tcl commands using the Tcl_Obj interface.

While the parsing of command options can be readily accomplished on the Tcl side, a uniform method for parsing "-option" formed options does not exist on the C side. Many developers are familiar with the ease of use of libpopt-style command line parsing, but a similarly clean method does not currently exist in Tcl. The common approach is to use Tcl_GetIndexFromObj(), yet this method alone does not allow the flexibilty and ease of use of libpopt-style parsing. One drawback of the classical Tcl_GetIndexFromObj()-only approach is the need to handle the specifies of your command option parsing for each unique command. This leads to significant code duplication. A libpopt-style approach is to bundle all of your parsing specifics into a single array of structures capturing the details, and then let a specific parsing routine handle the parsing of every option for you. The Tcl_ParseArgvObj() routine introduced in this TIP provides this functionality, thereby allowing the removal of all parsing specifics from the command implimentation other than that necessary to describe each optional argument. Additionally, a function Tcl_ParseArgsObjv is provided to provide the functionality of Tk_ParseArgs() to those who desire it. A discussion in 2002 on [] indicated that this is a desired feature. Arguments against a Tcl_ParseArgsObjv implementation include that it is better to do all command line parsing on the Tcl side. However, this implies writing two wrapper functions: (i) A C implementation of a Tcl command; and (ii) A Tcl wrapper that pre-parses the options before calling the C command. This can lead to significant duplication of effort when porting a large project to a Tcl enabled version. This point is particularly relevent in the context of Tcl_ParseArgvObj(), as then one is not assuming that one can simply replace the main() routine with Tcl, but rather that one is truly embedding the C side in a larger system. Tcl_ParseArgvObj() offers a clean method to enable flexible command line parsing to C implementations of Tcl commands.

This document proposes adding Tcl_ParseArgsObjv, whose arguments shall be: int Tcl_ParseArgsObjv(Tcl_Interp *interp, const Tcl_ArgvInfo *argTable, int *objcPtr, Tcl_Obj *const *objv, Tcl_Obj ***remainingObjv) Note that the count of arguments (referred to by objcPtr) will be modified, and a modified array will be returned via remainingObjv (and need ckfreeing). The input array of objects will not be modified.

A working implementation has been submitted to the Feature Request Tracker at SourceForge [].

I2luY2x1ZGUgPHRjbC5oPg==I2luY2x1ZGUgPHRjbEFyZ3YuaD4gLyogbm90IG5lZWRlZCBpZiBzdWJzdW1lZCBpbnRvIGNvcmUgKi8=aW50IGdfdGVzdF9jbWQoQ2xpZW50RGF0YSBjbGllbnREYXRhLCBUY2xfSW50ZXJwICppbnRlcnAsICAgIGludCBvYmpjLCBUY2xfT2JqICpDT05TVCBvYmp2W10pew==ICBjaGFyICpnbmFtZSwqZmlsZW5hbWU7ICBpbnQgaTs=ICBpbnQgbnVtUmVwZWF0Ow==ICBkb3VibGUgc2NhbGFyOw==ICBpbnQgZG9FcmFzZSA9IDA7ICBzaXplX3Qgc2l6ZTs=ICAvKiB0aGlzIHRhYmxlIHNwZWNpZmllcyB0aGUgcG9zc2libGUgb3B0aW9ucywgYWxsIGluIG9uZSBwbGFjZS4qLw==ICBUY2xfQXJndkluZm8gYXJnVGFibGVbXSA9IHs=ICAgIHsiLWVyYXNlIiwgVENMX0FSR1ZfQ09OU1RBTlQsICh2b2lkICopIDEsICZkb0VyYXNlLA==ICAgICAgImVyYXNlIGltYWdlIGJlZm9yZSBwbG90dGluZyJ9LA==ICAgIHsiLW51bVJlcGVhdCIsIFRDTF9BUkdWX0lOVCwgTlVMTCwgJm51bVJlcGVhdCw=ICAgICAgIm51bWJlciBvZiB0aW1lcyB0byByZXBlYXQgdGVzdCJ9LA==ICAgIHsiLXNjYWxhciIsIFRDTF9BUkdWX0ZMT0FULCBOVUxMLCAmc2NhbGFyLA==ICAgICAgInNjYWxhciBtdWx0aXBsZSB0byB1c2UgZm9yIHRlc3QifSw=ICAgIHsiLW91dGZpbGUiLCBUQ0xfQVJHVl9TVFJJTkcsIE5VTEwsICZmaWxlbmFtZSw=ICAgICAgIm5hbWUgb2YgZmlsZSB0byB3aGljaCB0byBkdW1wIHJlc3VsdCJ9LA==ICAgIHtOVUxMLCBUQ0xfQVJHVl9FTkQsIE5VTEwsIE5VTEwsIE5VTEx9ICB9Ow==ICAvKiBDYWxsIFRjbF9QYXJzZUFyZ09ianYgdG8gZG8gYWxsIHRoZSBwYXJzaW5nISAqLw==ICBpZiAoVGNsX1BhcnNlQXJnc09ianYoaW50ZXJwLGFyZ1RhYmxlLCZvYmpjLG9ianYsJnByaXZhdGVfb2JqdikgIT0gVENMX09LKSB7ICAgICByZXR1cm4gVENMX0VSUk9SOw==ICB9ICAvKiBTaG91bGQgcmVjaGVjayBvYmpjIGhlcmUgKi8=ICAvKiBhdCB0aGlzIHBvaW50LCBhbnkgdW5oYW5kbGVkIG9wdGlvbnMgYXJlIHJlcGFja2VkIGluIHByaXZhdGVfb2JqdiAqLw==ICBnbmFtZSA9IFRjbF9HZXRTdHJpbmcocHJpdmF0ZV9vYmpbMV0pOw==ICAvKiBhbGwgZG9uZSAqLw==ICBja2ZyZWUocHJpdmF0ZV9vYmp2KTs=ICAvKiByZXN0IG9mIGNvZGUgY29udGludWVzIGhlcmUuLi4qLw==ICByZXR1cm4gVENMX09LOw==fQ==

This document has been placed in the public domain.