xref: /titanic_52/usr/src/man/man3c/getsubopt.3c (revision 88b44bf4e73233af70877930178dbff7f1c2992b)
te
Copyright (c) 1989 AT&T.
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
GETSUBOPT 3C "Sep 29, 2005"
NAME
getsubopt - parse suboption arguments from a string
SYNOPSIS

#include <stdlib.h>

int getsubopt(char **optionp, char * const *keylistp, char **valuep);
DESCRIPTION

The getsubopt() function parses suboption arguments in a flag argument. Such options often result from the use of getopt(3C).

The getsubopt() argument optionp is a pointer to a pointer to the option argument string. The suboption arguments are separated by commas and each can consist of either a single token or a token-value pair separated by an equal sign.

The keylistp argument is a pointer to a vector of strings. The end of the vector is identified by a null pointer. Each entry in the vector is one of the possible tokens that might be found in *optionp. Since commas delimit suboption arguments in optionp, they should not appear in any of the strings pointed to by keylistp. Similarly, because an equal sign separates a token from its value, the application should not include an equal sign in any of the strings pointed to by keylistp.

The valuep argument is the address of a value string pointer.

If a comma appears in optionp, it is interpreted as a suboption separator. After commas have been processed, if there are one or more equal signs in a suboption string, the first equal sign in any suboption string is interpreted as a separator between a token and a value. Subsequent equal signs in a suboption string are interpreted as part of the value.

If the string at *optionp contains only one suboption argument (equivalently, no commas), getsubopt() updates *optionp to point to the null character at the end of the string. Otherwise, it isolates the suboption argument by replacing the comma separator with a null character and updates *optionp to point to the start of the next suboption argument. If the suboption argument has an associated value (equivalently, contains an equal sign), getsubopt() updates *valuep to point to the value's first character. Otherwise, it sets *valuep to a null pointer. The calling application can use this information to determine whether the presence or absence of a value for the suboption is an error.

Additionally, when getsubopt() fails to match the suboption with a token in the keylistp array, the calling application should decide if this is an error or if the unrecognized option should be processed in another way.

RETURN VALUES

The getsubopt() function returns the index of the matched token string or -1 if no token strings were matched.

ERRORS

No errors are defined.

EXAMPLES

Example 1 Use getsubopt() to process options.

The following example demonstrates the processing of options to the mount(1M) utility using getsubopt().

#include <stdlib.h>

char *myopts[] = {
#define READONLY 0
 "ro",
#define READWRITE 1
 "rw",
#define WRITESIZE 2
 "wsize",
#define READSIZE 3
 "rsize",
 NULL};

main(argc, argv)
 int argc;
 char **argv;
{
 int sc, c, errflag;
 char *options, *value;
 extern char *optarg;
 extern int optind;
 .
 .
 .
 while((c = getopt(argc, argv, "abf:o:")) != -1) {
 switch (c) {
 case 'a': /* process a option */
 break;
 case 'b': /* process b option */
 break;
 case 'f':
 ofile = optarg;
 break;
 case '?':
 errflag++;
 break;
 case 'o':
 options = optarg;
 while (*options != '\e0') {
 switch(getsubopt(&options,myopts,&value)){
 case READONLY : /* process ro option */
 break;
 case READWRITE : /* process rw option */
 break;
 case WRITESIZE : /* process wsize option */
 if (value == NULL) {
 error_no_arg();
 errflag++;
 } else
 write_size = atoi(value);
 break;
 case READSIZE : /* process rsize option */
 if (value == NULL) {
 error_no_arg();
 errflag++;
 } else
 read_size = atoi(value);
 break;
 default :
 /* process unknown token */
 error_bad_token(value);
 errflag++;
 break;
 }
 }
 break;
 }
 }
 if (errflag) {
 /* print usage instructions etc. */
 }
 for (; optind<argc; optind++) {
 /* process remaining arguments */
 }
 .
 .
 .
}

Example 2 Parse suboptions.

The following example uses the getsubopt() function to parse a value argument in the optarg external variable returned by a call to getopt(3C).

#include <stdlib.h>
...
char *tokens[] = {"HOME", "PATH", "LOGNAME", (char *) NULL };
char *value;
int opt, index;
while ((opt = getopt(argc, argv, "e:")) != -1) {
 switch(opt) {
 case 'e' :
 while ((index = getsubopt(&optarg, tokens, &value)) != -1) {
 switch(index) {
...
 }
 break;
...
 }
}
ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

mount(1M), getopt(3C), attributes(5), standards(5)