xref: /netbsd-src/external/bsd/ntp/dist/sntp/libopts/sort.c (revision 7788a0781fe6ff2cce37368b4578a7ade0850cb1)
1 /*	$NetBSD: sort.c,v 1.1.1.2 2012/01/31 21:27:52 kardel Exp $	*/
2 
3 
4 /*
5  * \file sort.c
6  *
7  * Time-stamp:      "2010-07-17 10:34:15 bkorb"
8  *
9  *  This module implements argument sorting.
10  *
11  *  This file is part of AutoOpts, a companion to AutoGen.
12  *  AutoOpts is free software.
13  *  AutoOpts is Copyright (c) 1992-2011 by Bruce Korb - all rights reserved
14  *
15  *  AutoOpts is available under any one of two licenses.  The license
16  *  in use must be one of these two and the choice is under the control
17  *  of the user of the license.
18  *
19  *   The GNU Lesser General Public License, version 3 or later
20  *      See the files "COPYING.lgplv3" and "COPYING.gplv3"
21  *
22  *   The Modified Berkeley Software Distribution License
23  *      See the file "COPYING.mbsd"
24  *
25  *  These files have the following md5sums:
26  *
27  *  43b91e8ca915626ed3818ffb1b71248b pkg/libopts/COPYING.gplv3
28  *  06a1a2e4760c90ea5e1dad8dfaac4d39 pkg/libopts/COPYING.lgplv3
29  *  66a5cedaf62c4b2637025f049f9b826f pkg/libopts/COPYING.mbsd
30  */
31 
32 /* = = = START-STATIC-FORWARD = = = */
33 static tSuccess
34 mustHandleArg(tOptions* pOpts, char* pzArg, tOptState* pOS,
35               char** ppzOpts, int* pOptsIdx);
36 
37 static tSuccess
38 mayHandleArg(tOptions* pOpts, char* pzArg, tOptState* pOS,
39              char** ppzOpts, int* pOptsIdx);
40 
41 static tSuccess
42 checkShortOpts(tOptions* pOpts, char* pzArg, tOptState* pOS,
43                char** ppzOpts, int* pOptsIdx);
44 /* = = = END-STATIC-FORWARD = = = */
45 
46 /*
47  *  "mustHandleArg" and "mayHandleArg" are really similar.  The biggest
48  *  difference is that "may" will consume the next argument only if it
49  *  does not start with a hyphen and "must" will consume it, hyphen or not.
50  */
51 static tSuccess
52 mustHandleArg(tOptions* pOpts, char* pzArg, tOptState* pOS,
53               char** ppzOpts, int* pOptsIdx)
54 {
55     /*
56      *  An option argument is required.  Long options can either have
57      *  a separate command line argument, or an argument attached by
58      *  the '=' character.  Figure out which.
59      */
60     switch (pOS->optType) {
61     case TOPT_SHORT:
62         /*
63          *  See if an arg string follows the flag character.  If not,
64          *  the next arg must be the option argument.
65          */
66         if (*pzArg != NUL)
67             return SUCCESS;
68         break;
69 
70     case TOPT_LONG:
71         /*
72          *  See if an arg string has already been assigned (glued on
73          *  with an `=' character).  If not, the next is the opt arg.
74          */
75         if (pOS->pzOptArg != NULL)
76             return SUCCESS;
77         break;
78 
79     default:
80         return FAILURE;
81     }
82     if (pOpts->curOptIdx >= pOpts->origArgCt)
83         return FAILURE;
84 
85     ppzOpts[ (*pOptsIdx)++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
86     return SUCCESS;
87 }
88 
89 static tSuccess
90 mayHandleArg(tOptions* pOpts, char* pzArg, tOptState* pOS,
91              char** ppzOpts, int* pOptsIdx)
92 {
93     /*
94      *  An option argument is optional.
95      */
96     switch (pOS->optType) {
97     case TOPT_SHORT:
98         /*
99          *  IF nothing is glued on after the current flag character,
100          *  THEN see if there is another argument.  If so and if it
101          *  does *NOT* start with a hyphen, then it is the option arg.
102          */
103         if (*pzArg != NUL)
104             return SUCCESS;
105         break;
106 
107     case TOPT_LONG:
108         /*
109          *  Look for an argument if we don't already have one (glued on
110          *  with a `=' character)
111          */
112         if (pOS->pzOptArg != NULL)
113             return SUCCESS;
114         break;
115 
116     default:
117         return FAILURE;
118     }
119     if (pOpts->curOptIdx >= pOpts->origArgCt)
120         return PROBLEM;
121 
122     pzArg = pOpts->origArgVect[ pOpts->curOptIdx ];
123     if (*pzArg != '-')
124         ppzOpts[ (*pOptsIdx)++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
125     return SUCCESS;
126 }
127 
128 /*
129  *  Process a string of short options glued together.  If the last one
130  *  does or may take an argument, the do the argument processing and leave.
131  */
132 static tSuccess
133 checkShortOpts(tOptions* pOpts, char* pzArg, tOptState* pOS,
134                char** ppzOpts, int* pOptsIdx)
135 {
136     while (*pzArg != NUL) {
137         if (FAILED(shortOptionFind(pOpts, (tAoUC)*pzArg, pOS)))
138             return FAILURE;
139 
140         /*
141          *  See if we can have an arg.
142          */
143         if (OPTST_GET_ARGTYPE(pOS->pOD->fOptState) == OPARG_TYPE_NONE) {
144             pzArg++;
145 
146         } else if (pOS->pOD->fOptState & OPTST_ARG_OPTIONAL) {
147             /*
148              *  Take an argument if it is not attached and it does not
149              *  start with a hyphen.
150              */
151             if (pzArg[1] != NUL)
152                 return SUCCESS;
153 
154             pzArg = pOpts->origArgVect[ pOpts->curOptIdx ];
155             if (*pzArg != '-')
156                 ppzOpts[ (*pOptsIdx)++ ] =
157                     pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
158             return SUCCESS;
159 
160         } else {
161             /*
162              *  IF we need another argument, be sure it is there and
163              *  take it.
164              */
165             if (pzArg[1] == NUL) {
166                 if (pOpts->curOptIdx >= pOpts->origArgCt)
167                     return FAILURE;
168                 ppzOpts[ (*pOptsIdx)++ ] =
169                     pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
170             }
171             return SUCCESS;
172         }
173     }
174     return SUCCESS;
175 }
176 
177 /*
178  *  If the program wants sorted options (separated operands and options),
179  *  then this routine will to the trick.
180  */
181 LOCAL void
182 optionSort(tOptions* pOpts)
183 {
184     char** ppzOpts;
185     char** ppzOpds;
186     int    optsIdx = 0;
187     int    opdsIdx = 0;
188 
189     tOptState os = OPTSTATE_INITIALIZER(DEFINED);
190 
191     /*
192      *  Disable for POSIX conformance, or if there are no operands.
193      */
194     if (  (getenv("POSIXLY_CORRECT") != NULL)
195        || NAMED_OPTS(pOpts))
196         return;
197 
198     /*
199      *  Make sure we can allocate two full-sized arg vectors.
200      */
201     ppzOpts = malloc(pOpts->origArgCt * sizeof(char*));
202     if (ppzOpts == NULL)
203         goto exit_no_mem;
204 
205     ppzOpds = malloc(pOpts->origArgCt * sizeof(char*));
206     if (ppzOpds == NULL) {
207         free(ppzOpts);
208         goto exit_no_mem;
209     }
210 
211     pOpts->curOptIdx = 1;
212     pOpts->pzCurOpt  = NULL;
213 
214     /*
215      *  Now, process all the options from our current position onward.
216      *  (This allows interspersed options and arguments for the few
217      *  non-standard programs that require it.)
218      */
219     for (;;) {
220         char* pzArg;
221         tSuccess res;
222 
223         /*
224          *  If we're out of arguments, we're done.  Join the option and
225          *  operand lists into the original argument vector.
226          */
227         if (pOpts->curOptIdx >= pOpts->origArgCt) {
228             errno = 0;
229             goto joinLists;
230         }
231 
232         pzArg = pOpts->origArgVect[ pOpts->curOptIdx ];
233         if (*pzArg != '-') {
234             ppzOpds[ opdsIdx++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
235             continue;
236         }
237 
238         switch (pzArg[1]) {
239         case NUL:
240             /*
241              *  A single hyphen is an operand.
242              */
243             ppzOpds[ opdsIdx++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
244             continue;
245 
246         case '-':
247             /*
248              *  Two consecutive hypens.  Put them on the options list and then
249              *  _always_ force the remainder of the arguments to be operands.
250              */
251             if (pzArg[2] == NUL) {
252                 ppzOpts[ optsIdx++ ] =
253                     pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
254                 goto restOperands;
255             }
256             res = longOptionFind(pOpts, pzArg+2, &os);
257             break;
258 
259         default:
260             /*
261              *  If short options are not allowed, then do long
262              *  option processing.  Otherwise the character must be a
263              *  short (i.e. single character) option.
264              */
265             if ((pOpts->fOptSet & OPTPROC_SHORTOPT) == 0) {
266                 res = longOptionFind(pOpts, pzArg+1, &os);
267             } else {
268                 res = shortOptionFind(pOpts, (tAoUC)pzArg[1], &os);
269             }
270             break;
271         }
272         if (FAILED(res)) {
273             errno = EINVAL;
274             goto freeTemps;
275         }
276 
277         /*
278          *  We've found an option.  Add the argument to the option list.
279          *  Next, we have to see if we need to pull another argument to be
280          *  used as the option argument.
281          */
282         ppzOpts[ optsIdx++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
283 
284         if (OPTST_GET_ARGTYPE(os.pOD->fOptState) == OPARG_TYPE_NONE) {
285             /*
286              *  No option argument.  If we have a short option here,
287              *  then scan for short options until we get to the end
288              *  of the argument string.
289              */
290             if (  (os.optType == TOPT_SHORT)
291                && FAILED(checkShortOpts(pOpts, pzArg+2, &os, ppzOpts,
292                                         &optsIdx)) )  {
293                 errno = EINVAL;
294                 goto freeTemps;
295             }
296 
297         } else if (os.pOD->fOptState & OPTST_ARG_OPTIONAL) {
298             switch (mayHandleArg(pOpts, pzArg+2, &os, ppzOpts, &optsIdx)) {
299             case FAILURE: errno = EIO; goto freeTemps;
300             case PROBLEM: errno = 0;   goto joinLists;
301             }
302 
303         } else {
304             switch (mustHandleArg(pOpts, pzArg+2, &os, ppzOpts, &optsIdx)) {
305             case PROBLEM:
306             case FAILURE: errno = EIO; goto freeTemps;
307             }
308         }
309     } /* for (;;) */
310 
311  restOperands:
312     while (pOpts->curOptIdx < pOpts->origArgCt)
313         ppzOpds[ opdsIdx++ ] = pOpts->origArgVect[ (pOpts->curOptIdx)++ ];
314 
315  joinLists:
316     if (optsIdx > 0)
317         memcpy(pOpts->origArgVect + 1, ppzOpts, optsIdx * sizeof(char*));
318     if (opdsIdx > 0)
319         memcpy(pOpts->origArgVect + 1 + optsIdx, ppzOpds,
320                opdsIdx * sizeof(char*));
321 
322  freeTemps:
323     free(ppzOpts);
324     free(ppzOpds);
325     return;
326 
327  exit_no_mem:
328     errno = ENOMEM;
329     return;
330 }
331 
332 /*
333  * Local Variables:
334  * mode: C
335  * c-file-style: "stroustrup"
336  * indent-tabs-mode: nil
337  * End:
338  * end of autoopts/sort.c */
339