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-2004 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 #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_expand(const exprseq &e) {return e[0].expand();}
 317 static ex f_gcd(const exprseq &e) {return gcd(e[0], e[1]);}
 318 static ex f_has(const exprseq &e) {return e[0].has(e[1]) ? ex(1) : ex(0);}
 319 static ex f_lcm(const exprseq &e) {return lcm(e[0], e[1]);}
 320 static ex f_lcoeff(const exprseq &e) {return e[0].lcoeff(e[1]);}
 321 static ex f_ldegree(const exprseq &e) {return e[0].ldegree(e[1]);}
 322 static ex f_lsolve(const exprseq &e) {return lsolve(e[0], e[1]);}
 323 static ex f_nops(const exprseq &e) {return e[0].nops();}
 324 static ex f_normal1(const exprseq &e) {return e[0].normal();}
 325 static ex f_numer(const exprseq &e) {return e[0].numer();}
 326 static ex f_numer_denom(const exprseq &e) {return e[0].numer_denom();}
 327 static ex f_pow(const exprseq &e) {return pow(e[0], e[1]);}
 328 static ex f_sqrt(const exprseq &e) {return sqrt(e[0]);}
 329 static ex f_sqrfree1(const exprseq &e) {return sqrfree(e[0]);}
 330 static ex f_subs2(const exprseq &e) {return e[0].subs(e[1]);}
 331 static ex f_tcoeff(const exprseq &e) {return e[0].tcoeff(e[1]);}
 332
 333 #define CHECK_ARG(num, type, fcn) if (!is_a<type>(e[num])) throw(std::invalid_argument("argument " #num " to " #fcn "() must be a " #type))
 334
 335 static ex f_charpoly(const exprseq &e)
 336 {
 337         CHECK_ARG(0, matrix, charpoly);
 338         return ex_to<matrix>(e[0]).charpoly(e[1]);
 339 }
 340
 341 static ex f_coeff(const exprseq &e)
 342 {
 343         CHECK_ARG(2, numeric, coeff);
 344         return e[0].coeff(e[1], ex_to<numeric>(e[2]).to_int());
 345 }
 346
 347 static ex f_content(const exprseq &e)
 348 {
 349         return e[0].content(e[1]);
 350 }
 351
 352 static ex f_decomp_rational(const exprseq &e)
 353 {
 354         return decomp_rational(e[0], e[1]);
 355 }
 356
 357 static ex f_determinant(const exprseq &e)
 358 {
 359         CHECK_ARG(0, matrix, determinant);
 360         return ex_to<matrix>(e[0]).determinant();
 361 }
 362
 363 static ex f_diag(const exprseq &e)
 364 {
 365         size_t dim = e.nops();
 366         matrix &m = *new matrix(dim, dim);
 367         for (size_t i=0; i<dim; i++)
 368                 m.set(i, i, e.op(i));
 369         return m;
 370 }
 371
 372 static ex f_diff2(const exprseq &e)
 373 {
 374         CHECK_ARG(1, symbol, diff);
 375         return e[0].diff(ex_to<symbol>(e[1]));
 376 }
 377
 378 static ex f_diff3(const exprseq &e)
 379 {
 380         CHECK_ARG(1, symbol, diff);
 381         CHECK_ARG(2, numeric, diff);
 382         return e[0].diff(ex_to<symbol>(e[1]), ex_to<numeric>(e[2]).to_int());
 383 }
 384
 385 static ex f_divide(const exprseq &e)
 386 {
 387         ex q;
 388         if (divide(e[0], e[1], q))
 389                 return q;
 390         else
 391                 return fail();
 392 }
 393
 394 static ex f_eval2(const exprseq &e)
 395 {
 396         CHECK_ARG(1, numeric, eval);
 397         return e[0].eval(ex_to<numeric>(e[1]).to_int());
 398 }
 399
 400 static ex f_evalf2(const exprseq &e)
 401 {
 402         CHECK_ARG(1, numeric, evalf);
 403         return e[0].evalf(ex_to<numeric>(e[1]).to_int());
 404 }
 405
 406 static ex f_find(const exprseq &e)
 407 {
 408         lst found;
 409         e[0].find(e[1], found);
 410         return found;
 411 }
 412
 413 static ex f_integer_content(const exprseq &e)
 414 {
 415         return e[0].expand().integer_content();
 416 }
 417
 418 static ex f_inverse(const exprseq &e)
 419 {
 420         CHECK_ARG(0, matrix, inverse);
 421         return ex_to<matrix>(e[0]).inverse();
 422 }
 423
 424 static ex f_is(const exprseq &e)
 425 {
 426         CHECK_ARG(0, relational, is);
 427         return (bool)ex_to<relational>(e[0]) ? ex(1) : ex(0);
 428 }
 429
 430 class apply_map_function : public map_function {
 431         ex apply;
 432 public:
 433         apply_map_function(const ex & a) : apply(a) {}
 434         virtual ~apply_map_function() {}
 435         ex operator()(const ex & e) { return apply.subs(wild() == e, true); }
 436 };
 437
 438 static ex f_map(const exprseq &e)
 439 {
 440         apply_map_function fcn(e[1]);
 441         return e[0].map(fcn);
 442 }
 443
 444 static ex f_match(const exprseq &e)
 445 {
 446         lst repl_lst;
 447         if (e[0].match(e[1], repl_lst))
 448                 return repl_lst;
 449         else
 450                 return fail();
 451 }
 452
 453 static ex f_normal2(const exprseq &e)
 454 {
 455         CHECK_ARG(1, numeric, normal);
 456         return e[0].normal(ex_to<numeric>(e[1]).to_int());
 457 }
 458
 459 static ex f_op(const exprseq &e)
 460 {
 461         CHECK_ARG(1, numeric, op);
 462         int n = ex_to<numeric>(e[1]).to_int();
 463         if (n < 0 || n >= (int)e[0].nops())
 464                 throw(std::out_of_range("second argument to op() is out of range"));
 465         return e[0].op(n);
 466 }
 467
 468 static ex f_prem(const exprseq &e)
 469 {
 470         return prem(e[0], e[1], e[2]);
 471 }
 472
 473 static ex f_primpart(const exprseq &e)
 474 {
 475         return e[0].primpart(e[1]);
 476 }
 477
 478 static ex f_quo(const exprseq &e)
 479 {
 480         return quo(e[0], e[1], e[2]);
 481 }
 482
 483 static ex f_rank(const exprseq &e)
 484 {
 485         CHECK_ARG(0, matrix, rank);
 486         return ex_to<matrix>(e[0]).rank();
 487 }
 488
 489 static ex f_rem(const exprseq &e)
 490 {
 491         return rem(e[0], e[1], e[2]);
 492 }
 493
 494 static ex f_resultant(const exprseq &e)
 495 {
 496         CHECK_ARG(2, symbol, resultant);
 497         return resultant(e[0], e[1], ex_to<symbol>(e[2]));
 498 }
 499
 500 static ex f_series(const exprseq &e)
 501 {
 502         CHECK_ARG(2, numeric, series);
 503         return e[0].series(e[1], ex_to<numeric>(e[2]).to_int());
 504 }
 505
 506 static ex f_sprem(const exprseq &e)
 507 {
 508         return sprem(e[0], e[1], e[2]);
 509 }
 510
 511 static ex f_sqrfree2(const exprseq &e)
 512 {
 513         CHECK_ARG(1, lst, sqrfree);
 514         return sqrfree(e[0], ex_to<lst>(e[1]));
 515 }
 516
 517 static ex f_subs3(const exprseq &e)
 518 {
 519         CHECK_ARG(1, lst, subs);
 520         CHECK_ARG(2, lst, subs);
 521         return e[0].subs(ex_to<lst>(e[1]), ex_to<lst>(e[2]));
 522 }
 523
 524 static ex f_trace(const exprseq &e)
 525 {
 526         CHECK_ARG(0, matrix, trace);
 527         return ex_to<matrix>(e[0]).trace();
 528 }
 529
 530 static ex f_transpose(const exprseq &e)
 531 {
 532         CHECK_ARG(0, matrix, transpose);
 533         return ex_to<matrix>(e[0]).transpose();
 534 }
 535
 536 static ex f_unassign(const exprseq &e)
 537 {
 538         CHECK_ARG(0, symbol, unassign);
 539         const_cast<symbol&>(ex_to<symbol>(e[0])).unassign();
 540         return e[0];
 541 }
 542
 543 static ex f_unit(const exprseq &e)
 544 {
 545         return e[0].unit(e[1]);
 546 }
 547
 548 static ex f_dummy(const exprseq &e)
 549 {
 550         throw(std::logic_error("dummy function called (shouldn't happen)"));
 551 }
 552
 553 // Tables for initializing the "fcns" map and the function help topics
 554 struct fcn_init {
 555         const char *name;
 556         fcnp p;
 557         int num_params;
 558 };
 559
 560 static const fcn_init builtin_fcns[] = {
 561         {"charpoly", f_charpoly, 2},
 562         {"coeff", f_coeff, 3},
 563         {"collect", f_collect, 2},
 564         {"collect_common_factors", f_collect_common_factors, 1},
 565         {"collect_distributed", f_collect_distributed, 2},
 566         {"content", f_content, 2},
 567         {"convert_H_to_Li", f_convert_H_to_Li, 2},
 568         {"decomp_rational", f_decomp_rational, 2},
 569         {"degree", f_degree, 2},
 570         {"denom", f_denom, 1},
 571         {"determinant", f_determinant, 1},
 572         {"diag", f_diag, 0},
 573         {"diff", f_diff2, 2},
 574         {"diff", f_diff3, 3},
 575         {"divide", f_divide, 2},
 576         {"eval", f_eval1, 1},
 577         {"eval", f_eval2, 2},
 578         {"evalf", f_evalf1, 1},
 579         {"evalf", f_evalf2, 2},
 580         {"evalm", f_evalm, 1},
 581         {"expand", f_expand, 1},
 582         {"find", f_find, 2},
 583         {"gcd", f_gcd, 2},
 584         {"has", f_has, 2},
 585         {"integer_content", f_integer_content, 1},
 586         {"inverse", f_inverse, 1},
 587         {"iprint", f_dummy, 0},      // for Tab-completion
 588         {"is", f_is, 1},
 589         {"lcm", f_lcm, 2},
 590         {"lcoeff", f_lcoeff, 2},
 591         {"ldegree", f_ldegree, 2},
 592         {"lsolve", f_lsolve, 2},
 593         {"map", f_map, 2},
 594         {"match", f_match, 2},
 595         {"nops", f_nops, 1},
 596         {"normal", f_normal1, 1},
 597         {"normal", f_normal2, 2},
 598         {"numer", f_numer, 1},
 599         {"numer_denom", f_numer_denom, 1},
 600         {"op", f_op, 2},
 601         {"pow", f_pow, 2},
 602         {"prem", f_prem, 3},
 603         {"primpart", f_primpart, 2},
 604         {"print", f_dummy, 0},       // for Tab-completion
 605         {"print_csrc", f_dummy, 0},  // for Tab-completion
 606         {"print_latex", f_dummy, 0}, // for Tab-completion
 607         {"quo", f_quo, 3},
 608         {"rank", f_rank, 1},
 609         {"rem", f_rem, 3},
 610         {"resultant", f_resultant, 3},
 611         {"series", f_series, 3},
 612         {"sprem", f_sprem, 3},
 613         {"sqrfree", f_sqrfree1, 1},
 614         {"sqrfree", f_sqrfree2, 2},
 615         {"sqrt", f_sqrt, 1},
 616         {"subs", f_subs2, 2},
 617         {"subs", f_subs3, 3},
 618         {"tcoeff", f_tcoeff, 2},
 619         {"time", f_dummy, 0},        // for Tab-completion
 620         {"trace", f_trace, 1},
 621         {"transpose", f_transpose, 1},
 622         {"unassign", f_unassign, 1},
 623         {"unit", f_unit, 2},
 624         {NULL, f_dummy, 0}           // End marker
 625 };
 626
 627 struct fcn_help_init {
 628         const char *name;
 629         const char *help;
 630 };
 631
 632 static const fcn_help_init builtin_help[] = {
 633         {"acos", "inverse cosine function"},
 634         {"acosh", "inverse hyperbolic cosine function"},
 635         {"asin", "inverse sine function"},
 636         {"asinh", "inverse hyperbolic sine function"},
 637         {"atan", "inverse tangent function"},
 638         {"atan2", "inverse tangent function with two arguments"},
 639         {"atanh", "inverse hyperbolic tangent function"},
 640         {"beta", "Beta function"},
 641         {"binomial", "binomial function"},
 642         {"cos", "cosine function"},
 643         {"cosh", "hyperbolic cosine function"},
 644         {"exp", "exponential function"},
 645         {"factorial", "factorial function"},
 646         {"lgamma", "natural logarithm of Gamma function"},
 647         {"tgamma", "Gamma function"},
 648         {"log", "natural logarithm"},
 649         {"psi", "psi function\npsi(x) is the digamma function, psi(n,x) the nth polygamma function"},
 650         {"sin", "sine function"},
 651         {"sinh", "hyperbolic sine function"},
 652         {"tan", "tangent function"},
 653         {"tanh", "hyperbolic tangent function"},
 654         {"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"},
 655         {"Li2", "dilogarithm"},
 656         {"Li3", "trilogarithm"},
 657         {"Li", "(multiple) polylogarithm"},
 658         {"S", "Nielsen's generalized polylogarithm"},
 659         {"H", "harmonic polylogarithm"},
 660         {"Order", "order term function (for truncated power series)"},
 661         {"Derivative", "inert differential operator"},
 662         {NULL, NULL}    // End marker
 663 };
 664
 665 #include "ginsh_extensions.h"
 666
 667
 668 /*
 669  *  Add functions to ginsh
 670  */
 671
 672 // Functions from fcn_init array
 673 static void insert_fcns(const fcn_init *p)
 674 {
 675         while (p->name) {
 676                 fcns.insert(make_pair(string(p->name), fcn_desc(p->p, p->num_params)));
 677                 p++;
 678         }
 679 }
 680
 681 static ex f_ginac_function(const exprseq &es, int serial)
 682 {
 683         return function(serial, es).eval(1);
 684 }
 685
 686 // All registered GiNaC functions
 687 void GiNaC::ginsh_get_ginac_functions(void)
 688 {
 689         vector<function_options>::const_iterator i = function::registered_functions().begin(), end = function::registered_functions().end();
 690         unsigned serial = 0;
 691         while (i != end) {
 692                 fcns.insert(make_pair(i->get_name(), fcn_desc(f_ginac_function, i->get_nparams(), serial)));
 693                 ++i;
 694                 serial++;
 695         }
 696 }
 697
 698
 699 /*
 700  *  Find a function given a name and number of parameters. Throw exceptions on error.
 701  */
 702
 703 static fcn_tab::const_iterator find_function(const ex &sym, int req_params)
 704 {
 705         const string &name = ex_to<symbol>(sym).get_name();
 706         typedef fcn_tab::const_iterator I;
 707         pair<I, I> b = fcns.equal_range(name);
 708         if (b.first == b.second)
 709                 throw(std::logic_error("unknown function '" + name + "'"));
 710         else {
 711                 for (I i=b.first; i!=b.second; i++)
 712                         if ((i->second.num_params == 0) || (i->second.num_params == req_params))
 713                                 return i;
 714         }
 715         throw(std::logic_error("invalid number of arguments to " + name + "()"));
 716 }
 717
 718
 719 /*
 720  *  Insert help strings
 721  */
 722
 723 // Normal help string
 724 static void insert_help(const char *topic, const char *str)
 725 {
 726         help.insert(make_pair(string(topic), string(str)));
 727 }
 728
 729 // Help string for functions, automatically generates synopsis
 730 static void insert_fcn_help(const char *name, const char *str)
 731 {
 732         typedef fcn_tab::const_iterator I;
 733         pair<I, I> b = fcns.equal_range(name);
 734         if (b.first != b.second) {
 735                 string help_str = string(name) + "(";
 736                 for (int i=0; i<b.first->second.num_params; i++) {
 737                         if (i)
 738                                 help_str += ", ";
 739                         help_str += "expression";
 740                 }
 741                 help_str += ") - ";
 742                 help_str += str;
 743                 help.insert(make_pair(string(name), help_str));
 744         }
 745 }
 746
 747 // Help strings for functions from fcn_help_init array
 748 static void insert_help(const fcn_help_init *p)
 749 {
 750         while (p->name) {
 751                 insert_fcn_help(p->name, p->help);
 752                 p++;
 753         }
 754 }
 755
 756
 757 /*
 758  *  Print help to cout
 759  */
 760
 761 // Help for a given topic
 762 static void print_help(const string &topic)
 763 {
 764         typedef help_tab::const_iterator I;
 765         pair<I, I> b = help.equal_range(topic);
 766         if (b.first == b.second)
 767                 cout << "no help for '" << topic << "'\n";
 768         else {
 769                 for (I i=b.first; i!=b.second; i++)
 770                         cout << i->second << endl;
 771         }
 772 }
 773
 774 // List of help topics
 775 static void print_help_topics(void)
 776 {
 777         cout << "Available help topics:\n";
 778         help_tab::const_iterator i;
 779         string last_name = string("*");
 780         int num = 0;
 781         for (i=help.begin(); i!=help.end(); i++) {
 782                 // Don't print duplicates
 783                 if (i->first != last_name) {
 784                         if (num)
 785                                 cout << ", ";
 786                         num++;
 787                         cout << i->first;
 788                         last_name = i->first;
 789                 }
 790         }
 791         cout << "\nTo get help for a certain topic, type ?topic\n";
 792 }
 793
 794
 795 /*
 796  *  Function name completion functions for readline
 797  */
 798
 799 static char *fcn_generator(const char *text, int state)
 800 {
 801         static int len;                         // Length of word to complete
 802         static fcn_tab::const_iterator index;   // Iterator to function being currently considered
 803
 804         // If this is a new word to complete, initialize now
 805         if (state == 0) {
 806                 index = fcns.begin();
 807                 len = strlen(text);
 808         }
 809
 810         // Return the next function which partially matches
 811         while (index != fcns.end()) {
 812                 const char *fcn_name = index->first.c_str();
 813                 ++index;
 814                 if (strncmp(fcn_name, text, len) == 0)
 815                         return strdup(fcn_name);
 816         }
 817         return NULL;
 818 }
 819
 820 static char **fcn_completion(const char *text, int start, int end)
 821 {
 822         if (rl_line_buffer[0] == '!') {
 823                 // For shell commands, revert back to filename completion
 824                 rl_completion_append_character = orig_completion_append_character;
 825                 rl_basic_word_break_characters = orig_basic_word_break_characters;
 826                 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
 827 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
 828                 return completion_matches(const_cast<char *>(text), (CPFunction *)filename_completion_function);
 829 #else
 830                 return rl_completion_matches(text, rl_filename_completion_function);
 831 #endif
 832         } else {
 833                 // Otherwise, complete function names
 834                 rl_completion_append_character = '(';
 835                 rl_basic_word_break_characters = " \t\n\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~";
 836                 rl_completer_word_break_characters = GINAC_RL_COMPLETER_CAST(rl_basic_word_break_characters);
 837 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
 838                 return completion_matches(const_cast<char *>(text), (CPFunction *)fcn_generator);
 839 #else
 840                 return rl_completion_matches(text, fcn_generator);
 841 #endif
 842         }
 843 }
 844
 845 void greeting(void)
 846 {
 847     cout << "ginsh - GiNaC Interactive Shell (" << PACKAGE << " V" << VERSION << ")" << endl;
 848     cout << "  __,  _______  Copyright (C) 1999-2004 Johannes Gutenberg University Mainz,\n"
 849          << " (__) *       | Germany.  This is free software with ABSOLUTELY NO WARRANTY.\n"
 850          << "  ._) i N a C | You are welcome to redistribute it under certain conditions.\n"
 851          << "<-------------' For details type `warranty;'.\n" << endl;
 852     cout << "Type ?? for a list of help topics." << endl;
 853 }
 854
 855 /*
 856  *  Main program
 857  */
 858
 859 int main(int argc, char **argv)
 860 {
 861         // Print banner in interactive mode
 862         if (isatty(0))
 863                 greeting();
 864
 865         // Init function table
 866         insert_fcns(builtin_fcns);
 867         insert_fcns(extended_fcns);
 868         ginsh_get_ginac_functions();
 869
 870         // Init help for operators (automatically generated from man page)
 871         insert_help("operators", "Operators in falling order of precedence:");
 872 #include "ginsh_op_help.h"
 873
 874         // Init help for built-in functions (automatically generated from man page)
 875 #include "ginsh_fcn_help.h"
 876
 877         // Help for GiNaC functions is added manually
 878         insert_help(builtin_help);
 879         insert_help(extended_help);
 880
 881         // Help for other keywords
 882         insert_help("print", "print(expression) - dumps the internal structure of the given expression (for debugging)");
 883         insert_help("iprint", "iprint(expression) - prints the given integer expression in decimal, octal, and hexadecimal bases");
 884         insert_help("print_latex", "print_latex(expression) - prints a LaTeX representation of the given expression");
 885         insert_help("print_csrc", "print_csrc(expression) - prints a C source code representation of the given expression");
 886
 887         // Init readline completer
 888         rl_readline_name = argv[0];
 889 #if (GINAC_RL_VERSION_MAJOR < 4) || (GINAC_RL_VERSION_MAJOR == 4 && GINAC_RL_VERSION_MINOR < 2)
 890         rl_attempted_completion_function = (CPPFunction *)fcn_completion;
 891 #else
 892         rl_attempted_completion_function = fcn_completion;
 893 #endif
 894         orig_completion_append_character = rl_completion_append_character;
 895         orig_basic_word_break_characters = rl_basic_word_break_characters;
 896
 897         // Init input file list, open first file
 898         num_files = argc - 1;
 899         file_list = argv + 1;
 900         if (num_files) {
 901                 yyin = fopen(*file_list, "r");
 902                 if (yyin == NULL) {
 903                         cerr << "Can't open " << *file_list << endl;
 904                         exit(1);
 905                 }
 906                 num_files--;
 907                 file_list++;
 908         }
 909
 910         // Parse input, catch all remaining exceptions
 911         int result;
 912 again:  try {
 913                 result = yyparse();
 914         } catch (exception &e) {
 915                 cerr << e.what() << endl;
 916                 goto again;
 917         }
 918         return result;
 919 }