.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .\" ======================================================================== .\" .IX Title "Text::sprintfn 3pm" .TH Text::sprintfn 3pm "2022-10-13" "perl v5.34.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" Text::sprintfn \- Drop\-in replacement for sprintf(), with named parameter support .SH "VERSION" .IX Header "VERSION" This document describes version 0.090 of Text::sprintfn (from Perl distribution Text-sprintfn), released on 2019\-11\-19. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Text::sprintfn; # by default exports sprintfn() and printfn() \& \& # with no hash, behaves just like printf \& printfn \*(Aq<%04d>\*(Aq, 1, 2; # <0001> \& \& # named parameter \& printfn \*(Aq<%(v1)\-4d>\*(Aq, {v1=>\-2}; # <\-2 > \& \& # mixed named and positional \& printfn \*(Aq<%d> <%(v1)d> <%d>\*(Aq, {v1=>1}, 2, 3; # <2> <1> <3> \& \& # named width \& printfn "<%(v1)(v2).1f>", {v1=>3, v2=>4}; # < 3> \& \& # named precision \& printfn "<%(v1)(v2).(v2)f>", {v1=>3, v2=>4}; # <3.0000> .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides \fBsprintfn()\fR and \fBprintfn()\fR, which are like \fBsprintf()\fR and \&\fBprintf()\fR, with the exception that they support named parameters from a hash. .SH "RATIONALE" .IX Header "RATIONALE" There exist other \s-1CPAN\s0 modules for string formatting with named parameter support. Two of such modules are String::Formatter and Text::Sprintf::Named. This module is far simpler to use and retains all of the features of Perl's \fBsprintf()\fR (which we like, or perhaps hate, but nevertheless are familiar with). .PP String::Formatter requires you to create a new formatter function first. Text::Sprintf::Named also accordingly requires you to instantiate an object first. There is currently no way to mix named and positional parameters. And you don't get the full features of \fBsprintf()\fR. .SH "HOW IT WORKS" .IX Header "HOW IT WORKS" Text::sprintfn works by converting the format string into sprintf format, i.e. replacing the named parameters like \f(CW\*(C`%(foo)s\*(C'\fR to something like \f(CW\*(C`%11$s\*(C'\fR. .SH "DOWNSIDES" .IX Header "DOWNSIDES" Currently the main downside is speed. \f(CW\*(C`sprintfn()\*(C'\fR is about 2\-3 orders of magnitude slower than \f(CW\*(C`sprintf()\*(C'\fR. See Bencher::Scenario::Textsprintfn for benchmarks. .SH "TIPS AND TRICKS" .IX Header "TIPS AND TRICKS" .SS "Common mistake 1" .IX Subsection "Common mistake 1" Writing .PP .Vb 1 \& %(var) .Ve .PP instead of .PP .Vb 1 \& %(var)s .Ve .SS "Common mistake 2 (a bit more newbish)" .IX Subsection "Common mistake 2 (a bit more newbish)" Writing .PP .Vb 1 \& sprintfn $format, %hash, ...; .Ve .PP instead of .PP .Vb 1 \& sprintfn $format, \e%hash, ...; .Ve .SS "Alternative hashes" .IX Subsection "Alternative hashes" You have several hashes (%h1, \f(CW%h2\fR, \f(CW%h3\fR) which should be consulted for values. You can either merge the hash first: .PP .Vb 2 \& %h = (%h1, %h2, %h3); # or use some hash merging module \& printfn $format, \e%h, ...; .Ve .PP or create a tied hash which can consult hashes for you: .PP .Vb 2 \& tie %h, \*(AqYour::Module\*(Aq, \e%h1, \e%h2, \e%h3; \& printfn $format, \e%h, ...; .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .SS "sprintfn $fmt, \e%hash, ..." .el .SS "sprintfn \f(CW$fmt\fP, \e%hash, ..." .IX Subsection "sprintfn $fmt, %hash, ..." If first argument after format is not a hash, \fBsprintfn()\fR will behave exactly like \fBsprintf()\fR. .PP If hash is given, \fBsprintfn()\fR will look for named parameters in argument and supply the values from the hash. Named parameters are surrounded with parentheses, i.e. \*(L"(\s-1NAME\s0)\*(R". They can occur in format parameter index: .PP .Vb 3 \& %2$d # sprintf version, take argument at index 2 \& %(two)d # $ is optional \& %(two)$d # same .Ve .PP or in width: .PP .Vb 3 \& %\-10d # sprintf version, use (minimum) width of 10 \& %\-(width)d # like sprintf, but use width from hash key \*(Aqwidth\*(Aq \& %(var)\-(width)d # format hash key \*(Aqvar\*(Aq with width from hash key \*(Aqwidth\*(Aq .Ve .PP or in precision: .PP .Vb 4 \& %6.2f # sprintf version, use precision of 2 decimals \& %6.(prec)f # like sprintf, but use precision from hash key \*(Aqprec\*(Aq \& %(width).(prec)f \& %(var)(width).(prec)f .Ve .PP The existence of formats using hash keys will not affect indexes of the rest of the argument, example: .PP .Vb 1 \& sprintfn "<%(v1)s> <%2$d> <%d>", {v1=>10}, 0, 1, 2; # "<10> <2> <0>" .Ve .PP Like \fBsprintf()\fR, if format is unknown/erroneous, it will be printed as-is. .PP There is currently no way to escape \*(L")\*(R" in named parameter, e.g.: .PP .Vb 1 \& %(var containing ))s .Ve .ie n .SS "printfn $fmt, ..." .el .SS "printfn \f(CW$fmt\fP, ..." .IX Subsection "printfn $fmt, ..." Equivalent to: print sprintfn($fmt, ...). .SH "HOMEPAGE" .IX Header "HOMEPAGE" Please visit the project's homepage at . .SH "SOURCE" .IX Header "SOURCE" Source repository is at . .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBsprintf()\fR section on perlfunc .PP String::Formatter .PP Text::Sprintf::Named .SH "AUTHOR" .IX Header "AUTHOR" perlancar .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2019, 2015, 2012, 2011 by perlancar@cpan.org. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.