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