1 /** @file ginsh_parser.ypp
3 * Input grammar definition for ginsh.
4 * This file must be processed with yacc/bison. */
7 * GiNaC Copyright (C) 1999-2016 Johannes Gutenberg University Mainz, Germany
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
34 #include <sys/resource.h>
40 #include <sys/types.h>
48 #define YYERROR_VERBOSE 1
50 #ifdef HAVE_LIBREADLINE
51 // Original readline settings
52 static int orig_completion_append_character;
53 static const char *orig_basic_word_break_characters;
55 #if (RL_VERSION_MAJOR >= 5)
56 #define GINAC_RL_COMPLETER_CAST(a) const_cast<char *>((a))
58 #define GINAC_RL_COMPLETER_CAST(a) (a)
60 #endif // HAVE_LIBREADLINE
62 // Expression stack for %, %% and %%%
63 static void push(const ex &e);
66 static exmap assigned_symbol_table;
68 // Start and end time for the time() function
70 static struct rusage start_time, end_time;
71 #define START_TIMER getrusage(RUSAGE_SELF, &start_time);
72 #define STOP_TIMER getrusage(RUSAGE_SELF, &end_time);
73 #define PRINT_TIME_USED cout << \
74 (end_time.ru_utime.tv_sec - start_time.ru_utime.tv_sec) + \
75 (end_time.ru_stime.tv_sec - start_time.ru_stime.tv_sec) + \
76 double(end_time.ru_utime.tv_usec - start_time.ru_utime.tv_usec) / 1e6 + \
77 double(end_time.ru_stime.tv_usec - start_time.ru_stime.tv_usec) / 1e6 \
80 static std::clock_t start_time, end_time;
81 #define START_TIMER start_time = std::clock();
82 #define STOP_TIMER end_time = std::clock();
83 #define PRINT_TIME_USED \
84 cout << double(end_time - start_time)/CLOCKS_PER_SEC << 's' << endl;
87 // Table of functions (a multimap, because one function may appear with different
88 // numbers of parameters)
89 typedef ex (*fcnp)(const exprseq &e);
90 typedef ex (*fcnp2)(const exprseq &e, int serial);
93 fcn_desc() : p(NULL), num_params(0), is_ginac(false), serial(0) {}
94 fcn_desc(fcnp func, int num) : p(func), num_params(num), is_ginac(false), serial(0) {}
95 fcn_desc(fcnp2 func, int num, int ser) : p((fcnp)func), num_params(num), is_ginac(true), serial(ser) {}
97 fcnp p; // Pointer to function
98 int num_params; // Number of parameters (0 = arbitrary)
99 bool is_ginac; // Flag: function is GiNaC function
100 int serial; // GiNaC function serial number (if is_ginac == true)
103 typedef multimap<string, fcn_desc> fcn_tab;
106 static fcn_tab::const_iterator find_function(const ex &sym, int req_params);
108 // Table to map help topics to help strings
109 typedef multimap<string, string> help_tab;
110 static help_tab help;
112 static void insert_fcn_help(const char *name, const char *str);
113 static void print_help(const string &topic);
114 static void print_help_topics(void);
117 /* Tokens (T_LITERAL means a literal value returned by the parser, but not
118 of class numeric or symbol (e.g. a constant or the FAIL object)) */
119 %token T_NUMBER T_SYMBOL T_LITERAL T_DIGITS T_QUOTE T_QUOTE2 T_QUOTE3
120 %token T_EQUAL T_NOTEQ T_LESSEQ T_GREATEREQ
122 %token T_QUIT T_WARRANTY T_PRINT T_IPRINT T_PRINTLATEX T_PRINTCSRC T_TIME
123 %token T_XYZZY T_INVENTORY T_LOOK T_SCORE T_COMPLEX_SYMBOLS T_REAL_SYMBOLS
125 /* Operator precedence and associativity */
127 %left T_EQUAL T_NOTEQ
128 %left '<' '>' T_LESSEQ T_GREATEREQ
152 } catch (exception &e) {
153 cerr << e.what() << endl;
160 } catch (exception &e) {
161 std::cerr << e.what() << endl;
165 | T_PRINT '(' exp ')' ';' {
167 $3.print(print_tree(std::cout));
168 } catch (exception &e) {
169 std::cerr << e.what() << endl;
173 | T_IPRINT '(' exp ')' ';' {
176 if (!e.info(info_flags::integer))
177 throw (std::invalid_argument("argument to iprint() must be an integer"));
178 long i = ex_to<numeric>(e).to_long();
180 cout << "#o" << oct << i << endl;
181 cout << "#x" << hex << i << dec << endl;
182 } catch (exception &e) {
183 cerr << e.what() << endl;
187 | T_PRINTLATEX '(' exp ')' ';' {
189 $3.print(print_latex(std::cout)); cout << endl;
190 } catch (exception &e) {
191 std::cerr << e.what() << endl;
195 | T_PRINTCSRC '(' exp ')' ';' {
197 $3.print(print_csrc_double(std::cout)); cout << endl;
198 } catch (exception &e) {
199 std::cerr << e.what() << endl;
203 | '?' T_SYMBOL {print_help(ex_to<symbol>($2).get_name());}
204 | '?' T_TIME {print_help("time");}
205 | '?' T_PRINT {print_help("print");}
206 | '?' T_IPRINT {print_help("iprint");}
207 | '?' T_PRINTLATEX {print_help("print_latex");}
208 | '?' T_PRINTCSRC {print_help("print_csrc");}
209 | '?' '?' {print_help_topics();}
212 cout << "This program is free software; you can redistribute it and/or modify it under\n";
213 cout << "the terms of the GNU General Public License as published by the Free Software\n";
214 cout << "Foundation; either version 2 of the License, or (at your option) any later\n";
215 cout << "version.\n";
216 cout << "This program is distributed in the hope that it will be useful, but WITHOUT\n";
217 cout << "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n";
218 cout << "FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n";
219 cout << "details.\n";
220 cout << "You should have received a copy of the GNU General Public License along with\n";
221 cout << "this program. If not, write to the Free Software Foundation,\n";
222 cout << "51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.\n";
224 | T_XYZZY {cout << "Nothing happens.\n";}
225 | T_INVENTORY {cout << "You're not carrying anything.\n";}
226 | T_LOOK {cout << "You're in a twisty little maze of passages, all alike.\n";}
228 cout << "If you were to quit now, you would score ";
229 cout << (syms.size() > 350 ? 350 : syms.size());
230 cout << " out of a possible 350.\n";
232 | T_REAL_SYMBOLS { symboltype = domain::real; }
233 | T_COMPLEX_SYMBOLS { symboltype = domain::complex; }
234 | T_TIME { START_TIMER } '(' exp ')' { STOP_TIMER PRINT_TIME_USED }
235 | error ';' {yyclearin; yyerrok;}
236 | error ':' {yyclearin; yyerrok;}
239 exp : T_NUMBER {$$ = $1;}
241 exmap::const_iterator i = assigned_symbol_table.find($1);
242 if (i == assigned_symbol_table.end())
247 | '\'' T_SYMBOL '\'' {$$ = $2;}
248 | T_LITERAL {$$ = $1;}
249 | T_DIGITS {$$ = $1;}
250 | T_QUOTE {$$ = exstack[0];}
251 | T_QUOTE2 {$$ = exstack[1];}
252 | T_QUOTE3 {$$ = exstack[2];}
253 | T_SYMBOL '(' exprseq ')' {
254 fcn_tab::const_iterator i = find_function($1, $3.nops());
255 if (i->second.is_ginac) {
256 $$ = ((fcnp2)(i->second.p))(ex_to<exprseq>($3), i->second.serial);
258 $$ = (i->second.p)(ex_to<exprseq>($3));
261 | T_DIGITS '=' T_NUMBER {$$ = $3; Digits = ex_to<numeric>($3).to_int();}
262 | T_SYMBOL '=' exp {$$ = $3; assigned_symbol_table[$1] = $3; }
263 | exp T_EQUAL exp {$$ = $1 == $3;}
264 | exp T_NOTEQ exp {$$ = $1 != $3;}
265 | exp '<' exp {$$ = $1 < $3;}
266 | exp T_LESSEQ exp {$$ = $1 <= $3;}
267 | exp '>' exp {$$ = $1 > $3;}
268 | exp T_GREATEREQ exp {$$ = $1 >= $3;}
269 | exp '+' exp {$$ = $1 + $3;}
270 | exp '-' exp {$$ = $1 - $3;}
271 | exp '*' exp {$$ = $1 * $3;}
272 | exp '/' exp {$$ = $1 / $3;}
273 | '-' exp %prec NEG {$$ = -$2;}
274 | '+' exp %prec NEG {$$ = $2;}
275 | exp '^' exp {$$ = power($1, $3);}
276 | exp '!' {$$ = factorial($1);}
277 | '(' exp ')' {$$ = $2;}
278 | '{' list_or_empty '}' {$$ = $2;}
279 | '[' matrix ']' {$$ = lst_to_matrix(ex_to<lst>($2));}
282 exprseq : exp {$$ = exprseq{$1};}
283 | exprseq ',' exp {exprseq es(ex_to<exprseq>($1)); $$ = es.append($3);}
286 list_or_empty: /* empty */ {$$ = *new lst;}
290 list : exp {$$ = lst{$1};}
291 | list ',' exp {lst l(ex_to<lst>($1)); $$ = l.append($3);}
294 matrix : '[' row ']' {$$ = lst{$2};}
295 | matrix ',' '[' row ']' {lst l(ex_to<lst>($1)); $$ = l.append($4);}
298 row : exp {$$ = lst{$1};}
299 | row ',' exp {lst l(ex_to<lst>($1)); $$ = l.append($3);}
308 // Error print routine
309 int yyerror(const char *s)
311 cerr << s << " at " << yytext << endl;
315 // Push expression "e" onto the expression stack (for ", "" and """)
316 static void push(const ex &e)
318 exstack[2] = exstack[1];
319 exstack[1] = exstack[0];
328 static ex f_collect(const exprseq &e) {return e[0].collect(e[1]);}
329 static ex f_collect_distributed(const exprseq &e) {return e[0].collect(e[1], true);}
330 static ex f_collect_common_factors(const exprseq &e) {return collect_common_factors(e[0]);}
331 static ex f_convert_H_to_Li(const exprseq &e) {return convert_H_to_Li(e[0], e[1]);}
332 static ex f_degree(const exprseq &e) {return e[0].degree(e[1]);}
333 static ex f_denom(const exprseq &e) {return e[0].denom();}
334 static ex f_evalf1(const exprseq &e) {return e[0].evalf();}
335 static ex f_evalm(const exprseq &e) {return e[0].evalm();}
336 static ex f_eval_integ(const exprseq &e) {return e[0].eval_integ();}
337 static ex f_expand(const exprseq &e) {return e[0].expand();}
338 static ex f_factor(const exprseq &e) {return factor(e[0]);}
339 static ex f_gcd(const exprseq &e) {return gcd(e[0], e[1]);}
340 static ex f_has(const exprseq &e) {return e[0].has(e[1]) ? ex(1) : ex(0);}
341 static ex f_lcm(const exprseq &e) {return lcm(e[0], e[1]);}
342 static ex f_lcoeff(const exprseq &e) {return e[0].lcoeff(e[1]);}
343 static ex f_ldegree(const exprseq &e) {return e[0].ldegree(e[1]);}
344 static ex f_lsolve(const exprseq &e) {return lsolve(e[0], e[1]);}
345 static ex f_nops(const exprseq &e) {return e[0].nops();}
346 static ex f_normal1(const exprseq &e) {return e[0].normal();}
347 static ex f_numer(const exprseq &e) {return e[0].numer();}
348 static ex f_numer_denom(const exprseq &e) {return e[0].numer_denom();}
349 static ex f_pow(const exprseq &e) {return pow(e[0], e[1]);}
350 static ex f_sqrt(const exprseq &e) {return sqrt(e[0]);}
351 static ex f_sqrfree1(const exprseq &e) {return sqrfree(e[0]);}
352 static ex f_subs2(const exprseq &e) {return e[0].subs(e[1]);}
353 static ex f_tcoeff(const exprseq &e) {return e[0].tcoeff(e[1]);}
355 #define CHECK_ARG(num, type, fcn) if (!is_a<type>(e[num])) throw(std::invalid_argument("argument " #num " to " #fcn "() must be a " #type))
357 static ex f_charpoly(const exprseq &e)
359 CHECK_ARG(0, matrix, charpoly);
360 return ex_to<matrix>(e[0]).charpoly(e[1]);
363 static ex f_coeff(const exprseq &e)
365 CHECK_ARG(2, numeric, coeff);
366 return e[0].coeff(e[1], ex_to<numeric>(e[2]).to_int());
369 static ex f_content(const exprseq &e)
371 return e[0].content(e[1]);
374 static ex f_decomp_rational(const exprseq &e)
376 return decomp_rational(e[0], e[1]);
379 static ex f_determinant(const exprseq &e)
381 CHECK_ARG(0, matrix, determinant);
382 return ex_to<matrix>(e[0]).determinant();
385 static ex f_diag(const exprseq &e)
387 size_t dim = e.nops();
388 matrix &m = *new matrix(dim, dim);
389 for (size_t i=0; i<dim; i++)
390 m.set(i, i, e.op(i));
394 static ex f_diff2(const exprseq &e)
396 CHECK_ARG(1, symbol, diff);
397 return e[0].diff(ex_to<symbol>(e[1]));
400 static ex f_diff3(const exprseq &e)
402 CHECK_ARG(1, symbol, diff);
403 CHECK_ARG(2, numeric, diff);
404 return e[0].diff(ex_to<symbol>(e[1]), ex_to<numeric>(e[2]).to_int());
407 static ex f_divide(const exprseq &e)
410 if (divide(e[0], e[1], q))
416 static ex f_evalf2(const exprseq &e)
418 CHECK_ARG(1, numeric, evalf);
419 return e[0].evalf(ex_to<numeric>(e[1]).to_int());
422 static ex f_find(const exprseq &e)
425 e[0].find(e[1], found);
427 for (auto & i : found)
432 static ex f_fsolve(const exprseq &e)
434 CHECK_ARG(1, symbol, fsolve);
435 CHECK_ARG(2, numeric, fsolve);
436 CHECK_ARG(3, numeric, fsolve);
437 return fsolve(e[0], ex_to<symbol>(e[1]), ex_to<numeric>(e[2]), ex_to<numeric>(e[3]));
440 static ex f_integer_content(const exprseq &e)
442 return e[0].expand().integer_content();
445 static ex f_integral(const exprseq &e)
447 CHECK_ARG(0, symbol, integral);
448 return integral(e[0], e[1], e[2], e[3]);
451 static ex f_inverse(const exprseq &e)
453 CHECK_ARG(0, matrix, inverse);
454 return ex_to<matrix>(e[0]).inverse();
457 static ex f_is(const exprseq &e)
459 CHECK_ARG(0, relational, is);
460 return (bool)ex_to<relational>(e[0]) ? ex(1) : ex(0);
463 class apply_map_function : public map_function {
466 apply_map_function(const ex & a) : apply(a) {}
467 virtual ~apply_map_function() {}
468 ex operator()(const ex & e) override { return apply.subs(wild() == e, true); }
471 static ex f_map(const exprseq &e)
473 apply_map_function fcn(e[1]);
474 return e[0].map(fcn);
477 static ex f_match(const exprseq &e)
480 if (e[0].match(e[1], repls)) {
482 for (auto & i : repls)
483 repl_lst.append(relational(i.first, i.second, relational::equal));
486 throw std::runtime_error("FAIL");
489 static ex f_normal2(const exprseq &e)
491 CHECK_ARG(1, numeric, normal);
492 return e[0].normal(ex_to<numeric>(e[1]).to_int());
495 static ex f_op(const exprseq &e)
497 CHECK_ARG(1, numeric, op);
498 int n = ex_to<numeric>(e[1]).to_int();
499 if (n < 0 || n >= (int)e[0].nops())
500 throw(std::out_of_range("second argument to op() is out of range"));
504 static ex f_prem(const exprseq &e)
506 return prem(e[0], e[1], e[2]);
509 static ex f_primpart(const exprseq &e)
511 return e[0].primpart(e[1]);
514 static ex f_quo(const exprseq &e)
516 return quo(e[0], e[1], e[2]);
519 static ex f_rank(const exprseq &e)
521 CHECK_ARG(0, matrix, rank);
522 return ex_to<matrix>(e[0]).rank();
525 static ex f_rem(const exprseq &e)
527 return rem(e[0], e[1], e[2]);
530 static ex f_resultant(const exprseq &e)
532 CHECK_ARG(2, symbol, resultant);
533 return resultant(e[0], e[1], ex_to<symbol>(e[2]));
536 static ex f_series(const exprseq &e)
538 CHECK_ARG(2, numeric, series);
539 return e[0].series(e[1], ex_to<numeric>(e[2]).to_int());
542 static ex f_sprem(const exprseq &e)
544 return sprem(e[0], e[1], e[2]);
547 static ex f_sqrfree2(const exprseq &e)
549 CHECK_ARG(1, lst, sqrfree);
550 return sqrfree(e[0], ex_to<lst>(e[1]));
553 static ex f_subs3(const exprseq &e)
555 CHECK_ARG(1, lst, subs);
556 CHECK_ARG(2, lst, subs);
557 return e[0].subs(ex_to<lst>(e[1]), ex_to<lst>(e[2]));
560 static ex f_trace(const exprseq &e)
562 CHECK_ARG(0, matrix, trace);
563 return ex_to<matrix>(e[0]).trace();
566 static ex f_transpose(const exprseq &e)
568 CHECK_ARG(0, matrix, transpose);
569 return ex_to<matrix>(e[0]).transpose();
572 static ex f_unassign(const exprseq &e)
574 CHECK_ARG(0, symbol, unassign);
575 exmap::iterator i = assigned_symbol_table.find(e[0]);
576 if (i != assigned_symbol_table.end())
577 assigned_symbol_table.erase(i);
581 static ex f_unit(const exprseq &e)
583 return e[0].unit(e[1]);
586 static ex f_dummy(const exprseq &e)
588 throw(std::logic_error("dummy function called (shouldn't happen)"));
591 // Tables for initializing the "fcns" map and the function help topics
598 static const fcn_init builtin_fcns[] = {
599 {"charpoly", f_charpoly, 2},
600 {"coeff", f_coeff, 3},
601 {"collect", f_collect, 2},
602 {"collect_common_factors", f_collect_common_factors, 1},
603 {"collect_distributed", f_collect_distributed, 2},
604 {"content", f_content, 2},
605 {"convert_H_to_Li", f_convert_H_to_Li, 2},
606 {"decomp_rational", f_decomp_rational, 2},
607 {"degree", f_degree, 2},
608 {"denom", f_denom, 1},
609 {"determinant", f_determinant, 1},
611 {"diff", f_diff2, 2},
612 {"diff", f_diff3, 3},
613 {"divide", f_divide, 2},
614 {"evalf", f_evalf1, 1},
615 {"evalf", f_evalf2, 2},
616 {"evalm", f_evalm, 1},
617 {"eval_integ", f_eval_integ, 1},
618 {"expand", f_expand, 1},
619 {"factor", f_factor, 1},
621 {"fsolve", f_fsolve, 4},
624 {"integer_content", f_integer_content, 1},
625 {"integral", f_integral, 4},
626 {"inverse", f_inverse, 1},
627 {"iprint", f_dummy, 0}, // for Tab-completion
630 {"lcoeff", f_lcoeff, 2},
631 {"ldegree", f_ldegree, 2},
632 {"lsolve", f_lsolve, 2},
634 {"match", f_match, 2},
636 {"normal", f_normal1, 1},
637 {"normal", f_normal2, 2},
638 {"numer", f_numer, 1},
639 {"numer_denom", f_numer_denom, 1},
643 {"primpart", f_primpart, 2},
644 {"print", f_dummy, 0}, // for Tab-completion
645 {"print_csrc", f_dummy, 0}, // for Tab-completion
646 {"print_latex", f_dummy, 0}, // for Tab-completion
650 {"resultant", f_resultant, 3},
651 {"series", f_series, 3},
652 {"sprem", f_sprem, 3},
653 {"sqrfree", f_sqrfree1, 1},
654 {"sqrfree", f_sqrfree2, 2},
656 {"subs", f_subs2, 2},
657 {"subs", f_subs3, 3},
658 {"tcoeff", f_tcoeff, 2},
659 {"time", f_dummy, 0}, // for Tab-completion
660 {"trace", f_trace, 1},
661 {"transpose", f_transpose, 1},
662 {"unassign", f_unassign, 1},
664 {NULL, f_dummy, 0} // End marker
667 struct fcn_help_init {
672 static const fcn_help_init builtin_help[] = {
673 {"acos", "inverse cosine function"},
674 {"acosh", "inverse hyperbolic cosine function"},
675 {"asin", "inverse sine function"},
676 {"asinh", "inverse hyperbolic sine function"},
677 {"atan", "inverse tangent function"},
678 {"atan2", "inverse tangent function with two arguments"},
679 {"atanh", "inverse hyperbolic tangent function"},
680 {"beta", "Beta function"},
681 {"binomial", "binomial function"},
682 {"cos", "cosine function"},
683 {"cosh", "hyperbolic cosine function"},
684 {"exp", "exponential function"},
685 {"factorial", "factorial function"},
686 {"lgamma", "natural logarithm of Gamma function"},
687 {"tgamma", "Gamma function"},
688 {"log", "natural logarithm"},
689 {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
690 {"sin", "sine function"},
691 {"sinh", "hyperbolic sine function"},
692 {"tan", "tangent function"},
693 {"tanh", "hyperbolic tangent function"},
694 {"zeta", "zeta function\nzeta(x) is Riemann's zeta function, zetaderiv(n,x) its nth derivative.\nIf x is a GiNaC::lst, it is a multiple zeta value\nzeta(x,s) is an alternating Euler sum"},
695 {"Li2", "dilogarithm"},
696 {"Li3", "trilogarithm"},
697 {"Li", "(multiple) polylogarithm"},
698 {"S", "Nielsen's generalized polylogarithm"},
699 {"H", "harmonic polylogarithm"},
700 {"Order", "order term function (for truncated power series)"},
701 {"Derivative", "inert differential operator"},
702 {NULL, NULL} // End marker
705 #include "ginsh_extensions.h"
709 * Add functions to ginsh
712 // Functions from fcn_init array
713 static void insert_fcns(const fcn_init *p)
716 fcns.insert(make_pair(string(p->name), fcn_desc(p->p, p->num_params)));
721 static ex f_ginac_function(const exprseq &es, int serial)
723 return GiNaC::function(serial, es);
726 // All registered GiNaC functions
728 static void ginsh_get_ginac_functions(void)
731 for (auto & i : function::get_registered_functions()) {
732 fcns.insert(make_pair(i.get_name(), fcn_desc(f_ginac_function, i.get_nparams(), serial)));
740 * Find a function given a name and number of parameters. Throw exceptions on error.
743 static fcn_tab::const_iterator find_function(const ex &sym, int req_params)
745 const string &name = ex_to<symbol>(sym).get_name();
746 typedef fcn_tab::const_iterator I;
747 pair<I, I> b = fcns.equal_range(name);
748 if (b.first == b.second)
749 throw(std::logic_error("unknown function '" + name + "'"));
751 for (I i=b.first; i!=b.second; i++)
752 if ((i->second.num_params == 0) || (i->second.num_params == req_params))
755 throw(std::logic_error("invalid number of arguments to " + name + "()"));
760 * Insert help strings
763 // Normal help string
764 static void insert_help(const char *topic, const char *str)
766 help.insert(make_pair(string(topic), string(str)));
769 // Help string for functions, automatically generates synopsis
770 static void insert_fcn_help(const char *name, const char *str)
772 typedef fcn_tab::const_iterator I;
773 pair<I, I> b = fcns.equal_range(name);
774 if (b.first != b.second) {
775 string help_str = string(name) + "(";
776 for (int i=0; i<b.first->second.num_params; i++) {
779 help_str += "expression";
783 help.insert(make_pair(string(name), help_str));
787 // Help strings for functions from fcn_help_init array
788 static void insert_help(const fcn_help_init *p)
791 insert_fcn_help(p->name, p->help);
801 // Help for a given topic
802 static void print_help(const string &topic)
804 typedef help_tab::const_iterator I;
805 pair<I, I> b = help.equal_range(topic);
806 if (b.first == b.second)
807 cout << "no help for '" << topic << "'\n";
809 for (I i=b.first; i!=b.second; i++)
810 cout << i->second << endl;
814 // List of help topics
815 static void print_help_topics(void)
817 cout << "Available help topics:\n";
818 help_tab::const_iterator i;
819 string last_name = string("*");
821 for (i=help.begin(); i!=help.end(); i++) {
822 // Don't print duplicates
823 if (i->first != last_name) {
828 last_name = i->first;
831 cout << "\nTo get help for a certain topic, type ?topic\n";
836 * Function name completion functions for readline
839 static char *fcn_generator(const char *text, int state)
841 static int len; // Length of word to complete
842 static fcn_tab::const_iterator index; // Iterator to function being currently considered
844 // If this is a new word to complete, initialize now
846 index = fcns.begin();
850 // Return the next function which partially matches
851 while (index != fcns.end()) {
852 const char *fcn_name = index->first.c_str();
854 if (strncmp(fcn_name, text, len) == 0)
855 return strdup(fcn_name);
860 #ifdef HAVE_LIBREADLINE
861 static char **fcn_completion(const char *text, int start, int end)
863 if (rl_line_buffer[0] == '!') {
864 // For shell commands, revert back to filename completion
865 rl_completion_append_character = orig_completion_append_character;
866 rl_basic_word_break_characters = orig_basic_word_break_characters;
867 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
868 return rl_completion_matches(text, rl_filename_completion_function);
870 // Otherwise, complete function names
871 rl_completion_append_character = '(';
872 rl_basic_word_break_characters = " \t\n\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~";
873 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
874 return rl_completion_matches(text, fcn_generator);
877 #endif // HAVE_LIBREADLINE
879 static void ginsh_readline_init(char* name)
881 #ifdef HAVE_LIBREADLINE
882 // Init readline completer
883 rl_readline_name = name;
884 rl_attempted_completion_function = fcn_completion;
885 orig_completion_append_character = rl_completion_append_character;
886 orig_basic_word_break_characters = rl_basic_word_break_characters;
887 #endif // HAVE_LIBREADLINE
892 cout << "ginsh - GiNaC Interactive Shell (GiNaC V" << GINACLIB_VERSION << ")" << endl;
893 cout << " __, _______ Copyright (C) 1999-2016 Johannes Gutenberg University Mainz,\n"
894 << " (__) * | Germany. This is free software with ABSOLUTELY NO WARRANTY.\n"
895 << " ._) i N a C | You are welcome to redistribute it under certain conditions.\n"
896 << "<-------------' For details type `warranty;'.\n" << endl;
897 cout << "Type ?? for a list of help topics." << endl;
904 int main(int argc, char **argv)
906 // Print banner in interactive mode
909 assigned_symbol_table = exmap();
911 // Init function table
912 insert_fcns(builtin_fcns);
913 insert_fcns(extended_fcns);
914 ginsh_get_ginac_functions();
916 // Init help for operators (automatically generated from man page)
917 insert_help("operators", "Operators in falling order of precedence:");
918 #include "ginsh_op_help.h"
920 // Init help for built-in functions (automatically generated from man page)
921 #include "ginsh_fcn_help.h"
923 // Help for GiNaC functions is added manually
924 insert_help(builtin_help);
925 insert_help(extended_help);
927 // Help for other keywords
928 insert_help("print", "print(expression) - dumps the internal structure of the given expression (for debugging)");
929 insert_help("iprint", "iprint(expression) - prints the given integer expression in decimal, octal, and hexadecimal bases");
930 insert_help("print_latex", "print_latex(expression) - prints a LaTeX representation of the given expression");
931 insert_help("print_csrc", "print_csrc(expression) - prints a C source code representation of the given expression");
933 ginsh_readline_init(argv[0]);
935 // Init input file list, open first file
936 num_files = argc - 1;
937 file_list = argv + 1;
939 yyin = fopen(*file_list, "r");
941 cerr << "Can't open " << *file_list << endl;
948 // Parse input, catch all remaining exceptions
952 } catch (exception &e) {
953 cerr << e.what() << endl;