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