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