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