update path to lua-doc in manual
[ardour.git] / tools / fmt-bindings
index cd69e04a595f86a408c01b438cc4b84a69d3e53b..d2dd1adfca5e19b92ee56723d40123df05922d9a 100755 (executable)
@@ -2,7 +2,9 @@
 
 # import module
 use Getopt::Long; 
-
+use File::Basename;
+use File::Spec;
+    
 $semicolon = ";"; # help out stupid emacs
 $title = "Ardour Shortcuts";
 $in_group_def = 0;
@@ -12,15 +14,17 @@ $group_key;
 $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;
 
@@ -33,46 +37,55 @@ GetOptions ("platform=s" => \$platform,
 
 if ($platform eq "darwin") {
 
-    $gtk_modifier_map{'PRIMARY'} = 'Primary';
+    $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'} = 'Mod1';
-    $gtk_modifier_map{'WINDOW'} = 'Control';
+    $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'} = 'Cmd';
     $cs_modifier_map{'SECONDARY'} = 'Control';
     $cs_modifier_map{'TERTIARY'} = 'Shift';
-    $cs_modifier_map{'LEVEL4'} = 'Mod1';
-    $cs_modifier_map{'WINDOW'} = 'Control';
+    $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'} = 'Ctrl';
     $mouse_modifier_map{'TERTIARY'} = 'Shift';
     $mouse_modifier_map{'LEVEL4'} = 'Opt';
-    $mouse_modifier_map{'WINDOW'} = 'Ctrl';
 
 } 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 = ();
@@ -164,10 +177,15 @@ if ($merge_from) {
 }
 
 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 (/^\$/) {
@@ -192,7 +210,13 @@ while (<>) {
 
        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;
@@ -218,6 +242,10 @@ while (<>) {
        chop;
        ($key,$action,$binding,$text) = split (/\|/, $_, 4);
 
+       $gkey = $key;
+       $gkey =~ s/^-//;
+       $owner = $group_owners{$gkey};
+
        # substitute bindings
 
        $gtk_binding = $binding;
@@ -236,18 +264,28 @@ while (<>) {
            }
        } 
 
-       # 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/\\&/&amp;/g;
+
+               $bref = $owner_bindings{$owner};
+               push (@$bref, [ $action, $b, $g]);
            }
        }
 
@@ -259,12 +297,43 @@ while (<>) {
        $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;
 }
@@ -369,6 +438,8 @@ if ($html) {
 
 $boilerplate_header = <<END_HEADER;
 \\documentclass[10pt,landscape]{article}
+%\\documentclass[10pt,landscape,a4paper]{article}
+%\\documentclass[10pt,landscape,letterpaper]{article}
 \\usepackage{multicol}
 \\usepackage{calc}
 \\usepackage{ifthen}
@@ -387,7 +458,7 @@ $boilerplate_header = <<END_HEADER;
 % 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} }
@@ -431,12 +502,11 @@ $boilerplate_footer = <<END_FOOTER;
 \\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}