Mercurial > octave

annotate scripts/io/is_valid_file_id.m @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2010-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ##
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## This file is part of Octave.
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ##
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 ##
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @deftypefn {} {} is_valid_file_id (@var{fid})
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 ## Return true if @var{fid} refers to an open file.
19109
e90bfaadb489 doc: Increase seealso links between low level C IO functions.
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ## @seealso{freport, fopen}
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 ## @end deftypefn
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 function retval = is_valid_file_id (fid)
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
31 retval = false;
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 if (nargin == 1)
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 try
11144
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
35 if (isscalar (fid))
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
36 [file, mode, arch] = fopen (fid);
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
37 retval = ! isempty (file);
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
38 endif
11142
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 end_try_catch
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 else
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 print_usage ();
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42 endif
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43
3450551f591e new function, is_valid_file_id
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 endfunction
11144
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
45
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
46
11144
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
47 %!assert (is_valid_file_id (stdout))
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
48 %!assert (! is_valid_file_id ([1,2;3,4]))
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
49 %!assert (! is_valid_file_id ("not_a_file_id"))
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
50 %!assert (! is_valid_file_id (-1))
461ae8d58cdb tests for is_valid_file_id
John W. Eaton <jwe@octave.org>
parents: 11142
diff changeset
51 %!assert (! is_valid_file_id (pi))