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