.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Commandable::Finder::SubAttributes 3pm" .TH Commandable::Finder::SubAttributes 3pm "2023-01-08" "perl v5.36.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 "NAME" "Commandable::Finder::SubAttributes" \- find commands stored as subs with attributes .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Commandable::Finder::SubAttributes; \& \& my $finder = Commandable::Finder::SubAttributes\->new( \& package => "MyApp::Commands", \& ); \& \& my $help_command = $finder\->find_command( "help" ); \& \& foreach my $command ( $finder\->find_commands ) { \& ... \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This implementation of Commandable::Finder looks for functions that define commands, where each command is provided by an individual sub in a given package. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .Vb 1 \& use Commandable::Finder::SubAttributes \*(Aq:attrs\*(Aq; \& \& sub command_example \& :Command_description("An example of a command") \& { \& ... \& } .Ve .PP Properties about each command are stored as attributes on the named function, using Attribute::Storage. .PP The following attributes are available on the calling package when imported with the \f(CW\*(C`:attrs\*(C'\fR symbol: .SS "Command_description" .IX Subsection "Command_description" .Vb 1 \& :Command_description("description text") .Ve .PP Gives a plain string description text for the command. .SS "Command_arg" .IX Subsection "Command_arg" .Vb 1 \& :Command_arg("argname", "description") .Ve .PP Gives a named argument for the command and its description. .PP If the name is suffixed by a \f(CW\*(C`?\*(C'\fR, this argument is optional. (The \f(CW\*(C`?\*(C'\fR itself will be removed from the name). .PP If the name is suffixed by \f(CW\*(C`...\*(C'\fR, this argument is slurpy. (The \f(CW\*(C`...\*(C'\fR itself will be removed from the name). .SS "Command_opt" .IX Subsection "Command_opt" .Vb 1 \& :Command_opt("optname", "description") .Ve .PP Gives a named option for the command and its description. .PP If the name contains \f(CW\*(C`|\*(C'\fR characters it provides multiple name aliases for the same option. .PP If the name field ends in a \f(CW\*(C`:\*(C'\fR character, a value is expected for the option. It can either be parsed from the next input token, or after an \f(CW\*(C`=\*(C'\fR sign of the same token: .PP .Vb 2 \& \-\-optname VALUE \& \-\-optname=VALUE .Ve .PP An optional third argument may be present to specify a default value, if not provided by the invocation: .PP .Vb 1 \& :Command_opt("optname", "description", "default") .Ve .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 1 \& $finder = Commandable::Finder::SubAttributes\->new( %args ) .Ve .PP Constructs a new instance of \f(CW\*(C`Commandable::Finder::SubAttributes\*(C'\fR. .PP Takes the following named arguments: .IP "package => \s-1STR\s0" 4 .IX Item "package => STR" The name of the package to look in for command subs. .IP "name_prefix => \s-1STR\s0" 4 .IX Item "name_prefix => STR" Optional. Gives the name prefix to use to filter for subs that actually provide a command, and to strip off to find the name of the command. Default \&\f(CW\*(C`command_\*(C'\fR. .IP "underscore_to_hyphen => \s-1BOOL\s0" 4 .IX Item "underscore_to_hyphen => BOOL" Optional. If true, sub names that contain underscores will be converted into hyphens. This is often useful in \s-1CLI\s0 systems, allowing commands to be typed with hyphenated names (e.g. \*(L"get-thing\*(R") while the Perl sub that implements it is named with an underscores (e.g. \*(L"command_get_thing\*(R"). Defaults true, but can be disabled by passing a defined-but-false value such as \f(CW0\fR or \f(CW\*(Aq\*(Aq\fR. .PP Any additional arguments are passed to the \f(CW\*(C`configure\*(C'\fR method to be used as configuration options. .SS "new_for_caller" .IX Subsection "new_for_caller" .SS "new_for_main" .IX Subsection "new_for_main" .Vb 2 \& $finder = Commandable::Finder::SubAttributes\->new_for_caller( %args ) \& $finder = Commandable::Finder::SubAttributes\->new_for_main( %args ) .Ve .PP Convenient wrapper constructors that pass either the caller's package name or \&\f(CW\*(C`main\*(C'\fR as the package name. Combined with the \f(CW\*(C`find_and_invoke_ARGV\*(C'\fR method these are particularly convenient for wrapper scripts: .PP .Vb 1 \& #!/usr/bin/perl \& \& use v5.14; \& use warnings; \& \& use Commandable::Finder::SubAttributes \*(Aq:attrs\*(Aq; \& \& exit Commandable::Finder::SubAttributes\->new_for_main \& \->find_and_invoke_ARGV; \& \& # command subs go here... .Ve .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans