ginac/container.pl

   1 if (($#ARGV!=0) and ($#ARGV!=1)) {
   2         die 'usage: container.pl type [maxargs] (type=lst or exprseq)';
   3 }
   4
   5 if ($ARGV[0] eq 'lst') {
   6         $type='lst';
   7 } elsif ($ARGV[0] eq 'exprseq') {
   8         $type='exprseq';
   9 } else {
  10         die 'only lst and exprseq supported';
  11 }
  12
  13 if ($#ARGV==1) {
  14         $maxargs=$ARGV[1];
  15 } else {
  16         $maxargs=16; # must be greater or equal than the value used in function.pl
  17 }
  18
  19 if ($type eq 'exprseq') {
  20
  21         # settings for exprseq
  22         $CONTAINER="exprseq";
  23         $STLHEADER="vector";
  24         $reserve=1;
  25         $prepend=0;
  26         $let_op=0;
  27         $open_bracket='(';
  28         $close_bracket=')';
  29
  30 } elsif ($type eq 'lst') {
  31
  32         # settings for lst
  33         $CONTAINER="lst";
  34         $STLHEADER="list";
  35         $reserve=0;
  36         $prepend=1;
  37         $let_op=1;
  38         $open_bracket='{';
  39         $close_bracket='}';
  40
  41 } else {
  42         die "invalid type $type";
  43 }
  44
  45 $CONTAINER_UC=uc(${CONTAINER});
  46 $STLT="ex".$STLHEADER;
  47
  48 if ($reserve) {
  49         $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) (s).reserve(size)";
  50 } else {
  51         $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) // no reserve needed for ${STLHEADER}";
  52 }
  53
  54 if ($prepend) {
  55         $PREPEND_INTERFACE=<<END_OF_PREPEND_INTERFACE;
  56         virtual ${CONTAINER} & prepend(const ex & b);
  57         virtual ${CONTAINER} & remove_first(void);
  58 END_OF_PREPEND_INTERFACE
  59
  60         $PREPEND_IMPLEMENTATION=<<END_OF_PREPEND_IMPLEMENTATION;
  61 ${CONTAINER} & ${CONTAINER}::prepend(const ex & b)
  62 {
  63         ensure_if_modifiable();
  64         seq.push_front(b);
  65         return *this;
  66 }
  67 ${CONTAINER} & ${CONTAINER}::remove_first(void)
  68 {
  69         ensure_if_modifiable();
  70         seq.pop_front();
  71         return *this;
  72 }
  73 END_OF_PREPEND_IMPLEMENTATION
  74 } else {
  75         $PREPEND_INTERFACE="    // no prepend possible for ${CONTAINER}";
  76         $PREPEND_IMPLEMENTATION="";
  77 }
  78
  79 if ($let_op) {
  80         $LET_OP_IMPLEMENTATION=<<END_OF_LET_OP_IMPLEMENTATION
  81 ex & ${CONTAINER}::let_op(int i)
  82 {
  83         GINAC_ASSERT(i>=0);
  84         GINAC_ASSERT(i<nops());
  85
  86         ${STLT}::iterator it=seq.begin();
  87         for (int j=0; j<i; j++) {
  88                 ++it;
  89         }
  90         return *it;
  91 }
  92 END_OF_LET_OP_IMPLEMENTATION
  93 } else {
  94         $LET_OP_IMPLEMENTATION="// ${CONTAINER}::let_op() will be implemented by user elsewhere";
  95 }
  96
  97 sub generate_seq {
  98         my ($seq_template,$n,$separator)=@_;
  99         my ($res,$N);
 100
 101         $res='';
 102         for ($N=1; $N<=$n; $N++) {
 103                 $res .= eval('"' . $seq_template . '"');
 104                 if ($N!=$n) {
 105                         $res .= $separator;
 106                 }
 107         }
 108         return $res;
 109 }
 110
 111 sub generate_from_to {
 112         my ($template,$seq_template1,$seq_separator1,$seq_template2,
 113             $seq_separator2,$from,$to)=@_;
 114         my ($res,$N,$SEQ);
 115
 116         $res='';
 117         for ($N=$from; $N<=$to; $N++) {
 118                 $SEQ1=generate_seq($seq_template1,$N,$seq_separator1);
 119                 $SEQ2=generate_seq($seq_template2,$N,$seq_separator2);
 120                 $res .= eval('"' . $template . '"');
 121                 $SEQ1=''; # to avoid main::SEQ1 used only once warning
 122                 $SEQ2=''; # same as above
 123         }
 124         return $res;
 125 }
 126
 127 sub generate {
 128         my ($template,$seq_template1,$seq_separator1,$seq_template2,
 129             $seq_separator2)=@_;
 130         return generate_from_to($template,$seq_template1,$seq_separator1,
 131                                                         $seq_template2,$seq_separator2,1,$maxargs);
 132 }
 133
 134 $constructors_interface=generate(
 135 '       explicit ${CONTAINER}(${SEQ1});'."\n",
 136 'const ex & param${N}',', ','','');
 137
 138 $constructors_implementation=generate(
 139         <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}',', ','    seq.push_back(param${N});',"\n");
 140 ${CONTAINER}::${CONTAINER}(${SEQ1}) : basic(TINFO_${CONTAINER})
 141 {
 142         debugmsg(\"${CONTAINER} ctor from ${N}*ex\",LOGLEVEL_CONSTRUCT);
 143         RESERVE(seq,${N});
 144 ${SEQ2}
 145 }
 146 END_OF_CONSTRUCTORS_IMPLEMENTATION
 147
 148 $interface=<<END_OF_INTERFACE;
 149 /** \@file ${CONTAINER}.h
 150  *
 151  *  Definition of GiNaC's ${CONTAINER}. */
 152
 153 /*
 154  *  This file was generated automatically by container.pl.
 155  *  Please do not modify it directly, edit the perl script instead!
 156  *  container.pl options: \$CONTAINER=${CONTAINER}
 157  *                        \$STLHEADER=${STLHEADER}
 158  *                        \$reserve=${reserve}
 159  *                        \$prepend=${prepend}
 160  *                        \$let_op=${let_op}
 161  *                        \$open_bracket=${open_bracket}
 162  *                        \$close_bracket=${close_bracket}
 163  *                        \$maxargs=${maxargs}
 164  *
 165  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
 166  *
 167  *  This program is free software; you can redistribute it and/or modify
 168  *  it under the terms of the GNU General Public License as published by
 169  *  the Free Software Foundation; either version 2 of the License, or
 170  *  (at your option) any later version.
 171  *
 172  *  This program is distributed in the hope that it will be useful,
 173  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 174  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 175  *  GNU General Public License for more details.
 176  *
 177  *  You should have received a copy of the GNU General Public License
 178  *  along with this program; if not, write to the Free Software
 179  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 180  */
 181
 182 #ifndef __GINAC_${CONTAINER_UC}_H__
 183 #define __GINAC_${CONTAINER_UC}_H__
 184
 185 #include <${STLHEADER}>
 186
 187 // CINT needs <algorithm> to work properly with <vector> and <list>
 188 #include <algorithm>
 189
 190 #include "basic.h"
 191 #include "ex.h"
 192
 193 namespace GiNaC {
 194
 195
 196 typedef std::${STLHEADER}<ex> ${STLT};
 197
 198 class ${CONTAINER} : public basic
 199 {
 200         GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
 201
 202 public:
 203         ${CONTAINER}(${STLT} const & s, bool discardable=0);
 204         ${CONTAINER}(${STLT} * vp); // vp will be deleted
 205 ${constructors_interface}
 206
 207 public:
 208         void print(const print_context & c, unsigned level = 0) const;
 209         unsigned precedence(void) const {return 10;}
 210         bool info(unsigned inf) const;
 211         unsigned nops() const;
 212         ex & let_op(int i);
 213         ex map(map_function & f) const;
 214         ex eval(int level=0) const;
 215         ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
 216 protected:
 217         bool is_equal_same_type(const basic & other) const;
 218         unsigned return_type(void) const;
 219
 220         // new virtual functions which can be overridden by derived classes
 221 public:
 222         virtual ${CONTAINER} & append(const ex & b);
 223         virtual ${CONTAINER} & remove_last(void);
 224 ${PREPEND_INTERFACE}
 225 protected:
 226         virtual void printseq(const print_context & c, char openbracket, char delim,
 227                               char closebracket, unsigned this_precedence,
 228                               unsigned upper_precedence = 0) const;
 229         virtual ex this${CONTAINER}(${STLT} const & v) const;
 230         virtual ex this${CONTAINER}(${STLT} * vp) const;
 231
 232 protected:
 233         bool is_canonical() const;
 234         ${STLT} evalchildren(int level) const;
 235         ${STLT} * subschildren(const lst & ls, const lst & lr, bool no_pattern = false) const;
 236
 237 protected:
 238         ${STLT} seq;
 239 };
 240
 241 // utility functions
 242
 243 /** Return the ${CONTAINER} object handled by an ex.  Deprecated: use ex_to<${CONTAINER}>().
 244  *  This is unsafe: you need to check the type first. */
 245 inline const ${CONTAINER} &ex_to_${CONTAINER}(const ex &e)
 246 {
 247         return static_cast<const ${CONTAINER} &>(*e.bp);
 248 }
 249
 250 /** Specialization of is_exactly_a<${CONTAINER}>(obj) for ${CONTAINER} objects. */
 251 template<> inline bool is_exactly_a<${CONTAINER}>(const basic & obj)
 252 {
 253         return obj.tinfo()==TINFO_${CONTAINER};
 254 }
 255
 256 inline ${CONTAINER} &ex_to_nonconst_${CONTAINER}(const ex &e)
 257 {
 258         return static_cast<${CONTAINER} &>(*e.bp);
 259 }
 260
 261 } // namespace GiNaC
 262
 263 #endif // ndef __GINAC_${CONTAINER_UC}_H__
 264
 265 END_OF_INTERFACE
 266
 267 $implementation=<<END_OF_IMPLEMENTATION;
 268 /** \@file ${CONTAINER}.cpp
 269  *
 270  *  Implementation of GiNaC's ${CONTAINER}. */
 271
 272 /*
 273  *  This file was generated automatically by container.pl.
 274  *  Please do not modify it directly, edit the perl script instead!
 275  *  container.pl options: \$CONTAINER=${CONTAINER}
 276  *                        \$STLHEADER=${STLHEADER}
 277  *                        \$reserve=${reserve}
 278  *                        \$prepend=${prepend}
 279  *                        \$let_op=${let_op}
 280  *                        \$open_bracket=${open_bracket}
 281  *                        \$close_bracket=${close_bracket}
 282  *                        \$maxargs=${maxargs}
 283  *
 284  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
 285  *
 286  *  This program is free software; you can redistribute it and/or modify
 287  *  it under the terms of the GNU General Public License as published by
 288  *  the Free Software Foundation; either version 2 of the License, or
 289  *  (at your option) any later version.
 290  *
 291  *  This program is distributed in the hope that it will be useful,
 292  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 293  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 294  *  GNU General Public License for more details.
 295  *
 296  *  You should have received a copy of the GNU General Public License
 297  *  along with this program; if not, write to the Free Software
 298  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 299  */
 300
 301 #include <iostream>
 302 #include <stdexcept>
 303
 304 #include "${CONTAINER}.h"
 305 #include "ex.h"
 306 #include "print.h"
 307 #include "archive.h"
 308 #include "debugmsg.h"
 309
 310 namespace GiNaC {
 311
 312 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
 313
 314 ${RESERVE_IMPLEMENTATION}
 315
 316 //////////
 317 // default ctor, dtor, copy ctor assignment operator and helpers
 318 //////////
 319
 320 // public
 321
 322 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
 323 {
 324         debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
 325 }
 326
 327 // protected
 328
 329 void ${CONTAINER}::copy(${CONTAINER} const & other)
 330 {
 331         inherited::copy(other);
 332         seq=other.seq;
 333 }
 334
 335 void ${CONTAINER}::destroy(bool call_parent)
 336 {
 337         seq.clear();
 338         if (call_parent) inherited::destroy(call_parent);
 339 }
 340
 341 //////////
 342 // other ctors
 343 //////////
 344
 345 // public
 346
 347 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) :  basic(TINFO_${CONTAINER})
 348 {
 349         debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
 350         if (discardable) {
 351                 seq.swap(const_cast<${STLT} &>(s));
 352         } else {
 353                 seq=s;
 354         }
 355 }
 356
 357 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
 358 {
 359         debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
 360         GINAC_ASSERT(vp!=0);
 361         seq.swap(*vp);
 362         delete vp;
 363 }
 364
 365 ${constructors_implementation}
 366
 367 //////////
 368 // archiving
 369 //////////
 370
 371 /** Construct object from archive_node. */
 372 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
 373 {
 374         debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
 375         for (unsigned int i=0; true; i++) {
 376                 ex e;
 377                 if (n.find_ex("seq", e, sym_lst, i))
 378                         seq.push_back(e);
 379                 else
 380                         break;
 381         }
 382 }
 383
 384 /** Unarchive the object. */
 385 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
 386 {
 387         return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
 388 }
 389
 390 /** Archive the object. */
 391 void ${CONTAINER}::archive(archive_node &n) const
 392 {
 393         inherited::archive(n);
 394         ${STLT}::const_iterator i = seq.begin(), iend = seq.end();
 395         while (i != iend) {
 396                 n.add_ex("seq", *i);
 397                 i++;
 398         }
 399 }
 400
 401 //////////
 402 // functions overriding virtual functions from bases classes
 403 //////////
 404
 405 // public
 406
 407 void ${CONTAINER}::print(const print_context & c, unsigned level) const
 408 {
 409         debugmsg("${CONTAINER} print", LOGLEVEL_PRINT);
 410
 411         if (is_a<print_tree>(c)) {
 412
 413                 c.s << std::string(level, ' ') << class_name()
 414                     << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
 415                     << ", nops=" << nops()
 416                     << std::endl;
 417                 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
 418                 for (${STLT}::const_iterator cit=seq.begin(); cit!=seq.end(); ++cit)
 419                         cit->print(c, level + delta_indent);
 420                 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
 421
 422         } else {
 423                 // always print brackets around seq, ignore upper_precedence
 424                 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence(), precedence()+1);
 425         }
 426 }
 427
 428 // ${CONTAINER}::info() will be implemented by user elsewhere";
 429
 430 unsigned ${CONTAINER}::nops() const
 431 {
 432         return seq.size();
 433 }
 434
 435 ${LET_OP_IMPLEMENTATION}
 436
 437 ex ${CONTAINER}::map(map_function & f) const
 438 {
 439         ${STLT} s;
 440         RESERVE(s,seq.size());
 441         for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
 442                 s.push_back(f(*it));
 443         }
 444
 445         return this${CONTAINER}(s);
 446 }
 447
 448 ex ${CONTAINER}::eval(int level) const
 449 {
 450         if (level==1) {
 451                 return this->hold();
 452         }
 453         return this${CONTAINER}(evalchildren(level));
 454 }
 455
 456 ex ${CONTAINER}::subs(const lst & ls, const lst & lr, bool no_pattern) const
 457 {
 458         ${STLT} *vp = subschildren(ls, lr, no_pattern);
 459         if (vp)
 460                 return this${CONTAINER}(vp).bp->basic::subs(ls, lr, no_pattern);
 461         else
 462                 return basic::subs(ls, lr, no_pattern);
 463 }
 464
 465 // protected
 466
 467 int ${CONTAINER}::compare_same_type(const basic & other) const
 468 {
 469         GINAC_ASSERT(is_a<${CONTAINER}>(other));
 470         ${CONTAINER} const & o = static_cast<const ${CONTAINER} &>(other);
 471
 472         ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
 473                                 it2 = o.seq.begin(), it2end = o.seq.end();
 474
 475         while (it1 != it1end && it2 != it2end) {
 476                 int cmpval = it1->compare(*it2);
 477                 if (cmpval)
 478                         return cmpval;
 479                 ++it1; ++it2;
 480         }
 481
 482         return (it1 == it1end) ? (it2 == it2end ? 0 : -1) : 1;
 483 }
 484
 485 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
 486 {
 487         GINAC_ASSERT(is_a<${CONTAINER}>(other));
 488         ${CONTAINER} const &o = static_cast<const ${CONTAINER} &>(other);
 489
 490         if (seq.size() != o.seq.size())
 491                 return false;
 492
 493         ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
 494                                 it2 = o.seq.begin();
 495
 496         while (it1 != it1end) {
 497                 if (!it1->is_equal(*it2))
 498                         return false;
 499                 ++it1; ++it2;
 500         }
 501
 502         return true;
 503 }
 504
 505 unsigned ${CONTAINER}::return_type(void) const
 506 {
 507         return return_types::noncommutative_composite;
 508 }
 509
 510 //////////
 511 // new virtual functions which can be overridden by derived classes
 512 //////////
 513
 514 // public
 515
 516 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
 517 {
 518         ensure_if_modifiable();
 519         seq.push_back(b);
 520         return *this;
 521 }
 522
 523 ${CONTAINER} & ${CONTAINER}::remove_last(void)
 524 {
 525         ensure_if_modifiable();
 526         seq.pop_back();
 527         return *this;
 528 }
 529
 530 ${PREPEND_IMPLEMENTATION}
 531
 532 // protected
 533
 534 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
 535                             char closebracket, unsigned this_precedence,
 536                             unsigned upper_precedence) const
 537 {
 538         if (this_precedence <= upper_precedence)
 539                 c.s << openbracket;
 540
 541         if (seq.size() != 0) {
 542                 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
 543                 --itend;
 544                 while (it != itend) {
 545                         it->print(c, this_precedence);
 546                         c.s << delim;
 547                         it++;
 548                 }
 549                 it->print(c, this_precedence);
 550         }
 551
 552         if (this_precedence <= upper_precedence)
 553                 c.s << closebracket;
 554 }
 555
 556 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
 557 {
 558         return ${CONTAINER}(v);
 559 }
 560
 561 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
 562 {
 563         return ${CONTAINER}(vp);
 564 }
 565
 566 //////////
 567 // non-virtual functions in this class
 568 //////////
 569
 570 // public
 571
 572 // none
 573
 574 // protected
 575
 576 bool ${CONTAINER}::is_canonical() const
 577 {
 578         if (seq.size()<=1) { return 1; }
 579
 580         ${STLT}::const_iterator it=seq.begin();
 581         ${STLT}::const_iterator it_last=it;
 582         for (++it; it!=seq.end(); it_last=it, ++it) {
 583                 if ((*it_last).compare(*it)>0) {
 584                         if ((*it_last).compare(*it)>0) {
 585                                 std::cout << *it_last << ">" << *it << "\\n";
 586                                 return 0;
 587                         }
 588                 }
 589         }
 590         return 1;
 591 }
 592
 593
 594 ${STLT} ${CONTAINER}::evalchildren(int level) const
 595 {
 596         ${STLT} s;
 597         RESERVE(s,seq.size());
 598
 599         if (level==1) {
 600                 return seq;
 601         }
 602         if (level == -max_recursion_level) {
 603                 throw(std::runtime_error("max recursion level reached"));
 604         }
 605         --level;
 606         for (${STLT}::const_iterator it=seq.begin(); it!=seq.end(); ++it) {
 607                 s.push_back((*it).eval(level));
 608         }
 609         return s;
 610 }
 611
 612 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr, bool no_pattern) const
 613 {
 614         // returns a NULL pointer if nothing had to be substituted
 615         // returns a pointer to a newly created epvector otherwise
 616         // (which has to be deleted somewhere else)
 617
 618         ${STLT}::const_iterator last=seq.end();
 619         ${STLT}::const_iterator cit=seq.begin();
 620         while (cit!=last) {
 621                 const ex & subsed_ex=(*cit).subs(ls,lr,no_pattern);
 622                 if (!are_ex_trivially_equal(*cit,subsed_ex)) {
 623
 624                         // something changed, copy seq, subs and return it
 625                         ${STLT} *s=new ${STLT};
 626                         RESERVE(*s,seq.size());
 627
 628                         // copy parts of seq which are known not to have changed
 629                         ${STLT}::const_iterator cit2=seq.begin();
 630                         while (cit2!=cit) {
 631                                 s->push_back(*cit2);
 632                                 ++cit2;
 633                         }
 634                         // copy first changed element
 635                         s->push_back(subsed_ex);
 636                         ++cit2;
 637                         // copy rest
 638                         while (cit2!=last) {
 639                                 s->push_back((*cit2).subs(ls,lr,no_pattern));
 640                                 ++cit2;
 641                         }
 642                         return s;
 643                 }
 644                 ++cit;
 645         }
 646
 647         return 0; // nothing has changed
 648 }
 649
 650 } // namespace GiNaC
 651
 652 END_OF_IMPLEMENTATION
 653
 654 print "Creating interface file ${CONTAINER}.h...";
 655 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
 656 print OUT $interface;
 657 close OUT;
 658 print "ok.\n";
 659
 660 print "Creating implementation file ${CONTAINER}.cpp...";
 661 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
 662 print OUT $implementation;
 663 close OUT;
 664 print "ok.\n";
 665
 666 print "done.\n";