Misc Functions.

Functions
	__argsparse_has_array_item (array_name, item)
	__argsparse_index_of (value, values...)
	Tells if a value is found in a set of other values.
	__argsparse_is_array_declared (name)
	__argsparse_join_array (c, strings...)
	join multiple strings by a char.
	__argsparse_values_array_identifier (option)
	Prints the name of the array containing all user-declared acceptable values for an option.
	argsparse_option_to_identifier (option)
	Give the identifier name associated to an option.

Detailed Description

Function Documentation

__argsparse_has_array_item()

__argsparse_has_array_item	(	array_name	,
		item	)

Parameters

array_name	an array name.
item	an item key.

Return values

0	if an array has been already declared by the name of the parameter AND if said array holds given key.

__argsparse_index_of()

__argsparse_index_of	(	value	,
		values...	)

Tells if a value is found in a set of other values.

Parameters

value	a value
values...	array values

Look for value and print its position in the values set. Return false if it can not be found.

Return values

0	if value is amongst values
1	if value is not found.

__argsparse_is_array_declared()

__argsparse_is_array_declared

(

name

)

Parameters

name	A potential array name

Return values

0	if an array named after the parameter does exist

__argsparse_join_array()

__argsparse_join_array	(	c	,
		strings...	)

join multiple strings by a char.

Parameters

c	a single char
strings...	strings to join

Like the 'str.join' string method in python, join multiple strings by a char. Only work with a single char, though.

Return values

1	if first parameter is invalid.
0	else.

__argsparse_values_array_identifier()

__argsparse_values_array_identifier

(

option

)

Prints the name of the array containing all user-declared acceptable values for an option.

from "opt" or "opt-name" string, prints "option_opt_values[@]" or "option_opt_name_values[@]", unless array is not declared, in which case function will return an error.

Parameters

option

an option name.

Return values

1	if array has not been declared
0	else. Array name will be written to stdout.

argsparse_option_to_identifier()

argsparse_option_to_identifier

(

option

)

Give the identifier name associated to an option.

Transforms and prints an option name into a string which suitable to be part of a function or a variable name.

Parameters

option

an option name.