Mercurial > octave
view scripts/plot/util/private/__ghostscript__.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 | 796f54d4ddbf |
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{gs_cmd}, @var{cleanup_cmd}] =} __ghostscript__ (@var{@dots{}}) ## Undocumented internal function. ## @end deftypefn function [gs_cmd, cleanup_cmd] = __ghostscript__ (varargin) dos_shell = (ispc () && ! isunix ()); opts.binary = ""; opts.source = "-"; opts.output = "-"; opts.device = ""; opts.epscrop = false; opts.antialiasing = false; opts.antialiasing_textalphabits = 4; opts.antialiasing_graphicsalphabits = 1; opts.resolution = 150; opts.papersize = ""; opts.pageoffset = [0 0]; opts.debug = false; opts.level = []; opts.prepend = ""; offsetfile = ""; offset_ps = {}; cleanup_cmd = ""; args = varargin; n = find (cellfun ("isclass", args, "struct")); if (! isempty (n)) f = fieldnames (args{n}); for m = 1:numel (f) opts.(f{m}) = args{n}.(f{m}); endfor args(n) = []; endif for n = 1:2:numel (args) opts.(args{n}) = args{n+1}; endfor if (isempty (opts.binary)) error ("Octave:print:nogs", "__ghostscript__: 'gs' (Ghostscript) binary is required for specified output format, but binary is not available in PATH"); endif if (isempty (opts.papersize)) format_for_printer = false; else format_for_printer = true; endif gs_opts = ["-dQUIET -dNOPAUSE -dBATCH -dSAFER -dAutoRotatePages=/None -sDEVICE=" opts.device]; if (! isempty (opts.level) && ismember (opts.level, [1, 2, 3])) gs_opts = sprintf ("%s -dLanguageLevel=%d", gs_opts, opts.level); endif if (strfind (opts.device, "tiffscaled")) gs_opts = [gs_opts " -sCompression=lzw"]; endif if (opts.antialiasing && isempty (strfind (opts.device, "write"))) ## Apply anti-aliasing to all bitmap formats/devices gs_opts = sprintf ("%s -dTextAlphaBits=%d -dGraphicsAlphaBits=%d", gs_opts, fix (opts.antialiasing_textalphabits), fix (opts.antialiasing_graphicsalphabits)); gs_opts = sprintf ("%s -r%dx%d", gs_opts, fix ([1, 1] * opts.resolution)); elseif (any (strcmp (opts.device, {"pswrite", "ps2write", "pdfwrite"}))) gs_opts = sprintf ("%s -dEmbedAllFonts=true", gs_opts); if (strcmp (opts.device, "pdfwrite")) ## Optimize for loading gs_opts = sprintf ("%s -dOptimize=true", gs_opts); endif endif if (opts.epscrop) ## papersize is specified by the eps bbox gs_opts = sprintf ("%s -dEPSCrop", gs_opts); endif if (format_for_printer) if (ischar (opts.papersize)) gs_opts = sprintf ("%s -sPAPERSIZE=%s", gs_opts, opts.papersize); elseif (isnumeric (opts.papersize) && numel (opts.papersize) == 2) gs_opts = sprintf ("%s -dDEVICEWIDTHPOINTS=%d -dDEVICEHEIGHTPOINTS=%d", gs_opts, fix (opts.papersize)); if (opts.papersize(1) > opts.papersize(2)) ## Lanscape mode: This option will result in automatic rotation of the ## document page if the requested page size matches one ## of the default page sizes gs_opts = sprintf ("%s -dNORANGEPAGESIZE", gs_opts); endif else error ("Octave:print:badpapersize", "__ghostscript__.m: invalid 'papersize'"); endif gs_opts = sprintf ("%s -dFIXEDMEDIA", gs_opts); ## "pageoffset" is relative to the coordinates, not the BBox LLHC. str = sprintf ("%s [%d %d] %s", "<< /Margins [0 0] /.HWMargins [0 0 0 0] /PageOffset", fix (opts.pageoffset), ">> setpagedevice"); offset_ps = {"%!PS-Adobe-3.0", str, "%%EOF"}; if (isfield (opts, "offsetfile")) offsetfile = opts.offsetfile; cleanup_cmd = ""; else offsetfile = [tempname() ".ps"]; if (dos_shell) cleanup_cmd = sprintf ('del "%s"', strrep (offsetfile, '/', '\')); else cleanup_cmd = sprintf ('rm "%s"', offsetfile); endif endif unwind_protect fid = fopen (offsetfile, "w"); if (fid == -1) error ("Octave:print:fopenfailed", "__ghostscript__.m: fopen () failed"); endif fprintf (fid, "%s\n", offset_ps{:}); unwind_protect_cleanup status = fclose (fid); if (status == -1) error ("Octave:print:fclosefailed", "__ghostscript__.m: fclose () failed"); endif end_unwind_protect if (opts.debug) fprintf ("---- begin %s ----\n", offsetfile); fprintf ("%s\n", offset_ps{:}); fprintf ("----- end %s -----\n", offsetfile); endif endif if (isempty (opts.output)) cmd = sprintf ("%s %s", opts.binary, gs_opts); else cmd = sprintf ('%s %s -sOutputFile="%s"', opts.binary, gs_opts, opts.output); endif if (! isempty (opts.prepend) && any (strcmpi (opts.device, {"pswrite", "ps2write", "pdfwrite"}))) ## FIXME: Fonts get may be mangled when appending ps/ps2. ## See "How to concatenate several PS files" at the link, ## http://en.wikibooks.org/wiki/PostScript_FAQ cmd = sprintf ("%s %s", cmd, opts.prepend); if (isempty (cleanup_cmd)) if (dos_shell) cleanup_cmd = ["del " strrep(opts.prepend, '/', '\')]; else cleanup_cmd = ["rm " opts.prepend]; endif else if (dos_shell) cleanup_cmd = sprintf ("%s & del %s", cleanup_cmd, strrep (opts.prepend, '/', '\')); else cleanup_cmd = sprintf ("%s ; rm %s", cleanup_cmd, opts.prepend); endif endif endif if (! isempty (offsetfile) && format_for_printer) cmd = sprintf ('%s "%s"', cmd, offsetfile); endif if (! isempty (opts.source)) cmd = sprintf ("%s %s", cmd, opts.source); endif if (opts.debug) fprintf ("Ghostscript command: '%s'\n", cmd); endif gs_cmd = cmd; endfunction