live "ˆl–ßi~”T†»ê€~ãlܪbÑ¿È ƒq–ÛÇËÓ=encoding utf-8 =head1 NAME Unicode::GCString - String as Sequence of UAX #29 Grapheme Clusters =head1 SYNOPSIS use Unicode::GCString; $gcstring = Unicode::GCString->new($string); =head1 DESCRIPTION Unicode::GCString treats Unicode string as a sequence of I defined by Unicode Standard Annex #29 [UAX #29]. B is a sequence of Unicode character(s) that consists of one B and optional B and/or B<“prepend†character>. It is close in that people consider as I. =head2 Public Interface =head3 Constructors =over 4 =item new (STRING, [KEY => VALUE, ...]) =item new (STRING, [LINEBREAK]) I. Create new grapheme cluster string (Unicode::GCString object) from Unicode string STRING. About optional KEY => VALUE pairs see L. On second form, L object LINEBREAK controls breaking features. B: The first form was introduced by release 2012.10. =item copy I. Create a copy of grapheme cluster string. Next position of new string is set at beginning. =back =head3 Sizes =over 4 =item chars I. Returns number of Unicode characters grapheme cluster string includes, i.e. length as Unicode string. =item columns I. Returns total number of columns of grapheme clusters defined by built-in character database. For more details see L. =item length I. Returns number of grapheme clusters contained in grapheme cluster string. =back =head3 Operations as String =over 4 =item as_string =item C<">OBJECTC<"> I. Convert grapheme cluster string to Unicode string explicitly. =item cmp (STRING) =item STRING C STRING I. Compare strings. There are no oddities. One of each STRING may be Unicode string. =item concat (STRING) =item STRING C<.> STRING I. Concatenate STRINGs. One of each STRING may be Unicode string. Note that number of columns (see columns()) or grapheme clusters (see length()) of resulting string is not always equal to sum of both strings. Next position of new string is that set on the left value. =item join ([STRING, ...]) I. Join STRINGs inserting grapheme cluster string. Any of STRINGs may be Unicode string. =item substr (OFFSET, [LENGTH, [REPLACEMENT]]) I. Returns substring of grapheme cluster string. OFFSET and LENGTH are based on grapheme clusters. If REPLACEMENT is specified, substring is replaced by it. REPLACEMENT may be Unicode string. Note: This method cannot return the lvalue, unlike built-in substr(). =back =head3 Operations as Sequence of Grapheme Clusters =over 4 =item as_array =item C<@{>OBJECTC<}> =item as_arrayref I. Convert grapheme cluster string to an array of grapheme clusters. =item eos I. Test if current position is at end of grapheme cluster string. =item item ([OFFSET]) I. Returns OFFSET-th grapheme cluster. If OFFSET was not specified, returns next grapheme cluster. =item next =item C>OBJECTC> I, iterative. Returns next grapheme cluster and increment next position. =item pos ([OFFSET]) I. If optional OFFSET is specified, set next position by it. Returns next position of grapheme cluster string. =back =begin comment =head4 Methods planned to be deprecated =over 4 =item flag ([OFFSET, [VALUE]]) I. Get or set flag value of OFFEST-th grapheme cluster. If OFFSET was not specified, returns flag value of next grapheme cluster. Flag value is an non-zero integer not greater than 255 and initially is 0. Predefined flags are: =over 4 =item Unicode::LineBreak::ALLOW_BEFORE Allow line breaking just before this grapheme cluster. =item Unicode::LineBreak::PROHIBIT_BEFORE Prohibit line breaking just before this grapheme cluster. =back =item lbclass