annotate lib/argv-iter.h @ 40186:8964917f9574

autoupdate
author Karl Berry <karl@freefriends.org>
date Mon, 18 Feb 2019 08:02:49 -0800
parents b06060465f09
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
1 /* Iterate over arguments from argv or --files0-from=FILE
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 19484
diff changeset
2 Copyright (C) 2008-2019 Free Software Foundation, Inc.
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
3
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
4 This program is free software: you can redistribute it and/or modify
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
5 it under the terms of the GNU General Public License as published by
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
6 the Free Software Foundation, either version 3 of the License, or
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
7 (at your option) any later version.
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
8
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful,
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
12 GNU General Public License for more details.
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
13
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License
19190
9759915b2aca all: prefer https: URLs
Paul Eggert <eggert@cs.ucla.edu>
parents: 18626
diff changeset
15 along with this program. If not, see <https://www.gnu.org/licenses/>. */
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
16
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
17 #include <stdio.h>
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
18 #include <stdbool.h>
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
19
12422
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
20 /* Definition of _GL_ARG_NONNULL. */
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
21 #include "arg-nonnull.h"
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
22
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
23 struct argv_iterator;
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
24
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
25 enum argv_iter_err
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
26 {
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
27 AI_ERR_OK = 1,
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
28 AI_ERR_EOF,
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
29 AI_ERR_MEM,
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
30 AI_ERR_READ
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
31 };
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
32
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
33 struct argv_iterator *argv_iter_init_argv (char **argv)
12422
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
34 _GL_ARG_NONNULL ((1));
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
35 struct argv_iterator *argv_iter_init_stream (FILE *fp)
12422
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
36 _GL_ARG_NONNULL ((1));
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
37 char *argv_iter (struct argv_iterator *, enum argv_iter_err *)
12422
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
38 _GL_ARG_NONNULL ((1, 2));
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
39 size_t argv_iter_n_args (struct argv_iterator const *)
16128
6beadb731202 mark functions with const and pure attributes
Jim Meyering <meyering@redhat.com>
parents: 14079
diff changeset
40 _GL_ATTRIBUTE_PURE _GL_ARG_NONNULL ((1));
11708
f74cfe188f81 argv-iter: new module
Jim Meyering <meyering@redhat.com>
parents:
diff changeset
41 void argv_iter_free (struct argv_iterator *)
12422
f7842310a565 New module 'arg-nonnull'. Declare which arguments expect non-NULL values.
Bruno Haible <bruno@clisp.org>
parents: 11708
diff changeset
42 _GL_ARG_NONNULL ((1));