.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "SHARYANTO::String::Util 3pm"
.TH SHARYANTO::String::Util 3pm "2018-04-07" "perl v5.26.1" "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"
SHARYANTO::String::Util \- String utilities
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "ltrim($str) => \s-1STR\s0"
.IX Subsection "ltrim($str) => STR"
Trim whitespaces (including newlines) at the beginning of string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/\eA\es+//s;
.Ve
.SS "ltrim_lines($str) => \s-1STR\s0"
.IX Subsection "ltrim_lines($str) => STR"
Trim whitespaces (not including newlines) at the beginning of each line of
string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/^\es+//mg;
.Ve
.SS "rtrim($str) => \s-1STR\s0"
.IX Subsection "rtrim($str) => STR"
Trim whitespaces (including newlines) at the end of string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/[ \et]+\ez//s;
.Ve
.SS "rtrim_lines($str) => \s-1STR\s0"
.IX Subsection "rtrim_lines($str) => STR"
Trim whitespaces (not including newlines) at the end of each line of
string. Equivalent to:
.PP
.Vb 1
\& $str =~ s/[ \et]+$//mg;
.Ve
.SS "trim($str) => \s-1STR\s0"
.IX Subsection "trim($str) => STR"
ltrim + rtrim.
.SS "trim_lines($str) => \s-1STR\s0"
.IX Subsection "trim_lines($str) => STR"
ltrim_lines + rtrim_lines.
.SS "trim_blank_lines($str) => \s-1STR\s0"
.IX Subsection "trim_blank_lines($str) => STR"
Trim blank lines at the beginning and the end. Won't trim blank lines in the
middle. Blank lines include lines with only whitespaces in them.
.ie n .SS "ellipsis($str[, $maxlen, $ellipsis]) => \s-1STR\s0"
.el .SS "ellipsis($str[, \f(CW$maxlen\fP, \f(CW$ellipsis\fP]) => \s-1STR\s0"
.IX Subsection "ellipsis($str[, $maxlen, $ellipsis]) => STR"
Return \f(CW$str\fR unmodified if \f(CW$str\fR's length is less than \f(CW$maxlen\fR (default 80).
Otherwise cut \f(CW$str\fR to ($maxlen \- length($ellipsis)) and append \f(CW$ellipsis\fR
(default '...') at the end.
.ie n .SS "indent($indent, $str, \e%opts) => \s-1STR\s0"
.el .SS "indent($indent, \f(CW$str\fP, \e%opts) => \s-1STR\s0"
.IX Subsection "indent($indent, $str, %opts) => STR"
Indent every line in \f(CW$str\fR with \f(CW$indent\fR. Example:
.PP
.Vb 1
\& indent(\*(Aq  \*(Aq, "one\entwo\enthree") # "  one\en  two\en  three"
.Ve
.PP
\&\f(CW%opts\fR is optional. Known options:
.IP "\(bu" 4
indent_blank_lines => \s-1BOOL\s0 (default 1)
.Sp
If set to false, does not indent blank lines (i.e., lines containing only zero
or more whitespaces).
.SS "linenum($str, \e%opts) => \s-1STR\s0"
.IX Subsection "linenum($str, %opts) => STR"
Add line numbers. For example:
.PP
.Vb 4
\&     1|line1
\&     2|line2
\&      |
\&     4|line4
.Ve
.PP
Known options:
.IP "\(bu" 4
width => \s-1INT\s0 (default: 4)
.IP "\(bu" 4
zeropad => \s-1BOOL\s0 (default: 0)
.Sp
If turned on, will output something like:
.Sp
.Vb 4
\&  0001|line1
\&  0002|line2
\&      |
\&  0004|line4
.Ve
.IP "\(bu" 4
skip_empty => \s-1BOOL\s0 (default: 1)
.Sp
If set to false, keep printing line number even if line is empty:
.Sp
.Vb 4
\&     1|line1
\&     2|line2
\&     3|
\&     4|line4
.Ve
.ie n .SS "pad($text, $width[, $which[, $padchar[, $truncate]]]) => \s-1STR\s0"
.el .SS "pad($text, \f(CW$width\fP[, \f(CW$which\fP[, \f(CW$padchar\fP[, \f(CW$truncate\fP]]]) => \s-1STR\s0"
.IX Subsection "pad($text, $width[, $which[, $padchar[, $truncate]]]) => STR"
Return \f(CW$text\fR padded with \f(CW$padchar\fR to \f(CW$width\fR columns. \f(CW$which\fR is
either \*(L"r\*(R" or \*(L"right\*(R" for padding on the right (the default if not specified),
\&\*(L"l\*(R" or \*(L"left\*(R" for padding on the right, or \*(L"c\*(R" or \*(L"center\*(R" or \*(L"centre\*(R" for
left+right padding to center the text.
.PP
\&\f(CW$padchar\fR is whitespace if not specified. It should be string having the width
of 1 column.
.SS "qqquote($str) => \s-1STR\s0"
.IX Subsection "qqquote($str) => STR"
Quote or encode \f(CW$str\fR to the Perl double quote (\f(CW\*(C`qq\*(C'\fR) literal representation
of the string. Example:
.PP
.Vb 4
\& say qqquote("a");        # => "a"
\& say qqquote("a\en");      # => "a\en"
\& say qqquote(\*(Aq"\*(Aq);        # => "\e""
\& say qqquote(\*(Aq$foo\*(Aq);     # => "\e$foo"
.Ve
.PP
This code is taken from \f(CW\*(C`quote()\*(C'\fR in Data::Dump. Maybe I didn't look more
closely, but I couldn't a module that provides a function to do something like
this. String::Escape, for example, provides \f(CW\*(C`qqbackslash\*(C'\fR but it does not
escape \f(CW\*(C`$\*(C'\fR.
.PP
None are exported by default, but they are exportable.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1SHARYANTO\s0
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/SHARYANTO\-String\-Util>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at \s-1HASH\s0(0x353ed90).
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website
https://rt.cpan.org/Public/Dist/Display.html?Name=SHARYANTO\-String\-Util
.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 "AUTHOR"
.IX Header "AUTHOR"
Steven Haryanto <stevenharyanto@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Steven Haryanto.
.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.