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