keys: graphical representation of linux control keys

[sheet.git] / Shiar_Sheet / Keyboard.pm

diff --git a/Shiar_Sheet/Keyboard.pm b/Shiar_Sheet/Keyboard.pm
index 2b3cc8629e8033d0d818dfd008b6e7efafb16418..98c5a40a330a774e564464f4ceb005db21227ce0 100644 (file)
--- a/Shiar_Sheet/Keyboard.pm
+++ b/Shiar_Sheet/Keyboard.pm
@@ -6,7 +6,7 @@ use warnings;
 no  warnings 'uninitialized';  # save some useless checks for more legible code
 use Carp;
 
-our $VERSION = 'v2.05';
+our $VERSION = '2.07';
 
 my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
 my @rowdesc = qw(numeric top home bottom);
@@ -14,12 +14,12 @@ my %keyrows = do 'keys.inc.pl';
 # add first two cases of each row again with each char prepended by + (alt)
 push @$_, map { [map {"+$_"} @$_] } @$_[0,1] for map {@$_} values %keyrows;
 
-my %keytrans = qw(
-       ^@ NUL ^a SOH ^b STX ^c ETX  ^d EOT ^e ENQ ^f ACK ^g BEL
-       ^h BS  ^i tab ^j LF  ^k VT   ^l FF  ^m CR  ^n SO  ^o SI
-       ^p DLE ^q DC1 ^r DC2 ^s DC3  ^t DC4 ^u NAK ^v SYN ^w ETB
-       ^x CAN ^y EM  ^z SUB ^[ ESC  ^\ FS  ^] GS  ^^ RS  ^_ US
-       ^? DEL
+my %keytrans = (
+       '^h' => "\x{232B}", # BS
+       '^i' => "\x{21E5}", # TAB
+       '^m' => "\x{21B5}", # CR
+       '^?' => "\x{2326}", # DEL
+       '^[' => "\x{238B}", # ESC
 );
 
 sub new {
@@ -36,6 +36,9 @@ sub new {
                \%Shiar_Sheet::KeySigns::sign;
        };
 
+       $self->{showkeys} = $PLP::Script::showkeys;
+       $self->{style   } = $PLP::Script::style;
+
        bless $self, $class;
 }
 
@@ -86,6 +89,19 @@ sub keyunalias {
        return $self->keyunalias($keyinfo, $ancestry);
 }
 
+sub print_letter {
+       my $self = shift;
+       my ($key, $mode) = @_;
+
+       return if $key eq '^0';
+       return 'Esc' if $key eq "\e";
+       return $keytrans{$key} if defined $keytrans{$key};
+       my $html = $self->{def}{$mode}{lead} . escapehtml($key);
+          $html =~ s{\^(?=.)}{<small>^</small>};  # element around ctrl-identifier
+          $html =~ s{\+(?=.)}{<small>+</small>};  # meta
+       return $html;
+}
+
 sub print_key {
        my $self = shift;
        my ($mode, $key, $flags) = @_;
@@ -103,12 +119,9 @@ sub print_key {
                ($desc, $mnem) = split /\n/, $self->escapedesc($txt);
        }
 
-#      $key = $keytrans{$key} if defined $keytrans{$key};
-       my $keytxt = $key eq "\e" ? 'Esc' : $self->{def}{$mode}{lead} . escapehtml($key) if $key ne '^0';
+       my $keytxt = $self->print_letter($key, $mode);
           $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 =~ s{\+(?=.)}{<small>+</small>};  # meta
        my $keyhint = defined($mnem) && qq{ title="$mnem"};
           $keytxt  = "<b$keyhint>$keytxt</b>";
           $keytxt .= ' '.$desc if defined $desc;
@@ -125,11 +138,13 @@ sub print_key {
 
 sub print_rows {
        my $self = shift;
+       my ($rowsspec, $defrows) = @_;
+       $defrows ||= [2, 1, 0];
        my %moderows = (
-               -DEFAULT => !!@_ && $_[0] ne '' && split(/(?:\s*([^=\s]*)=\s*)/, shift),
+               -DEFAULT => defined $rowsspec && $rowsspec ne '' &&
+                       split(/\s* ([^=\s]*) = \s*/x, $rowsspec),
                # plus specific mode overrides prefixed by '='
        );
-       my $defrows = shift || [2, 1, 0];
        my @modes = sort keys %{ $self->{def} };
 
        print '<table id="rows" class="keys">'."\n\n";
@@ -140,8 +155,8 @@ sub print_rows {
                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};
+                               $row < 0 ? '1' : # top row (esc key) always unshifted
+                               $moderows{$basemode} // $moderows{-DEFAULT};
 
                for my $submode (@moderows ? @moderows : '') {
                        my $mode = $basemode . $submode;
@@ -183,11 +198,43 @@ sub print_legend {
        my $self = shift;
        my ($class, $flags) = @_;
 
-       print qq{\t\t<dl class="legend $class">\n};
+       say qq{\t\t<dl class="legend $class">};
        printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s'."\n",
                $_, map { $self->escapedesc($_) } @{ $self->{flag}->{$_} || ["($_)", '...'] }
        ) for @$flags;
-       print "\t\t</dl>";
+       say "\t\t</dl>";
+}
+
+sub print_legends {
+       my $self = shift;
+       my ($input) = @_;
+
+       say "<hr/>\n";
+       say '<div class="help">';
+
+       say "\t", '<div class="left">';
+       my @groups = sort grep {/^g\d/} keys %{ $self->{flag} };
+       $self->print_legend('legend-types', \@groups);
+       say "\t</div>\n";
+
+       say "\t", '<div class="right">';
+       my @attr = sort grep {!/^g\d/} keys %{ $self->{flag} };
+       $self->print_legend('legend-options', \@attr);
+       say '';
+
+       say "\t\t", '<ul class="legend legend-set">';
+
+       say "\t\t<li>keyboard <strong>map</strong> is ",
+               ($input->{map} ? 'set to ' : ''), "<em>$self->{map}</em>";
+       say "\t\t<li><strong>keys</strong> are ",
+               "<em>", ($self->{showkeys} ? 'always shown' : 'hidden if unassigned'), "</em>",
+               (!defined $self->{showkeys} && ' by default');
+       say "\t\t<li>default <strong>style</strong> is ",
+               (defined $input->{style} && 'set to '), "<em>$self->{style}</em>";
+
+       say "\t\t</ul>";
+       say "\t</div>\n";
+       say "</div>\n";
 }
 
 1;