1/******************************************************************************
2 *
3 * Module Name: getopt
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 *    notice, this list of conditions, and the following disclaimer,
124 *    without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 *    substantially similar to the "NO WARRANTY" disclaimer below
127 *    ("Disclaimer") and any redistribution must be conditioned upon
128 *    including a substantially similar Disclaimer requirement for further
129 *    binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 *    of any contributors may be used to endorse or promote products derived
132 *    from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152/*
153 * ACPICA getopt() implementation
154 *
155 * Option strings:
156 *    "f"       - Option has no arguments
157 *    "f:"      - Option requires an argument
158 *    "f+"      - Option has an optional argument
159 *    "f^"      - Option has optional single-char sub-options
160 *    "f|"      - Option has required single-char sub-options
161 */
162
163#include "acpi.h"
164#include "accommon.h"
165#include "acapps.h"
166
167#define ACPI_OPTION_ERROR(msg, badchar) \
168    if (AcpiGbl_Opterr) {fprintf (stderr, "%s%c\n", msg, badchar);}
169
170
171int                 AcpiGbl_Opterr = 1;
172int                 AcpiGbl_Optind = 1;
173int                 AcpiGbl_SubOptChar = 0;
174char                *AcpiGbl_Optarg;
175
176static int          CurrentCharPtr = 1;
177
178
179/*******************************************************************************
180 *
181 * FUNCTION:    AcpiGetoptArgument
182 *
183 * PARAMETERS:  argc, argv          - from main
184 *
185 * RETURN:      0 if an argument was found, -1 otherwise. Sets AcpiGbl_Optarg
186 *              to point to the next argument.
187 *
188 * DESCRIPTION: Get the next argument. Used to obtain arguments for the
189 *              two-character options after the original call to AcpiGetopt.
190 *              Note: Either the argument starts at the next character after
191 *              the option, or it is pointed to by the next argv entry.
192 *              (After call to AcpiGetopt, we need to backup to the previous
193 *              argv entry).
194 *
195 ******************************************************************************/
196
197int
198AcpiGetoptArgument (
199    int                     argc,
200    char                    **argv)
201{
202
203    AcpiGbl_Optind--;
204    CurrentCharPtr++;
205
206    if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
207    {
208        AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
209    }
210    else if (++AcpiGbl_Optind >= argc)
211    {
212        ACPI_OPTION_ERROR ("\nOption requires an argument", 0);
213
214        CurrentCharPtr = 1;
215        return (-1);
216    }
217    else
218    {
219        AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
220    }
221
222    CurrentCharPtr = 1;
223    return (0);
224}
225
226
227/*******************************************************************************
228 *
229 * FUNCTION:    AcpiGetopt
230 *
231 * PARAMETERS:  argc, argv          - from main
232 *              opts                - options info list
233 *
234 * RETURN:      Option character or ACPI_OPT_END
235 *
236 * DESCRIPTION: Get the next option
237 *
238 ******************************************************************************/
239
240int
241AcpiGetopt(
242    int                     argc,
243    char                    **argv,
244    char                    *opts)
245{
246    int                     CurrentChar;
247    char                    *OptsPtr;
248
249
250    if (CurrentCharPtr == 1)
251    {
252        if (AcpiGbl_Optind >= argc ||
253            argv[AcpiGbl_Optind][0] != '-' ||
254            argv[AcpiGbl_Optind][1] == '\0')
255        {
256            return (ACPI_OPT_END);
257        }
258        else if (strcmp (argv[AcpiGbl_Optind], "--") == 0)
259        {
260            AcpiGbl_Optind++;
261            return (ACPI_OPT_END);
262        }
263    }
264
265    /* Get the option */
266
267    CurrentChar = argv[AcpiGbl_Optind][CurrentCharPtr];
268
269    /* Make sure that the option is legal */
270
271    if (CurrentChar == ':' ||
272       (OptsPtr = strchr (opts, CurrentChar)) == NULL)
273    {
274        ACPI_OPTION_ERROR ("Illegal option: -", CurrentChar);
275
276        if (argv[AcpiGbl_Optind][++CurrentCharPtr] == '\0')
277        {
278            AcpiGbl_Optind++;
279            CurrentCharPtr = 1;
280        }
281
282        return ('?');
283    }
284
285    /* Option requires an argument? */
286
287    if (*++OptsPtr == ':')
288    {
289        if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
290        {
291            AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
292        }
293        else if (++AcpiGbl_Optind >= argc)
294        {
295            ACPI_OPTION_ERROR (
296                "Option requires an argument: -", CurrentChar);
297
298            CurrentCharPtr = 1;
299            return ('?');
300        }
301        else
302        {
303            AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
304        }
305
306        CurrentCharPtr = 1;
307    }
308
309    /* Option has an optional argument? */
310
311    else if (*OptsPtr == '+')
312    {
313        if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
314        {
315            AcpiGbl_Optarg = &argv[AcpiGbl_Optind++][(int) (CurrentCharPtr+1)];
316        }
317        else if (++AcpiGbl_Optind >= argc)
318        {
319            AcpiGbl_Optarg = NULL;
320        }
321        else
322        {
323            AcpiGbl_Optarg = argv[AcpiGbl_Optind++];
324        }
325
326        CurrentCharPtr = 1;
327    }
328
329    /* Option has optional single-char arguments? */
330
331    else if (*OptsPtr == '^')
332    {
333        if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
334        {
335            AcpiGbl_Optarg = &argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)];
336        }
337        else
338        {
339            AcpiGbl_Optarg = "^";
340        }
341
342        AcpiGbl_SubOptChar = AcpiGbl_Optarg[0];
343        AcpiGbl_Optind++;
344        CurrentCharPtr = 1;
345    }
346
347    /* Option has a required single-char argument? */
348
349    else if (*OptsPtr == '|')
350    {
351        if (argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)] != '\0')
352        {
353            AcpiGbl_Optarg = &argv[AcpiGbl_Optind][(int) (CurrentCharPtr+1)];
354        }
355        else
356        {
357            ACPI_OPTION_ERROR (
358                "Option requires a single-character suboption: -",
359                CurrentChar);
360
361            CurrentCharPtr = 1;
362            return ('?');
363        }
364
365        AcpiGbl_SubOptChar = AcpiGbl_Optarg[0];
366        AcpiGbl_Optind++;
367        CurrentCharPtr = 1;
368    }
369
370    /* Option with no arguments */
371
372    else
373    {
374        if (argv[AcpiGbl_Optind][++CurrentCharPtr] == '\0')
375        {
376            CurrentCharPtr = 1;
377            AcpiGbl_Optind++;
378        }
379
380        AcpiGbl_Optarg = NULL;
381    }
382
383    return (CurrentChar);
384}
385