X-Git-Url: http://git.shiar.nl/sheet.git/blobdiff_plain/b9115db06de9eb679d3cd040356e3103b0bcfa86..32a6cc3086f1c4ff99aadd88c976fe854a3fd826:/Shiar_Sheet/Keyboard.pm diff --git a/Shiar_Sheet/Keyboard.pm b/Shiar_Sheet/Keyboard.pm index 7713009..98c5a40 100644 --- a/Shiar_Sheet/Keyboard.pm +++ b/Shiar_Sheet/Keyboard.pm @@ -1,11 +1,12 @@ package Shiar_Sheet::Keyboard; +use 5.010; use strict; use warnings; no warnings 'uninitialized'; # save some useless checks for more legible code use Carp; -our $VERSION = 'v2.01'; +our $VERSION = '2.07'; my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta'); my @rowdesc = qw(numeric top home bottom); @@ -13,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 { @@ -29,13 +30,14 @@ sub new { croak 'No key definitions specified' unless ref $self->{def} eq 'HASH'; $self->{map} ||= 'qwerty'; - my $parent = (caller)[0]; # calling module - my $sign = do { - no strict 'refs'; # temporarily allow variable references - \%{ $parent.'::sign' }; # return %sign from parent + $self->{sign} ||= do { + require Shiar_Sheet::KeySigns; + Shiar_Sheet::KeySigns->VERSION(1.04); + \%Shiar_Sheet::KeySigns::sign; }; - croak "%${parent}::sign not found" unless %$sign; - $self->{sign} = $sign; + + $self->{showkeys} = $PLP::Script::showkeys; + $self->{style } = $PLP::Script::style; bless $self, $class; } @@ -66,6 +68,13 @@ sub escapehtml { return $_; } +sub escapedesc { + my $self = shift; + local $_ = shift; + s{ (< ([^>]*) >) }{ $self->{sign}->{$2} // $1 }xeg; + return $_; +} + sub keyunalias { my $self = shift; my ($key, $ancestry) = @_; @@ -75,35 +84,44 @@ sub keyunalias { my $keyinfo = $self->{def}->{$mode}->{$key}; return unless defined $keyinfo; - return $keyinfo->[0] if ref $keyinfo; + $keyinfo =~ s/^=// or return $keyinfo; return '' if $ancestry->{$key}++; # endless loop failsafe 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{\^(?=.)}{^}; # element around ctrl-identifier + $html =~ s{\+(?=.)}{+}; # meta + return $html; +} + sub print_key { my $self = shift; my ($mode, $key, $flags) = @_; - - my $txt = $self->{key}->{$mode.$key}; - my ($desc, $mnem) = defined $txt ? @$txt : (); + my ($desc, $mnem); if (not defined $flags) { $flags = $key eq '^0' ? 'ni' : 'no'; } - elsif (not ref $flags) { # alias - $desc = $self->{sign}->{alias} . $flags; + elsif ($flags =~ s/^=//) { # alias + $desc = $self->{sign}->{alias}; + $desc .= $flags eq "\e" ? 'esc' : $flags; $flags = $self->keyunalias($flags) . ' alias'; } - else { - $flags = $flags->[0]; + if (my $txt = $self->{key}->{$mode.$key}) { + ($desc, $mnem) = split /\n/, $self->escapedesc($txt); } -# $key = $keytrans{$key} if defined $keytrans{$key}; - my $keytxt = $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 .= "$self->{sign}->{motion}" if $flags =~ s/ ?\bargm\b//; # motion argument - $keytxt =~ s{\^(?=.)}{^}; # element around ctrl-identifier - $keytxt =~ s{\+(?=.)}{+}; # meta my $keyhint = defined($mnem) && qq{ title="$mnem"}; $keytxt = "$keytxt"; $keytxt .= ' '.$desc if defined $desc; @@ -114,26 +132,31 @@ sub print_key { ); $flags .= ' chr'.ord(substr $key, -1) if $key ne '^0'; - print qq{\t\t
  • $keytxt}; + print qq{\t\t$keytxt}; print "\n"; } sub print_rows { my $self = shift; + my ($rowsspec, $defrows) = @_; + $defrows ||= [2, 1, 0]; my %moderows = ( - -DEFAULT => !@_ ? '' : 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} }; - for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) { - my $keyrow = $keyrows{$self->{map}}->[$row]; + print ''."\n\n"; - print qq{
    • \n}; + for (my $row = -1; $row <= $#{ $keyrows{$self->{map}} }; $row++) { + my $keyrow = $row < 0 ? [["\e"]] : $keyrows{$self->{map}}->[$row]; + + printf qq{
    • \n}, $row+1; for my $basemode (@modes) { my @moderows = split /\s+/, - 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; @@ -145,38 +168,73 @@ 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", $basemode ne '' && sprintf( - ' class="%s"', 'mode mode' . escapeclass($basemode) + printf "\t", @caseclass > 0 && sprintf( + ' class="%s"', join ' ', @caseclass ); - printf("

    %s: %s

    \n", # XXX insert   here to fix msie<=6 - $self->{mode}->{$mode} || "mode $basemode", + printf('    ', # XXX insert   here to fix msie<=6 + $self->escapedesc($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\n}; + print qq{\t\t\n}; } # case } # submode } # basemode - print qq{\t\n}; + print qq{\t\n}; } # row + + print "
    %s: %s
    \n"; } sub print_legend { my $self = shift; my ($class, $flags) = @_; - print qq{\t\t
    \n}; + say qq{\t\t
    }; printf("\t\t".'
    %s'."\n\t\t\t".'
    %s'."\n", - $_, @{ $self->{flag}->{$_} || ["($_)", '...'] } + $_, map { $self->escapedesc($_) } @{ $self->{flag}->{$_} || ["($_)", '...'] } ) for @$flags; - print "\t\t
    "; + say "\t\t
    "; +} + +sub print_legends { + my $self = shift; + my ($input) = @_; + + say "
    \n"; + say '
    '; + + say "\t", '
    '; + my @groups = sort grep {/^g\d/} keys %{ $self->{flag} }; + $self->print_legend('legend-types', \@groups); + say "\t
    \n"; + + say "\t", '
    '; + my @attr = sort grep {!/^g\d/} keys %{ $self->{flag} }; + $self->print_legend('legend-options', \@attr); + say ''; + + say "\t\t", '
      '; + + say "\t\t
    • keyboard map is ", + ($input->{map} ? 'set to ' : ''), "$self->{map}"; + say "\t\t
    • keys are ", + "", ($self->{showkeys} ? 'always shown' : 'hidden if unassigned'), "", + (!defined $self->{showkeys} && ' by default'); + say "\t\t
    • default style is ", + (defined $input->{style} && 'set to '), "$self->{style}"; + + say "\t\t
    "; + say "\t
    \n"; + say "
    \n"; } 1; @@ -192,8 +250,8 @@ Shiar_Sheet::Keyboard - Output HTML for key sheets my $keys = Shiar_Sheet::Keyboard({ def => { 'lead' => { - 'A' => 'a', # alias - 'a' => ['classes'], + 'A' => '=a', # alias + 'a' => 'classes', }, }, key => {