keys: structure keyboard as html table
[sheet.git] / Shiar_Sheet / Keyboard.pm
index 760733595c4d7cf2a0351613544d766e23d32b9b..adaa3ddab066b8ec67358d7d4bea4a2f47dab02b 100644 (file)
@@ -5,7 +5,7 @@ use warnings;
 no  warnings 'uninitialized';  # save some useless checks for more legible code
 use Carp;
 
-our $VERSION = 'v2.00';
+our $VERSION = 'v2.02';
 
 my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
 my @rowdesc = qw(numeric top home bottom);
@@ -84,22 +84,21 @@ sub print_key {
        my $self = shift;
        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';
+               $flags = [$key eq '^0' ? 'ni' : 'no'];
        }
        elsif (not ref $flags) { # alias
-               $desc = $self->{sign}->{alias} . $flags;
-               $flags = $self->keyunalias($flags) . ' alias';
+               my $desc = $self->{sign}->{alias};
+               $desc .= $flags eq "\e" ? 'esc' : $flags;
+               $flags = [$self->keyunalias($flags) . ' alias', $desc];
        }
-       else {
-               $flags = $flags->[0];
+       my ($flags, $desc, $mnem) = @{$flags};
+       if (my $txt = $self->{key}->{$mode.$key}) {
+               ($desc, $mnem) = @{$txt};
        }
 
 #      $key = $keytrans{$key} if defined $keytrans{$key};
-       my $keytxt = $self->{def}{$mode}{lead} . 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
@@ -114,7 +113,7 @@ sub print_key {
        );
        $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
 
-       print qq{\t\t<li class="$flags"$onclick>$keytxt};
+       print qq{\t\t<td class="$flags"$onclick>$keytxt};
        print "\n";
 }
 
@@ -127,12 +126,15 @@ sub print_rows {
        my $defrows = shift || [2, 1, 0];
        my @modes = sort keys %{ $self->{def} };
 
-       for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
-               my $keyrow = $keyrows{$self->{map}}->[$row];
+       print '<table id="rows" class="keys">'."\n\n";
+
+       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};
+               printf qq{<tbody class="row row%d">\n}, $row+1;
                for my $basemode (@modes) {
                        my @moderows = split /\s+/,
+                               $row < 0 ? "0" :
                                defined $moderows{$basemode} ? $moderows{$basemode} : $moderows{-DEFAULT};
 
                for my $submode (@moderows ? @moderows : '') {
@@ -145,27 +147,41 @@ sub print_rows {
                        for my $case (@caserows) {
                                my $keycase = $keyrow->[$case] or next;
                                  @$keycase or next;
+                               my @caseclass;
+                               push @caseclass, 'mode', 'mode'.escapeclass($basemode) if $basemode ne '';
+                               push @caseclass, 'lead' if defined $modekeys->{lead};  # leading command key shown
+                               push @caseclass, $casedesc[$case] if defined $casedesc[$case];
 
-                               printf "\t<li%s>", $basemode ne '' && sprintf(
-                                       ' class="%s"', 'mode mode' . escapeclass($basemode)
+                               printf "\t<tr%s>", @caseclass > 0 && sprintf(
+                                       ' class="%s"', join ' ', @caseclass
                                );
-                               printf("<h3>%s<small>: %s</small></h3>\n", # XXX insert &nbsp; here to fix msie<=6
+                               printf('<th>%s<small>: %s</small></th>', # XXX insert &nbsp; here to fix msie<=6
                                                $self->{mode}->{$mode} || "mode $basemode",
                                                "$rowdesc[$row] row $casedesc[$case]"
-                               );
-                               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};
+                               ) unless $row < 0;
+                               print "\n";
                                $self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
-                               print qq{\t\t</ul>\n};
+                               print qq{\t\t</tr>\n};
                        } # case
 
                } # submode
 
                } # basemode
-               print qq{\t</ul>\n};
+               print qq{\t</tbody>\n};
        } # row
+
+       print "</table>\n";
+}
+
+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;