# import module
use Getopt::Long;
-
+use File::Basename;
+use File::Spec;
+
$semicolon = ";"; # help out stupid emacs
$title = "Ardour Shortcuts";
$in_group_def = 0;
$group_number = 0;
%group_names;
%group_text;
+%owner_bindings;
+%group_owners;
%group_bindings;
%modifier_map;
%group_numbering;
%merge_bindings;
$platform = linux;
-$winkey = 'Mod4><Super';
-$make_cheatsheet = 1;
-$make_accelmap = 0;
+$winkey = 'Win';
+$make_cheatsheet = 0;
+$make_accelmap = 1;
$merge_from = "";
+$html = 0;
GetOptions ("platform=s" => \$platform,
"winkey=s" => \$winkey,
"cheatsheet" => \$make_cheatsheet,
"accelmap" => \$make_accelmap,
- "merge=s" => \$merge_from);
+ "merge=s" => \$merge_from,
+ "html" => \$html);
if ($platform eq "darwin") {
- $gtk_modifier_map{'PRIMARY'} = 'meta';
- $gtk_modifier_map{'SECONDARY'} = 'Mod1';
+ $gtk_modifier_map{'PRIMARY'} = 'Primary'; # GTK supports Primary to allow platform-independent binding to the "primary" modifier, which on OS X is Command
+ $gtk_modifier_map{'SECONDARY'} = 'Control';
$gtk_modifier_map{'TERTIARY'} = 'Shift';
- $gtk_modifier_map{'LEVEL4'} = 'Control';
- $gtk_modifier_map{'WINDOW'} = 'Mod1';
+ $gtk_modifier_map{'LEVEL4'} = 'Mod1';
+
+ # cs_modifier_map == "Cheat Sheet Modifier Map"
+ # Used to control what gets shown in the
+ # cheat sheet for a given (meta)-modifier
- $cs_modifier_map{'PRIMARY'} = 'Command';
- $cs_modifier_map{'SECONDARY'} = 'Opt';
+ $cs_modifier_map{'PRIMARY'} = 'Cmd';
+ $cs_modifier_map{'SECONDARY'} = 'Control';
$cs_modifier_map{'TERTIARY'} = 'Shift';
- $cs_modifier_map{'LEVEL4'} = 'Control';
- $cs_modifier_map{'WINDOW'} = 'Opt';
+ $cs_modifier_map{'LEVEL4'} = 'Opt';
+ # used to display what gets shown in the
+ # cheat sheet for mouse bindings. Differs
+ # from cs_modifier map in using shorter
+ # abbreviations.
+
$mouse_modifier_map{'PRIMARY'} = 'Cmd';
- $mouse_modifier_map{'SECONDARY'} = 'Opt';
+ $mouse_modifier_map{'SECONDARY'} = 'Ctrl';
$mouse_modifier_map{'TERTIARY'} = 'Shift';
- $mouse_modifier_map{'LEVEL4'} = 'Control';
- $mouse_modifier_map{'WINDOW'} = 'Opt';
+ $mouse_modifier_map{'LEVEL4'} = 'Opt';
} else {
$gtk_modifier_map{'PRIMARY'} = 'Control';
$gtk_modifier_map{'SECONDARY'} = 'Alt';
$gtk_modifier_map{'TERTIARY'} = 'Shift';
- $gtk_modifier_map{'LEVEL4'} = $winkey;
- $gtk_modifier_map{'WINDOW'} = 'Alt';
- $gtk_modifier_map{$winkey} => 'Win';
+ $gtk_modifier_map{'LEVEL4'} = $winkey; # something like "Mod4><Super"
+
+ # cs_modifier_map == "Cheat Sheet Modifier Map"
+ # Used to control what gets shown in the
+ # cheat sheet for a given (meta)-modifier
$cs_modifier_map{'PRIMARY'} = 'Control';
$cs_modifier_map{'SECONDARY'} = 'Alt';
$cs_modifier_map{'TERTIARY'} = 'Shift';
$cs_modifier_map{'LEVEL4'} = 'Win';
- $cs_modifier_map{'WINDOW'} = 'Alt';
- $cs_modifier_map{$winkey} => 'Win';
+
+ # used to display what gets shown in the
+ # cheat sheet for mouse bindings. Differs
+ # from cs_modifier map in using shorter
+ # abbreviations.
$mouse_modifier_map{'PRIMARY'} = 'Ctl';
$mouse_modifier_map{'SECONDARY'} = 'Alt';
$mouse_modifier_map{'TERTIARY'} = 'Shift';
$mouse_modifier_map{'LEVEL4'} = 'Win';
- $mouse_modifier_map{'WINDOW'} = 'Alt';
- $mouse_modifier_map{$winkey} => 'Win';
}
-%keycodes = (
- 'asciicircum' => '\\verb=^=',
- 'apostrophe' => '\'',
- 'bracketleft' => '[',
- 'bracketright' => ']',
- 'braceleft' => '\\{',
- 'braceright' => '\\}',
- 'backslash' => '$\\backslash$',
- 'slash' => '/',
- 'rightanglebracket' => '>',
- 'leftanglebracket' => '<',
- 'ampersand' => '\\&',
- 'comma' => ',',
- 'period' => '.',
- 'semicolon' => ';',
- 'colon' => ':',
- 'equal' => '=',
- 'minus' => '-',
- 'plus' => '+',
- 'grave' => '`',
- 'rightarrow' => '$\rightarrow$',
- 'leftarrow' => '$\\leftarrow$',
- 'uparrow' => '$\\uparrow$',
- 'downarrow' => '$\\downarrow$',
- 'Page_Down' => 'Page Down',
- 'Page_Up' => 'Page Up',
- 'space' => 'space',
- 'KP_' => 'KP$\_$',
+%keycodes = ();
+
+if ($html) {
+ %keycodes = (
+ 'asciicircum' => '^',
+ 'apostrophe' => '\'',
+ 'bracketleft' => '[',
+ 'bracketright' => ']',
+ 'braceleft' => '{',
+ 'braceright' => '}',
+ 'backslash' => '\\',
+ 'slash' => '/',
+ 'rightanglebracket' => '>',
+ 'leftanglebracket' => '<',
+ 'ampersand' => '&',
+ 'comma' => ',',
+ 'period' => '.',
+ 'semicolon' => ';',
+ 'colon' => ':',
+ 'equal' => '=',
+ 'minus' => '-',
+ 'plus' => '+',
+ 'grave' => '`',
+ 'rightarrow' => '→',
+ 'leftarrow' => '←',
+ 'uparrow' => '↑',
+ 'downarrow' => '↓',
+ 'Page_Down' => 'PageDown',
+ 'Page_Up' => 'PageUp',
+ 'space' => 'space',
+ 'KP_Right' => 'KP-→',
+ 'KP_Left' => 'KP-←',
+ 'KP_Up' => 'KP-↑',
+ 'KP_Down' => 'KP-↓',
+ 'KP_0' => 'KP-0;',
+ 'greater' => '>',
+ 'less' => '<',
+ );
+} else {
+
+ %keycodes = (
+ 'asciicircum' => '\\verb=^=',
+ 'apostrophe' => '\'',
+ 'bracketleft' => '[',
+ 'bracketright' => ']',
+ 'braceleft' => '\\{',
+ 'braceright' => '\\}',
+ 'backslash' => '$\\backslash$',
+ 'slash' => '/',
+ 'rightanglebracket' => '>',
+ 'leftanglebracket' => '<',
+ 'ampersand' => '\\&',
+ 'comma' => ',',
+ 'period' => '.',
+ 'semicolon' => ';',
+ 'colon' => ':',
+ 'equal' => '=',
+ 'minus' => '-',
+ 'plus' => '+',
+ 'grave' => '`',
+ 'rightarrow' => '$\rightarrow$',
+ 'leftarrow' => '$\\leftarrow$',
+ 'uparrow' => '$\\uparrow$',
+ 'downarrow' => '$\\downarrow$',
+ 'Page_Down' => 'Page Down',
+ 'Page_Up' => 'Page Up',
+ 'space' => 'space',
+ 'KP_' => 'KP$\_$',
+ 'greater' => '>',
+ 'less' => '<',
);
+}
if ($merge_from) {
open (BINDINGS, $merge_from) || die ("merge from bindings: file not readable");
}
if ($make_accelmap && !$merge_from) {
- print ";; this accelmap was produced by tools/fmt-bindings\n";
+ print "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
}
-while (<>) {
+$bindings_name = basename ($ARGV[0]);
+$bindings_name =~ s/.bindings\.in$//;
+
+open SOURCE, "<", $ARGV[0] or die $!;
+
+while (<SOURCE>) {
next if /^$semicolon/;
if (/^\$/) {
s/^%//;
chop;
- ($group_key,$group_name) = split (/\s+/, $_, 2);
+ ($group_key,$owner,$group_name) = split (/\s+/, $_, 3);
+ if ($make_accelmap) {
+ if (!exists ($owner_bindings{$owner})) {
+ $owner_bindings{$owner} = [ [] ];
+ }
+ $group_owners{$group_key} = $owner;
+ }
$group_number++;
$group_text = "";
$in_group_def = 1;
chop;
($key,$action,$binding,$text) = split (/\|/, $_, 4);
+ $gkey = $key;
+ $gkey =~ s/^-//;
+ $owner = $group_owners{$gkey};
+
# substitute bindings
$gtk_binding = $binding;
}
}
- # print the accelmap output
+ # store the accelmap output
if ($key =~ /^\+/) {
# remove + and don't print it in the accelmap
$key =~ s/^\+//;
} else {
- # include this in the accelmap
- if (!$merge_from && $make_accelmap) {
- foreach $k (keys %gtk_modifier_map) {
- $gtk_binding =~ s/\@$k\@/$gtk_modifier_map{$k}/;
- }
- print "(gtk_accel_path \"<Actions>/$action\" \"$gtk_binding\")\n";
+ # include this in the accelmap if it is part of a group that has an "owner"
+ if (!$merge_from && $make_accelmap && exists ($owner_bindings{$owner})) {
+
+ $b = $binding;
+ $b =~ s/<@//g;
+ $b =~ s/@>//g;
+ $b =~ s/PRIMARY/Primary-/;
+ $b =~ s/SECONDARY/Secondary-/;
+ $b =~ s/TERTIARY/Tertiary-/;
+ $b =~ s/LEVEL4/Level4-/;
+
+ $g = $group_names{$gkey};
+ $g =~ s/\\&/&/g;
+
+ $bref = $owner_bindings{$owner};
+ push (@$bref, [ $action, $b, $g]);
}
}
$bref = $group_bindings{$key};
push (@$bref, [$binding, $text]);
+ $sref = $section_text{$key};
+ push (@$sref, [$owner]);
+
next;
}
next;
}
+if ($make_accelmap) {
+ print "<BindingSet name=\"" . $bindings_name . "\">\n";
+
+ foreach $owner (keys %owner_bindings) {
+ print " <Bindings name=\"$owner\">\n <Press>\n";
+ $bindings = $owner_bindings{$owner};
+ shift (@$bindings); # remove initial empty element
+ for my $binding (@$bindings) {
+ print ' <Binding key="' . @$binding[1] . '" action="' . @$binding[0] . '" group="' . @$binding[2] . "\"/>\n";
+ }
+ print " </Press>\n </Bindings>\n";
+ }
+
+ # merge in the "fixed" bindings that are not defined by the argument given to this program
+ # this covers things like the step editor, monitor and processor box bindings
+
+ foreach $hardcoded_bindings ("mixer.bindings", "step_editing.bindings", "monitor.bindings", "processor_box.bindings") {
+ $path = File::Spec->catfile (dirname ($ARGV[0]), $hardcoded_bindings);
+ open HARDCODED, "<", $path or die $!;
+ while (<HARDCODED>) {
+ print $_;
+ }
+ close HARDCODED;
+ }
+
+ print "</BindingSet>\n";
+}
+
if ($make_accelmap || !$make_cheatsheet) {
exit 0;
}
+if ($html) {
+
+ @groups_sorted_by_number = sort { $group_numbering{$a} <=> $group_numbering{$b} } keys %group_numbering;
+
+ foreach $gk (@groups_sorted_by_number) {
+
+ if ($gk =~ /^m/) {
+ # mouse stuff - ignore
+ next;
+ }
+
+ # $bref is a reference to the array of arrays for this group
+ $bref = $group_bindings{$gk};
+
+ if (scalar @$bref > 1) {
+
+ $name = $group_names{$gk};
+ $name =~ s/\\linebreak.*//;
+ $name =~ s/\\&/&/;
+ $name =~ s/\$\\_\$/-/g;
+ $name =~ s/\\[a-z]+ //g;
+ $name =~ s/[{}]//g;
+ $name =~ s/\\par//g;
+
+ print "<h3>$name</h3>\n";
+
+ $gtext = $group_text{$gk};
+ $gtext =~ s/\\linebreak.*//;
+ $gtext =~ s/\\&/&/;
+ $gtext =~ s/\$\\_\$/-/g;
+ $gtext =~ s/\\[a-z]+ //g;
+ $gtext =~ s/[{}]//g;
+ $gtext =~ s/\\par//g;
+
+ if (!($gtext eq "")) {
+ print "$gtext\n\n";
+ }
+
+ # ignore the first entry, which was empty
+
+ shift (@$bref);
+
+ # set up the list
+
+ print "<dl class=\"bindings\">\n";
+
+ # sort the array of arrays by the descriptive text for nicer appearance,
+ # and print them
+
+ for $bbref (sort { @$a[1] cmp @$b[1] } @$bref) {
+ # $bbref is a reference to an array
+
+ $binding = @$bbref[0];
+ $text = @$bbref[1];
+
+ if ($binding =~ /:/) { # mouse binding with "where" clause
+ ($binding,$where) = split (/:/, $binding, 2);
+ }
+
+ foreach $k (keys %cs_modifier_map) {
+ $binding =~ s/\@$k\@/$cs_modifier_map{$k}/;
+ }
+
+ # remove braces for HTML
+
+ $binding =~ s/></\+/g;
+ $binding =~ s/^<//;
+ $binding =~ s/>/\+/;
+
+ # substitute keycode names for something printable
+
+ $re = qr/${ \(join'|', map quotemeta, keys %keycodes)}/;
+ $binding =~ s/($re)/$keycodes{$1}/g;
+
+ # tidy up description
+
+ $descr = @$bbref[1];
+ $descr =~ s/\\linebreak.*//;
+ $descr =~ s/\\&/&/;
+ $descr =~ s/\$\\_\$/-/g;
+ $descr =~ s/\\[a-z]+ //g;
+ $descr =~ s/[{}]//g;
+ $descr =~ s/\\par//g;
+
+ print "<dt>$descr</dt><dd>$binding</dd>\n";
+ }
+
+ print "</dl>\n";
+
+ }
+ }
+ print " <!-- remove this if more text is added below -->\n";
+ exit 0;
+}
+
+
# Now print the cheatsheet
$boilerplate_header = <<END_HEADER;
\\documentclass[10pt,landscape]{article}
+%\\documentclass[10pt,landscape,a4paper]{article}
+%\\documentclass[10pt,landscape,letterpaper]{article}
\\usepackage{multicol}
\\usepackage{calc}
\\usepackage{ifthen}
% if using A4 paper. (This probably isnott strictly necessary.)
% If using another size paper, use default 1cm margins.
\\ifthenelse{\\lengthtest { \\paperwidth = 11in}}
- { \\geometry{top=.5in,left=1in,right=0in,bottom=.5in} }
+ { \\geometry{top=.5in,left=.5in,right=.5in,bottom=.5in} }
{\\ifthenelse{ \\lengthtest{ \\paperwidth = 297mm}}
{\\geometry{top=1cm,left=1cm,right=1cm,bottom=1cm} }
{\\geometry{top=1cm,left=1cm,right=1cm,bottom=1cm} }
\\rule{0.3\\linewidth}{0.25pt}
\\scriptsize
-Copyright \\copyright\\ 2009 ardour.org
+Copyright \\copyright\\ 2013 ardour.org
% Should change this to be date of file, not current date.
-%\\verb!$Revision: 1.13 $, $Date: 2008/05/29 06:11:56 $.!
-http://ardour.org/manual
+http://manual.ardour.org
\\end{multicols}
\\end{document}
projects / ardour.git / blobdiff