CLI.au3 easy using of command line parameter

[Xenobiologist]

Hi,

next week my holiday starts ... and I'd like to create an nice UDF

I would like to create a cli.au3 in Autoit --> for Autoit.

What it is supposed to do?

In Perl or Java there a funcs that deal with the arguments passed by commandline parameters to your code.

Like myExe.exe -i inputFilePath -o outputFilePath -t -s

Till now, it is up to you coding something like this:

If $CmdLine[0] > 0 Then
    Select $CmdLine[1]
        Case $CmdLine[1] == "Hello"
            out("hello")
        Case $CmdLine[1] == "Test"
            ConsoleWrite("Test" & @CRLF)
        Case Else
            out("unknown Parameter!")
    EndSelect
Else
    MsgBox(0, "Info", "No parameter --> exit", 4)
    Exit (0)
EndIf

Func out($txt)
    MsgBox(0, "Info", $txt)
EndFunc   ;==>out

I would like to create some func to make things easier to use, but I need some suggestions before I start.

What funcs are needed?

I thought it would be nice to have something like this:

Func _setVersion($s_version = '-version', $icon = 64, $s_Title = @ScriptName, $s_Message = 'Version : ', $i_timeout = 10)

If one of the parameters is -version then show this MsgBox ...

Func _setHelpMsg($s_help = '-?', $icon = 64, $s_Title = @ScriptName, $s_Message = '', $i_timeout = 10)

If one of the parameters is -help or -? then show this MsgBox ...

Func _setParameter($mandatoryParameter_A, $optionalParameter_A = '')

You can set parameters that have to be passed by otherwise the usage (Msgbox from setHelpMsg) will be shown and script exits.

The func returns an 2D array with parameter[0] and parameterValue[1] e.g:

[0][0] = count of parameters

[1][0] = i

[1][1] = inputFilePath

...

Or a func like getCLIValue('-i') return is inputFilePath and so on.

Addional debug func two parameters (debug and level)

If one of the parameter is -debug then a global variable called $b_Debug = 0 is set to True

and -debuglevel sets the level (like 0=info=much logging, 1=warn=log only warnings, 2=fatal=log only errors)

Questions:

What should happen to parameters passed twice?

What should happen to unexpected parameters?

Should there be an option to set sign to determine parameters like (-,/,--)?

Should there be an sort option?

Thanks for you suggestions.

Questions over all, do you think this can come in handy / be useful?

So long,

Mega

[Valik]

Please don't use font colors. Just because something is visible with the theme you happen to be using doesn't mean it's visible with themes others happen to be using.

I would have a look at *nix's getopts library, or whatever it's called. I know there's a library for *nix, at any rate, which tries to make command line arguments easier to implement. That seems like it'd be a good place for ideas.

[Xenobiologist]

Please don't use font colors. Just because something is visible with the theme you happen to be using doesn't mean it's visible with themes others happen to be using.

I would have a look at *nix's getopts library, or whatever it's called. I know there's a library for *nix, at any rate, which tries to make command line arguments easier to implement. That seems like it'd be a good place for ideas.

Hi,

thx for reply. Okay, I'll try to avoid font colors.

I know Getopts and I already had a short look at cpan or here : http://world.std.com/~swmcd/steven/perl/pm/getopt.html

Do you think this can be useful? Then I'll try my best.

So long,

Mega

[Valik]

If you're keen on reading a bunch of Lua, have a look at AceOptionsTable. It uses a Lua table to describe how an option works. Then, this table is used to build menus, GUIs or just plain command line arguments (for World of Warcraft Addons). You might find some good ideas in there.

[DaleHohm]

Anything you do here will be appreciated. Supporting Valik's comments -- if there is a defacto standard, it would be best to go that direction.

Dale

[Xenobiologist]

Hi,

thx. I'll read a bit of that stuff and post a little starting script soon.

Never thought of implementing something big like GetOps with X different ways. I just wanted to create some little funcs to avoid those select case things and so on - to write for everybody who uses commandline parameters in thier scripts.

I'll find an answer to my questions mentioned above and I'll react on that cases. we'll see if you can live with that.

So long,

Mega

[eltorro]

While not as feature rich as it could be, here's a link to a getopt port I used for my base32 script.

[James]

This sounds interesting. So it will support multiple arguments?

[Richard Robertson]

I think that's a given, James.

[eltorro]

This sounds interesting. So it will support multiple arguments?

Yes. The base32 script is simple enough to act as an example. Usage is fairly easy.

[James]

Awesome! I can't wait for this, Disk Manager will be console supported!

[James]

Any updates, progress on this?

I'm getting into CUI!

[Xenobiologist]

Hi,

the question is how far you would like to go?

I thought of just implementing the basics as mentioned above.

Maybe an udf for this could lead to kind of standardization for Autoit scripts like -? and /? = show help dialog for commandline parameters. -version and /version show version dialog of script and used Autoit version and -debug (1,2,3..) sets the debuglevel.

and funcs to easily get the parameters in script like _getParameter(i) and so on.

Mega

[Richard Robertson]

My Process Watcher made use of arbitrarily ordered parameters, if anyone is interested in tearing it apart for an example. I just remembered that.

[Xenobiologist]

My Process Watcher made use of arbitrarily ordered parameters, if anyone is interested in tearing it apart for an example. I just remembered that.

Hi,

give it a go and show what you did. Anybody interested in an udf for that?

Mega

[daddydave]

While not as feature rich as it could be, here's a link to a getopt port I used for my base32 script.

(I know this is an old thread, but for the benefit of those searching the forums..)

eltorro, I finally followed your signature to "some of your scripts on Google code" and was delighted to see you have a newer version called OptParse which allows non-option arguments as well.

[AJStevens]

Appologies as this is an old thread, but I'm trying to find a nice UDF to quickly and easily add command line options to autoit scripts.

As daddydave said above, eltorro's OptParse does indeed seem to be what I'm after, but have hit a problem or two.

"Duplicate Arguments" don't seem to cause an error as they should, seems to be just ignored.

If you use the --switch format, it first cuts it down to -switch which is fine until it errors and says that -switch is not a valid switch, but actually what they used was --switch possibly this is nit picking, but thought it worth mentioning.

I don't see an option for a hidden switch, one that doesn't show up in the usage listing but does work, possible reasons for this are new/beta switches/functions not yet fully supported, or more advanced options only listed in advanced user documentation.

Having "short" and "long" will most likely do in 90% of cases, but it would be nice if one line could represent what to do if any of the following are used: /? /h /help /usage (just as an example of multiple possible identical switches).

Have PM eltorro, and looking through the UDF to work it out, but just wondered if anyone else was or has done this?

[ProgAndy]

I created an UDF to parse a commandline into a 2D-Array, but I did not create any other functions for the params. You could use the _Array-functions, though.

http://www.autoitscript.com/forum/index.php?showtopic=110189&view=findpost&p=774455

[AJStevens]

I created an UDF to parse a commandline into a 2D-Array, but I did not create any other functions for the params. You could use the _Array-functions, though.

http://www.autoitscript.com/forum/index.php?showtopic=110189&view=findpost&p=774455

Was really hoping not to have to re-invent this and write it all I've got enough problems with StringSplit and Multidimensional arrays...

[eltorro]

Had this for a long while.

http://my-autoit.googlecode.com/svn/trunk/doc/optparse.html

code is here:

http://code.google.com/p/my-autoit/source/browse/#svn/trunk/Scripts/_OptParse

Edited August 9, 2010 by eltorro