.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "Data::OptList 3" .TH Data::OptList 3 2026-10-26 "perl v5.44.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Data::OptList; \& \& my $options = Data::OptList::mkopt([ \& qw(key1 key2 key3 key4), \& key5 => { ... }, \& key6 => [ ... ], \& key7 => sub { ... }, \& key8 => { ... }, \& key8 => [ ... ], \& ]); .Ve .PP \&...is the same thing, more or less, as: .PP .Vb 11 \& my $options = [ \& [ key1 => undef, ], \& [ key2 => undef, ], \& [ key3 => undef, ], \& [ key4 => undef, ], \& [ key5 => { ... }, ], \& [ key6 => [ ... ], ], \& [ key7 => sub { ... }, ], \& [ key8 => { ... }, ], \& [ key8 => [ ... ], ], \& ]); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" 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: .PP .Vb 6 \& $values = [ \& foo => undef, \& bar => undef, \& baz => undef, \& xyz => { ... }, \& ]; .Ve .PP Just look at all those undefs! Don\*(Aqt worry, we can get rid of those: .PP .Vb 4 \& $values = [ \& map { $_ => undef } qw(foo bar baz), \& xyz => { ... }, \& ]; .Ve .PP Aaaauuugh! We\*(Aqve saved a little typing, but now it requires thought to read, and thinking is even worse than typing... and it\*(Aqs got a bug! It looked right, didn\*(Aqt it? Well, the \f(CW\*(C`xyz => { ... }\*(C'\fR gets consumed by the map, and we don\*(Aqt get the data we wanted. .PP With Data::OptList, you can do this instead: .PP .Vb 4 \& $values = Data::OptList::mkopt([ \& qw(foo bar baz), \& xyz => { ... }, \& ]); .Ve .PP This works by assuming that any defined scalar is a name and any reference following a name is its value. .PP .Vb 1 \& my $opt_list = Data::OptList::mkopt($input, \e%arg); .Ve .PP Valid arguments are: .PP .Vb 5 \& moniker \- a word used in errors to describe the opt list; encouraged \& require_unique \- if true, no name may appear more than once \& must_be \- types to which opt list values are limited (described below) \& name_test \- a coderef used to test whether a value can be a name \& (described below, but you probably don\*(Aqt want this) .Ve .PP This produces an array of arrays; the inner arrays are name/value pairs. Values will be either "undef" or a reference. .PP Positional parameters may be used for compatibility with the old \f(CW\*(C`mkopt\*(C'\fR interface: .PP .Vb 1 \& my $opt_list = Data::OptList::mkopt($input, $moniker, $req_uni, $must_be); .Ve .PP Valid values for \f(CW$input\fR: .PP .Vb 6 \& undef \-> [] \& hashref \-> [ [ key1 => value1 ] ... ] # non\-ref values become undef \& arrayref \-> every name followed by a non\-name 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 ] ] \-> [ [ a => undef ], [ b => [ 1, 2 ] ] ] .Ve .PP By default, a \fIname\fR is any defined non\-reference. The \f(CW\*(C`name_test\*(C'\fR 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 \f(CW\*(C`require_unique\*(C'\fR and \&\f(CW\*(C`name_test\*(C'\fR are not yet particularly elegant, as \f(CW\*(C`require_unique\*(C'\fR just tests string equality. \fBThis may change.\fR .PP The \f(CW\*(C`must_be\*(C'\fR 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 \f(CW\*(C`must_be\*(C'\fR specifies that values must be CODE, HASH, ARRAY, or SCALAR, then Params::SomeUtil 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. .PP In other words: .PP .Vb 1 \& [ qw(SCALAR HASH Object::Known) ] .Ve .PP Means: .PP .Vb 1 \& _SCALAR0($value) or _HASH($value) or _INSTANCE($value, \*(AqObject::Known\*(Aq) .Ve .PP .Vb 1 \& my $opt_hash = Data::OptList::mkopt_hash($input, $moniker, $must_be); .Ve .PP Given valid \f(CW"mkopt"\fR input, this routine returns a reference to a hash. It will throw an exception if any name has more than one value. .SH EXPORTS .IX Header "EXPORTS" Both \f(CW\*(C`mkopt\*(C'\fR and \f(CW\*(C`mkopt_hash\*(C'\fR may be exported on request. .SH "POD ERRORS" .IX Header "POD ERRORS" Hey! \fBThe above document had some coding errors, which are explained below:\fR .IP "Around line 72:" 4 .IX Item "Around line 72:" Unknown directive: =func .IP "Around line 208:" 4 .IX Item "Around line 208:" Unknown directive: =func