1 if (($#ARGV!=0) and ($#ARGV!=1)) {
2 die 'usage: container.pl type [maxargs] (type=lst or exprseq)';
5 if ($ARGV[0] eq 'lst') {
7 } elsif ($ARGV[0] eq 'exprseq') {
10 die 'only lst and exprseq supported';
16 $maxargs=16; # must be greater or equal than the value used in function.pl
19 if ($type eq 'exprseq') {
21 # settings for exprseq
31 } elsif ($type eq 'lst') {
44 die "invalid type $type";
47 $CONTAINER_UC=uc(${CONTAINER});
48 $STLT="ex".$STLHEADER;
51 $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) (s).reserve(size)";
53 $RESERVE_IMPLEMENTATION="#define RESERVE(s,size) // no reserve needed for ${STLHEADER}";
57 $PREPEND_INTERFACE=<<END_OF_PREPEND_INTERFACE;
58 virtual ${CONTAINER} & prepend(const ex & b);
59 virtual ${CONTAINER} & remove_first(void);
60 END_OF_PREPEND_INTERFACE
62 $PREPEND_IMPLEMENTATION=<<END_OF_PREPEND_IMPLEMENTATION;
63 ${CONTAINER} & ${CONTAINER}::prepend(const ex & b)
65 ensure_if_modifiable();
70 ${CONTAINER} & ${CONTAINER}::remove_first(void)
72 ensure_if_modifiable();
76 END_OF_PREPEND_IMPLEMENTATION
78 $PREPEND_INTERFACE=" // no prepend possible for ${CONTAINER}";
79 $PREPEND_IMPLEMENTATION="";
83 $SORT_INTERFACE=<<END_OF_SORT_INTERFACE;
84 virtual ${CONTAINER} & sort(void);
85 virtual ${CONTAINER} & unique(void);
88 $SORT_IMPLEMENTATION=<<END_OF_SORT_IMPLEMENTATION;
89 ${CONTAINER} & ${CONTAINER}::sort(void)
91 ensure_if_modifiable();
92 seq.sort(ex_is_less());
96 ${CONTAINER} & ${CONTAINER}::unique(void)
98 ensure_if_modifiable();
99 seq.unique(ex_is_equal());
102 END_OF_SORT_IMPLEMENTATION
104 $SORT_INTERFACE=" // no sort possible for ${CONTAINER}";
105 $SORT_IMPLEMENTATION="";
109 $LET_OP_IMPLEMENTATION=<<END_OF_LET_OP_IMPLEMENTATION
110 ex & ${CONTAINER}::let_op(int i)
113 GINAC_ASSERT(i<nops());
115 ${STLT}::iterator it=seq.begin();
116 for (int j=0; j<i; j++) {
121 END_OF_LET_OP_IMPLEMENTATION
123 $LET_OP_IMPLEMENTATION="// ${CONTAINER}::let_op() will be implemented by user elsewhere";
127 my ($seq_template,$n,$separator)=@_;
131 for ($N=1; $N<=$n; $N++) {
132 $res .= eval('"' . $seq_template . '"');
140 sub generate_from_to {
141 my ($template,$seq_template1,$seq_separator1,$seq_template2,
142 $seq_separator2,$from,$to)=@_;
146 for ($N=$from; $N<=$to; $N++) {
147 $SEQ1=generate_seq($seq_template1,$N,$seq_separator1);
148 $SEQ2=generate_seq($seq_template2,$N,$seq_separator2);
149 $res .= eval('"' . $template . '"');
150 $SEQ1=''; # to avoid main::SEQ1 used only once warning
151 $SEQ2=''; # same as above
157 my ($template,$seq_template1,$seq_separator1,$seq_template2,
159 return generate_from_to($template,$seq_template1,$seq_separator1,
160 $seq_template2,$seq_separator2,1,$maxargs);
163 $constructors_interface=generate(
164 ' explicit ${CONTAINER}(${SEQ1});'."\n",
165 'const ex & param${N}',', ','','');
167 $constructors_implementation=generate(
168 <<'END_OF_CONSTRUCTORS_IMPLEMENTATION','const ex & param${N}',', ',' seq.push_back(param${N});',"\n");
169 ${CONTAINER}::${CONTAINER}(${SEQ1}) : basic(TINFO_${CONTAINER})
171 debugmsg(\"${CONTAINER} ctor from ${N}*ex\",LOGLEVEL_CONSTRUCT);
175 END_OF_CONSTRUCTORS_IMPLEMENTATION
177 $interface=<<END_OF_INTERFACE;
178 /** \@file ${CONTAINER}.h
180 * Definition of GiNaC's ${CONTAINER}. */
183 * This file was generated automatically by container.pl.
184 * Please do not modify it directly, edit the perl script instead!
185 * container.pl options: \$CONTAINER=${CONTAINER}
186 * \$STLHEADER=${STLHEADER}
187 * \$reserve=${reserve}
188 * \$prepend=${prepend}
191 * \$open_bracket=${open_bracket}
192 * \$close_bracket=${close_bracket}
193 * \$maxargs=${maxargs}
195 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
197 * This program is free software; you can redistribute it and/or modify
198 * it under the terms of the GNU General Public License as published by
199 * the Free Software Foundation; either version 2 of the License, or
200 * (at your option) any later version.
202 * This program is distributed in the hope that it will be useful,
203 * but WITHOUT ANY WARRANTY; without even the implied warranty of
204 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
205 * GNU General Public License for more details.
207 * You should have received a copy of the GNU General Public License
208 * along with this program; if not, write to the Free Software
209 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
212 #ifndef __GINAC_${CONTAINER_UC}_H__
213 #define __GINAC_${CONTAINER_UC}_H__
215 #include <${STLHEADER}>
217 // CINT needs <algorithm> to work properly with <vector> and <list>
226 typedef std::${STLHEADER}<ex> ${STLT};
228 class ${CONTAINER} : public basic
230 GINAC_DECLARE_REGISTERED_CLASS(${CONTAINER}, basic)
233 ${CONTAINER}(${STLT} const & s, bool discardable = false);
234 ${CONTAINER}(${STLT} * vp); // vp will be deleted
235 ${constructors_interface}
238 void print(const print_context & c, unsigned level = 0) const;
239 unsigned precedence(void) const {return 10;}
240 bool info(unsigned inf) const;
241 unsigned nops() const;
243 ex map(map_function & f) const;
244 ex eval(int level=0) const;
245 ex subs(const lst & ls, const lst & lr, bool no_pattern = false) const;
247 bool is_equal_same_type(const basic & other) const;
248 unsigned return_type(void) const;
250 // new virtual functions which can be overridden by derived classes
252 virtual ${CONTAINER} & append(const ex & b);
253 virtual ${CONTAINER} & remove_last(void);
257 virtual void printseq(const print_context & c, char openbracket, char delim,
258 char closebracket, unsigned this_precedence,
259 unsigned upper_precedence = 0) const;
260 virtual ex this${CONTAINER}(${STLT} const & v) const;
261 virtual ex this${CONTAINER}(${STLT} * vp) const;
264 bool is_canonical() const;
265 ${STLT} evalchildren(int level) const;
266 ${STLT} * subschildren(const lst & ls, const lst & lr, bool no_pattern = false) const;
274 /** Specialization of is_exactly_a<${CONTAINER}>(obj) for ${CONTAINER} objects. */
275 template<> inline bool is_exactly_a<${CONTAINER}>(const basic & obj)
277 return obj.tinfo()==TINFO_${CONTAINER};
282 #endif // ndef __GINAC_${CONTAINER_UC}_H__
286 $implementation=<<END_OF_IMPLEMENTATION;
287 /** \@file ${CONTAINER}.cpp
289 * Implementation of GiNaC's ${CONTAINER}. */
292 * This file was generated automatically by container.pl.
293 * Please do not modify it directly, edit the perl script instead!
294 * container.pl options: \$CONTAINER=${CONTAINER}
295 * \$STLHEADER=${STLHEADER}
296 * \$reserve=${reserve}
297 * \$prepend=${prepend}
299 * \$open_bracket=${open_bracket}
300 * \$close_bracket=${close_bracket}
301 * \$maxargs=${maxargs}
303 * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
305 * This program is free software; you can redistribute it and/or modify
306 * it under the terms of the GNU General Public License as published by
307 * the Free Software Foundation; either version 2 of the License, or
308 * (at your option) any later version.
310 * This program is distributed in the hope that it will be useful,
311 * but WITHOUT ANY WARRANTY; without even the implied warranty of
312 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
313 * GNU General Public License for more details.
315 * You should have received a copy of the GNU General Public License
316 * along with this program; if not, write to the Free Software
317 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
323 #include "${CONTAINER}.h"
327 #include "debugmsg.h"
331 GINAC_IMPLEMENT_REGISTERED_CLASS(${CONTAINER}, basic)
333 ${RESERVE_IMPLEMENTATION}
336 // default ctor, dtor, copy ctor assignment operator and helpers
341 ${CONTAINER}::${CONTAINER}() : basic(TINFO_${CONTAINER})
343 debugmsg("${CONTAINER} default ctor",LOGLEVEL_CONSTRUCT);
348 void ${CONTAINER}::copy(${CONTAINER} const & other)
350 inherited::copy(other);
354 void ${CONTAINER}::destroy(bool call_parent)
357 if (call_parent) inherited::destroy(call_parent);
366 ${CONTAINER}::${CONTAINER}(${STLT} const & s, bool discardable) : basic(TINFO_${CONTAINER})
368 debugmsg("${CONTAINER} ctor from ${STLT}", LOGLEVEL_CONSTRUCT);
370 seq.swap(const_cast<${STLT} &>(s));
376 ${CONTAINER}::${CONTAINER}(${STLT} * vp) : basic(TINFO_${CONTAINER})
378 debugmsg("${CONTAINER} ctor from ${STLT} *",LOGLEVEL_CONSTRUCT);
384 ${constructors_implementation}
390 /** Construct object from archive_node. */
391 ${CONTAINER}::${CONTAINER}(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst)
393 debugmsg("${CONTAINER} ctor from archive_node", LOGLEVEL_CONSTRUCT);
394 for (unsigned int i=0; true; i++) {
396 if (n.find_ex("seq", e, sym_lst, i))
403 /** Unarchive the object. */
404 ex ${CONTAINER}::unarchive(const archive_node &n, const lst &sym_lst)
406 return (new ${CONTAINER}(n, sym_lst))->setflag(status_flags::dynallocated);
409 /** Archive the object. */
410 void ${CONTAINER}::archive(archive_node &n) const
412 inherited::archive(n);
413 ${STLT}::const_iterator i = seq.begin(), end = seq.end();
421 // functions overriding virtual functions from base classes
426 void ${CONTAINER}::print(const print_context & c, unsigned level) const
428 debugmsg("${CONTAINER} print", LOGLEVEL_PRINT);
430 if (is_a<print_tree>(c)) {
432 c.s << std::string(level, ' ') << class_name()
433 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
434 << ", nops=" << nops()
436 unsigned delta_indent = static_cast<const print_tree &>(c).delta_indent;
437 ${STLT}::const_iterator i = seq.begin(), end = seq.end();
439 i->print(c, level + delta_indent);
442 c.s << std::string(level + delta_indent,' ') << "=====" << std::endl;
445 // always print brackets around seq, ignore upper_precedence
446 printseq(c, '${open_bracket}', ',', '${close_bracket}', precedence(), precedence()+1);
450 // ${CONTAINER}::info() will be implemented by user elsewhere";
452 unsigned ${CONTAINER}::nops() const
457 ${LET_OP_IMPLEMENTATION}
459 ex ${CONTAINER}::map(map_function & f) const
461 // This implementation is here because basic::map() uses let_op()
462 // which is not defined for all containers
464 RESERVE(s,seq.size());
465 ${STLT}::const_iterator i = seq.begin(), end = seq.end();
471 return this${CONTAINER}(s);
474 ex ${CONTAINER}::eval(int level) const
479 return this${CONTAINER}(evalchildren(level));
482 ex ${CONTAINER}::subs(const lst & ls, const lst & lr, bool no_pattern) const
484 ${STLT} *vp = subschildren(ls, lr, no_pattern);
486 return ex_to<basic>(this${CONTAINER}(vp)).basic::subs(ls, lr, no_pattern);
488 return basic::subs(ls, lr, no_pattern);
493 int ${CONTAINER}::compare_same_type(const basic & other) const
495 GINAC_ASSERT(is_a<${CONTAINER}>(other));
496 ${CONTAINER} const & o = static_cast<const ${CONTAINER} &>(other);
498 ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
499 it2 = o.seq.begin(), it2end = o.seq.end();
501 while (it1 != it1end && it2 != it2end) {
502 int cmpval = it1->compare(*it2);
508 return (it1 == it1end) ? (it2 == it2end ? 0 : -1) : 1;
511 bool ${CONTAINER}::is_equal_same_type(const basic & other) const
513 GINAC_ASSERT(is_a<${CONTAINER}>(other));
514 ${CONTAINER} const &o = static_cast<const ${CONTAINER} &>(other);
516 if (seq.size() != o.seq.size())
519 ${STLT}::const_iterator it1 = seq.begin(), it1end = seq.end(),
522 while (it1 != it1end) {
523 if (!it1->is_equal(*it2))
531 unsigned ${CONTAINER}::return_type(void) const
533 return return_types::noncommutative_composite;
537 // new virtual functions which can be overridden by derived classes
542 ${CONTAINER} & ${CONTAINER}::append(const ex & b)
544 ensure_if_modifiable();
549 ${CONTAINER} & ${CONTAINER}::remove_last(void)
551 ensure_if_modifiable();
556 ${PREPEND_IMPLEMENTATION}
558 ${SORT_IMPLEMENTATION}
562 void ${CONTAINER}::printseq(const print_context & c, char openbracket, char delim,
563 char closebracket, unsigned this_precedence,
564 unsigned upper_precedence) const
566 if (this_precedence <= upper_precedence)
570 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
572 while (it != itend) {
573 it->print(c, this_precedence);
577 it->print(c, this_precedence);
580 if (this_precedence <= upper_precedence)
584 ex ${CONTAINER}::this${CONTAINER}(${STLT} const & v) const
586 return ${CONTAINER}(v);
589 ex ${CONTAINER}::this${CONTAINER}(${STLT} * vp) const
591 return ${CONTAINER}(vp);
595 // non-virtual functions in this class
604 bool ${CONTAINER}::is_canonical() const
606 if (seq.size()<=1) { return 1; }
608 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
609 ${STLT}::const_iterator it_last=it;
610 for (++it; it!=itend; it_last=it, ++it) {
611 if (it_last->compare(*it)>0) {
612 if (it_last->compare(*it)>0) {
613 std::cout << *it_last << ">" << *it << "\\n";
622 ${STLT} ${CONTAINER}::evalchildren(int level) const
625 RESERVE(s,seq.size());
630 if (level == -max_recursion_level) {
631 throw(std::runtime_error("max recursion level reached"));
634 ${STLT}::const_iterator it = seq.begin(), itend = seq.end();
635 while (it != itend) {
636 s.push_back(it->eval(level));
642 ${STLT} * ${CONTAINER}::subschildren(const lst & ls, const lst & lr, bool no_pattern) const
644 // returns a NULL pointer if nothing had to be substituted
645 // returns a pointer to a newly created epvector otherwise
646 // (which has to be deleted somewhere else)
648 ${STLT}::const_iterator cit = seq.begin(), end = seq.end();
650 const ex & subsed_ex = cit->subs(ls, lr, no_pattern);
651 if (!are_ex_trivially_equal(*cit, subsed_ex)) {
653 // something changed, copy seq, subs and return it
654 ${STLT} *s=new ${STLT};
655 RESERVE(*s, seq.size());
657 // copy parts of seq which are known not to have changed
658 ${STLT}::const_iterator cit2 = seq.begin();
659 while (cit2 != cit) {
664 // copy first changed element
665 s->push_back(subsed_ex);
669 while (cit2 != end) {
670 s->push_back(cit2->subs(ls, lr, no_pattern));
678 return 0; // nothing has changed
683 END_OF_IMPLEMENTATION
685 print "Creating interface file ${CONTAINER}.h...";
686 open OUT,">${CONTAINER}.h" or die "cannot open ${CONTAINER}.h";
687 print OUT $interface;
691 print "Creating implementation file ${CONTAINER}.cpp...";
692 open OUT,">${CONTAINER}.cpp" or die "cannot open ${CONTAINER}.cpp";
693 print OUT $implementation;