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