X-Git-Url: http://git.shiar.nl/sheet.git/blobdiff_plain/02aff73f80ccbf7d050280af1114f0e663c6d4dd..HEAD:/Shiar_Sheet/Keyboard.pm

diff --git a/Shiar_Sheet/Keyboard.pm b/Shiar_Sheet/Keyboard.pm
index 4bc142c..c7e455b 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 = 'v1.04';
+our $VERSION = '2.10';
 
 my @casedesc = (undef, qw/shift ctrl meta/, 'shift meta');
 my @rowdesc = qw(numeric top home bottom);
@@ -13,27 +14,32 @@ 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 {
-	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
+	$self->{sign} ||= do {
+		require Shiar_Sheet::KeySigns;
+		Shiar_Sheet::KeySigns->VERSION(1.04);
+		\%Shiar_Sheet::KeySigns::sign;
 	};
-	croak "%${parent}::sign not found" unless %$sign;
 
-	bless {sign => $sign, keys => $keys, map => 'qwerty'}, $self;
+	$self->{showkeys} = $PLP::Script::showkeys;
+	$self->{style   } = $PLP::Script::style;
+
+	bless $self, $class;
 }
 
 sub map {
@@ -50,6 +56,7 @@ sub escapeclass {
 	s/\+/_m/g;
 	s/\[/_sbo/g;
 	s/\]/_sbc/g;
+	s/\\/_b/g;
 	s/^$/_/;
 	return $_;
 }
@@ -62,97 +69,148 @@ 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) = @_;
 
 	$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;
+	$keyinfo =~ s/^=// or return $keyinfo;
+	return '' if $ancestry->{$key}++;  # endless loop failsafe
 	return $self->keyunalias($keyinfo, $ancestry);
 }
 
-sub print_key {
+sub print_letter {
 	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 ($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;
+}
 
-#	$key = $keytrans{$key} if defined $keytrans{$key};
-	my $keytxt = $mode . escapehtml($key) if $key ne '^0';
-	   $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//;  # arguments
+sub print_key {
+	my $self = shift;
+	my ($mode, $key, $flags) = @_;
+	my ($desc, $mnem);
+
+	if (not defined $flags) {
+		$flags = $key eq '^0' ? 'ni' : 'no';
+	}
+	elsif ($flags =~ s/^=(\S+)\s?//) { # alias
+		my $ref = $1;
+		$desc = $self->{sign}->{alias} . ($ref eq "\e" ? 'esc' : $ref);
+		$flags = join ' ', $self->keyunalias($ref), 'alias', $flags;
+	}
+	if (my $txt = $self->{key}->{$mode.$key}) {
+		($desc, $mnem) = split /\n/, $self->escapedesc($txt);
+	}
+
+	my $keytxt = $self->print_letter($key, $mode);
 	   $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 $onclick = $flags =~ s/ ?\bmode(\S*)// && defined $self->{keys}{$1} && sprintf(
+	   $keytxt .= $self->{sign}->{$1} while $flags =~ s/(?:^| )(arg[a-ln-z]?)\b//;  # arguments
+	my $keyhint = defined($mnem) && qq{ title="$mnem"};
+	   $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->{def}{$1} && sprintf(
 		' onclick="setmode(%s)"',
 		$1 eq '' ? '' : sprintf(q{'mode%s'}, escapeclass($1))
 	);
-	$onclick .= sprintf(q{ onclick="document.location='%s'"}, $1)
-		if $flags =~ s/ ?\blink(\S*)//;
-	my $keyhint = defined($mnem) && qq{ title="$mnem"};
+	$flags =~ s/\bx\w+/ext/;
+	$flags =~ s/\bv\d+/new/;
 	$flags .= ' chr'.ord(substr $key, -1) if $key ne '^0';
 
-	print qq{\t\t<li class="$flags"$onclick><b$keyhint>$keytxt</b>};
-	print ' ', $desc if defined $desc;
+	print qq{\t\t<td class="$flags"$onclick>$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->{keys} };
+	my @modes = sort keys %{ $self->{def} };
+
+	printf '<table id="rows" class="%s">'."\n\n", $self->{tableclass} // 'keys';
 
-	for (my $row = 0; $row <= $#{ $keyrows{$self->{map}} }; $row++) {
-		my $keyrow = $keyrows{$self->{map}}->[$row];
+print_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};
+#		grep {
+#			defined $self->{def}->{''}->{$_} or defined $self->{def}->{g}->{$_}
+#		} map { @{$_} } @{$keyrow} or next;
+
+		printf qq{<tbody class="row row%d">\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;
-			my @caserows = $mode =~ s/(\d+)(?:-(\d+))?$//
-				? (map {$_ - 1} split //, $row == 0 && $2 || $1)  # user override
+			my @caserows = $mode =~ s/(\d+)(?:-(\d*))?$//
+				? (map {$_ - 1} split //, $row == 0 ? $2 // $1 : $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;
 				  @$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
-						$modekeys->{desc} || "mode $basemode",
+				printf('<th>%s<small>: %s</small></th>', # XXX insert &nbsp; 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<ul class="$caseclass">\n};
-				$self->print_key($modekeys->{lead}, $_, $modekeys->{$_}) for @$keycase;
-				print qq{\t\t</ul>\n};
+				) unless $row < 0;
+				print "\n";
+				$self->print_key($mode, $_, $modekeys->{$_}) for @$keycase;
+				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) = @_;
+
+	say qq{\t\t<dl class="legend $class">};
+	printf("\t\t".'<dt class="%s">%s'."\n\t\t\t".'<dd>%s</dd>'."\n",
+		$_, map { $self->escapedesc($_) } @{ $self->{flag}->{$_} || ["($_)", '...'] }
+	) for @$flags;
+	say "\t\t</dl>";
 }
 
 1;
@@ -166,10 +224,17 @@ Shiar_Sheet::Keyboard - Output HTML for key sheets
 	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";
@@ -178,7 +243,7 @@ Shiar_Sheet::Keyboard - Output HTML for key sheets
 
 =head1 DESCRIPTION
 
-Used by http://sheet.shiar.nl to display keyboard sheets.
+Used by https://sheet.shiar.nl to display keyboard sheets.
 Assumes specific stylesheets and javascript from this site,
 so probably not of much use elsewhere.