version bump

This looks like a large patch, but it's 99% re-indentation

Changes

@@ -1,3 +1,38 @@
+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
+  * an "exit" command now has effect even with triggered-only replotting
+
+  * More sophisticated handling of termination conditions:
+    - Without --exit, we always end up with an interactive plot when the
+    input data is exhausted or when the user sends a ^C to the pipeline
+    - When streaming, the first ^C does not kill feedgnuplot
+  
+  * Removed threading
+
+ -- Dima Kogan <dima@secretsauce.net>  Sun, 01 Nov 2015 12:50:33 -0800
+
 feedgnuplot (1.34)
 
   * Fix for "Use of implicit split to @_ is deprecated". Thanks to Corey

bin/feedgnuplot

@@ -7,16 +7,14 @@ use warnings;
 use Getopt::Long;
 use Time::HiRes qw( usleep gettimeofday tv_interval );
 use IO::Handle;
+use IO::Select;
 use List::Util qw( first );
 use Scalar::Util qw( looks_like_number );
-use Text::ParseWords;
-use threads;
-use threads::shared;
-use Thread::Queue;
+use Text::ParseWords; # for shellwords
 use Pod::Usage;
 use Time::Piece;
 
-my $VERSION = 1.34;
+my $VERSION = 1.38;
 
 my %options;
 interpretCommandline();
@@ -29,16 +27,11 @@ interpretCommandline();
 # with --xlen, the offsets are preserved by using $curve->{datastring_offset} to
 # represent the offset IN THE ORIGINAL STRING of the current start of the
 # datastring
-
-
 my @curves = ();
 
 # list mapping curve names to their indices in the @curves list
 my %curveIndices = ();
 
-# now start the data acquisition and plotting threads
-my $dataQueue;
-
 # Whether any new data has arrived since the last replot
 my $haveNewData;
 
@@ -48,39 +41,16 @@ my $last_replot_time = [gettimeofday];
 # whether the previous replot was timer based
 my $last_replot_is_from_timer = 1;
 
-my $streamingFinished : shared = undef;
 
-if($options{stream})
-{
-  $dataQueue  = Thread::Queue->new();
-  my $addThr  = threads->create(\&mainThread);
+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 );
 
-  # spawn the plot updating thread. If I'm replotting from a data trigger, I don't need this
-  my $plotThr = threads->create(\&plotUpdateThread) if $options{stream} > 0;
 
-  while(<>)
-  {
-    chomp;
 
-    last if /^exit/;
-
-    # place every line of input to the queue, so that the plotting thread can process it. if we are
-    # using an implicit domain (x = line number), then we send it on the data queue also, since
-    # $. is not meaningful in the plotting thread
-    if(!$options{domain})
-    {
-      $_ .= " $.";
-    }
-    $dataQueue->enqueue($_);
-  }
-
-  $streamingFinished = 1;
-
-  $plotThr->join() if defined $plotThr;
-  $addThr->join();
-}
-else
-{ mainThread(); }
+mainThread();
 
 
 
@@ -119,6 +89,7 @@ sub interpretCommandline
   $options{extracmds}  = [];
   $options{set}        = [];
   $options{unset}      = [];
+  $options{equation}   = [];
 
   $options{curvestyleall} = '';
   $options{styleall}      = '';
@@ -132,6 +103,7 @@ 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',
@@ -227,6 +199,9 @@ sub interpretCommandline
   #  -1 for triggered replotting
   #  >0 for timed replotting
   #  undef if not streaming
+  #
+  #  Note that '0' is not allowed, so !$options{stream} will do the expected
+  #  thing
   if(defined $options{stream})
   {
     # if no streaming period is given, default to 1Hz.
@@ -383,7 +358,7 @@ sub interpretCommandline
     {
       if( $options{xlen} - int($options{xlen}) )
       {
-        say STDERR "When streaming --xlen MUST be an integer. Rounding up to the nearest second";
+        print STDERR "When streaming --xlen MUST be an integer. Rounding up to the nearest second\n";
         $options{xlen} = 1 + int($options{xlen});
       }
     }
@@ -404,19 +379,6 @@ sub getGnuplotVersion
   return $gnuplotVersion;
 }
 
-sub plotUpdateThread
-{
-  while(! $streamingFinished)
-  {
-    usleep( $options{stream} * 1e6 );
-
-    # indicate that the timer was the replot source
-    $dataQueue->enqueue('replot timertick');
-  }
-
-  $dataQueue->enqueue(undef);
-}
-
 sub sendRangeCommand
 {
   my ($name, $min, $max) = @_;
@@ -452,16 +414,64 @@ sub makeDomainNumeric
   return $domain0;
 }
 
+
+sub getNextLine
+{
+    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);
+
+
+        my $now = [gettimeofday];
+        my $time_remaining = $options{stream} - tv_interval($prev_timed_replot_time, $now);
+
+        if ( $time_remaining < 0 )
+        {
+            $prev_timed_replot_time = $now;
+            $this_replot_is_from_timer = 1;
+            return 'replot';
+        }
+
+        if ($selector->can_read($time_remaining))
+        {
+            return $stdin->getline();
+        }
+    }
+}
+
 sub mainThread
 {
     local *PIPE;
     my $dopersist = '';
 
-    if( !$options{stream} && getGnuplotVersion() >= 4.3)
+    if( getGnuplotVersion() >= 4.3 && # --persist not available before this
+
+        # --persist is needed for the "half-alive" state (see documentation for
+        # --exit). This state is only used with these options:
+        !$options{stream} && $options{exit})
     {
       $dopersist = '--persist';
     }
 
+    # We trap SIGINT to kill the data input, but keep the plot up. see
+    # documentation for --exit
+    if ($options{stream} && !$options{exit})
+    {
+        $SIG{INT} = sub
+        {
+            print STDERR "$0 received SIGINT. Send again to quit\n";
+            $SIG{INT} = undef;
+        };
+    }
+
+
+
+
     if(exists $options{dump})
     {
       *PIPE = *STDOUT;
@@ -487,11 +497,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    &&
@@ -542,7 +552,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,
@@ -557,7 +567,7 @@ 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,
@@ -572,22 +582,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" .
@@ -595,11 +605,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";
@@ -628,8 +633,7 @@ sub mainThread
     # number of seconds since the UNIX epoch.
     my $domain0_numeric;
 
-    # I should be using the // operator, but I'd like to be compatible with perl 5.8
-    while( $_ = (defined $dataQueue ? $dataQueue->dequeue() : <>))
+    while( defined ($_ = getNextLine()) )
     {
       next if /^#/o;
 
@@ -643,16 +647,13 @@ sub mainThread
 
         if(/^replot/o )
         {
-          # /timertick/ determines if the timer was the source of the replot
-          replot( $domain0_numeric, /timertick/ );
+          replot( $domain0_numeric );
           next;
         }
 
-        # /exit/ is handled in the data-reading thread
+        last if /^exit/o;
       }
 
-      if(! /^replot/o)
-      {
       # parse the incoming data lines. The format is
       # x id0 dat0 id1 dat1 ....
       # where idX is the ID of the curve that datX corresponds to
@@ -709,17 +710,8 @@ sub mainThread
         }
       }
       else
-        {
-          # since $. is not meaningful in the plotting thread if we're using the data queue, we pass
-          # $. on the data queue in that case
-          if(defined $dataQueue)
-          {
-            $domain[0] = pop @fields;
-          }
-          else
       {
         $domain[0] = $.;
-          }
         $domain0_numeric = makeDomainNumeric( $domain[0] );
       }
 
@@ -750,16 +742,9 @@ sub mainThread
                     $domain0_numeric);
       }
     }
-    }
-
-    # if we were streaming, we're now done!
-    if( $options{stream} )
-    {
-      return;
-    }
 
     # finished reading in all. Plot what we have
-    plotStoredData();
+    plotStoredData() unless $options{stream} && $options{exit};
 
     if ( defined $options{hardcopy})
     {
@@ -768,7 +753,7 @@ sub mainThread
       # sleep until the plot file exists, and it is closed. Sometimes the output
       # is still being written at this point. If the output filename starts with
       # '|', gnuplot pipes the output to that process, instead of writing to a
-      # file. In that case I don't make sure the file exists, since there IS not
+      # file. In that case I don't make sure the file exists, since there IS no
       # file
       if( $options{hardcopy} !~ /^\|/ )
       {
@@ -780,6 +765,13 @@ sub mainThread
       return;
     }
 
+    # data exhausted. If we're killed now, then we should peacefully die.
+    if($options{stream} && !$options{exit})
+    {
+        print STDERR "Input data exhausted\n";
+        $SIG{INT} = undef;
+    }
+
     # 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
@@ -823,7 +815,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"; }
 
@@ -977,7 +971,7 @@ sub replot
   # }
 
 
-  my ($domain0_numeric, $replot_is_from_timer) = @_;
+  my ($domain0_numeric) = @_;
 
   my $now = [gettimeofday];
 
@@ -987,7 +981,7 @@ sub replot
       # if the last replot was timer-based, but this one isn't, force a replot.
       # This makes sure that a replot happens for a domain rollover shortly
       # after a timer replot
-      !$replot_is_from_timer && $last_replot_is_from_timer ||
+      !$this_replot_is_from_timer && $last_replot_is_from_timer ||
 
       # if enough time has elapsed since the last replot, it's ok to replot
       tv_interval ( $last_replot_time, $now ) > 0.8*$options{stream} )
@@ -1013,7 +1007,7 @@ sub replot
 
     # update replot state
     $last_replot_time          = $now;
-    $last_replot_is_from_timer = $replot_is_from_timer;
+    $last_replot_is_from_timer = $this_replot_is_from_timer;
   }
 }
 
@@ -1542,12 +1536,17 @@ 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), '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 'frequency' histogram. 'cnormal' is
+like 'cumulative', but rescaled to end up at 1.0. Note that there's no
+normalized 'frequency' option because gnuplot does not provide one.
+
+
+C<help smooth>
 
 =item
 
@@ -1615,6 +1614,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
@@ -1700,10 +1727,80 @@ is possible to send the output produced this way to gnuplot directly.
 
 C<--exit>
 
-Terminate the feedgnuplot process after passing data to gnuplot. The window will
-persist but will not be interactive. Without this option feedgnuplot keeps
-running and must be killed by the user. Note that this option works only with
-later versions of gnuplot and only with some gnuplot terminals.
+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.
+
+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:
+
+=over
+
+=item Alive: C<feedgnuplot>, C<gnuplot> alive, plot window process alive, no
+shell prompt (shell busy with C<feedgnuplot>)
+
+=item Half-alive: C<feedgnuplot>, C<gnuplot> dead, plot window process alive
+(but non-interactive), shell prompt available
+
+=item Dead: C<feedgnuplot>, C<gnuplot> dead, plot window process dead, shell
+prompt available
+
+=back
+
+The C<--exit> option controls the details of this behavior. The possibilities
+are:
+
+=over
+
+=item No C<--stream>, input pipe is exhausted (all data read in)
+
+=over
+
+=item default; no C<--exit>
+
+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.
+
+=back
+
+=item C<--stream>, input pipe is exhausted (all data read in) or the
+C<feedgnuplot> process terminated
+
+=over
+
+=item default; no C<--exit>
+
+Alive. Need to Ctrl-C to get back into the shell
+
+=item C<--exit>
+
+Dead. No plot is shown, and the shell accepts new commands. With C<--stream> the
+goal is to show a plot as the data comes in, which we have been doing. Now that
+we're done, we can clean up everything.
+
+=back
+
+=back
+
+Note that one usually invokes C<feedgnuplot> as a part of a shell pipeline:
+
+ $ write_data | feedgnuplot
+
+If the user terminates this pipeline with ^C, then I<all> the processes in the
+pipeline receive SIGINT. This normally kills C<feedgnuplot> and all its
+C<gnuplot> children, and we let this happen unless C<--stream> and no C<--exit>.
+If C<--stream> and no C<--exit>, then we ignore the first ^C. The data feeder
+dies, and we behave as if the input data was exhausted. A second ^C kills us
+also.
 
 =item
 
@@ -1757,10 +1854,12 @@ in a Thinkpad.
  $ while true; do cat /proc/acpi/ibm/thermal | awk '{$1=""; print}' ; sleep 1; done |
    feedgnuplot --stream --xlen 100 --lines --autolegend --ymax 100 --ymin 20 --ylabel 'Temperature (deg C)'
 
-=head2 Plotting a histogram of file sizes in a directory
+=head2 Plotting a histogram of file sizes in a directory, granular to 10MB
 
  $ ls -l | awk '{print $5/1e6}' |
-   feedgnuplot --histogram 0 --with boxes --ymin 0 --xlabel 'File size (MB)' --ylabel Frequency
+   feedgnuplot --histogram 0 --with boxes
+     --binwidth 10 --set 'style fill solid'
+     --ymin 0 --xlabel 'File size (MB)' --ylabel Frequency
 
 =head1 ACKNOWLEDGEMENT
 

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'                                         \