no warnings 'uninitialized'; # save some useless checks for more legible code
use Carp;
-our $VERSION = 'v1.05';
+our $VERSION = 'v2.02';
my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
my @rowdesc = qw(numeric top home bottom);
);
sub new {
- my $self = shift;
- my ($keys) = @_;
+ my $class = shift;
+ my ($self) = @_;
+
+ croak 'Invalid keyboard definitions specified' unless ref $self eq 'HASH';
+ croak 'No key definitions specified' unless ref $self->{def} eq 'HASH';
+ $self->{map} ||= 'qwerty';
- croak 'Invalid key table specified' unless ref $keys eq 'HASH';
my $parent = (caller)[0]; # calling module
my $sign = do {
no strict 'refs'; # temporarily allow variable references
\%{ $parent.'::sign' }; # return %sign from parent
};
croak "%${parent}::sign not found" unless %$sign;
+ $self->{sign} = $sign;
- bless {sign => $sign, keys => $keys, map => 'qwerty'}, $self;
+ bless $self, $class;
}
sub map {
$key =~ s/(\S*?)(\+?\^?\S)($|\s.*)/$2/;
my $mode = $1;
- my $keyinfo = $self->{keys}->{$mode}->{$key};
+ my $keyinfo = $self->{def}->{$mode}->{$key};
- return [] unless defined $keyinfo;
- return $keyinfo if ref $keyinfo;
- return if $ancestry->{$key}++; # endless loop failsafe
+ return unless defined $keyinfo;
+ return $keyinfo->[0] if ref $keyinfo;
+ return '' if $ancestry->{$key}++; # endless loop failsafe
return $self->keyunalias($keyinfo, $ancestry);
}
sub print_key {
my $self = shift;
- my ($mode, $key, $keyinfo) = @_;
-
- $keyinfo = [ $self->{sign}->{alias}.$keyinfo, $self->keyunalias($keyinfo)->[1] . ' alias' ]
- if defined $keyinfo and not ref $keyinfo; # alias
- my ($desc, $flags, $mnem) = @$keyinfo if defined $keyinfo;
- defined $desc or $flags = $key eq '^0' ? 'ni' : 'no';
+ my ($mode, $key, $flags) = @_;
+
+ my $txt = $self->{key}->{$mode.$key};
+ my ($desc, $mnem) = defined $txt ? @$txt : ();
+
+ if (not defined $flags) {
+ $flags = $key eq '^0' ? 'ni' : 'no';
+ }
+ elsif (not ref $flags) { # alias
+ $desc = $self->{sign}->{alias} . $flags;
+ $flags = $self->keyunalias($flags) . ' alias';
+ }
+ else {
+ $flags = $flags->[0];
+ }
# $key = $keytrans{$key} if defined $keytrans{$key};
- my $keytxt = $mode . escapehtml($key) if $key ne '^0';
+ my $keytxt = $key eq "\e" ? 'Esc' : $self->{def}{$mode}{lead} . escapehtml($key) if $key ne '^0';
$keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//; # arguments
$keytxt .= "<small>$self->{sign}->{motion}</small>" if $flags =~ s/ ?\bargm\b//; # motion argument
$keytxt =~ s{\^(?=.)}{<small>^</small>}; # element around ctrl-identifier
$keytxt = "<b$keyhint>$keytxt</b>";
$keytxt .= ' '.$desc if defined $desc;
$keytxt = qq{<a href="/$1">$keytxt</a>} if $flags =~ s/ ?\blink(\S*)//;
- my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{keys}{$1} && sprintf(
+ my $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{def}{$1} && sprintf(
' onclick="setmode(%s)"',
$1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
);
# plus specific mode overrides prefixed by '='
);
my $defrows = shift || [2, 1, 0];
- my @modes = sort keys %{ $self->{keys} };
+ my @modes = sort keys %{ $self->{def} };
- for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
- my $keyrow = $keyrows{$self->{map}}->[$row];
+ for (my $row = -1; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
+ my $keyrow = $row < 0 ? [["\e"]] : $keyrows{$self->{map}}->[$row];
- print qq{<li class="row row$row"><ul>\n};
- for my $basemode (@modes) {
+ printf qq{<li class="row row%d"><ul>\n}, $row+1;
+ for my $basemode ($row < 0 ? '' : @modes) {
my @moderows = split /\s+/,
defined $moderows{$basemode} ? $moderows{$basemode} : $moderows{-DEFAULT};
my @caserows = $mode =~ s/(\d+)(?:-(\d+))?$//
? (map {$_ - 1} split //, $row == 0 && $2 || $1) # user override
: @$defrows; # default
- my $modekeys = $self->{keys}{$mode};
+ my $modekeys = $self->{def}{$mode};
for my $case (@caserows) {
my $keycase = $keyrow->[$case] or next;
printf "\t<li%s>", $basemode ne '' && sprintf(
' class="%s"', 'mode mode' . escapeclass($basemode)
);
- printf("<h3>%s<small>: %s</small></h3>\n", # XXX insert here to fix msie<=6
- $modekeys->{desc} || "mode $basemode",
+ printf('<h3>%s<small>: %s</small></h3>', # XXX insert here to fix msie<=6
+ $self->{mode}->{$mode} || "mode $basemode",
"$rowdesc[$row] row $casedesc[$case]"
- );
+ ) unless $row < 0;
+ print "\n";
my $caseclass = 'keys';
$caseclass .= ' lead' if defined $modekeys->{lead}; # leading command key shown
$caseclass .= " $casedesc[$case]" if defined $casedesc[$case];
print qq{\t\t<ul class="$caseclass">\n};
- $self->print_key($modekeys->{lead}, $_, $modekeys->{$_}) for @$keycase;
+ $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
print qq{\t\t</ul>\n};
} # case
} # row
}
+sub print_legend {
+ my $self = shift;
+ my ($class, $flags) = @_;
+
+ print qq{\t\t<dl class="legend $class">\n};
+ printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s'."\n",
+ $_, @{ $self->{flag}->{$_} || ["($_)", '...'] }
+ ) for @$flags;
+ print "\t\t</dl>";
+}
+
1;
=head1 NAME
our %sign = (alias => 'see: ');
my $keys = Shiar_Sheet::Keyboard({
- 'mode' => {
- desc => 'mode description',
- 'A' => 'a', # alias
- 'a' => ['description', 'classes', 'comments (on hover)'],
+ def => {
+ 'lead' => {
+ 'A' => 'a', # alias
+ 'a' => ['classes'],
+ },
+ },
+ key => {
+ 'leada' => ['description', 'comments (on hover)'],
+ },
+ mode => {
+ 'lead' => 'mode description',
},
});
$keys->map('dvorak') or die "Keyboard map not found";