ngspice/src/frontend/com_help.c

120 lines
3.6 KiB
C

#include "ngspice/ngspice.h"
#include "ngspice/macros.h"
#include "ngspice/wordlist.h"
#include "ngspice/cpdefs.h"
#include "ngspice/bool.h"
#include "hcomp.h"
#include "com_help.h"
#include "ngspice/fteext.h"
#define N_CMD_DFLT 512
void com_help(wordlist *wl)
{
bool allflag = FALSE;
/* Make empty list and "all" behave the same except for the part
* related to "help all" */
if (wl && eq(wl->wl_word, "all")) {
allflag = TRUE;
wl = (wordlist *) NULL;
}
/* We want to use more mode whether "moremode" is set or not.
* In that case the code below should be changed... */
out_moremode = TRUE;
out_init();
out_moremode = FALSE;
if (wl == NULL) {
struct comm *ccc_dflt[N_CMD_DFLT]; /* Should be enough. */
struct comm **ccc; /* dynamic alloc in case it is not */
int numcoms;
if (!allflag) {
out_printf("For a list of all commands "
"type \"help all\", for a short\n"
"description of \"command\", "
"type \"help command\".\n");
return;
}
/* Count the number of commands */
for (numcoms = 0; cp_coms[numcoms].co_func != NULL; numcoms++) {
;
}
if (numcoms > N_CMD_DFLT) {
ccc = TMALLOC(struct comm *, numcoms);
}
else {
ccc = ccc_dflt;
}
/* Sort the commands */
for (numcoms = 0; cp_coms[numcoms].co_func != NULL; numcoms++) {
ccc[numcoms] = &cp_coms[numcoms];
}
qsort(ccc, (size_t) numcoms, sizeof(struct comm *), hcomp);
/* Print help for each of the "major" commands */
{
int i;
for (i = 0; i < numcoms; i++) {
if ((ccc[i]->co_spiceonly && ft_nutmeg) ||
(ccc[i]->co_help == NULL) ||
(!allflag && !ccc[i]->co_major)) {
continue;
}
out_printf("%s ", ccc[i]->co_comname);
out_printf(ccc[i]->co_help, cp_program);
out_send("\n");
}
}
/* Free allocation if it was required */
if (ccc != ccc_dflt) {
txfree(ccc);
}
}
else {
while (wl != NULL) {
struct comm *c;
for (c = &cp_coms[0]; c->co_func != NULL; c++)
if (eq(wl->wl_word, c->co_comname)) {
out_printf("%s ", c->co_comname);
out_printf(c->co_help, cp_program);
if (c->co_spiceonly && ft_nutmeg)
out_send(" (Not available in nutmeg)");
out_send("\n");
break;
}
if (c->co_func == NULL) {
/* See if this is aliased. */
struct alias *al;
for (al = cp_aliases; al; al = al->al_next)
if (eq(al->al_name, wl->wl_word))
break;
if (al == NULL) {
fprintf(cp_out, "Sorry, no help for %s.\n", wl->wl_word);
}
else {
out_printf("%s is aliased to ", wl->wl_word);
/* Minor badness here... */
wl_print(al->al_text, cp_out);
out_send("\n");
}
} /* end of case that a function with the given name was found */
wl = wl->wl_next; /* step to next word in list of help items */
} /* end of loop over list of help items */
}
out_send("\n");
} /* end of function com_help */