.\" Automatically generated by Pod::Man 4.10 (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
..
.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 "Tickit::StringPos 3pm"
.TH Tickit::StringPos 3pm "2018-11-01" "perl v5.28.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"
"Tickit::StringPos" \- store string position counters
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Tickit::StringPos;
\& use Tickit::Utils qw( string_count );
\&
\& my $pos = Tickit::StringPos\->zero;
\& string_count( "Here is a message", $pos );
\&
\& print "The message consumes ", $pos\->columns, " columns\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Instances in this object class store four position counters that relate to
counting strings.
.PP
The \f(CW\*(C`bytes\*(C'\fR member counts \s-1UTF\-8\s0 bytes which encode individual codepoints. For
example the Unicode character U+00E9 is encoded by two bytes 0xc3, 0xa9; it
would increment the bytes counter by 2 and the \f(CW\*(C`codepoints\*(C'\fR counter by 1.
.PP
The \f(CW\*(C`codepoints\*(C'\fR member counts individual Unicode codepoints.
.PP
The \f(CW\*(C`graphemes\*(C'\fR member counts whole composed graphical clusters of codepoints,
where combining accents which count as individual codepoints do not count as
separate graphemes. For example, the codepoint sequence U+0065 U+0301 would
increment the \f(CW\*(C`codepoint\*(C'\fR counter by 2 and the \f(CW\*(C`graphemes\*(C'\fR counter by 1.
.PP
The \f(CW\*(C`columns\*(C'\fR member counts the number of screen columns consumed by the
graphemes. Most graphemes consume only 1 column, but some are defined in
Unicode to consume 2.
.PP
Instances are also used to store count limits, where any memeber may be set
to \-1 to indicate no limit in that counter.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.SS "zero"
.IX Subsection "zero"
.Vb 1
\&   $pos = Tickit::StringPos\->zero
.Ve
.PP
Returns a new instance with all counters set to zero.
.SS "limit_bytes"
.IX Subsection "limit_bytes"
.SS "limit_codepoints"
.IX Subsection "limit_codepoints"
.SS "limit_graphemes"
.IX Subsection "limit_graphemes"
.SS "limit_columns"
.IX Subsection "limit_columns"
.Vb 1
\&   $pos = Tickit::StringPos\->limit_bytes( $bytes )
\&
\&   $pos = Tickit::StringPos\->limit_codepoints( $codepoints )
\&
\&   $pos = Tickit::StringPos\->limit_graphemes( $graphemes )
\&
\&   $pos = Tickit::StringPos\->limit_columns( $columns )
.Ve
.PP
Return a new instance with one counter set to the given limit and the other
three counters set to \-1.
.SH "METHODS"
.IX Header "METHODS"
.SS "bytes"
.IX Subsection "bytes"
.SS "codepoints"
.IX Subsection "codepoints"
.SS "graphemes"
.IX Subsection "graphemes"
.SS "columns"
.IX Subsection "columns"
.Vb 1
\&   $bytes = $pos\->bytes
\&
\&   $codepoints = $pos\->codepoints
\&
\&   $graphemes = $pos\->graphemes
\&
\&   $columns = $pos\->columns
.Ve
.PP
Return the current value the counters.
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>