version bump

I delete the with option after I use it. This is defensive and clarifies the
intent

Changes

@@ -1,3 +1,39 @@
+feedgnuplot (1.40)
+
+  * If the options couldn't be parsed I don't dump the whole manpage
+  * --style and --rangesize can now take a comma-separated list of IDs
+  * 'any' is from List::MoreUtils, not List::Util
+  * the sleep-forever delay at end is now > 1000 days
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 25 Nov 2016 14:45:06 -0800
+
+feedgnuplot (1.39)
+
+  * by default, histograms are plotted in expected ways
+
+ -- Dima Kogan <dima@secretsauce.net>  Sat, 15 Oct 2016 20:45:15 -0700
+
+feedgnuplot (1.38)
+
+  * hardcopy defaults:
+   - no enhanced text mode
+   - larger font size
+
+ -- Dima Kogan <dima@secretsauce.net>  Wed, 27 Jul 2016 22:15:11 -0700
+
+feedgnuplot (1.37)
+
+  * At the end of a streaming plot, include the last chunk of data
+  * Added --equation to the completions
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 01 Jan 2016 08:09:43 -0800
+
+feedgnuplot (1.36)
+
+  * Added --equation to plot symbolic equations
+
+ -- Dima Kogan <dima@secretsauce.net>  Fri, 13 Nov 2015 11:08:26 -0800
+
 feedgnuplot (1.35)
 
   * replaced a 'say' with 'print'. Should work better with ancient perls

Makefile.PL

@@ -64,6 +64,7 @@ WriteMakefile
    PL_FILES                   => {},
    EXE_FILES                  => [ 'bin/feedgnuplot' ],
    BUILD_REQUIRES             => { 'String::ShellQuote' => 0,
+                                   'List::MoreUtils'    => 0,
                                    'IPC::Run'           => 0},
    dist                       => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', },
    clean                      => { FILES => 'feedgnuplot-*' },

bin/feedgnuplot

@@ -9,12 +9,13 @@ use Time::HiRes qw( usleep gettimeofday tv_interval );
 use IO::Handle;
 use IO::Select;
 use List::Util qw( first );
+use List::MoreUtils 'any';
 use Scalar::Util qw( looks_like_number );
 use Text::ParseWords; # for shellwords
 use Pod::Usage;
 use Time::Piece;
 
-my $VERSION = 1.35;
+my $VERSION = 1.40;
 
 my %options;
 interpretCommandline();
@@ -89,6 +90,7 @@ sub interpretCommandline
   $options{extracmds}  = [];
   $options{set}        = [];
   $options{unset}      = [];
+  $options{equation}   = [];
 
   $options{curvestyleall} = '';
   $options{styleall}      = '';
@@ -102,13 +104,12 @@ sub interpretCommandline
              'zmin=f', 'zmax=f', 'y2=s@',
              '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@',
              'histogram=s@', 'binwidth=f', 'histstyle=s',
              'terminal=s',
              'rangesize=s{2}', 'rangesizeall=i', 'extraValuesPerPoint=i',
              'help', 'dump', 'exit', 'version',
-             'geometry=s') or pod2usage( -exitval => 1,
-                                         -verbose => 1, # synopsis and args
-                                         -output  => \*STDERR );
+             'geometry=s') or exit 1;
 
 
   # handle various cmdline-option errors
@@ -125,28 +126,72 @@ sub interpretCommandline
     exit 0;
   }
 
+  # --style and --curvestyle are synonyms, as are --styleall and
+  # --curvestyleall, so fill that in
+  if( $options{styleall} )
+  {
+    if($options{curvestyleall} ) { $options{curvestyleall} .= " $options{styleall}"; }
+    else                         { $options{curvestyleall}  =   $options{styleall};  }
+    delete $options{styleall};
+  }
+
+  push @{$options{curvestyle}}, @{$options{style}};
+  delete $options{style};
+
+  if( $options{curvestyleall} && $options{with} )
+  {
+    print STDERR "--curvestyleall and --with are mutually exclusive. Please just use one.\n";
+    exit -1;
+  }
+  if( $options{with} )
+  {
+    $options{curvestyleall} = "with $options{with}";
+    delete $options{with};
+  }
+
+
   # expand options that are given as comma-separated lists
   for my $listkey (qw(histogram y2))
   {
     @{$options{$listkey}} = map split('\s*,\s*', $_), @{$options{$listkey}}
       if defined $options{$listkey};
   }
-
-  # --style and --curvestyle are synonyms, as are --styleall and
-  # --curvestyleall, so fill that in
-  if( $options{styleall} )
+  for my $listkey (qw(curvestyle rangesize))
   {
-    if($options{curvestyleall} )
-    {
-      $options{curvestyleall} .= " $options{styleall}";
-    }
-    else
-    {
-      $options{curvestyleall} = $options{styleall};
-    }
-  }
-  push @{$options{curvestyle}}, @{$options{style}};
+      next unless defined $options{$listkey};
+      my @in = @{$options{$listkey}};
+      my $N = @in / 2;
+      my @out;
+      for my $i (0..$N-1)
+      {
+          my $key   = $in[2*$i];
+          my $value = $in[2*$i + 1];
+          for my $key_new (split('\s*,\s*', $key))
+          {
+              push @out, $key_new, $value;
+          }
+      }
 
+      @{$options{$listkey}} = @out;
+  }
+
+
+  # If we're plotting histograms, then set the default histogram options for
+  # each histogram curve
+  #
+  # Apply this to plain (non-cumulative) histograms
+  if( !$options{curvestyleall} && $options{histstyle} =~ /freq|fnorm/ )
+  {
+      for my $hist_curve(@{$options{histogram}})
+      {
+          # If we don't specify any options specifically for this histogram, use
+          # the defaults: filled boxes with borders
+          if( !any { $options{curvestyle}[$_*2] eq $hist_curve } 0..(@{$options{curvestyle}}/2 - 1) )
+          {
+              push @{$options{curvestyle}}, ($hist_curve, 'with boxes fill solid border lt -1');
+          }
+      }
+  }
 
   # --legend and --curvestyle options are conceptually hashes, but are parsed as
   # arrays in order to preserve the ordering. I parse both of these into hashes
@@ -229,17 +274,6 @@ sub interpretCommandline
     }
   }
 
-  if( $options{curvestyleall} && $options{with} )
-  {
-    print STDERR "--curvestyleall and --with are mutually exclusive. Please just use one.\n";
-    exit -1;
-  }
-  if( $options{with} )
-  {
-    $options{curvestyleall} = "with $options{with}";
-    $options{with} = '';
-  }
-
   if ($options{colormap})
   {
     # colormap styles all curves with palette. Seems like there should be a way to do this with a
@@ -331,9 +365,9 @@ sub interpretCommandline
   # --xlen implies an order to the data, so I force monotonicity
   $options{monotonic} = 1 if defined $options{xlen};
 
-  if( $options{histstyle} !~ /freq|cum|uniq|cnorm/ )
+  if( $options{histstyle} !~ /freq|cum|uniq|cnorm|fnorm/ )
   {
-    print STDERR "unknown histstyle. Allowed are 'freq...', 'cum...', 'uniq...', 'cnorm...'\n";
+    print STDERR "unknown histstyle. Allowed are 'freq...', 'fnorm...', 'cum...', 'uniq...', 'cnorm...'\n";
     exit -1;
   }
 
@@ -495,11 +529,11 @@ sub mainThread
       }
 
       my %terminalOpts =
-      ( eps  => 'postscript solid color enhanced eps',
-        ps   => 'postscript solid color landscape 10',
-        pdf  => 'pdfcairo solid color font ",10" size 11in,8.5in',
-        png  => 'png size 1280,1024',
-        svg  => 'svg');
+      ( eps  => 'postscript noenhanced solid color enhanced eps',
+        ps   => 'postscript noenhanced solid color landscape 12',
+        pdf  => 'pdfcairo noenhanced solid color font ",12" size 11in,8.5in',
+        png  => 'png noenhanced size 1280,1024',
+        svg  => 'svg noenhanced');
 
       if( !defined $options{terminal} &&
            defined $outputfileType    &&
@@ -550,7 +584,7 @@ sub mainThread
       print(PIPE "set view equal xy\n");
     }
 
-# For the specified values, set the legend entries to 'title "blah blah"'
+    # For the specified values, set the legend entries to 'title "blah blah"'
     if(@{$options{legend}})
     {
       # @{$options{legend}} is a list where consecutive pairs are (curveID,
@@ -565,13 +599,11 @@ sub mainThread
       }
     }
 
-# add the extra curve options
+    # add the extra curve options
     if(@{$options{curvestyle}})
     {
       # @{$options{curvestyle}} is a list where consecutive pairs are (curveID,
-      # style). I use $options{curvestyle} here instead of
-      # $options{curvestyle_hash} because I create a new curve when I see a new
-      # one, and the hash is unordered, thus messing up the ordering
+      # style).
       my $n = scalar @{$options{curvestyle}}/2;
       foreach my $idx (0..$n-1)
       {
@@ -580,22 +612,22 @@ sub mainThread
       }
     }
 
-# For the values requested to be printed on the y2 axis, set that
+    # For the values requested to be printed on the y2 axis, set that
     addCurveOption($_, 'axes x1y2') foreach (@{$options{y2}});
 
-# timefmt
+    # timefmt
     if( $options{timefmt} )
     {
       print(PIPE "set timefmt '$options{timefmt}'\n");
       print(PIPE "set xdata time\n");
     }
 
-# add the extra global options
+    # 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
+    # set up histograms
     $options{binwidth} ||= 1;   # if no binwidth given, set it to 1
     print PIPE
       "set boxwidth $options{binwidth}\n" .
@@ -603,11 +635,6 @@ sub mainThread
 
     setCurveAsHistogram( $_ ) foreach (@{$options{histogram}});
 
-# set all the axis ranges
-    # If a bound isn't given I want to set it to the empty string, so I can communicate it simply to
-    # gnuplot
-    print PIPE "set xtics\n";
-
     if(@{$options{y2}})
     {
       print PIPE "set ytics nomirror\n";
@@ -747,7 +774,7 @@ sub mainThread
     }
 
     # finished reading in all. Plot what we have
-    plotStoredData() unless $options{stream};
+    plotStoredData() unless $options{stream} && $options{exit};
 
     if ( defined $options{hardcopy})
     {
@@ -778,7 +805,7 @@ sub mainThread
     # we persist gnuplot, so we shouldn't need this sleep. However, once
     # gnuplot exits, but the persistent window sticks around, you can no
     # longer interactively zoom the plot. So we still sleep
-    sleep(100000) unless $options{dump} || $options{exit};
+    sleep(100000000) unless $options{dump} || $options{exit};
 }
 
 sub pruneOldData
@@ -818,7 +845,9 @@ sub plotStoredData
   my @nonemptyCurves = grep { $_->{datastring} } @curves;
   my @extraopts = map {$_->{options}} @nonemptyCurves;
 
-  my $body = join(', ' , map({ "'-' $_" } @extraopts) );
+  my $body = join('', map { "$_," } @{$options{equation}});
+  $body .= join(', ' , map({ "'-' $_" } @extraopts) );
+
   if($options{'3d'}) { print PIPE "splot $body\n"; }
   else               { print PIPE  "plot $body\n"; }
 
@@ -847,19 +876,6 @@ sub updateCurveOptions
   { $title = $id; }
 
   my $titleoption = defined $title ? "title \"$title\"" : "notitle";
-
-  my ($curvestyleall);
-  if( defined $options{curvestyle_hash}{$id} )
-  {
-    # I have a curve-specific style set with --curvestyle. This style lives in
-    # $curve->{extraoptions}, and it overrides the global styles
-    $curvestyleall = '';
-  }
-  else
-  {
-    $curvestyleall = $options{curvestyleall};
-  }
-
   my $histoptions = $curve->{histoptions} || '';
 
   my $usingoptions = '';
@@ -880,7 +896,7 @@ sub updateCurveOptions
       $usingoptions = "using 1:" . join(':', @rest);
   }
 
-  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions} $curvestyleall";
+  $curve->{options} = "$histoptions $usingoptions $titleoption $curve->{extraoptions} $options{curvestyleall}";
 }
 
 sub getCurve
@@ -1282,7 +1298,9 @@ This command causes feedgnuplot to exit.
 The script is able to produce hardcopy output with C<--hardcopy outputfile>. The
 output type can be inferred from the filename, if B<.ps>, B<.eps>, B<.pdf>,
 B<.svg> or B<.png> is requested. If any other file type is requested,
-C<--terminal> I<must> be passed in to tell gnuplot how to make the plot.
+C<--terminal> I<must> be passed in to tell gnuplot how to make the plot. If
+C<--terminal> is passed in, then the C<--hardcopy> argument only provides the
+output filename.
 
 =head2 Self-plotting data files
 
@@ -1517,11 +1535,11 @@ passing something like
 
 C<--histogram curveID>
 
-
 Set up a this specific curve to plot a histogram. The bin width is given with
-the C<--binwidth> option (assumed 1.0 if omitted). C<--histogram> does I<not>
-touch the drawing style. It is often desired to plot these with boxes, and this
-I<must> be explicitly requested by C<--with boxes>. This works with C<--domain>
+the C<--binwidth> option (assumed 1.0 if omitted). If a drawing style is not
+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
@@ -1537,21 +1555,24 @@ in the plot. Defaults to 1.0 if not given.
 
 C<--histstyle style>
 
-Normally, histograms are generated with the 'smooth freq' gnuplot style.
-C<--histstyle> can be used to select different 'smooth' settings. Allowed are
-'unique', 'cumulative' and 'cnormal'. 'unique' indicates whether a bin has at
-least one item in it: instead of counting the items, it'll always report 0 or 1.
-'cumulative' is the integral of the "normal" histogram. 'cnormal' is like
-'cumulative', but rescaled to end up at 1.0.
+Normally, histograms are generated with the 'smooth frequency' gnuplot style.
+C<--histstyle> can be used to select different C<smooth> settings (see the
+gnuplot C<help smooth> page for more info). Allowed values are 'frequency' (the
+default), 'fnormal' (available in very recent gnuplots), 'unique', 'cumulative'
+and 'cnormal'. 'fnormal' is a normalized histogram. 'unique' indicates whether a
+bin has at least one item in it: instead of counting the items, it'll always
+report 0 or 1. 'cumulative' is the integral of the 'frequency' histogram.
+'cnormal' is like 'cumulative', but rescaled to end up at 1.0.
 
 =item
 
 C<--style curveID style>
 
 Additional styles per curve. With C<--dataid>, curveID is the ID. Otherwise,
-it's the index of the curve, starting at 0. Use this option multiple times for
-multiple curves. C<--styleall> does I<not> apply to curves that have a
-C<--style>
+it's the index of the curve, starting at 0. curveID can be a comma-separated
+list of IDs to which the given style should apply. Use this option multiple
+times for multiple curves. C<--styleall> does I<not> apply to curves that have a
+C<--style>.
 
 =item
 
@@ -1610,6 +1631,34 @@ times.
 
 =item
 
+C<--equation xxx>
+
+Gnuplot can plot both data and symbolic equations. C<feedgnuplot> generally
+plots data, but with this option can plot symbolic equations I<also>. This is
+generally intended to augment data plots, since for equation-only plots you
+don't need C<feedgnuplot>. C<--equation> can be passed multiple times for
+multiple equations. The given strings are passed to gnuplot directly without any
+thing added or removed, so styling and such should be applied in the string. A
+basic example:
+
+ seq 100 | awk '{print $1/10, $1/100}' |
+   feedgnuplot --with 'lines lw 3' --domain --ymax 1
+               --equation 'sin(x)/x' --equation 'cos(x)/x with lines lw 4'
+
+Here I plot the incoming data (points along a line) with the given style (a line
+with thickness 3), I<and> I plot two damped sinusoids on the same plot. The
+sinusoids are not affected by C<feedgnuplot> styling, so their styles are set
+separately, as in this example. More complicated example:
+
+ seq 360 | perl -nE '$th=$_/360 * 3.14*2; $c=cos($th); $s=sin($th); say "$c $s"' |
+   feedgnuplot --domain --square
+               --set parametric --set "trange [0:2*3.14]" --equation "sin(t),cos(t)"
+
+Here the data I generate is points along the unit circle. I plot these as
+points, and I I<also> plot a true circle as a parametric equation.
+
+=item
+
 C<--square>
 
 Plot data with aspect ratio 1. For 3D plots, this controls the aspect ratio for
@@ -1626,16 +1675,17 @@ For 3D plots, set square aspect ratio for ONLY the x,y axes
 C<--hardcopy xxx>
 
 If not streaming, output to a file specified here. Format inferred from
-filename, unless specified by C<--terminal>
+filename, unless specified by C<--terminal>. If C<--terminal> is given,
+C<--hardcopy> sets I<only> the output filename.
 
 =item
 
 C<--terminal xxx>
 
 String passed to 'set terminal'. No attempts are made to validate this.
-C<--hardcopy> sets this to some sensible defaults if --hardcopy is given .png,
-.pdf, .ps, .eps or .svg. If any other file type is desired, use both
-C<--hardcopy> and C<--terminal>
+C<--hardcopy> sets this to some sensible defaults if C<--hardcopy> is set to a
+filename ending in C<.png>, C<.pdf>, C<.ps>, C<.eps> or C<.svg>. If any other
+file type is desired, use both C<--hardcopy> and C<--terminal>
 
 =item
 
@@ -1668,6 +1718,10 @@ C<--rangesize> is used to set how many values are needed to represent the range
 of a point for a particular curve. This overrides any defaults that may exist
 for this curve only.
 
+With C<--dataid>, curveID is the ID. Otherwise, it's the index of the curve,
+starting at 0. curveID can be a comma-separated list of IDs to which the given
+rangesize should apply.
+
 =item
 
 C<--rangesizeall xxx>
@@ -1825,10 +1879,23 @@ in a Thinkpad.
 =head2 Plotting a histogram of file sizes in a directory, granular to 10MB
 
  $ ls -l | awk '{print $5/1e6}' |
-   feedgnuplot --histogram 0 --with boxes
-     --binwidth 10 --set 'style fill solid'
+   feedgnuplot --histogram 0
+     --binwidth 10
      --ymin 0 --xlabel 'File size (MB)' --ylabel Frequency
 
+=head2 Plotting points on top of an existing image
+
+This can be done by using C<--equation> to pass arbitrary plot input to gnuplot:
+
+ $ < features_xy.data
+   feedgnuplot --points --domain
+     --equation '"image.png" binary filetype=png flipy with rgbimage'
+
+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
+usually the y axis points up, but when looking at images, this is usually
+reversed: the origin is the top-left pixel.
+
 =head1 ACKNOWLEDGEMENT
 
 This program is originally based on the driveGnuPlots.pl script from

completions/bash/feedgnuplot

@@ -20,6 +20,7 @@ complete -W               \
     --extracmds           \
     --set                 \
     --unset               \
+    --equation            \
     --geometry            \
     --hardcopy            \
     --help                \

completions/zsh/_feedgnuplot

@@ -32,6 +32,7 @@ _arguments -S
     '*--extracmds[Additional gnuplot commands]:command'                           \
     '*--set[Additional 'set' gnuplot commands]:set-option'                        \
     '*--unset[Additional 'unset' gnuplot commands]:unset-option'                  \
+    '*--equation[Raw symbolic equation]:equation'                                 \
     '--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'                                         \

feedgnuplot.spec

@@ -0,0 +1,58 @@
+# Sample spec file for rpm-based systems. Debian-based systems already have this
+# packaged, so we do not ship those here
+
+Name:           feedgnuplot
+Version:        1.38
+Release:        1%{?dist}
+Summary:        Pipe-oriented frontend to Gnuplot
+BuildArch:      noarch
+
+License:        Artistic or GPL-1+
+URL:            https://www.github.com/dkogan/feedgnuplot/
+Source0:        https://www.github.com/dkogan/feedgnuplot/archive/v%{version}.tar.gz#/%{name}-%{version}.tar.gz
+
+BuildRequires:  /usr/bin/pod2html
+BuildRequires:  perl-String-ShellQuote
+BuildRequires:  perl-ExtUtils-MakeMaker
+BuildRequires:  perl
+BuildRequires:  gawk
+BuildRequires:  gnuplot
+BuildRequires:  perl-IPC-Run
+
+Requires:       gnuplot
+
+%description
+Flexible, command-line-oriented frontend to Gnuplot. Creates plots from data
+coming in on STDIN or given in a filename passed on the commandline. Various
+data representations are supported, as is hardcopy output and streaming display
+of live data.
+
+%prep
+%setup -q
+
+%build
+perl Makefile.PL INSTALLDIRS=vendor
+make
+pod2html --title=feedgnuplot bin/feedgnuplot > feedgnuplot.html
+
+%install
+make install DESTDIR=%{buildroot} PREFIX=/usr
+
+mkdir -p %{buildroot}%{_defaultdocdir}/%{name}
+cp Changes LICENSE feedgnuplot.html %{buildroot}%{_defaultdocdir}/%{name}
+
+mkdir -p %{buildroot}%{_datadir}/zsh/site-functions
+cp completions/zsh/* %{buildroot}%{_datadir}/zsh/site-functions
+
+mkdir -p %{buildroot}%{_datadir}/bash-completion/completions
+cp completions/bash/* %{buildroot}%{_datadir}/bash-completion/completions
+
+rm -rf %{buildroot}/usr/lib64
+
+
+%files
+%{_bindir}/*
+%{_datadir}/zsh/*
+%{_datadir}/bash-completion/*
+%doc %{_defaultdocdir}/%{name}/*
+%doc %{_mandir}