Add finalize_subplot!

_process_userrecipes now calls the correct _process_userrecipe

.travis.yml

@@ -35,4 +35,4 @@ notifications:
 script:
   - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
   - if [[ `uname` = "Linux" ]]; then TESTCMD="xvfb-run julia"; else TESTCMD="julia"; fi
-  - $TESTCMD -e 'using Pkg; Pkg.build(); Pkg.test(coverage=true)'
+  - $TESTCMD -e 'using Pkg; pkg"add https://github.com/mkborregaard/RecipeUtils.jl"; Pkg.build(); Pkg.test(coverage=true)'

Project.toml

@@ -1,7 +1,7 @@
 name = "Plots"
 uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 author = ["Tom Breloff (@tbreloff)"]
-version = "0.29.6"
+version = "0.29.7"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
@@ -21,6 +21,7 @@ PlotUtils = "995b91a9-d308-5afd-9ec6-746e21dbc043"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+RecipePipeline = "01d81517-befc-4cb6-b9ec-a95719d0359c"
 RecipesBase = "3cdcf5f2-1ef4-517c-9805-6587b60abb01"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
@@ -34,7 +35,7 @@ UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 Contour = "0.5"
 FFMPEG = "0.2, 0.3"
 FixedPointNumbers = "0.6, 0.7, 0.8"
-GR = "0.46, 0.47"
+GR = "0.46, 0.47, 0.48"
 GeometryTypes = "0.7, 0.8"
 JSON = "0.21"
 Measures = "0.3"

src/Plots.jl

@@ -18,6 +18,13 @@ using Base.Meta
 import Showoff
 import StatsBase
 import JSON
+import RecipePipeline: _process_userrecipe, _process_plotrecipe,
+                    _process_seriesrecipe, _preprocess_args,
+                    preprocessArgs!, is_st_supported,
+                    finalize_subplot!, recipe_pipeline!,
+                    _recipe_init!, _recipe_after_user!,
+                    _recipe_after_plot!, _recipe_before_series!,
+                    _recipe_finish!
 
 using Requires
 
@@ -222,7 +229,7 @@ end
 
 const CURRENT_BACKEND = CurrentBackend(:none)
 
-include("precompile.jl")
-_precompile_()
+# include("precompile.jl")
+# _precompile_()
 
 end # module

src/backends/pgfplotsx.jl

@@ -75,7 +75,7 @@ function Base.push!(pgfx_plot::PGFPlotsXPlot, item)
 end
 
 function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
-    if !pgfx_plot.is_created
+    if !pgfx_plot.is_created || pgfx_plot.was_shown
         the_plot = PGFPlotsX.TikzPicture(PGFPlotsX.Options())
         bgc = plt.attr[:background_color_outside] == :match ?
             plt.attr[:background_color] : plt.attr[:background_color_outside]
@@ -129,8 +129,7 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
                     ) => nothing,
                     "fill" => cstr,
                     "fill opacity" => a,
-                    "text opacity" =>
-                                alpha(plot_color(sp[:legendfontcolor])),
+                    "text opacity" =>     alpha(plot_color(sp[:legendfontcolor])),
                     "font" => pgfx_font(
                         sp[:legendfontsize],
                         pgfx_thickness_scaling(sp),
@@ -254,9 +253,6 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
                     end
                 for (i, rng) in enumerate(segments)
                     segment_opt = PGFPlotsX.Options()
-                    if opt[:label] == ""
-                        push!(segment_opt, "forget plot" => nothing)
-                    end
                     segment_opt = merge(segment_opt, pgfx_linestyle(opt, i))
                     if opt[:markershape] != :none
                         marker = opt[:markershape]
@@ -302,12 +298,11 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
                                 rng,
                             )
                         end
-                        if i == 1 && sp[:legend] != :none && pgfx_should_add_to_legend(series)
+                        if i == 1 &&
+                           sp[:legend] != :none && pgfx_should_add_to_legend(series)
                             pgfx_filllegend!(series_opt, opt)
                         end
                     end
-                    # series
-                    #
                     coordinates =
                         pgfx_series_coordinates!(sp, series, segment_opt, opt, rng)
                     segment_plot =
@@ -339,15 +334,6 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
                             series_index,
                         )
                     end
-                    # add to legend?
-                    if i == 1 && sp[:legend] != :none && pgfx_should_add_to_legend(series)
-                        leg_opt = PGFPlotsX.Options()
-                        if ribbon !== nothing
-                            pgfx_filllegend!(axis.contents[end - 3].options, opt)
-                        end
-                        legend = PGFPlotsX.LegendEntry(leg_opt, opt[:label], false)
-                        push!(axis, legend)
-                    end
                     # add series annotations
                     anns = series[:series_annotations]
                     for (xi, yi, str, fnt) in EachAnn(anns, series[:x], series[:y])
@@ -359,7 +345,31 @@ function (pgfx_plot::PGFPlotsXPlot)(plt::Plot{PGFPlotsXBackend})
                             pgfx_thickness_scaling(series),
                         )
                     end
-                end
+                    # add to legend?
+                    if sp[:legend] != :none && pgfx_should_add_to_legend(series)
+                        leg_entry = if opt[:label] isa AVec
+                            get(opt[:label], i, "")
+                        elseif opt[:label] isa AbstractString
+                            if i == 1
+                                opt[:label]
+                            else
+                                ""
+                            end
+                        else
+                            throw(ArgumentError("Malformed label. label = $(opt[:label])"))
+                        end
+                        if leg_entry == ""
+                            push!(segment_plot.options, "forget plot" => nothing)
+                            continue
+                        end
+                        leg_opt = PGFPlotsX.Options()
+                        if ribbon !== nothing
+                            pgfx_filllegend!(axis.contents[end - 3].options, opt)
+                        end
+                        legend = PGFPlotsX.LegendEntry(leg_opt, leg_entry, false)
+                        push!(axis, legend)
+                    end
+                end # for segments
                 # add subplot annotations
                 for ann in sp[:annotations]
                     pgfx_add_annotation!(
@@ -534,8 +544,7 @@ function pgfx_series_coordinates!(
 
     cs = join(
         [
-            join(["($x, $y) [$(zs[j, i])]" for (j, x) in enumerate(xs)], " ")
-            for (i, y) in enumerate(ys)
+            join(["($x, $y) [$(zs[j, i])]" for (j, x) in enumerate(xs)], " ") for (i, y) in enumerate(ys)
         ],
         "\n\n",
     )
@@ -726,8 +735,8 @@ function pgfx_marker(plotattributes, i = 1)
             "fill" => cstr,
             "fill opacity" => a,
             "line width" =>
-                    pgfx_thickness_scaling(plotattributes) *
-                    _cycle(plotattributes[:markerstrokewidth], i),
+                pgfx_thickness_scaling(plotattributes) *
+                _cycle(plotattributes[:markerstrokewidth], i),
             "rotate" => if shape == :dtriangle
                 180
             elseif shape == :rtriangle
@@ -882,8 +891,7 @@ function pgfx_axis!(opt::PGFPlotsX.Options, sp::Subplot, letter)
         opt,
         string(letter, "label style") => PGFPlotsX.Options(
             labelpos => nothing,
-            "font" =>
-                    pgfx_font(axis[:guidefontsize], pgfx_thickness_scaling(sp)),
+            "font" =>     pgfx_font(axis[:guidefontsize], pgfx_thickness_scaling(sp)),
             "color" => cstr,
             "draw opacity" => α,
             "rotate" => axis[:guidefontrotation],
@@ -969,7 +977,7 @@ function pgfx_axis!(opt::PGFPlotsX.Options, sp::Subplot, letter)
             opt,
             string(letter, "ticklabel style") => PGFPlotsX.Options(
                 "font" =>
-                        pgfx_font(axis[:tickfontsize], pgfx_thickness_scaling(sp)),
+                    pgfx_font(axis[:tickfontsize], pgfx_thickness_scaling(sp)),
                 "color" => cstr,
                 "draw opacity" => α,
                 "rotate" => axis[:tickfontrotation],
@@ -988,8 +996,7 @@ function pgfx_axis!(opt::PGFPlotsX.Options, sp::Subplot, letter)
 
     # framestyle
     if framestyle in (:axes, :origin)
-        axispos = axis[:mirror] ? "right" :
-                  framestyle == :axes ? "left" : "middle"
+        axispos = axis[:mirror] ? "right" : framestyle == :axes ? "left" : "middle"
 
         if axis[:draw_arrow]
             push!(opt, string("axis ", letter, " line") => axispos)
@@ -1062,6 +1069,7 @@ for mime in ("application/pdf", "image/png", "image/svg+xml")
         mime::MIME{Symbol($mime)},
         plt::Plot{PGFPlotsXBackend},
     )
+        plt.o.was_shown = true
         show(io, mime, plt.o.the_plot)
     end
 end
@@ -1071,6 +1079,7 @@ function _show(
     mime::MIME{Symbol("application/x-tex")},
     plt::Plot{PGFPlotsXBackend},
 )
+    plt.o.was_shown = true
     PGFPlotsX.print_tex(
         io,
         plt.o.the_plot,
@@ -1079,5 +1088,6 @@ function _show(
 end
 
 function _display(plt::Plot{PGFPlotsXBackend})
+    plt.o.was_shown = true
     display(PGFPlotsX.PGFPlotsXDisplay(), plt.o.the_plot)
 end

src/examples.jl

@@ -800,7 +800,7 @@ const _examples = PlotExample[
                     plot(
                         plot(
                             0:10;
-                            ribbon = (LinRange(0, 2, 10), LinRange(0, 1, 10)),
+                            ribbon = (LinRange(0, 2, 11), LinRange(0, 1, 11)),
                         ),
                         plot(0:10; ribbon = 0:0.5:5),
                         plot(0:10; ribbon = sqrt),
@@ -885,7 +885,14 @@ _backend_skips = Dict(
     :plotlyjs => [2, 21, 24, 25, 30, 31],
     :plotly => [2, 21, 24, 25, 30, 31],
     :pgfplots => [2, 5, 6, 10, 16, 20, 22, 23, 25, 28, 30, 31, 34, 37, 38, 39],
-)
+    :pgfplotsx => [ 6, # images
+                    10, # histogram2d
+                    20, # annotations due to missing sanitation
+                    22, # contourf
+                    23, # pie
+                    32, # spy
+                    38, # histogram2d
+                  ] )
 
 
 

src/pipeline.jl

@@ -1,5 +1,13 @@
 
+function finalize_subplot!(plt::Plot, st, plotattributes::AKW)
+    sp = _prepare_subplot(plt, plotattributes)
+    _prepare_annotations(sp, plotattributes)
+    _expand_subplot_extrema(sp, plotattributes, st)
+    _update_series_attributes!(plotattributes, plt, sp)
+    _add_the_series(plt, sp, plotattributes)
+end
 
+is_st_supported(st::Symbol) = is_seriestype_supported(st)
 # ------------------------------------------------------------------
 # preprocessing
 
@@ -59,39 +67,6 @@ end
 # user recipes
 
 
-function _process_userrecipes(plt::Plot, plotattributes::AKW, args)
-    still_to_process = RecipeData[]
-    args = _preprocess_args(plotattributes, args, still_to_process)
-
-    # for plotting recipes, swap out the args and update the parameter dictionary
-    # we are keeping a stack of series that still need to be processed.
-    # each pass through the loop, we pop one off and apply the recipe.
-    # the recipe will return a list a Series objects... the ones that are
-    # finished (no more args) get added to the kw_list, the ones that are not
-    # are placed on top of the stack and are then processed further.
-    kw_list = KW[]
-    while !isempty(still_to_process)
-        # grab the first in line to be processed and either add it to the kw_list or
-        # pass it through apply_recipe to generate a list of RecipeData objects (data + attributes)
-        # for further processing.
-        next_series = popfirst!(still_to_process)
-        # recipedata should be of type RecipeData.  if it's not then the inputs must not have been fully processed by recipes
-        if !(typeof(next_series) <: RecipeData)
-            error("Inputs couldn't be processed... expected RecipeData but got: $next_series")
-        end
-        if isempty(next_series.args)
-            _process_userrecipe(plt, kw_list, next_series)
-        else
-            rd_list = RecipesBase.apply_recipe(next_series.plotattributes, next_series.args...)
-            prepend!(still_to_process,rd_list)
-        end
-    end
-
-    # don't allow something else to handle it
-    plotattributes[:smooth] = false
-    kw_list
-end
-
 function _process_userrecipe(plt::Plot, kw_list::Vector{KW}, recipedata::RecipeData)
     # when the arg tuple is empty, that means there's nothing left to recursively
     # process... finish up and add to the kw_list
@@ -168,39 +143,6 @@ function _add_smooth_kw(kw_list::Vector{KW}, kw::AKW)
 end
 
 # ------------------------------------------------------------------
-# plot recipes
-
-# Grab the first in line to be processed and pass it through apply_recipe
-# to generate a list of RecipeData objects (data + attributes).
-# If we applied a "plot recipe" without error, then add the returned datalist's KWs,
-# otherwise we just add the original KW.
-function _process_plotrecipe(plt::Plot, kw::AKW, kw_list::Vector{KW}, still_to_process::Vector{KW})
-    if !isa(get(kw, :seriestype, nothing), Symbol)
-        # seriestype was never set, or it's not a Symbol, so it can't be a plot recipe
-        push!(kw_list, kw)
-        return
-    end
-    try
-        st = kw[:seriestype]
-        st = kw[:seriestype] = get(_typeAliases, st, st)
-        datalist = RecipesBase.apply_recipe(kw, Val{st}, plt)
-        for data in datalist
-            preprocessArgs!(data.plotattributes)
-            if data.plotattributes[:seriestype] == st
-                error("Plot recipe $st returned the same seriestype: $(data.plotattributes)")
-            end
-            push!(still_to_process, data.plotattributes)
-        end
-    catch err
-        if isa(err, MethodError)
-            push!(kw_list, kw)
-        else
-            rethrow()
-        end
-    end
-    return
-end
-
 
 # ------------------------------------------------------------------
 # setup plot and subplot
@@ -382,47 +324,3 @@ function _add_the_series(plt, sp, plotattributes)
     push!(sp.series_list, series)
     _series_added(plt, series)
 end
-
-# -------------------------------------------------------------------------------
-
-# this method recursively applies series recipes when the seriestype is not supported
-# natively by the backend
-function _process_seriesrecipe(plt::Plot, plotattributes::AKW)
-    #println("process $(typeof(plotattributes))")
-    # replace seriestype aliases
-    st = Symbol(plotattributes[:seriestype])
-    st = plotattributes[:seriestype] = get(_typeAliases, st, st)
-
-    # shapes shouldn't have fillrange set
-    if plotattributes[:seriestype] == :shape
-        plotattributes[:fillrange] = nothing
-    end
-
-    # if it's natively supported, finalize processing and pass along to the backend, otherwise recurse
-    if is_seriestype_supported(st)
-        sp = _prepare_subplot(plt, plotattributes)
-        _prepare_annotations(sp, plotattributes)
-        _expand_subplot_extrema(sp, plotattributes, st)
-        _update_series_attributes!(plotattributes, plt, sp)
-        _add_the_series(plt, sp, plotattributes)
-
-    else
-        # get a sub list of series for this seriestype
-        datalist = RecipesBase.apply_recipe(plotattributes, Val{st}, plotattributes[:x], plotattributes[:y], plotattributes[:z])
-
-        # assuming there was no error, recursively apply the series recipes
-        for data in datalist
-            if isa(data, RecipeData)
-                preprocessArgs!(data.plotattributes)
-                if data.plotattributes[:seriestype] == st
-                    error("The seriestype didn't change in series recipe $st.  This will cause a StackOverflow.")
-                end
-                _process_seriesrecipe(plt, data.plotattributes)
-            else
-                @warn("Unhandled recipe: $(data)")
-                break
-            end
-        end
-    end
-    nothing
-end

src/plot.jl

@@ -54,7 +54,7 @@ function plot(args...; kw...)
     # create an empty Plot then process
     plt = Plot()
     # plt.user_attr = plotattributes
-    _plot!(plt, plotattributes, args)
+    recipe_pipeline!(plt, plotattributes, args, type_aliases=_typeAliases)
 end
 
 # build a new plot from existing plots
@@ -155,7 +155,7 @@ function plot!(plt::Plot, args...; kw...)
     plotattributes = KW(kw)
     preprocessArgs!(plotattributes)
     # merge!(plt.user_attr, plotattributes)
-    _plot!(plt, plotattributes, args)
+    recipe_pipeline!(plt, plotattributes, args, type_aliases=_typeAliases)
 end
 
 # -------------------------------------------------------------------------------
@@ -163,78 +163,36 @@ end
 # this is the core plotting function.  recursively apply recipes to build
 # a list of series KW dicts.
 # note: at entry, we only have those preprocessed args which were passed in... no default values yet
-function _plot!(plt::Plot, plotattributes::AKW, args::Tuple)
+
+## here we implement the recipe interface
+function _recipe_init!(plt::Plot, plotattributes::AKW, args::Tuple)
     plotattributes[:plot_object] = plt
 
     if !isempty(args) && !isdefined(Main, :StatsPlots) &&
             first(split(string(typeof(args[1])), ".")) == "DataFrames"
         @warn("You're trying to plot a DataFrame, but this functionality is provided by StatsPlots")
     end
+end
 
-    # --------------------------------
-    # "USER RECIPES"
-    # --------------------------------
-
-    kw_list = _process_userrecipes(plt, plotattributes, args)
-
-    # @info(1)
-    # map(DD, kw_list)
-
-
-    # --------------------------------
-    # "PLOT RECIPES"
-    # --------------------------------
-
-    # "plot recipe", which acts like a series type, and is processed before
-    # the plot layout is created, which allows for setting layouts and other plot-wide attributes.
-    # we get inputs which have been fully processed by "user recipes" and "type recipes",
-    # so we can expect standard vectors, surfaces, etc.  No defaults have been set yet.
-    still_to_process = kw_list
-    kw_list = KW[]
-    while !isempty(still_to_process)
-        next_kw = popfirst!(still_to_process)
-        _process_plotrecipe(plt, next_kw, kw_list, still_to_process)
-    end
-
-    # @info(2)
-    # map(DD, kw_list)
-
+function _recipe_after_plot!(plt::Plot, plotattributes::AKW, kw_list::Vector{KW})
     # --------------------------------
     # Plot/Subplot/Layout setup
     # --------------------------------
     _plot_setup(plt, plotattributes, kw_list)
     _subplot_setup(plt, plotattributes, kw_list)
+end
 
-    # !!! note: At this point, kw_list is fully decomposed into individual series... one KW per series.          !!!
-    # !!!       The next step is to recursively apply series recipes until the backend supports that series type !!!
+function _recipe_before_series!(plt::Plot, kw, kw_list)
+    sp::Subplot = kw[:subplot]
 
-    # --------------------------------
-    # "SERIES RECIPES"
-    # --------------------------------
+    # in series attributes given as vector with one element per series,
+    # select the value for current series
+    _slice_series_args!(kw, plt, sp, series_idx(kw_list,kw))
 
-    # @info(3)
-    # map(DD, kw_list)
-
-    for kw in kw_list
-        sp::Subplot = kw[:subplot]
-
-        # in series attributes given as vector with one element per series,
-        # select the value for current series
-        _slice_series_args!(kw, plt, sp, series_idx(kw_list,kw))
-
-
-        series_attr = Attr(kw, _series_defaults)
-        # now we have a fully specified series, with colors chosen.   we must recursively handle
-        # series recipes, which dispatch on seriestype.  If a backend does not natively support a seriestype,
-        # we check for a recipe that will convert that series type into one made up of lower-level components.
-        # For example, a histogram is just a bar plot with binned data, a bar plot is really a filled step plot,
-        # and a step plot is really just a path.  So any backend that supports drawing a path will implicitly
-        # be able to support step, bar, and histogram plots (and any recipes that use those components).
-        _process_seriesrecipe(plt, series_attr)
-    end
-
-    # --------------------------------
+    series_attr = Attr(kw, _series_defaults)
+end
 
+function _recipe_finish!(plt::Plot, plotattributes::AKW, args::Tuple)
     current(plt)
 
     # do we want to force display?
@@ -246,7 +204,6 @@ function _plot!(plt::Plot, plotattributes::AKW, args::Tuple)
     plt
 end
 
-
 # we're getting ready to display/output.  prep for layout calcs, then update
 # the plot object after
 function prepare_output(plt::Plot)

test/runtests.jl

@@ -42,7 +42,7 @@ include("imgcomp.jl")
 Random.seed!(1234)
 default(show=false, reuse=true)
 is_ci() = get(ENV, "CI", "false") == "true"
-img_tol = is_ci() ? 1e-2 : 1e-3
+img_tol = is_ci() ? 1e-2 : Sys.islinux() ? 1e-3 : 0.1
 
 ## Uncomment the following lines to update reference images for different backends
 
@@ -76,7 +76,9 @@ end
         @test gr() == Plots.GRBackend()
         @test backend() == Plots.GRBackend()
 
-        @static if Sys.islinux()
+        @static if haskey(ENV, "APPVEYOR")
+            @info "Skipping GR image comparison tests on AppVeyor"
+        else
             image_comparison_facts(:gr, tol=img_tol, skip = Plots._backend_skips[:gr])
         end
     end