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};
74 s{ (< ([^>]*) >) }{ $self->{sign}->{$2} // $1 }xeg;
80 my ($key, $ancestry) = @_;
82 $key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
84 my $keyinfo = $self->{def}->{$mode}->{$key};
86 return unless defined $keyinfo;
87 $keyinfo =~ s/^=// or return $keyinfo;
88 return '' if $ancestry->{$key}++; # endless loop failsafe
89 return $self->keyunalias($keyinfo, $ancestry);
94 my ($key, $mode) = @_;
96 return if $key eq '^0';
97 return 'Esc' if $key eq "\e";
98 return $keytrans{$key} if defined $keytrans{$key};
99 my $html = $self->{def}{$mode}{lead} . escapehtml($key);
100 $html =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
101 $html =~ s{\+(?=.)}{<small>+</small>}; # meta
107 my ($mode, $key, $flags) = @_;
110 if (not defined $flags) {
111 $flags = $key eq '^0' ? 'ni' : 'no';
113 elsif ($flags =~ s/^=//) { # alias
114 $desc = $self->{sign}->{alias};
115 $desc .= $flags eq "\e" ? 'esc' : $flags;
116 $flags = $self->keyunalias($flags) . ' alias';
118 if (my $txt = $self->{key}->{$mode.$key}) {
119 ($desc, $mnem) = split /\n/, $self->escapedesc($txt);
122 my $keytxt = $self->print_letter($key, $mode);
123 $keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
124 $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
125 my $keyhint = defined($mnem) && qq{ title="$mnem"};
126 $keytxt = "<b$keyhint>$keytxt</b>";
127 $keytxt .= ' '.$desc if defined $desc;
128 $keytxt = qq{<a href="/$1">$keytxt</a>} if $flags =~ s/ ?\blink(\S*)//;
129 my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{def}{$1} && sprintf(
130 ' onclick="setmode(%s)"',
131 $1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
133 $flags =~ s/\bx\w+/ext/;
134 $flags =~ s/\bv\d+/new/;
135 $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
137 print qq{\t\t<td class="$flags"$onclick>$keytxt};
143 my ($rowsspec, $defrows) = @_;
144 $defrows ||= [2, 1, 0];
146 -DEFAULT => defined $rowsspec && $rowsspec ne '' &&
147 split(/\s* ([^=\s]*) = \s*/x, $rowsspec),
148 # plus specific mode overrides prefixed by '='
150 my @modes = sort keys %{ $self->{def} };
152 print '<table id="rows" class="keys">'."\n\n";
154 for (my $row = -1; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
155 my $keyrow = $row < 0 ? [["\e"]] : $keyrows{$self->{map}}->[$row];
157 printf qq{<tbody class="row row%d">\n}, $row+1;
158 for my $basemode (@modes) {
159 my @moderows = split /\s+/,
160 $row < 0 ? '1' : # top row (esc key) always unshifted
161 $moderows{$basemode} // $moderows{-DEFAULT};
163 for my $submode (@moderows ? @moderows : '') {
164 my $mode = $basemode . $submode;
165 my @caserows = $mode =~ s/(\d+)(?:-(\d+))?$//
166 ? (map {$_ - 1} split //, $row == 0 && $2 || $1) # user override
167 : @$defrows; # default
168 my $modekeys = $self->{def}{$mode};
170 for my $case (@caserows) {
171 my $keycase = $keyrow->[$case] or next;
174 push @caseclass, 'mode', 'mode'.escapeclass($basemode) if $basemode ne '';
175 push @caseclass, 'lead' if defined $modekeys->{lead}; # leading command key shown
176 push @caseclass, $casedesc[$case] if defined $casedesc[$case];
178 printf "\t<tr%s>", @caseclass > 0 && sprintf(
179 ' class="%s"', join ' ', @caseclass
181 printf('<th>%s<small>: %s</small></th>', # XXX insert here to fix msie<=6
182 $self->escapedesc($self->{mode}->{$mode} || "mode $basemode"),
183 "$rowdesc[$row] row $casedesc[$case]"
186 $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
187 print qq{\t\t</tr>\n};
193 print qq{\t</tbody>\n};
201 my ($class, $flags) = @_;
203 say qq{\t\t<dl class="legend $class">};
204 printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s'."\n",
205 $_, map { $self->escapedesc($_) } @{ $self->{flag}->{$_} || ["($_)", '...'] }
215 say '<div class="help">';
217 say "\t", '<div class="left">';
218 my @groups = sort grep {/^g\d/} keys %{ $self->{flag} };
219 $self->print_legend('legend-types', \@groups);
222 say "\t", '<div class="right">';
223 my @attr = sort grep {!/^g\d/} keys %{ $self->{flag} };
224 $self->print_legend('legend-options', \@attr);
227 say "\t\t", '<ul class="legend legend-set">';
229 say "\t\t<li>keyboard <strong>map</strong> is ",
230 ($input->{map} ? 'set to ' : ''), "<em>$self->{map}</em>";
231 say "\t\t<li><strong>keys</strong> are ",
232 "<em>", ($self->{showkeys} ? 'always shown' : 'hidden if unassigned'), "</em>",
233 (!defined $self->{showkeys} && ' by default');
234 say "\t\t<li>default <strong>style</strong> is ",
235 (defined $input->{style} && 'set to '), "<em>$self->{style}</em>";
246 Shiar_Sheet::Keyboard - Output HTML for key sheets
250 our %sign = (alias => 'see: ');
252 my $keys = Shiar_Sheet::Keyboard({
260 'leada' => ['description', 'comments (on hover)'],
263 'lead' => 'mode description',
266 $keys->map('dvorak') or die "Keyboard map not found";
272 Used by http://sheet.shiar.nl to display keyboard sheets.
273 Assumes specific stylesheets and javascript from this site,
274 so probably not of much use elsewhere.
278 Mischa POSLAWSKY <perl@shiar.nl>
282 Licensed under the GNU Affero General Public License version 3.