ginac/structure.pl

   1 #!/usr/bin/perl -w
   2
   3 $input_structure='';
   4 $original_input_structure='';
   5 while (<>) {
   6         $input_structure .= '// '.$_;
   7         $original_input_structure .= $_;
   8 }
   9
  10 $original_input_structure =~ tr/ \t\n\r\f/     /;
  11 $original_input_structure =~ tr/ //s;
  12
  13 if ($original_input_structure =~ /^struct (\w+) ?\{ ?(.*)\}\;? ?$/) {
  14         $STRUCTURE=$1;
  15         $decl=$2;
  16 } else {
  17         die "illegal struct, must match 'struct name { type var; /*comment*/ ...};': $original_input_structure";
  18 }
  19
  20 # split off a part 'type var[,var...];' with a possible C-comment '/* ... */'
  21 while ($decl =~ /^ ?(\w+) ([\w \,]+)\; ?((\/\*.*?\*\/)?)(.*)$/) {
  22         $type=$1;
  23         $member=$2;
  24         $comment=$3;
  25         $decl=$5;
  26         while ($member =~ /^(\w+) ?\, ?(.*)$/) {
  27                 push @TYPES,$type;
  28                 push @MEMBERS,$1;
  29                 push @COMMENTS,$comment;
  30                 if ($comment ne '') {
  31                         $comment='/* see above */';
  32                 }
  33                 $member=$2;
  34         }
  35         if ($member !~ /^\w+$/) {
  36                 die "illegal struct, must match 'struct name { type var; /*comment*/ ...};': $input_structure";
  37         }
  38         push @TYPES,$type;
  39         push @MEMBERS,$member;
  40         push @COMMENTS,$comment;
  41 }
  42
  43 if ($decl !~ /^ ?$/) {
  44         die "illegal struct, must match 'struct name { type var; /*comment*/ ...};': $input_structure";
  45 }
  46
  47 #$STRUCTURE='teststruct';
  48 $STRUCTURE_UC=uc(${STRUCTURE});
  49 #@TYPES=('ex','ex','ex');
  50 #@MEMBERS=('q10','q20','q21');
  51
  52 sub generate {
  53         my ($template,$conj)=@_;
  54         my ($res,$N);
  55
  56         $res='';
  57         for ($N=1; $N<=$#MEMBERS+1; $N++) {
  58                 $TYPE=$TYPES[$N-1];
  59                 $MEMBER=$MEMBERS[$N-1];
  60                 $COMMENT=$COMMENTS[$N-1];
  61                 $res .= eval('"' . $template . '"');
  62                 $TYPE=''; # to avoid main::TYPE used only once warning
  63                 $MEMBER=''; # same as above
  64                 $COMMENT=''; # same as above
  65                 if ($N!=$#MEMBERS+1) {
  66                         $res .= $conj;
  67                 }
  68         }
  69         return $res;
  70 }
  71
  72 $number_of_members=$#MEMBERS+1;
  73 $constructor_arglist=generate('ex tmp_${MEMBER}',', ');
  74 $member_access_functions=generate('    const ex & ${MEMBER}(void) { return m_${MEMBER}; }',"\n");
  75 $op_access_indices_decl=generate('    static unsigned op_${MEMBER};',"\n");
  76 $op_access_indices_def=generate('unsigned ${STRUCTURE}::op_${MEMBER}=${N}-1;',"\n");
  77 $members=generate('    ex m_${MEMBER}; ${COMMENT}',"\n");
  78 $copy_statements=generate('    m_${MEMBER}=other.m_${MEMBER};',"\n");
  79 $constructor_statements=generate('m_${MEMBER}(tmp_${MEMBER})',', ');
  80 $let_op_statements=generate(
  81 '    case ${N}-1:'."\n".
  82 '        return m_${MEMBER};'."\n".
  83 '        break;',
  84 "\n");
  85 $temporary_arglist=generate('tmp_${MEMBER}',', ');
  86 $expand_statements=generate('    ex tmp_${MEMBER}=m_${MEMBER}.expand(options);',"\n");
  87 $has_statements=generate('    if (m_${MEMBER}.has(other)) return true;',"\n");
  88 $eval_statements=generate(
  89 '    ex tmp_${MEMBER}=m_${MEMBER}.eval(level-1);'."\n".
  90 '    all_are_trivially_equal = all_are_trivially_equal &&'."\n".
  91 '                              are_ex_trivially_equal(tmp_${MEMBER},m_${MEMBER});',
  92 "\n");
  93 $evalf_statements=generate(
  94 '    ex tmp_${MEMBER}=m_${MEMBER}.evalf(level-1);'."\n".
  95 '    all_are_trivially_equal = all_are_trivially_equal &&'."\n".
  96 '                              are_ex_trivially_equal(tmp_${MEMBER},m_${MEMBER});',
  97 "\n");
  98 $normal_statements=generate(
  99 '    ex tmp_${MEMBER}=m_${MEMBER}.normal(level-1);'."\n".
 100 '    all_are_trivially_equal = all_are_trivially_equal &&'."\n".
 101 '                              are_ex_trivially_equal(tmp_${MEMBER},m_${MEMBER});',
 102 "\n");
 103 $diff_statements=generate('    ex tmp_${MEMBER}=m_${MEMBER}.diff(s);',"\n");
 104 $subs_statements=generate(
 105 '    ex tmp_${MEMBER}=m_${MEMBER}.subs(ls,lr);'."\n".
 106 '    all_are_trivially_equal = all_are_trivially_equal &&'."\n".
 107 '                              are_ex_trivially_equal(tmp_${MEMBER},m_${MEMBER});',
 108 "\n");
 109 $compare_statements=generate(
 110 '    cmpval=m_${MEMBER}.compare(o.m_${MEMBER});'."\n".
 111 '    if (cmpval!=0) return cmpval;',
 112 "\n");
 113 $is_equal_statements=generate('    if (!m_${MEMBER}.is_equal(o.m_${MEMBER})) return false;',"\n");
 114 $types_ok_statements=generate(
 115 '#ifndef SKIP_TYPE_CHECK_FOR_${TYPE}'."\n".
 116 '    if (!is_ex_exactly_of_type(m_${MEMBER},${TYPE})) return false;'."\n".
 117 '#endif // ndef SKIP_TYPE_CHECK_FOR_${TYPE}',"\n");
 118
 119 $interface=<<END_OF_INTERFACE;
 120 /** \@file ${STRUCTURE}.h
 121  *
 122  *  Definition of GiNaC's user defined structure ${STRUCTURE}. */
 123
 124 /*
 125  *  This file was generated automatically by structure.pl.
 126  *  Please do not modify it directly, edit the perl script instead!
 127  *
 128  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
 129  *
 130  *  This program is free software; you can redistribute it and/or modify
 131  *  it under the terms of the GNU General Public License as published by
 132  *  the Free Software Foundation; either version 2 of the License, or
 133  *  (at your option) any later version.
 134  *
 135  *  This program is distributed in the hope that it will be useful,
 136  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 137  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 138  *  GNU General Public License for more details.
 139  *
 140  *  You should have received a copy of the GNU General Public License
 141  *  along with this program; if not, write to the Free Software
 142  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 143  */
 144
 145 // structure.pl input:
 146 ${input_structure}
 147
 148 #ifndef __GINAC_${STRUCTURE_UC}_H__
 149 #define __GINAC_${STRUCTURE_UC}_H__
 150
 151 #include "structure.h"
 152
 153 namespace GiNaC {
 154
 155 class ${STRUCTURE} : public structure
 156 {
 157 // member functions
 158
 159         // default ctor, dtor, copy ctor assignment operator and helpers
 160 public:
 161         ${STRUCTURE}();
 162         ~${STRUCTURE}();
 163         ${STRUCTURE}(${STRUCTURE} const & other);
 164         ${STRUCTURE} const & operator=(${STRUCTURE} const & other);
 165 protected:
 166         void copy(${STRUCTURE} const & other);
 167         void destroy(bool call_parent);
 168
 169         // other ctors
 170 public:
 171         ${STRUCTURE}(${constructor_arglist});
 172
 173         // functions overriding virtual functions from bases classes
 174 public:
 175         basic * duplicate() const;
 176         void printraw(ostream & os) const;
 177         void print(ostream & os, unsigned upper_precedence=0) const;
 178         void printtree(ostream & os, unsigned indent) const;
 179         int nops() const;
 180         ex & let_op(int i);
 181         ex expand(unsigned options=0) const;
 182         bool has(const ex & other) const;
 183         ex eval(int level=0) const;
 184         ex evalf(int level=0) const;
 185         ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
 186         ex diff(const symbol & s) const;
 187         ex subs(const lst & ls, const lst & lr) const;
 188 protected:
 189         int compare_same_type(const basic & other) const;
 190         bool is_equal_same_type(const basic & other) const;
 191         unsigned return_type(void) const;
 192
 193         // new virtual functions which can be overridden by derived classes
 194         // none
 195
 196         // non-virtual functions in this class
 197 public:
 198 ${member_access_functions}
 199         bool types_ok(void) const;
 200
 201 // member variables
 202 protected:
 203 ${members}
 204 public:
 205 ${op_access_indices_decl}
 206 };
 207
 208 // global constants
 209
 210 extern const ${STRUCTURE} some_${STRUCTURE};
 211 extern const type_info & typeid_${STRUCTURE};
 212 extern const unsigned tinfo_${STRUCTURE};
 213
 214 // macros
 215
 216 #define ex_to_${STRUCTURE}(X) (static_cast<${STRUCTURE} const &>(*(X).bp))
 217
 218 } // namespace GiNaC
 219
 220 #endif // ndef _${STRUCTURE_UC}_H_
 221
 222 END_OF_INTERFACE
 223
 224 $implementation=<<END_OF_IMPLEMENTATION;
 225 /** \@file ${STRUCTURE}.cpp
 226  *
 227  *  Implementation of GiNaC's user defined structure ${STRUCTURE}. */
 228
 229 /*
 230  *  This file was generated automatically by STRUCTURE.pl.
 231  *  Please do not modify it directly, edit the perl script instead!
 232  *
 233  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
 234  *
 235  *  This program is free software; you can redistribute it and/or modify
 236  *  it under the terms of the GNU General Public License as published by
 237  *  the Free Software Foundation; either version 2 of the License, or
 238  *  (at your option) any later version.
 239  *
 240  *  This program is distributed in the hope that it will be useful,
 241  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 242  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 243  *  GNU General Public License for more details.
 244  *
 245  *  You should have received a copy of the GNU General Public License
 246  *  along with this program; if not, write to the Free Software
 247  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 248  */
 249
 250 // structure.pl input:
 251 ${input_structure}
 252
 253 #include <iostream>
 254
 255 #include "${STRUCTURE}.h"
 256
 257 namespace GiNaC {
 258
 259 //////////
 260 // default ctor, destructor, copy ctor assignment operator and helpers
 261 //////////
 262
 263 // public
 264
 265 ${STRUCTURE}::${STRUCTURE}()
 266 {
 267         debugmsg("${STRUCTURE} default ctor",LOGLEVEL_CONSTRUCT);
 268         tinfo_key=tinfo_${STRUCTURE};
 269 }
 270
 271 ${STRUCTURE}::~${STRUCTURE}()
 272 {
 273         debugmsg("${STRUCTURE} destructor",LOGLEVEL_DESTRUCT);
 274         destroy(false);
 275 }
 276
 277 ${STRUCTURE}::${STRUCTURE}(${STRUCTURE} const & other)
 278 {
 279         debugmsg("${STRUCTURE} copy ctor",LOGLEVEL_CONSTRUCT);
 280         copy(other);
 281 }
 282
 283 ${STRUCTURE} const & ${STRUCTURE}::operator=(${STRUCTURE} const & other)
 284 {
 285         debugmsg("${STRUCTURE} operator=",LOGLEVEL_ASSIGNMENT);
 286         if (this != &other) {
 287                 destroy(true);
 288                 copy(other);
 289         }
 290         return *this;
 291 }
 292
 293 // protected
 294
 295 void ${STRUCTURE}::copy(${STRUCTURE} const & other)
 296 {
 297         structure::copy(other);
 298 ${copy_statements}
 299 }
 300
 301 void ${STRUCTURE}::destroy(bool call_parent)
 302 {
 303         if (call_parent) structure::destroy(call_parent);
 304 }
 305
 306 //////////
 307 // other ctors
 308 //////////
 309
 310 // public
 311
 312 ${STRUCTURE}::${STRUCTURE}(${constructor_arglist})
 313         : ${constructor_statements}
 314 {
 315         debugmsg("${STRUCTURE} ctor from children", LOGLEVEL_CONSTRUCT);
 316         tinfo_key=tinfo_${STRUCTURE};
 317 }
 318
 319 //////////
 320 // functions overriding virtual functions from bases classes
 321 //////////
 322
 323 // public
 324
 325 basic * ${STRUCTURE}::duplicate() const
 326 {
 327         debugmsg("${STRUCTURE} duplicate",LOGLEVEL_DUPLICATE);
 328         return new ${STRUCTURE}(*this);
 329 }
 330
 331 void ${STRUCTURE}::printraw(ostream & os) const
 332 {
 333         debugmsg("${STRUCTURE} printraw",LOGLEVEL_PRINT);
 334         os << class_name() << "()";
 335 }
 336
 337 void ${STRUCTURE}::print(ostream & os, unsigned upper_precedence) const
 338 {
 339         debugmsg("${STRUCTURE} print",LOGLEVEL_PRINT);
 340         os << class_name() << "()";
 341 }
 342
 343 void ${STRUCTURE}::printtree(ostream & os, unsigned indent) const
 344 {
 345         debugmsg("${STRUCTURE} printtree",LOGLEVEL_PRINT);
 346         os << "${STRUCTURE}()";
 347 }
 348
 349 int ${STRUCTURE}::nops() const
 350 {
 351         return ${number_of_members};
 352 }
 353
 354 ex & ${STRUCTURE}::let_op(int i)
 355 {
 356         GINAC_ASSERT(i>=0);
 357         GINAC_ASSERT(i<nops());
 358
 359         switch (i) {
 360 ${let_op_statements}
 361         }
 362         errormsg("${STRUCTURE}::let_op(): should not reach this point");
 363         return *new ex(fail());
 364 }
 365
 366 ex ${STRUCTURE}::expand(unsigned options) const
 367 {
 368         bool all_are_trivially_equal=true;
 369 ${expand_statements}
 370         if (all_are_trivially_equal) {
 371                 return *this;
 372         }
 373         return ${STRUCTURE}(${temporary_arglist});
 374 }
 375
 376 // a ${STRUCTURE} 'has' an expression if it is this expression itself or a child 'has' it
 377
 378 bool ${STRUCTURE}::has(const ex & other) const
 379 {
 380         GINAC_ASSERT(other.bp!=0);
 381         if (is_equal(*other.bp)) return true;
 382 ${has_statements}
 383         return false;
 384 }
 385
 386 ex ${STRUCTURE}::eval(int level) const
 387 {
 388         if (level==1) {
 389                 return this->hold();
 390         }
 391         bool all_are_trivially_equal=true;
 392 ${eval_statements}
 393         if (all_are_trivially_equal) {
 394                 return this->hold();
 395         }
 396         return ${STRUCTURE}(${temporary_arglist});
 397 }
 398
 399 ex ${STRUCTURE}::evalf(int level) const
 400 {
 401         if (level==1) {
 402                 return *this;
 403         }
 404         bool all_are_trivially_equal=true;
 405 ${evalf_statements}
 406         if (all_are_trivially_equal) {
 407                 return *this;
 408         }
 409         return ${STRUCTURE}(${temporary_arglist});
 410 }
 411
 412 /** Implementation of ex::normal() for ${STRUCTURE}s. It normalizes the arguments
 413  *  and replaces the ${STRUCTURE} by a temporary symbol.
 414  *  \@see ex::normal */
 415 ex ${STRUCTURE}::normal(lst &sym_lst, lst &repl_lst, int level) const
 416 {
 417         if (level==1) {
 418                 return basic::normal(sym_lst,repl_lst,level);
 419         }
 420         bool all_are_trivially_equal=true;
 421 ${normal_statements}
 422         if (all_are_trivially_equal) {
 423                 return basic::normal(sym_lst,repl_lst,level);
 424         }
 425         ex n=${STRUCTURE}(${temporary_arglist});
 426         return n.bp->basic::normal(sym_lst,repl_lst,level);
 427 }
 428
 429 /** ${STRUCTURE}::diff() differentiates the children.
 430         there is no need to check for triavially equal, since diff usually
 431         does not return itself unevaluated. */
 432 ex ${STRUCTURE}::diff(const symbol & s) const
 433 {
 434 ${diff_statements}
 435         return ${STRUCTURE}(${temporary_arglist});
 436 }
 437
 438 ex ${STRUCTURE}::subs(const lst & ls, const lst & lr) const
 439 {
 440         bool all_are_trivially_equal=true;
 441 ${subs_statements}
 442         if (all_are_trivially_equal) {
 443                 return *this;
 444         }
 445         return ${STRUCTURE}(${temporary_arglist});
 446 }
 447
 448 // protected
 449
 450 int ${STRUCTURE}::compare_same_type(const basic & other) const
 451 {
 452         GINAC_ASSERT(is_of_type(other,${STRUCTURE}));
 453         ${STRUCTURE} const & o=static_cast<${STRUCTURE} const &>
 454                                                                         (const_cast<basic &>(other));
 455         int cmpval;
 456 ${compare_statements}
 457         return 0;
 458 }
 459
 460 bool ${STRUCTURE}::is_equal_same_type(const basic & other) const
 461 {
 462         GINAC_ASSERT(is_of_type(other,${STRUCTURE}));
 463         ${STRUCTURE} const & o=static_cast<${STRUCTURE} const &>
 464                                                                         (const_cast<basic &>(other));
 465 ${is_equal_statements}
 466         return true;
 467 }
 468
 469 unsigned ${STRUCTURE}::return_type(void) const
 470 {
 471         return return_types::noncommutative_composite;
 472 }
 473
 474 //////////
 475 // new virtual functions which can be overridden by derived classes
 476 //////////
 477
 478 // none
 479
 480 //////////
 481 // non-virtual functions in this class
 482 //////////
 483
 484 // public
 485
 486 #define SKIP_TYPE_CHECK_FOR_ex
 487 // this is a hack since there is no meaningful
 488 // is_ex_exactly_of_type(...,ex) macro definition
 489
 490 bool ${STRUCTURE}::types_ok(void) const
 491 {
 492 ${types_ok_statements}
 493         return true;
 494 }
 495
 496 //////////
 497 // static member variables
 498 //////////
 499
 500 ${op_access_indices_def}
 501
 502 //////////
 503 // global constants
 504 //////////
 505
 506 const ${STRUCTURE} some_${STRUCTURE};
 507 const type_info & typeid_${STRUCTURE}=typeid(some_${STRUCTURE});
 508 const unsigned tinfo_${STRUCTURE}=structure::register_new("${STRUCTURE}");
 509
 510 } // namespace GiNaC
 511
 512 END_OF_IMPLEMENTATION
 513
 514 print "Creating interface file ${STRUCTURE}.h...";
 515 open OUT,">${STRUCTURE}.h" or die "cannot open ${STRUCTURE}.h";
 516 print OUT $interface;
 517 close OUT;
 518 print "ok.\n";
 519
 520 print "Creating implementation file ${STRUCTURE}.cpp...";
 521 open OUT,">${STRUCTURE}.cpp" or die "cannot open ${STRUCTURE}.cpp";
 522 print OUT $implementation;
 523 close OUT;
 524 print "ok.\n";
 525
 526 print "done.\n";