NAME<\/a> Data::OptList \u2212 parse and validate simple name\/value option pairs<\/p>\n version 0.110<\/p>\n use Data::OptList; …is the same thing, more or less, as:<\/p>\n my $options = [ Hashes are great for storing named data, but if you want more than one entry for a name, you have to use a list of pairs. Even then, this is really boring to write:<\/p>\n $values = [ Just look at all those undefs! Don\u2019t worry, we can get rid of those:<\/p>\n $values = [ Aaaauuugh! We\u2019ve saved a little typing, but now it requires thought to read, and thinking is even worse than typing… and it\u2019s got a bug! It looked right, didn\u2019t it? Well, the “xyz => { … }” gets consumed by the map, and we don\u2019t get the data we wanted.<\/p>\n With Data::OptList, you can do this instead:<\/p>\n $values = Data::OptList::mkopt([ This works by assuming that any defined scalar is a name and any reference following a name is its value.<\/p>\n mkopt<\/b> Valid arguments are:<\/p>\n moniker \u2212 a word used in errors to describe the opt list; encouraged This produces an array of arrays; the inner arrays are name\/value pairs. Values will be either “undef” or a reference.<\/p>\n Positional parameters may be used for compatibility with the old “mkopt” interface:<\/p>\n my $opt_list = Data::OptList::mkopt($input, $moniker, $req_uni, $must_be);<\/p>\n Valid values for $input:<\/p>\n undef \u2212> [] By default, a name<\/i> is any defined non-reference. The “name_test” parameter can be a code ref that tests whether the argument passed it is a name or not. This should be used rarely. Interactions between “require_unique” and “name_test” are not yet particularly elegant, as “require_unique” just tests string equality. This may change.<\/b><\/p>\n The “must_be” parameter is either a scalar or array of scalars; it defines what kind(s) of refs may be values. If an invalid value is found, an exception is thrown. If no value is passed for this argument, any reference is valid. If “must_be” specifies that values must be CODE, HASH, ARRAY,<\/small> or SCALAR,<\/small> then Params::Util is used to check whether the given value can provide that interface. Otherwise, it checks that the given value is an object of the kind.<\/p>\n In other words:<\/p>\n [ qw(SCALAR HASH Object::Known) ]<\/p>\n Means:<\/p>\n _SCALAR0($value) or _HASH($value) or _INSTANCE($value, ‘Object::Known’)<\/p>\n mkopt_hash<\/b> Given valid “mkopt” input, this routine returns a reference to a hash. It will throw an exception if any name has more than one value.<\/p>\n Both “mkopt” and “mkopt_hash” may be exported on request.<\/p>\n Ricardo Signes \u2022<\/p>\n<\/td>\n
VERSION<\/a>
SYNOPSIS<\/a>
DESCRIPTION<\/a>
FUNCTIONS<\/a>
EXPORTS<\/a>
AUTHOR<\/a>
CONTRIBUTORS<\/a>
COPYRIGHT AND LICENSE<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
VERSION <\/a> <\/h2>\n
SYNOPSIS <\/a> <\/h2>\n
my $options = Data::OptList::mkopt([
qw(key1 key2 key3 key4),
key5 => { … },
key6 => [ … ],
key7 => sub { … },
key8 => { … },
key8 => [ … ],
]);<\/p>\n
[ key1 => undef, ],
[ key2 => undef, ],
[ key3 => undef, ],
[ key4 => undef, ],
[ key5 => { … }, ],
[ key6 => [ … ], ],
[ key7 => sub { … }, ],
[ key8 => { … }, ],
[ key8 => [ … ], ],
]);<\/p>\nDESCRIPTION <\/a> <\/h2>\n
foo => undef,
bar => undef,
baz => undef,
xyz => { … },
];<\/p>\n
map { $_ => undef } qw(foo bar baz),
xyz => { … },
];<\/p>\n
qw(foo bar baz),
xyz => { … },
]);<\/p>\nFUNCTIONS <\/a> <\/h2>\n
my $opt_list = Data::OptList::mkopt($input, %arg);<\/p>\n
require_unique \u2212 if true, no name may appear more than once
must_be \u2212 types to which opt list values are limited (described below)
name_test \u2212 a coderef used to test whether a value can be a name
(described below, but you probably don’t want this)<\/p>\n
hashref \u2212> [ [ key1 => value1 ] … ] # non\u2212ref values become undef
arrayref \u2212> every name followed by a non\u2212name becomes a pair: [ name => ref ]
every name followed by undef becomes a pair: [ name => undef ]
otherwise, it becomes [ name => undef ] like so:
[ “a”, “b”, [ 1, 2 ] ] \u2212> [ [ a => undef ], [ b => [ 1, 2 ] ] ]<\/p>\n
my $opt_hash = Data::OptList::mkopt_hash($input, $moniker, $must_be);<\/p>\nEXPORTS <\/a> <\/h2>\n
AUTHOR <\/a> <\/h2>\n
CONTRIBUTORS <\/a> <\/h2>\n
\n
\n <\/td>\n \n <\/td>\n \n