.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(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
.\" ========================================================================
.\"
.IX Title "Tickit::StringPos 3pm"
.TH Tickit::StringPos 3pm 2024-03-07 "perl v5.38.2" "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 UTF\-8 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 member 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>