cmdparse.c revision fcf3ce441efd61da9bb2884968af01cb7c1452cc
/*
* CDDL HEADER START
*
* 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
* 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]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <libintl.h>
#include <errno.h>
#include <string.h>
#include <assert.h>
#include <getopt.h>
#include "cmdparse.h"
/* Usage types */
#define GENERAL_USAGE 1
#define HELP_USAGE 2
#define DETAIL_USAGE 3
/* printable ascii character set len */
/*
* MAXOPTIONSTRING is the max length of the options string used in getopt and
* will be the printable character set + ':' for each character,
* providing for options with arguments. e.g. "t:Cs:hglr:"
*/
/* standard command options table to support -?, -V */
struct option standardCmdOptions[] = {
};
/* standard subcommand options table to support -? */
struct option standardSubCmdOptions[] = {
};
/* forward declarations */
static int getSubcommand(char *, subcommand_t **);
static char *getExecBasename(char *);
static char *getLongOption(int);
static char *getOptionArgDesc(int);
extern void seeMan(void);
/* global data */
static struct option *_longOptions;
static subcommand_t *_subcommands;
static objectRules_t *_objectRules;
static optionRules_t *_optionRules;
static optionTbl_t *_clientOptionTbl;
static char *commandName;
/*
* input:
* object - object value
* output:
* opCmd - pointer to opCmd_t structure allocated by caller
*
* On successful return, opCmd contains the rules for the value in
* object. On failure, the contents of opCmd is unspecified.
*
* Returns:
* zero on success
* non-zero on failure
*
*/
static int
{
*objectRules = sp;
return (0);
}
}
return (1);
}
/*
* input:
* arg - pointer to array of char containing object string
*
* output:
* object - pointer to object_t structure pointer
* on success, contains the matching object structure based on
* input object name
*
* Returns:
* zero on success
* non-zero otherwise
*
*/
static int
{
int len;
return (0);
}
}
return (1);
}
/*
* input:
* arg - pointer to array of char containing subcommand string
* output:
* subcommand - pointer to subcommand_t pointer
* on success, contains the matching subcommand structure based on
* input subcommand name
*
* Returns:
* zero on success
* non-zero on failure
*/
static int
{
int len;
*subcommand = sp;
return (0);
}
}
return (1);
}
/*
* input:
* object - object for which to get options
* subcommand - subcommand for which to get options
*
* Returns:
* on success, optionsProp_t pointer to structure matching input object
* value
* on failure, NULL is returned
*/
static optionProp_t *
{
if ((currObject == object) &&
return (&(op->optionProp));
}
op++;
}
return (NULL);
}
/*
* input:
* shortOption - short option character for which to return the
* associated long option string
*
* Returns:
* on success, long option name
* on failure, NULL
*/
static char *
getLongOption(int shortOption)
{
}
}
return (NULL);
}
/*
* input
* shortOption - short option character for which to return the
* option argument
* Returns:
* on success, argument string
* on failure, NULL
*/
static char *
{
}
}
return (NULL);
}
/*
* Print usage for a subcommand.
*
* input:
* usage type - GENERAL_USAGE, HELP_USAGE, DETAIL_USAGE
* subcommand - pointer to subcommand_t structure
*
* Returns:
* none
*
*/
static void
{
int i;
for (i = 0; standardSubCmdOptions[i].name; i++) {
standardSubCmdOptions[i].val);
}
for (i = 0; standardSubCmdOptions[i].name; i++) {
standardSubCmdOptions[i].val);
}
if (usageType == GENERAL_USAGE) {
return;
}
/*
* iterate through object table
* For each object, print appropriate usage
* based on rules tables
*/
}
}
/*
* Print usage for a subcommand and object.
*
* input:
* usage type - GENERAL_USAGE, HELP_USAGE, DETAIL_USAGE
* subcommand - pointer to subcommand_t structure
* objp - pointer to a object_t structure
*
* Returns:
* none
*
*/
static void
{
int i;
char *optionArgDesc;
char *longOpt;
/*
* internal subcommand rules table error
* no object entry in object
*/
assert(0);
}
return;
}
/* print generic subcommand usage */
/* print object */
/* print options if applicable */
} else {
}
} else {
}
}
/* print operand requirements */
}
if (objRules->operandDefinition) {
} else {
/*
* Missing operand description
* from table
*/
assert(0);
}
}
}
}
}
if (usageType == HELP_USAGE) {
return;
}
/* print options for subcommand, object */
if ((longOpt = getLongOption(
options->optionString[i]))
== NULL) {
/* no long option exists for short option */
assert(0);
}
if (optionArgDesc != NULL) {
}
options->optionString[i])) {
gettext("exclusive"));
}
}
}
}
/*
* input:
* type of usage statement to print
*
* Returns:
* return value of subUsage
*/
static void
{
int i;
/* print general command usage */
for (i = 0; standardCmdOptions[i].name; i++) {
standardCmdOptions[i].val);
}
for (i = 0; standardCmdOptions[i].name; i++) {
}
}
/* print all subcommand usage */
if (usageType == HELP_USAGE) {
}
}
}
/*
* input:
* execFullName - exec name of program (argv[0])
*
* Returns:
* command name portion of execFullName
*/
static char *
getExecBasename(char *execFullname)
{
char *lastSlash, *execBasename;
/* guard against '/' at end of command invocation */
for (;;) {
break;
} else {
if (*execBasename == '\0') {
*lastSlash = '\0';
continue;
}
break;
}
}
return (execBasename);
}
/*
* cmdParse is a parser that checks syntax of the input command against
* various rules tables.
*
* It provides usage feedback based upon the passed rules tables by calling
* two usage functions, usage, subUsage, and subUsageObject handling command,
* subcommand and object usage respectively.
*
* When syntax is successfully validated, the associated function is called
* using the subcommands table functions.
*
* Syntax is as follows:
* command subcommand object [<options>] [<operand>]
*
* There are two standard short and long options assumed:
* -?, --help Provides usage on a command or subcommand
* and stops further processing of the arguments
*
* -V, --version Provides version information on the command
* and stops further processing of the arguments
*
* These options are loaded by this function.
*
* input:
* argc, argv from main
* syntax rules tables (synTables_t structure)
* callArgs - void * passed by caller to be passed to subcommand function
*
* output:
* funcRet - pointer to int that holds subcommand function return value
*
* Returns:
*
* zero on successful syntax parse and function call
*
* 1 on unsuccessful syntax parse (no function has been called)
* This could be due to a version or help call or simply a
* general usage call.
*
* -1 check errno, call failed
*
* This module is not MT-safe.
*
*/
int
int *funcRet)
{
int getoptargc;
char **getoptargv;
int opt;
int operInd;
int i, j;
int len;
char *versionString;
/*
* Check for NULLs on mandatory input arguments
*
* Note: longOptionTbl and optionRulesTbl can be NULL in the case
* where there is no caller defined options
*
*/
assert(0);
}
/* set global command name */
/* Set unbuffered output */
/* load globals */
/* There must be at least two arguments */
if (argc < 2) {
return (1);
}
/*
* load standard subcommand options to internal long options table
* Two separate getopt_long(3C) tables are used.
*/
for (i = 0; standardSubCmdOptions[i].name; i++) {
}
/*
* copy caller's long options into internal long options table
* We do this for two reasons:
* 1) We need to use the getopt_long option structure internally
* 2) We need to prepend the table with the standard option
* for all subcommands (currently -?)
*/
if (i > MAXOPTIONS - 1) {
/* option table too long */
assert(0);
}
}
/* set option table global */
_longOptions = &intLongOpt[0];
/*
* '+' in option string ensures POSIX compliance in getopt_long()
* which means that processing will stop at first non-option
* argument.
*/
switch (opt) {
case '?':
/*
* getopt can return a '?' when no
* option letters match string. Check for
* the 'real' '?' in optopt.
*/
if (optopt == '?') {
return (0);
} else {
return (0);
}
case 'V':
return (0);
default:
break;
}
}
/*
* subcommand is always in the second argument. If there is no
* recognized subcommand in the second argument, print error,
* general usage and then return.
*/
return (1);
}
if (argc == 2) {
return (1);
}
getoptargv = argv;
getoptargv++;
getoptargc = argc;
getoptargc -= 1;
switch (opt) {
case '?':
/*
* getopt can return a '?' when no
* option letters match string. Check for
* the 'real' '?' in optopt.
*/
if (optopt == '?') {
return (0);
} else {
return (0);
}
default:
break;
}
}
/*
* object is always in the third argument. If there is no
* recognized object in the third argument, print error,
* help usage for the subcommand and then return.
*/
return (1);
}
/*
* internal subcommand rules table error
* no object entry in object table
*/
assert(0);
}
/*
* Is command valid for this object?
*/
return (1);
}
/*
* offset getopt arg begin since
* getopt(3C) assumes options
* follow first argument
*/
getoptargv = argv;
getoptargv++;
getoptargv++;
getoptargc = argc;
getoptargc -= 2;
j = 0;
/*
* Build optionStringAll from long options table
*/
/* sanity check on string length */
if (j + 1 >= sizeof (optionStringAll)) {
/* option table too long */
assert(0);
}
optionStringAll[++j] = ':';
}
}
i = 0;
/*
* Run getopt for all arguments against all possible options
* later.
* Once all options are retrieved, check against object
* and subcommand (option rules table) for validity.
* This is done later.
*/
switch (opt) {
case '?':
if (optopt == '?') {
subcommand, object);
return (0);
} else {
return (0);
}
default:
if (optarg) {
- 1) {
"%s: %s\n",
gettext("option too long"));
return (-1);
}
}
i++;
break;
}
}
/*
* increment past last option
*/
/*
* Check validity of given options, if any were given
*/
/* get option string for this object and subcommand */
return (1);
}
for (i = 0; cmdOptions[i].optval; i++) {
/* Check for invalid options */
/*
* internal option table error
* There must be an option string if
* there is an entry in the table
*/
assert(0);
}
/* is the option in the available option string? */
cmdOptions[i].optval))) {
"%s: '-%c': %s\n",
gettext("invalid option"));
object);
return (1);
/* Check for exclusive options */
cmdOptions[i].optval)) {
"%s: '-%c': %s\n",
gettext("is an exclusive option"));
object);
return (1);
}
}
} else { /* no options were input */
if (availOptions != NULL &&
(availOptions->required)) {
gettext("at least one option required"));
object);
return (1);
}
}
/*
* If there are no more arguments (operands),
* check to see if this is okay
*/
return (1);
}
/*
* If there are more operands,
* check to see if this is okay
*/
return (1);
}
/*
* If there is more than one more operand,
* check to see if this is okay
*/
gettext("accepts only a single operand"));
return (1);
}
/* Finished syntax checks */
/* Call appropriate function */
}