lib/libc/stdlib/getsubopt.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd December 25, 2011
  29 .Dt GETSUBOPT 3
  30 .Os
  31 .Sh NAME
  32 .Nm getsubopt
  33 .Nd get sub options from an argument
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In stdlib.h
  38 .Vt extern char *suboptarg ;
  39 .Ft int
  40 .Fn getsubopt "char **optionp" "char * const *tokens" "char **valuep"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn getsubopt
  44 function
  45 parses a string containing tokens delimited by one or more tab, space or
  46 comma
  47 .Pq Ql \&,
  48 characters.
  49 It is intended for use in parsing groups of option arguments provided
  50 as part of a utility command line.
  51 .Pp
  52 The argument
  53 .Fa optionp
  54 is a pointer to a pointer to the string.
  55 The argument
  56 .Fa tokens
  57 is a pointer to a
  58 .Dv NULL Ns -terminated
  59 array of pointers to strings.
  60 .Pp
  61 The
  62 .Fn getsubopt
  63 function
  64 returns the zero-based offset of the pointer in the
  65 .Fa tokens
  66 array referencing a string which matches the first token
  67 in the string, or, \-1 if the string contains no tokens or
  68 .Fa tokens
  69 does not contain a matching string.
  70 .Pp
  71 If the token is of the form ``name=value'', the location referenced by
  72 .Fa valuep
  73 will be set to point to the start of the ``value'' portion of the token.
  74 .Pp
  75 On return from
  76 .Fn getsubopt ,
  77 .Fa optionp
  78 will be set to point to the start of the next token in the string,
  79 or the null at the end of the string if no more tokens are present.
  80 The external variable
  81 .Fa suboptarg
  82 will be set to point to the start of the current token, or
  83 .Dv NULL
  84 if no
  85 tokens were present.
  86 The argument
  87 .Fa valuep
  88 will be set to point to the ``value'' portion of the token, or
  89 .Dv NULL
  90 if no ``value'' portion was present.
  91 .Sh EXAMPLES
  92 .Bd -literal -compact
  93 char *tokens[] = {
  94         #define ONE     0
  95                 "one",
  96         #define TWO     1
  97                 "two",
  98         NULL
  99 };
 100
 101 \&...
 102
 103 extern char *optarg, *suboptarg;
 104 char *options, *value;
 105
 106 while ((ch = getopt(argc, argv, "ab:")) != \-1) {
 107         switch(ch) {
 108         case 'a':
 109                 /* process ``a'' option */
 110                 break;
 111         case 'b':
 112                 options = optarg;
 113                 while (*options) {
 114                         switch(getsubopt(&options, tokens, &value)) {
 115                         case ONE:
 116                                 /* process ``one'' sub option */
 117                                 break;
 118                         case TWO:
 119                                 /* process ``two'' sub option */
 120                                 if (!value)
 121                                         error("no value for two");
 122                                 i = atoi(value);
 123                                 break;
 124                         case \-1:
 125                                 if (suboptarg)
 126                                         error("illegal sub option %s",
 127                                           suboptarg);
 128                                 else
 129                                         error("missing sub option");
 130                                 break;
 131                         }
 132                 }
 133                 break;
 134         }
 135 }
 136 .Ed
 137 .Sh SEE ALSO
 138 .Xr getopt 3 ,
 139 .Xr strsep 3
 140 .Sh HISTORY
 141 The
 142 .Fn getsubopt
 143 function first appeared in
 144 .Bx 4.4 .