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