-m(dup2): Texinfo typo
[gnulib.git] / lib / argv-iter.h
1 /* Iterate over arguments from argv or --files0-from=FILE
2    Copyright (C) 2008-2009 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
16
17 #include <stdio.h>
18 #include <stdbool.h>
19
20 struct argv_iterator;
21 enum argv_iter_err;
22
23 #undef _ATTRIBUTE_NONNULL_
24 #if __GNUC__ == 3 && __GNUC_MINOR__ >= 3 || 3 < __GNUC__
25 # define _ATTRIBUTE_NONNULL_(m) __attribute__ ((__nonnull__ (m)))
26 #else
27 # define _ATTRIBUTE_NONNULL_(m)
28 #endif
29
30 enum argv_iter_err
31 {
32   AI_ERR_OK = 1,
33   AI_ERR_EOF,
34   AI_ERR_MEM,
35   AI_ERR_READ
36 };
37
38 struct argv_iterator *argv_iter_init_argv (char **argv)
39   _ATTRIBUTE_NONNULL_ (1);
40 struct argv_iterator *argv_iter_init_stream (FILE *fp)
41   _ATTRIBUTE_NONNULL_ (1);
42 char *argv_iter (struct argv_iterator *, enum argv_iter_err *)
43   _ATTRIBUTE_NONNULL_ (1) _ATTRIBUTE_NONNULL_ (2);
44 size_t argv_iter_n_args (struct argv_iterator const *)
45   _ATTRIBUTE_NONNULL_ (1);
46 void argv_iter_free (struct argv_iterator *)
47   _ATTRIBUTE_NONNULL_ (1);