1 package Shiar_Sheet::Keyboard;
5 no warnings 'uninitialized'; # save some useless checks for more legible code
8 our $VERSION = 'v2.03';
10 my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
11 my @rowdesc = qw(numeric top home bottom);
12 my %keyrows = do 'keys.inc.pl';
13 # add first two cases of each row again with each char prepended by + (alt)
14 push @$_, map { [map {"+$_"} @$_] } @$_[0,1] for map {@$_} values %keyrows;
17 ^@ NUL ^a SOH ^b STX ^c ETX ^d EOT ^e ENQ ^f ACK ^g BEL
18 ^h BS ^i tab ^j LF ^k VT ^l FF ^m CR ^n SO ^o SI
19 ^p DLE ^q DC1 ^r DC2 ^s DC3 ^t DC4 ^u NAK ^v SYN ^w ETB
20 ^x CAN ^y EM ^z SUB ^[ ESC ^\ FS ^] GS ^^ RS ^_ US
28 croak 'Invalid keyboard definitions specified' unless ref $self eq 'HASH';
29 croak 'No key definitions specified' unless ref $self->{def} eq 'HASH';
30 $self->{map} ||= 'qwerty';
32 $self->{sign} ||= do {
33 require Shiar_Sheet::KeySigns;
34 Shiar_Sheet::KeySigns->VERSION(1.03);
35 \%Shiar_Sheet::KeySigns::sign;
45 return $self->{map} = $mapname if defined $keyrows{$mapname};
69 my ($key, $ancestry) = @_;
71 $key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
73 my $keyinfo = $self->{def}->{$mode}->{$key};
75 return unless defined $keyinfo;
76 return $keyinfo->[0] if ref $keyinfo;
77 return '' if $ancestry->{$key}++; # endless loop failsafe
78 return $self->keyunalias($keyinfo, $ancestry);
83 my ($mode, $key, $flags) = @_;
85 if (not defined $flags) {
86 $flags = [$key eq '^0' ? 'ni' : 'no'];
88 elsif (not ref $flags) { # alias
89 my $desc = $self->{sign}->{alias};
90 $desc .= $flags eq "\e" ? 'esc' : $flags;
91 $flags = [$self->keyunalias($flags) . ' alias', $desc];
93 my ($flags, $desc, $mnem) = @{$flags};
94 if (my $txt = $self->{key}->{$mode.$key}) {
95 ($desc, $mnem) = split /\n/, $txt;
98 # $key = $keytrans{$key} if defined $keytrans{$key};
99 my $keytxt = $key eq "\e" ? 'Esc' : $self->{def}{$mode}{lead} . escapehtml($key) if $key ne '^0';
100 $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
101 $keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
102 $keytxt =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
103 $keytxt =~ s{\+(?=.)}{<small>+</small>}; # meta
104 my $keyhint = defined($mnem) && qq{ title="$mnem"};
105 $keytxt = "<b$keyhint>$keytxt</b>";
106 $keytxt .= ' '.$desc if defined $desc;
107 $keytxt = qq{<a href="/$1">$keytxt</a>} if $flags =~ s/ ?\blink(\S*)//;
108 my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{def}{$1} && sprintf(
109 ' onclick="setmode(%s)"',
110 $1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
112 $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
114 print qq{\t\t<td class="$flags"$onclick>$keytxt};
121 -DEFAULT => !@_ ? '' : split(/(?:\s*([^=\s]*)=\s*)/, shift),
122 # plus specific mode overrides prefixed by '='
124 my $defrows = shift || [2, 1, 0];
125 my @modes = sort keys %{ $self->{def} };
127 print '<table id="rows" class="keys">'."\n\n";
129 for (my $row = -1; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
130 my $keyrow = $row < 0 ? [["\e"]] : $keyrows{$self->{map}}->[$row];
132 printf qq{<tbody class="row row%d">\n}, $row+1;
133 for my $basemode (@modes) {
134 my @moderows = split /\s+/,
136 defined $moderows{$basemode} ? $moderows{$basemode} : $moderows{-DEFAULT};
138 for my $submode (@moderows ? @moderows : '') {
139 my $mode = $basemode . $submode;
140 my @caserows = $mode =~ s/(\d+)(?:-(\d+))?$//
141 ? (map {$_ - 1} split //, $row == 0 && $2 || $1) # user override
142 : @$defrows; # default
143 my $modekeys = $self->{def}{$mode};
145 for my $case (@caserows) {
146 my $keycase = $keyrow->[$case] or next;
149 push @caseclass, 'mode', 'mode'.escapeclass($basemode) if $basemode ne '';
150 push @caseclass, 'lead' if defined $modekeys->{lead}; # leading command key shown
151 push @caseclass, $casedesc[$case] if defined $casedesc[$case];
153 printf "\t<tr%s>", @caseclass > 0 && sprintf(
154 ' class="%s"', join ' ', @caseclass
156 printf('<th>%s<small>: %s</small></th>', # XXX insert here to fix msie<=6
157 $self->{mode}->{$mode} || "mode $basemode",
158 "$rowdesc[$row] row $casedesc[$case]"
161 $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
162 print qq{\t\t</tr>\n};
168 print qq{\t</tbody>\n};
176 my ($class, $flags) = @_;
178 print qq{\t\t<dl class="legend $class">\n};
179 printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s'."\n",
180 $_, @{ $self->{flag}->{$_} || ["($_)", '...'] }
189 Shiar_Sheet::Keyboard - Output HTML for key sheets
193 our %sign = (alias => 'see: ');
195 my $keys = Shiar_Sheet::Keyboard({
203 'leada' => ['description', 'comments (on hover)'],
206 'lead' => 'mode description',
209 $keys->map('dvorak') or die "Keyboard map not found";
215 Used by http://sheet.shiar.nl to display keyboard sheets.
216 Assumes specific stylesheets and javascript from this site,
217 so probably not of much use elsewhere.
221 Mischa POSLAWSKY <perl@shiar.nl>
225 Licensed under the GNU Affero General Public License version 3.