Move the CTRLstruct.pocket_call out to a separate global. (#1843)

Author: joa-quim

src/GMT.jl

@@ -12,22 +12,32 @@ struct CTRLstruct
 	figsize::Vector{Float64}		# To store the current fig size (xsize,ysize[,zsize]). Needed, for example, in hexbin
 	proj_linear::Vector{Bool}		# To know if images sent to GMT need Pad
 	returnPS::Vector{Bool}			# To know if returning the PS to Julia
-	callable::Array{Symbol}			# Modules that can be called inside other modules
-	pocket_call::Vector{Any}		# To temporarily store data needed by modules sub-calls. Put in [3] for pre-calls
+	callable::Vector{Symbol}		# Modules that can be called inside other modules
 	pocket_B::Vector{String}		# To temporarily store opt_B grid and fill color to be reworked in psclip
 	pocket_J::Vector{String}		# To temporarily store opt_J and fig size to eventualy flip directions (y + down, etc)
 									# = [opt_J width opt_Jz codes-to-tell-which-axis-to-reverse]
 	pocket_R::Vector{String}		# To temporarily store opt_R
 	XYlabels::Vector{String}		# To temporarily store the x,y col names to let x|y labels know what to plot (if "auto")
 	IamInPaperMode::Vector{Bool}	# A 2 elem vec to know if we are in under-the-hood paper mode. 2nd traces if first call
 	gmt_mem_bag::Vector{Ptr{Cvoid}}	# To temporarily store a GMT owned memory to be freed in gmt()
-	pocket_d::Vector{Dict}			# To pass the Dict of kwargs, after consumption, to other modules.
+	pocket_d::Vector{Dict{Symbol,Any}}			# To pass the Dict of kwargs, after consumption, to other modules.
 end
 
-struct CTRLstruct2
-	first::Vector{Bool}				# Signal that we are starting a new plot (used to set params)
-	points::Vector{Bool}			# If maps are using points as coordinates
-	fname::Vector{String}			# Store the full name of PS being constructed
+mutable struct CTRLstruct2
+	first::Bool						# Signal that we are starting a new plot (used to set params)
+	points::Bool					# If maps are using points as coordinates
+	fname::String					# Store the full name of PS being constructed
+end
+
+mutable struct TMPDIRInfo
+	dir::String						# Temporary directory path
+	username::String				# Username (spaces replaced with underscores)
+	pid_suffix::String				# PID suffix for multi-process support
+end
+
+mutable struct InsetInfo
+	active::Bool					# Whether currently in inset mode
+	has_J::Bool						# Whether -J projection option was provided (GMT bug #7005 workaround)
 end
 
 depfile = joinpath(dirname(@__FILE__),"..","deps","deps.jl")	# File with shared lib names
@@ -55,7 +65,7 @@ end
 
 const G_API = Ref{Ptr{Cvoid}}(C_NULL)
 const PSname = Ref{String}("")					# The PS file (filled in __init__) where, in classic mode, all lands.
-const global TMPDIR_USR = [tempdir(), "", ""]	# Save the tmp dir and user name (also filled in __init__)
+const TMPDIR_USR = TMPDIRInfo(tempdir(), "", "")	# Save the tmp dir and user name (also filled in __init__)
 const global TESTSDIR = joinpath(dirname(pathof(GMT))[1:end-4], "test", "")	# To have easy access to test files
 const IMG_MEM_LAYOUT = Ref{String}("")			# "TCP"	 For Images.jl. The default is "TRBa"
 const GRD_MEM_LAYOUT = Ref{String}("")			# "BRP" is the default for GMT PS images.
@@ -66,7 +76,7 @@ const FirstModern = Ref{Bool}(false)	# To know
 const DidOneGmtCmd = Ref{Bool}(false)		# To know when first gmt() call. Used in first modern mode cmd to not restart what is still fresh
 const IamModernBySubplot = Ref{Bool}(false)	# To know if set in subpot
 const IamSubplot  = Ref{Bool}(false)	# To know if we are in subplot mode
-const global IamInset    = [false, false]									# To know if we are in Inset mode
+const IamInset = InsetInfo(false, false)									# To know if we are in Inset mode
 const usedConfPar = Ref{Bool}(false)	# Hacky solution for the session's memory trouble
 const ThemeIsOn   = Ref{Bool}(false)		# To know if we have an active plot theme
 const CONVERT_SYNTAX = Ref{Bool}(false)	# To only convert to hard core GMT syntax (like Vd=2)
@@ -87,8 +97,9 @@ const DEF_FIG_AXES  = Ref{String}(DEF_FIG_AXES_BAK)    # This one may be be chan
 const DEF_FIG_AXES3 = Ref{String}(DEF_FIG_AXES3_BAK)   #		""
 const FIG_MARGIN = Ref{Int}(1)                      # Figure margin in points after convertion by 'psconvert'. Accessible 'margin' common option
 const global CTRL = CTRLstruct(zeros(13), zeros(6), [true], [false],
-                               [:arrows, :bubblechart, :basemap, :band, :clip, :coast, :colorbar, :grdcontour, :hband, :hlines, :inset, :logo, :lines, :grdvector, :plot, :plot3, :quiver, :scatter, :scatter3, :stairs, :text, :vlines, :vband], fill(nothing, 6), ["","",""], ["","", "", "   "], ["",""], ["",""], [false,true], [C_NULL], [Dict()])
-const global CTRLshapes = CTRLstruct2([true], [true], [""])			# Used in sub-module Drawing
+                               [:arrows, :bubblechart, :basemap, :band, :clip, :coast, :colorbar, :grdcontour, :hband, :hlines, :inset, :logo, :lines, :grdvector, :plot, :plot3, :quiver, :scatter, :scatter3, :stairs, :text, :vlines, :vband], ["","",""], ["","", "", "   "], ["",""], ["",""], [false,true], [C_NULL], [Dict()])
+const pocket_call = Ref{Vector{Any}}(Any[nothing, nothing, nothing, nothing, nothing, nothing])	# Extracted from CTRL to isolate type instability
+const CTRLshapes = CTRLstruct2(true, true, "")			# Used in sub-module Drawing
 const prj4WGS84 = "+proj=longlat +datum=WGS84 +units=m +no_defs"	# This is used in many places
 const global CPTaliases = [:C :color :cmap :colormap :colorscale]
 const global VMs = Union{Vector{Symbol}, Matrix{Symbol}}
@@ -467,9 +478,9 @@ function __init__(test::Bool=false)
 	f = joinpath(GMTuserdir[1], "theme_jl.txt")
 	(isfile(f)) && (theme(readline(f));	ThemeIsOn[] = false)	# False because we don't want it reset in showfig()
 	user = (Sys.isunix() || Sys.isapple()) ? Libc.getpwuid(Libc.getuid(), true).username : Sys.iswindows() ? ENV["USERNAME"] : ""
-	TMPDIR_USR[2] = replace(user, " " => "_")
-	haskey(ENV, "JULIA_GMT_MULTIFILE") && (TMPDIR_USR[3] = string("_", getpid()))
-	PSname[] = TMPDIR_USR[1] * "/" * "GMTjl_" * TMPDIR_USR[2] * TMPDIR_USR[3] * ".ps"
+	TMPDIR_USR.username = replace(user, " " => "_")
+	haskey(ENV, "JULIA_GMT_MULTIFILE") && (TMPDIR_USR.pid_suffix = string("_", getpid()))
+	PSname[] = TMPDIR_USR.dir * "/" * "GMTjl_" * TMPDIR_USR.username * TMPDIR_USR.pid_suffix * ".ps"
 	DidOneGmtCmd[] = false
 end
 

src/common_options.jl

@@ -192,7 +192,7 @@ function parse_R(d::Dict, cmd::String; O::Bool=false, del::Bool=true, RIr::Bool=
 	end
 
 	(O && opt_R == "") && (opt_R = " -R")
-	if (!already_know && opt_R != "" && opt_R != " -R" && !IamInset[1] && !noGlobalR)	# Save limits in numeric
+	if (!already_know && opt_R != "" && opt_R != " -R" && !IamInset.active && !noGlobalR)	# Save limits in numeric
 		bak = IamModern[]
 		try
 			limits = opt_R2num(opt_R)
@@ -489,7 +489,7 @@ function parse_J(d::Dict, cmd::String; default::String="", map::Bool=true, O::Bo
 		opt_J, mnemo = build_opt_J(val)		# mnemo = true when the projection name used a mnemonic for the projection
 	elseif (IamModern[] && ((val = is_in_dict(d, [:figscale :fig_scale :scale :figsize :fig_size])) === nothing))
 		# Subplots do not rely in the classic default mechanism
-		(IamInset[1] && !IamInset[2] && !contains(cmd, " -J")) && (cmd *= CTRL.pocket_J[1]::String) 	# Workaround GMT bug (#7005)
+		(IamInset.active && !IamInset.has_J && !contains(cmd, " -J")) && (cmd *= CTRL.pocket_J[1]::String) 	# Workaround GMT bug (#7005)
 		return cmd, ""
 	end
 	if (CTRL.proj_linear[1])				# Otherwise (CTRL.proj_linear[1] == false), trust it
@@ -2835,16 +2835,16 @@ end
 Put VAL in the next empty slot in the pocket_call vector. So far only 2 slots
 """
 function put_pocket_call(val)
-	(CTRL.pocket_call[1] === nothing) ? (CTRL.pocket_call[1] = val) : (CTRL.pocket_call[2] = val)
+	(pocket_call[][1] === nothing) ? (pocket_call[][1] = val) : (pocket_call[][2] = val)
 end
 """
     val get_pocket_call() -> Any
 
 Pop the contents of the first non-empty slot in the pocket_call vector stack 
 """
 function get_pocket_call()
-	val = CTRL.pocket_call[1]		# Should error if val is nothing or are there concievable correct cases?
-	CTRL.pocket_call[1] = CTRL.pocket_call[2];		CTRL.pocket_call[2] = nothing
+	val = pocket_call[][1]		# Should error if val is nothing or are there concievable correct cases?
+	pocket_call[][1] = pocket_call[][2];		pocket_call[][2] = nothing
 	return val
 end
 
@@ -3235,9 +3235,9 @@ function helper3_axes(arg, primo::String, axe::String)::String
 		@warn("Argument of the custom annotations must be an N-array or a NamedTuple");		return ""
 	end
 
-	temp::String = "GMTjl_custom_" * primo * "_" * TMPDIR_USR[2] * TMPDIR_USR[3]
+	temp::String = "GMTjl_custom_" * primo * "_" * TMPDIR_USR.username * TMPDIR_USR.pid_suffix
 	(axe != "") && (temp *= axe)
-	fname = joinpath(TMPDIR_USR[1], temp * ".txt")
+	fname = joinpath(TMPDIR_USR.dir, temp * ".txt")
 	fid = open(fname, "w")
 	if (label != [""])
 		for k = 1:n_annot
@@ -4111,7 +4111,7 @@ function dbg_print_cmd(d::Dict, cmd::Vector{String})
 
 		if (Vd >= 2)					# Delete these first before reporting
 			delete!(d, [[:show], [:leg, :legend, :l], [:box_pos], [:leg_pos], [:figname], [:name], [:savefig]])
-			CTRL.pocket_call[3] = nothing	# This is mostly for testing purposes, but potentially needed elsewhere.
+			pocket_call[][3] = nothing	# This is mostly for testing purposes, but potentially needed elsewhere.
 			CTRL.limits[1:12] = zeros(12)
 			# Some times an automtic CPT has been generated by the Vd'ed cmd but when that happens MUST debug it
 			#CURRENT_CPT[] = GMTcpt()		# Can't do this because it would f. plot(..., colorbar=true)
@@ -4182,12 +4182,12 @@ function showfig(d::Dict{Symbol, Any}, fname_ps::String, fname_ext::String, opt_
 	if (fname_ps != "" && isPluto)				# A patch attempt to an undebugable Pluto thing
 		(K) && close_PS_file(fname_ps)			# Close the PS file first
 		gmt(pscvt_cmd * fname_ps * " -Tg *")
-		out = TMPDIR_USR[1] * "/" * "GMTjl_" * TMPDIR_USR[2] * TMPDIR_USR[3] * ".png"
+		out = TMPDIR_USR.dir * "/" * "GMTjl_" * TMPDIR_USR.username * TMPDIR_USR.pid_suffix * ".png"
 		opt_T, fname_ps  = "", ""
 	end
 
 	# When we are in Jupyter or Pluto, the image may already be in a raster format by a previous call to 'gmt end'
-	(isJupyter[] || isPluto) && (fname_ps = TMPDIR_USR[1] * "/" * "GMTjl_" * TMPDIR_USR[2] * TMPDIR_USR[3] * "." * FMT[];	opt_T = "")
+	(isJupyter[] || isPluto) && (fname_ps = TMPDIR_USR.dir * "/" * "GMTjl_" * TMPDIR_USR.username * TMPDIR_USR.pid_suffix * "." * FMT[];	opt_T = "")
 
 	if (opt_T != "")
 		(K) && close_PS_file(fname_ps)			# Close the PS file first
@@ -4215,7 +4215,7 @@ function showfig(d::Dict{Symbol, Any}, fname_ps::String, fname_ext::String, opt_
 	end
 	CTRL.limits .= 0.0;		CTRL.figsize .= 0.0;	CTRL.proj_linear[1] = true;		# Reset these for safety
 	CTRL.pocket_J[1], CTRL.pocket_J[2], CTRL.pocket_J[3], CTRL.pocket_J[4] = "", "", "", "   ";
-	CTRL.pocket_R[1:2] .= "";	isJupyter[] = false;	CTRL.pocket_call .= nothing
+	CTRL.pocket_R[1:2] .= "";	isJupyter[] = false;	pocket_call[] .= nothing
 	CURRENT_VIEW[] = ""
 	return retPluto ? WrapperPluto(out) : nothing	# retPluto should make it all way down to base so that Plut displays it
 end
@@ -4453,9 +4453,9 @@ function finish_PS_module(d::Dict, cmd::Vector{String}, opt_extra::String, K::Bo
 
 	orig_J::String = ""		# To use in the case of a double Cartesian/Geog frame.
 	fi = 1
-	if (CTRL.pocket_call[3] !== nothing)	# Case where we want to run a "pre command" whose data is in pocket_call[3]
-		P = (isa(CTRL.pocket_call[3], String)) ? gmt(cmd[1]) : gmt(cmd[1], CTRL.pocket_call[3]) 
-		CTRL.pocket_call[3] = nothing		# Reset
+	if (pocket_call[][3] !== nothing)	# Case where we want to run a "pre command" whose data is in pocket_call[3]
+		P = (isa(pocket_call[][3], String)) ? gmt(cmd[1]) : gmt(cmd[1], pocket_call[][3]) 
+		pocket_call[][3] = nothing		# Reset
 		fi = 2		# First index, the one that the args... respect, start at 2
 	end
 
@@ -4482,23 +4482,23 @@ function finish_PS_module(d::Dict, cmd::Vector{String}, opt_extra::String, K::Bo
 			continue
 		elseif (k >= 1+fi && !first_was_psclip && (is_pscoast || is_basemap || is_plot) && (args1_is_I || args1_is_G || args1_is_D))
 			orig_J, orig_R = finish_PS_module_barr_2(d, args[1], cmd, k, is_plot, orig_J)
-		elseif (k >= 1+fi && k2_no_pocket && !is_psscale && !is_pscoast && !is_basemap && !is_text && (CTRL.pocket_call[1] !== nothing))
+		elseif (k >= 1+fi && k2_no_pocket && !is_psscale && !is_pscoast && !is_basemap && !is_text && (pocket_call[][1] !== nothing))
 			# For nested calls that need to pass data
 			P = gmt(cmd[k], get_pocket_call())
 			continue
 		elseif (startswith(cmd[k], "psclip") || is_text)			# Pure (unique) psclip requires args. Compose cmd not
-			P = (CTRL.pocket_call[1] !== nothing) ? gmt(cmd[k], get_pocket_call()) :
+			P = (pocket_call[][1] !== nothing) ? gmt(cmd[k], get_pocket_call()) :
 			                                        (length(cmd) > 1) ? gmt(cmd[k]) : gmt(cmd[k], args...)
 			continue
 		elseif (startswith(cmd[k], "inset"))		# Here we have an already made inset ps file waiting to be included
-			finset = searchdir(TMPDIR_USR[1], "GMTjl__inset__")[1]	# Even if there are more we only want the first
-			add2PSfile(TMPDIR_USR[1] * "/" * finset, isfile=true)	# Add the partial inset ps in main ps file.
-			rm(TMPDIR_USR[1] * "/" * finset)						# Crutial to delete after use to not be picked in a eventual next round
+			finset = searchdir(TMPDIR_USR.dir, "GMTjl__inset__")[1]	# Even if there are more we only want the first
+			add2PSfile(TMPDIR_USR.dir * "/" * finset, isfile=true)	# Add the partial inset ps in main ps file.
+			rm(TMPDIR_USR.dir * "/" * finset)						# Crutial to delete after use to not be picked in a eventual next round
 			continue
 		end
 		(k == 2) && (k2_no_pocket = true)		# For other k's this has to be neutral.
 		# Allow also plot data from a nested call to plot
-		cond = !(k > fi && is_plot && (CTRL.pocket_call[1] !== nothing))
+		cond = !(k > fi && is_plot && (pocket_call[][1] !== nothing))
 		# Next line means cases like 'plot(D, marker=:circ, ms="4p", lt=0.5, plot=(data=...))' where data in 'D'
 		# must be used twice before we pass to the next 'plot' (a nested call).
 		!cond && is_plot && (k == fi + 1) && (k < n_cmds) && contains(cmd[k], " -S") && (cond = true)
@@ -4510,7 +4510,7 @@ function finish_PS_module(d::Dict, cmd::Vector{String}, opt_extra::String, K::Bo
 		IamModern[] && (orig_J = "")	# setting orig_J to "" is a way of avoiding next line that is not for modern mode.
 		(orig_J != "") && (gmt("psxy -T -J" * orig_J * " -R" * orig_R * " -O -K" * apenda * output);  orig_J = "")
 	end
-	CTRL.pocket_call[1] = nothing;	CTRL.pocket_call[2] = nothing		# For the case it was not yet empty
+	pocket_call[][1] = nothing;	pocket_call[][2] = nothing		# For the case it was not yet empty
 
 	finish_PS_module_barr_last(d, cmd, fname, fname_ext, opt_extra, output, opt_T, K, P)	# returns P
 end

src/drawing/Drawing.jl

@@ -80,10 +80,10 @@ function helper_shapes(x, y, cmd; Vd=0, kw...)
 	# Se if we are asked to force the start a new drawing (first= true) or bypass the CTRLshapes.first control
 	_first = find_in_dict(d, [:first])[1]
 	first = (_first !== nothing) && (_first == 1)
-	CTRLshapes.first[1] = first
+	CTRLshapes.first = first
 
-	if (CTRLshapes.first[1])
-		CTRLshapes.fname[1] = PSname[]
+	if (CTRLshapes.first)
+		CTRLshapes.fname = PSname[]
 		if ((val = find_in_dict(d, [:units])[1]) !== nothing)
 			_cmd, opt_B = parse_B(d, "", DEF_FIG_AXES[])
 			cmd *= " --PROJ_LENGTH_UNIT=p"
@@ -95,7 +95,7 @@ function helper_shapes(x, y, cmd; Vd=0, kw...)
 			else
 				opt_R, ps_media = " -R0/594/0/841", " --PS_MEDIA=1194x1441"	# add 600 pt to PS_MEDIA to account 4 the 20 cm
 			end
-			CTRLshapes.points[1] = true
+			CTRLshapes.points = true
 		else
 			_cmd, opt_B, opt_J, opt_R = parse_BJR(d, "", "", false, " ")
 			(opt_R == "")  && (opt_R = " -R0/21/0/29")
@@ -105,42 +105,42 @@ function helper_shapes(x, y, cmd; Vd=0, kw...)
 		opt_O, opt_P = "", " -P"
 	else
 		opt_R, opt_J, opt_B, opt_O, opt_P = " -R", " -J", "", " -O", ""
-		(CTRLshapes.points[1]) && (cmd *= " --PROJ_LENGTH_UNIT=p")
+		(CTRLshapes.points) && (cmd *= " --PROJ_LENGTH_UNIT=p")
 	end
 
 	out, opt_T, EXT, fname, = GMT.fname_out(d, true)
 
-	redirect = (CTRLshapes.first[1]) ? " > " : " >> "
+	redirect = (CTRLshapes.first) ? " > " : " >> "
 	if (length(kw) == 0)
-		cmd = "psxy" * cmd * opt_R * opt_J * opt_B * opt_P * opt_O * " -K" * redirect * CTRLshapes.fname[1]
+		cmd = "psxy" * cmd * opt_R * opt_J * opt_B * opt_P * opt_O * " -K" * redirect * CTRLshapes.fname
 	else
 		d[:Vd] = 2
 		(opt_J != " -J" && length(opt_J) > 3) && (d[:J] = opt_J[4:end])	# Dirty trick to force assign the J we want
 		(opt_R != " -R" && length(opt_R) > 3) && (d[:R] = opt_R[4:end])
 		d[:B] = "none"
-		cmd = GMT.common_plot_xyz("", nothing, cmd, CTRLshapes.first[1], false; d...)
-		(CTRLshapes.first[1] && opt_B != "") && (cmd = replace(cmd, "psxy" => "psxy" * opt_B))
+		cmd = GMT.common_plot_xyz("", nothing, cmd, CTRLshapes.first, false; d...)
+		(CTRLshapes.first && opt_B != "") && (cmd = replace(cmd, "psxy" => "psxy" * opt_B))
 		cmd = GMT.finish_PS(d, cmd, out, true, !first)
 	end
 	(0 < Vd < 2) && println(cmd);	(Vd > 1) && return cmd
 
-	if (CTRLshapes.first[1])
-		if (CTRLshapes.points[1])  cmd *= ps_media		# When units are points we always set a specific paper size
+	if (CTRLshapes.first)
+		if (CTRLshapes.points)  cmd *= ps_media		# When units are points we always set a specific paper size
 		elseif (EXT != "ps")       cmd *= " --PS_MEDIA=32767x32767"		# Exptend to a larger paper size
 		end
 	end
 
 	in_data = (length(x) == 1) ? [x y] : [x[:] y[:]]
 	gmt(cmd, in_data)
-	CTRLshapes.first[1] = false				# To signal next calls that they have to append
+	CTRLshapes.first = false				# To signal next calls that they have to append
 	fim = ((find_in_dict(d, [:show :fmt :savefig :figname :name], false)[1]) !== nothing) ? true : false
 	(!fim) && return nothing
 
-	CTRLshapes.first[1] = true				# Better reset it right now in case next command errors
-	CTRLshapes.points[1] = false
+	CTRLshapes.first = true				# Better reset it right now in case next command errors
+	CTRLshapes.points = false
 	#show_non_consumed(d, cmd)
-	close_PS_file(CTRLshapes.fname[1])
-	showfig(d, CTRLshapes.fname[1], EXT, opt_T, false, fname)
+	close_PS_file(CTRLshapes.fname)
+	showfig(d, CTRLshapes.fname, EXT, opt_T, false, fname)
 end
 
 """

src/extras/anaglyph.jl

@@ -113,7 +113,7 @@ function anaglyph_3d(G::GMTgrid; zsize=4, azim=190, dazim=2, cmap="gray")
 
 	# We do this more convoluted call to grdview to avoid calling it directly (unknown in future GMT_base module)
 	p_left, p_right = "$(azim)/30/0", "$(azim - dazim)/30/0"
-	pato = TMPDIR_USR[1] * "/" * "GMTjl_" * TMPDIR_USR[2] * TMPDIR_USR[3] * ".jpg"
+	pato = TMPDIR_USR.dir * "/" * "GMTjl_" * TMPDIR_USR.username * TMPDIR_USR.pid_suffix * ".jpg"
 	opt_R = @sprintf("%.15g/%.15g/%.15g/%.15g/%.15g/%.15g", G.range[1], G.range[2], G.range[3], G.range[4], G.range[5], G.range[6])
 	#grdview(G, J="Q20c", JZ="$zsize", B=:none, C=string(cmap), Q=:i, p=p_left, I=true, figname=pato)
 	cmd = ["grdview -R$opt_R -JQ20c -JZ$zsize -C$cmap -Qi -p$p_left -I+a-45+nt1"]