Mercurial > octave
view scripts/miscellaneous/run.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 27 Mar 2016 15:50:01 -0700 |
parents | 516bb87ea72e |
children | ffad2baa90f7 |
line wrap: on
line source
## Copyright (C) 2007-2015 David Bateman ## ## 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 ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {} run @var{script} ## @deftypefnx {} {} run ("@var{script}") ## Run @var{script} in the current workspace. ## ## Scripts which reside in directories specified in Octave's load path, and ## which end with the extension @file{".m"}, can be run simply by typing ## their name. For scripts not located on the load path, use @code{run}. ## ## The filename @var{script} can be a bare, fully qualified, or relative ## filename and with or without a file extension. If no extension is ## specified, Octave will first search for a script with the @file{".m"} ## extension before falling back to the script name without an extension. ## ## Implementation Note: If @var{script} includes a path component, then ## @code{run} first changes the working directory to the directory where ## @var{script} is found. Next, the script is executed. Finally, @code{run} ## returns to the original working directory unless @code{script} has ## specifically changed directories. ## @seealso{path, addpath, source} ## @end deftypefn function run (script) if (nargin != 1) print_usage (); endif [d, f, ext] = fileparts (script); if (! strcmp (ext, ".m")) ## prefer files with .m extension for compatibility with Matlab if (exist ([script ".m"], "file")) f = [f ext]; ext = ".m"; script = [script ".m"]; endif endif if (! exist (script, "file")) error ("run: file SCRIPT must exist and be a valid Octave scriptfile"); endif if (! isempty (d)) if (exist (d, "dir")) startdir = pwd (); d = make_absolute_filename (d); unwind_protect cd (d); evalin ("caller", sprintf ("source ('%s%s');", f, ext), "rethrow (lasterror ())"); unwind_protect_cleanup if (strcmp (d, pwd ())) cd (startdir); endif end_unwind_protect else error ("run: the path %s doesn't exist", d); endif else if (! isempty (ext)) script = which (script); else ## Search PATH with null extension ('.' will be stripped and ext = "") script = which ([script "."]); endif evalin ("caller", sprintf ("source ('%s');", script), "rethrow (lasterror ())"); endif endfunction ## Test input validation %!error run () %!error run ("a", "b") %!error <SCRIPT must exist> run ("__A_very_#unlikely#_file_name__")