annotate scripts/miscellaneous/open.m @ 20787:40ed9b46a800

new octave_value::string_value method with optional error message * ov.h (octave_value::string_vector): New method. ov-base.cc, ov-base.h (octave_base_value::string_vector): New default method. ov-str-mat.cc, ov-str-mat.h (octave_char_matrix_str::string_value): New method.
author John W. Eaton <jwe@octave.org>
date Thu, 08 Oct 2015 16:43:22 -0400
parents df437a52bcaf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19602
diff changeset
1 ## Copyright (C) 2014-2015 John W. Eaton
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {@var{output} =} open @var{file}
19602
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19463
diff changeset
21 ## @deftypefnx {Function File} {@var{output} =} open (@var{file})
20374
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20061
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: 20061
diff changeset
23 ## the file type as determined by the file name extension.
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 ## Recognized file types are
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 ## @table @code
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 ## @item .m
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 ## Open file in the editor.
19602
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19463
diff changeset
30 ##
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 ## @item .mat
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 ## Load the file in the base workspace.
19602
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19463
diff changeset
33 ##
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 ## @item .exe
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 ## Execute the program (on Windows systems only).
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 ## @end table
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 ##
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 ## Other file types are opened in the appropriate external application.
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 ## @end deftypefn
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 function output = open (file)
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 if (nargin != 1)
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 print_usage ();
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 endif
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 if (! ischar (file))
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 error ("expecting argument to be a file name");
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
49 endif
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 [~, ~, ext] = fileparts (file);
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 if (strcmpi (ext, ".m"))
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 edit (file);
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 elseif (strcmpi (ext, ".mat"))
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56 if (nargout > 0)
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 output = load (file);
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58 else
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 evalin ("base", sprintf ("load ('%s');", file));
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60 endif
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 elseif (any (strcmpi (ext, {".fig", ".mdl", ".slx", ".prj"})))
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62 error ("opening file type '%s' is not supported", ext);
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 elseif (strcmpi (ext, ".exe"))
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 if (ispc ())
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
65 dos (file);
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66 else
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
67 error ("executing .exe files is only supported on Windows systems");
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68 endif
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
69 else
20061
5c1a38089f89 Change open_with_system_app to internal function.
Rik <rik@octave.org>
parents: 20038
diff changeset
70 __open_with_system_app__ (file);
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
71 endif
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 endfunction
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
74
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19979
diff changeset
75 ## Test input validation
19463
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76 %!error open
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 %!error open (1)
030d56f67363 implement the open function
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78 %!error output = open (1)