1 /** @file ginsh_parser.yy
3 * Input grammar definition for ginsh.
4 * This file must be processed with yacc/bison. */
7 * GiNaC Copyright (C) 1999-2008 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
32 #include <sys/resource.h>
38 #include <sys/types.h>
46 #define YYERROR_VERBOSE 1
48 #ifdef HAVE_LIBREADLINE
49 // Original readline settings
50 static int orig_completion_append_character;
51 static const char *orig_basic_word_break_characters;
53 #if (RL_VERSION_MAJOR >= 5)
54 #define GINAC_RL_COMPLETER_CAST(a) const_cast<char *>((a))
56 #define GINAC_RL_COMPLETER_CAST(a) (a)
58 #endif // HAVE_LIBREADLINE
60 // Expression stack for %, %% and %%%
61 static void push(const ex &e);
64 static exmap assigned_symbol_table;
66 // Start and end time for the time() function
68 static struct rusage start_time, end_time;
69 #define START_TIMER getrusage(RUSAGE_SELF, &start_time);
70 #define STOP_TIMER getrusage(RUSAGE_SELF, &end_time);
71 #define PRINT_TIME_USED cout << \
72 (end_time.ru_utime.tv_sec - start_time.ru_utime.tv_sec) + \
73 (end_time.ru_stime.tv_sec - start_time.ru_stime.tv_sec) + \
74 double(end_time.ru_utime.tv_usec - start_time.ru_utime.tv_usec) / 1e6 + \
75 double(end_time.ru_stime.tv_usec - start_time.ru_stime.tv_usec) / 1e6 \
78 static std::clock_t start_time, end_time;
79 #define START_TIMER start_time = std::clock();
80 #define STOP_TIMER end_time = std::clock();
81 #define PRINT_TIME_USED \
82 cout << double(end_time - start_time)/CLOCKS_PER_SEC << 's' << endl;
85 // Table of functions (a multimap, because one function may appear with different
86 // numbers of parameters)
87 typedef ex (*fcnp)(const exprseq &e);
88 typedef ex (*fcnp2)(const exprseq &e, int serial);
91 fcn_desc() : p(NULL), num_params(0), is_ginac(false), serial(0) {}
92 fcn_desc(fcnp func, int num) : p(func), num_params(num), is_ginac(false), serial(0) {}
93 fcn_desc(fcnp2 func, int num, int ser) : p((fcnp)func), num_params(num), is_ginac(true), serial(ser) {}
95 fcnp p; // Pointer to function
96 int num_params; // Number of parameters (0 = arbitrary)
97 bool is_ginac; // Flag: function is GiNaC function
98 int serial; // GiNaC function serial number (if is_ginac == true)
101 typedef multimap<string, fcn_desc> fcn_tab;
104 static fcn_tab::const_iterator find_function(const ex &sym, int req_params);
106 // Table to map help topics to help strings
107 typedef multimap<string, string> help_tab;
108 static help_tab help;
110 static void insert_fcn_help(const char *name, const char *str);
111 static void print_help(const string &topic);
112 static void print_help_topics(void);
115 /* Tokens (T_LITERAL means a literal value returned by the parser, but not
116 of class numeric or symbol (e.g. a constant or the FAIL object)) */
117 %token T_NUMBER T_SYMBOL T_LITERAL T_DIGITS T_QUOTE T_QUOTE2 T_QUOTE3
118 %token T_EQUAL T_NOTEQ T_LESSEQ T_GREATEREQ
120 %token T_QUIT T_WARRANTY T_PRINT T_IPRINT T_PRINTLATEX T_PRINTCSRC T_TIME
121 %token T_XYZZY T_INVENTORY T_LOOK T_SCORE T_COMPLEX_SYMBOLS T_REAL_SYMBOLS
123 /* Operator precedence and associativity */
125 %left T_EQUAL T_NOTEQ
126 %left '<' '>' T_LESSEQ T_GREATEREQ
150 } catch (exception &e) {
151 cerr << e.what() << endl;
158 } catch (exception &e) {
159 std::cerr << e.what() << endl;
163 | T_PRINT '(' exp ')' ';' {
165 $3.print(print_tree(std::cout));
166 } catch (exception &e) {
167 std::cerr << e.what() << endl;
171 | T_IPRINT '(' exp ')' ';' {
174 if (!e.info(info_flags::integer))
175 throw (std::invalid_argument("argument to iprint() must be an integer"));
176 long i = ex_to<numeric>(e).to_long();
178 cout << "#o" << oct << i << endl;
179 cout << "#x" << hex << i << dec << endl;
180 } catch (exception &e) {
181 cerr << e.what() << endl;
185 | T_PRINTLATEX '(' exp ')' ';' {
187 $3.print(print_latex(std::cout)); cout << endl;
188 } catch (exception &e) {
189 std::cerr << e.what() << endl;
193 | T_PRINTCSRC '(' exp ')' ';' {
195 $3.print(print_csrc_double(std::cout)); cout << endl;
196 } catch (exception &e) {
197 std::cerr << e.what() << endl;
201 | '?' T_SYMBOL {print_help(ex_to<symbol>($2).get_name());}
202 | '?' T_TIME {print_help("time");}
203 | '?' T_PRINT {print_help("print");}
204 | '?' T_IPRINT {print_help("iprint");}
205 | '?' T_PRINTLATEX {print_help("print_latex");}
206 | '?' T_PRINTCSRC {print_help("print_csrc");}
207 | '?' '?' {print_help_topics();}
210 cout << "This program is free software; you can redistribute it and/or modify it under\n";
211 cout << "the terms of the GNU General Public License as published by the Free Software\n";
212 cout << "Foundation; either version 2 of the License, or (at your option) any later\n";
213 cout << "version.\n";
214 cout << "This program is distributed in the hope that it will be useful, but WITHOUT\n";
215 cout << "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n";
216 cout << "FOR A PARTICULAR PURPOSE. See the GNU General Public License for more\n";
217 cout << "details.\n";
218 cout << "You should have received a copy of the GNU General Public License along with\n";
219 cout << "this program. If not, write to the Free Software Foundation, 675 Mass Ave,\n";
220 cout << "Cambridge, MA 02139, USA.\n";
222 | T_XYZZY {cout << "Nothing happens.\n";}
223 | T_INVENTORY {cout << "You're not carrying anything.\n";}
224 | T_LOOK {cout << "You're in a twisty little maze of passages, all alike.\n";}
226 cout << "If you were to quit now, you would score ";
227 cout << (syms.size() > 350 ? 350 : syms.size());
228 cout << " out of a possible 350.\n";
230 | T_REAL_SYMBOLS { symboltype = domain::real; }
231 | T_COMPLEX_SYMBOLS { symboltype = domain::complex; }
232 | T_TIME { START_TIMER } '(' exp ')' { STOP_TIMER PRINT_TIME_USED }
233 | error ';' {yyclearin; yyerrok;}
234 | error ':' {yyclearin; yyerrok;}
237 exp : T_NUMBER {$$ = $1;}
239 exmap::const_iterator i = assigned_symbol_table.find($1);
240 if (i == assigned_symbol_table.end())
243 $$ = i->second.eval();
245 | '\'' T_SYMBOL '\'' {$$ = $2;}
246 | T_LITERAL {$$ = $1;}
247 | T_DIGITS {$$ = $1;}
248 | T_QUOTE {$$ = exstack[0];}
249 | T_QUOTE2 {$$ = exstack[1];}
250 | T_QUOTE3 {$$ = exstack[2];}
251 | T_SYMBOL '(' exprseq ')' {
252 fcn_tab::const_iterator i = find_function($1, $3.nops());
253 if (i->second.is_ginac) {
254 $$ = ((fcnp2)(i->second.p))(ex_to<exprseq>($3), i->second.serial);
256 $$ = (i->second.p)(ex_to<exprseq>($3));
259 | T_DIGITS '=' T_NUMBER {$$ = $3; Digits = ex_to<numeric>($3).to_int();}
260 | T_SYMBOL '=' exp {$$ = $3; assigned_symbol_table[$1] = $3; }
261 | exp T_EQUAL exp {$$ = $1 == $3;}
262 | exp T_NOTEQ exp {$$ = $1 != $3;}
263 | exp '<' exp {$$ = $1 < $3;}
264 | exp T_LESSEQ exp {$$ = $1 <= $3;}
265 | exp '>' exp {$$ = $1 > $3;}
266 | exp T_GREATEREQ exp {$$ = $1 >= $3;}
267 | exp '+' exp {$$ = $1 + $3;}
268 | exp '-' exp {$$ = $1 - $3;}
269 | exp '*' exp {$$ = $1 * $3;}
270 | exp '/' exp {$$ = $1 / $3;}
271 | '-' exp %prec NEG {$$ = -$2;}
272 | '+' exp %prec NEG {$$ = $2;}
273 | exp '^' exp {$$ = power($1, $3);}
274 | exp '!' {$$ = factorial($1);}
275 | '(' exp ')' {$$ = $2;}
276 | '{' list_or_empty '}' {$$ = $2;}
277 | '[' matrix ']' {$$ = lst_to_matrix(ex_to<lst>($2));}
280 exprseq : exp {$$ = exprseq($1);}
281 | exprseq ',' exp {exprseq es(ex_to<exprseq>($1)); $$ = es.append($3);}
284 list_or_empty: /* empty */ {$$ = *new lst;}
288 list : exp {$$ = lst($1);}
289 | list ',' exp {lst l(ex_to<lst>($1)); $$ = l.append($3);}
292 matrix : '[' row ']' {$$ = lst($2);}
293 | matrix ',' '[' row ']' {lst l(ex_to<lst>($1)); $$ = l.append($4);}
296 row : exp {$$ = lst($1);}
297 | row ',' exp {lst l(ex_to<lst>($1)); $$ = l.append($3);}
306 // Error print routine
309 cerr << s << " at " << yytext << endl;
313 // Push expression "e" onto the expression stack (for ", "" and """)
314 static void push(const ex &e)
316 exstack[2] = exstack[1];
317 exstack[1] = exstack[0];
326 static ex f_collect(const exprseq &e) {return e[0].collect(e[1]);}
327 static ex f_collect_distributed(const exprseq &e) {return e[0].collect(e[1], true);}
328 static ex f_collect_common_factors(const exprseq &e) {return collect_common_factors(e[0]);}
329 static ex f_convert_H_to_Li(const exprseq &e) {return convert_H_to_Li(e[0], e[1]);}
330 static ex f_degree(const exprseq &e) {return e[0].degree(e[1]);}
331 static ex f_denom(const exprseq &e) {return e[0].denom();}
332 static ex f_eval1(const exprseq &e) {return e[0].eval();}
333 static ex f_evalf1(const exprseq &e) {return e[0].evalf();}
334 static ex f_evalm(const exprseq &e) {return e[0].evalm();}
335 static ex f_eval_integ(const exprseq &e) {return e[0].eval_integ();}
336 static ex f_expand(const exprseq &e) {return e[0].expand();}
337 static ex f_factor(const exprseq &e) {return factor(e[0]);}
338 static ex f_gcd(const exprseq &e) {return gcd(e[0], e[1]);}
339 static ex f_has(const exprseq &e) {return e[0].has(e[1]) ? ex(1) : ex(0);}
340 static ex f_lcm(const exprseq &e) {return lcm(e[0], e[1]);}
341 static ex f_lcoeff(const exprseq &e) {return e[0].lcoeff(e[1]);}
342 static ex f_ldegree(const exprseq &e) {return e[0].ldegree(e[1]);}
343 static ex f_lsolve(const exprseq &e) {return lsolve(e[0], e[1]);}
344 static ex f_nops(const exprseq &e) {return e[0].nops();}
345 static ex f_normal1(const exprseq &e) {return e[0].normal();}
346 static ex f_numer(const exprseq &e) {return e[0].numer();}
347 static ex f_numer_denom(const exprseq &e) {return e[0].numer_denom();}
348 static ex f_pow(const exprseq &e) {return pow(e[0], e[1]);}
349 static ex f_sqrt(const exprseq &e) {return sqrt(e[0]);}
350 static ex f_sqrfree1(const exprseq &e) {return sqrfree(e[0]);}
351 static ex f_subs2(const exprseq &e) {return e[0].subs(e[1]);}
352 static ex f_tcoeff(const exprseq &e) {return e[0].tcoeff(e[1]);}
354 #define CHECK_ARG(num, type, fcn) if (!is_a<type>(e[num])) throw(std::invalid_argument("argument " #num " to " #fcn "() must be a " #type))
356 static ex f_charpoly(const exprseq &e)
358 CHECK_ARG(0, matrix, charpoly);
359 return ex_to<matrix>(e[0]).charpoly(e[1]);
362 static ex f_coeff(const exprseq &e)
364 CHECK_ARG(2, numeric, coeff);
365 return e[0].coeff(e[1], ex_to<numeric>(e[2]).to_int());
368 static ex f_content(const exprseq &e)
370 return e[0].content(e[1]);
373 static ex f_decomp_rational(const exprseq &e)
375 return decomp_rational(e[0], e[1]);
378 static ex f_determinant(const exprseq &e)
380 CHECK_ARG(0, matrix, determinant);
381 return ex_to<matrix>(e[0]).determinant();
384 static ex f_diag(const exprseq &e)
386 size_t dim = e.nops();
387 matrix &m = *new matrix(dim, dim);
388 for (size_t i=0; i<dim; i++)
389 m.set(i, i, e.op(i));
393 static ex f_diff2(const exprseq &e)
395 CHECK_ARG(1, symbol, diff);
396 return e[0].diff(ex_to<symbol>(e[1]));
399 static ex f_diff3(const exprseq &e)
401 CHECK_ARG(1, symbol, diff);
402 CHECK_ARG(2, numeric, diff);
403 return e[0].diff(ex_to<symbol>(e[1]), ex_to<numeric>(e[2]).to_int());
406 static ex f_divide(const exprseq &e)
409 if (divide(e[0], e[1], q))
415 static ex f_eval2(const exprseq &e)
417 CHECK_ARG(1, numeric, eval);
418 return e[0].eval(ex_to<numeric>(e[1]).to_int());
421 static ex f_evalf2(const exprseq &e)
423 CHECK_ARG(1, numeric, evalf);
424 return e[0].evalf(ex_to<numeric>(e[1]).to_int());
427 static ex f_find(const exprseq &e)
430 e[0].find(e[1], found);
432 for (exset::const_iterator i = found.begin(); i != found.end(); ++i)
437 static ex f_fsolve(const exprseq &e)
439 CHECK_ARG(1, symbol, fsolve);
440 CHECK_ARG(2, numeric, fsolve);
441 CHECK_ARG(3, numeric, fsolve);
442 return fsolve(e[0], ex_to<symbol>(e[1]), ex_to<numeric>(e[2]), ex_to<numeric>(e[3]));
445 static ex f_integer_content(const exprseq &e)
447 return e[0].expand().integer_content();
450 static ex f_integral(const exprseq &e)
452 CHECK_ARG(0, symbol, integral);
453 return integral(e[0], e[1], e[2], e[3]);
456 static ex f_inverse(const exprseq &e)
458 CHECK_ARG(0, matrix, inverse);
459 return ex_to<matrix>(e[0]).inverse();
462 static ex f_is(const exprseq &e)
464 CHECK_ARG(0, relational, is);
465 return (bool)ex_to<relational>(e[0]) ? ex(1) : ex(0);
468 class apply_map_function : public map_function {
471 apply_map_function(const ex & a) : apply(a) {}
472 virtual ~apply_map_function() {}
473 ex operator()(const ex & e) { return apply.subs(wild() == e, true); }
476 static ex f_map(const exprseq &e)
478 apply_map_function fcn(e[1]);
479 return e[0].map(fcn);
482 static ex f_match(const exprseq &e)
485 if (e[0].match(e[1], repls)) {
487 for (exmap::const_iterator i = repls.begin(); i != repls.end(); ++i)
488 repl_lst.append(relational(i->first, i->second, relational::equal));
491 throw std::runtime_error("FAIL");
494 static ex f_normal2(const exprseq &e)
496 CHECK_ARG(1, numeric, normal);
497 return e[0].normal(ex_to<numeric>(e[1]).to_int());
500 static ex f_op(const exprseq &e)
502 CHECK_ARG(1, numeric, op);
503 int n = ex_to<numeric>(e[1]).to_int();
504 if (n < 0 || n >= (int)e[0].nops())
505 throw(std::out_of_range("second argument to op() is out of range"));
509 static ex f_prem(const exprseq &e)
511 return prem(e[0], e[1], e[2]);
514 static ex f_primpart(const exprseq &e)
516 return e[0].primpart(e[1]);
519 static ex f_quo(const exprseq &e)
521 return quo(e[0], e[1], e[2]);
524 static ex f_rank(const exprseq &e)
526 CHECK_ARG(0, matrix, rank);
527 return ex_to<matrix>(e[0]).rank();
530 static ex f_rem(const exprseq &e)
532 return rem(e[0], e[1], e[2]);
535 static ex f_resultant(const exprseq &e)
537 CHECK_ARG(2, symbol, resultant);
538 return resultant(e[0], e[1], ex_to<symbol>(e[2]));
541 static ex f_series(const exprseq &e)
543 CHECK_ARG(2, numeric, series);
544 return e[0].series(e[1], ex_to<numeric>(e[2]).to_int());
547 static ex f_sprem(const exprseq &e)
549 return sprem(e[0], e[1], e[2]);
552 static ex f_sqrfree2(const exprseq &e)
554 CHECK_ARG(1, lst, sqrfree);
555 return sqrfree(e[0], ex_to<lst>(e[1]));
558 static ex f_subs3(const exprseq &e)
560 CHECK_ARG(1, lst, subs);
561 CHECK_ARG(2, lst, subs);
562 return e[0].subs(ex_to<lst>(e[1]), ex_to<lst>(e[2]));
565 static ex f_trace(const exprseq &e)
567 CHECK_ARG(0, matrix, trace);
568 return ex_to<matrix>(e[0]).trace();
571 static ex f_transpose(const exprseq &e)
573 CHECK_ARG(0, matrix, transpose);
574 return ex_to<matrix>(e[0]).transpose();
577 static ex f_unassign(const exprseq &e)
579 CHECK_ARG(0, symbol, unassign);
580 exmap::iterator i = assigned_symbol_table.find(e[0]);
581 if (i != assigned_symbol_table.end())
582 assigned_symbol_table.erase(i);
586 static ex f_unit(const exprseq &e)
588 return e[0].unit(e[1]);
591 static ex f_dummy(const exprseq &e)
593 throw(std::logic_error("dummy function called (shouldn't happen)"));
596 // Tables for initializing the "fcns" map and the function help topics
603 static const fcn_init builtin_fcns[] = {
604 {"charpoly", f_charpoly, 2},
605 {"coeff", f_coeff, 3},
606 {"collect", f_collect, 2},
607 {"collect_common_factors", f_collect_common_factors, 1},
608 {"collect_distributed", f_collect_distributed, 2},
609 {"content", f_content, 2},
610 {"convert_H_to_Li", f_convert_H_to_Li, 2},
611 {"decomp_rational", f_decomp_rational, 2},
612 {"degree", f_degree, 2},
613 {"denom", f_denom, 1},
614 {"determinant", f_determinant, 1},
616 {"diff", f_diff2, 2},
617 {"diff", f_diff3, 3},
618 {"divide", f_divide, 2},
619 {"eval", f_eval1, 1},
620 {"eval", f_eval2, 2},
621 {"evalf", f_evalf1, 1},
622 {"evalf", f_evalf2, 2},
623 {"evalm", f_evalm, 1},
624 {"eval_integ", f_eval_integ, 1},
625 {"expand", f_expand, 1},
626 {"factor", f_factor, 1},
628 {"fsolve", f_fsolve, 4},
631 {"integer_content", f_integer_content, 1},
632 {"integral", f_integral, 4},
633 {"inverse", f_inverse, 1},
634 {"iprint", f_dummy, 0}, // for Tab-completion
637 {"lcoeff", f_lcoeff, 2},
638 {"ldegree", f_ldegree, 2},
639 {"lsolve", f_lsolve, 2},
641 {"match", f_match, 2},
643 {"normal", f_normal1, 1},
644 {"normal", f_normal2, 2},
645 {"numer", f_numer, 1},
646 {"numer_denom", f_numer_denom, 1},
650 {"primpart", f_primpart, 2},
651 {"print", f_dummy, 0}, // for Tab-completion
652 {"print_csrc", f_dummy, 0}, // for Tab-completion
653 {"print_latex", f_dummy, 0}, // for Tab-completion
657 {"resultant", f_resultant, 3},
658 {"series", f_series, 3},
659 {"sprem", f_sprem, 3},
660 {"sqrfree", f_sqrfree1, 1},
661 {"sqrfree", f_sqrfree2, 2},
663 {"subs", f_subs2, 2},
664 {"subs", f_subs3, 3},
665 {"tcoeff", f_tcoeff, 2},
666 {"time", f_dummy, 0}, // for Tab-completion
667 {"trace", f_trace, 1},
668 {"transpose", f_transpose, 1},
669 {"unassign", f_unassign, 1},
671 {NULL, f_dummy, 0} // End marker
674 struct fcn_help_init {
679 static const fcn_help_init builtin_help[] = {
680 {"acos", "inverse cosine function"},
681 {"acosh", "inverse hyperbolic cosine function"},
682 {"asin", "inverse sine function"},
683 {"asinh", "inverse hyperbolic sine function"},
684 {"atan", "inverse tangent function"},
685 {"atan2", "inverse tangent function with two arguments"},
686 {"atanh", "inverse hyperbolic tangent function"},
687 {"beta", "Beta function"},
688 {"binomial", "binomial function"},
689 {"cos", "cosine function"},
690 {"cosh", "hyperbolic cosine function"},
691 {"exp", "exponential function"},
692 {"factorial", "factorial function"},
693 {"lgamma", "natural logarithm of Gamma function"},
694 {"tgamma", "Gamma function"},
695 {"log", "natural logarithm"},
696 {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
697 {"sin", "sine function"},
698 {"sinh", "hyperbolic sine function"},
699 {"tan", "tangent function"},
700 {"tanh", "hyperbolic tangent function"},
701 {"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"},
702 {"Li2", "dilogarithm"},
703 {"Li3", "trilogarithm"},
704 {"Li", "(multiple) polylogarithm"},
705 {"S", "Nielsen's generalized polylogarithm"},
706 {"H", "harmonic polylogarithm"},
707 {"Order", "order term function (for truncated power series)"},
708 {"Derivative", "inert differential operator"},
709 {NULL, NULL} // End marker
712 #include "ginsh_extensions.h"
716 * Add functions to ginsh
719 // Functions from fcn_init array
720 static void insert_fcns(const fcn_init *p)
723 fcns.insert(make_pair(string(p->name), fcn_desc(p->p, p->num_params)));
728 static ex f_ginac_function(const exprseq &es, int serial)
730 return function(serial, es).eval(1);
733 // All registered GiNaC functions
735 void ginsh_get_ginac_functions(void)
737 vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
740 fcns.insert(make_pair(i->get_name(), fcn_desc(f_ginac_function, i->get_nparams(), serial)));
749 * Find a function given a name and number of parameters. Throw exceptions on error.
752 static fcn_tab::const_iterator find_function(const ex &sym, int req_params)
754 const string &name = ex_to<symbol>(sym).get_name();
755 typedef fcn_tab::const_iterator I;
756 pair<I, I> b = fcns.equal_range(name);
757 if (b.first == b.second)
758 throw(std::logic_error("unknown function '" + name + "'"));
760 for (I i=b.first; i!=b.second; i++)
761 if ((i->second.num_params == 0) || (i->second.num_params == req_params))
764 throw(std::logic_error("invalid number of arguments to " + name + "()"));
769 * Insert help strings
772 // Normal help string
773 static void insert_help(const char *topic, const char *str)
775 help.insert(make_pair(string(topic), string(str)));
778 // Help string for functions, automatically generates synopsis
779 static void insert_fcn_help(const char *name, const char *str)
781 typedef fcn_tab::const_iterator I;
782 pair<I, I> b = fcns.equal_range(name);
783 if (b.first != b.second) {
784 string help_str = string(name) + "(";
785 for (int i=0; i<b.first->second.num_params; i++) {
788 help_str += "expression";
792 help.insert(make_pair(string(name), help_str));
796 // Help strings for functions from fcn_help_init array
797 static void insert_help(const fcn_help_init *p)
800 insert_fcn_help(p->name, p->help);
810 // Help for a given topic
811 static void print_help(const string &topic)
813 typedef help_tab::const_iterator I;
814 pair<I, I> b = help.equal_range(topic);
815 if (b.first == b.second)
816 cout << "no help for '" << topic << "'\n";
818 for (I i=b.first; i!=b.second; i++)
819 cout << i->second << endl;
823 // List of help topics
824 static void print_help_topics(void)
826 cout << "Available help topics:\n";
827 help_tab::const_iterator i;
828 string last_name = string("*");
830 for (i=help.begin(); i!=help.end(); i++) {
831 // Don't print duplicates
832 if (i->first != last_name) {
837 last_name = i->first;
840 cout << "\nTo get help for a certain topic, type ?topic\n";
845 * Function name completion functions for readline
848 static char *fcn_generator(const char *text, int state)
850 static int len; // Length of word to complete
851 static fcn_tab::const_iterator index; // Iterator to function being currently considered
853 // If this is a new word to complete, initialize now
855 index = fcns.begin();
859 // Return the next function which partially matches
860 while (index != fcns.end()) {
861 const char *fcn_name = index->first.c_str();
863 if (strncmp(fcn_name, text, len) == 0)
864 return strdup(fcn_name);
869 #ifdef HAVE_LIBREADLINE
870 static char **fcn_completion(const char *text, int start, int end)
872 if (rl_line_buffer[0] == '!') {
873 // For shell commands, revert back to filename completion
874 rl_completion_append_character = orig_completion_append_character;
875 rl_basic_word_break_characters = orig_basic_word_break_characters;
876 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
877 return rl_completion_matches(text, rl_filename_completion_function);
879 // Otherwise, complete function names
880 rl_completion_append_character = '(';
881 rl_basic_word_break_characters = " \t\n\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~";
882 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
883 return rl_completion_matches(text, fcn_generator);
886 #endif // HAVE_LIBREADLINE
888 static void ginsh_readline_init(char* name)
890 #ifdef HAVE_LIBREADLINE
891 // Init readline completer
892 rl_readline_name = name;
893 rl_attempted_completion_function = fcn_completion;
894 orig_completion_append_character = rl_completion_append_character;
895 orig_basic_word_break_characters = rl_basic_word_break_characters;
896 #endif // HAVE_LIBREADLINE
901 cout << "ginsh - GiNaC Interactive Shell (" << PACKAGE << " V" << VERSION << ")" << endl;
902 cout << " __, _______ Copyright (C) 1999-2008 Johannes Gutenberg University Mainz,\n"
903 << " (__) * | Germany. This is free software with ABSOLUTELY NO WARRANTY.\n"
904 << " ._) i N a C | You are welcome to redistribute it under certain conditions.\n"
905 << "<-------------' For details type `warranty;'.\n" << endl;
906 cout << "Type ?? for a list of help topics." << endl;
913 int main(int argc, char **argv)
915 // Print banner in interactive mode
918 assigned_symbol_table = exmap();
920 // Init function table
921 insert_fcns(builtin_fcns);
922 insert_fcns(extended_fcns);
923 ginsh_get_ginac_functions();
925 // Init help for operators (automatically generated from man page)
926 insert_help("operators", "Operators in falling order of precedence:");
927 #include "ginsh_op_help.h"
929 // Init help for built-in functions (automatically generated from man page)
930 #include "ginsh_fcn_help.h"
932 // Help for GiNaC functions is added manually
933 insert_help(builtin_help);
934 insert_help(extended_help);
936 // Help for other keywords
937 insert_help("print", "print(expression) - dumps the internal structure of the given expression (for debugging)");
938 insert_help("iprint", "iprint(expression) - prints the given integer expression in decimal, octal, and hexadecimal bases");
939 insert_help("print_latex", "print_latex(expression) - prints a LaTeX representation of the given expression");
940 insert_help("print_csrc", "print_csrc(expression) - prints a C source code representation of the given expression");
942 ginsh_readline_init(argv[0]);
944 // Init input file list, open first file
945 num_files = argc - 1;
946 file_list = argv + 1;
948 yyin = fopen(*file_list, "r");
950 cerr << "Can't open " << *file_list << endl;
957 // Parse input, catch all remaining exceptions
961 } catch (exception &e) {
962 cerr << e.what() << endl;