CmdLine UDF (get value/existence/flag)

[Jefrey]

I wrote this very simple functions to parse command line arguments.

It can get:

Simple key/value

Example. The following code:

#include "cmdline.au3"

MsgBox(0, _CmdLine_Get('color'))

Will return "white" if you run the script in one of these ways (quotes are optional but mandatory if you're going to use spaces):

• script.exe -color "white"
• script.exe --color white
• script.exe /color white

Existence

Example. The following code:

#include "cmdline.au3"

If _CmdLine_KeyExists('givemecoffee') Then
   ConsoleWrite('You want coffee.')
Else
   ConsoleWrite('You do not want coffee.')
EndIf

Will return "You want coffee." if you run one of these:

• script.exe -givemecoffee
• script.exe --givemecoffee
• script.exe /givemecoffee

And the following code:

#include "cmdline.au3"

If _CmdLine_ValueExists('givemecoffee') Then
   ConsoleWrite('You want coffee.')
Else
   ConsoleWrite('You do not want coffee.')
EndIf

Will return "You want coffee." if you run one of these:

• script.exe givemecoffee
• script.exe "givemecoffee"

Flags

Example. This script:

#include "cmdline.au3"

ConsoleWrite("You want: ")

If _CmdLine_FlagEnabled('C') Then
  ConsoleWrite("coffee ")
EndIf

If _CmdLine_FlagEnabled('B') Then
   ConsoleWrite("beer ")
EndIf

ConsoleWrite(" and you do not want: ")

If _CmdLine_FlagDisabled('V') Then
  ConsoleWrite("vodka ")
EndIf

If _CmdLine_FlagDisabled('W') Then
   ConsoleWrite("wine ")
EndIf

ConsoleWrite(" but you did not tell me if you want: ")

If Not _CmdLine_FlagExists('S') Then
   ConsoleWrite("soda ")
EndIf

If Not _CmdLine_FlagExists('J') Then
   ConsoleWrite("juice ")
EndIf

Will return "You want: coffee beer  and you do not want: vodka wine  but you did not tell me if you want: soda juice" if you run:

• script.exe +CB -VW

Getting argument by its index

You can also read the $CmdLine (1-based index) through this function. The advantage is that if the index does not exist (the user did not specify the argument), it won't break your script. It will just return the value you specify in the second function parameter.

#include "cmdline.au3"

$first_argument = _CmdLine_GetValByIndex(1, False)

If Not $first_argument Then
   ConsoleWrite("You did not specify any argument.")
Else
   ConsoleWrite("First argument is: " & $first_argument)
EndIf

Just a note: The second value of _CmdLine_GetValByIndex function can be an integer value, a string, a boolean value, an array or anything you want it to return if the index does not exist in $CmdLine array.

This parameter is also available in _CmdLine_Get() function, also as a second function parameter. In this case, it will return this value if the key was not found. Example:

#include "cmdline.au3"

$user_wants = _CmdLine_Get("iwant", "nothing")

ConsoleWrite("You want " & $user_wants)

So, if you run:

• script.exe /iwant water

It will return "You want water". But if you run just:

• script.exe

It will return "You want nothing". Please note that, as these two are the only functions in this library meant to return strings, the second parameter is not available for the other functions. By default, if you do not specify any fallback value, it returns null if the wanted value could not be found.

Also, please note that this UDF can NOT parse arguments in the format (key=value). Example:

• script.exe key=value IT WILL NOT WORK

 

Here is the code:

expandcollapse popup

#include-once

#comments-start
   CmdLine small UDF
   coder: Jefrey (jefrey[at]jefrey.ml)
#comments-end

Func _CmdLine_Get($sKey, $mDefault = Null)
   For $i = 1 To $CmdLine[0]
      If $CmdLine[$i] = "/" & $sKey OR $CmdLine[$i] = "-" & $sKey OR $CmdLine[$i] = "--" & $sKey Then
         If $CmdLine[0] >= $i+1 Then
            Return $CmdLine[$i+1]
         EndIf
      EndIf
   Next
   Return $mDefault
EndFunc

Func _CmdLine_KeyExists($sKey)
   For $i = 1 To $CmdLine[0]
      If $CmdLine[$i] = "/" & $sKey OR $CmdLine[$i] = "-" & $sKey OR $CmdLine[$i] = "--" & $sKey Then
         Return True
      EndIf
   Next
   Return False
EndFunc

Func _CmdLine_ValueExists($sValue)
   For $i = 1 To $CmdLine[0]
      If $CmdLine[$i] = $sValue Then
         Return True
      EndIf
   Next
   Return False
EndFunc

Func _CmdLine_FlagEnabled($sKey)
   For $i = 1 To $CmdLine[0]
      If StringRegExp($CmdLine[$i], "\+([a-zA-Z]*)" & $sKey & "([a-zA-Z]*)") Then
         Return True
      EndIf
   Next
   Return False
EndFunc

Func _CmdLine_FlagDisabled($sKey)
   For $i = 1 To $CmdLine[0]
      If StringRegExp($CmdLine[$i], "\-([a-zA-Z]*)" & $sKey & "([a-zA-Z]*)") Then
         Return True
      EndIf
   Next
   Return False
EndFunc

Func _CmdLine_FlagExists($sKey)
   For $i = 1 To $CmdLine[0]
      If StringRegExp($CmdLine[$i], "(\+|\-)([a-zA-Z]*)" & $sKey & "([a-zA-Z]*)") Then
         Return True
      EndIf
   Next
   Return False
EndFunc

Func _CmdLine_GetValByIndex($iIndex, $mDefault = Null)
   If $CmdLine[0] >= $iIndex Then
      Return $CmdLine[$iIndex]
   Else
      Return $mDefault
   EndIf
EndFunc

Edited April 18, 2015 by Jefrey

[mLipok]

Thanks for sharing
Very useful UDF.

mLipok

 

btw:
added here , and please fix your signature.

 

Edit:

Can you make a zip with your UDF and post it to this thread or As described herein or here

Edited May 9, 2015 by mLipok

[robertocm]

Dear Jefrey,

Many Thanks,

Let me share a version of some of your examples trying to get StdOut from ConsoleWrite in Uncompiled scripts

save this as 01_child.au3

#include "cmdline.au3"

Local $Output = _CmdLine_Get('color')
MsgBox(0, "", $Output)
ConsoleWrite($Output)

save this as 01_main.au3

#include <Constants.au3>

#cs ----------------------------------------------------------------------------
Will return "white" if you run the script in one of these ways
(quotes are optional but mandatory if you're going to use spaces)
#ce ----------------------------------------------------------------------------
Local $sFilePath = '"' & @ScriptDir & '\01_child.au3"'
RunWait(@AutoItExe & " " & $sFilePath & ' -color "white"')

RunWait(@AutoItExe & " 01_child.au3" & ' -color white')

RunWait(@AutoItExe & " 01_child.au3" & ' --color white')
RunWait(@AutoItExe & " 01_child.au3" & ' /color white')

$iPID = Run(@AutoItExe & " /AutoIt3ExecuteScript " & "01_child.au3" & ' /color "white cafe"', "", @SW_HIDE, $STDERR_CHILD + $STDOUT_CHILD)
ProcessWaitClose($iPID)
Local $sOutput = ""
$sOutput = StdoutRead($iPID)
MsgBox(0, "Stdout Read", "Stdout Read: " & @CRLF & $sOutput)
ConsoleWrite($sOutput & @CRLF)

 

And this could be for example 04:

create 04_child.au3 in the same way as explained above

and save below code as 04_main.au3

#include <Constants.au3>

#cs ----------------------------------------------------------------------------
Flags
Will return "You want: coffee beer  and you do not want: vodka wine  but you did not tell me if you want: soda juice" if you run:
    script.exe +CB -VW
#ce ----------------------------------------------------------------------------

;Local $sFilePath = '"' & @ScriptDir & '\04_child.au3"'
;Local $iPID = Run(@AutoItExe & " /AutoIt3ExecuteScript " & $sFilePath & ' +CB -VW', "", @SW_HIDE, $STDERR_CHILD + $STDOUT_CHILD)
Local $iPID = Run(@AutoItExe & " /AutoIt3ExecuteScript " & "04_child.au3" & ' +CB -VW', "", @SW_HIDE, $STDERR_CHILD + $STDOUT_CHILD)

;This would be if compiled:
;Local $iPID = Run(@ComSpec & " /C 04_child.exe +CB -VW", @ScriptDir, @SW_HIDE, $STDERR_CHILD + $STDOUT_CHILD)

ProcessWaitClose($iPID)
Local $sOutput = ""
$sOutput = StdoutRead($iPID)
MsgBox(0, "Stdout Read", "Stdout Read: " & @CRLF & $sOutput)
ConsoleWrite($sOutput & @CRLF)

 

Edited December 25, 2016 by robertocm

[mLipok]

modfied:

expandcollapse popup

#include-once

; #INDEX# =======================================================================================================================
; Title .........: CmdLine
; AutoIt Version : 3.3
; Description ...: Reads named arguments, positional values and grouped letter flags from $CmdLine.
; Author(s) .....: Jefrey
; Remarks .......: Function headers added with AI assistance: OpenAI GPT-6
; Dll ...........: None
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; ===============================================================================================================================

; #CURRENT# =====================================================================================================================
;_CmdLine_Get
;_CmdLine_KeyExists
;_CmdLine_ValueExists
;_CmdLine_FlagEnabled
;_CmdLine_FlagDisabled
;_CmdLine_FlagExists
;_CmdLine_GetValByIndex
; ===============================================================================================================================

; #INTERNAL_USE_ONLY# ===========================================================================================================
;_CmdLine__FlagContains
; ===============================================================================================================================

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_Get
; Description ...: Gets the argument following a named command-line key.
; Syntax ........: _CmdLine_Get($sKey[, $mDefault = Null])
; Parameters ....: $sKey - Key name without its /, - or -- prefix.
;                  $mDefault - [optional] Value returned when the key has no following argument; default is Null.
; Return values .: The next command-line argument when the key has one; otherwise $mDefault.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: The next argument is returned literally, even if it starts with a key prefix. key=value syntax is unsupported.
; Related .......: _CmdLine_KeyExists, _CmdLine_GetValByIndex
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_Get("color", "white")
; ===============================================================================================================================
Func _CmdLine_Get($sKey, $mDefault = Null)
    For $i = 1 To $CmdLine[0]
        If $CmdLine[$i] = "/" & $sKey Or $CmdLine[$i] = "-" & $sKey Or $CmdLine[$i] = "--" & $sKey Then
            If $CmdLine[0] >= $i + 1 Then
                Return $CmdLine[$i + 1]
            EndIf
        EndIf
    Next
    Return $mDefault
EndFunc   ;==>_CmdLine_Get

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_KeyExists
; Description ...: Checks whether a named key occurs on the command line.
; Syntax ........: _CmdLine_KeyExists($sKey)
; Parameters ....: $sKey - Key name without its /, - or -- prefix.
; Return values .: True if the key occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: An argument value after the key is not required.
; Related .......: _CmdLine_Get, _CmdLine_ValueExists
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_KeyExists("verbose")
; ===============================================================================================================================
Func _CmdLine_KeyExists($sKey)
    For $i = 1 To $CmdLine[0]
        If $CmdLine[$i] = "/" & $sKey Or $CmdLine[$i] = "-" & $sKey Or $CmdLine[$i] = "--" & $sKey Then
            Return True
        EndIf
    Next
    Return False
EndFunc   ;==>_CmdLine_KeyExists

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_ValueExists
; Description ...: Checks whether an argument exactly matches a value.
; Syntax ........: _CmdLine_ValueExists($sValue)
; Parameters ....: $sValue - Value to find among the command-line arguments.
; Return values .: True if the value occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: This searches every argument and does not associate a value with a key.
; Related .......: _CmdLine_KeyExists
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_ValueExists("white")
; ===============================================================================================================================
Func _CmdLine_ValueExists($sValue)
    For $i = 1 To $CmdLine[0]
        If $CmdLine[$i] = $sValue Then
            Return True
        EndIf
    Next
    Return False
EndFunc   ;==>_CmdLine_ValueExists

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_FlagEnabled
; Description ...: Checks whether a letter flag occurs in a + flag group.
; Syntax ........: _CmdLine_FlagEnabled($sKey)
; Parameters ....: $sKey - One or more letters to find together in a flag group.
; Return values .: True if a matching + group occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: Matching is case-sensitive and requires an entire argument of the form +LETTERS.
; Related .......: _CmdLine_FlagDisabled, _CmdLine_FlagExists
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_FlagEnabled("C") ; matches +CB
; ===============================================================================================================================
Func _CmdLine_FlagEnabled($sKey)
    Return _CmdLine__FlagContains($sKey, "+")
EndFunc   ;==>_CmdLine_FlagEnabled

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_FlagDisabled
; Description ...: Checks whether a letter flag occurs in a - flag group.
; Syntax ........: _CmdLine_FlagDisabled($sKey)
; Parameters ....: $sKey - One or more letters to find together in a flag group.
; Return values .: True if a matching - group occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: Matching is case-sensitive and requires an entire argument of the form -LETTERS.
; Related .......: _CmdLine_FlagEnabled, _CmdLine_FlagExists
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_FlagDisabled("V") ; matches -VW
; ===============================================================================================================================
Func _CmdLine_FlagDisabled($sKey)
    Return _CmdLine__FlagContains($sKey, "-")
EndFunc   ;==>_CmdLine_FlagDisabled

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_FlagExists
; Description ...: Checks whether a letter flag occurs in a + or - flag group.
; Syntax ........: _CmdLine_FlagExists($sKey)
; Parameters ....: $sKey - One or more letters to find together in a flag group.
; Return values .: True if a matching group occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: Matching is case-sensitive and requires an entire argument of the form +LETTERS or -LETTERS.
; Related .......: _CmdLine_FlagEnabled, _CmdLine_FlagDisabled
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_FlagExists("B")
; ===============================================================================================================================
Func _CmdLine_FlagExists($sKey)
    Return _CmdLine__FlagContains($sKey, "+") Or _CmdLine__FlagContains($sKey, "-")
EndFunc   ;==>_CmdLine_FlagExists

; #FUNCTION# ====================================================================================================================
; Name ..........: _CmdLine_GetValByIndex
; Description ...: Gets a command-line argument by its one-based index.
; Syntax ........: _CmdLine_GetValByIndex($iIndex[, $mDefault = Null])
; Parameters ....: $iIndex - Integer index from 1 through $CmdLine[0].
;                  $mDefault - [optional] Value returned for an invalid or absent index; default is Null.
; Return values .: The indexed argument when it exists; otherwise $mDefault.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: Index 0 contains the argument count and is not returned by this function.
; Related .......: _CmdLine_Get
; Link ..........: https://www.autoitscript.com/forum/topic/169610-cmdline-udf-get-valueexistenceflag/
; Example .......: _CmdLine_GetValByIndex(1, "missing")
; ===============================================================================================================================
Func _CmdLine_GetValByIndex($iIndex, $mDefault = Null)
    If Not IsInt($iIndex) Or $iIndex < 1 Or $iIndex > $CmdLine[0] Then Return $mDefault
    Return $CmdLine[$iIndex]
EndFunc   ;==>_CmdLine_GetValByIndex

; #INTERNAL_USE_ONLY# ===========================================================================================================
; Name ..........: _CmdLine__FlagContains
; Description ...: Checks for literal letters inside one signed flag-group argument.
; Syntax ........: _CmdLine__FlagContains($sKey, $sPrefix)
; Parameters ....: $sKey - One or more letters to find together.
;                  $sPrefix - Expected leading + or - character.
; Return values .: True if a matching group occurs; otherwise False.
; Author ........: Jefrey
; Modified ......:
; Remarks .......: Rejects empty and non-letter keys so they cannot act as regular expressions.
; Related .......: _CmdLine_FlagEnabled, _CmdLine_FlagDisabled, _CmdLine_FlagExists
; Link ..........:
; Example .......: No
; ===============================================================================================================================
Func _CmdLine__FlagContains($sKey, $sPrefix)
    If Not StringRegExp($sKey, "^[A-Za-z]+$") Then Return False
    For $i = 1 To $CmdLine[0]
        Local $sArgument = $CmdLine[$i]
        If StringLeft($sArgument, 1) <> $sPrefix Then ContinueLoop
        Local $sFlags = StringTrimLeft($sArgument, 1)
        If StringRegExp($sFlags, "^[A-Za-z]+$") And StringInStr($sFlags, $sKey, 1) Then Return True
    Next
    Return False
EndFunc   ;==>_CmdLine__FlagContains

 

Edited 9 hours ago by mLipok