/ program / 2.0 / sh / parser.chunks.html

Table of content

Templates

Details

Templates

prg.sh.parser.indexIncrement()

"$parser_index++"
prg.sh.parser.itemUpdate()

parser_item=${parser_input[$parser_index]}
prg.sh.parser.copyValues(interpreter)

for each remaining input, append parser_input[] to parser_values[]
  1. interpreter
prg.sh.parser.optionSetPresence(optionNode=".", onError="''", depth="0")

@todo use unified id
  1. optionNode
    Option node
    Default value: .
  2. onError
    If set, test return value of setoptionpresence function
    Default value: ''
  3. depth
    Internal use
    Default value: 0
prg.sh.parser.setDefaultOption(rootNode, optionNode=".", interpreter)
  1. rootNode
  2. optionNode
    Default value: .
  3. interpreter
prg.sh.parser.setDefaultOptions(rootNode, interpreter)

Set default values for all single arguments in a root item info (part of the setdefaultoptions function)
  1. rootNode
  2. interpreter
prg.sh.parser.unescapeValue(variableName="$prg.sh.parser.vName_item")

Remove \ protection if any
  1. variableName
    Default value: $prg.sh.parser.vName_item
prg.sh.parser.argumentPreprocess(optionNode=".", shortOption="false()", onError)
  1. optionNode
    Default value: .
  2. shortOption
    Default value: false()
  3. onError
prg.sh.parser.multiargumentPreprocess(optionNode=".", onError)
  1. optionNode
    Default value: .
  2. onError
prg.sh.parser.optionSetValue(optionNode=".", onError, shortOption="false()", interpreter)
  1. optionNode
    Default value: .
  2. onError
  3. shortOption
    Default value: false()
  4. interpreter
prg.sh.parser.groupSetVars(optionNode=".")
  1. optionNode
    Default value: .
prg.sh.parser.valueRestrictionCheck(optionNode=".", value, onError, currentItem="option \" \"")
  1. optionNode
    Default value: .
  2. value
  3. onError
  4. currentItem
    Default value: option \" \"
prg.sh.parser.groupSetCondition(groupOptionNode=".", optionNode)

List of test to check if a group was "set" at least by one variable
  1. groupOptionNode
    The group node
    Default value: .
  2. optionNode
    If set, also check if group was set by this option
prg.sh.parser.groupCheck(optionNode=".", onError, shortOption="false()", process="true()", comments="true()", originalOptionNode="$optionNode")

Chec if the option is part of a group and if it does not break mutual exclusion rule
  1. optionNode
    Option to check
    Default value: .
  2. onError
    Additional things to do when checks fail
  3. shortOption
    Option name type
    Default value: false()
  4. process
    Disable default processing
    Default value: true()
  5. comments
    Internal use
    Default value: true()
  6. originalOptionNode
    Internal use
    Default value: $optionNode
prg.sh.parser.numberCheck(numberNode, value, onError, currentItem, interpreter)
  1. numberNode
  2. value
  3. onError
  4. currentItem
  5. interpreter
prg.sh.parser.existingCommandCheck(value, onError, currentItem)
  1. value
  2. onError
  3. currentItem
prg.sh.parser.pathTypeAccessCheck(value, onError, accessString, currentItem)
  1. value
  2. onError
  3. accessString
  4. currentItem
prg.sh.parser.pathTypeKindsCheck(value, kindsNode, onError, currentItem)
  1. value
  2. kindsNode
  3. onError
  4. currentItem
prg.sh.parser.pathTypePresenceCheck(value, onError, currentItem)
  1. value
  2. onError
  3. currentItem
prg.sh.parser.optionValueTypeCheck(node=".", value, onError, interpreter, currentItem="option \" \"")
  1. node
    Default value: .
  2. value
  3. onError
  4. interpreter
  5. currentItem
    Default value: option \" \"
prg.sh.parser.longOptionSwitch(optionsNode, onError, onUnknownOption, interpreter)

long option case
  1. optionsNode
  2. onError
  3. onUnknownOption
  4. interpreter
prg.sh.parser.checkMax(node=".", isOption="true()", valueVariableName, max, onError)
  1. node
    Default value: .
  2. isOption
    Default value: true()
  3. valueVariableName
  4. max
  5. onError
prg.sh.parser.optionCase(optionNode=".", shortOption="false()", onError, interpreter)
  1. optionNode
    Default value: .
  2. shortOption
    Default value: false()
  3. onError
  4. interpreter
prg.sh.parser.shortOptionSwitch(optionsNode, onError, onUnknownOption, interpreter)

short option case
  1. optionsNode
  2. onError
  3. onUnknownOption
  4. interpreter
prg.sh.parser.addRequiredOption(optionNode=".", useFunction="false()")
  1. optionNode
    Default value: .
  2. useFunction
    Default value: false()
prg.sh.parser.addRequiredOptions(optionsNode, useFunction="false()", recursive="true()")
  1. optionsNode
  2. useFunction
    Default value: false()
  3. recursive
    Default value: true()
prg.sh.parser.addGlobalError(value)
  1. value
prg.sh.parser.checkValue(valuesNode, interpreter, positionVar, onError, value="value")
  1. valuesNode
  2. interpreter
  3. positionVar
  4. onError
  5. value
    Even if a positional argument is invalid, the value is added to the global array
    Default value: value
prg.sh.parser.longOptionNameElif(optionsNode, onError, onUnknownOption, keyword="elif", interpreter)
  1. optionsNode
  2. onError
  3. onUnknownOption
  4. keyword
    Default value: elif
  5. interpreter
prg.sh.parser.shortOptionNameElif(optionsNode, onError, onSuccess, onUnknownOption, keyword="elif", interpreter)
  1. optionsNode
  2. onError
  3. onSuccess
  4. onUnknownOption
  5. keyword
    Default value: elif
  6. interpreter
prg.sh.parser.initialize(programNode=".")

Variable Initialization
  1. programNode
    Default value: .