Merge pull request #3467 from orestisf1993/userguide

[i3/i3] / contrib / dump-asy.pl

diff --git a/contrib/dump-asy.pl b/contrib/dump-asy.pl
index 54a1e490f2ac5124097d51ec57f3d878dac339c9..5af4c72f313763a7fb6a459ba59cada1d273d2c2 100755 (executable)
--- a/contrib/dump-asy.pl
+++ b/contrib/dump-asy.pl
@@ -8,14 +8,19 @@ use Getopt::Long;
 use Pod::Usage;
 use AnyEvent::I3;
 use File::Temp;
+use File::Spec;
 use File::Basename;
 use v5.10;
 use IPC::Cmd qw[can_run];
 
 my %options = (
+    gv => 1,
+    save => undef,
     help => 0,
 );
 my $result = GetOptions(
+    "gv!" => \$options{gv},
+    "save=s" => \$options{save},
     "help|?" => \$options{help},
 );
 
@@ -24,7 +29,7 @@ pod2usage(-verbose => 2, -exitcode => 0) if $options{help};
 # prerequisites check so we can be specific about failures caused
 # by not having these tools in the path
 can_run('asy') or die 'Please install asymptote';
-can_run('gv') or die 'Please install gv';
+can_run('gv') or die 'Please install gv' unless !$options{gv};
 
 my $i3 = i3();
 
@@ -41,7 +46,7 @@ sub dump_node {
 
     my $o = ($n->{orientation} eq 'none' ? "u" : ($n->{orientation} eq 'horizontal' ? "h" : "v"));
     my $w = (defined($n->{window}) ? $n->{window} : "N");
-    my $na = ($n->{name} or "[Empty]");
+    my $na = ($n->{name} or ($n->{type} eq "floating_con" ? "[Floating con]" : "[Empty]"));
     $na =~ s/#/\\#/g;
     $na =~ s/\$/\\\$/g;
     $na =~ s/&/\\&/g;
@@ -51,14 +56,16 @@ sub dump_node {
     if (!defined($n->{window})) {
         $type = $n->{layout};
     }
-    my $name = qq|``$na'' ($type)|;
+    my $marks = $n->{marks} ? ' [' . join('][', @{$n->{marks}}) . ']' : '';
+    my $name = qq|``$na'' ($type)$marks|;
 
     print $tmp "TreeNode n" . $n->{id} . " = makeNode(";
 
     print $tmp "n" . $parent->{id} . ", " if defined($parent);
     print $tmp "\"" . $name . "\");\n";
 
-       dump_node($_, $n) for @{$n->{nodes}};
+    dump_node($_, $n) for @{$n->{nodes}};
+    dump_node($_, $n) for @{$n->{floating_nodes}};
 }
 
 sub find_node_with_name {
@@ -86,8 +93,21 @@ say $tmp "draw(n" . $root->{id} . ", (0, 0));";
 close($tmp);
 my $rep = "$tmp";
 $rep =~ s/asy$/eps/;
-my $tmp_dir = dirname($rep);
-system("cd $tmp_dir && asy $tmp && gv --scale=-1000 --noresize --widgetless $rep && rm $rep");
+if ($options{gv}) {
+    my $tmp_dir = dirname($rep);
+    $options{save} = File::Spec->rel2abs($options{save}) if $options{save};
+    chdir($tmp_dir);
+} else {
+    $rep = basename($rep);  # Output in current dir.
+}
+system("asy $tmp");  # Create the .eps file.
+system("gv --scale=-1000 --noresize --widgetless $rep") if $options{gv};
+if ($options{save}) {
+    system("mv $rep ${options{save}}");
+} elsif ($options{gv}) {
+    system("rm $rep");
+}
+system("rm $tmp");
 
 __END__
 
@@ -108,3 +128,25 @@ Render the entire tree, run:
 Render the tree starting from the node with the specified name, run:
 
   ./dump-asy.pl 'name'
+
+Render the entire tree, save in file 'file.eps' and show using gv, run:
+
+  ./dump-asy.pl --save file.eps
+
+=head1 OPTIONS
+
+=over 8
+
+=item B<--gv>
+
+=item B<--no-gv>
+
+Enable or disable showing the result through gv. If disabled, an .eps file will
+be saved in the current working directory. Enabled by default.
+
+=item B<--save>
+
+Save result using the specified file-name. If omitted, no file will be saved
+when using '--gv' or a random name will be used when using '--no-gv'.
+
+=back