1 package Shiar_Sheet::Keyboard;
6 no warnings 'uninitialized'; # save some useless checks for more legible code
11 my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
12 my @rowdesc = qw(numeric top home bottom);
13 my %keyrows = do 'keys.inc.pl';
14 # add first two cases of each row again with each char prepended by + (alt)
15 push @$_, map { [map {"+$_"} @$_] } @$_[0,1] for map {@$_} values %keyrows;
18 '^h' => "\x{232B}", # BS
19 '^i' => "\x{21E5}", # TAB
20 '^m' => "\x{21B5}", # CR
21 '^?' => "\x{2326}", # DEL
22 '^[' => "\x{238B}", # ESC
29 croak 'Invalid keyboard definitions specified' unless ref $self eq 'HASH';
30 croak 'No key definitions specified' unless ref $self->{def} eq 'HASH';
31 $self->{map} ||= 'qwerty';
33 $self->{sign} ||= do {
34 require Shiar_Sheet::KeySigns;
35 Shiar_Sheet::KeySigns->VERSION(1.04);
36 \%Shiar_Sheet::KeySigns::sign;
39 $self->{showkeys} = $PLP::Script::showkeys;
40 $self->{style } = $PLP::Script::style;
49 return $self->{map} = $mapname if defined $keyrows{$mapname};
75 s{ (< ([^>]*) >) }{ $self->{sign}->{$2} // $1 }xeg;
81 my ($key, $ancestry) = @_;
83 $key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
85 my $keyinfo = $self->{def}->{$mode}->{$key};
87 return unless defined $keyinfo;
88 $keyinfo =~ s/^=// or return $keyinfo;
89 return '' if $ancestry->{$key}++; # endless loop failsafe
90 return $self->keyunalias($keyinfo, $ancestry);
95 my ($key, $mode) = @_;
97 return if $key eq '^0';
98 return 'Esc' if $key eq "\e";
99 return $keytrans{$key} if defined $keytrans{$key};
100 my $html = $self->{def}{$mode}{lead} . escapehtml($key);
101 $html =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
102 $html =~ s{\+(?=.)}{<small>+</small>}; # meta
108 my ($mode, $key, $flags) = @_;
111 if (not defined $flags) {
112 $flags = $key eq '^0' ? 'ni' : 'no';
114 elsif ($flags =~ s/^=(\S+)\s?//) { # alias
116 $desc = $self->{sign}->{alias} . ($ref eq "\e" ? 'esc' : $ref);
117 $flags = join ' ', $self->keyunalias($ref), 'alias', $flags;
119 if (my $txt = $self->{key}->{$mode.$key}) {
120 ($desc, $mnem) = split /\n/, $self->escapedesc($txt);
123 my $keytxt = $self->print_letter($key, $mode);
124 $keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
125 $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
126 my $keyhint = defined($mnem) && qq{ title="$mnem"};
127 $keytxt = "<b$keyhint>$keytxt</b>";
128 $keytxt .= ' '.$desc if defined $desc;
129 $keytxt = qq{<a href="/$1">$keytxt</a>} if $flags =~ s/ ?\blink(\S*)//;
130 my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{def}{$1} && sprintf(
131 ' onclick="setmode(%s)"',
132 $1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
134 $flags =~ s/\bx\w+/ext/;
135 $flags =~ s/\bv\d+/new/;
136 $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
138 print qq{\t\t<td class="$flags"$onclick>$keytxt};
144 my ($rowsspec, $defrows) = @_;
145 $defrows ||= [2, 1, 0];
147 -DEFAULT => defined $rowsspec && $rowsspec ne '' &&
148 split(/\s* ([^=\s]*) = \s*/x, $rowsspec),
149 # plus specific mode overrides prefixed by '='
151 my @modes = sort keys %{ $self->{def} };
153 printf '<table id="rows" class="%s">'."\n\n", $self->{tableclass} // 'keys';
156 for (my $row = -1; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
157 my $keyrow = $row < 0 ? [["\e"]] : $keyrows{$self->{map}}->[$row];
160 # defined $self->{def}->{''}->{$_} or defined $self->{def}->{g}->{$_}
161 # } map { @{$_} } @{$keyrow} or next;
163 printf qq{<tbody class="row row%d">\n}, $row+1;
164 for my $basemode (@modes) {
165 my @moderows = split /\s+/,
166 $row < 0 ? '1' : # top row (esc key) always unshifted
167 $moderows{$basemode} // $moderows{-DEFAULT};
169 for my $submode (@moderows ? @moderows : '') {
170 my $mode = $basemode . $submode;
171 my @caserows = $mode =~ s/(\d+)(?:-(\d*))?$//
172 ? (map {$_ - 1} split //, $row == 0 ? $2 // $1 : $1) # user override
173 : @$defrows; # default
174 my $modekeys = $self->{def}{$mode};
176 for my $case (@caserows) {
177 my $keycase = $keyrow->[$case] or next;
180 push @caseclass, 'mode', 'mode'.escapeclass($basemode) if $basemode ne '';
181 push @caseclass, 'lead' if defined $modekeys->{lead}; # leading command key shown
182 push @caseclass, $casedesc[$case] if defined $casedesc[$case];
184 printf "\t<tr%s>", @caseclass > 0 && sprintf(
185 ' class="%s"', join ' ', @caseclass
187 printf('<th>%s<small>: %s</small></th>', # XXX insert here to fix msie<=6
188 $self->escapedesc($self->{mode}->{$mode} || "mode $basemode"),
189 "$rowdesc[$row] row $casedesc[$case]"
192 $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
193 print qq{\t\t</tr>\n};
199 print qq{\t</tbody>\n};
207 my ($class, $flags) = @_;
209 say qq{\t\t<dl class="legend $class">};
210 printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s</dd>'."\n",
211 $_, map { $self->escapedesc($_) } @{ $self->{flag}->{$_} || ["($_)", '...'] }
220 Shiar_Sheet::Keyboard - Output HTML for key sheets
224 our %sign = (alias => 'see: ');
226 my $keys = Shiar_Sheet::Keyboard({
234 'leada' => ['description', 'comments (on hover)'],
237 'lead' => 'mode description',
240 $keys->map('dvorak') or die "Keyboard map not found";
246 Used by https://sheet.shiar.nl to display keyboard sheets.
247 Assumes specific stylesheets and javascript from this site,
248 so probably not of much use elsewhere.
252 Mischa POSLAWSKY <perl@shiar.nl>
256 Licensed under the GNU Affero General Public License version 3.