charset: inline symbol character tables
[sheet.git] / charset.plp
1 <(common.inc.plp)><:
2
3 my $mode = exists $get{compare};
4 my @tablist = split m{/+}, $Request || 'default';
5
6 Html({
7         title => 'charset cheat sheet',
8         version => '1.0',
9         description => [
10                 "Reference sheet with all glyphs in common character encoding tables,",
11                 "and an overview of Unicode ranges and UTF-8 bytes.",
12         ],
13         keywords => [qw'
14                 charset codepage unicode ascii utf8 latin glyph character encoding
15                 reference common overview table
16         '],
17         stylesheet => [qw'light'],
18         data => [qw(
19                 charset-encoding.inc.pl
20                 charset-unicode.inc.pl charset-ucplanes.inc.pl charset-utf8.inc.pl
21         )],
22 });
23
24 use List::Util qw( first pairmap pairfirst pairs );
25
26 :>
27 <h1>Character encodings</h1>
28
29 <p>
30 <:
31 if ($tablist[0] eq 'default') {
32         say "Overview of Unicode allocation and common latin code pages.";
33         say "Compare alternate charsets:";
34 }
35 else {
36         say "Charset comparison:";
37 }
38
39 sub optionlink {
40         my ($title, $href, $selected) = @_;
41         return sprintf(
42                 $selected ? '<strong>%s</strong>' : '<a href="%2$s">%s</a>',
43                 EscapeHTML($title), $href
44         );
45 }
46
47 print join " •\n", (
48         map {
49                 join " ·\n", pairmap {
50                         optionlink($b || ucfirst $a, '/charset'.($a && "/$a?compare"), $a eq $Request);
51                 } @{$_}
52         }
53         [
54                 iso      => 'ISO',
55                 win      => 'Windows',
56                 dos      => 'DOS',
57                 mac      => 'Apple',
58                 ebcdic   => 'EBCDIC',
59                 $tablist[0] eq 'default' ? () : ('' => 'common'),
60         ],
61         [
62                 westeur  => 'West',
63                 centeur  => 'Central',
64                 norteur  => 'North European',
65                 turkish  => 0,
66                 greek    => 0,
67                 cyrillic => 0,
68                 hebrew   => 0,
69         ],
70 );
71 :>.
72 </p>
73
74 <:
75 use POSIX qw( ceil );
76 use Shiar_Sheet::FormatChar;
77 my $glyphs = Shiar_Sheet::FormatChar->new;
78 my @request;
79
80 my $charsets = do 'charset-encoding.inc.pl'
81         or Alert('Encoding metadata could not be read', $@ || $!);
82
83 sub tabinput {
84         # generate character table(s)
85         my $input = shift or return;
86         my $params = $input =~ s/[+](.*)\z// ? $1 : undef;
87         my $charset = $charsets->{lc $input} || {};
88
89         if (ref $charset ne 'HASH') {
90                 $params and Alert("Parameters ignored for $input",
91                         "Cannot apply <q>$params</q> to multiple charsets.",
92                 );
93                 tabinput($_) for ref $charset ? @{$charset} : $charset;
94                 return;
95         }
96
97         state $visible = {'' => 1};  # all present tables
98         my %row = (offset => 0, cols => 16);
99
100         if (not defined $params) {
101                 my @parents = @{ $charset->{inherit} || [] };
102
103                 if (my ($parent, $part) = pairfirst { defined $visible->{$a} } @parents) {
104                         $row{parent} = $parent;
105                         $params = $part;
106                         $params = 80 unless $visible->{$parent}
107                                 or ($input eq 'MacCroatian' and defined $visible->{MacRomanian});
108                 }
109                 elsif (defined $visible->{ascii}) {
110                         $row{parent} = $parents[0];
111                         $params = $parents[1] // 80;
112                         $params = 80 if hex $params >= 0x80;  # ascii offset at most
113                 }
114                 elsif (@parents) {
115                         $row{parent} = $parents[0];
116                         $params = $parents[1] if hex $parents[1] == 0;  # apply ascii end
117                 }
118                 $visible->{$_} //= 0 for $row{parent} || ();
119         }
120
121         for my $param (split /[+]+/, $params // '') {
122                 if ($param eq 'realsize') {
123                         $row{realsize}++;
124                 }
125                 elsif ($param =~ m{ \A cols = (\d+) \z }x) {
126                         $row{cols} = $1;
127                 }
128                 elsif ($param =~ m{ \A (?<start> \p{AHex}+) (?: [-] (?<end> \p{AHex}+) )? \z }x) {
129                         if (defined $row{endpoint}) {
130                                 # extend earlier range
131                                 my $skip = int(($row{endpoint} || $row{startpoint}) / $row{cols});
132                                 for ($skip + 1 .. (hex($+{start}) / $row{cols}) - 1) {
133                                         $row{skip}->{ $_ * $row{cols} - $row{startpoint} }++;
134                                 }
135                         }
136                         else {
137                                 $row{startpoint} = hex $+{start};
138                         }
139                         $row{endpoint} = hex($+{end} || 0);
140                 }
141                 else {
142                         Alert("Unknown option <q>$param</q> for charset $input");
143                 }
144         }
145
146         if ($charset->{setup}) {
147                 eval { $charset->{setup}->(\%row) }
148                         or Alert("Incomplete setup of $input", $@);
149         }
150         $row{endpoint} ||= 0xFF;
151
152         if (defined $row{table} or defined $row{cell}) {
153                 $row{set} //= $input;
154         }
155         elsif ($row{set} = Encode::resolve_alias($input)) {
156                 $row{offset} = delete $row{startpoint};
157                 if ($charset->{varchar}) {
158                         # array of possibly multiple characters per code point
159                         $row{table} = [
160                                 map { Encode::decode($row{set}, pack 'C*', $_) } $row{offset} .. $row{endpoint}
161                         ];
162                 }
163                 else {
164                         # ~16x faster than decoding in loop;
165                         # substr strings is twice as fast as splitting to an array
166                         $row{table} = Encode::decode($row{set}, pack 'C*', $row{offset} .. $row{endpoint});
167                 }
168
169                 $row{endpoint} -= $row{offset};
170                 $visible->{ascii}++;  # assume common base
171         }
172         else {
173                 Alert("Encoding <q>$input</q> unknown");
174                 return;
175         }
176
177         if (my $replace = $charset->{replace}) {
178                 while (my ($offset, $sub) = each %{$replace}) {
179                         $offset -= $row{offset};
180
181                         if (ref $row{table} eq 'ARRAY') {
182                                 $row{table}->[$offset] = $sub
183                                         if $offset >= 0 and $offset <= $row{endpoint};
184                                 next;
185                         }
186
187                         my $length = length $sub;
188
189                         if ($offset < 0) {
190                                 $offset > -$length or next; # at least one character after start
191                                 # trim leftmost part to start at offset
192                                 substr($sub, 0, -$offset) = '';
193                                 $length += $offset;
194                                 $offset = 0;
195                         }
196
197                         if ((my $excess = $row{endpoint} - $offset - $length + 1) < 0) {
198                                 $excess > -$length or next;
199                                 # trim rightmost part to prevent overflow
200                                 substr($sub, $excess) = '';
201                                 $length += $excess;
202                         }
203
204                         substr($row{table}, $offset, $length) = $sub;
205                 }
206         }
207
208         push @request, \%row;
209         $visible->{ $row{set} } = 1 if $row{table};
210 }
211 tabinput($_) for @tablist;
212
213 my $NOCHAR = chr 0xFFFD;
214
215 sub range_cell {
216         my ($info, $offset) = @_;
217         my $table = $info->{cell} or return;
218         my $def = $table->{$offset} or return;
219         my ($len, $class, $name, $title) = @{$def};
220
221         my $cols = $info->{cols};
222         my $colsize = $table->{colsize} || 1;
223         my $attr = '';
224         $len /= $colsize;
225         $name //= $len <= 2 ? 'res' : 'reserved';
226
227         if (my $part = ($offset/$colsize - $info->{startpoint}) % $cols) {
228                 # continued row
229                 my $rest = $cols - $part;  # remaining
230                 $rest = $len if $len < $rest; #TODO: optimise
231                 if ($len -= $rest) {
232                         # continued on new row
233                         my @next = ($len * $colsize, "$class joinu");
234                         my $separate = $cols - $len > $rest;  # columns not on next row
235                         if ($len > $rest) {
236                                 # minority remains
237                                 push @next, $name, $title;
238                                 $title ||= $name;
239                                 $name = $separate && '…';
240                         }
241                         else {
242                                 # minority on next row
243                                 push @next, $separate && '"', $title || $name;
244                         }
245                         $table->{$offset + $colsize*$rest} //= \@next;
246                         $class .= ' joind';
247                 }
248                 $len = $rest;
249         }
250         elsif (my $rows = int($len / $cols)) {
251                 # multiple full rows
252                 my $rowsize = $colsize * $cols;
253                 if ($len -= $rows * $cols) {
254                         # partial row remains
255                         $table->{$offset + $rowsize * $rows} //= [$len*$colsize, "$class joinu", '', $title];
256                         $class .= ' joind';
257                 }
258
259                 unless ($info->{realsize}) {
260                         # coalesce multiple rows
261                         while ($rows > 3) {
262                                 $info->{skip}->{$offset += $rowsize}++;
263                                 $rows--;
264                         }
265                         if ($rows > 2) {
266                                 $info->{skip}->{$offset += $rowsize} = 0;
267                         }
268                 }
269
270                 $attr .= sprintf ' rowspan=%d', $rows;
271                 $len = $cols;
272         }
273
274         $attr .= sprintf ' colspan=%d', $len unless $len == 1;
275         $attr .= $1 if $class and $class =~ s/( \w+="[^"]*")//;
276         $attr .= sprintf ' class="%s"', $class if $class;
277         $attr .= sprintf ' title="%s"', EscapeHTML($title) if $title;
278         return "<td$attr>$name\n";
279 }
280
281 for my $row (@request) {
282         my $cols = $row->{cols};
283         my $colsize = $row->{cell} && $row->{cell}->{colsize} || 1;
284         my $coldigits = ceil(log($colsize * $cols) / log(16));  # uniform length of hexadecimal header
285         my $rowdiv = 16 ** $coldigits;  # row divide for column digits
286         $rowdiv = 1 if $rowdiv != $cols * $colsize;  # divide only if all columns are matched
287         my $offset = $row->{startpoint} * $colsize || 0;
288
289         printf '<div class="section"><table class="glyphs%s">', !$row->{cell} && ' charmap';
290         my $title = $row->{set};
291         $title .= " <aside>(over $_)</aside>"
292                 for $row->{parent} || ();
293         printf '<caption>%s</caption>', $title;
294         print '<col>' x ($cols + 1);
295         for my $section (qw{thead}) {
296                 print "<$section><tr><th>", $rowdiv == 1 ? '+' : '↱';
297                 printf '<th>%0*X', $coldigits, $_ * $colsize for 0 .. $cols - 1;
298                 print "\n";
299         }
300
301         print '<tbody>';
302         while ($offset <= $row->{endpoint} * $colsize) {
303                 if ($row->{skip}->{$offset}) {
304                         $offset += $cols * $colsize;
305                         next;
306                 }
307
308                 print '<tr><th>';
309                 if (defined $row->{skip}->{$offset}) {
310                         print '⋮';
311                 }
312                 else {
313                         if (my $rowmod = $offset % $rowdiv) {
314                                 # offset in column units
315                                 printf '<small>+%X</small>', $rowmod;
316                         }
317                         else {
318                                 # divided row offset
319                                 printf '%X', ($offset + $row->{offset}) / $rowdiv;
320                         }
321                 }
322                 say '';
323
324                 for (1 .. $cols) {
325                         if ($row->{cell}) {
326                                 print range_cell($row, $offset);
327                                 next;
328                         }
329
330                         my $cp = $offset + $row->{offset};
331                         my $glyph = ref $row->{table} eq 'ARRAY' ? $row->{table}->[$offset] :
332                                 substr $row->{table}, $offset, 1;
333                         my ($cell, $name, $class) = !defined $glyph || $glyph eq $NOCHAR ? () :
334                                 $glyphs->glyph_html($glyph);
335
336                         if ($mode) {
337                                 state $visible = {};
338                                 $class = (
339                                         $cp == ord $glyph ? 'l4' :
340                                         $row->{parent} && $glyph eq
341                                                 Encode::decode($row->{parent}, pack 'C', $cp) ? 'l3' :
342                                         !$class ? undef :
343                                         $visible->{$glyph} ? 'l2' :
344                                         'l1'
345                                 );
346                                 $visible->{$glyph}++;
347                         }
348
349                         say sprintf $class ? '<td title="%s" class="X %s">%s' : '<td title="%s">',
350                                 $name, $class, $cell;
351                 }
352                 continue {
353                         $offset += $colsize;
354                 }
355         }
356         say '</table></div>';
357 }
358
359 :>
360 <hr>
361
362 <div class="legend">
363         <table class="glyphs"><tr><: if ($mode) { :>
364         <td class="X l4">unicode
365         <td class="X l3">inherited
366         <td class="X l2">existing
367         <td class="X l1">original
368         <td class="">unassigned
369 <: } else { :>
370         <td class="X Cc">control
371         <td class="X Zs"><span>whitespace</span>
372         <td class="X Mn">diacritic<table class="glyphs"><tr>
373                 <td class="X Sk">letter
374                 </table>
375         <td class="X Po">punctuation<table class="glyphs"><tr>
376                 <td class="X Pf">quote
377                 </table>
378         <td class="X So">symbol<table class="glyphs"><tr>
379                 <td class="X Sm">math
380                 <td class="X Sc">currency
381                 </table>
382         <td class="X No">numeric
383         <td class="X Greek">greek<table class="glyphs"><tr>
384                 <td class="X Latin">latin
385                 <td class="X Cyrillic">cyrillic
386                 </table>
387         <td class="X Aramaic">aramaic<table class="glyphs"><tr>
388                 <td class="X Brahmic">brahmic
389                 <td class="X Arabic">arabic
390                 </table>
391         <td class="X Syllabic">syllabic<table class="glyphs"><tr>
392                 <td class="X African">african
393                 <td class="X Hiragana">japanese
394                 <td class="X Han">cjk
395                 <td class="X Bopomofo">chinese
396                 </table>
397         <td class="X Alpha">alphabetic
398         </table>
399
400         <table class="glyphs"><tr>
401         <td class="X">unicode 7.0
402         <td class="X Xr">proposed
403         <td class="X Xd">deprecated
404         <td class="">unassigned
405         <td class="X Xi">invalid
406 <: } :> </table>
407 </div>
408