added a way to add more functions to ginsh in the file ginsh_extensions.h
authorChristian Bauer <Christian.Bauer@uni-mainz.de>
Fri, 22 Jun 2001 22:02:28 +0000 (22:02 +0000)
committerChristian Bauer <Christian.Bauer@uni-mainz.de>
Fri, 22 Jun 2001 22:02:28 +0000 (22:02 +0000)
(this is used by the xloops-variant of ginsh)

ginsh/ginsh_extensions.h [new file with mode: 0644]
ginsh/ginsh_parser.yy

diff --git a/ginsh/ginsh_extensions.h b/ginsh/ginsh_extensions.h
new file mode 100644 (file)
index 0000000..a517aff
--- /dev/null
@@ -0,0 +1,33 @@
+/** @file ginsh_extensions.h
+ *
+ *  The contents of this file are included in the ginsh parser. This makes
+ *  it possible to create customized versions of ginsh that add special
+ *  functions. */
+
+/*
+ *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+// Table of names and descriptors of functions to be added
+static const fcn_init extended_fcns[] = {
+       {NULL, fcn_desc(f_dummy, 0)} // End marker
+};
+
+// Table of help strings for functions
+static const fcn_help_init extended_help[] = {
+       {NULL, NULL} // End marker
+};
index 5fc99fd..10383e8 100644 (file)
@@ -82,6 +82,7 @@ static fcn_tab::const_iterator find_function(const ex &sym, int req_params);
 typedef multimap<string, string> help_tab;
 static help_tab help;
 
+static void insert_fcn_help(const char *name, const char *str);
 static void print_help(const string &topic);
 static void print_help_topics(void);
 %}
@@ -483,7 +484,7 @@ static ex f_dummy(const exprseq &e)
        throw(std::logic_error("dummy function called (shouldn't happen)"));
 }
 
-// Table for initializing the "fcns" map
+// Tables for initializing the "fcns" map and the function help topics
 struct fcn_init {
        const char *name;
        const fcn_desc desc;
@@ -544,6 +545,43 @@ static const fcn_init builtin_fcns[] = {
        {NULL, fcn_desc(f_dummy, 0)}    // End marker
 };
 
+struct fcn_help_init {
+       const char *name;
+       const char *help;
+};
+
+static const fcn_help_init builtin_help[] = {
+       {"acos", "inverse cosine function"},
+       {"acosh", "inverse hyperbolic cosine function"},
+       {"asin", "inverse sine function"},
+       {"asinh", "inverse hyperbolic sine function"},
+       {"atan", "inverse tangent function"},
+       {"atan2", "inverse tangent function with two arguments"},
+       {"atanh", "inverse hyperbolic tangent function"},
+       {"beta", "Beta function"},
+       {"binomial", "binomial function"},
+       {"cos", "cosine function"},
+       {"cosh", "hyperbolic cosine function"},
+       {"exp", "exponential function"},
+       {"factorial", "factorial function"},
+       {"lgamma", "natural logarithm of Gamma function"},
+       {"tgamma", "Gamma function"},
+       {"log", "natural logarithm"},
+       {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
+       {"sin", "sine function"},
+       {"sinh", "hyperbolic sine function"},
+       {"tan", "tangent function"},
+       {"tanh", "hyperbolic tangent function"},
+       {"zeta", "zeta function\nzeta(x) is Riemann's zeta function, zeta(n,x) its nth derivative"},
+       {"Li2", "dilogarithm"},
+       {"Li3", "trilogarithm"},
+       {"Order", "order term function (for truncated power series)"},
+       {"Derivative", "inert differential operator"},
+       {NULL, NULL}    // End marker
+};
+
+#include "ginsh_extensions.h"
+
 
 /*
  *  Add functions to ginsh
@@ -624,6 +662,15 @@ static void insert_fcn_help(const char *name, const char *str)
        }
 }
 
+// Help strings for functions from fcn_help_init array
+static void insert_help(const fcn_help_init *p)
+{
+       while (p->name) {
+               insert_fcn_help(p->name, p->help);
+               p++;
+       }
+}
+
 
 /*
  *  Print help to cout
@@ -735,6 +782,7 @@ int main(int argc, char **argv)
 
        // Init function table
        insert_fcns(builtin_fcns);
+       insert_fcns(extended_fcns);
        ginsh_get_ginac_functions();
 
        // Init help for operators (automatically generated from man page)
@@ -745,31 +793,8 @@ int main(int argc, char **argv)
 #include "ginsh_fcn_help.c"
 
        // Help for GiNaC functions is added manually
-       insert_fcn_help("acos", "inverse cosine function");
-       insert_fcn_help("acosh", "inverse hyperbolic cosine function");
-       insert_fcn_help("asin", "inverse sine function");
-       insert_fcn_help("asinh", "inverse hyperbolic sine function");
-       insert_fcn_help("atan", "inverse tangent function");
-       insert_fcn_help("atan2", "inverse tangent function with two arguments");
-       insert_fcn_help("atanh", "inverse hyperbolic tangent function");
-       insert_fcn_help("beta", "Beta function");
-       insert_fcn_help("binomial", "binomial function");
-       insert_fcn_help("cos", "cosine function");
-       insert_fcn_help("cosh", "hyperbolic cosine function");
-       insert_fcn_help("exp", "exponential function");
-       insert_fcn_help("factorial", "factorial function");
-       insert_fcn_help("lgamma", "natural logarithm of Gamma function");
-       insert_fcn_help("tgamma", "Gamma function");
-       insert_fcn_help("log", "natural logarithm");
-       insert_fcn_help("psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function");
-       insert_fcn_help("sin", "sine function");
-       insert_fcn_help("sinh", "hyperbolic sine function");
-       insert_fcn_help("tan", "tangent function");
-       insert_fcn_help("tanh", "hyperbolic tangent function");
-       insert_fcn_help("zeta", "zeta function\nzeta(x) is Riemann's zeta function, zeta(n,x) its nth derivative");
-       insert_fcn_help("Li2", "dilogarithm");
-       insert_fcn_help("Li3", "trilogarithm");
-       insert_fcn_help("Order", "order term function (for truncated power series)");
+       insert_help(builtin_help);
+       insert_help(extended_help);
 
        // Init readline completer
        rl_readline_name = argv[0];