Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
947 lines (849 sloc) 25.4 KB
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/** \ingroup popt
* \file popt/popthelp.c
*/
/* (C) 1998-2002 Red Hat, Inc. -- Licensing details are in the COPYING
file accompanying popt source distributions, available from
ftp://ftp.rpm.org/pub/rpm/dist. */
#include "system.h"
#define POPT_USE_TIOCGWINSZ
#ifdef POPT_USE_TIOCGWINSZ
#if defined(HAVE_SYS_IOCTL_H)
#include <sys/ioctl.h>
#endif
#endif
#define POPT_WCHAR_HACK
#ifdef POPT_WCHAR_HACK
#include <wchar.h> /* for mbsrtowcs */
/*@access mbstate_t @*/
#endif
#include "poptint.h"
#if defined(HAVE_ASSERT_H)
#include <assert.h>
#else
#define assert(_x)
#endif
/*@access poptContext@*/
/**
* Display arguments.
* @param con context
* @param foo (unused)
* @param key option(s)
* @param arg (unused)
* @param data (unused)
*/
/*@exits@*/
static void displayArgs(poptContext con,
/*@unused@*/ UNUSED(enum poptCallbackReason foo),
struct poptOption * key,
/*@unused@*/ UNUSED(const char * arg),
/*@unused@*/ UNUSED(void * data))
/*@globals fileSystem@*/
/*@modifies fileSystem@*/
{
if (key->shortName == '?')
poptPrintHelp(con, stdout, 0);
else
poptPrintUsage(con, stdout, 0);
#if !defined(__LCLINT__) /* XXX keep both splint & valgrind happy */
con = poptFreeContext(con);
#endif
exit(0);
}
#ifdef NOTYET
/*@unchecked@*/
static int show_option_defaults = 0;
#endif
/**
* Empty table marker to enable displaying popt alias/exec options.
*/
/*@observer@*/ /*@unchecked@*/
struct poptOption poptAliasOptions[] = {
POPT_TABLEEND
};
/**
* Auto help table options.
*/
/*@-castfcnptr@*/
/*@observer@*/ /*@unchecked@*/
struct poptOption poptHelpOptions[] = {
{ NULL, '\0', POPT_ARG_CALLBACK, (void *)displayArgs, 0, NULL, NULL },
{ "help", '?', 0, NULL, (int)'?', N_("Show this help message"), NULL },
{ "usage", '\0', 0, NULL, (int)'u', N_("Display brief usage message"), NULL },
POPT_TABLEEND
} ;
/*@observer@*/ /*@unchecked@*/
static struct poptOption poptHelpOptions2[] = {
/*@-readonlytrans@*/
{ NULL, '\0', POPT_ARG_INTL_DOMAIN, PACKAGE, 0, NULL, NULL},
/*@=readonlytrans@*/
{ NULL, '\0', POPT_ARG_CALLBACK, (void *)displayArgs, 0, NULL, NULL },
{ "help", '?', 0, NULL, (int)'?', N_("Show this help message"), NULL },
{ "usage", '\0', 0, NULL, (int)'u', N_("Display brief usage message"), NULL },
#ifdef NOTYET
{ "defaults", '\0', POPT_ARG_NONE, &show_option_defaults, 0,
N_("Display option defaults in message"), NULL },
#endif
{ "", '\0', 0, NULL, 0, N_("Terminate options"), NULL },
POPT_TABLEEND
} ;
/*@observer@*/ /*@unchecked@*/
struct poptOption * poptHelpOptionsI18N = poptHelpOptions2;
/*@=castfcnptr@*/
#define _POPTHELP_MAXLINE ((size_t)79)
typedef struct columns_s {
size_t cur;
size_t max;
} * columns_t;
/**
* Return no. of columns in output window.
* @param fp FILE
* @return no. of columns
*/
static size_t maxColumnWidth(FILE *fp)
/*@*/
{
size_t maxcols = _POPTHELP_MAXLINE;
#if defined(TIOCGWINSZ)
struct winsize ws;
int fdno = fileno(fp ? fp : stdout);
memset(&ws, 0, sizeof(ws));
if (fdno >= 0 && !ioctl(fdno, (unsigned long)TIOCGWINSZ, &ws)) {
size_t ws_col = (size_t)ws.ws_col;
if (ws_col > maxcols && ws_col < (size_t)256)
maxcols = ws_col - 1;
}
#endif
return maxcols;
}
/**
* Determine number of display characters in a string.
* @param s string
* @return no. of display characters.
*/
static inline size_t stringDisplayWidth(const char *s)
/*@*/
{
size_t n = strlen(s);
#ifdef POPT_WCHAR_HACK
mbstate_t t;
memset ((void *)&t, 0, sizeof (t)); /* In initial state. */
/* Determine number of display characters. */
n = mbsrtowcs (NULL, &s, n, &t);
#else
n = 0;
for (; *s; s = POPT_next_char(s))
n++;
#endif
return n;
}
/**
* @param opt option(s)
*/
/*@observer@*/ /*@null@*/ static const char *
getTableTranslationDomain(/*@null@*/ const struct poptOption *opt)
/*@*/
{
if (opt != NULL)
for (; opt->longName || opt->shortName || opt->arg; opt++) {
if (opt->argInfo == POPT_ARG_INTL_DOMAIN)
return opt->arg;
}
return NULL;
}
/**
* @param opt option(s)
* @param translation_domain translation domain
*/
/*@observer@*/ /*@null@*/ static const char *
getArgDescrip(const struct poptOption * opt,
/*@-paramuse@*/ /* FIX: i18n macros disabled with lclint */
/*@null@*/ const char * translation_domain)
/*@=paramuse@*/
/*@*/
{
if (!poptArgType(opt)) return NULL;
if (poptArgType(opt) == POPT_ARG_MAINCALL)
return opt->argDescrip;
if (poptArgType(opt) == POPT_ARG_ARGV)
return opt->argDescrip;
if (opt->argDescrip) {
/* Some strings need popt library, not application, i18n domain. */
if (opt == (poptHelpOptions + 1)
|| opt == (poptHelpOptions + 2)
|| !strcmp(opt->argDescrip, N_("Help options:"))
|| !strcmp(opt->argDescrip, N_("Options implemented via popt alias/exec:")))
return POPT_(opt->argDescrip);
/* Use the application i18n domain. */
return D_(translation_domain, opt->argDescrip);
}
switch (poptArgType(opt)) {
case POPT_ARG_NONE: return POPT_("NONE");
#ifdef DYING
case POPT_ARG_VAL: return POPT_("VAL");
#else
case POPT_ARG_VAL: return NULL;
#endif
case POPT_ARG_INT: return POPT_("INT");
case POPT_ARG_SHORT: return POPT_("SHORT");
case POPT_ARG_LONG: return POPT_("LONG");
case POPT_ARG_LONGLONG: return POPT_("LONGLONG");
case POPT_ARG_STRING: return POPT_("STRING");
case POPT_ARG_FLOAT: return POPT_("FLOAT");
case POPT_ARG_DOUBLE: return POPT_("DOUBLE");
case POPT_ARG_MAINCALL: return NULL;
case POPT_ARG_ARGV: return NULL;
default: return POPT_("ARG");
}
}
/**
* Display default value for an option.
* @param lineLength display positions remaining
* @param opt option(s)
* @param translation_domain translation domain
* @return
*/
static /*@only@*/ /*@null@*/ char *
singleOptionDefaultValue(size_t lineLength,
const struct poptOption * opt,
/*@-paramuse@*/ /* FIX: i18n macros disabled with lclint */
/*@null@*/ const char * translation_domain)
/*@=paramuse@*/
/*@*/
{
const char * defstr = D_(translation_domain, "default");
char * le = (char*) xmalloc(4*lineLength + 1);
char * l = le;
assert(le); /* XXX can't happen */
if (le == NULL) return NULL;
*le = '\0';
*le++ = '(';
le = stpcpy(le, defstr);
*le++ = ':';
*le++ = ' ';
if (opt->arg) { /* XXX programmer error */
poptArg arg;
arg.ptr = opt->arg;
switch (poptArgType(opt)) {
case POPT_ARG_VAL:
case POPT_ARG_INT:
le += sprintf(le, "%d", arg.intp[0]);
break;
case POPT_ARG_SHORT:
le += sprintf(le, "%hd", arg.shortp[0]);
break;
case POPT_ARG_LONG:
le += sprintf(le, "%ld", arg.longp[0]);
break;
case POPT_ARG_LONGLONG:
#if defined(_MSC_VER) || defined(__MINGW32__)
le += sprintf(le, "%I64d", arg.longlongp[0]);
#else
le += sprintf(le, "%lld", arg.longlongp[0]);
#endif
break;
case POPT_ARG_FLOAT:
{ double aDouble = (double) arg.floatp[0];
le += sprintf(le, "%g", aDouble);
} break;
case POPT_ARG_DOUBLE:
le += sprintf(le, "%g", arg.doublep[0]);
break;
case POPT_ARG_MAINCALL:
le += sprintf(le, "%p", opt->arg);
break;
case POPT_ARG_ARGV:
le += sprintf(le, "%p", opt->arg);
break;
case POPT_ARG_STRING:
{ const char * s = arg.argv[0];
if (s == NULL)
le = stpcpy(le, "null");
else {
size_t limit = 4*lineLength - (le - l) - sizeof("\"\")");
size_t slen;
*le++ = '"';
strncpy(le, s, limit); le[limit] = '\0'; le += (slen = strlen(le));
if (slen == limit && s[limit])
le[-1] = le[-2] = le[-3] = '.';
*le++ = '"';
}
} break;
case POPT_ARG_NONE:
default:
l = _free(l);
return NULL;
/*@notreached@*/ break;
}
}
*le++ = ')';
*le = '\0';
return l;
}
/**
* Display help text for an option.
* @param fp output file handle
* @param columns output display width control
* @param opt option(s)
* @param translation_domain translation domain
*/
static void singleOptionHelp(FILE * fp, columns_t columns,
const struct poptOption * opt,
/*@null@*/ const char * translation_domain)
/*@globals fileSystem @*/
/*@modifies fp, fileSystem @*/
{
size_t maxLeftCol = columns->cur;
size_t indentLength = maxLeftCol + 5;
size_t lineLength = columns->max - indentLength;
const char * help = D_(translation_domain, opt->descrip);
const char * argDescrip = getArgDescrip(opt, translation_domain);
/* Display shortName iff printable non-space. */
int prtshort = (int)(isprint((int)opt->shortName) && opt->shortName != ' ');
size_t helpLength;
char * defs = NULL;
char * left;
size_t nb = maxLeftCol + 1;
int displaypad = 0;
/* Make sure there's more than enough room in target buffer. */
if (opt->longName) nb += strlen(opt->longName);
if (F_ISSET(opt, TOGGLE)) nb += sizeof("[no]") - 1;
if (argDescrip) nb += strlen(argDescrip);
left = (char*) xmalloc(nb);
assert(left); /* XXX can't happen */
if (left == NULL) return;
left[0] = '\0';
left[maxLeftCol] = '\0';
#define prtlong (opt->longName != NULL) /* XXX splint needs a clue */
if (!(prtshort || prtlong))
goto out;
if (prtshort && prtlong) {
char *dash = F_ISSET(opt, ONEDASH) ? "-" : "--";
left[0] = '-';
left[1] = opt->shortName;
(void) stpcpy(stpcpy(stpcpy(left+2, ", "), dash), opt->longName);
} else if (prtshort) {
left[0] = '-';
left[1] = opt->shortName;
left[2] = '\0';
} else if (prtlong) {
/* XXX --long always padded for alignment with/without "-X, ". */
char *dash = poptArgType(opt) == POPT_ARG_MAINCALL ? ""
: (F_ISSET(opt, ONEDASH) ? "-" : "--");
const char *longName = opt->longName;
const char *toggle;
if (F_ISSET(opt, TOGGLE)) {
toggle = "[no]";
if (longName[0] == 'n' && longName[1] == 'o') {
longName += sizeof("no") - 1;
if (longName[0] == '-')
longName++;
}
} else
toggle = "";
(void) stpcpy(stpcpy(stpcpy(stpcpy(left, " "), dash), toggle), longName);
}
#undef prtlong
if (argDescrip) {
char * le = left + strlen(left);
if (F_ISSET(opt, OPTIONAL))
*le++ = '[';
/* Choose type of output */
if (F_ISSET(opt, SHOW_DEFAULT)) {
defs = singleOptionDefaultValue(lineLength, opt, translation_domain);
if (defs) {
char * t = (char*) xmalloc((help ? strlen(help) : 0) +
strlen(defs) + sizeof(" "));
assert(t); /* XXX can't happen */
if (t) {
char * te = t;
if (help)
te = stpcpy(te, help);
*te++ = ' ';
strcpy(te, defs);
defs = _free(defs);
defs = t;
}
}
}
if (opt->argDescrip == NULL) {
switch (poptArgType(opt)) {
case POPT_ARG_NONE:
break;
case POPT_ARG_VAL:
#ifdef NOTNOW /* XXX pug ugly nerdy output */
{ long aLong = opt->val;
int ops = F_ISSET(opt, LOGICALOPS);
int negate = F_ISSET(opt, NOT);
/* Don't bother displaying typical values */
if (!ops && (aLong == 0L || aLong == 1L || aLong == -1L))
break;
*le++ = '[';
switch (ops) {
case POPT_ARGFLAG_OR:
*le++ = '|';
/*@innerbreak@*/ break;
case POPT_ARGFLAG_AND:
*le++ = '&';
/*@innerbreak@*/ break;
case POPT_ARGFLAG_XOR:
*le++ = '^';
/*@innerbreak@*/ break;
default:
/*@innerbreak@*/ break;
}
*le++ = (opt->longName != NULL ? '=' : ' ');
if (negate) *le++ = '~';
/*@-formatconst@*/
le += sprintf(le, (ops ? "0x%lx" : "%ld"), aLong);
/*@=formatconst@*/
*le++ = ']';
}
#endif
break;
case POPT_ARG_INT:
case POPT_ARG_SHORT:
case POPT_ARG_LONG:
case POPT_ARG_LONGLONG:
case POPT_ARG_FLOAT:
case POPT_ARG_DOUBLE:
case POPT_ARG_STRING:
*le++ = (opt->longName != NULL ? '=' : ' ');
le = stpcpy(le, argDescrip);
break;
default:
break;
}
} else {
char *leo;
/* XXX argDescrip[0] determines "--foo=bar" or "--foo bar". */
if (!strchr(" =(", argDescrip[0]))
*le++ = ((poptArgType(opt) == POPT_ARG_MAINCALL) ? ' ' :
(poptArgType(opt) == POPT_ARG_ARGV) ? ' ' : '=');
le = stpcpy(leo = le, argDescrip);
/* Adjust for (possible) wide characters. */
displaypad = (int)((le - leo) - stringDisplayWidth(argDescrip));
}
if (F_ISSET(opt, OPTIONAL))
*le++ = ']';
*le = '\0';
}
if (help)
POPT_fprintf(fp," %-*s ", (int)(maxLeftCol+displaypad), left);
else {
POPT_fprintf(fp," %s\n", left);
goto out;
}
left = _free(left);
if (defs)
help = defs;
helpLength = strlen(help);
while (helpLength > lineLength) {
const char * ch;
char format[16];
ch = help + lineLength - 1;
while (ch > help && !_isspaceptr(ch))
ch = POPT_prev_char(ch);
if (ch == help) break; /* give up */
while (ch > (help + 1) && _isspaceptr(ch))
ch = POPT_prev_char (ch);
ch = POPT_next_char(ch);
/*
* XXX strdup is necessary to add NUL terminator so that an unknown
* no. of (possible) multi-byte characters can be displayed.
*/
{ char * fmthelp = xstrdup(help);
if (fmthelp) {
fmthelp[ch - help] = '\0';
sprintf(format, "%%s\n%%%ds", (int) indentLength);
/*@-formatconst@*/
POPT_fprintf(fp, format, fmthelp, " ");
/*@=formatconst@*/
free(fmthelp);
}
}
help = ch;
while (_isspaceptr(help) && *help)
help = POPT_next_char(help);
helpLength = strlen(help);
}
if (helpLength) fprintf(fp, "%s\n", help);
help = NULL;
out:
/*@-dependenttrans@*/
defs = _free(defs);
/*@=dependenttrans@*/
left = _free(left);
}
/**
* Find display width for longest argument string.
* @param opt option(s)
* @param translation_domain translation domain
* @return display width
*/
static size_t maxArgWidth(const struct poptOption * opt,
/*@null@*/ const char * translation_domain)
/*@*/
{
size_t max = 0;
const char * argDescrip;
if (opt != NULL)
while (opt->longName || opt->shortName || opt->arg) {
size_t len = 0;
if (poptArgType(opt) == POPT_ARG_INCLUDE_TABLE) {
if (opt->arg) /* XXX program error */
len = maxArgWidth(opt->arg, translation_domain);
if (len > max) max = len;
} else if (!F_ISSET(opt, DOC_HIDDEN)) {
len = sizeof(" ")-1;
/* XXX --long always padded for alignment with/without "-X, ". */
len += sizeof("-X, ")-1;
if (opt->longName) {
len += (F_ISSET(opt, ONEDASH) ? sizeof("-") : sizeof("--")) - 1;
len += strlen(opt->longName);
}
argDescrip = getArgDescrip(opt, translation_domain);
if (argDescrip) {
/* XXX argDescrip[0] determines "--foo=bar" or "--foo bar". */
if (!strchr(" =(", argDescrip[0])) len += sizeof("=")-1;
/* Adjust for (possible) wide characters. */
len += stringDisplayWidth(argDescrip);
}
if (F_ISSET(opt, OPTIONAL)) len += sizeof("[]")-1;
if (len > max) max = len;
}
opt++;
}
return max;
}
/**
* Display popt alias and exec help.
* @param fp output file handle
* @param items alias/exec array
* @param nitems no. of alias/exec entries
* @param columns output display width control
* @param translation_domain translation domain
*/
static void itemHelp(FILE * fp,
/*@null@*/ poptItem items, int nitems,
columns_t columns,
/*@null@*/ const char * translation_domain)
/*@globals fileSystem @*/
/*@modifies fp, fileSystem @*/
{
poptItem item;
if (items != NULL) {
int i;
for (i = 0, item = items; i < nitems; i++, item++) {
const struct poptOption * opt;
opt = &item->option;
if ((opt->longName || opt->shortName) && !F_ISSET(opt, DOC_HIDDEN))
singleOptionHelp(fp, columns, opt, translation_domain);
}
}
}
/**
* Display help text for a table of options.
* @param con context
* @param fp output file handle
* @param table option(s)
* @param columns output display width control
* @param translation_domain translation domain
*/
static void singleTableHelp(poptContext con, FILE * fp,
/*@null@*/ const struct poptOption * table,
columns_t columns,
/*@null@*/ const char * translation_domain)
/*@globals fileSystem @*/
/*@modifies fp, columns->cur, fileSystem @*/
{
const struct poptOption * opt;
const char *sub_transdom;
if (table == poptAliasOptions) {
itemHelp(fp, con->aliases, con->numAliases, columns, NULL);
itemHelp(fp, con->execs, con->numExecs, columns, NULL);
return;
}
if (table != NULL)
for (opt = table; opt->longName || opt->shortName || opt->arg; opt++) {
if ((opt->longName || opt->shortName) && !F_ISSET(opt, DOC_HIDDEN))
singleOptionHelp(fp, columns, opt, translation_domain);
}
if (table != NULL)
for (opt = table; opt->longName || opt->shortName || opt->arg; opt++) {
if (poptArgType(opt) != POPT_ARG_INCLUDE_TABLE)
continue;
sub_transdom = getTableTranslationDomain(opt->arg);
if (sub_transdom == NULL)
sub_transdom = translation_domain;
/* If no popt aliases/execs, skip poptAliasOption processing. */
if (opt->arg == poptAliasOptions && !(con->numAliases || con->numExecs))
continue;
if (opt->descrip) {
POPT_fprintf(fp, "\n%s\n", D_(sub_transdom, opt->descrip)); /* XXX: unchecked */
}
singleTableHelp(con, fp, opt->arg, columns, sub_transdom);
}
}
/**
* @param con context
* @param fp output file handle
*/
static size_t showHelpIntro(poptContext con, FILE * fp)
/*@globals fileSystem @*/
/*@modifies fp, fileSystem @*/
{
size_t len = (size_t)6;
POPT_fprintf(fp, POPT_("Usage:"));
if (!(con->flags & POPT_CONTEXT_KEEP_FIRST)) {
struct optionStackEntry * os = con->optionStack;
const char * fn = (os->argv ? os->argv[0] : NULL);
if (fn == NULL) return len;
if (strchr(fn, '/')) fn = strrchr(fn, '/') + 1;
if (fn[0] == 'l' && fn[1] == 't' && fn[2] == '-')
fn += sizeof("lt-") - 1;
/* XXX POPT_fprintf not needed for argv[0] display. */
fprintf(fp, " %s", fn);
len += strlen(fn) + 1;
}
return len;
}
void poptPrintHelp(poptContext con, FILE * fp, /*@unused@*/ UNUSED(int flags))
{
columns_t columns = (columns_t) xcalloc((size_t)1, sizeof(*columns));
assert(columns); /* XXX can't happen */
(void) showHelpIntro(con, fp);
if (con->otherHelp)
POPT_fprintf(fp, " %s\n", con->otherHelp);
else
POPT_fprintf(fp, " %s\n", POPT_("[OPTION...]"));
if (columns) {
columns->cur = maxArgWidth(con->options, NULL);
columns->max = maxColumnWidth(fp);
singleTableHelp(con, fp, con->options, columns, NULL);
free(columns);
}
}
/**
* Display usage text for an option.
* @param fp output file handle
* @param columns output display width control
* @param opt option(s)
* @param translation_domain translation domain
*/
static size_t singleOptionUsage(FILE * fp, columns_t columns,
const struct poptOption * opt,
/*@null@*/ const char *translation_domain)
/*@globals fileSystem @*/
/*@modifies fp, columns->cur, fileSystem @*/
{
size_t len = sizeof(" []")-1;
const char * argDescrip = getArgDescrip(opt, translation_domain);
/* Display shortName iff printable non-space. */
int prtshort = (int)(isprint((int)opt->shortName) && opt->shortName != ' ');
#define prtlong (opt->longName != NULL) /* XXX splint needs a clue */
if (!(prtshort || prtlong))
return columns->cur;
len = sizeof(" []")-1;
if (prtshort)
len += sizeof("-c")-1;
if (prtlong) {
if (prtshort) len += sizeof("|")-1;
len += (F_ISSET(opt, ONEDASH) ? sizeof("-") : sizeof("--")) - 1;
len += strlen(opt->longName);
}
if (argDescrip) {
/* XXX argDescrip[0] determines "--foo=bar" or "--foo bar". */
if (!strchr(" =(", argDescrip[0])) len += sizeof("=")-1;
/* Adjust for (possible) wide characters. */
len += stringDisplayWidth(argDescrip);
}
if ((columns->cur + len) > columns->max) {
fprintf(fp, "\n ");
columns->cur = (size_t)7;
}
fprintf(fp, " [");
if (prtshort)
fprintf(fp, "-%c", opt->shortName);
if (prtlong)
fprintf(fp, "%s%s%s",
(prtshort ? "|" : ""),
(F_ISSET(opt, ONEDASH) ? "-" : "--"),
opt->longName);
#undef prtlong
if (argDescrip) {
/* XXX argDescrip[0] determines "--foo=bar" or "--foo bar". */
if (!strchr(" =(", argDescrip[0])) fprintf(fp, "=");
fprintf(fp, "%s", argDescrip);
}
fprintf(fp, "]");
return columns->cur + len + 1;
}
/**
* Display popt alias and exec usage.
* @param fp output file handle
* @param columns output display width control
* @param item alias/exec array
* @param nitems no. of ara/exec entries
* @param translation_domain translation domain
*/
static size_t itemUsage(FILE * fp, columns_t columns,
/*@null@*/ poptItem item, int nitems,
/*@null@*/ const char * translation_domain)
/*@globals fileSystem @*/
/*@modifies fp, columns->cur, fileSystem @*/
{
if (item != NULL) {
int i;
for (i = 0; i < nitems; i++, item++) {
const struct poptOption * opt;
opt = &item->option;
if (poptArgType(opt) == POPT_ARG_INTL_DOMAIN) {
translation_domain = (const char *)opt->arg;
} else
if ((opt->longName || opt->shortName) && !F_ISSET(opt, DOC_HIDDEN)) {
columns->cur = singleOptionUsage(fp, columns, opt, translation_domain);
}
}
}
return columns->cur;
}
/**
* Keep track of option tables already processed.
*/
typedef struct poptDone_s {
int nopts;
int maxopts;
/*@null@*/
const void ** opts;
} * poptDone;
/**
* Display usage text for a table of options.
* @param con context
* @param fp output file handle
* @param columns output display width control
* @param opt option(s)
* @param translation_domain translation domain
* @param done tables already processed
* @return
*/
static size_t singleTableUsage(poptContext con, FILE * fp, columns_t columns,
/*@null@*/ const struct poptOption * opt,
/*@null@*/ const char * translation_domain,
/*@null@*/ poptDone done)
/*@globals fileSystem @*/
/*@modifies fp, columns->cur, done, fileSystem @*/
{
if (opt != NULL)
for (; (opt->longName || opt->shortName || opt->arg) ; opt++) {
if (poptArgType(opt) == POPT_ARG_INTL_DOMAIN) {
translation_domain = (const char *)opt->arg;
} else
if (poptArgType(opt) == POPT_ARG_INCLUDE_TABLE) {
if (done) {
int i = 0;
if (done->opts != NULL)
for (i = 0; i < done->nopts; i++) {
const void * that = done->opts[i];
if (that == NULL || that != opt->arg)
/*@innercontinue@*/ continue;
/*@innerbreak@*/ break;
}
/* Skip if this table has already been processed. */
if (opt->arg == NULL || i < done->nopts)
continue;
if (done->opts != NULL && done->nopts < done->maxopts)
done->opts[done->nopts++] = (const void *) opt->arg;
}
columns->cur = singleTableUsage(con, fp, columns, opt->arg,
translation_domain, done);
} else
if ((opt->longName || opt->shortName) && !F_ISSET(opt, DOC_HIDDEN)) {
columns->cur = singleOptionUsage(fp, columns, opt, translation_domain);
}
}
return columns->cur;
}
/**
* Return concatenated short options for display.
* @todo Sub-tables should be recursed.
* @param opt option(s)
* @param fp output file handle
* @retval str concatenation of short options
* @return length of display string
*/
static size_t showShortOptions(const struct poptOption * opt, FILE * fp,
/*@null@*/ char * str)
/*@globals fileSystem @*/
/*@modifies str, *fp, fileSystem @*/
/*@requires maxRead(str) >= 0 @*/
{
/* bufsize larger then the ascii set, lazy allocation on top level call. */
size_t nb = (size_t)300;
char * s = (str != NULL ? str : (char*) calloc((size_t)1, nb));
size_t len = (size_t)0;
assert(s); /* XXX can't happen */
if (s == NULL)
return 0;
if (opt != NULL)
for (; (opt->longName || opt->shortName || opt->arg); opt++) {
if (!F_ISSET(opt, DOC_HIDDEN) && opt->shortName && !poptArgType(opt))
{
/* Display shortName iff unique printable non-space. */
if (!strchr(s, opt->shortName) && isprint((int)opt->shortName)
&& opt->shortName != ' ')
s[strlen(s)] = opt->shortName;
} else if (poptArgType(opt) == POPT_ARG_INCLUDE_TABLE)
if (opt->arg) /* XXX program error */
len = showShortOptions(opt->arg, fp, s);
}
/* On return to top level, print the short options, return print length. */
if (s != str && *s != '\0') {
fprintf(fp, " [-%s]", s);
len = strlen(s) + sizeof(" [-]")-1;
}
/*@-temptrans@*/ /* LCL: local s, not str arg, is being freed. */
if (s != str)
free(s);
/*@=temptrans@*/
return len;
}
void poptPrintUsage(poptContext con, FILE * fp, /*@unused@*/ UNUSED(int flags))
{
columns_t columns = (columns_t) xcalloc((size_t)1, sizeof(*columns));
struct poptDone_s done_buf;
poptDone done = &done_buf;
assert(columns); /* XXX can't happen */
memset(done, 0, sizeof(*done));
done->nopts = 0;
done->maxopts = 64;
if (columns) {
columns->cur = done->maxopts * sizeof(*done->opts);
columns->max = maxColumnWidth(fp);
done->opts = (const void**) xcalloc((size_t)1, columns->cur);
assert(done->opts); /* XXX can't happen */
/*@-keeptrans@*/
if (done->opts != NULL)
done->opts[done->nopts++] = (const void *) con->options;
/*@=keeptrans@*/
columns->cur = showHelpIntro(con, fp);
columns->cur += showShortOptions(con->options, fp, NULL);
columns->cur = singleTableUsage(con, fp, columns, con->options, NULL, done);
columns->cur = itemUsage(fp, columns, con->aliases, con->numAliases, NULL);
columns->cur = itemUsage(fp, columns, con->execs, con->numExecs, NULL);
if (con->otherHelp) {
columns->cur += strlen(con->otherHelp) + 1;
if (columns->cur > columns->max) fprintf(fp, "\n ");
fprintf(fp, " %s", con->otherHelp);
}
fprintf(fp, "\n");
if (done->opts != NULL)
free(done->opts);
free(columns);
}
}
void poptSetOtherOptionHelp(poptContext con, const char * text)
{
con->otherHelp = _free(con->otherHelp);
con->otherHelp = xstrdup(text);
}
Something went wrong with that request. Please try again.