Mercurial > octave
view scripts/plot/util/private/__opengl_print__.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 05cf43c9b351 |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2010-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{opts} =} __opengl_print__ (@var{@dots{}}) ## Undocumented internal function. ## @end deftypefn function opts = __opengl_print__ (opts) dos_shell = (ispc () && ! isunix ()); if (! isempty (opts.fig2dev_binary)) ## fig2dev is preferred for conversion to emf fig2dev_devices = {"pstex", "mf", "emf"}; else fig2dev_devices = {"pstex", "mf"}; endif gl2ps_device = {}; pipeline = {}; switch (lower (opts.devopt)) case {"eps", "eps2", "epsc", "epsc2"} ## format GL2PS_EPS gl2ps_device = {"eps"}; ## FIXME: use epstool to tighten bbox and provide preview. pipeline = {opts.epstool_cmd(opts, "-", opts.name)}; case {"epslatex", "pslatex", "pdflatex", "epslatexstandalone", ... "pslatexstandalone", "pdflatexstandalone"} ## format GL2PS_TEX n = find (opts.devopt == "l", 1); suffix = opts.devopt(1:n-1); [ndir, name, ext] = fileparts (opts.name); if (isempty (ext)) ext = "tex"; else ext = ext(2:end); # remove leading '.' endif if (any (strcmpi (ext, {suffix, "tex"}))) name = fullfile (ndir, name); if (any (strcmpi (ext, {"eps", "ps", "pdf"}))) suffix = ext; # If user provides eps/ps/pdf suffix, use it. endif else error ("Octave:print:invalid-suffix", "invalid suffix '%s' for device '%s'.", ext, lower (opts.devopt)); endif gl2ps_device = {sprintf("%snotxt", lower (suffix))}; gl2ps_device{2} = "tex"; if (dos_shell) pipeline = {sprintf('findstr . > "%s-inc.%s"', name, suffix)}; pipeline{2} = sprintf ('findstr . > "%s.tex"', name); else pipeline = {sprintf('cat > "%s-inc.%s"', name, suffix)}; pipeline{2} = sprintf ('cat > "%s.tex"', name); endif case "tikz" ## format GL2PS_PGF gl2ps_device = {"pgf"}; pipeline = {sprintf('cat > "%s"', opts.name)}; case "svg" ## format GL2PS_SVG gl2ps_device = {"svg"}; svgcmd = ""; if (opts.svgconvert) svgcmd = opts.svgconvert_cmd (opts, opts.ghostscript.device); endif if (! isempty (svgcmd)) pipeline = {sprintf(svgcmd, "svg", opts.name)}; else pipeline = {sprintf('cat > "%s"', opts.name)}; endif case fig2dev_devices cmd_fig2dev = opts.fig2dev_cmd (opts, opts.devopt); if (strcmp (opts.devopt, "pstex")) cmd_pstoedit = opts.pstoedit_cmd (opts, "fig", false); [~, ~, ext] = fileparts (opts.name); if (any (strcmpi (ext, {".ps", ".tex", "."}))) opts.name = opts.name(1:end-numel (ext)); endif opts.name = [opts.name ".ps"]; cmd = sprintf ('%s | %s > "%s"', cmd_pstoedit, cmd_fig2dev, opts.name); gl2ps_device = {"eps"}; pipeline = {cmd}; cmd_fig2dev = opts.fig2dev_cmd (opts, "pstex_t"); gl2ps_device{2} = "eps"; pipeline{2} = sprintf ('%s | %s > "%s"', cmd_pstoedit, cmd_fig2dev, strrep (opts.name, ".ps", ".tex")); else ## Using svgconvert tmp = tempname (); opts.unlink = [opts.unlink tmp]; cmd_pstoedit = sprintf (opts.pstoedit_cmd (opts, "fig"), ... "pdf", tmp, tmp); tmp = [tempname(), ".fig"]; opts.unlink = [opts.unlink tmp]; if (ispc () && ! isunix ()) cmd = sprintf ('%s "%s" & %s "%s" "%s"', cmd_pstoedit, tmp, cmd_fig2dev, tmp, opts.name); else cmd = sprintf ('%s "%s" ; %s "%s" "%s"', cmd_pstoedit, tmp, cmd_fig2dev, tmp, opts.name); endif gl2ps_device = {"svg"}; pipeline = {cmd}; endif case "aifm" tmp = tempname (); opts.unlink = [opts.unlink tmp]; cmd = sprintf (opts.pstoedit_cmd (opts, "ps2ai"), "pdf", tmp, tmp); gl2ps_device = {"svg"}; pipeline = {sprintf("%s > %s", cmd, opts.name)}; case {"dxf", "emf", "fig", "hpgl"} tmp = tempname (); opts.unlink = [opts.unlink tmp]; cmd = sprintf (opts.pstoedit_cmd (opts), "pdf", tmp, tmp); gl2ps_device = {"svg"}; pipeline = {sprintf('%s "%s"', cmd, opts.name)}; case opts.ghostscript.device svgcmd = ""; if (opts.svgconvert) svgcmd = opts.svgconvert_cmd (opts, opts.ghostscript.device); endif dosvg = ! isempty (svgcmd); if (! dosvg) opts.ghostscript.source = "-"; else tmp = tempname (); opts.ghostscript.source = tmp; opts.unlink = [opts.unlink tmp]; svgcmd = sprintf (svgcmd, "pdf", tmp); endif opts.ghostscript.output = opts.name; if (opts.send_to_printer) opts.unlink(strcmp (opts.unlink, opts.ghostscript.output)) = []; opts.ghostscript.output = "-"; endif [cmd_gs, cmd_cleanup] = __ghostscript__ (opts.ghostscript); if (opts.send_to_printer || isempty (opts.name)) cmd_lpr = opts.lpr_cmd (opts); cmd = sprintf ("%s | %s", cmd_gs, cmd_lpr); elseif (dosvg) if (dos_shell) cmd = sprintf ("%s & %s", svgcmd, cmd_gs); else cmd = sprintf ("%s ; %s", svgcmd, cmd_gs); endif else cmd = sprintf ("%s", cmd_gs); endif if (dosvg) gl2ps_device = {"svg"}; else gl2ps_device = {"eps"}; endif if (! isempty (cmd_cleanup)) if (dos_shell) pipeline = {sprintf("%s & %s", cmd, cmd_cleanup)}; else pipeline = {sprintf("%s ; %s", cmd, cmd_cleanup)}; endif else pipeline = {cmd}; endif otherwise error (sprintf ("print:no%soutput", opts.devopt), "print: %s output is not available for OpenGL toolkits", upper (opts.devopt)); endswitch opts.pipeline = pipeline; for n = 1:numel (pipeline) if (opts.debug) fprintf ("opengl-pipeline: '%s'\n", pipeline{n}); endif __check_rendering_capability__ ("print", opts.figure); ## Use toolkits "print_figure" method if (ispc () && ! isunix ()) drawnow (gl2ps_device{n}, ['| "' pipeline{n} '"']); else drawnow (gl2ps_device{n}, ["| " pipeline{n}]); endif endfor if (! isempty (strfind (opts.devopt, "standalone"))) opts.latex_standalone (opts); endif endfunction