Mercurial > octave-nkf
annotate libinterp/corefcn/getgrent.cc @ 20607:db3286201347 stable
doc: Add explanation of ':' optional input to numel().
* data.cc (Fnumel): Add explanation of ':' optional input.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 07 Oct 2015 14:52:01 -0700 |
parents | 4f45eaf83908 |
children | f90c8372b7ba |
rev | line source |
---|---|
2928 | 1 /* |
2 | |
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3 Copyright (C) 1996-2015 John W. Eaton |
2928 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
2928 | 11 |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
2928 | 20 |
21 */ | |
22 | |
23 #ifdef HAVE_CONFIG_H | |
24 #include <config.h> | |
25 #endif | |
26 | |
27 #include <string> | |
28 | |
29 #include <sys/types.h> | |
30 | |
2937 | 31 #include "oct-group.h" |
2928 | 32 |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
33 #include "defun.h" |
2928 | 34 #include "error.h" |
35 #include "gripes.h" | |
36 #include "oct-map.h" | |
37 #include "ov.h" | |
38 #include "oct-obj.h" | |
39 #include "utils.h" | |
40 | |
41 // Group file functions. (Why not?) | |
42 | |
43 static octave_value | |
2937 | 44 mk_gr_map (const octave_group& gr) |
2928 | 45 { |
46 octave_value retval; | |
47 | |
48 if (gr) | |
49 { | |
11043
e9966851619b
getpwent.cc, getgrent.cc, getrusage.cc: use octave_scalar_map instead of Octave_map
John W. Eaton <jwe@octave.org>
parents:
10182
diff
changeset
|
50 octave_scalar_map m; |
2928 | 51 |
4675 | 52 m.assign ("name", gr.name ()); |
53 m.assign ("passwd", gr.passwd ()); | |
54 m.assign ("gid", static_cast<double> (gr.gid ())); | |
55 m.assign ("mem", octave_value (gr.mem ())); | |
2928 | 56 |
57 retval = m; | |
58 } | |
59 else | |
4233 | 60 retval = 0; |
2928 | 61 |
62 return retval; | |
63 } | |
64 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
65 DEFUN (getgrent, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
66 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
67 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrent ()\n\ |
3301 | 68 Return an entry from the group database, opening it if necessary.\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
69 \n\ |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
70 Once the end of data has been reached, @code{getgrent} returns 0.\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
71 @seealso{setgrent, endgrent}\n\ |
3301 | 72 @end deftypefn") |
2928 | 73 { |
2937 | 74 octave_value_list retval; |
75 | |
3523 | 76 retval(1) = std::string (); |
4233 | 77 retval(0) = 0; |
2928 | 78 |
79 int nargin = args.length (); | |
80 | |
81 if (nargin == 0) | |
82 { | |
3523 | 83 std::string msg; |
2937 | 84 |
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
85 retval(1) = msg; |
2937 | 86 retval(0) = mk_gr_map (octave_group::getgrent (msg)); |
2928 | 87 } |
88 else | |
5823 | 89 print_usage (); |
2928 | 90 |
91 return retval; | |
92 } | |
93 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
94 DEFUN (getgrgid, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
95 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
96 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrgid (@var{gid}).\n\ |
3301 | 97 Return the first entry from the group database with the group ID\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
98 @var{gid}.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
99 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
100 If the group ID does not exist in the database, @code{getgrgid} returns 0.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
101 @seealso{getgrnam}\n\ |
3301 | 102 @end deftypefn") |
2928 | 103 { |
2937 | 104 octave_value_list retval; |
105 | |
3523 | 106 retval(1) = std::string (); |
4233 | 107 retval(0) = 0; |
2928 | 108 |
109 int nargin = args.length (); | |
110 | |
111 if (nargin == 1) | |
112 { | |
113 double dval = args(0).double_value (); | |
114 | |
115 if (! error_state) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
116 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
117 if (D_NINT (dval) == dval) |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
118 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
119 gid_t gid = static_cast<gid_t> (dval); |
2928 | 120 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
121 std::string msg; |
2937 | 122 |
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
123 retval(1) = msg; |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
124 retval(0) = mk_gr_map (octave_group::getgrgid (gid, msg)); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
125 } |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
126 else |
11553
01f703952eff
Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
127 error ("getgrgid: GID must be an integer"); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
128 } |
2928 | 129 } |
130 else | |
5823 | 131 print_usage (); |
2928 | 132 |
133 return retval; | |
134 } | |
135 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
136 DEFUN (getgrnam, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
137 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
138 @deftypefn {Built-in Function} {@var{grp_struct} =} getgrnam (@var{name})\n\ |
3301 | 139 Return the first entry from the group database with the group name\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
140 @var{name}.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
141 \n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
142 If the group name does not exist in the database, @code{getgrnam} returns 0.\n\ |
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
143 @seealso{getgrgid}\n\ |
3301 | 144 @end deftypefn") |
2928 | 145 { |
2937 | 146 octave_value_list retval; |
147 | |
3523 | 148 retval(1) = std::string (); |
4233 | 149 retval(0) = 0; |
2928 | 150 |
151 int nargin = args.length (); | |
152 | |
153 if (nargin == 1) | |
154 { | |
3523 | 155 std::string s = args(0).string_value (); |
2928 | 156 |
157 if (! error_state) | |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
158 { |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
159 std::string msg; |
2937 | 160 |
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
161 retval(1) = msg; |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
162 retval(0) = mk_gr_map (octave_group::getgrnam (s.c_str (), msg)); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9245
diff
changeset
|
163 } |
2928 | 164 } |
165 else | |
5823 | 166 print_usage (); |
2928 | 167 |
168 return retval; | |
169 } | |
170 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
171 DEFUN (setgrent, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
172 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
173 @deftypefn {Built-in Function} {} setgrent ()\n\ |
3301 | 174 Return the internal pointer to the beginning of the group database.\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
175 @seealso{getgrent, endgrent}\n\ |
3301 | 176 @end deftypefn") |
2928 | 177 { |
2937 | 178 octave_value_list retval; |
179 | |
3523 | 180 retval(1) = std::string (); |
2937 | 181 retval(0) = -1.0; |
2928 | 182 |
183 int nargin = args.length (); | |
184 | |
185 if (nargin == 0) | |
186 { | |
3523 | 187 std::string msg; |
2937 | 188 |
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
189 retval(1) = msg; |
2937 | 190 retval(0) = static_cast<double> (octave_group::setgrent (msg)); |
2928 | 191 } |
192 else | |
5823 | 193 print_usage (); |
2928 | 194 |
195 return retval; | |
196 } | |
197 | |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
198 DEFUN (endgrent, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
199 "-*- texinfo -*-\n\ |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
200 @deftypefn {Built-in Function} {} endgrent ()\n\ |
3301 | 201 Close the group database.\n\ |
20207
4f45eaf83908
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
202 @seealso{getgrent, setgrent}\n\ |
3301 | 203 @end deftypefn") |
2928 | 204 { |
2937 | 205 octave_value_list retval; |
206 | |
3523 | 207 retval(1) = std::string (); |
2937 | 208 retval(0) = -1.0; |
2928 | 209 |
210 int nargin = args.length (); | |
211 | |
212 if (nargin == 0) | |
213 { | |
3523 | 214 std::string msg; |
2937 | 215 |
14022
de90542b7afc
Return retval(1) before retval(0) to avoid re-sizing call on retval.
Rik <octave@nomad.inbox5.com>
parents:
11553
diff
changeset
|
216 retval(1) = msg; |
2937 | 217 retval(0) = static_cast<double> (octave_group::endgrent (msg)); |
2928 | 218 } |
219 else | |
5823 | 220 print_usage (); |
2928 | 221 |
222 return retval; | |
223 } |