Mercurial > octave-antonio
annotate scripts/miscellaneous/open.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 May 2015 14:22:02 -0700 |
| parents | 5c1a38089f89 |
| children |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19405
diff
changeset
|
1 ## Copyright (C) 2014-2015 John W. Eaton |
| 19271 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {@var{output} =} open @var{file} | |
|
19405
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19271
diff
changeset
|
21 ## @deftypefnx {Function File} {@var{output} =} open (@var{file}) |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19856
diff
changeset
|
22 ## Open the file @var{file} in Octave or in an external application based on |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19856
diff
changeset
|
23 ## the file type as determined by the file name extension. |
| 19271 | 24 ## |
| 25 ## Recognized file types are | |
| 26 ## | |
| 27 ## @table @code | |
| 28 ## @item .m | |
| 29 ## Open file in the editor. | |
|
19405
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19271
diff
changeset
|
30 ## |
| 19271 | 31 ## @item .mat |
| 32 ## Load the file in the base workspace. | |
|
19405
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19271
diff
changeset
|
33 ## |
| 19271 | 34 ## @item .exe |
| 35 ## Execute the program (on Windows systems only). | |
| 36 ## @end table | |
| 37 ## | |
| 38 ## Other file types are opened in the appropriate external application. | |
| 39 ## @end deftypefn | |
| 40 | |
| 41 function output = open (file) | |
| 42 | |
| 43 if (nargin != 1) | |
| 44 print_usage (); | |
| 45 endif | |
| 46 | |
| 47 if (! ischar (file)) | |
| 48 error ("expecting argument to be a file name"); | |
| 49 endif | |
| 50 | |
| 51 [~, ~, ext] = fileparts (file); | |
| 52 | |
| 53 if (strcmpi (ext, ".m")) | |
| 54 edit (file); | |
| 55 elseif (strcmpi (ext, ".mat")) | |
| 56 if (nargout > 0) | |
| 57 output = load (file); | |
| 58 else | |
| 59 evalin ("base", sprintf ("load ('%s');", file)); | |
| 60 endif | |
| 61 elseif (any (strcmpi (ext, {".fig", ".mdl", ".slx", ".prj"}))) | |
| 62 error ("opening file type '%s' is not supported", ext); | |
| 63 elseif (strcmpi (ext, ".exe")) | |
| 64 if (ispc ()) | |
| 65 dos (file); | |
| 66 else | |
| 67 error ("executing .exe files is only supported on Windows systems"); | |
| 68 endif | |
| 69 else | |
|
19856
5c1a38089f89
Change open_with_system_app to internal function.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
70 __open_with_system_app__ (file); |
| 19271 | 71 endif |
| 72 | |
| 73 endfunction | |
| 74 | |
|
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19774
diff
changeset
|
75 ## Test input validation |
| 19271 | 76 %!error open |
| 77 %!error open (1) | |
| 78 %!error output = open (1) |