version bump

Generally --hardcopy should produce new files, but the completion is still
useful.

Changes

@@ -1,3 +1,41 @@
+feedgnuplot (1.45)
+
+  * zsh completion: --hardcopy, --image  suggest filenames
+  * --image now produces a nicer legend: just the filename
+  * --curvestyle now overrides --curvestyleall
+    - This is a bug fix
+  * The version is now treated as a string not as a number
+    - So "1.40" is distinct from "1.4"
+
+ -- Dima Kogan <dima@secretsauce.net>  Sun, 29 Oct 2017 13:56:28 -0700
+
+feedgnuplot (1.44)
+
+  * --image draws its output beneath everything else
+
+ -- Dima Kogan <dima@secretsauce.net>  Tue, 20 Jun 2017 16:44:30 -0700
+
+feedgnuplot (1.43)
+
+  * Added --image
+
+ -- Dima Kogan <dima@secretsauce.net>  Mon, 19 Jun 2017 13:12:38 -0700
+
+feedgnuplot (1.42)
+
+  * Data can now come from STDIN or files on the cmdline.
+    This fixes a regression. Self-plotting data files work again
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 31 Mar 2017 15:38:47 -0700
+
+feedgnuplot (1.41)
+
+  * Histograms: --xlen can coexist with --xmin/--xmax
+  * Histograms: work as expected with --xlen and --monotonic
+  * Histograms: better sanity checking of options
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 24 Feb 2017 23:42:28 -0800
+
 feedgnuplot (1.40)
 
   * If the options couldn't be parsed I don't dump the whole manpage
@@ -16,8 +54,8 @@ feedgnuplot (1.39)
 feedgnuplot (1.38)
 
   * hardcopy defaults:
-   - no enhanced text mode
-   - larger font size
+    - no enhanced text mode
+    - larger font size
 
  -- Dima Kogan <dima@secretsauce.net>  Wed, 27 Jul 2016 22:15:11 -0700
 

Makefile.PL

@@ -20,9 +20,9 @@ sub parseversion
 
   while(<PL>)
   {
-    if( /VERSION = ([0-9\.]+)/ )
+    if( /VERSION = '([0-9\.]+)'/ )
     {
-      if ( $1 != $version )
+      if ( $1 ne $version )
       {
         die "Version mismatch. Changes says version is '$version', but 'bin/feedgnuplot' says it is '$1'";
       }

bin/feedgnuplot

@@ -15,7 +15,8 @@ use Text::ParseWords; # for shellwords
 use Pod::Usage;
 use Time::Piece;
 
-my $VERSION = 1.40;
+# Makefile.PL assumes this is in ''
+my $VERSION = '1.45';
 
 my %options;
 interpretCommandline();
@@ -41,22 +42,26 @@ my $last_replot_time = [gettimeofday];
 
 # whether the previous replot was timer based
 my $last_replot_is_from_timer = 1;
-
-
-my $prev_timed_replot_time = [gettimeofday];
 my $this_replot_is_from_timer;
-my $stdin    = IO::Handle->new();
-die "Couldn't open STDIN" unless $stdin->fdopen(fileno(STDIN),"r");
-my $selector = IO::Select->new( $stdin );
-
-
-
-mainThread();
 
 
 
 
 
+
+
+
+sub getRangeSize
+{
+    my ($id) = @_;
+
+    # I'd like to use //, but I guess some people are still on perl 5.8
+    return
+      exists $options{rangesize_hash}{$id} ?
+      $options{rangesize_hash}{$id} :
+      $options{rangesize_default};
+}
+
 sub interpretCommandline
 {
   # if I'm using a self-plotting data file with a #! line, then $ARGV[0] will contain ALL of the
@@ -105,13 +110,13 @@ sub interpretCommandline
              'style=s{2}', 'curvestyle=s{2}', 'curvestyleall=s', 'styleall=s', 'with=s', 'extracmds=s@', 'set=s@', 'unset=s@',
              'square!', 'square_xy!', 'hardcopy=s', 'maxcurves=i', 'monotonic!', 'timefmt=s',
              'equation=s@',
+             'image=s',
              'histogram=s@', 'binwidth=f', 'histstyle=s',
              'terminal=s',
              'rangesize=s{2}', 'rangesizeall=i', 'extraValuesPerPoint=i',
              'help', 'dump', 'exit', 'version',
              'geometry=s') or exit 1;
 
-
   # handle various cmdline-option errors
   if ( $options{help} )
   {
@@ -222,7 +227,10 @@ sub interpretCommandline
 
 
   # I now set up the rangesize to always be
-  #  $options{rangesize_hash}{$id} // $options{rangesize_default}
+  #
+  #   $options{rangesize_hash}{$id} // $options{rangesize_default}
+  #
+  # which is available as getRangeSize($id)
   if ( $options{rangesizeall} )
   {
       $options{rangesize_default} = $options{rangesizeall};
@@ -281,6 +289,13 @@ sub interpretCommandline
     $options{curvestyleall} .= ' palette';
   }
 
+  if ( defined $options{binwidth} && !@{$options{histogram}} )
+  {
+    print STDERR "--binwidth doesn't make sense without any histograms\n";
+    exit -1;
+  }
+
+
   if ( $options{'3d'} )
   {
     if ( !$options{domain} )
@@ -313,7 +328,7 @@ sub interpretCommandline
       exit -1;
     }
 
-    if ( defined $options{binwidth} || @{$options{histogram}} )
+    if ( @{$options{histogram}} )
     {
       print STDERR "--3d does not make sense with histograms\n";
       exit -1;
@@ -347,6 +362,16 @@ sub interpretCommandline
       print STDERR "--square_xy only makes sense with --3d\n";
       exit -1;
     }
+
+    for my $hist_curve(@{$options{histogram}})
+    {
+        my $hist_dim = getRangeSize($hist_curve);
+        if( $hist_dim != 1 )
+        {
+            print STDERR "I only support 1D histograms, but curve '$hist_curve' has '$hist_dim'-D data\n";
+            exit -1;
+        }
+    }
   }
 
   if(defined $options{xlen} && !$options{stream} )
@@ -356,7 +381,8 @@ sub interpretCommandline
   }
 
   if($options{stream} && defined $options{xlen} &&
-     ( defined $options{xmin} || defined $options{xmax}))
+     ( defined $options{xmin} || defined $options{xmax}) &&
+    !defined $options{histogram})
   {
     print STDERR "With --stream and --xlen the X bounds are set, so neither --xmin nor --xmax make sense\n";
     exit -1;
@@ -395,6 +421,27 @@ sub interpretCommandline
       }
     }
   }
+
+  # deal with --image. I just fill in --equation, and reverse the y extents if
+  # none are explicitly given
+  if( defined $options{image} )
+  {
+      # images generally have the origin at the top-left instead of the
+      # bottom-left, so given nothing else, I flip the y axis
+      if( !defined $options{ymin} && !defined $options{ymax} &&
+          ! any { /^ *yrange\b/ } @{$options{set}} )
+      {
+          push @{$options{set}}, "yrange [:] reverse";
+      }
+
+      if ( ! -r $options{image} )
+      {
+          die "Couldn't read image '$options{image}'";
+      }
+
+      unshift @{$options{equation}}, qq{"$options{image}" binary filetype=auto flipy with rgbimage title "$options{image}"};
+      delete $options{image};
+  }
 }
 
 sub getGnuplotVersion
@@ -447,16 +494,66 @@ sub makeDomainNumeric
 }
 
 
+my $prev_timed_replot_time = [gettimeofday];
+my $pipe_in;
+my $selector;
+my $line_number = 0;
+my $is_stdin = !@ARGV; # read stdin only if no data files given on the cmdline
+sub openNextFile
+{
+    my $fd;
+    if($is_stdin)
+    {
+        $fd = IO::Handle->new();
+        $fd->fdopen(fileno(STDIN), "r") or die "Couldn't open STDIN";
+    }
+    else
+    {
+        my $filename = shift @ARGV;
+        $fd = IO::File->new($filename, "r") or die "Couldn't open file '$filename'";
+    }
+
+    my $selector = IO::Select->new( $fd );
+    return ($fd, $selector);
+}
 sub getNextLine
 {
+    sub getline_internal
+    {
+        while(1)
+        {
+            my $line = $pipe_in->getline();
+            if( !$is_stdin && !defined $line && $pipe_in->eof() && @ARGV)
+            {
+                # I got to the end of one file, so open the next one (which I'm
+                # sure exists)
+                ($pipe_in, $selector) = openNextFile();
+                next;
+            }
+            return $line;
+        }
+    }
+
+
+
+
+
+    if( !defined $pipe_in )
+    {
+        ($pipe_in, $selector) = openNextFile();
+    }
+
     while(1)
     {
         $this_replot_is_from_timer = undef;
 
         # if we're not streaming, or we're doing triggered-only replotting, simply
         # do a blocking read
-        return $stdin->getline()
-          if (! $options{stream} || $options{stream} < 0);
+        if (! $options{stream} || $options{stream} < 0)
+        {
+            $line_number++;
+            return getline_internal();
+        }
 
 
         my $now = [gettimeofday];
@@ -471,7 +568,8 @@ sub getNextLine
 
         if ($selector->can_read($time_remaining))
         {
-            return $stdin->getline();
+            $line_number++;
+            return getline_internal();
         }
     }
 }
@@ -622,11 +720,6 @@ sub mainThread
       print(PIPE "set xdata time\n");
     }
 
-    # add the extra global options
-    print(PIPE "$_\n")       foreach (@{$options{extracmds}});
-    print(PIPE "set $_\n")   foreach (@{$options{set}});
-    print(PIPE "unset $_\n") foreach (@{$options{unset}});
-
     # set up histograms
     $options{binwidth} ||= 1;   # if no binwidth given, set it to 1
     print PIPE
@@ -649,6 +742,11 @@ sub mainThread
     sendRangeCommand( "zrange",  $options{zmin}, $options{zmax} );
     sendRangeCommand( "cbrange", $options{zmin}, $options{zmax} ) if($options{colormap});
 
+    # add the extra global options
+    print(PIPE "$_\n")       foreach (@{$options{extracmds}});
+    print(PIPE "set $_\n")   foreach (@{$options{set}});
+    print(PIPE "unset $_\n") foreach (@{$options{unset}});
+
 
 
 
@@ -741,7 +839,7 @@ sub mainThread
       }
       else
       {
-        $domain[0] = $.;
+        $domain[0] = $line_number;
         $domain0_numeric = makeDomainNumeric( $domain[0] );
       }
 
@@ -749,20 +847,10 @@ sub mainThread
 
       while(@fields)
       {
-          if($options{dataid})
-          {
-              $id = shift @fields;
-          }
-          else
-          {
-              $id++;
-          }
-
-          # I'd like to use //, but I guess some people are still on perl 5.8
-          my $rangesize = exists $options{rangesize_hash}{$id} ?
-            $options{rangesize_hash}{$id} :
-            $options{rangesize_default};
+          if($options{dataid}) { $id = shift @fields; }
+          else                 { $id++;               }
 
+          my $rangesize = getRangeSize($id);
           last if @fields < $rangesize;
 
           pushPoint(getCurve($id),
@@ -886,17 +974,13 @@ sub updateCurveOptions
       # as 1 + rangesize). I also need to start the range at the first column
       # past the timefmt
 
-      # I'd like to use //, but I guess some people are still on perl 5.8
-      my $rangesize = exists $options{rangesize_hash}{$id} ?
-        $options{rangesize_hash}{$id} :
-        $options{rangesize_default};
-
-      my @rest = map {$_ + $options{timefmt_Ncols}} (1..$rangesize);
+      my @rest = map {$_ + $options{timefmt_Ncols}} (1..getRangeSize($id));
 
       $usingoptions = "using 1:" . join(':', @rest);
   }
 
-  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions} $options{curvestyleall}";
+
+  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions}";
 }
 
 sub getCurve
@@ -915,13 +999,33 @@ sub getCurve
 
   if( !exists $curveIndices{$id} )
   {
-    push @curves, {extraoptions      => ' ',
+    push @curves, {# if we have a catch-all style and no specific style, use
+                   # the catch-all style
+                   extraoptions      => (!exists $options{curvestyle_hash}{$id} &&
+                                          exists $options{curvestyleall}) ?
+                                        "$options{curvestyleall} " : ' ',
                    datastring        => '',
                    datastring_meta   => [],
                    datastring_offset => 0}; # push a curve with no data and no options
     $curveIndices{$id} =  $#curves;
 
     updateCurveOptions($curves[$#curves], $id);
+
+
+    # --xlen has a meaning if we're not plotting histograms at all or if we're
+    # plotting ONLY histograms. If we're doing both at the same time, there's no
+    # consistent way to assign meaning to xlen
+    if ( defined $options{xlen} &&
+
+         # have at least some histograms
+         @{$options{histogram}} &&
+
+         # there are more curves than histogram curves, i.e. there're some
+         # non-histogram curves
+         @curves > @{$options{histogram}} ) {
+        print STDERR "--xlen only makes sense when plotting ONLY histograms or ONLY NON-histograms\n";
+        exit -1;
+    }
   }
   return $curves[$curveIndices{$id}];
 }
@@ -949,6 +1053,10 @@ sub setCurveAsHistogram
   my ($id, $str) = @_;
 
   my $curve = getCurve($id);
+
+  # With histograms I have 2d plots with rangesize=1. I thus give gnuplot two
+  # values for each point: a domain and a range. For histograms I ignore the
+  # domain, so I get the statistics of the 2nd column: $2
   $curve->{histoptions} = 'using (histbin($2)):(1.0) smooth ' . $options{histstyle};
 
   updateCurveOptions($curve, $id);
@@ -1016,7 +1124,11 @@ sub replot
         # seconds-since-the-epoch BACK to the timefmt. Sheesh
         ($xmin, $xmax) = map {Time::Piece->strptime( $_, '%s' )->strftime( $options{timefmt} ) } ($xmin, $xmax);
       }
-      sendRangeCommand( "xrange", $xmin, $xmax );
+
+      # if we have any histograms, then I'm not really visualizing the domain at
+      # all, and I don't set the range.
+      sendRangeCommand( "xrange", $xmin, $xmax )
+        unless @{$options{histogram}};
     }
 
     plotStoredData();
@@ -1041,6 +1153,9 @@ sub pushPoint
 }
 
 
+mainThread();
+
+
 =head1 NAME
 
 feedgnuplot - General purpose pipe-oriented plotting tool
@@ -1265,7 +1380,12 @@ windowsize> can be given. This will create an constantly-updating, scrolling
 view of the recent past. C<windowsize> should be replaced by the desired length
 of the domain window to plot, in domain units (passed-in values if C<--domain>
 or line numbers otherwise). If the domain is a time/date via C<--timefmt>, then
-C<windowsize> is and I<integer> in seconds.
+C<windowsize> is and I<integer> in seconds. If we're plotting a histogram, then
+C<--xlen> causes a histogram over a moving window to be computed. The subtlely
+here is that with a histogram you don't actually I<see> the domain since only
+the range is analyzed. But the domain is still there, and can be utilized with
+C<--xlen>. With C<--xlen> we can plot I<only> histograms or I<only>
+I<non>-histograms.
 
 =head3 Special data commands
 
@@ -1499,7 +1619,12 @@ C<--xlen xxx>
 
 When using C<--stream>, sets the size of the x-window to plot. Omit this or set
 it to 0 to plot ALL the data. Does not make sense with 3d plots. Implies
-C<--monotonic>
+C<--monotonic>. If we're plotting a histogram, then C<--xlen> causes a histogram
+over a moving window to be computed. The subtlely here is that with a histogram
+you don't actually I<see> the domain since only the range is analyzed. But the
+domain is still there, and can be utilized with C<--xlen>. With C<--xlen> we can
+plot I<only> histograms or I<only> I<non>-histograms.
+
 
 =item
 
@@ -1541,8 +1666,9 @@ specified for this curve (C<--curvestyle>) or all curves (C<--with>,
 C<--curvestyleall>) then the default histogram style is set: filled boxes with
 borders. This is what the user generally wants. This works with C<--domain>
 and/or C<--stream>, but in those cases the x-value is used I<only> to cull old
-data because of C<--xlen> or C<--monotonic>. I.e. the x-values are I<not> drawn
-in any way. Can be passed multiple times, or passed a comma- separated list
+data because of C<--xlen> or C<--monotonic>. I.e. the domain values are I<not>
+drawn in any way. Can be passed multiple times, or passed a comma- separated
+list
 
 =item
 
@@ -1631,6 +1757,17 @@ times.
 
 =item
 
+C<--image filename>
+
+Overlays the data on top of a raster image given in C<filename>. This is passed
+through to gnuplot via C<--equation>, and is not interpreted by C<feedgnuplot>
+other than checking for existence. Usually images have their origin at the
+top-left corner, while plots have it in the bottom-left corner instead. Thus if
+the y-axis extents are not specified (C<--ymin>, C<--ymax>, C<--set 'yrange
+...'>) this option will also flip around the y axis to make the image appear
+properly. Since this option is just a passthrough to gnuplot, finer control can
+be achieved by passing in C<--equation> and C<--set yrange ...> directly.
+
 C<--equation xxx>
 
 Gnuplot can plot both data and symbolic equations. C<feedgnuplot> generally
@@ -1749,16 +1886,15 @@ is possible to send the output produced this way to gnuplot directly.
 
 C<--exit>
 
-This controls the details of what happens when the input data is exhausted, or
-when some part of the C<feedgnuplot> pipeline is killed. This option does
-different things depending on whether C<--stream> is active, so read this
-closely.
+This controls what happens when the input data is exhausted, or when some part
+of the C<feedgnuplot> pipeline is killed. This option does different things
+depending on whether C<--stream> is active, so read this closely.
 
 With interactive gnuplot terminals (qt, x11, wxt), the plot windows live in a
 separate process from the main C<gnuplot> process. It is thus possible for the
 main C<gnuplot> process to exit, while leaving the plot windows up (a caveat is
-that such decapitated windows aren't interactive). To be clear, there are 3
-possible states:
+that such decapitated windows aren't interactive). There are 3 possible states
+of the polotting pipeline:
 
 =over
 
@@ -1773,35 +1909,35 @@ prompt available
 
 =back
 
-The C<--exit> option controls the details of this behavior. The possibilities
-are:
+The possibilities are:
 
 =over
 
-=item No C<--stream>, input pipe is exhausted (all data read in)
+=item No C<--stream>, all data read in
 
 =over
 
-=item default; no C<--exit>
+=item no C<--exit> (default)
 
 Alive. Need to Ctrl-C to get back into the shell
 
 =item C<--exit>
 
 Half-alive. Non-interactive prompt up, and the shell accepts new commands.
-Without C<--stream> the goal is to show a plot, so a Dead state is not useful
-here.
+Without C<--stream> the goal is to show a plot, so a Dead state would not be
+useful.
 
 =back
 
-=item C<--stream>, input pipe is exhausted (all data read in) or the
-C<feedgnuplot> process terminated
+=item C<--stream>, all data read in or the C<feedgnuplot> process terminated
 
 =over
 
-=item default; no C<--exit>
+=item no C<--exit> (default)
 
-Alive. Need to Ctrl-C to get back into the shell
+Alive. Need to Ctrl-C to get back into the shell. This means that when making
+live plots, the first Ctrl-C kills the data feeding process, but leaves the
+final plot up for inspection. A second Ctrl-C kills feedgnuplot as well.
 
 =item C<--exit>
 
@@ -1883,13 +2019,34 @@ in a Thinkpad.
      --binwidth 10
      --ymin 0 --xlabel 'File size (MB)' --ylabel Frequency
 
+=head2 Plotting a live histogram of the ping round-trip times for the past 20 seconds
+
+ $ ping -A -D 8.8.8.8 |
+   perl -anE 'BEGIN { $| = 1; }
+              $F[0] =~ s/[\[\]]//g or next;
+              $F[7] =~ s/.*=//g    or next;
+              say "$F[0] $F[7]"' |
+   feedgnuplot --stream --domain --histogram 0 --binwidth 10 \
+               --xlabel 'Ping round-trip time (s)'  \
+               --ylabel Frequency --xlen 20
+
 =head2 Plotting points on top of an existing image
 
-This can be done by using C<--equation> to pass arbitrary plot input to gnuplot:
+This can be done with C<--image>:
+
+ $ < features_xy.data
+   feedgnuplot --points --domain --image "image.png"
+
+or with C<--equation>:
 
  $ < features_xy.data
    feedgnuplot --points --domain
-     --equation '"image.png" binary filetype=png flipy with rgbimage'
+     --equation '"image.png" binary filetype=auto flipy with rgbimage'
+     --set 'yrange [:] reverse'
+
+The C<--image> invocation is a convenience wrapper for the C<--equation>
+version. Finer control is available with C<--equation>.
+
 
 Here an existing image is given to gnuplot verbatim, and data to plot on top of
 it is interpreted by feedgnuplot as usual. C<flipy> is useful here because

completions/bash/feedgnuplot

@@ -21,6 +21,7 @@ complete -W               \
     --set                 \
     --unset               \
     --equation            \
+    --image               \
     --geometry            \
     --hardcopy            \
     --help                \

completions/zsh/_feedgnuplot

@@ -33,9 +33,10 @@ _arguments -S
     '*--set[Additional 'set' gnuplot commands]:set-option'                        \
     '*--unset[Additional 'unset' gnuplot commands]:unset-option'                  \
     '*--equation[Raw symbolic equation]:equation'                                 \
+    '--image[Image file to render beneath the data]:image:_files -g "(#i)*.(jpg|jpeg|png|gif)"' \
     '--square[Plot data with square aspect ratio]'                                \
     '--square_xy[For 3D plots, set square aspect ratio for ONLY the x,y axes]'    \
-    '--hardcopy[Plot to a file]:filename'                                         \
+    '--hardcopy[Plot to a file]:new image filename:_files -g "(#i)*.(jpg|jpeg|png|gif)"' \
     '--maxcurves[The maximum allowed number of curves]:number of curves'          \
     '(--3d)--monotonic[Resets plot if an X in the past is seen]'                  \
     '(--rangesizeall)--extraValuesPerPoint[How many extra values are given for each data range]:N'\

debian/changelog

@@ -1,3 +1,44 @@
+feedgnuplot (1.45-1) unstable; urgency=medium
+
+  * zsh completion: --hardcopy, --image  suggest filenames
+  * --image now produces a nicer legend: just the filename
+  * --curvestyle now overrides --curvestyleall
+    - This is a bug fix
+  * The version is now treated as a string not as a number
+    - So "1.40" is distinct from "1.4"
+
+ -- Dima Kogan <dkogan@debian.org>  Sun, 29 Oct 2017 14:06:26 -0700
+
+feedgnuplot (1.44-1) unstable; urgency=medium
+
+  * --image always goes on the FRONT of the equation list
+
+ -- Dima Kogan <dkogan@debian.org>  Tue, 20 Jun 2017 16:45:42 -0700
+
+feedgnuplot (1.43-1) unstable; urgency=medium
+
+  * added --image as a convenience wrapper for --equation
+
+ -- Dima Kogan <dkogan@debian.org>  Mon, 19 Jun 2017 13:16:18 -0700
+
+feedgnuplot (1.42-1) unstable; urgency=medium
+
+  * Upstream update:
+    - Fixed regression: data can now come from STDIN or files on the
+      cmdline
+    - reworded manpage of --exit
+
+ -- Dima Kogan <dkogan@debian.org>  Tue, 25 Apr 2017 11:02:18 -0700
+
+feedgnuplot (1.41-1) unstable; urgency=medium
+
+  * Upstream update:
+    - Histograms: --xlen can coexist with --xmin/--xmax
+    - Histograms: work as expected with --xlen and --monotonic
+    - Histograms: better sanity checking of options
+
+ -- Dima Kogan <dkogan@debian.org>  Fri, 24 Feb 2017 23:53:27 -0800
+
 feedgnuplot (1.40-1) unstable; urgency=medium
 
   * Upstream update: