1 package Shiar_Sheet::Keyboard;
5 no warnings 'uninitialized'; # save some useless checks for more legible code
8 our $VERSION = 'v2.01';
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 my $parent = (caller)[0]; # calling module
34 no strict 'refs'; # temporarily allow variable references
35 \%{ $parent.'::sign' }; # return %sign from parent
37 croak "%${parent}::sign not found" unless %$sign;
38 $self->{sign} = $sign;
47 return $self->{map} = $mapname if defined $keyrows{$mapname};
71 my ($key, $ancestry) = @_;
73 $key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
75 my $keyinfo = $self->{def}->{$mode}->{$key};
77 return unless defined $keyinfo;
78 return $keyinfo->[0] if ref $keyinfo;
79 return '' if $ancestry->{$key}++; # endless loop failsafe
80 return $self->keyunalias($keyinfo, $ancestry);
85 my ($mode, $key, $flags) = @_;
87 my $txt = $self->{key}->{$mode.$key};
88 my ($desc, $mnem) = defined $txt ? @$txt : ();
90 if (not defined $flags) {
91 $flags = $key eq '^0' ? 'ni' : 'no';
93 elsif (not ref $flags) { # alias
94 $desc = $self->{sign}->{alias} . $flags;
95 $flags = $self->keyunalias($flags) . ' alias';
101 # $key = $keytrans{$key} if defined $keytrans{$key};
102 my $keytxt = $self->{def}{$mode}{lead} . escapehtml($key) if $key ne '^0';
103 $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
104 $keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
105 $keytxt =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
106 $keytxt =~ s{\+(?=.)}{<small>+</small>}; # meta
107 my $keyhint = defined($mnem) && qq{ title="$mnem"};
108 $keytxt = "<b$keyhint>$keytxt</b>";
109 $keytxt .= ' '.$desc if defined $desc;
110 $keytxt = qq{<a href="/$1">$keytxt</a>} if $flags =~ s/ ?\blink(\S*)//;
111 my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{def}{$1} && sprintf(
112 ' onclick="setmode(%s)"',
113 $1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
115 $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
117 print qq{\t\t<li class="$flags"$onclick>$keytxt};
124 -DEFAULT => !@_ ? '' : split(/(?:\s*([^=\s]*)=\s*)/, shift),
125 # plus specific mode overrides prefixed by '='
127 my $defrows = shift || [2, 1, 0];
128 my @modes = sort keys %{ $self->{def} };
130 for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
131 my $keyrow = $keyrows{$self->{map}}->[$row];
133 print qq{<li class="row row$row"><ul>\n};
134 for my $basemode (@modes) {
135 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 printf "\t<li%s>", $basemode ne '' && sprintf(
150 ' class="%s"', 'mode mode' . escapeclass($basemode)
152 printf("<h3>%s<small>: %s</small></h3>\n", # XXX insert here to fix msie<=6
153 $self->{mode}->{$mode} || "mode $basemode",
154 "$rowdesc[$row] row $casedesc[$case]"
156 my $caseclass = 'keys';
157 $caseclass .= ' lead' if defined $modekeys->{lead}; # leading command key shown
158 $caseclass .= " $casedesc[$case]" if defined $casedesc[$case];
159 print qq{\t\t<ul class="$caseclass">\n};
160 $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
161 print qq{\t\t</ul>\n};
173 my ($class, $flags) = @_;
175 print qq{\t\t<dl class="legend $class">\n};
176 printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s'."\n",
177 $_, @{ $self->{flag}->{$_} || ["($_)", '...'] }
186 Shiar_Sheet::Keyboard - Output HTML for key sheets
190 our %sign = (alias => 'see: ');
192 my $keys = Shiar_Sheet::Keyboard({
200 'leada' => ['description', 'comments (on hover)'],
203 'lead' => 'mode description',
206 $keys->map('dvorak') or die "Keyboard map not found";
212 Used by http://sheet.shiar.nl to display keyboard sheets.
213 Assumes specific stylesheets and javascript from this site,
214 so probably not of much use elsewhere.
218 Mischa POSLAWSKY <perl@shiar.nl>
222 Licensed under the GNU Affero General Public License version 3.