popt/popt.h

ソースコードを見る。

データ構造
struct	poptOption
struct	poptAlias
	A popt alias argument for poptAddAlias(). [詳細]
struct	poptItem_s
	A popt alias or exec argument for poptAddItem(). [詳細]
Auto-generated help/usage
poptOption	poptAliasOptions []
	Empty table marker to enable displaying popt alias/exec options.
poptOption	poptHelpOptions []
	Auto help table options.
型定義
typedef poptItem_s *	poptItem
	A popt alias or exec argument for poptAddItem().
typedef poptContext_s *	poptContext
typedef poptOption *	poptOption
typedef void(*)	poptCallbackType (poptContext con, enum poptCallbackReason reason, const struct poptOption *opt, const char *arg, const void *data)
	Table callback prototype.
列挙型
enum	poptCallbackReason { POPT_CALLBACK_REASON_PRE = 0, POPT_CALLBACK_REASON_POST = 1, POPT_CALLBACK_REASON_OPTION = 2 }
関数
poptContext	poptGetContext (const char *name, int argc, const char **argv, const struct poptOption *options, int flags)
	Initialize popt context.
void	poptResetContext (poptContext con)
	Reinitialize popt context.
int	poptGetNextOpt (poptContext con)
	Return value of next option found.
const char *	poptGetOptArg (poptContext con)
	Return next option argument (if any).
const char *	poptGetArg (poptContext con)
	Return next argument.
const char *	poptPeekArg (poptContext con)
	Peek at current argument.
const char **	poptGetArgs (poptContext con)
	Return remaining arguments.
const char *	poptBadOption (poptContext con, int flags)
	Return the option which caused the most recent error.
poptContext	poptFreeContext (poptContext con)
	Destroy context.
int	poptStuffArgs (poptContext con, const char **argv)
	Add arguments to context.
int	poptAddAlias (poptContext con, struct poptAlias alias, int flags)
	Add alias to context.
int	poptAddItem (poptContext con, poptItem newItem, int flags)
	Add alias/exec item to context.
int	poptReadConfigFile (poptContext con, const char *fn)
	Read configuration file.
int	poptReadDefaultConfig (poptContext con, int useEnv)
	Read default configuration from /etc/popt and $HOME/.popt.
int	poptDupArgv (int argc, const char **argv, int *argcPtr, const char ***argvPtr)
	Duplicate an argument array.
int	poptParseArgvString (const char *s, int *argcPtr, const char ***argvPtr)
	Parse a string into an argument array.
int	poptConfigFileToString (FILE *fp, char **argstrp, int flags)
	Parses an input configuration file and returns an string that is a command line.
const char *	poptStrerror (const int error)
	Return formatted error string for popt failure.
void	poptSetExecPath (poptContext con, const char *path, int allowAbsolute)
	Limit search for executables.
void	poptPrintHelp (poptContext con, FILE *fp, int flags)
	Print detailed description of options.
void	poptPrintUsage (poptContext con, FILE *fp, int flags)
	Print terse description of options.
void	poptSetOtherOptionHelp (poptContext con, const char *text)
	Provide text to replace default "[OPTION...]" in help/usage output.
const char *	poptGetInvocationName (poptContext con)
	Return argv[0] from context.
int	poptStrippedArgv (poptContext con, int argc, char **argv)
	Shuffle argv pointers to remove stripped args, returns new argc.
int	poptSaveLong (long *arg, int argInfo, long aLong)
	Save a long, performing logical operation with value.
int	poptSaveInt (int *arg, int argInfo, long aLong)
	Save an integer, performing logical operation with value.

---

説明

popt.h で定義されています。

---

型定義

typedef struct poptItem_s * poptItem

A popt alias or exec argument for poptAddItem().

typedef struct poptContext_s* poptContext

popt.h の 185 行で定義されています。

typedef struct poptOption* poptOption

popt.h の 192 行で定義されています。

typedef void(*) poptCallbackType(poptContext con, enum poptCallbackReason reason,const struct poptOption *opt,const char *arg,const void *data)

Table callback prototype.

引数:

	con	context
	reason	reason for callback
	opt	option that triggered callback
	arg\xrefitem	todo 17
	data\xrefitem	todo 18

popt.h の 217 行で定義されています。

---

列挙型

enum poptCallbackReason

列挙型の値:

POPT_CALLBACK_REASON_PRE
POPT_CALLBACK_REASON_POST
POPT_CALLBACK_REASON_OPTION

popt.h の 197 行で定義されています。

           {

---

関数

poptContext poptGetContext	(	const char *	name,
		int	argc,
		const char **	argv,
		const struct poptOption *	options,
		int	flags
	)

Initialize popt context.

引数:

	name	context name (usually argv[0] program name)
	argc	no. of arguments
	argv	argument array
	options	address of popt option table
	flags	or'd POPT_CONTEXT_* bits

戻り値:

initialized popt context

popt.c の 154 行で定義されています。

参照先 invokeCallbacksPRE()・options・t.

参照元 main()・parse_quota_set()・rpc_reg_shutdown_internals().

{
    poptContext con = (poptContext)malloc(sizeof(*con));

    if (con == NULL) return NULL;       /* XXX can't happen */
    memset(con, 0, sizeof(*con));

    con->os = con->optionStack;
    con->os->argc = argc;
    /*@-dependenttrans -assignexpose@*/ /* FIX: W2DO? */
    con->os->argv = argv;
    /*@=dependenttrans =assignexpose@*/
    con->os->argb = NULL;

    if (!(flags & POPT_CONTEXT_KEEP_FIRST))
        con->os->next = 1;                      /* skip argv[0] */

    con->leftovers = (const char **)calloc( (argc + 1),
                                            sizeof(*con->leftovers) );
    /*@-dependenttrans -assignexpose@*/ /* FIX: W2DO? */
    con->options = options;
    /*@=dependenttrans =assignexpose@*/
    con->aliases = NULL;
    con->numAliases = 0;
    con->flags = flags;
    con->execs = NULL;
    con->numExecs = 0;
    con->finalArgvAlloced = argc * 2;
    con->finalArgv = (const char **)calloc( con->finalArgvAlloced,
                                            sizeof(*con->finalArgv) );
    con->execAbsolute = 1;
    con->arg_strip = NULL;

    if (getenv("POSIXLY_CORRECT") || getenv("POSIX_ME_HARDER"))
        con->flags |= POPT_CONTEXT_POSIXMEHARDER;

    if (name) {
        char * t = (char *)malloc(strlen(name) + 1);
        if (t) con->appName = strcpy(t, name);
    }

    /*@-internalglobs@*/
    invokeCallbacksPRE(con, con->options);
    /*@=internalglobs@*/

    return con;
}

void poptResetContext

(

poptContext

con

)

Reinitialize popt context.

引数:

con

context

popt.c の 214 行で定義されています。

参照先 _free()・poptContext_s::arg_strip・optionStackEntry::argb・cleanOSE()・optionStackEntry::currAlias・poptContext_s::doExec・poptContext_s::finalArgv・poptContext_s::finalArgvCount・optionStackEntry::next・optionStackEntry::nextArg・optionStackEntry::nextCharArg・poptContext_s::nextLeftover・poptContext_s::numLeftovers・poptContext_s::optionStack・poptContext_s::os・poptContext_s::restLeftover.

参照元 poptFreeContext().

{
    int i;

    if (con == NULL) return;
    while (con->os > con->optionStack) {
        cleanOSE(con->os--);
    }
    con->os->argb = (pbm_set *)PBM_FREE(con->os->argb);
    con->os->currAlias = NULL;
    con->os->nextCharArg = NULL;
    con->os->nextArg = NULL;
    con->os->next = 1;                  /* skip argv[0] */

    con->numLeftovers = 0;
    con->nextLeftover = 0;
    con->restLeftover = 0;
    con->doExec = NULL;

    if (con->finalArgv != NULL)
    for (i = 0; i < con->finalArgvCount; i++) {
        /*@-unqualifiedtrans@*/         /* FIX: typedef double indirection. */
        con->finalArgv[i] = (const char *)_free(con->finalArgv[i]);
        /*@=unqualifiedtrans@*/
    }

    con->finalArgvCount = 0;
    con->arg_strip = ( pbm_set *)PBM_FREE(con->arg_strip);
    /*@-nullstate@*/    /* FIX: con->finalArgv != NULL */
    return;
    /*@=nullstate@*/
}

int poptGetNextOpt

(

poptContext

con

)

Return value of next option found.

引数:

con

context

戻り値:

next option val, -1 on last item, POPT_ERROR_* on error

popt.c の 691 行で定義されています。

参照先 _free()・alloca()・poptOption::arg・optionStackEntry::argb・optionStackEntry::argc・poptOption::argInfo・optionStackEntry::argv・cleanOSE()・poptContext_s::doExec・errno・execCommand()・expandNextArg()・poptContext_s::finalArgv・poptContext_s::finalArgvAlloced・poptContext_s::finalArgvCount・findOption()・poptContext_s::flags・fprintf()・handleAlias()・handleExec()・invokeCallbacksOPTION()・invokeCallbacksPOST()・poptContext_s::leftovers・poptOption::longName・optionStackEntry::next・optionStackEntry::nextArg・optionStackEntry::nextCharArg・poptContext_s::numLeftovers・poptContext_s::options・poptContext_s::optionStack・poptContext_s::os・poptSaveInt()・poptSaveLong()・poptStripArg()・poptContext_s::restLeftover・poptOption::shortName・sprintf()・poptOption::val・xstrdup().

参照元 main()・parse_quota_set()・rpc_reg_shutdown_internals().

{
    const struct poptOption * opt = NULL;
    int done = 0;

    if (con == NULL)
        return -1;
    while (!done) {
        const char * origOptString = NULL;
        poptCallbackType cb = NULL;
        const void * cbData = NULL;
        const char * longArg = NULL;
        int canstrip = 0;
        int shorty = 0;

        while (!con->os->nextCharArg && con->os->next == con->os->argc
                && con->os > con->optionStack) {
            cleanOSE(con->os--);
        }
        if (!con->os->nextCharArg && con->os->next == con->os->argc) {
            /*@-internalglobs@*/
            invokeCallbacksPOST(con, con->options);
            /*@=internalglobs@*/
            if (con->doExec) return execCommand(con);
            return -1;
        }

        /* Process next long option */
        if (!con->os->nextCharArg) {
            char * localOptString, * optString;
            int thisopt;

            /*@-sizeoftype@*/
            if (con->os->argb && PBM_ISSET(con->os->next, con->os->argb)) {
                con->os->next++;
                continue;
            }
            /*@=sizeoftype@*/
            thisopt = con->os->next;
            if (con->os->argv != NULL)  /* XXX can't happen */
            origOptString = con->os->argv[con->os->next++];

            if (origOptString == NULL)  /* XXX can't happen */
                return POPT_ERROR_BADOPT;

            if (con->restLeftover || *origOptString != '-') {
                if (con->flags & POPT_CONTEXT_POSIXMEHARDER)
                    con->restLeftover = 1;
                if (con->flags & POPT_CONTEXT_ARG_OPTS) {
                    con->os->nextArg = xstrdup(origOptString);
                    return 0;
                }
                if (con->leftovers != NULL)     /* XXX can't happen */
                    con->leftovers[con->numLeftovers++] = origOptString;
                continue;
            }

            /* Make a copy we can hack at */
            localOptString = optString =
                strcpy((char *)alloca(strlen(origOptString) + 1),
                       origOptString);

            if (optString[0] == '\0')
                return POPT_ERROR_BADOPT;

            if (optString[1] == '-' && !optString[2]) {
                con->restLeftover = 1;
                continue;
            } else {
                char *oe;
                int singleDash;

                optString++;
                if (*optString == '-')
                    singleDash = 0, optString++;
                else
                    singleDash = 1;

                /* XXX aliases with arg substitution need "--alias=arg" */
                if (handleAlias(con, optString, '\0', NULL))
                    continue;

                if (handleExec(con, optString, '\0'))
                    continue;

                /* Check for "--long=arg" option. */
                for (oe = optString; *oe && *oe != '='; oe++)
                    {};
                if (*oe == '=') {
                    *oe++ = '\0';
                    /* XXX longArg is mapped back to persistent storage. */
                    longArg = origOptString + (oe - localOptString);
                }

                opt = findOption(con->options, optString, '\0', &cb, &cbData,
                                 singleDash);
                if (!opt && !singleDash)
                    return POPT_ERROR_BADOPT;
            }

            if (!opt) {
                con->os->nextCharArg = origOptString + 1;
            } else {
                if (con->os == con->optionStack &&
                   opt->argInfo & POPT_ARGFLAG_STRIP)
                {
                    canstrip = 1;
                    poptStripArg(con, thisopt);
                }
                shorty = 0;
            }
        }

        /* Process next short option */
        /*@-branchstate@*/              /* FIX: W2DO? */
        if (con->os->nextCharArg) {
            origOptString = con->os->nextCharArg;

            con->os->nextCharArg = NULL;

            if (handleAlias(con, NULL, *origOptString, origOptString + 1))
                continue;

            if (handleExec(con, NULL, *origOptString)) {
                /* Restore rest of short options for further processing */
                origOptString++;
                if (*origOptString != '\0')
                    con->os->nextCharArg = origOptString;
                continue;
            }

            opt = findOption(con->options, NULL, *origOptString, &cb,
                             &cbData, 0);
            if (!opt)
                return POPT_ERROR_BADOPT;
            shorty = 1;

            origOptString++;
            if (*origOptString != '\0')
                con->os->nextCharArg = origOptString;
        }
        /*@=branchstate@*/

        if (opt == NULL) return POPT_ERROR_BADOPT;      /* XXX can't happen */
        if (opt->arg && (opt->argInfo & POPT_ARG_MASK) == POPT_ARG_NONE) {
            if (poptSaveInt((int *)opt->arg, opt->argInfo, 1L))
                return POPT_ERROR_BADOPERATION;
        } else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_VAL) {
            if (opt->arg) {
                if (poptSaveInt((int *)opt->arg, opt->argInfo, (long)opt->val))
                    return POPT_ERROR_BADOPERATION;
            }
        } else if ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE) {
            con->os->nextArg = (const char *)_free(con->os->nextArg);
            /*@-usedef@*/       /* FIX: W2DO? */
            if (longArg) {
            /*@=usedef@*/
                longArg = expandNextArg(con, longArg);
                con->os->nextArg = longArg;
            } else if (con->os->nextCharArg) {
                longArg = expandNextArg(con, con->os->nextCharArg);
                con->os->nextArg = longArg;
                con->os->nextCharArg = NULL;
            } else {
                while (con->os->next == con->os->argc &&
                       con->os > con->optionStack) {
                    cleanOSE(con->os--);
                }
                if (con->os->next == con->os->argc) {
                    if (!(opt->argInfo & POPT_ARGFLAG_OPTIONAL))
                        /*@-compdef@*/  /* FIX: con->os->argv not defined */
                        return POPT_ERROR_NOARG;
                        /*@=compdef@*/
                    con->os->nextArg = NULL;
                } else {

                    /*
                     * Make sure this isn't part of a short arg or the
                     * result of an alias expansion.
                     */
                    if (con->os == con->optionStack &&
                        (opt->argInfo & POPT_ARGFLAG_STRIP) &&
                        canstrip) {
                        poptStripArg(con, con->os->next);
                    }
                
                    if (con->os->argv != NULL) {        /* XXX can't happen */
                        /* XXX watchout: subtle side-effects live here. */
                        longArg = con->os->argv[con->os->next++];
                        longArg = expandNextArg(con, longArg);
                        con->os->nextArg = longArg;
                    }
                }
            }
            longArg = NULL;

            if (opt->arg) {
                switch (opt->argInfo & POPT_ARG_MASK) {
                case POPT_ARG_STRING:
                    /* XXX memory leak, hard to plug */
                    *((const char **) opt->arg) = (con->os->nextArg)
                        ? xstrdup(con->os->nextArg) : NULL;
                    /*@switchbreak@*/ break;

                case POPT_ARG_INT:
                case POPT_ARG_LONG:
                {   long aLong = 0;
                    char *end;

                    if (con->os->nextArg) {
                        aLong = strtol(con->os->nextArg, &end, 0);
                        if (!(end && *end == '\0'))
                            return POPT_ERROR_BADNUMBER;
                    }

                    if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_LONG) {
                        if (aLong == LONG_MIN || aLong == LONG_MAX)
                            return POPT_ERROR_OVERFLOW;
                        if (poptSaveLong((long *)opt->arg, opt->argInfo, aLong))
                            return POPT_ERROR_BADOPERATION;
                    } else {
                        if (aLong > INT_MAX || aLong < INT_MIN)
                            return POPT_ERROR_OVERFLOW;
                        if (poptSaveInt((int *)opt->arg, opt->argInfo, aLong))
                            return POPT_ERROR_BADOPERATION;
                    }
                }   /*@switchbreak@*/ break;

                case POPT_ARG_FLOAT:
                case POPT_ARG_DOUBLE:
                {   double aDouble = 0.0;
                    char *end;

                    if (con->os->nextArg) {
                        /*@-mods@*/
                        int saveerrno = errno;
                        errno = 0;
                        aDouble = strtod(con->os->nextArg, &end);
                        if (errno == ERANGE)
                            return POPT_ERROR_OVERFLOW;
                        errno = saveerrno;
                        /*@=mods@*/
                        if (*end != '\0')
                            return POPT_ERROR_BADNUMBER;
                    }

                    if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_DOUBLE) {
                        *((double *) opt->arg) = aDouble;
                    } else {
#ifndef _ABS
#define _ABS(a) ((((a) - 0.0) < DBL_EPSILON) ? -(a) : (a))
#endif
                        if ((_ABS(aDouble) - FLT_MAX) > DBL_EPSILON)
                            return POPT_ERROR_OVERFLOW;
                        if ((FLT_MIN - _ABS(aDouble)) > DBL_EPSILON)
                            return POPT_ERROR_OVERFLOW;
                        *((float *) opt->arg) = aDouble;
                    }
                }   /*@switchbreak@*/ break;
                default:
                    fprintf(stdout,
                        POPT_("option type (%d) not implemented in popt\n"),
                        (opt->argInfo & POPT_ARG_MASK));
                    exit(EXIT_FAILURE);
                    /*@notreached@*/ /*@switchbreak@*/ break;
                }
            }
        }

        if (cb) {
            /*@-internalglobs@*/
            invokeCallbacksOPTION(con, con->options, opt, cbData, shorty);
            /*@=internalglobs@*/
        } else if (opt->val && ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_VAL))
            done = 1;

        if ((con->finalArgvCount + 2) >= (con->finalArgvAlloced)) {
            con->finalArgvAlloced += 10;
            con->finalArgv = (const char **)realloc(con->finalArgv,
                            sizeof(*con->finalArgv) * con->finalArgvAlloced);
        }

        if (con->finalArgv != NULL)
        {   char *s = (char *)malloc(
                (opt->longName ? strlen(opt->longName) : 0) + 3);
            if (s != NULL) {    /* XXX can't happen */
                if (opt->longName)
                    sprintf(s, "%s%s",
                        ((opt->argInfo & POPT_ARGFLAG_ONEDASH) ? "-" : "--"),
                        opt->longName);
                else
                    sprintf(s, "-%c", opt->shortName);
                con->finalArgv[con->finalArgvCount++] = s;
            } else
                con->finalArgv[con->finalArgvCount++] = NULL;
        }

        if (opt->arg && (opt->argInfo & POPT_ARG_MASK) == POPT_ARG_NONE)
            /*@-ifempty@*/ ; /*@=ifempty@*/
        else if ((opt->argInfo & POPT_ARG_MASK) == POPT_ARG_VAL)
            /*@-ifempty@*/ ; /*@=ifempty@*/
        else if ((opt->argInfo & POPT_ARG_MASK) != POPT_ARG_NONE) {
            if (con->finalArgv != NULL && con->os->nextArg)
                con->finalArgv[con->finalArgvCount++] =
                        /*@-nullpass@*/ /* LCL: con->os->nextArg != NULL */
                        xstrdup(con->os->nextArg);
                        /*@=nullpass@*/
        }
    }

    return (opt ? opt->val : -1);       /* XXX can't happen */
}

const char* poptGetOptArg

(

poptContext

con

)

Return next option argument (if any).

引数:

con

context

戻り値:

option argument, NULL if no argument is available

popt.c の 1005 行で定義されています。

参照先 optionStackEntry::nextArg・poptContext_s::os.

参照元 main()・parse_quota_set().

{
    const char * ret = NULL;
    /*@-branchstate@*/
    if (con) {
        ret = con->os->nextArg;
        con->os->nextArg = NULL;
    }
    /*@=branchstate@*/
    return ret;
}

const char* poptGetArg

(

poptContext

con

)

Return next argument.

引数:

con

context

戻り値:

next argument, NULL if no argument is available

popt.c の 1017 行で定義されています。

参照先 poptContext_s::leftovers・poptContext_s::nextLeftover・poptContext_s::numLeftovers.

参照元 main()・parse_quota_set().

{
    const char * ret = NULL;
    if (con && con->leftovers != NULL && con->nextLeftover < con->numLeftovers)
        ret = con->leftovers[con->nextLeftover++];
    return ret;
}

const char* poptPeekArg

(

poptContext

con

)

Peek at current argument.

引数:

con

context

戻り値:

current argument, NULL if no argument is available

popt.c の 1025 行で定義されています。

参照先 poptContext_s::leftovers・poptContext_s::nextLeftover・poptContext_s::numLeftovers.

参照元 main()・parse_quota_set().

{
    const char * ret = NULL;
    if (con && con->leftovers != NULL && con->nextLeftover < con->numLeftovers)
        ret = con->leftovers[con->nextLeftover];
    return ret;
}

const char** poptGetArgs

(

poptContext

con

)

Return remaining arguments.

引数:

con

context

戻り値:

argument array, NULL terminated

popt.c の 1034 行で定義されています。

参照先 poptContext_s::leftovers・poptContext_s::nextLeftover・poptContext_s::numLeftovers.

参照元 main().

{
    if (con == NULL ||
        con->leftovers == NULL || con->numLeftovers == con->nextLeftover)
        return NULL;

    /* some apps like [like RPM ;-) ] need this NULL terminated */
    con->leftovers[con->numLeftovers] = NULL;

    /*@-nullret -nullstate @*/  /* FIX: typedef double indirection. */
    return (con->leftovers + con->nextLeftover);
    /*@=nullret =nullstate @*/
}

const char* poptBadOption	(	poptContext	con,
		int	flags
	)

Return the option which caused the most recent error.

引数:

	con	context
	flags

戻り値:

offending option

popt.c の 1157 行で定義されています。

参照先 optionStackEntry::argv・optionStackEntry::next・poptContext_s::optionStack・poptContext_s::os.

参照元 main()・rpc_reg_shutdown_internals().

{
    struct optionStackEntry * os = NULL;

    if (con != NULL)
        os = (flags & POPT_BADOPTION_NOALIAS) ? con->optionStack : con->os;

    /*@-nullderef@*/    /* LCL: os->argv != NULL */
    return (os && os->argv ? os->argv[os->next - 1] : NULL);
    /*@=nullderef@*/
}

poptContext poptFreeContext

(

poptContext

con

)

Destroy context.

引数:

con

context

戻り値:

NULL always

popt.c の 1049 行で定義されています。

参照先 _free()・poptContext_s::aliases・poptContext_s::appName・poptContext_s::arg_strip・optionStackEntry::argb・poptOption::argDescrip・poptItem_s::argv・poptOption::descrip・poptContext_s::execPath・poptContext_s::execs・poptContext_s::finalArgv・poptContext_s::leftovers・poptOption::longName・poptContext_s::numAliases・poptContext_s::numExecs・poptItem_s::option・poptContext_s::os・poptContext_s::otherHelp・poptResetContext().

参照元 main().

{
    poptItem item;
    int i;

    if (con == NULL) return con;
    poptResetContext(con);
    con->os->argb = (pbm_set *)_free(con->os->argb);

    if (con->aliases != NULL)
    for (i = 0; i < con->numAliases; i++) {
        item = con->aliases + i;
        /*@-modobserver -observertrans -dependenttrans@*/
        item->option.longName = (const char *)_free(item->option.longName);
        item->option.descrip = (const char *)_free(item->option.descrip);
        item->option.argDescrip = (const char *)_free(item->option.argDescrip);
        /*@=modobserver =observertrans =dependenttrans@*/
        item->argv = (const char **)_free(item->argv);
    }
    con->aliases = (poptItem)_free(con->aliases);

    if (con->execs != NULL)
    for (i = 0; i < con->numExecs; i++) {
        item = con->execs + i;
        /*@-modobserver -observertrans -dependenttrans@*/
        item->option.longName = (const char *)_free(item->option.longName);
        item->option.descrip = (const char *)_free(item->option.descrip);
        item->option.argDescrip = (const char *)_free(item->option.argDescrip);
        /*@=modobserver =observertrans =dependenttrans@*/
        item->argv = (const char **)_free(item->argv);
    }
    con->execs = (poptItem)_free(con->execs);

    con->leftovers = (const char **)_free(con->leftovers);
    con->finalArgv = (const char **)_free(con->finalArgv);
    con->appName = (const char *)_free(con->appName);
    con->otherHelp = (const char *)_free(con->otherHelp);
    con->execPath = (const char *)_free(con->execPath);
    con->arg_strip = (pbm_set *)PBM_FREE(con->arg_strip);
    
    con = (poptContext)_free(con);
    return con;
}

int poptStuffArgs	(	poptContext	con,
		const char **	argv
	)

Add arguments to context.

引数:

	con	context
	argv	argument array, NULL terminated

戻り値:

0 on success, POPT_ERROR_OPTSTOODEEP on failure

popt.c の 1197 行で定義されています。

参照先 optionStackEntry::argb・optionStackEntry::argc・optionStackEntry::argv・optionStackEntry::currAlias・optionStackEntry::next・optionStackEntry::nextArg・optionStackEntry::nextCharArg・poptContext_s::optionStack・poptContext_s::os・poptDupArgv()・optionStackEntry::stuffed.

{
    int argc;
    int rc;

    if ((con->os - con->optionStack) == POPT_OPTION_DEPTH)
        return POPT_ERROR_OPTSTOODEEP;

    for (argc = 0; argv[argc]; argc++)
        {};

    con->os++;
    con->os->next = 0;
    con->os->nextArg = NULL;
    con->os->nextCharArg = NULL;
    con->os->currAlias = NULL;
    rc = poptDupArgv(argc, argv, &con->os->argc, &con->os->argv);
    con->os->argb = NULL;
    con->os->stuffed = 1;

    return rc;
}

int poptAddAlias	(	poptContext	con,
		struct poptAlias	alias,
		int	flags
	)

Add alias to context.

TODO:

Pass alias by reference, not value.

非推奨:

Use poptAddItem instead.

引数:

	con	context
	alias	alias to add
	flags	(unused)

戻り値:

0 on success

popt.c の 1093 行で定義されています。

参照先 alloca()・poptAlias::argc・poptAlias::argv・poptAlias::longName・poptAddItem()・poptAlias::shortName.

{
    poptItem item = (poptItem)alloca(sizeof(*item));
    memset(item, 0, sizeof(*item));
    item->option.longName = alias.longName;
    item->option.shortName = alias.shortName;
    item->option.argInfo = POPT_ARGFLAG_DOC_HIDDEN;
    item->option.arg = 0;
    item->option.val = 0;
    item->option.descrip = NULL;
    item->option.argDescrip = NULL;
    item->argc = alias.argc;
    item->argv = alias.argv;
    return poptAddItem(con, item, 0);
}

int poptAddItem	(	poptContext	con,
		poptItem	newItem,
		int	flags
	)

Add alias/exec item to context.

引数:

	con	context
	newItem	alias/exec item to add
	flags	0 for alias, 1 for exec

戻り値:

0 on success

popt.c の 1112 行で定義されています。

参照先 poptContext_s::aliases・poptOption::arg・poptItem_s::argc・poptOption::argDescrip・poptOption::argInfo・poptItem_s::argv・poptOption::descrip・poptContext_s::execs・poptOption::longName・poptContext_s::numAliases・poptContext_s::numExecs・poptItem_s::option・poptOption::shortName・poptOption::val・xstrdup().

参照元 poptAddAlias().

{
    poptItem * items, item;
    int * nitems;

    switch (flags) {
    case 1:
        items = &con->execs;
        nitems = &con->numExecs;
        break;
    case 0:
        items = &con->aliases;
        nitems = &con->numAliases;
        break;
    default:
        return 1;
        /*@notreached@*/ break;
    }

    *items = (poptItem)realloc((*items), ((*nitems) + 1) * sizeof(**items));
    if ((*items) == NULL)
        return 1;

    item = (*items) + (*nitems);

    item->option.longName =
        (newItem->option.longName ? xstrdup(newItem->option.longName) : NULL);
    item->option.shortName = newItem->option.shortName;
    item->option.argInfo = newItem->option.argInfo;
    item->option.arg = newItem->option.arg;
    item->option.val = newItem->option.val;
    item->option.descrip =
        (newItem->option.descrip ? xstrdup(newItem->option.descrip) : NULL);
    item->option.argDescrip =
       (newItem->option.argDescrip ? xstrdup(newItem->option.argDescrip) : NULL);
    item->argc = newItem->argc;
    item->argv = newItem->argv;

    (*nitems)++;

    return 0;
}

int poptReadConfigFile	(	poptContext	con,
		const char *	fn
	)

Read configuration file.

引数:

	con	context
	fn	file name to read

戻り値:

0 on success, POPT_ERROR_ERRNO on failure

poptconfig.c の 95 行で定義されています。

参照先 alloca()・buf・configLine()・errno・fd.

参照元 poptReadDefaultConfig().

{
    const char * file, * chptr, * end;
    char * buf;
/*@dependent@*/ char * dst;
    int fd, rc;
    off_t fileLength;

    fd = open(fn, O_RDONLY);
    if (fd < 0)
        return (errno == ENOENT ? 0 : POPT_ERROR_ERRNO);

    fileLength = lseek(fd, 0, SEEK_END);
    if (fileLength == -1 || lseek(fd, 0, 0) == -1) {
        rc = errno;
        (void) close(fd);
        /*@-mods@*/
        errno = rc;
        /*@=mods@*/
        return POPT_ERROR_ERRNO;
    }

    file = alloca(fileLength + 1);
    if (read(fd, (char *)file, fileLength) != fileLength) {
        rc = errno;
        (void) close(fd);
        /*@-mods@*/
        errno = rc;
        /*@=mods@*/
        return POPT_ERROR_ERRNO;
    }
    if (close(fd) == -1)
        return POPT_ERROR_ERRNO;

/*@-boundswrite@*/
    dst = buf = alloca(fileLength + 1);

    chptr = file;
    end = (file + fileLength);
    /*@-infloops@*/     /* LCL: can't detect chptr++ */
    while (chptr < end) {
        switch (*chptr) {
          case '\n':
            *dst = '\0';
            dst = buf;
            while (*dst && isspace(*dst)) dst++;
            if (*dst && *dst != '#')
                configLine(con, dst);
            chptr++;
            /*@switchbreak@*/ break;
          case '\\':
            *dst++ = *chptr++;
            if (chptr < end) {
                if (*chptr == '\n') 
                    dst--, chptr++;     
                    /* \ at the end of a line does not insert a \n */
                else
                    *dst++ = *chptr++;
            }
            /*@switchbreak@*/ break;
          default:
            *dst++ = *chptr++;
            /*@switchbreak@*/ break;
        }
    }
    /*@=infloops@*/
/*@=boundswrite@*/

    return 0;
}

int poptReadDefaultConfig	(	poptContext	con,
		int	useEnv
	)

Read default configuration from /etc/popt and $HOME/.popt.

引数:

	con	context
	useEnv	(unused)

戻り値:

0 on success, POPT_ERROR_ERRNO on failure

poptconfig.c の 166 行で定義されています。

参照先 alloca()・poptContext_s::appName・fn・poptReadConfigFile().

{
    char * fn, * home;
    int rc;

    /*@-type@*/
    if (!con->appName) return 0;
    /*@=type@*/

    rc = poptReadConfigFile(con, "/etc/popt");
    if (rc) return rc;
#if defined(HAVE_GETUID) && defined(HAVE_GETEUID)
    if (getuid() != geteuid()) return 0;
#endif

    if ((home = getenv("HOME"))) {
        fn = alloca(strlen(home) + 20);
        strcpy(fn, home);
        strcat(fn, "/.popt");
        rc = poptReadConfigFile(con, fn);
        if (rc) return rc;
    }

    return 0;
}

int poptDupArgv	(	int	argc,
		const char **	argv,
		int *	argcPtr,
		const char ***	argvPtr
	)

Duplicate an argument array.

覚え書き:

: The argument array is malloc'd as a single area, so only argv must be free'd.

引数:

	argc	no. of arguments
	argv	argument array

戻り値:

	argcPtr	address of returned no. of arguments
	argvPtr	address of returned argument array

戻り値:

0 on success, POPT_ERROR_NOARG on failure

poptparse.c の 14 行で定義されています。

参照元 handleAlias()・poptParseArgvString()・poptStuffArgs().

{
    size_t nb = (argc + 1) * sizeof(*argv);
    const char ** argv2;
    char * dst;
    int i;

    if (argc <= 0 || argv == NULL)      /* XXX can't happen */
        return POPT_ERROR_NOARG;
    for (i = 0; i < argc; i++) {
        if (argv[i] == NULL)
            return POPT_ERROR_NOARG;
        nb += strlen(argv[i]) + 1;
    }
        
    dst = malloc(nb);
    if (dst == NULL)                    /* XXX can't happen */
        return POPT_ERROR_MALLOC;
    argv2 = (void *) dst;
    dst += (argc + 1) * sizeof(*argv);

    /*@-branchstate@*/
    for (i = 0; i < argc; i++) {
        argv2[i] = dst;
        dst += strlen(strcpy(dst, argv[i])) + 1;
    }
    /*@=branchstate@*/
    argv2[argc] = NULL;

    if (argvPtr) {
        *argvPtr = argv2;
    } else {
        free(argv2);
        argv2 = NULL;
    }
    if (argcPtr)
        *argcPtr = argc;
    return 0;
}

int poptParseArgvString	(	const char *	s,
		int *	argcPtr,
		const char ***	argvPtr
	)

Parse a string into an argument array.

The parse allows ', ", and \ quoting, but ' is treated the same as " and both may include \ quotes.

覚え書き:

: The argument array is malloc'd as a single area, so only argv must be free'd.

引数:

s

string to parse

戻り値:

	argcPtr	address of returned no. of arguments
	argvPtr	address of returned argument array

poptparse.c の 57 行で定義されています。

参照先 alloca()・buf・poptDupArgv().

参照元 configLine()・net_rpc_shell()・process_cmd().

{
    const char * src;
    char quote = '\0';
    int argvAlloced = POPT_ARGV_ARRAY_GROW_DELTA;
    const char ** argv = malloc(sizeof(*argv) * argvAlloced);
    int argc = 0;
    int buflen = strlen(s) + 1;
    char * buf = memset(alloca(buflen), 0, buflen);
    int rc = POPT_ERROR_MALLOC;

    if (argv == NULL) return rc;
    argv[argc] = buf;

    for (src = s; *src != '\0'; src++) {
        if (quote == *src) {
            quote = '\0';
        } else if (quote != '\0') {
            if (*src == '\\') {
                src++;
                if (!*src) {
                    rc = POPT_ERROR_BADQUOTE;
                    goto exit;
                }
                if (*src != quote) *buf++ = '\\';
            }
            *buf++ = *src;
        } else if (isspace(*src)) {
            if (*argv[argc] != '\0') {
                buf++, argc++;
                if (argc == argvAlloced) {
                    argvAlloced += POPT_ARGV_ARRAY_GROW_DELTA;
                    argv = realloc(argv, sizeof(*argv) * argvAlloced);
                    if (argv == NULL) goto exit;
                }
                argv[argc] = buf;
            }
        } else switch (*src) {
          case '"':
          case '\'':
            quote = *src;
            /*@switchbreak@*/ break;
          case '\\':
            src++;
            if (!*src) {
                rc = POPT_ERROR_BADQUOTE;
                goto exit;
            }
            /*@fallthrough@*/
          default:
            *buf++ = *src;
            /*@switchbreak@*/ break;
        }
    }

    if (strlen(argv[argc])) {
        argc++, buf++;
    }

    rc = poptDupArgv(argc, argv, argcPtr, argvPtr);

exit:
    if (argv) free(argv);
    return rc;
}

int poptConfigFileToString	(	FILE *	fp,
		char **	argstrp,
		int	flags
	)

Parses an input configuration file and returns an string that is a command line.

For use with popt. You must free the return value when done.

Given the file:

# this line is ignored
    #   this one too
aaa
  bbb
    ccc
bla=bla

this_is   =   fdsafdas
     bad_line=
  reall bad line
  reall bad line  = again
5555=   55555
  test = with lots of spaces

The result is:

--aaa --bbb --ccc --bla="bla" --this_is="fdsafdas" --5555="55555" --test="with lots of spaces"

Passing this to poptParseArgvString() yields an argv of:

'--aaa'
'--bbb'
'--ccc'
'--bla=bla'
'--this_is=fdsafdas'
'--5555=55555'
'--test=with lots of spaces'

バグ:

NULL is returned if file line is too long.

Silently ignores invalid lines.

引数:

	fp	file handle to read
	*argstrp	return string of options (malloc'd)
	flags	unused

戻り値:

0 on success

参照:

poptParseArgvString

poptparse.c の 129 行で定義されています。

参照先 line・t.

{
    char line[999];
    char * argstr;
    char * p;
    char * q;
    char * x;
    int t;
    int argvlen = 0;
    size_t maxlinelen = sizeof(line);
    size_t linelen;
    int maxargvlen = 480;
    int linenum = 0;

    *argstrp = NULL;

    /*   |   this_is   =   our_line
     *       p             q      x
     */

    if (fp == NULL)
        return POPT_ERROR_NULLARG;

    argstr = calloc(maxargvlen, sizeof(*argstr));
    if (argstr == NULL) return POPT_ERROR_MALLOC;

    while (fgets(line, (int)maxlinelen, fp) != NULL) {
        linenum++;
        p = line;

        /* loop until first non-space char or EOL */
        while( *p != '\0' && isspace(*p) )
            p++;

        linelen = strlen(p);
        if (linelen >= maxlinelen-1)
            return POPT_ERROR_OVERFLOW; /* XXX line too long */

        if (*p == '\0' || *p == '\n') continue; /* line is empty */
        if (*p == '#') continue;                /* comment line */

        q = p;

        while (*q != '\0' && (!isspace(*q)) && *q != '=')
            q++;

        if (isspace(*q)) {
            /* a space after the name, find next non space */
            *q++='\0';
            while( *q != '\0' && isspace((int)*q) ) q++;
        }
        if (*q == '\0') {
            /* single command line option (ie, no name=val, just name) */
            q[-1] = '\0';               /* kill off newline from fgets() call */
            argvlen += (t = q - p) + (sizeof(" --")-1);
            if (argvlen >= maxargvlen) {
                maxargvlen = (t > maxargvlen) ? t*2 : maxargvlen*2;
                argstr = realloc(argstr, maxargvlen);
                if (argstr == NULL) return POPT_ERROR_MALLOC;
            }
            strcat(argstr, " --");
            strcat(argstr, p);
            continue;
        }
        if (*q != '=')
            continue;   /* XXX for now, silently ignore bogus line */

        /* *q is an equal sign. */
        *q++ = '\0';

        /* find next non-space letter of value */
        while (*q != '\0' && isspace(*q))
            q++;
        if (*q == '\0')
            continue;   /* XXX silently ignore missing value */

        /* now, loop and strip all ending whitespace */
        x = p + linelen;
        while (isspace(*--x))
            *x = 0;     /* null out last char if space (including fgets() NL) */

        /* rest of line accept */
        t = x - p;
        argvlen += t + (sizeof("' --='")-1);
        if (argvlen >= maxargvlen) {
            maxargvlen = (t > maxargvlen) ? t*2 : maxargvlen*2;
            argstr = realloc(argstr, maxargvlen);
            if (argstr == NULL) return POPT_ERROR_MALLOC;
        }
        strcat(argstr, " --");
        strcat(argstr, p);
        strcat(argstr, "=\"");
        strcat(argstr, q);
        strcat(argstr, "\"");
    }

    *argstrp = argstr;
    return 0;
}

const char* poptStrerror

(

const int

error

)

Return formatted error string for popt failure.

引数:

error

popt error

戻り値:

error string

popt.c の 1169 行で定義されています。

参照先 errno・strerror().

参照元 main()・net_rpc_shell()・process_cmd()・rpc_reg_shutdown_internals().

{
    switch (error) {
      case POPT_ERROR_NOARG:
        return POPT_("missing argument");
      case POPT_ERROR_BADOPT:
        return POPT_("unknown option");
      case POPT_ERROR_BADOPERATION:
        return POPT_("mutually exclusive logical operations requested");
      case POPT_ERROR_NULLARG:
        return POPT_("opt->arg should not be NULL");
      case POPT_ERROR_OPTSTOODEEP:
        return POPT_("aliases nested too deeply");
      case POPT_ERROR_BADQUOTE:
        return POPT_("error in parameter quoting");
      case POPT_ERROR_BADNUMBER:
        return POPT_("invalid numeric value");
      case POPT_ERROR_OVERFLOW:
        return POPT_("number too large or too small");
      case POPT_ERROR_MALLOC:
        return POPT_("memory allocation failed");
      case POPT_ERROR_ERRNO:
        return strerror(errno);
      default:
        return POPT_("unknown error");
    }
}

void poptSetExecPath	(	poptContext	con,
		const char *	path,
		int	allowAbsolute
	)

Limit search for executables.

引数:

	con	context
	path	single path to search for executables
	allowAbsolute	absolute paths only?

popt.c の 52 行で定義されています。

参照先 _free()・poptContext_s::execAbsolute・poptContext_s::execPath・xstrdup().

{
    con->execPath = (const char *)_free(con->execPath);
    con->execPath = xstrdup(path);
    con->execAbsolute = allowAbsolute;
    /*@-nullstate@*/ /* LCL: con->execPath can be NULL? */
    return;
    /*@=nullstate@*/
}

void poptPrintHelp	(	poptContext	con,
		FILE *	fp,
		int	flags
	)

Print detailed description of options.

引数:

	con	context
	fp	ouput file handle
	flags	(unused)

popthelp.c の 502 行で定義されています。

参照先 fprintf()・maxArgWidth()・poptContext_s::options・poptContext_s::otherHelp・showHelpIntro()・singleTableHelp().

参照元 displayArgs()・main()・usage().

{
    int leftColWidth;

    (void) showHelpIntro(con, fp);
    if (con->otherHelp)
        fprintf(fp, " %s\n", con->otherHelp);
    else
        fprintf(fp, " %s\n", POPT_("[OPTION...]"));

    leftColWidth = maxArgWidth(con->options, NULL);
    singleTableHelp(con, fp, con->options, leftColWidth, NULL);
}

void poptPrintUsage	(	poptContext	con,
		FILE *	fp,
		int	flags
	)

Print terse description of options.

引数:

	con	context
	fp	ouput file handle
	flags	(unused)

popthelp.c の 705 行で定義されています。

参照先 poptContext_s::aliases・alloca()・poptContext_s::execs・fprintf()・itemUsage()・poptContext_s::numAliases・poptContext_s::numExecs・poptContext_s::options・poptContext_s::otherHelp・showHelpIntro()・showShortOptions()・singleTableUsage().

参照元 displayArgs()・main()・parse_quota_set().

{
    poptDone done = memset(alloca(sizeof(*done)), 0, sizeof(*done));
    int cursor;

    done->nopts = 0;
    done->maxopts = 64;
    cursor = done->maxopts * sizeof(*done->opts);
/*@-boundswrite@*/
    done->opts = memset(alloca(cursor), 0, cursor);
    done->opts[done->nopts++] = (const void *) con->options;
/*@=boundswrite@*/

    cursor = showHelpIntro(con, fp);
    cursor += showShortOptions(con->options, fp, NULL);
    cursor = singleTableUsage(con, fp, cursor, con->options, NULL, done);
    cursor = itemUsage(fp, cursor, con->aliases, con->numAliases, NULL);
    cursor = itemUsage(fp, cursor, con->execs, con->numExecs, NULL);

    if (con->otherHelp) {
        cursor += strlen(con->otherHelp) + 1;
        if (cursor > 79) fprintf(fp, "\n       ");
        fprintf(fp, " %s", con->otherHelp);
    }

    fprintf(fp, "\n");
}

void poptSetOtherOptionHelp	(	poptContext	con,
		const char *	text
	)

Provide text to replace default "[OPTION...]" in help/usage output.

引数:

	con	context
	text	replacement text

popthelp.c の 733 行で定義されています。

参照先 _free()・poptContext_s::otherHelp・xstrdup().

参照元 main()・parse_quota_set().

{
    con->otherHelp = _free(con->otherHelp);
    con->otherHelp = xstrdup(text);
}

const char* poptGetInvocationName

(

poptContext

con

)

Return argv[0] from context.

引数:

con

context

戻り値:

argv[0]

popt.c の 1220 行で定義されています。

参照先 optionStackEntry::argv・poptContext_s::os.

参照元 set_logfile().

{
    return (con->os->argv ? con->os->argv[0] : "");
}

int poptStrippedArgv	(	poptContext	con,
		int	argc,
		char **	argv
	)

Shuffle argv pointers to remove stripped args, returns new argc.

引数:

	con	context
	argc	no. of args
	argv	arg vector

戻り値:

new argc

popt.c の 1226 行で定義されています。

参照先 poptContext_s::arg_strip.

{
    int numargs = argc;
    int j = 1;
    int i;
    
    /*@-sizeoftype@*/
    if (con->arg_strip)
    for (i = 1; i < argc; i++) {
        if (PBM_ISSET(i, con->arg_strip))
            numargs--;
    }
    
    for (i = 1; i < argc; i++) {
        if (con->arg_strip && PBM_ISSET(i, con->arg_strip))
            continue;
        argv[j] = (j < numargs) ? argv[i] : NULL;
        j++;
    }
    /*@=sizeoftype@*/
    
    return numargs;
}

int poptSaveLong	(	long *	arg,
		int	argInfo,
		long	aLong
	)

Save a long, performing logical operation with value.

警告:

Alignment check may be too strict on certain platorms.

引数:

	arg	integer pointer, aligned on int boundary.
	argInfo	logical operation (see POPT_ARGFLAG_*)
	aLong	value to use

戻り値:

0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

popt.c の 633 行で定義されています。

参照元 poptGetNextOpt().

{
    /* XXX Check alignment, may fail on funky platforms. */
    if (arg == NULL || (((unsigned long)arg) & (sizeof(*arg)-1)))
        return POPT_ERROR_NULLARG;

    if (argInfo & POPT_ARGFLAG_NOT)
        aLong = ~aLong;
    switch (argInfo & POPT_ARGFLAG_LOGICALOPS) {
    case 0:
        *arg = aLong;
        break;
    case POPT_ARGFLAG_OR:
        *arg |= aLong;
        break;
    case POPT_ARGFLAG_AND:
        *arg &= aLong;
        break;
    case POPT_ARGFLAG_XOR:
        *arg ^= aLong;
        break;
    default:
        return POPT_ERROR_BADOPERATION;
        /*@notreached@*/ break;
    }
    return 0;
}

int poptSaveInt	(	int *	arg,
		int	argInfo,
		long	aLong
	)

Save an integer, performing logical operation with value.

警告:

Alignment check may be too strict on certain platorms.

引数:

	arg	integer pointer, aligned on int boundary.
	argInfo	logical operation (see POPT_ARGFLAG_*)
	aLong	value to use

戻り値:

0 on success, POPT_ERROR_NULLARG/POPT_ERROR_BADOPERATION

popt.c の 661 行で定義されています。

参照元 poptGetNextOpt().

{
    /* XXX Check alignment, may fail on funky platforms. */
    if (arg == NULL || (((unsigned long)arg) & (sizeof(*arg)-1)))
        return POPT_ERROR_NULLARG;

    if (argInfo & POPT_ARGFLAG_NOT)
        aLong = ~aLong;
    switch (argInfo & POPT_ARGFLAG_LOGICALOPS) {
    case 0:
        *arg = aLong;
        break;
    case POPT_ARGFLAG_OR:
        *arg |= aLong;
        break;
    case POPT_ARGFLAG_AND:
        *arg &= aLong;
        break;
    case POPT_ARGFLAG_XOR:
        *arg ^= aLong;
        break;
    default:
        return POPT_ERROR_BADOPERATION;
        /*@notreached@*/ break;
    }
    return 0;
}

---

変数

struct poptOption poptAliasOptions[]

Empty table marker to enable displaying popt alias/exec options.

popthelp.c の 46 行で定義されています。

参照元 singleTableHelp().

struct poptOption poptHelpOptions[]

Auto help table options.

popthelp.c の 55 行で定義されています。

参照元 getArgDescrip().

---