513 lines
14 KiB
C
513 lines
14 KiB
C
|
|
/*
|
|
* $Id: enumeration.c,v 4.26 2009/08/01 17:43:06 bkorb Exp $
|
|
* Time-stamp: "2008-07-27 12:28:01 bkorb"
|
|
*
|
|
* Automated Options Paged Usage module.
|
|
*
|
|
* This routine will run run-on options through a pager so the
|
|
* user may examine, print or edit them at their leisure.
|
|
*
|
|
* This file is part of AutoOpts, a companion to AutoGen.
|
|
* AutoOpts is free software.
|
|
* AutoOpts is copyright (c) 1992-2009 by Bruce Korb - all rights reserved
|
|
*
|
|
* AutoOpts is available under any one of two licenses. The license
|
|
* in use must be one of these two and the choice is under the control
|
|
* of the user of the license.
|
|
*
|
|
* The GNU Lesser General Public License, version 3 or later
|
|
* See the files "COPYING.lgplv3" and "COPYING.gplv3"
|
|
*
|
|
* The Modified Berkeley Software Distribution License
|
|
* See the file "COPYING.mbsd"
|
|
*
|
|
* These files have the following md5sums:
|
|
*
|
|
* 43b91e8ca915626ed3818ffb1b71248b pkg/libopts/COPYING.gplv3
|
|
* 06a1a2e4760c90ea5e1dad8dfaac4d39 pkg/libopts/COPYING.lgplv3
|
|
* 66a5cedaf62c4b2637025f049f9b826f pkg/libopts/COPYING.mbsd
|
|
*/
|
|
|
|
tSCC* pz_enum_err_fmt;
|
|
|
|
/* = = = START-STATIC-FORWARD = = = */
|
|
/* static forward declarations maintained by mk-fwd */
|
|
static void
|
|
enumError(
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC* const * paz_names,
|
|
int name_ct );
|
|
|
|
static uintptr_t
|
|
findName(
|
|
tCC* pzName,
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC* const * paz_names,
|
|
unsigned int name_ct );
|
|
/* = = = END-STATIC-FORWARD = = = */
|
|
|
|
static void
|
|
enumError(
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC* const * paz_names,
|
|
int name_ct )
|
|
{
|
|
size_t max_len = 0;
|
|
size_t ttl_len = 0;
|
|
int ct_down = name_ct;
|
|
int hidden = 0;
|
|
|
|
/*
|
|
* A real "pOpts" pointer means someone messed up. Give a real error.
|
|
*/
|
|
if (pOpts > OPTPROC_EMIT_LIMIT)
|
|
fprintf(option_usage_fp, pz_enum_err_fmt, pOpts->pzProgName,
|
|
pOD->optArg.argString, pOD->pz_Name);
|
|
|
|
fprintf(option_usage_fp, zValidKeys, pOD->pz_Name);
|
|
|
|
/*
|
|
* If the first name starts with this funny character, then we have
|
|
* a first value with an unspellable name. You cannot specify it.
|
|
* So, we don't list it either.
|
|
*/
|
|
if (**paz_names == 0x7F) {
|
|
paz_names++;
|
|
hidden = 1;
|
|
ct_down = --name_ct;
|
|
}
|
|
|
|
/*
|
|
* Figure out the maximum length of any name, plus the total length
|
|
* of all the names.
|
|
*/
|
|
{
|
|
tCC * const * paz = paz_names;
|
|
|
|
do {
|
|
size_t len = strlen( *(paz++) ) + 1;
|
|
if (len > max_len)
|
|
max_len = len;
|
|
ttl_len += len;
|
|
} while (--ct_down > 0);
|
|
|
|
ct_down = name_ct;
|
|
}
|
|
|
|
/*
|
|
* IF any one entry is about 1/2 line or longer, print one per line
|
|
*/
|
|
if (max_len > 35) {
|
|
do {
|
|
fprintf( option_usage_fp, " %s\n", *(paz_names++) );
|
|
} while (--ct_down > 0);
|
|
}
|
|
|
|
/*
|
|
* ELSE IF they all fit on one line, then do so.
|
|
*/
|
|
else if (ttl_len < 76) {
|
|
fputc( ' ', option_usage_fp );
|
|
do {
|
|
fputc( ' ', option_usage_fp );
|
|
fputs( *(paz_names++), option_usage_fp );
|
|
} while (--ct_down > 0);
|
|
fputc( '\n', option_usage_fp );
|
|
}
|
|
|
|
/*
|
|
* Otherwise, columnize the output
|
|
*/
|
|
else {
|
|
int ent_no = 0;
|
|
char zFmt[16]; /* format for all-but-last entries on a line */
|
|
|
|
sprintf( zFmt, "%%-%ds", (int)max_len );
|
|
max_len = 78 / max_len; /* max_len is now max entries on a line */
|
|
fputs( " ", option_usage_fp );
|
|
|
|
/*
|
|
* Loop through all but the last entry
|
|
*/
|
|
ct_down = name_ct;
|
|
while (--ct_down > 0) {
|
|
if (++ent_no == max_len) {
|
|
/*
|
|
* Last entry on a line. Start next line, too.
|
|
*/
|
|
fprintf( option_usage_fp, "%s\n ", *(paz_names++) );
|
|
ent_no = 0;
|
|
}
|
|
|
|
else
|
|
fprintf(option_usage_fp, zFmt, *(paz_names++) );
|
|
}
|
|
fprintf(option_usage_fp, "%s\n", *paz_names);
|
|
}
|
|
|
|
if (pOpts > OPTPROC_EMIT_LIMIT) {
|
|
fprintf(option_usage_fp, zIntRange, hidden, name_ct - 1 + hidden);
|
|
|
|
(*(pOpts->pUsageProc))( pOpts, EXIT_FAILURE );
|
|
/* NOTREACHED */
|
|
}
|
|
|
|
|
|
if (OPTST_GET_ARGTYPE(pOD->fOptState) == OPARG_TYPE_MEMBERSHIP) {
|
|
fprintf(option_usage_fp, zLowerBits, name_ct);
|
|
fputs(zSetMemberSettings, option_usage_fp);
|
|
} else {
|
|
fprintf(option_usage_fp, zIntRange, hidden, name_ct - 1 + hidden);
|
|
}
|
|
}
|
|
|
|
|
|
static uintptr_t
|
|
findName(
|
|
tCC* pzName,
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC* const * paz_names,
|
|
unsigned int name_ct )
|
|
{
|
|
/*
|
|
* Return the matching index as a pointer sized integer.
|
|
* The result gets stashed in a char* pointer.
|
|
*/
|
|
uintptr_t res = name_ct;
|
|
size_t len = strlen( (char*)pzName );
|
|
uintptr_t idx;
|
|
|
|
if (IS_DEC_DIGIT_CHAR(*pzName)) {
|
|
char * pz = (char *)(void *)pzName;
|
|
unsigned long val = strtoul(pz, &pz, 0);
|
|
if ((*pz == NUL) && (val < name_ct))
|
|
return (uintptr_t)val;
|
|
enumError(pOpts, pOD, paz_names, (int)name_ct);
|
|
return name_ct;
|
|
}
|
|
|
|
/*
|
|
* Look for an exact match, but remember any partial matches.
|
|
* Multiple partial matches means we have an ambiguous match.
|
|
*/
|
|
for (idx = 0; idx < name_ct; idx++) {
|
|
if (strncmp( (char*)paz_names[idx], (char*)pzName, len) == 0) {
|
|
if (paz_names[idx][len] == NUL)
|
|
return idx; /* full match */
|
|
|
|
res = (res != name_ct) ? ~0 : idx; /* save partial match */
|
|
}
|
|
}
|
|
|
|
if (res < name_ct)
|
|
return res; /* partial match */
|
|
|
|
pz_enum_err_fmt = (res == name_ct) ? zNoKey : zAmbigKey;
|
|
option_usage_fp = stderr;
|
|
enumError(pOpts, pOD, paz_names, (int)name_ct);
|
|
return name_ct;
|
|
}
|
|
|
|
|
|
/*=export_func optionKeywordName
|
|
* what: Convert between enumeration values and strings
|
|
* private:
|
|
*
|
|
* arg: tOptDesc*, pOD, enumeration option description
|
|
* arg: unsigned int, enum_val, the enumeration value to map
|
|
*
|
|
* ret_type: char const*
|
|
* ret_desc: the enumeration name from const memory
|
|
*
|
|
* doc: This converts an enumeration value into the matching string.
|
|
=*/
|
|
char const*
|
|
optionKeywordName(
|
|
tOptDesc* pOD,
|
|
unsigned int enum_val )
|
|
{
|
|
tOptDesc od;
|
|
|
|
od.optArg.argEnum = enum_val;
|
|
(*(pOD->pOptProc))(OPTPROC_RETURN_VALNAME, &od );
|
|
return od.optArg.argString;
|
|
}
|
|
|
|
|
|
/*=export_func optionEnumerationVal
|
|
* what: Convert from a string to an enumeration value
|
|
* private:
|
|
*
|
|
* arg: tOptions*, pOpts, the program options descriptor
|
|
* arg: tOptDesc*, pOD, enumeration option description
|
|
* arg: char const * const *, paz_names, list of enumeration names
|
|
* arg: unsigned int, name_ct, number of names in list
|
|
*
|
|
* ret_type: uintptr_t
|
|
* ret_desc: the enumeration value
|
|
*
|
|
* doc: This converts the optArg.argString string from the option description
|
|
* into the index corresponding to an entry in the name list.
|
|
* This will match the generated enumeration value.
|
|
* Full matches are always accepted. Partial matches are accepted
|
|
* if there is only one partial match.
|
|
=*/
|
|
uintptr_t
|
|
optionEnumerationVal(
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC * const * paz_names,
|
|
unsigned int name_ct )
|
|
{
|
|
uintptr_t res = 0UL;
|
|
|
|
/*
|
|
* IF the program option descriptor pointer is invalid,
|
|
* then it is some sort of special request.
|
|
*/
|
|
switch ((uintptr_t)pOpts) {
|
|
case (uintptr_t)OPTPROC_EMIT_USAGE:
|
|
/*
|
|
* print the list of enumeration names.
|
|
*/
|
|
enumError(pOpts, pOD, paz_names, (int)name_ct);
|
|
break;
|
|
|
|
case (uintptr_t)OPTPROC_EMIT_SHELL:
|
|
{
|
|
unsigned int ix = pOD->optArg.argEnum;
|
|
/*
|
|
* print the name string.
|
|
*/
|
|
if (ix >= name_ct)
|
|
printf( "INVALID-%d", ix );
|
|
else
|
|
fputs( paz_names[ ix ], stdout );
|
|
|
|
break;
|
|
}
|
|
|
|
case (uintptr_t)OPTPROC_RETURN_VALNAME:
|
|
{
|
|
tSCC zInval[] = "*INVALID*";
|
|
unsigned int ix = pOD->optArg.argEnum;
|
|
/*
|
|
* Replace the enumeration value with the name string.
|
|
*/
|
|
if (ix >= name_ct)
|
|
return (uintptr_t)zInval;
|
|
|
|
pOD->optArg.argString = paz_names[ix];
|
|
break;
|
|
}
|
|
|
|
default:
|
|
res = findName(pOD->optArg.argString, pOpts, pOD, paz_names, name_ct);
|
|
|
|
if (pOD->fOptState & OPTST_ALLOC_ARG) {
|
|
AGFREE(pOD->optArg.argString);
|
|
pOD->fOptState &= ~OPTST_ALLOC_ARG;
|
|
pOD->optArg.argString = NULL;
|
|
}
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
|
|
/*=export_func optionSetMembers
|
|
* what: Convert between bit flag values and strings
|
|
* private:
|
|
*
|
|
* arg: tOptions*, pOpts, the program options descriptor
|
|
* arg: tOptDesc*, pOD, enumeration option description
|
|
* arg: char const * const *,
|
|
* paz_names, list of enumeration names
|
|
* arg: unsigned int, name_ct, number of names in list
|
|
*
|
|
* doc: This converts the optArg.argString string from the option description
|
|
* into the index corresponding to an entry in the name list.
|
|
* This will match the generated enumeration value.
|
|
* Full matches are always accepted. Partial matches are accepted
|
|
* if there is only one partial match.
|
|
=*/
|
|
void
|
|
optionSetMembers(
|
|
tOptions* pOpts,
|
|
tOptDesc* pOD,
|
|
tCC* const * paz_names,
|
|
unsigned int name_ct )
|
|
{
|
|
/*
|
|
* IF the program option descriptor pointer is invalid,
|
|
* then it is some sort of special request.
|
|
*/
|
|
switch ((uintptr_t)pOpts) {
|
|
case (uintptr_t)OPTPROC_EMIT_USAGE:
|
|
/*
|
|
* print the list of enumeration names.
|
|
*/
|
|
enumError(OPTPROC_EMIT_USAGE, pOD, paz_names, (int)name_ct );
|
|
return;
|
|
|
|
case (uintptr_t)OPTPROC_EMIT_SHELL:
|
|
{
|
|
/*
|
|
* print the name string.
|
|
*/
|
|
int ix = 0;
|
|
uintptr_t bits = (uintptr_t)pOD->optCookie;
|
|
size_t len = 0;
|
|
|
|
bits &= ((uintptr_t)1 << (uintptr_t)name_ct) - (uintptr_t)1;
|
|
|
|
while (bits != 0) {
|
|
if (bits & 1) {
|
|
if (len++ > 0) fputs( " | ", stdout );
|
|
fputs(paz_names[ix], stdout);
|
|
}
|
|
if (++ix >= name_ct) break;
|
|
bits >>= 1;
|
|
}
|
|
return;
|
|
}
|
|
|
|
case (uintptr_t)OPTPROC_RETURN_VALNAME:
|
|
{
|
|
char* pz;
|
|
uintptr_t bits = (uintptr_t)pOD->optCookie;
|
|
int ix = 0;
|
|
size_t len = 5;
|
|
|
|
bits &= ((uintptr_t)1 << (uintptr_t)name_ct) - (uintptr_t)1;
|
|
|
|
/*
|
|
* Replace the enumeration value with the name string.
|
|
* First, determine the needed length, then allocate and fill in.
|
|
*/
|
|
while (bits != 0) {
|
|
if (bits & 1)
|
|
len += strlen( paz_names[ix]) + 8;
|
|
if (++ix >= name_ct) break;
|
|
bits >>= 1;
|
|
}
|
|
|
|
pOD->optArg.argString = pz = AGALOC(len, "enum name");
|
|
|
|
/*
|
|
* Start by clearing all the bits. We want to turn off any defaults
|
|
* because we will be restoring to current state, not adding to
|
|
* the default set of bits.
|
|
*/
|
|
strcpy( pz, "none" );
|
|
pz += 4;
|
|
bits = (uintptr_t)pOD->optCookie;
|
|
bits &= ((uintptr_t)1 << (uintptr_t)name_ct) - (uintptr_t)1;
|
|
ix = 0;
|
|
|
|
while (bits != 0) {
|
|
if (bits & 1) {
|
|
strcpy( pz, " + " );
|
|
strcpy( pz+3, paz_names[ix]);
|
|
pz += strlen( paz_names[ix]) + 3;
|
|
}
|
|
if (++ix >= name_ct) break;
|
|
bits >>= 1;
|
|
}
|
|
return;
|
|
}
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
if ((pOD->fOptState & OPTST_RESET) != 0)
|
|
return;
|
|
|
|
{
|
|
tCC* pzArg = pOD->optArg.argString;
|
|
uintptr_t res;
|
|
if ((pzArg == NULL) || (*pzArg == NUL)) {
|
|
pOD->optCookie = (void*)0;
|
|
return;
|
|
}
|
|
|
|
res = (uintptr_t)pOD->optCookie;
|
|
for (;;) {
|
|
tSCC zSpn[] = " ,|+\t\r\f\n";
|
|
int iv, len;
|
|
|
|
pzArg += strspn( pzArg, zSpn );
|
|
iv = (*pzArg == '!');
|
|
if (iv)
|
|
pzArg += strspn( pzArg+1, zSpn ) + 1;
|
|
|
|
len = strcspn( pzArg, zSpn );
|
|
if (len == 0)
|
|
break;
|
|
|
|
if ((len == 3) && (strncmp(pzArg, zAll, (size_t)3) == 0)) {
|
|
if (iv)
|
|
res = 0;
|
|
else res = ~0UL;
|
|
}
|
|
else if ((len == 4) && (strncmp(pzArg, zNone, (size_t)4) == 0)) {
|
|
if (! iv)
|
|
res = 0;
|
|
}
|
|
else do {
|
|
char* pz;
|
|
uintptr_t bit = strtoul( pzArg, &pz, 0 );
|
|
|
|
if (pz != pzArg + len) {
|
|
char z[ AO_NAME_SIZE ];
|
|
tCC* p;
|
|
int shift_ct;
|
|
|
|
if (*pz != NUL) {
|
|
if (len >= AO_NAME_LIMIT)
|
|
break;
|
|
strncpy( z, pzArg, (size_t)len );
|
|
z[len] = NUL;
|
|
p = z;
|
|
} else {
|
|
p = pzArg;
|
|
}
|
|
|
|
shift_ct = findName(p, pOpts, pOD, paz_names, name_ct);
|
|
if (shift_ct >= name_ct) {
|
|
pOD->optCookie = (void*)0;
|
|
return;
|
|
}
|
|
bit = 1UL << shift_ct;
|
|
}
|
|
if (iv)
|
|
res &= ~bit;
|
|
else res |= bit;
|
|
} while (0);
|
|
|
|
if (pzArg[len] == NUL)
|
|
break;
|
|
pzArg += len + 1;
|
|
}
|
|
if (name_ct < (8 * sizeof( uintptr_t ))) {
|
|
res &= (1UL << name_ct) - 1UL;
|
|
}
|
|
|
|
pOD->optCookie = (void*)res;
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Local Variables:
|
|
* mode: C
|
|
* c-file-style: "stroustrup"
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
* end of autoopts/enumeration.c */
|