ginsh/ginsh_parser.yy

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