fix stuff

Don't run gnuplot process connected to stdout

ChangeLog.md

@@ -1,3 +1,17 @@
+# Version 1.4.1 (released on: )
+- New features:
+	* Implicit recipes can now returns a `Vector{PlotElement}`;
+
+	* Allow using single quotes in output file names (#52);
+
+	* New function: `palette_levels()` can be used to modify palette levels before passing them to gnuplot;
+
+- Bugfix:
+	* Fixed `BoundsErrors` in `hist()` (#49);
+
+	* Fixed problem when generating documentation (#51);
+
+
 # Version 1.4.0 (released on: May 5, 2021)
 - New features:
     * Missing values are accepted if the input arrays have `eltype <:

Project.toml

@@ -1,6 +1,6 @@
 name = "Gnuplot"
 uuid = "dc211083-a33a-5b79-959f-2ff34033469d"
-version = "1.4.0"
+version = "1.4.1"
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
@@ -21,4 +21,4 @@ DataStructures = "^0.18"
 ReplMaker = "^0.2"
 StatsBase = "^0.33"
 StructC14N = "^0.3"
-julia = "^1.5"
+julia = "^1.6"

README.md

@@ -3,7 +3,7 @@
 
 [![Build Status](https://travis-ci.org/gcalderone/Gnuplot.jl.svg?branch=master)](https://travis-ci.org/gcalderone/Gnuplot.jl)
 [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.md)
-[![DocumentationStatus](https://img.shields.io/badge/docs-stable-blue.svg?style=flat)](https://gcalderone.github.io/Gnuplot.jl/v1.4.0/)
+[![DocumentationStatus](https://img.shields.io/badge/docs-stable-blue.svg?style=flat)](https://gcalderone.github.io/Gnuplot.jl/v1.4.0/index.html)
 
 
 **Gnuplot.jl** is a simple package able to send both data and commands from Julia to an underlying [gnuplot](http://gnuplot.sourceforge.net/) process.  Its main purpose it to provide a fast and powerful data visualization framework, using an extremely concise Julia syntax. It also has automatic display of plots in Jupyter, Juno and VS Code.

docs/src/api.md

@@ -21,6 +21,7 @@ gpvars
 hist
 linetypes
 palette
+palette_levels
 palette_names
 recipe
 save

docs/src/basic.md

@@ -210,6 +210,16 @@ saveas("basic008a") # hide
 ```
 ![](assets/basic008a.png)
 
+The palette levels may be easily stretched by using the [`palette_levels()`](@ref) and modifying the numeric levels, e.g.:
+```@example abc
+x = 0:0.1:10pi
+v, l, n = palette_levels(:viridis)
+@gsp palette(v.^0.25, l, n) cbr=[-1,1].*30 :-
+@gsp :-  x  x.*sin.(x)  x.*cos.(x)  x./20  "w p pt 7 ps var lc pal"
+saveas("basic008b") # hide
+```
+![](assets/basic008b.png)
+
 The list of all available palette can be retrieved with [`palette_names()`](@ref):
 ```@repl abc
 palette_names()

docs/src/install.md

@@ -19,11 +19,11 @@ Check **Gnuplot.jl** version with:
 ```julia-repl
 julia> ]st Gnuplot
 Status `~/.julia/environments/v1.4/Project.toml`
-  [dc211083] Gnuplot v1.4.0
+  [dc211083] Gnuplot v1.4.1
 ```
-If the displayed version is not `v1.4.0` you are probably having a dependency conflict.  In this case try forcing installation of the latest version with:
+If the displayed version is not `v1.4.1` you are probably having a dependency conflict.  In this case try forcing installation of the latest version with:
 ```julia-repl
-julia> ]add Gnuplot@1.4.0
+julia> ]add Gnuplot@1.4.1
 ```
 and check which package is causing the conflict.
 

docs/src/options.md

@@ -70,12 +70,11 @@ Each line reports the package name (`GNUPLOT`), the session name (`default`), th
 
 ## Package initialization
 
-If you use **Gnuplot.jl** frequently you may find convenient to collect all the package settings ([Options](@ref)) in a single place, to quickly recall them in a Julia session.  A possibility is to put the following code in the `~/.julia/config/startup.jl` initialization file (further info [here](https://docs.julialang.org/en/v1/stdlib/REPL/)):
+If you use **Gnuplot.jl** frequently you may find convenient to automatically apply the package settings ([Options](@ref)) whenever the package is loaded.  A possibility is to use [Requires.jl](https://github.com/JuliaPackaging/Requires.jl) and put the following code in the `~/.julia/config/startup.jl` initialization file (further info [here](https://docs.julialang.org/en/v1/stdlib/REPL/)):
 ```julia
-macro gnuplotrc()
-    return :(
-        using Gnuplot;
-
+using Requires
+@require Gnuplot="dc211083-a33a-5b79-959f-2ff34033469d" begin
+        @info "Custom Gnuplot initialization"
         # Uncomment the following if you don't have the gnuplot
         # executable installed on your platform:
         #Gnuplot.options.dry = true;
@@ -103,17 +102,13 @@ macro gnuplotrc()
 
         # Set the default linetypes
         empty!(Gnuplot.options.init);
-        push!(Gnuplot.options.init, linetypes(:Set1_5, lw=1.5, ps=1.5));
+        push!(Gnuplot.options.init, Gnuplot.linetypes(:Set1_5, lw=1.5, ps=1.5));
 
         # Initialize the gnuplot REPL using the provided `start_key`.
         if Gnuplot.options.gpviewer;
             Gnuplot.repl_init(start_key='>');
         end;
-    )
 end
 ```
-At the Julia prompt you may load the package and the associated settings by typing:
-```julia
-julia> @gnuplotrc
-```
-and you're ready to go.
+
+The above code will be automatically when you first load the package with `using Gnuplot`.

docs/src/terminals.md

@@ -26,9 +26,35 @@ Press the `h` key on the window to display an help message with all available ke
 
 
 ## Plot in a terminal application (`dumb`, `sixel` and `sixelgd`)
-Gnuplot supports plotting in a terminal application, with no need for X11 or other GUI support, via the `dumb`, `sixel` and `sixelgd` terminals.  These are extremely useful when you run Julia on a remote shell through `ssh`, with no X11 forwarding.
+Gnuplot supports plotting in a terminal application, with no need for X11 or other GUI support, via the `dumb`, `sixel` and `sixelgd` terminals.  These are extremely useful when you run Julia on a remote shell through `ssh`, with no X11 forwarding. The `dumb` terminal uses ASCII characters to draw a plot, while `sixel` and `sixelgd` actually use bitmaps (but require Sixel support to be enabled in the terminal, e.g. `xterm -ti vt340`).
 
-The `dumb` terminal uses ASCII characters to draw a plot, while `sixel` and `sixelgd` actually use bitmaps (but require Sixel support to be enabled in the terminal, e.g. `xterm -ti vt340`).  A sixel plot on `xterm` looks as follows:
+Dumb terminal can be used as follows:
+
+```jldoctest; setup = :(using Gnuplot)
+julia> origterm = Gnuplot.options.term;
+
+julia> Gnuplot.options.term = "dumb size 60,15";
+
+julia> @gp "plot sin(x)"
+
+    1 +-------------------------------------------------+
+  0.8 |-+         *+ *         + ** **      +    *  * +-|
+  0.6 |-+        *   **          *   *   sin(x) *******-|
+  0.4 |*+        *    *         *     *         *    *+-|
+  0.2 |*+       *      *        *     *        *      *-|
+    0 |*+       *      *       *       *       *      *-|
+      | *      *       *       *       *      *        *|
+ -0.2 |-*      *        *     *        *      *       +*|
+ -0.4 |-+*    *         *     *         *    *        +*|
+ -0.6 |-+*    *          *   *          **   *        +-|
+ -0.8 |-+ *  *     +     ** ** +         *  *         +-|
+   -1 +-------------------------------------------------+
+     -10          -5           0            5           10
+
+julia> Gnuplot.options.term = origterm;
+
+```
+A sixel plot on `xterm` looks as follows:
 ![](assets/sixelgd.png)
 
 The above terminals are available if gnuplot has been compiled with the `--with-bitmap-terminals` option enabled and Libgd (only for `sixelgd`).

src/Gnuplot.jl

@@ -7,7 +7,7 @@ import Base.reset
 import Base.write
 import Base.show
 
-export session_names, dataset_names, palette_names, linetypes, palette,
+export session_names, dataset_names, palette_names, linetypes, palette_levels, palette,
     terminal, terminals, test_terminal,
     stats, @gp, @gsp, save, gpexec,
     boxxy, contourlines, dgrid3d, hist, recipe, gpvars, gpmargins, gpranges
@@ -283,11 +283,11 @@ function parseKeywords(; kwargs...)
     ismissing(kw.zrange ) || (push!(out, replace("set zrange  [" * join(kw.zrange , ":") * "]", "NaN"=>"*")))
     ismissing(kw.cbrange) || (push!(out, replace("set cbrange [" * join(kw.cbrange, ":") * "]", "NaN"=>"*")))
     ismissing(kw.key    ) || (push!(out, "set key " * kw.key  * ""))
-    ismissing(kw.title  ) || (push!(out, "set title   \"" * kw.title  * "\""))
-    ismissing(kw.xlabel ) || (push!(out, "set xlabel  \"" * kw.xlabel * "\""))
-    ismissing(kw.ylabel ) || (push!(out, "set ylabel  \"" * kw.ylabel * "\""))
-    ismissing(kw.zlabel ) || (push!(out, "set zlabel  \"" * kw.zlabel * "\""))
-    ismissing(kw.cblabel) || (push!(out, "set cblabel \"" * kw.cblabel * "\""))
+    ismissing(kw.title  ) || (push!(out, "set title   '" * kw.title  * "'"))
+    ismissing(kw.xlabel ) || (push!(out, "set xlabel  '" * kw.xlabel * "'"))
+    ismissing(kw.ylabel ) || (push!(out, "set ylabel  '" * kw.ylabel * "'"))
+    ismissing(kw.zlabel ) || (push!(out, "set zlabel  '" * kw.zlabel * "'"))
+    ismissing(kw.cblabel) || (push!(out, "set cblabel '" * kw.cblabel * "'"))
     ismissing(kw.xlog   ) || (push!(out, (kw.xlog  ?  ""  :  "un") * "set logscale x"))
     ismissing(kw.ylog   ) || (push!(out, (kw.ylog  ?  ""  :  "un") * "set logscale y"))
     ismissing(kw.zlog   ) || (push!(out, (kw.zlog  ?  ""  :  "un") * "set logscale z"))
@@ -304,7 +304,6 @@ function parseKeywords(; kwargs...)
     ismissing(kw.rmargin) ||  push!(out, (kw.rmargin == ""  ?  "unset rmargin"  :  "set rmargin at screen $(kw.rmargin)"))
     ismissing(kw.bmargin) ||  push!(out, (kw.bmargin == ""  ?  "unset bmargin"  :  "set bmargin at screen $(kw.bmargin)"))
     ismissing(kw.tmargin) ||  push!(out, (kw.tmargin == ""  ?  "unset tmargin"  :  "set tmargin at screen $(kw.tmargin)"))
-
     return join(out, ";\n")
 end
 
@@ -520,7 +519,6 @@ function readTask(gp::GPSession)
     delete!(sessions, gp.sid)
 end
 
-
 function GPSession(sid::Symbol)
     session = DrySession(sid)
     if !options.dry
@@ -535,13 +533,16 @@ function GPSession(sid::Symbol)
     end
 
     pin  = Base.Pipe()
+    pout = Base.Pipe()
     perr = Base.Pipe()
-    proc = run(pipeline(`$(options.cmd)`, stdin=pin, stdout=stdout, stderr=perr), wait=false)
+    proc = run(pipeline(`$(options.cmd)`, stdin=pin, stdout=pout, stderr=perr), wait=false)
     chan = Channel{String}(32)
 
     # Close unused sides of the pipes
+    Base.close(pout.in)
     Base.close(perr.in)
     Base.close(pin.out)
+    Base.start_reading(pout.out)
     Base.start_reading(perr.out)
 
     out = GPSession(getfield.(Ref(session), fieldnames(DrySession))...,
@@ -550,6 +551,9 @@ function GPSession(sid::Symbol)
 
     # Start reading tasks
     @async readTask(out)
+    @async while !eof(pout) # see PR #51
+        write(stdout, readavailable(pout))
+    end
 
     # Read gnuplot default terminal
     if options.term == ""
@@ -925,7 +929,7 @@ function execall(gp::GPSession; term::AbstractString="", output::AbstractString=
         gpexec(gp, "unset multiplot")
         gpexec(gp, "set term $term")
     end
-    (output != "")  &&  gpexec(gp, "set output '$output'")
+    (output != "")  &&  gpexec(gp, "set output '$(replace(output, "'" => "''"))'")
 
     # printstyled("Plotting with terminal: " * terminal() * "\n", color=:blue, bold=true)
 
@@ -1125,7 +1129,16 @@ function parseArguments(_args...)
         elseif hasmethod(recipe, tuple(typeof(arg))) # ==> implicit recipe
             # @info which(recipe, tuple(typeof(arg)))  # debug
             deleteat!(args, pos)
-            insert!(args, pos, recipe(arg))
+            pe = recipe(arg)
+            if isa(pe, PlotElement)
+                insert!(args, pos, pe)
+            elseif isa(pe, Vector{PlotElement})
+                for i in 1:length(pe)
+                    insert!(args, pos, pe[i])
+                end
+            else
+                error("Recipe must return a PlotElement or Vector{PlotElement}")
+            end
             continue
         elseif isa(arg, Vector{PlotElement})         # ==> explicit recipe (vector)
             deleteat!(args, pos)
@@ -1347,7 +1360,7 @@ end
 
 Return the **Gnuplot.jl** package version.
 """
-version() = v"1.4.0"
+version() = v"1.4.1"
 
 # ---------------------------------------------------------------------
 """
@@ -1698,6 +1711,34 @@ function linetypes(cmap::ColorScheme; lw=1, ps=1, dashed=false, rev=false)
 end
 
 
+"""
+    palette_levels(cmap::ColorScheme; rev=false, smooth=false)
+    palette_levels(s::Symbol; rev=false, smooth=false)
+
+Convert a `ColorScheme` object into a `Tuple{Vector{Float64}, Vector{String}, Int}` containing:
+- the numeric levels (between 0 and 1 included) corresponding to colors in the palette;
+- the corresponding colors (as hex strings);
+- the total number of different colors in the palette.
+
+If the argument is a `Symbol` it is interpreted as the name of one of the predefined schemes in [ColorSchemes](https://juliagraphics.github.io/ColorSchemes.jl/stable/basics/#Pre-defined-schemes-1).
+
+If `rev=true` the palette is reversed.  If `smooth=true` the palette is interpolated in 256 levels.
+"""
+palette_levels(s::Symbol; kwargs...) = palette_levels(colorschemes[s]; kwargs...)
+function palette_levels(cmap::ColorScheme; rev=false, smooth=false)
+    levels = OrderedDict{Float64, String}()
+    for x in LinRange(0, 1, (smooth  ?  256  : length(cmap.colors)))
+        if rev
+            color = get(cmap, 1-x)
+        else
+            color = get(cmap, x)
+        end
+        levels[x] = "#" * Colors.hex(color)
+    end
+    return (collect(keys(levels)), collect(values(levels)), length(cmap.colors))
+end
+
+
 """
     palette(cmap::ColorScheme; rev=false, smooth=false)
     palette(s::Symbol; rev=false, smooth=false)
@@ -1708,19 +1749,13 @@ If the argument is a `Symbol` it is interpreted as the name of one of the predef
 
 If `rev=true` the palette is reversed.  If `smooth=true` the palette is interpolated in 256 levels.
 """
-palette(s::Symbol; kwargs...) = palette(colorschemes[s]; kwargs...)
-function palette(cmap::ColorScheme; rev=false, smooth=false)
-    levels = Vector{String}()
-    for x in LinRange(0, 1, (smooth  ?  256  : length(cmap.colors)))
-        if rev
-            color = get(cmap, 1-x)
-        else
-            color = get(cmap, x)
-        end
-        push!(levels, "$x '#" * Colors.hex(color) * "'")
-    end
-    return "set palette defined (" * join(levels, ", ") * ")\nset palette maxcol $(length(cmap.colors))\n"
+function palette(values::Vector{Float64}, levels::Vector{String}, ncolors::Int)
+    str = string.(values) .* " '" .* levels .* "'"
+    return "set palette defined (" * join(str, ", ") * ")\nset palette maxcol $(ncolors)\n"
 end
+palette(s::Symbol; kwargs...) = palette(colorschemes[s]; kwargs...)
+palette(cmap::ColorScheme; kwargs...) =
+    palette(palette_levels(cmap; kwargs...)...)
 
 
 # --------------------------------------------------------------------
@@ -1846,16 +1881,20 @@ function hist(v::Vector{T}; range=[NaN,NaN], bs=NaN, nbins=0, pad=true) where T
         if sum(hh.weights) < length(i)
             j = findall(v[i] .== range[2])
             @assert length(j) == (length(i) - sum(hh.weights))
-            hh.weights[end] += length(j)
+            if length(hh.weights) > 0
+                hh.weights[end] += length(j)
+            else
+                push!(hh.weights, length(j))
+            end
         end
     else
         hh = fit(Histogram, v[i], closed=:left)
     end
     @assert sum(hh.weights) == length(i)
     x = collect(hh.edges[1])
-    x = (x[1:end-1] .+ x[2:end]) ./ 2
+    binsize = isfinite(bs) ? bs : x[2] - x[1]
+    length(x) > 1 && (x = (x[1:end-1] .+ x[2:end]) ./ 2)
     h = hh.weights
-    binsize = x[2] - x[1]
     if pad
         x = [x[1]-binsize, x..., x[end]+binsize]
         h = [0, h..., 0]

test/runtests.jl

@@ -286,4 +286,8 @@ Gnuplot.quit(:default)
 Gnuplot.options.dry = true
 @gp hist(randn(1000))
 
+# Various hist() corner cases
+@gp hist([1,2,3], bs=2)
+@gp hist([1,1,1], bs=1)
+
 Gnuplot.quitall()