1 package Shiar_Sheet::Keyboard;
5 no warnings 'uninitialized'; # save some useless checks for more legible code
8 our $VERSION = 'v1.04';
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 key table specified' unless ref $keys eq 'HASH';
29 my $parent = (caller)[0]; # calling module
31 no strict 'refs'; # temporarily allow variable references
32 \%{ $parent.'::sign' }; # return %sign from parent
34 croak "%${parent}::sign not found" unless %$sign;
36 bless {sign => $sign, keys => $keys, map => 'qwerty'}, $self;
43 return $self->{map} = $mapname if defined $keyrows{$mapname};
67 my ($key, $ancestry) = @_;
69 $key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
71 my $keyinfo = $self->{keys}->{$mode}->{$key};
73 return [] unless defined $keyinfo;
74 return $keyinfo if ref $keyinfo;
75 return if $ancestry->{$key}++; # endless loop failsafe
76 return $self->keyunalias($keyinfo, $ancestry);
81 my ($mode, $key, $keyinfo) = @_;
83 $keyinfo = [ $self->{sign}->{alias}.$keyinfo, $self->keyunalias($keyinfo)->[1] . ' alias' ]
84 if defined $keyinfo and not ref $keyinfo; # alias
85 my ($desc, $flags, $mnem) = @$keyinfo if defined $keyinfo;
86 defined $desc or $flags = $key eq '^0' ? 'ni' : 'no';
88 # $key = $keytrans{$key} if defined $keytrans{$key};
89 my $keytxt = $mode . escapehtml($key) if $key ne '^0';
90 $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
91 $keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
92 $keytxt =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
93 $keytxt =~ s{\+(?=.)}{<small>+</small>}; # meta
94 my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{keys}{$1} && sprintf(
95 ' onclick="setmode(%s)"',
96 $1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
98 $onclick .= sprintf(q{ onclick="document.location='%s'"}, $1)
99 if $flags =~ s/ ?\blink(\S*)//;
100 my $keyhint = defined($mnem) && qq{ title="$mnem"};
101 $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
103 print qq{\t\t<li class="$flags"$onclick><b$keyhint>$keytxt</b>};
104 print ' ', $desc if defined $desc;
111 -DEFAULT => !@_ ? '' : split(/(?:\s*([^=\s]*)=\s*)/, shift),
112 # plus specific mode overrides prefixed by '='
114 my $defrows = shift || [2, 1, 0];
115 my @modes = sort keys %{ $self->{keys} };
117 for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
118 my $keyrow = $keyrows{$self->{map}}->[$row];
120 print qq{<li class="row row$row"><ul>\n};
121 for my $basemode (@modes) {
122 my @moderows = split /\s+/,
123 defined $moderows{$basemode} ? $moderows{$basemode} : $moderows{-DEFAULT};
125 for my $submode (@moderows ? @moderows : '') {
126 my $mode = $basemode . $submode;
127 my @caserows = $mode =~ s/(\d+)(?:-(\d+))?$//
128 ? (map {$_ - 1} split //, $row == 0 && $2 || $1) # user override
129 : @$defrows; # default
130 my $modekeys = $self->{keys}{$mode};
132 for my $case (@caserows) {
133 my $keycase = $keyrow->[$case] or next;
136 printf "\t<li%s>", $basemode ne '' && sprintf(
137 ' class="%s"', 'mode mode' . escapeclass($basemode)
139 printf("<h3>%s<small>: %s</small></h3>\n", # XXX insert here to fix msie<=6
140 $modekeys->{desc} || "mode $basemode",
141 "$rowdesc[$row] row $casedesc[$case]"
143 my $caseclass = 'keys';
144 $caseclass .= ' lead' if defined $modekeys->{lead}; # leading command key shown
145 $caseclass .= " $casedesc[$case]" if defined $casedesc[$case];
146 print qq{\t\t<ul class="$caseclass">\n};
147 $self->print_key($modekeys->{lead}, $_, $modekeys->{$_}) for @$keycase;
148 print qq{\t\t</ul>\n};
162 Shiar_Sheet::Keyboard - Output HTML for key sheets
166 our %sign = (alias => 'see: ');
168 my $keys = Shiar_Sheet::Keyboard({
170 desc => 'mode description',
172 'a' => ['description', 'classes', 'comments (on hover)'],
175 $keys->map('dvorak') or die "Keyboard map not found";
181 Used by http://sheet.shiar.nl to display keyboard sheets.
182 Assumes specific stylesheets and javascript from this site,
183 so probably not of much use elsewhere.
187 Mischa POSLAWSKY <perl@shiar.nl>
191 Licensed under the GNU Affero General Public License version 3.