Add support for Texinfo-5.0.

[ginac.git] / ginac / wildcard.h

diff --git a/ginac/wildcard.h b/ginac/wildcard.h
index e55788e7b18d257ec7b17bd939892fb564f16d17..678afb810a0997e458a6eccad5dba05ea1e9571d 100644 (file)
--- a/ginac/wildcard.h
+++ b/ginac/wildcard.h
@@ -3,7 +3,7 @@
  *  Interface to GiNaC's wildcard objects. */
 
 /*
- *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
+ *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
@@ -17,19 +17,19 @@
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_WILDCARD_H__
-#define __GINAC_WILDCARD_H__
+#ifndef GINAC_WILDCARD_H
+#define GINAC_WILDCARD_H
 
 #include "ex.h"
+#include "archive.h"
 
 namespace GiNaC {
 
-
-/** This class acts as a wildcard for subs() and matches(). An integer label
- *  is used to identify different wildcards. */
+/** This class acts as a wildcard for subs(), match(), has() and find(). An
+ *  integer label is used to identify different wildcards. */
 class wildcard : public basic
 {
        GINAC_DECLARE_REGISTERED_CLASS(wildcard, basic)
@@ -39,27 +39,34 @@ public:
        /** Construct wildcard with specified label. */
        wildcard(unsigned label);
 
-       // functions overriding virtual functions from bases classes
+       // functions overriding virtual functions from base classes
 public:
-       void print(const print_context & c, unsigned level = 0) const;
-       unsigned calchash(void) const;
-       bool match(const ex & pattern, lst & repl_lst) const;
+       bool match(const ex & pattern, exmap& repl_lst) const;
+
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms);
+protected:
+       unsigned calchash() const;
 
        // non-virtual functions in this class
 public:
-       unsigned get_label(void) const {return label;}
+       unsigned get_label() const {return label;}
+
+protected:
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
 
        // member variables
 private:
        unsigned label; /**< Label used to distinguish different wildcards */
 };
+GINAC_DECLARE_UNARCHIVER(wildcard);
 
 
-// global functions
-inline const wildcard &ex_to_wildcard(const ex &e)
-{
-       return static_cast<const wildcard &>(*e.bp);
-}
+// utility functions
 
 /** Create a wildcard object with the specified label. */
 inline ex wild(unsigned label = 0)
@@ -67,6 +74,9 @@ inline ex wild(unsigned label = 0)
        return wildcard(label);
 }
 
+/** Check whether x has a wildcard anywhere as a subexpression. */
+bool haswild(const ex & x);
+
 } // namespace GiNaC
 
-#endif // ndef __GINAC_WILDCARD_H__
+#endif // ndef GINAC_WILDCARD_H