* Added resultant() function (by Ralf Stephan <ralf@ark.in-berlin.de>).
[ginac.git] / ginsh / ginsh_parser.yy
1 /** @file ginsh_parser.yy
2  *
3  *  Input grammar definition for ginsh.
4  *  This file must be processed with yacc/bison. */
5
6 /*
7  *  GiNaC Copyright (C) 1999-2004 Johannes Gutenberg University Mainz, Germany
8  *
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.
13  *
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.
18  *
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23
24
25 /*
26  *  Definitions
27  */
28
29 %{
30 #include "config.h"
31
32 #include <sys/resource.h>
33
34 #if HAVE_UNISTD_H
35 #include <sys/types.h>
36 #include <unistd.h>
37 #endif
38
39 #include <stdexcept>
40
41 #include "ginsh.h"
42
43 #define YYERROR_VERBOSE 1
44
45 // Original readline settings
46 static int orig_completion_append_character;
47 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
48 static char *orig_basic_word_break_characters;
49 #else
50 static const char *orig_basic_word_break_characters;
51 #endif
52
53 // Expression stack for %, %% and %%%
54 static void push(const ex &e);
55 static ex exstack[3];
56
57 // Start and end time for the time() function
58 static struct rusage start_time, end_time;
59
60 // Table of functions (a multimap, because one function may appear with different
61 // numbers of parameters)
62 typedef ex (*fcnp)(const exprseq &e);
63 typedef ex (*fcnp2)(const exprseq &e, int serial);
64
65 struct fcn_desc {
66         fcn_desc() : p(NULL), num_params(0), is_ginac(false), serial(0) {}
67         fcn_desc(fcnp func, int num) : p(func), num_params(num), is_ginac(false), serial(0) {}
68         fcn_desc(fcnp2 func, int num, int ser) : p((fcnp)func), num_params(num), is_ginac(true), serial(ser) {}
69
70         fcnp p;         // Pointer to function
71         int num_params; // Number of parameters (0 = arbitrary)
72         bool is_ginac;  // Flag: function is GiNaC function
73         int serial;     // GiNaC function serial number (if is_ginac == true)
74 };
75
76 typedef multimap<string, fcn_desc> fcn_tab;
77 static fcn_tab fcns;
78
79 static fcn_tab::const_iterator find_function(const ex &sym, int req_params);
80
81 // Table to map help topics to help strings
82 typedef multimap<string, string> help_tab;
83 static help_tab help;
84
85 static void insert_fcn_help(const char *name, const char *str);
86 static void print_help(const string &topic);
87 static void print_help_topics(void);
88 %}
89
90 /* Tokens (T_LITERAL means a literal value returned by the parser, but not
91    of class numeric or symbol (e.g. a constant or the FAIL object)) */
92 %token T_NUMBER T_SYMBOL T_LITERAL T_DIGITS T_QUOTE T_QUOTE2 T_QUOTE3
93 %token T_EQUAL T_NOTEQ T_LESSEQ T_GREATEREQ
94
95 %token T_QUIT T_WARRANTY T_PRINT T_IPRINT T_PRINTLATEX T_PRINTCSRC T_TIME
96 %token T_XYZZY T_INVENTORY T_LOOK T_SCORE T_COMPLEX_SYMBOLS T_REAL_SYMBOLS
97
98 /* Operator precedence and associativity */
99 %right '='
100 %left T_EQUAL T_NOTEQ
101 %left '<' '>' T_LESSEQ T_GREATEREQ
102 %left '+' '-'
103 %left '*' '/'
104 %nonassoc NEG
105 %right '^'
106 %nonassoc '!'
107
108 %start input
109
110
111 /*
112  *  Grammar rules
113  */
114
115 %%
116 input   : /* empty */
117         | input line
118         ;
119
120 line    : ';'
121         | exp ';' {
122                 try {
123                         cout << $1 << endl;
124                         push($1);
125                 } catch (exception &e) {
126                         cerr << e.what() << endl;
127                         YYERROR;
128                 }
129         }
130         | exp ':' {
131                 try {
132                         push($1);
133                 } catch (exception &e) {
134                         std::cerr << e.what() << endl;
135                         YYERROR;
136                 }
137         }
138         | T_PRINT '(' exp ')' ';' {
139                 try {
140                         $3.print(print_tree(std::cout));
141                 } catch (exception &e) {
142                         std::cerr << e.what() << endl;
143                         YYERROR;
144                 }
145         }
146         | T_IPRINT '(' exp ')' ';' {
147                 try {
148                         ex e = $3;
149                         if (!e.info(info_flags::integer))
150                                 throw (std::invalid_argument("argument to iprint() must be an integer"));
151                         long i = ex_to<numeric>(e).to_long();
152                         cout << i << endl;
153                         cout << "#o" << oct << i << endl;
154                         cout << "#x" << hex << i << dec << endl;
155                 } catch (exception &e) {
156                         cerr << e.what() << endl;
157                         YYERROR;
158                 }
159         }
160         | T_PRINTLATEX '(' exp ')' ';' {
161                 try {
162                         $3.print(print_latex(std::cout)); cout << endl;
163                 } catch (exception &e) {
164                         std::cerr << e.what() << endl;
165                         YYERROR;
166                 }
167         }
168         | T_PRINTCSRC '(' exp ')' ';' {
169                 try {
170                         $3.print(print_csrc_double(std::cout)); cout << endl;
171                 } catch (exception &e) {
172                         std::cerr << e.what() << endl;
173                         YYERROR;
174                 }
175         }
176         | '?' T_SYMBOL          {print_help(ex_to<symbol>($2).get_name());}
177         | '?' T_TIME            {print_help("time");}
178         | '?' T_PRINT           {print_help("print");}
179         | '?' T_IPRINT          {print_help("iprint");}
180         | '?' T_PRINTLATEX      {print_help("print_latex");}
181         | '?' T_PRINTCSRC       {print_help("print_csrc");}
182         | '?' '?'               {print_help_topics();}
183         | T_QUIT                {YYACCEPT;}
184         | T_WARRANTY {
185                 cout << "This program is free software; you can redistribute it and/or modify it under\n";
186                 cout << "the terms of the GNU General Public License as published by the Free Software\n";
187                 cout << "Foundation; either version 2 of the License, or (at your option) any later\n";
188                 cout << "version.\n";
189                 cout << "This program is distributed in the hope that it will be useful, but WITHOUT\n";
190                 cout << "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\n";
191                 cout << "FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more\n";
192                 cout << "details.\n";
193                 cout << "You should have received a copy of the GNU General Public License along with\n";
194                 cout << "this program. If not, write to the Free Software Foundation, 675 Mass Ave,\n";
195                 cout << "Cambridge, MA 02139, USA.\n";
196         }
197         | T_XYZZY               {cout << "Nothing happens.\n";}
198         | T_INVENTORY           {cout << "You're not carrying anything.\n";}
199         | T_LOOK                {cout << "You're in a twisty little maze of passages, all alike.\n";}
200         | T_SCORE {
201                 cout << "If you were to quit now, you would score ";
202                 cout << (syms.size() > 350 ? 350 : syms.size());
203                 cout << " out of a possible 350.\n";
204         }
205         | T_REAL_SYMBOLS { symboltype = domain::real; }
206         | T_COMPLEX_SYMBOLS { symboltype = domain::complex; }
207         | T_TIME {getrusage(RUSAGE_SELF, &start_time);} '(' exp ')' {
208                 getrusage(RUSAGE_SELF, &end_time);
209                 cout << (end_time.ru_utime.tv_sec - start_time.ru_utime.tv_sec) +
210                         (end_time.ru_stime.tv_sec - start_time.ru_stime.tv_sec) +
211                          double(end_time.ru_utime.tv_usec - start_time.ru_utime.tv_usec) / 1e6 +
212                          double(end_time.ru_stime.tv_usec - start_time.ru_stime.tv_usec) / 1e6 << 's' << endl;
213         }
214         | error ';'             {yyclearin; yyerrok;}
215         | error ':'             {yyclearin; yyerrok;}
216         ;
217
218 exp     : T_NUMBER              {$$ = $1;}
219         | T_SYMBOL              {$$ = $1.eval();}
220         | '\'' T_SYMBOL '\''    {$$ = $2;}
221         | T_LITERAL             {$$ = $1;}
222         | T_DIGITS              {$$ = $1;}
223         | T_QUOTE               {$$ = exstack[0];}
224         | T_QUOTE2              {$$ = exstack[1];}
225         | T_QUOTE3              {$$ = exstack[2];}
226         | T_SYMBOL '(' exprseq ')' {
227                 fcn_tab::const_iterator i = find_function($1, $3.nops());
228                 if (i->second.is_ginac) {
229                         $$ = ((fcnp2)(i->second.p))(ex_to<exprseq>($3), i->second.serial);
230                 } else {
231                         $$ = (i->second.p)(ex_to<exprseq>($3));
232                 }
233         }
234         | T_DIGITS '=' T_NUMBER {$$ = $3; Digits = ex_to<numeric>($3).to_int();}
235         | T_SYMBOL '=' exp      {$$ = $3; const_cast<symbol&>(ex_to<symbol>($1)).assign($3);}
236         | exp T_EQUAL exp       {$$ = $1 == $3;}
237         | exp T_NOTEQ exp       {$$ = $1 != $3;}
238         | exp '<' exp           {$$ = $1 < $3;}
239         | exp T_LESSEQ exp      {$$ = $1 <= $3;}
240         | exp '>' exp           {$$ = $1 > $3;}
241         | exp T_GREATEREQ exp   {$$ = $1 >= $3;}
242         | exp '+' exp           {$$ = $1 + $3;}
243         | exp '-' exp           {$$ = $1 - $3;}
244         | exp '*' exp           {$$ = $1 * $3;}
245         | exp '/' exp           {$$ = $1 / $3;}
246         | '-' exp %prec NEG     {$$ = -$2;}
247         | '+' exp %prec NEG     {$$ = $2;}
248         | exp '^' exp           {$$ = power($1, $3);}
249         | exp '!'               {$$ = factorial($1);}
250         | '(' exp ')'           {$$ = $2;}
251         | '{' list_or_empty '}' {$$ = $2;}
252         | '[' matrix ']'        {$$ = lst_to_matrix(ex_to<lst>($2));}
253         ;
254
255 exprseq : exp                   {$$ = exprseq($1);}
256         | exprseq ',' exp       {exprseq es(ex_to<exprseq>($1)); $$ = es.append($3);}
257         ;
258
259 list_or_empty: /* empty */      {$$ = *new lst;}
260         | list                  {$$ = $1;}
261         ;
262
263 list    : exp                   {$$ = lst($1);}
264         | list ',' exp          {lst l(ex_to<lst>($1)); $$ = l.append($3);}
265         ;
266
267 matrix  : '[' row ']'           {$$ = lst($2);}
268         | matrix ',' '[' row ']' {lst l(ex_to<lst>($1)); $$ = l.append($4);}
269         ;
270
271 row     : exp                   {$$ = lst($1);}
272         | row ',' exp           {lst l(ex_to<lst>($1)); $$ = l.append($3);}
273         ;
274
275
276 /*
277  *  Routines
278  */
279
280 %%
281 // Error print routine
282 int yyerror(char *s)
283 {
284         cerr << s << " at " << yytext << endl;
285         return 0;
286 }
287
288 // Push expression "e" onto the expression stack (for ", "" and """)
289 static void push(const ex &e)
290 {
291         exstack[2] = exstack[1];
292         exstack[1] = exstack[0];
293         exstack[0] = e;
294 }
295
296
297 /*
298  *  Built-in functions
299  */
300
301 static ex f_collect(const exprseq &e) {return e[0].collect(e[1]);}
302 static ex f_collect_distributed(const exprseq &e) {return e[0].collect(e[1], true);}
303 static ex f_collect_common_factors(const exprseq &e) {return collect_common_factors(e[0]);}
304 static ex f_convert_H_to_Li(const exprseq &e) {return convert_H_to_Li(e[0], e[1]);}
305 static ex f_degree(const exprseq &e) {return e[0].degree(e[1]);}
306 static ex f_denom(const exprseq &e) {return e[0].denom();}
307 static ex f_eval1(const exprseq &e) {return e[0].eval();}
308 static ex f_evalf1(const exprseq &e) {return e[0].evalf();}
309 static ex f_evalm(const exprseq &e) {return e[0].evalm();}
310 static ex f_expand(const exprseq &e) {return e[0].expand();}
311 static ex f_gcd(const exprseq &e) {return gcd(e[0], e[1]);}
312 static ex f_has(const exprseq &e) {return e[0].has(e[1]) ? ex(1) : ex(0);}
313 static ex f_lcm(const exprseq &e) {return lcm(e[0], e[1]);}
314 static ex f_lcoeff(const exprseq &e) {return e[0].lcoeff(e[1]);}
315 static ex f_ldegree(const exprseq &e) {return e[0].ldegree(e[1]);}
316 static ex f_lsolve(const exprseq &e) {return lsolve(e[0], e[1]);}
317 static ex f_nops(const exprseq &e) {return e[0].nops();}
318 static ex f_normal1(const exprseq &e) {return e[0].normal();}
319 static ex f_numer(const exprseq &e) {return e[0].numer();}
320 static ex f_numer_denom(const exprseq &e) {return e[0].numer_denom();}
321 static ex f_pow(const exprseq &e) {return pow(e[0], e[1]);}
322 static ex f_sqrt(const exprseq &e) {return sqrt(e[0]);}
323 static ex f_sqrfree1(const exprseq &e) {return sqrfree(e[0]);}
324 static ex f_subs2(const exprseq &e) {return e[0].subs(e[1]);}
325 static ex f_tcoeff(const exprseq &e) {return e[0].tcoeff(e[1]);}
326
327 #define CHECK_ARG(num, type, fcn) if (!is_a<type>(e[num])) throw(std::invalid_argument("argument " #num " to " #fcn "() must be a " #type))
328
329 static ex f_charpoly(const exprseq &e)
330 {
331         CHECK_ARG(0, matrix, charpoly);
332         return ex_to<matrix>(e[0]).charpoly(e[1]);
333 }
334
335 static ex f_coeff(const exprseq &e)
336 {
337         CHECK_ARG(2, numeric, coeff);
338         return e[0].coeff(e[1], ex_to<numeric>(e[2]).to_int());
339 }
340
341 static ex f_content(const exprseq &e)
342 {
343         return e[0].content(e[1]);
344 }
345
346 static ex f_decomp_rational(const exprseq &e)
347 {
348         return decomp_rational(e[0], e[1]);
349 }
350
351 static ex f_determinant(const exprseq &e)
352 {
353         CHECK_ARG(0, matrix, determinant);
354         return ex_to<matrix>(e[0]).determinant();
355 }
356
357 static ex f_diag(const exprseq &e)
358 {
359         size_t dim = e.nops();
360         matrix &m = *new matrix(dim, dim);
361         for (size_t i=0; i<dim; i++)
362                 m.set(i, i, e.op(i));
363         return m;
364 }
365
366 static ex f_diff2(const exprseq &e)
367 {
368         CHECK_ARG(1, symbol, diff);
369         return e[0].diff(ex_to<symbol>(e[1]));
370 }
371
372 static ex f_diff3(const exprseq &e)
373 {
374         CHECK_ARG(1, symbol, diff);
375         CHECK_ARG(2, numeric, diff);
376         return e[0].diff(ex_to<symbol>(e[1]), ex_to<numeric>(e[2]).to_int());
377 }
378
379 static ex f_divide(const exprseq &e)
380 {
381         ex q;
382         if (divide(e[0], e[1], q))
383                 return q;
384         else
385                 return fail();
386 }
387
388 static ex f_eval2(const exprseq &e)
389 {
390         CHECK_ARG(1, numeric, eval);
391         return e[0].eval(ex_to<numeric>(e[1]).to_int());
392 }
393
394 static ex f_evalf2(const exprseq &e)
395 {
396         CHECK_ARG(1, numeric, evalf);
397         return e[0].evalf(ex_to<numeric>(e[1]).to_int());
398 }
399
400 static ex f_find(const exprseq &e)
401 {
402         lst found;
403         e[0].find(e[1], found);
404         return found;
405 }
406
407 static ex f_inverse(const exprseq &e)
408 {
409         CHECK_ARG(0, matrix, inverse);
410         return ex_to<matrix>(e[0]).inverse();
411 }
412
413 static ex f_is(const exprseq &e)
414 {
415         CHECK_ARG(0, relational, is);
416         return (bool)ex_to<relational>(e[0]) ? ex(1) : ex(0);
417 }
418
419 class apply_map_function : public map_function {
420         ex apply;
421 public:
422         apply_map_function(const ex & a) : apply(a) {}
423         virtual ~apply_map_function() {}
424         ex operator()(const ex & e) { return apply.subs(wild() == e, true); }
425 };
426
427 static ex f_map(const exprseq &e)
428 {
429         apply_map_function fcn(e[1]);
430         return e[0].map(fcn);
431 }
432
433 static ex f_match(const exprseq &e)
434 {
435         lst repl_lst;
436         if (e[0].match(e[1], repl_lst))
437                 return repl_lst;
438         else
439                 return fail();
440 }
441
442 static ex f_normal2(const exprseq &e)
443 {
444         CHECK_ARG(1, numeric, normal);
445         return e[0].normal(ex_to<numeric>(e[1]).to_int());
446 }
447
448 static ex f_op(const exprseq &e)
449 {
450         CHECK_ARG(1, numeric, op);
451         int n = ex_to<numeric>(e[1]).to_int();
452         if (n < 0 || n >= (int)e[0].nops())
453                 throw(std::out_of_range("second argument to op() is out of range"));
454         return e[0].op(n);
455 }
456
457 static ex f_prem(const exprseq &e)
458 {
459         return prem(e[0], e[1], e[2]);
460 }
461
462 static ex f_primpart(const exprseq &e)
463 {
464         return e[0].primpart(e[1]);
465 }
466
467 static ex f_quo(const exprseq &e)
468 {
469         return quo(e[0], e[1], e[2]);
470 }
471
472 static ex f_rank(const exprseq &e)
473 {
474         CHECK_ARG(0, matrix, rank);
475         return ex_to<matrix>(e[0]).rank();
476 }
477
478 static ex f_rem(const exprseq &e)
479 {
480         return rem(e[0], e[1], e[2]);
481 }
482
483 static ex f_resultant(const exprseq &e)
484 {
485         CHECK_ARG(2, symbol, resultant);
486         return resultant(e[0], e[1], ex_to<symbol>(e[2]));
487 }
488
489 static ex f_series(const exprseq &e)
490 {
491         CHECK_ARG(2, numeric, series);
492         return e[0].series(e[1], ex_to<numeric>(e[2]).to_int());
493 }
494
495 static ex f_sprem(const exprseq &e)
496 {
497         return sprem(e[0], e[1], e[2]);
498 }
499
500 static ex f_sqrfree2(const exprseq &e)
501 {
502         CHECK_ARG(1, lst, sqrfree);
503         return sqrfree(e[0], ex_to<lst>(e[1]));
504 }
505
506 static ex f_subs3(const exprseq &e)
507 {
508         CHECK_ARG(1, lst, subs);
509         CHECK_ARG(2, lst, subs);
510         return e[0].subs(ex_to<lst>(e[1]), ex_to<lst>(e[2]));
511 }
512
513 static ex f_trace(const exprseq &e)
514 {
515         CHECK_ARG(0, matrix, trace);
516         return ex_to<matrix>(e[0]).trace();
517 }
518
519 static ex f_transpose(const exprseq &e)
520 {
521         CHECK_ARG(0, matrix, transpose);
522         return ex_to<matrix>(e[0]).transpose();
523 }
524
525 static ex f_unassign(const exprseq &e)
526 {
527         CHECK_ARG(0, symbol, unassign);
528         const_cast<symbol&>(ex_to<symbol>(e[0])).unassign();
529         return e[0];
530 }
531
532 static ex f_unit(const exprseq &e)
533 {
534         return e[0].unit(e[1]);
535 }
536
537 static ex f_dummy(const exprseq &e)
538 {
539         throw(std::logic_error("dummy function called (shouldn't happen)"));
540 }
541
542 // Tables for initializing the "fcns" map and the function help topics
543 struct fcn_init {
544         const char *name;
545         fcnp p;
546         int num_params;
547 };
548
549 static const fcn_init builtin_fcns[] = {
550         {"charpoly", f_charpoly, 2},
551         {"coeff", f_coeff, 3},
552         {"collect", f_collect, 2},
553         {"collect_common_factors", f_collect_common_factors, 1},
554         {"collect_distributed", f_collect_distributed, 2},
555         {"content", f_content, 2},
556         {"convert_H_to_Li", f_convert_H_to_Li, 2},
557         {"decomp_rational", f_decomp_rational, 2},
558         {"degree", f_degree, 2},
559         {"denom", f_denom, 1},
560         {"determinant", f_determinant, 1},
561         {"diag", f_diag, 0},
562         {"diff", f_diff2, 2},
563         {"diff", f_diff3, 3},
564         {"divide", f_divide, 2},
565         {"eval", f_eval1, 1},
566         {"eval", f_eval2, 2},
567         {"evalf", f_evalf1, 1},
568         {"evalf", f_evalf2, 2},
569         {"evalm", f_evalm, 1},
570         {"expand", f_expand, 1},
571         {"find", f_find, 2},
572         {"gcd", f_gcd, 2},
573         {"has", f_has, 2},
574         {"inverse", f_inverse, 1},
575         {"iprint", f_dummy, 0},      // for Tab-completion
576         {"is", f_is, 1},
577         {"lcm", f_lcm, 2},
578         {"lcoeff", f_lcoeff, 2},
579         {"ldegree", f_ldegree, 2},
580         {"lsolve", f_lsolve, 2},
581         {"map", f_map, 2},
582         {"match", f_match, 2},
583         {"nops", f_nops, 1},
584         {"normal", f_normal1, 1},
585         {"normal", f_normal2, 2},
586         {"numer", f_numer, 1},
587         {"numer_denom", f_numer_denom, 1},
588         {"op", f_op, 2},
589         {"pow", f_pow, 2},
590         {"prem", f_prem, 3},
591         {"primpart", f_primpart, 2},
592         {"print", f_dummy, 0},       // for Tab-completion
593         {"print_csrc", f_dummy, 0},  // for Tab-completion
594         {"print_latex", f_dummy, 0}, // for Tab-completion
595         {"quo", f_quo, 3},
596         {"rank", f_rank, 1},
597         {"rem", f_rem, 3},
598         {"resultant", f_resultant, 3},
599         {"series", f_series, 3},
600         {"sprem", f_sprem, 3},
601         {"sqrfree", f_sqrfree1, 1},
602         {"sqrfree", f_sqrfree2, 2},
603         {"sqrt", f_sqrt, 1},
604         {"subs", f_subs2, 2},
605         {"subs", f_subs3, 3},
606         {"tcoeff", f_tcoeff, 2},
607         {"time", f_dummy, 0},        // for Tab-completion
608         {"trace", f_trace, 1},
609         {"transpose", f_transpose, 1},
610         {"unassign", f_unassign, 1},
611         {"unit", f_unit, 2},
612         {NULL, f_dummy, 0}           // End marker
613 };
614
615 struct fcn_help_init {
616         const char *name;
617         const char *help;
618 };
619
620 static const fcn_help_init builtin_help[] = {
621         {"acos", "inverse cosine function"},
622         {"acosh", "inverse hyperbolic cosine function"},
623         {"asin", "inverse sine function"},
624         {"asinh", "inverse hyperbolic sine function"},
625         {"atan", "inverse tangent function"},
626         {"atan2", "inverse tangent function with two arguments"},
627         {"atanh", "inverse hyperbolic tangent function"},
628         {"beta", "Beta function"},
629         {"binomial", "binomial function"},
630         {"cos", "cosine function"},
631         {"cosh", "hyperbolic cosine function"},
632         {"exp", "exponential function"},
633         {"factorial", "factorial function"},
634         {"lgamma", "natural logarithm of Gamma function"},
635         {"tgamma", "Gamma function"},
636         {"log", "natural logarithm"},
637         {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
638         {"sin", "sine function"},
639         {"sinh", "hyperbolic sine function"},
640         {"tan", "tangent function"},
641         {"tanh", "hyperbolic tangent function"},
642         {"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"},
643         {"Li2", "dilogarithm"},
644         {"Li3", "trilogarithm"},
645         {"Li", "(multiple) polylogarithm"},
646         {"S", "Nielsen's generalized polylogarithm"},
647         {"H", "harmonic polylogarithm"},
648         {"Order", "order term function (for truncated power series)"},
649         {"Derivative", "inert differential operator"},
650         {NULL, NULL}    // End marker
651 };
652
653 #include "ginsh_extensions.h"
654
655
656 /*
657  *  Add functions to ginsh
658  */
659
660 // Functions from fcn_init array
661 static void insert_fcns(const fcn_init *p)
662 {
663         while (p->name) {
664                 fcns.insert(make_pair(string(p->name), fcn_desc(p->p, p->num_params)));
665                 p++;
666         }
667 }
668
669 static ex f_ginac_function(const exprseq &es, int serial)
670 {
671         return function(serial, es).eval(1);
672 }
673
674 // All registered GiNaC functions
675 void GiNaC::ginsh_get_ginac_functions(void)
676 {
677         vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
678         unsigned serial = 0;
679         while (i != end) {
680                 fcns.insert(make_pair(i->get_name(), fcn_desc(f_ginac_function, i->get_nparams(), serial)));
681                 ++i;
682                 serial++;
683         }
684 }
685
686
687 /*
688  *  Find a function given a name and number of parameters. Throw exceptions on error.
689  */
690
691 static fcn_tab::const_iterator find_function(const ex &sym, int req_params)
692 {
693         const string &name = ex_to<symbol>(sym).get_name();
694         typedef fcn_tab::const_iterator I;
695         pair<I, I> b = fcns.equal_range(name);
696         if (b.first == b.second)
697                 throw(std::logic_error("unknown function '" + name + "'"));
698         else {
699                 for (I i=b.first; i!=b.second; i++)
700                         if ((i->second.num_params == 0) || (i->second.num_params == req_params))
701                                 return i;
702         }
703         throw(std::logic_error("invalid number of arguments to " + name + "()"));
704 }
705
706
707 /*
708  *  Insert help strings
709  */
710
711 // Normal help string
712 static void insert_help(const char *topic, const char *str)
713 {
714         help.insert(make_pair(string(topic), string(str)));
715 }
716
717 // Help string for functions, automatically generates synopsis
718 static void insert_fcn_help(const char *name, const char *str)
719 {
720         typedef fcn_tab::const_iterator I;
721         pair<I, I> b = fcns.equal_range(name);
722         if (b.first != b.second) {
723                 string help_str = string(name) + "(";
724                 for (int i=0; i<b.first->second.num_params; i++) {
725                         if (i)
726                                 help_str += ", ";
727                         help_str += "expression";
728                 }
729                 help_str += ") - ";
730                 help_str += str;
731                 help.insert(make_pair(string(name), help_str));
732         }
733 }
734
735 // Help strings for functions from fcn_help_init array
736 static void insert_help(const fcn_help_init *p)
737 {
738         while (p->name) {
739                 insert_fcn_help(p->name, p->help);
740                 p++;
741         }
742 }
743
744
745 /*
746  *  Print help to cout
747  */
748
749 // Help for a given topic
750 static void print_help(const string &topic)
751 {
752         typedef help_tab::const_iterator I;
753         pair<I, I> b = help.equal_range(topic);
754         if (b.first == b.second)
755                 cout << "no help for '" << topic << "'\n";
756         else {
757                 for (I i=b.first; i!=b.second; i++)
758                         cout << i->second << endl;
759         }
760 }
761
762 // List of help topics
763 static void print_help_topics(void)
764 {
765         cout << "Available help topics:\n";
766         help_tab::const_iterator i;
767         string last_name = string("*");
768         int num = 0;
769         for (i=help.begin(); i!=help.end(); i++) {
770                 // Don't print duplicates
771                 if (i->first != last_name) {
772                         if (num)
773                                 cout << ", ";
774                         num++;
775                         cout << i->first;
776                         last_name = i->first;
777                 }
778         }
779         cout << "\nTo get help for a certain topic, type ?topic\n";
780 }
781
782
783 /*
784  *  Function name completion functions for readline
785  */
786
787 static char *fcn_generator(const char *text, int state)
788 {
789         static int len;                         // Length of word to complete
790         static fcn_tab::const_iterator index;   // Iterator to function being currently considered
791
792         // If this is a new word to complete, initialize now
793         if (state == 0) {
794                 index = fcns.begin();
795                 len = strlen(text);
796         }
797
798         // Return the next function which partially matches
799         while (index != fcns.end()) {
800                 const char *fcn_name = index->first.c_str();
801                 ++index;
802                 if (strncmp(fcn_name, text, len) == 0)
803                         return strdup(fcn_name);
804         }
805         return NULL;
806 }
807
808 static char **fcn_completion(const char *text, int start, int end)
809 {
810         if (rl_line_buffer[0] == '!') {
811                 // For shell commands, revert back to filename completion
812                 rl_completion_append_character = orig_completion_append_character;
813                 rl_basic_word_break_characters = orig_basic_word_break_characters;
814                 rl_completer_word_break_characters = rl_basic_word_break_characters;
815 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
816                 return completion_matches(const_cast<char *>(text), (CPFunction *)filename_completion_function);
817 #else
818                 return rl_completion_matches(text, rl_filename_completion_function);
819 #endif
820         } else {
821                 // Otherwise, complete function names
822                 rl_completion_append_character = '(';
823                 rl_basic_word_break_characters = " \t\n\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~";
824                 rl_completer_word_break_characters = rl_basic_word_break_characters;
825 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
826                 return completion_matches(const_cast<char *>(text), (CPFunction *)fcn_generator);
827 #else
828                 return rl_completion_matches(text, fcn_generator);
829 #endif
830         }
831 }
832
833 void greeting(void)
834 {
835     cout << "ginsh - GiNaC Interactive Shell (" << PACKAGE << " V" << VERSION << ")" << endl;
836     cout << "  __,  _______  Copyright (C) 1999-2004 Johannes Gutenberg University Mainz,\n"
837          << " (__) *       | Germany.  This is free software with ABSOLUTELY NO WARRANTY.\n"
838          << "  ._) i N a C | You are welcome to redistribute it under certain conditions.\n"
839          << "<-------------' For details type `warranty;'.\n" << endl;
840     cout << "Type ?? for a list of help topics." << endl;
841 }
842
843 /*
844  *  Main program
845  */
846
847 int main(int argc, char **argv)
848 {
849         // Print banner in interactive mode
850         if (isatty(0)) 
851                 greeting();
852
853         // Init function table
854         insert_fcns(builtin_fcns);
855         insert_fcns(extended_fcns);
856         ginsh_get_ginac_functions();
857
858         // Init help for operators (automatically generated from man page)
859         insert_help("operators", "Operators in falling order of precedence:");
860 #include "ginsh_op_help.h"
861
862         // Init help for built-in functions (automatically generated from man page)
863 #include "ginsh_fcn_help.h"
864
865         // Help for GiNaC functions is added manually
866         insert_help(builtin_help);
867         insert_help(extended_help);
868
869         // Help for other keywords
870         insert_help("print", "print(expression) - dumps the internal structure of the given expression (for debugging)");
871         insert_help("iprint", "iprint(expression) - prints the given integer expression in decimal, octal, and hexadecimal bases");
872         insert_help("print_latex", "print_latex(expression) - prints a LaTeX representation of the given expression");
873         insert_help("print_csrc", "print_csrc(expression) - prints a C source code representation of the given expression");
874
875         // Init readline completer
876         rl_readline_name = argv[0];
877 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
878         rl_attempted_completion_function = (CPPFunction *)fcn_completion;
879 #else
880         rl_attempted_completion_function = fcn_completion;
881 #endif
882         orig_completion_append_character = rl_completion_append_character;
883         orig_basic_word_break_characters = rl_basic_word_break_characters;
884
885         // Init input file list, open first file
886         num_files = argc - 1;
887         file_list = argv + 1;
888         if (num_files) {
889                 yyin = fopen(*file_list, "r");
890                 if (yyin == NULL) {
891                         cerr << "Can't open " << *file_list << endl;
892                         exit(1);
893                 }
894                 num_files--;
895                 file_list++;
896         }
897
898         // Parse input, catch all remaining exceptions
899         int result;
900 again:  try {
901                 result = yyparse();
902         } catch (exception &e) {
903                 cerr << e.what() << endl;
904                 goto again;
905         }
906         return result;
907 }