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