* Made function "convert_H_notation" available to ginsh
[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-2003 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
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_TIME {getrusage(RUSAGE_SELF, &start_time);} '(' exp ')' {
206                 getrusage(RUSAGE_SELF, &end_time);
207                 cout << (end_time.ru_utime.tv_sec - start_time.ru_utime.tv_sec) +
208                         (end_time.ru_stime.tv_sec - start_time.ru_stime.tv_sec) +
209                          double(end_time.ru_utime.tv_usec - start_time.ru_utime.tv_usec) / 1e6 +
210                          double(end_time.ru_stime.tv_usec - start_time.ru_stime.tv_usec) / 1e6 << 's' << endl;
211         }
212         | error ';'             {yyclearin; yyerrok;}
213         | error ':'             {yyclearin; yyerrok;}
214         ;
215
216 exp     : T_NUMBER              {$$ = $1;}
217         | T_SYMBOL              {$$ = $1.eval();}
218         | '\'' T_SYMBOL '\''    {$$ = $2;}
219         | T_LITERAL             {$$ = $1;}
220         | T_DIGITS              {$$ = $1;}
221         | T_QUOTE               {$$ = exstack[0];}
222         | T_QUOTE2              {$$ = exstack[1];}
223         | T_QUOTE3              {$$ = exstack[2];}
224         | T_SYMBOL '(' exprseq ')' {
225                 fcn_tab::const_iterator i = find_function($1, $3.nops());
226                 if (i->second.is_ginac) {
227                         $$ = ((fcnp2)(i->second.p))(ex_to<exprseq>($3), i->second.serial);
228                 } else {
229                         $$ = (i->second.p)(ex_to<exprseq>($3));
230                 }
231         }
232         | T_DIGITS '=' T_NUMBER {$$ = $3; Digits = ex_to<numeric>($3).to_int();}
233         | T_SYMBOL '=' exp      {$$ = $3; const_cast<symbol&>(ex_to<symbol>($1)).assign($3);}
234         | exp T_EQUAL exp       {$$ = $1 == $3;}
235         | exp T_NOTEQ exp       {$$ = $1 != $3;}
236         | exp '<' exp           {$$ = $1 < $3;}
237         | exp T_LESSEQ exp      {$$ = $1 <= $3;}
238         | exp '>' exp           {$$ = $1 > $3;}
239         | exp T_GREATEREQ exp   {$$ = $1 >= $3;}
240         | exp '+' exp           {$$ = $1 + $3;}
241         | exp '-' exp           {$$ = $1 - $3;}
242         | exp '*' exp           {$$ = $1 * $3;}
243         | exp '/' exp           {$$ = $1 / $3;}
244         | '-' exp %prec NEG     {$$ = -$2;}
245         | '+' exp %prec NEG     {$$ = $2;}
246         | exp '^' exp           {$$ = power($1, $3);}
247         | exp '!'               {$$ = factorial($1);}
248         | '(' exp ')'           {$$ = $2;}
249         | '{' list_or_empty '}' {$$ = $2;}
250         | '[' matrix ']'        {$$ = lst_to_matrix(ex_to<lst>($2));}
251         ;
252
253 exprseq : exp                   {$$ = exprseq($1);}
254         | exprseq ',' exp       {exprseq es(ex_to<exprseq>($1)); $$ = es.append($3);}
255         ;
256
257 list_or_empty: /* empty */      {$$ = *new lst;}
258         | list                  {$$ = $1;}
259         ;
260
261 list    : exp                   {$$ = lst($1);}
262         | list ',' exp          {lst l(ex_to<lst>($1)); $$ = l.append($3);}
263         ;
264
265 matrix  : '[' row ']'           {$$ = lst($2);}
266         | matrix ',' '[' row ']' {lst l(ex_to<lst>($1)); $$ = l.append($4);}
267         ;
268
269 row     : exp                   {$$ = lst($1);}
270         | row ',' exp           {lst l(ex_to<lst>($1)); $$ = l.append($3);}
271         ;
272
273
274 /*
275  *  Routines
276  */
277
278 %%
279 // Error print routine
280 int yyerror(char *s)
281 {
282         cerr << s << " at " << yytext << endl;
283         return 0;
284 }
285
286 // Push expression "e" onto the expression stack (for ", "" and """)
287 static void push(const ex &e)
288 {
289         exstack[2] = exstack[1];
290         exstack[1] = exstack[0];
291         exstack[0] = e;
292 }
293
294
295 /*
296  *  Built-in functions
297  */
298
299 static ex f_collect(const exprseq &e) {return e[0].collect(e[1]);}
300 static ex f_collect_distributed(const exprseq &e) {return e[0].collect(e[1], true);}
301 static ex f_collect_common_factors(const exprseq &e) {return collect_common_factors(e[0]);}
302 static ex f_convert_H_notation(const exprseq &e) {return convert_H_notation(e[0], e[1]);}
303 static ex f_degree(const exprseq &e) {return e[0].degree(e[1]);}
304 static ex f_denom(const exprseq &e) {return e[0].denom();}
305 static ex f_eval1(const exprseq &e) {return e[0].eval();}
306 static ex f_evalf1(const exprseq &e) {return e[0].evalf();}
307 static ex f_evalm(const exprseq &e) {return e[0].evalm();}
308 static ex f_expand(const exprseq &e) {return e[0].expand();}
309 static ex f_gcd(const exprseq &e) {return gcd(e[0], e[1]);}
310 static ex f_has(const exprseq &e) {return e[0].has(e[1]) ? ex(1) : ex(0);}
311 static ex f_lcm(const exprseq &e) {return lcm(e[0], e[1]);}
312 static ex f_lcoeff(const exprseq &e) {return e[0].lcoeff(e[1]);}
313 static ex f_ldegree(const exprseq &e) {return e[0].ldegree(e[1]);}
314 static ex f_lsolve(const exprseq &e) {return lsolve(e[0], e[1]);}
315 static ex f_nops(const exprseq &e) {return e[0].nops();}
316 static ex f_normal1(const exprseq &e) {return e[0].normal();}
317 static ex f_numer(const exprseq &e) {return e[0].numer();}
318 static ex f_numer_denom(const exprseq &e) {return e[0].numer_denom();}
319 static ex f_pow(const exprseq &e) {return pow(e[0], e[1]);}
320 static ex f_sqrt(const exprseq &e) {return sqrt(e[0]);}
321 static ex f_sqrfree1(const exprseq &e) {return sqrfree(e[0]);}
322 static ex f_subs2(const exprseq &e) {return e[0].subs(e[1]);}
323 static ex f_tcoeff(const exprseq &e) {return e[0].tcoeff(e[1]);}
324
325 #define CHECK_ARG(num, type, fcn) if (!is_a<type>(e[num])) throw(std::invalid_argument("argument " #num " to " #fcn "() must be a " #type))
326
327 static ex f_charpoly(const exprseq &e)
328 {
329         CHECK_ARG(0, matrix, charpoly);
330         return ex_to<matrix>(e[0]).charpoly(e[1]);
331 }
332
333 static ex f_coeff(const exprseq &e)
334 {
335         CHECK_ARG(2, numeric, coeff);
336         return e[0].coeff(e[1], ex_to<numeric>(e[2]).to_int());
337 }
338
339 static ex f_content(const exprseq &e)
340 {
341         return e[0].content(e[1]);
342 }
343
344 static ex f_decomp_rational(const exprseq &e)
345 {
346         return decomp_rational(e[0], e[1]);
347 }
348
349 static ex f_determinant(const exprseq &e)
350 {
351         CHECK_ARG(0, matrix, determinant);
352         return ex_to<matrix>(e[0]).determinant();
353 }
354
355 static ex f_diag(const exprseq &e)
356 {
357         size_t dim = e.nops();
358         matrix &m = *new matrix(dim, dim);
359         for (size_t i=0; i<dim; i++)
360                 m.set(i, i, e.op(i));
361         return m;
362 }
363
364 static ex f_diff2(const exprseq &e)
365 {
366         CHECK_ARG(1, symbol, diff);
367         return e[0].diff(ex_to<symbol>(e[1]));
368 }
369
370 static ex f_diff3(const exprseq &e)
371 {
372         CHECK_ARG(1, symbol, diff);
373         CHECK_ARG(2, numeric, diff);
374         return e[0].diff(ex_to<symbol>(e[1]), ex_to<numeric>(e[2]).to_int());
375 }
376
377 static ex f_divide(const exprseq &e)
378 {
379         ex q;
380         if (divide(e[0], e[1], q))
381                 return q;
382         else
383                 return fail();
384 }
385
386 static ex f_eval2(const exprseq &e)
387 {
388         CHECK_ARG(1, numeric, eval);
389         return e[0].eval(ex_to<numeric>(e[1]).to_int());
390 }
391
392 static ex f_evalf2(const exprseq &e)
393 {
394         CHECK_ARG(1, numeric, evalf);
395         return e[0].evalf(ex_to<numeric>(e[1]).to_int());
396 }
397
398 static ex f_find(const exprseq &e)
399 {
400         lst found;
401         e[0].find(e[1], found);
402         return found;
403 }
404
405 static ex f_inverse(const exprseq &e)
406 {
407         CHECK_ARG(0, matrix, inverse);
408         return ex_to<matrix>(e[0]).inverse();
409 }
410
411 static ex f_is(const exprseq &e)
412 {
413         CHECK_ARG(0, relational, is);
414         return (bool)ex_to<relational>(e[0]) ? ex(1) : ex(0);
415 }
416
417 class apply_map_function : public map_function {
418         ex apply;
419 public:
420         apply_map_function(const ex & a) : apply(a) {}
421         virtual ~apply_map_function() {}
422         ex operator()(const ex & e) { return apply.subs(wild() == e, true); }
423 };
424
425 static ex f_map(const exprseq &e)
426 {
427         apply_map_function fcn(e[1]);
428         return e[0].map(fcn);
429 }
430
431 static ex f_match(const exprseq &e)
432 {
433         lst repl_lst;
434         if (e[0].match(e[1], repl_lst))
435                 return repl_lst;
436         else
437                 return fail();
438 }
439
440 static ex f_normal2(const exprseq &e)
441 {
442         CHECK_ARG(1, numeric, normal);
443         return e[0].normal(ex_to<numeric>(e[1]).to_int());
444 }
445
446 static ex f_op(const exprseq &e)
447 {
448         CHECK_ARG(1, numeric, op);
449         int n = ex_to<numeric>(e[1]).to_int();
450         if (n < 0 || n >= (int)e[0].nops())
451                 throw(std::out_of_range("second argument to op() is out of range"));
452         return e[0].op(n);
453 }
454
455 static ex f_prem(const exprseq &e)
456 {
457         return prem(e[0], e[1], e[2]);
458 }
459
460 static ex f_primpart(const exprseq &e)
461 {
462         return e[0].primpart(e[1]);
463 }
464
465 static ex f_quo(const exprseq &e)
466 {
467         return quo(e[0], e[1], e[2]);
468 }
469
470 static ex f_rem(const exprseq &e)
471 {
472         return rem(e[0], e[1], e[2]);
473 }
474
475 static ex f_series(const exprseq &e)
476 {
477         CHECK_ARG(2, numeric, series);
478         return e[0].series(e[1], ex_to<numeric>(e[2]).to_int());
479 }
480
481 static ex f_sprem(const exprseq &e)
482 {
483         return sprem(e[0], e[1], e[2]);
484 }
485
486 static ex f_sqrfree2(const exprseq &e)
487 {
488         CHECK_ARG(1, lst, sqrfree);
489         return sqrfree(e[0], ex_to<lst>(e[1]));
490 }
491
492 static ex f_subs3(const exprseq &e)
493 {
494         CHECK_ARG(1, lst, subs);
495         CHECK_ARG(2, lst, subs);
496         return e[0].subs(ex_to<lst>(e[1]), ex_to<lst>(e[2]));
497 }
498
499 static ex f_trace(const exprseq &e)
500 {
501         CHECK_ARG(0, matrix, trace);
502         return ex_to<matrix>(e[0]).trace();
503 }
504
505 static ex f_transpose(const exprseq &e)
506 {
507         CHECK_ARG(0, matrix, transpose);
508         return ex_to<matrix>(e[0]).transpose();
509 }
510
511 static ex f_unassign(const exprseq &e)
512 {
513         CHECK_ARG(0, symbol, unassign);
514         const_cast<symbol&>(ex_to<symbol>(e[0])).unassign();
515         return e[0];
516 }
517
518 static ex f_unit(const exprseq &e)
519 {
520         return e[0].unit(e[1]);
521 }
522
523 static ex f_dummy(const exprseq &e)
524 {
525         throw(std::logic_error("dummy function called (shouldn't happen)"));
526 }
527
528 // Tables for initializing the "fcns" map and the function help topics
529 struct fcn_init {
530         const char *name;
531         fcnp p;
532         int num_params;
533 };
534
535 static const fcn_init builtin_fcns[] = {
536         {"charpoly", f_charpoly, 2},
537         {"coeff", f_coeff, 3},
538         {"collect", f_collect, 2},
539         {"collect_common_factors", f_collect_common_factors, 1},
540         {"collect_distributed", f_collect_distributed, 2},
541         {"content", f_content, 2},
542         {"convert_H_notation", f_convert_H_notation, 2},
543         {"decomp_rational", f_decomp_rational, 2},
544         {"degree", f_degree, 2},
545         {"denom", f_denom, 1},
546         {"determinant", f_determinant, 1},
547         {"diag", f_diag, 0},
548         {"diff", f_diff2, 2},
549         {"diff", f_diff3, 3},
550         {"divide", f_divide, 2},
551         {"eval", f_eval1, 1},
552         {"eval", f_eval2, 2},
553         {"evalf", f_evalf1, 1},
554         {"evalf", f_evalf2, 2},
555         {"evalm", f_evalm, 1},
556         {"expand", f_expand, 1},
557         {"find", f_find, 2},
558         {"gcd", f_gcd, 2},
559         {"has", f_has, 2},
560         {"inverse", f_inverse, 1},
561         {"iprint", f_dummy, 0},      // for Tab-completion
562         {"is", f_is, 1},
563         {"lcm", f_lcm, 2},
564         {"lcoeff", f_lcoeff, 2},
565         {"ldegree", f_ldegree, 2},
566         {"lsolve", f_lsolve, 2},
567         {"map", f_map, 2},
568         {"match", f_match, 2},
569         {"nops", f_nops, 1},
570         {"normal", f_normal1, 1},
571         {"normal", f_normal2, 2},
572         {"numer", f_numer, 1},
573         {"numer_denom", f_numer_denom, 1},
574         {"op", f_op, 2},
575         {"pow", f_pow, 2},
576         {"prem", f_prem, 3},
577         {"primpart", f_primpart, 2},
578         {"print", f_dummy, 0},       // for Tab-completion
579         {"print_csrc", f_dummy, 0},  // for Tab-completion
580         {"print_latex", f_dummy, 0}, // for Tab-completion
581         {"quo", f_quo, 3},
582         {"rem", f_rem, 3},
583         {"series", f_series, 3},
584         {"sprem", f_sprem, 3},
585         {"sqrfree", f_sqrfree1, 1},
586         {"sqrfree", f_sqrfree2, 2},
587         {"sqrt", f_sqrt, 1},
588         {"subs", f_subs2, 2},
589         {"subs", f_subs3, 3},
590         {"tcoeff", f_tcoeff, 2},
591         {"time", f_dummy, 0},        // for Tab-completion
592         {"trace", f_trace, 1},
593         {"transpose", f_transpose, 1},
594         {"unassign", f_unassign, 1},
595         {"unit", f_unit, 2},
596         {NULL, f_dummy, 0}           // End marker
597 };
598
599 struct fcn_help_init {
600         const char *name;
601         const char *help;
602 };
603
604 static const fcn_help_init builtin_help[] = {
605         {"acos", "inverse cosine function"},
606         {"acosh", "inverse hyperbolic cosine function"},
607         {"asin", "inverse sine function"},
608         {"asinh", "inverse hyperbolic sine function"},
609         {"atan", "inverse tangent function"},
610         {"atan2", "inverse tangent function with two arguments"},
611         {"atanh", "inverse hyperbolic tangent function"},
612         {"beta", "Beta function"},
613         {"binomial", "binomial function"},
614         {"cos", "cosine function"},
615         {"cosh", "hyperbolic cosine function"},
616         {"exp", "exponential function"},
617         {"factorial", "factorial function"},
618         {"lgamma", "natural logarithm of Gamma function"},
619         {"tgamma", "Gamma function"},
620         {"log", "natural logarithm"},
621         {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
622         {"sin", "sine function"},
623         {"sinh", "hyperbolic sine function"},
624         {"tan", "tangent function"},
625         {"tanh", "hyperbolic tangent function"},
626         {"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"},
627         {"Li2", "dilogarithm"},
628         {"Li3", "trilogarithm"},
629         {"Li", "(multiple) polylogarithm"},
630         {"S", "Nielsen's generalized polylogarithm"},
631         {"H", "harmonic polylogarithm"},
632         {"Order", "order term function (for truncated power series)"},
633         {"Derivative", "inert differential operator"},
634         {NULL, NULL}    // End marker
635 };
636
637 #include "ginsh_extensions.h"
638
639
640 /*
641  *  Add functions to ginsh
642  */
643
644 // Functions from fcn_init array
645 static void insert_fcns(const fcn_init *p)
646 {
647         while (p->name) {
648                 fcns.insert(make_pair(string(p->name), fcn_desc(p->p, p->num_params)));
649                 p++;
650         }
651 }
652
653 static ex f_ginac_function(const exprseq &es, int serial)
654 {
655         return function(serial, es).eval(1);
656 }
657
658 // All registered GiNaC functions
659 void GiNaC::ginsh_get_ginac_functions(void)
660 {
661         vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
662         unsigned serial = 0;
663         while (i != end) {
664                 fcns.insert(make_pair(i->get_name(), fcn_desc(f_ginac_function, i->get_nparams(), serial)));
665                 ++i;
666                 serial++;
667         }
668 }
669
670
671 /*
672  *  Find a function given a name and number of parameters. Throw exceptions on error.
673  */
674
675 static fcn_tab::const_iterator find_function(const ex &sym, int req_params)
676 {
677         const string &name = ex_to<symbol>(sym).get_name();
678         typedef fcn_tab::const_iterator I;
679         pair<I, I> b = fcns.equal_range(name);
680         if (b.first == b.second)
681                 throw(std::logic_error("unknown function '" + name + "'"));
682         else {
683                 for (I i=b.first; i!=b.second; i++)
684                         if ((i->second.num_params == 0) || (i->second.num_params == req_params))
685                                 return i;
686         }
687         throw(std::logic_error("invalid number of arguments to " + name + "()"));
688 }
689
690
691 /*
692  *  Insert help strings
693  */
694
695 // Normal help string
696 static void insert_help(const char *topic, const char *str)
697 {
698         help.insert(make_pair(string(topic), string(str)));
699 }
700
701 // Help string for functions, automatically generates synopsis
702 static void insert_fcn_help(const char *name, const char *str)
703 {
704         typedef fcn_tab::const_iterator I;
705         pair<I, I> b = fcns.equal_range(name);
706         if (b.first != b.second) {
707                 string help_str = string(name) + "(";
708                 for (int i=0; i<b.first->second.num_params; i++) {
709                         if (i)
710                                 help_str += ", ";
711                         help_str += "expression";
712                 }
713                 help_str += ") - ";
714                 help_str += str;
715                 help.insert(make_pair(string(name), help_str));
716         }
717 }
718
719 // Help strings for functions from fcn_help_init array
720 static void insert_help(const fcn_help_init *p)
721 {
722         while (p->name) {
723                 insert_fcn_help(p->name, p->help);
724                 p++;
725         }
726 }
727
728
729 /*
730  *  Print help to cout
731  */
732
733 // Help for a given topic
734 static void print_help(const string &topic)
735 {
736         typedef help_tab::const_iterator I;
737         pair<I, I> b = help.equal_range(topic);
738         if (b.first == b.second)
739                 cout << "no help for '" << topic << "'\n";
740         else {
741                 for (I i=b.first; i!=b.second; i++)
742                         cout << i->second << endl;
743         }
744 }
745
746 // List of help topics
747 static void print_help_topics(void)
748 {
749         cout << "Available help topics:\n";
750         help_tab::const_iterator i;
751         string last_name = string("*");
752         int num = 0;
753         for (i=help.begin(); i!=help.end(); i++) {
754                 // Don't print duplicates
755                 if (i->first != last_name) {
756                         if (num)
757                                 cout << ", ";
758                         num++;
759                         cout << i->first;
760                         last_name = i->first;
761                 }
762         }
763         cout << "\nTo get help for a certain topic, type ?topic\n";
764 }
765
766
767 /*
768  *  Function name completion functions for readline
769  */
770
771 static char *fcn_generator(const char *text, int state)
772 {
773         static int len;                         // Length of word to complete
774         static fcn_tab::const_iterator index;   // Iterator to function being currently considered
775
776         // If this is a new word to complete, initialize now
777         if (state == 0) {
778                 index = fcns.begin();
779                 len = strlen(text);
780         }
781
782         // Return the next function which partially matches
783         while (index != fcns.end()) {
784                 const char *fcn_name = index->first.c_str();
785                 ++index;
786                 if (strncmp(fcn_name, text, len) == 0)
787                         return strdup(fcn_name);
788         }
789         return NULL;
790 }
791
792 static char **fcn_completion(const char *text, int start, int end)
793 {
794         if (rl_line_buffer[0] == '!') {
795                 // For shell commands, revert back to filename completion
796                 rl_completion_append_character = orig_completion_append_character;
797                 rl_basic_word_break_characters = orig_basic_word_break_characters;
798                 rl_completer_word_break_characters = rl_basic_word_break_characters;
799 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
800                 return completion_matches(const_cast<char *>(text), (CPFunction *)filename_completion_function);
801 #else
802                 return rl_completion_matches(text, rl_filename_completion_function);
803 #endif
804         } else {
805                 // Otherwise, complete function names
806                 rl_completion_append_character = '(';
807                 rl_basic_word_break_characters = " \t\n\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~";
808                 rl_completer_word_break_characters = rl_basic_word_break_characters;
809 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
810                 return completion_matches(const_cast<char *>(text), (CPFunction *)fcn_generator);
811 #else
812                 return rl_completion_matches(text, fcn_generator);
813 #endif
814         }
815 }
816
817 void greeting(void)
818 {
819     cout << "ginsh - GiNaC Interactive Shell (" << PACKAGE << " V" << VERSION << ")" << endl;
820     cout << "  __,  _______  Copyright (C) 1999-2003 Johannes Gutenberg University Mainz,\n"
821          << " (__) *       | Germany.  This is free software with ABSOLUTELY NO WARRANTY.\n"
822          << "  ._) i N a C | You are welcome to redistribute it under certain conditions.\n"
823          << "<-------------' For details type `warranty;'.\n" << endl;
824     cout << "Type ?? for a list of help topics." << endl;
825 }
826
827 /*
828  *  Main program
829  */
830
831 int main(int argc, char **argv)
832 {
833         // Print banner in interactive mode
834         if (isatty(0)) 
835                 greeting();
836
837         // Init function table
838         insert_fcns(builtin_fcns);
839         insert_fcns(extended_fcns);
840         ginsh_get_ginac_functions();
841
842         // Init help for operators (automatically generated from man page)
843         insert_help("operators", "Operators in falling order of precedence:");
844 #include "ginsh_op_help.h"
845
846         // Init help for built-in functions (automatically generated from man page)
847 #include "ginsh_fcn_help.h"
848
849         // Help for GiNaC functions is added manually
850         insert_help(builtin_help);
851         insert_help(extended_help);
852
853         // Help for other keywords
854         insert_help("print", "print(expression) - dumps the internal structure of the given expression (for debugging)");
855         insert_help("iprint", "iprint(expression) - prints the given integer expression in decimal, octal, and hexadecimal bases");
856         insert_help("print_latex", "print_latex(expression) - prints a LaTeX representation of the given expression");
857         insert_help("print_csrc", "print_csrc(expression) - prints a C source code representation of the given expression");
858
859         // Init readline completer
860         rl_readline_name = argv[0];
861 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
862         rl_attempted_completion_function = (CPPFunction *)fcn_completion;
863 #else
864         rl_attempted_completion_function = fcn_completion;
865 #endif
866         orig_completion_append_character = rl_completion_append_character;
867         orig_basic_word_break_characters = rl_basic_word_break_characters;
868
869         // Init input file list, open first file
870         num_files = argc - 1;
871         file_list = argv + 1;
872         if (num_files) {
873                 yyin = fopen(*file_list, "r");
874                 if (yyin == NULL) {
875                         cerr << "Can't open " << *file_list << endl;
876                         exit(1);
877                 }
878                 num_files--;
879                 file_list++;
880         }
881
882         // Parse input, catch all remaining exceptions
883         int result;
884 again:  try {
885                 result = yyparse();
886         } catch (exception &e) {
887                 cerr << e.what() << endl;
888                 goto again;
889         }
890         return result;
891 }