From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

KIMOTO / SPVM-Unicode-0.052 / lib / SPVM / Unicode.pm 

            

              
1
2
3
4
5
—
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

              
package SPVM::Unicode;
our $VERSION = "0.052";
1;
=encoding utf8
=head1 Name
SPVM::Unicode - Unicode Utilities
=head1 Description
Unicode class in L<SPVM> has methods for unicode utilities.
=head1 Usage
  use Unicode;
   
  my $string = "あいうえお";
  my $pos = 0;
  while ((my $uchar = Unicode->uchar($string, \$pos)) >= 0);
    # ...
  }
=head1 Class Methods
=head2 ERROR_INVALID_UTF8
C<static method INVALID_UTF8 : int ();>
Returns -2.
=head2 is_unicode_scalar_value
C<static method is_unicode_scalar_value : int ($code_point: int);>
If the code point $code_point is a Unicode scalar value, returns 1. Otherwise returns 0.
=head2 uchar
C<static method uchar : int ($string : string, $offset_ref : int*);>
Gets a Unicode codepoint by parsing UTF-8 string $string with the offset $$offset_ref  and proceed the offset to the next parsing posision.
If $$offset_ref is over the string length, returns -1.
If an invalid UTF-8 character is found, returns the value of L</"ERROR_INVALID_UTF8">.
=head2 uchar_to_utf8
C<static method uchar_to_utf8 : string ($unicode_code_point : int);>
Converts the Unicode codepoint $unicode_code_point to a UTF-8 character.
If the $unicode_code_point is invalid Unicode code point, returns undef.
=head2 utf8_to_utf16
C<static method utf8_to_utf16 : short[] ($string : string);>
Converts the UTF-8 string $string to a UTF-16 string, and returns it.
=head2 utf16_to_utf8
C<static method utf16_to_utf8 : string ($string : short[]);>
Converts the UTF-16 string $string to a UTF-8 string, and returns it.
=head2 utf32_to_utf16
C<static method utf32_to_utf16 : short[] ($string : int[]);>
Converts the UTF-32 string $string to a UTF-16 string, and returns it.
=head2 utf16_to_utf32
C<static method utf16_to_utf32 : int[] ($string : short[]);>
Converts the UTF-16 string $string to a UTF-32 string, and returns it.
=head1 Repository
L<SPVM::Unicode - Github|https://github.com/yuki-kimoto/SPVM-Unicode>
=head1 Copyright & License
Copyright (c) 2023 Yuki Kimoto
MIT License