1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #pragma once
30 
31 #include <sys/cdefs.h>
32 
33 __BEGIN_DECLS
34 
35 /**
36  * [getopt(3)](http://man7.org/linux/man-pages/man3/getopt.3.html) parses command-line options.
37  *
38  * Returns the next option character on success, returns -1 if all options have been parsed, and
39  * returns `'?'` on error.
40  */
41 int getopt(int __argc, char* const __argv[], const char* __options);
42 
43 /**
44  * Points to the text of the corresponding value for options that take an argument.
45  */
46 extern char* optarg;
47 
48 /**
49  * The index of the next element to be processed.
50  * On Android, callers should set `optreset = 1` rather than trying to reset `optind` to
51  * scan a new argument vector.
52  */
53 extern int optind;
54 
55 /**
56  * Determines whether getopt() outputs error messages.
57  * Callers should set this to `0` to disable error messages.
58  * Defaults to non-zero.
59  */
60 extern int opterr;
61 
62 /**
63  * The last unrecognized option character, valid when getopt() returns `'?'`.
64  */
65 extern int optopt;
66 
67 __END_DECLS
68