xref: /illumos-gate/usr/src/cmd/acpi/common/getopt.c (revision 25d3556849fcbe4fe5d517e1add48e0b2d585c70)
1 /******************************************************************************
2  *
3  * Module Name: getopt
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 /*
45  * ACPICA getopt() implementation
46  *
47  * Option strings:
48  *    "f"       - Option has no arguments
49  *    "f:"      - Option requires an argument
50  *    "f+"      - Option has an optional argument
51  *    "f^"      - Option has optional single-char sub-options
52  *    "f|"      - Option has required single-char sub-options
53  */
54 
55 #include "acpi.h"
56 #include "accommon.h"
57 #include "acapps.h"
58 
59 #define ACPI_OPTION_ERROR(msg, badchar) \
60     if (AcpiGbl_Opterr) {AcpiLogError ("%s%c\n", msg, badchar);}
61 
62 
63 int                 AcpiGbl_Opterr = 1;
64 int                 AcpiGbl_Optind = 1;
65 int                 AcpiGbl_SubOptChar = 0;
66 char                *AcpiGbl_Optarg;
67 
68 static int          CurrentCharPtr = 1;
69 
70 
71 /*******************************************************************************
72  *
73  * FUNCTION:    AcpiGetoptArgument
74  *
75  * PARAMETERS:  argc, argv          - from main
76  *
77  * RETURN:      0 if an argument was found, -1 otherwise. Sets AcpiGbl_Optarg
78  *              to point to the next argument.
79  *
80  * DESCRIPTION: Get the next argument. Used to obtain arguments for the
81  *              two-character options after the original call to AcpiGetopt.
82  *              Note: Either the argument starts at the next character after
83  *              the option, or it is pointed to by the next argv entry.
84  *              (After call to AcpiGetopt, we need to backup to the previous
85  *              argv entry).
86  *
87  ******************************************************************************/
88 
89 int
90 AcpiGetoptArgument (
91     int                     argc,
92     char                    **argv)
93 {
94 
95     AcpiGbl_Optind--;
96     CurrentCharPtr++;
97 
98     if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
99     {
100         AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
101     }
102     else if (++AcpiGbl_Optind >= argc)
103     {
104         ACPI_OPTION_ERROR ("Option requires an argument: -", 'v');
105 
106         CurrentCharPtr = 1;
107         return (-1);
108     }
109     else
110     {
111         AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
112     }
113 
114     CurrentCharPtr = 1;
115     return (0);
116 }
117 
118 
119 /*******************************************************************************
120  *
121  * FUNCTION:    AcpiGetopt
122  *
123  * PARAMETERS:  argc, argv          - from main
124  *              opts                - options info list
125  *
126  * RETURN:      Option character or ACPI_OPT_END
127  *
128  * DESCRIPTION: Get the next option
129  *
130  ******************************************************************************/
131 
132 int
133 AcpiGetopt(
134     int                     argc,
135     char                    **argv,
136     char                    *opts)
137 {
138     int                     CurrentChar;
139     char                    *OptsPtr;
140 
141 
142     if (CurrentCharPtr == 1)
143     {
144         if (AcpiGbl_Optind >= argc ||
145             argv[AcpiGbl_Optind][0] != '-' ||
146             argv[AcpiGbl_Optind][1] == '\0')
147         {
148             return (ACPI_OPT_END);
149         }
150         else if (strcmp (argv[AcpiGbl_Optind], "--") == 0)
151         {
152             AcpiGbl_Optind++;
153             return (ACPI_OPT_END);
154         }
155     }
156 
157     /* Get the option */
158 
159     CurrentChar = argv[AcpiGbl_Optind][CurrentCharPtr];
160 
161     /* Make sure that the option is legal */
162 
163     if (CurrentChar == ':' ||
164        (OptsPtr = strchr (opts, CurrentChar)) == NULL)
165     {
166         ACPI_OPTION_ERROR ("Illegal option: -", CurrentChar);
167 
168         if (argv[AcpiGbl_Optind][++CurrentCharPtr] == '\0')
169         {
170             AcpiGbl_Optind++;
171             CurrentCharPtr = 1;
172         }
173 
174         return ('?');
175     }
176 
177     /* Option requires an argument? */
178 
179     if (*++OptsPtr == ':')
180     {
181         if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
182         {
183             AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
184         }
185         else if (++AcpiGbl_Optind >= argc)
186         {
187             ACPI_OPTION_ERROR (
188                 "Option requires an argument: -", CurrentChar);
189 
190             CurrentCharPtr = 1;
191             return ('?');
192         }
193         else
194         {
195             AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
196         }
197 
198         CurrentCharPtr = 1;
199     }
200 
201     /* Option has an optional argument? */
202 
203     else if (*OptsPtr == '+')
204     {
205         if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
206         {
207             AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
208         }
209         else if (++AcpiGbl_Optind >= argc)
210         {
211             AcpiGbl_Optarg = NULL;
212         }
213         else
214         {
215             AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
216         }
217 
218         CurrentCharPtr = 1;
219     }
220 
221     /* Option has optional single-char arguments? */
222 
223     else if (*OptsPtr == '^')
224     {
225         if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
226         {
227             AcpiGbl_Optarg = &argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)];
228         }
229         else
230         {
231             AcpiGbl_Optarg = "^";
232         }
233 
234         AcpiGbl_SubOptChar = AcpiGbl_Optarg[0];
235         AcpiGbl_Optind++;
236         CurrentCharPtr = 1;
237     }
238 
239     /* Option has a required single-char argument? */
240 
241     else if (*OptsPtr == '|')
242     {
243         if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
244         {
245             AcpiGbl_Optarg = &argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)];
246         }
247         else
248         {
249             ACPI_OPTION_ERROR (
250                 "Option requires a single-character suboption: -",
251                 CurrentChar);
252 
253             CurrentCharPtr = 1;
254             return ('?');
255         }
256 
257         AcpiGbl_SubOptChar = AcpiGbl_Optarg[0];
258         AcpiGbl_Optind++;
259         CurrentCharPtr = 1;
260     }
261 
262     /* Option with no arguments */
263 
264     else
265     {
266         if (argv[AcpiGbl_Optind][++CurrentCharPtr] == '\0')
267         {
268             CurrentCharPtr = 1;
269             AcpiGbl_Optind++;
270         }
271 
272         AcpiGbl_Optarg = NULL;
273     }
274 
275     return (CurrentChar);
276 }
277