annotate scripts/miscellaneous/fileattrib.m @ 20039:eba80000fa0d rc-4-0-0-2

maint: Bump version number for 4.0.0-rc2.
author John W. Eaton <jwe@octave.org>
date Fri, 20 Mar 2015 16:19:38 -0400
parents 4197fc428c7d
children df437a52bcaf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 18891
diff changeset
1 ## Copyright (C) 2005-2015 John W. Eaton
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
2 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
4 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
9 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
14 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
18
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
14064
0b748d4284de fileattrib: fix on documentation
Carnë Draug <carandraug+dev@gmail.com>
parents: 11523
diff changeset
20 ## @deftypefn {Function File} {[@var{status}, @var{result}, @var{msgid}] =} fileattrib (@var{file})
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
21 ## Return information about @var{file}.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
22 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
23 ## If successful, @var{status} is 1, with @var{result} containing a
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
24 ## structure with the following fields:
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
25 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
26 ## @table @code
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
27 ## @item Name
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
28 ## Full name of @var{file}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
29 ##
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
30 ## @item archive
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
31 ## True if @var{file} is an archive (Windows).
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
32 ##
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
33 ## @item system
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
34 ## True if @var{file} is a system file (Windows).
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
35 ##
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
36 ## @item hidden
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
37 ## True if @var{file} is a hidden file (Windows).
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
38 ##
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
39 ## @item directory
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
40 ## True if @var{file} is a directory.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
41 ##
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15007
diff changeset
42 ## @item UserRead
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
43 ## @itemx GroupRead
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
44 ## @itemx OtherRead
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
45 ## True if the user (group; other users) has read permission for
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
46 ## @var{file}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
47 ##
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15007
diff changeset
48 ## @item UserWrite
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
49 ## @itemx GroupWrite
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
50 ## @itemx OtherWrite
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
51 ## True if the user (group; other users) has write permission for
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
52 ## @var{file}.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
53 ##
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15007
diff changeset
54 ## @item UserExecute
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
55 ## @itemx GroupExecute
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
56 ## @itemx OtherExecute
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
57 ## True if the user (group; other users) has execute permission for
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
58 ## @var{file}.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
59 ## @end table
15007
8f0e3c5bfa5f doc: Periodic grammarcheck of documentation
Rik <rik@octave.org>
parents: 14138
diff changeset
60 ##
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
61 ## If an attribute does not apply (i.e., archive on a Unix system) then
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
62 ## the field is set to NaN.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
63 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
64 ## With no input arguments, return information about the current
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
65 ## directory.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
66 ##
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
67 ## If @var{file} contains globbing characters, return information about
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
68 ## all the matching files.
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
69 ## @seealso{glob}
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
70 ## @end deftypefn
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
71
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
72 function [status, msg, msgid] = fileattrib (file)
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
73
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
74 status = true;
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
75 msg = "";
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
76 msgid = "";
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
77
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
78 if (nargin == 0)
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
79 file = ".";
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
80 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
81
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
82 if (ischar (file))
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
83 files = glob (file);
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
84 if (isempty (files))
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
85 files = {file};
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
86 nfiles = 1;
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
87 else
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
88 nfiles = length (files);
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
89 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
90 else
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
91 error ("fileattrib: expecting first argument to be a character string");
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
92 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
93
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
94 if (nargin == 0 || nargin == 1)
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
95
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
96 r_n = r_a = r_s = r_h = r_d ...
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
97 = r_u_r = r_u_w = r_u_x ...
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
98 = r_g_r = r_g_w = r_g_x ...
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
99 = r_o_r = r_o_w = r_o_x = cell (nfiles, 1);
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
100
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
101 curr_dir = pwd ();
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
102
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
103 for i = 1:nfiles
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
104 [info, err, msg] = stat (files{i});
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
105 if (! err)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
106 r_n{i} = canonicalize_file_name (files{i});
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
107 r_a{i} = NaN;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
108 r_s{i} = NaN;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
109 r_h{i} = NaN;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
110 r_d{i} = S_ISDIR (info.mode);
18891
7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files.
Rik <rik@octave.org>
parents: 17744
diff changeset
111 ## FIXME: Maybe we should have S_IRUSR etc. masks?
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
112 modestr = info.modestr;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
113 r_u_r{i} = modestr(2) == "r";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
114 r_u_w{i} = modestr(3) == "w";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
115 r_u_x{i} = modestr(4) == "x";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
116 r_g_r{i} = modestr(5) == "r";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
117 r_g_w{i} = modestr(6) == "w";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
118 r_g_x{i} = modestr(7) == "x";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
119 r_o_r{i} = modestr(8) == "r";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
120 r_o_w{i} = modestr(9) == "w";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
121 r_o_x{i} = modestr(10) == "x";
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
122 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
123 status = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
124 msgid = "fileattrib";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
125 break;
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
126 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
127 endfor
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
128 if (status)
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
129 r = struct ("Name", r_n, "archive", r_a, "system", r_s,
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
130 "hidden", r_s, "directory", r_d, "UserRead", r_u_r,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
131 "UserWrite", r_u_w, "UserExecute", r_u_x,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
132 "GroupRead", r_g_r, "GroupWrite", r_g_w,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
133 "GroupExecute", r_g_x, "OtherRead", r_o_r,
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
134 "OtherWrite", r_o_w, "OtherExecute", r_o_x);
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
135 if (nargout == 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
136 status = r;
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
137 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 7017
diff changeset
138 msg = r;
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
139 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
140 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
141 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5775
diff changeset
142 print_usage ();
5559
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
143 endif
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
144
45304bb922f1 [project @ 2005-12-05 16:06:28 by jwe]
jwe
parents:
diff changeset
145 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17170
diff changeset
146