ngspice/src/frontend/misccoms.c

379 lines
9.9 KiB
C

/**********
Copyright 1990 Regents of the University of California. All rights reserved.
Author: 1985 Wayne A. Christopher, U. C. Berkeley CAD Group
**********/
#include "../misc/ivars.h"
#include "circuits.h"
#include "com_alias.h"
#include "define.h"
#include "display.h"
#include "ftehelp.h"
#include "misccoms.h"
#include "ngspice/ngspice.h"
#include "ngspice/cpdefs.h"
#include "ngspice/ftedefs.h"
#include "ngspice/dvec.h"
#include "ngspice/iferrmsg.h"
#include "ngspice/hlpdefs.h"
#include "plotting/graf.h"
#include "plotting/plotit.h"
#include "postcoms.h"
#include "runcoms2.h"
#include "variable.h"
#include "com_unset.h"
#ifndef SHARED_MODULE
#ifdef HAVE_GNUREADLINE
#include <readline/readline.h>
#include <readline/history.h>
extern char history_file[];
#endif
#ifdef HAVE_BSDEDITLINE
#include <editline/readline.h>
extern char history_file[];
#endif
#endif
#ifdef SHARED_MODULE
extern void rem_controls(void);
extern void destroy_wallace(void);
extern void sh_delete_myvec(void);
#endif
extern IFsimulator SIMinfo;
extern void spice_destroy_devices(void); /* FIXME need a better place */
static void byemesg(void);
static int confirm_quit(void);
void
com_quit(wordlist *wl)
{
int exitcode = EXIT_NORMAL;
bool noask =
(wl && wl->wl_word && 1 == sscanf(wl->wl_word, "%d", &exitcode)) ||
(wl && wl->wl_word && cieq(wl->wl_word, "noask")) ||
!cp_getvar("askquit", CP_BOOL, NULL, 0);
/* Update screen. */
gr_clean();
/* Make sure the guy really wants to quit. */
if (!ft_nutmeg)
if (!noask && !confirm_quit())
return;
/* start to clean up the mess */
#ifdef SHARED_MODULE
{
wordlist all = { "all", NULL, NULL };
wordlist star = { "*", NULL, NULL };
com_destroy(&all);
com_unalias(&star);
com_undefine(&star);
cp_remvar("history");
cp_remvar("noglob");
cp_remvar("brief");
cp_remvar("sourcepath");
cp_remvar("program");
cp_remvar("prompt");
destroy_wallace();
}
rem_controls();
/* Destroy CKT when quit. */
if (!ft_nutmeg) {
while (ft_curckt) {
wl_delete(ft_curckt->ci_sourceinfo);
com_remcirc(NULL);
}
}
cp_destroy_keywords();
destroy_ivars();
#else
/* remove plotting parameters */
pl_rempar();
while (ft_curckt) {
// wl_delete(ft_curckt->ci_sourceinfo);
com_remcirc(NULL);
}
#endif
tfree(errMsg);
byemesg();
#ifdef SHARED_MODULE
destroy_const_plot();
spice_destroy_devices();
unset_all();
cp_resetcontrol(FALSE);
sh_delete_myvec();
/* add 1000 to notify that we exit from 'quit' */
controlled_exit(1000 + exitcode);
#else
exit(exitcode);
#endif
}
#ifdef SYSTEM_MAIL
void
com_bug(wordlist *wl)
{
char buf[BSIZE_SP];
NG_IGNORE(wl);
if (!Bug_Addr || !*Bug_Addr) {
fprintf(cp_err, "Error: No address to send bug reports to.\n");
return;
}
fprintf(cp_out,
"Calling the mail program . . .(sending to %s)\n\n"
"Please include the OS version number and machine architecture.\n"
"If the problem is with a specific circuit, please include the\n"
"input file.\n",
Bug_Addr);
(void) sprintf(buf, SYSTEM_MAIL, ft_sim->simulator, ft_sim->version, Bug_Addr);
if (system(buf) == -1) {
fprintf(cp_err, "Bug report could not be sent: \"%s\" failed.\n",
buf);
}
fprintf(cp_out, "Bug report sent. Thank you.\n");
}
#else
void
com_bug(wordlist *wl)
{
NG_IGNORE(wl);
fprintf(cp_out,
"Please use the ngspice bug tracker at:\n"
"https://sourceforge.net/p/ngspice/bugs/\n");
}
#endif
/* printout upon startup or 'version' command. options to version are -s (short),
-f (full), -v (just version), -d (just compile date).
'version' with options may also be used in ngspice pipe mode. */
void
com_version(wordlist *wl)
{
if (!wl) {
/* no printout in pipe mode (-p) */
if (ft_pipemode)
return;
fprintf(cp_out,
"******\n"
"** %s-%s : %s\n"
#ifdef KLU
"** Compiled with KLU Direct Linear Solver\n"
#else
"** Compiled with Sparse Direct Linear Solver\n"
#endif
"** The U. C. Berkeley CAD Group\n"
"** Copyright 1985-1994, Regents of the University of California.\n"
"** Copyright 2001-2025, The ngspice team.\n"
"** %s\n",
ft_sim->simulator, ft_sim->version, ft_sim->description, Spice_Manual);
if (*Spice_Notice != '\0')
fprintf(cp_out, "** %s\n", Spice_Notice);
if (*Spice_Build_Date != '\0')
fprintf(cp_out, "** Creation Date: %s\n", Spice_Build_Date);
fprintf(cp_out, "******\n");
} else {
char *s = wl_flatten(wl);
if (!strncasecmp(s, "-s", 2)) {
fprintf(cp_out,
"******\n"
"** %s-%s\n"
"** %s\n",
ft_sim->simulator, ft_sim->version, Spice_Manual);
if (*Spice_Notice != '\0')
fprintf(cp_out, "** %s\n", Spice_Notice);
if (*Spice_Build_Date != '\0')
fprintf(cp_out, "** Creation Date: %s\n", Spice_Build_Date);
fprintf(cp_out, "******\n");
} else if (!strncasecmp(s, "-v", 2)) {
fprintf(cp_out, "%s-%s\n",ft_sim->simulator, ft_sim->version);
} else if (!strncasecmp(s, "-d", 2) && *Spice_Build_Date != '\0'){
fprintf(cp_out, "%s\n", Spice_Build_Date);
} else if (!strncasecmp(s, "-f", 2)) {
fprintf(cp_out,
"******\n"
"** %s-%s : %s\n"
#ifdef KLU
"** Compiled with KLU Direct Linear Solver\n"
#else
"** Compiled with Sparse Direct Linear Solver\n"
#endif
"** The U. C. Berkeley CAD Group\n"
"** Copyright 1985-1994, Regents of the University of California.\n"
"** Copyright 2001-2025, The ngspice team.\n"
"** %s\n",
ft_sim->simulator, ft_sim->version, ft_sim->description, Spice_Manual);
if (*Spice_Notice != '\0')
fprintf(cp_out, "** %s\n", Spice_Notice);
if (*Spice_Build_Date != '\0')
fprintf(cp_out, "** Creation Date: %s\n", Spice_Build_Date);
fprintf(cp_out, "**\n");
#ifdef CIDER
fprintf(cp_out, "** CIDER 1.b1 (CODECS simulator) included\n");
#endif
#ifdef XSPICE
fprintf(cp_out, "** XSPICE extensions included\n");
#endif
fprintf(cp_out, "** Relevant compilation options (refer to user's manual):\n");
#ifdef NGDEBUG
fprintf(cp_out, "** Debugging option (-g) enabled\n");
#endif
#ifdef USE_OMP
fprintf(cp_out, "** OpenMP multithreading for BSIM3, BSIM4 enabled\n");
#endif
#if defined(X_DISPLAY_MISSING) && !defined(HAS_WINGUI)
fprintf(cp_out, "** X11 interface not compiled into ngspice\n");
#endif
#ifdef NOBYPASS
fprintf(cp_out, "** --enable-nobypass\n");
#endif
#ifdef CAPBYPASS
fprintf(cp_out, "** --enable-capbypass\n");
#endif
#ifdef NODELIMITING
fprintf(cp_out, "** --enable-nodelimiting\n");
#endif
#ifdef PREDICTOR
fprintf(cp_out, "** --enable-predictor\n");
#endif
#ifdef NEWTRUNC
fprintf(cp_out, "** --enable-newtrunc\n");
#endif
#ifdef WANT_SENSE2
fprintf(cp_out, "** --enable-sense2\n");
#endif
fprintf(cp_out, "**\n");
#ifdef EXPERIMENTAL_CODE
fprintf(cp_out, "** Experimental code enabled.\n");
#endif
#ifdef EXP_DEV
fprintf(cp_out, "** Experimental devices enabled.\n");
#endif
#ifdef SHARED_MODULE
fprintf(cp_out, "** ngspice shared library.\n");
#endif
fprintf(cp_out, "******\n");
} else if (!eq(ft_sim->version, s)) {
fprintf(stderr,
"Note: rawfile is version %s (current version is %s)\n",
wl->wl_word, ft_sim->version);
}
tfree(s);
}
}
static void
byemesg(void)
{
#ifndef SHARED_MODULE
#if defined(HAVE_GNUREADLINE) || defined(HAVE_BSDEDITLINE)
/* write out command history only when saying goodbye. */
if (cp_interactive && (cp_maxhistlength > 0)) {
stifle_history(cp_maxhistlength);
write_history(history_file);
}
#endif
#endif
printf("%s-%s done\n", ft_sim->simulator, ft_sim->version);
}
static int
confirm_quit(void)
{
struct circ *cc;
struct plot *pl;
int ncc = 0, npl = 0;
char buf[64];
for (cc = ft_circuits; cc; cc = cc->ci_next)
if (cc->ci_inprogress)
ncc++;
for (pl = plot_list; pl; pl = pl->pl_next)
if (!pl->pl_written && pl->pl_dvecs)
npl++;
if (!ncc && !npl)
return 1;
fprintf(cp_out, "Warning: ");
if (ncc) {
fprintf(cp_out,
"the following simulation%s still in progress:\n",
(ncc > 1) ? "s are" : " is");
for (cc = ft_circuits; cc; cc = cc->ci_next)
if (cc->ci_inprogress)
fprintf(cp_out, "\t%s\n", cc->ci_name);
}
if (ncc && npl)
fprintf(cp_out, "and ");
if (npl) {
fprintf(cp_out,
"the following plot%s been saved:\n",
(npl > 1) ? "s haven't" : " hasn't");
for (pl = plot_list; pl; pl = pl->pl_next)
if (!pl->pl_written && pl->pl_dvecs)
fprintf(cp_out, "%s\t%s, %s\n",
pl->pl_typename, pl->pl_title, pl->pl_name);
}
fprintf(cp_out, "\nAre you sure you want to quit (yes)? ");
(void) fflush(cp_out);
if (!fgets(buf, sizeof(buf), stdin)) {
clearerr(stdin);
*buf = 'y';
}
return ((*buf == 'y') || (*buf == 'Y') || (*buf == '\n'));
}