meta_class.h

Go to the documentation of this file.

/*
 *  GXML/Graphite: Geometry and Graphics Programming Library + Utilities
 *  Copyright (C) 2000 Bruno Levy
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  If you modify this software, you should include a notice giving the
 *  name of the person performing the modification, the date of modification,
 *  and the reason for such modification.
 *
 *  Contact: Bruno Levy
 *
 *     levy@loria.fr
 *
 *     ISA Project
 *     LORIA, INRIA Lorraine,
 *     Campus Scientifique, BP 239
 *     54506 VANDOEUVRE LES NANCY CEDEX
 *     FRANCE
 *
 *  Note that the GNU General Public License does not permit incorporating
 *  the Software into proprietary programs.
 */
 
#ifndef H_OGF_META_TYPES_META_CLASS_H
#define H_OGF_META_TYPES_META_CLASS_H
 
#include <OGF/gom/common/common.h>
#include <OGF/gom/reflection/meta_type.h>
#include <OGF/gom/reflection/meta_arg.h>
#include <OGF/gom/reflection/meta_signal.h>
#include <OGF/gom/reflection/meta_slot.h>
#include <OGF/gom/reflection/meta_constructor.h>
#include <OGF/gom/reflection/meta_property.h>
#include <OGF/gom/services/factory.h>
 
#include <set>
#include <map>
 
namespace OGF {
 
    class ArgList;
 
    gom_class GOM_API MetaClass : public MetaType {
    public:
 
        explicit MetaClass(
            const std::string& class_name, MetaClass* super_class = nullptr,
            bool is_abstract = false
        );
 
        explicit MetaClass(
            const std::string& class_name,
            const std::string& super_class_name,
            bool is_abstract = false
        );
 
        ~MetaClass() override;
 
        void pre_delete() override;
 
    gom_slots:
 
        MetaClass* super_class() const;
 
        const std::string& super_class_name() const {
            return super_class_name_;
        }
 
        bool is_abstract() const {
            return abstract_;
        }
 
        Object* create(const ArgList& args);
 
        size_t nb_members(bool super = true) const;
 
        MetaMember* ith_member(index_t i, bool super = true) const;
 
        MetaMember* find_member(
            const std::string& member_name, bool super = true
        ) const;
 
 
        size_t nb_signals(bool super = true) const;
 
        MetaSignal* ith_signal(index_t i, bool super = true) const;
 
        size_t nb_slots(bool super = true) const;
 
        MetaSlot* ith_slot(index_t i, bool super = true) const;
 
        size_t nb_properties(bool super = true) const;
 
 
        MetaProperty* ith_property(index_t i, bool super = true) const;
 
        size_t nb_constructors() const;
 
        MetaConstructor* ith_constructor(index_t i) const;
 
        MetaMethod* find_method(
            const std::string& method_name, bool super = true
        ) const;
 
        MetaSlot* find_slot(
            const std::string& slot_name, bool super = true
        ) const;
 
        MetaSignal* find_signal(
            const std::string& signal_name, bool super = true
        ) const;
 
        MetaProperty* find_property(
            const std::string& property_name, bool super = true
        ) const;
 
        virtual MetaClass* create_subclass(
            const std::string& name, bool is_abstract=false
        );
 
        virtual bool is_subclass_of(const MetaClass* other) const;
 
    public:
 
        void set_abstract(bool b) {
            abstract_ = b;
        }
 
 
        void add_member(MetaMember* member) {
            members_.push_back(member);
        }
 
        void get_members(
            std::vector<MetaMember*>& result, bool super = true
        ) const {
            result.clear();
            append_members(result, super);
        }
 
        void get_methods(
            std::vector<MetaMethod*>& result, bool super = true
        ) const {
            result.clear();
            append_methods(result, super);
        }
 
        void get_signals(
            std::vector<MetaSignal*>& result, bool super = true
        ) const {
            result.clear();
            append_signals(result, super);
        }
 
        void get_slots(
            std::vector<MetaSlot*>& result, bool super = true
        ) const {
            result.clear();
            append_slots(result, super);
        }
 
        void get_properties(
            std::vector<MetaProperty*>& result, bool super = true
        ) const {
            result.clear();
            append_properties(result, super);
        }
 
        void get_constructors(std::vector<MetaConstructor*>& result) const;
 
        bool is_subtype_of(const MetaType* other) const override;
 
        void get_used_types(
            std::set<std::string>& used_types, bool super = true
        ) const;
 
        MetaConstructor* best_constructor(const ArgList& args);
 
        Factory* factory() const {
            return factory_;
        }
 
        void set_factory(Factory* f) {
            factory_ = f;
        }
 
        void search(const std::string& needle, const std::string& path = "") override;
 
        std::string get_doc() const override;
 
 
    protected:
 
        std::string new_constructor_name() const;
 
        void append_members(
            std::vector<MetaMember*>& result, bool super = true
        ) const;
 
        void append_methods(
            std::vector<MetaMethod*>& result, bool super = true
        ) const;
 
        void append_signals(
            std::vector<MetaSignal*>& result, bool super = true
        ) const;
 
        void append_slots(
            std::vector<MetaSlot*>& result, bool super = true
        ) const;
 
        void append_properties(
            std::vector<MetaProperty*>& result, bool super = true
        ) const;
 
    private:
        std::string super_class_name_;
        std::vector<MetaMember_var> members_;
        bool abstract_;
        Factory_var factory_;
        friend class ::OGF::MetaConstructor;
    };
 
    typedef SmartPointer<MetaClass> MetaClass_var;
 
    /*******************************************************************/
 
    class GOM_API FactoryMetaClass : public Factory {
    public:
        FactoryMetaClass(MetaClass* mclass) : meta_class_(mclass) {
        }
 
        virtual Object* create(const ArgList& args);
 
        MetaClass* meta_class() const {
            return meta_class_;
        }
 
    private:
        MetaClass* meta_class_;
    };
 
    /*******************************************************************/
}
#endif