print.h

Go to the documentation of this file.

 
/*
 *  GiNaC Copyright (C) 1999-2026 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
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef GINAC_PRINT_H
#define GINAC_PRINT_H
 
#include "class_info.h"
 
#include <iosfwd>
#include <memory>
 
namespace GiNaC {
 
class print_context_options {
public:
    print_context_options(const char *n, const char *p, unsigned i)
     : name(n), parent_name(p), id(i) {}
 
    const char *get_name() const { return name; }
    const char *get_parent_name() const { return parent_name; }
    unsigned get_id() const { return id; }
 
private:
    const char *name;         
    const char *parent_name;  
    unsigned id;              
};
 
typedef class_info<print_context_options> print_context_class_info;
 
 
class print_options {
public:
    enum {
        print_index_dimensions = 0x0001 
    };
};
 
 
#define GINAC_DECLARE_PRINT_CONTEXT_COMMON(classname)   \
public: \
    friend class function_options; \
    friend class registered_class_options; \
    static const GiNaC::print_context_class_info &get_class_info_static(); \
    classname();
 
#define GINAC_DECLARE_PRINT_CONTEXT_BASE(classname) \
    GINAC_DECLARE_PRINT_CONTEXT_COMMON(classname) \
    virtual const GiNaC::print_context_class_info &get_class_info() const { return classname::get_class_info_static(); } \
    virtual const char *class_name() const { return classname::get_class_info_static().options.get_name(); } \
    virtual classname * duplicate() const { return new classname(*this); } \
private:
 
#define GINAC_DECLARE_PRINT_CONTEXT(classname, supername) \
    GINAC_DECLARE_PRINT_CONTEXT_COMMON(classname) \
    typedef supername inherited; \
    const GiNaC::print_context_class_info &get_class_info() const override { return classname::get_class_info_static(); } \
    const char *class_name() const override { return classname::get_class_info_static().options.get_name(); } \
    classname * duplicate() const override { return new classname(*this); } \
private:
 
#define GINAC_IMPLEMENT_PRINT_CONTEXT(classname, supername) \
const GiNaC::print_context_class_info &classname::get_class_info_static() \
{ \
    static GiNaC::print_context_class_info reg_info = GiNaC::print_context_class_info(GiNaC::print_context_options(#classname, #supername, GiNaC::next_print_context_id++)); \
    return reg_info; \
}
 
 
extern unsigned next_print_context_id;
 
 
class print_context
{
    GINAC_DECLARE_PRINT_CONTEXT_BASE(print_context)
public:
    print_context(std::ostream &, unsigned options = 0);
    virtual ~print_context() {}
 
    std::ostream & s; 
    unsigned options; 
};
 
class print_dflt : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_dflt, print_context)
public:
    print_dflt(std::ostream &, unsigned options = 0);
};
 
class print_latex : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_latex, print_context)
public:
    print_latex(std::ostream &, unsigned options = 0);
};
 
class print_python : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_python, print_context)
public:
    print_python(std::ostream &, unsigned options = 0);
};
 
class print_python_repr : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_python_repr, print_context)
public:
    print_python_repr(std::ostream &, unsigned options = 0);
};
 
class print_tree : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_tree, print_context)
public:
    print_tree(unsigned d);
    print_tree(std::ostream &, unsigned options = 0, unsigned d = 4);
 
    const unsigned delta_indent; 
};
 
class print_csrc : public print_context
{
    GINAC_DECLARE_PRINT_CONTEXT(print_csrc, print_context)
public:
    print_csrc(std::ostream &, unsigned options = 0);
};
 
class print_csrc_float : public print_csrc
{
    GINAC_DECLARE_PRINT_CONTEXT(print_csrc_float, print_csrc)
public:
    print_csrc_float(std::ostream &, unsigned options = 0);
};
 
class print_csrc_double : public print_csrc
{
    GINAC_DECLARE_PRINT_CONTEXT(print_csrc_double, print_csrc)
public:
    print_csrc_double(std::ostream &, unsigned options = 0);
};
 
class print_csrc_cl_N : public print_csrc
{
    GINAC_DECLARE_PRINT_CONTEXT(print_csrc_cl_N, print_csrc)
public:
    print_csrc_cl_N(std::ostream &, unsigned options = 0);
};
 
template <class T>
inline bool is_a(const print_context & obj)
{ return dynamic_cast<const T *>(&obj) != nullptr; }
 
 
class basic;
 
class print_functor_impl {
public:
    virtual ~print_functor_impl() {}
    virtual print_functor_impl *duplicate() const = 0;
    virtual void operator()(const basic & obj, const print_context & c, unsigned level) const = 0;
};
 
template <class T, class C>
class print_ptrfun_handler : public print_functor_impl {
public:
    typedef void (*F)(const T &, const C &, unsigned);
 
    print_ptrfun_handler(F f_) : f(f_) {}
    print_ptrfun_handler *duplicate() const override { return new print_ptrfun_handler(*this); }
 
    void operator()(const basic & obj, const print_context & c, unsigned level) const override
    {
        // Call the supplied function
        f(dynamic_cast<const T &>(obj), dynamic_cast<const C &>(c), level);
    }
 
private:
    F f;
};
 
template <class T, class C>
class print_memfun_handler : public print_functor_impl {
public:
    typedef void (T::*F)(const C & c, unsigned level) const;
 
    print_memfun_handler(F f_) : f(f_) {}
    print_memfun_handler *duplicate() const override { return new print_memfun_handler(*this); }
 
    void operator()(const basic & obj, const print_context & c, unsigned level) const override
    {
        // Call the supplied member function
        return (dynamic_cast<const T &>(obj).*f)(dynamic_cast<const C &>(c), level);
    }
 
private:
    F f;
};
 
class print_functor {
public:
    print_functor() : impl(nullptr) {}
    print_functor(const print_functor & other) : impl(other.impl.get() ? other.impl->duplicate() : 0) {}
    print_functor(std::unique_ptr<print_functor_impl> impl_) : impl(std::move(impl_)) {}
 
    template <class T, class C>
    print_functor(void f(const T &, const C &, unsigned)) : impl(new print_ptrfun_handler<T, C>(f)) {}
 
    template <class T, class C>
    print_functor(void (T::*f)(const C &, unsigned) const) : impl(new print_memfun_handler<T, C>(f)) {}
 
    print_functor & operator=(const print_functor & other)
    {
        if (this != &other) {
            print_functor_impl *p = other.impl.get();
            impl.reset(p ? other.impl->duplicate() : nullptr);
        }
        return *this;
    }
 
    void operator()(const basic & obj, const print_context & c, unsigned level) const
    {
        (*impl)(obj, c, level);
    }
 
    bool is_valid() const { return impl.get(); }
 
private:
    std::unique_ptr<print_functor_impl> impl;
};
 
 
} // namespace GiNaC
 
#endif // ndef GINAC_BASIC_H