meta_method.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_MEMBERS_META_METHOD_H
#define H_OGF_META_MEMBERS_META_METHOD_H
 
#include <OGF/gom/common/common.h>
#include <OGF/gom/reflection/meta_member.h>
#include <OGF/gom/reflection/meta_arg.h>
 
namespace OGF {
 
    class Object ;
    class ArgList ;
 
    typedef bool (*gom_method_adapter)(
        Object* target, 
        const std::string& method_name, const ArgList& args,
        Any& ret_val
    ) ;
 
    gom_class GOM_API MetaMethod : public MetaMember {
    public:
 
        MetaMethod(
            const std::string& name,
            MetaClass* container,
            const std::string& return_type 
        ) ;
 
        MetaMethod(
            const std::string& name,
            MetaClass* container,
            MetaType* return_type
        ) ;
 
        ~MetaMethod() override;
 
        void pre_delete() override;
 
 
        std::string get_doc() const override;
        
    gom_slots:
        
        size_t nb_args() const {
            return meta_args_.size();
        }
 
        const std::string& ith_arg_name(index_t i) const {
            ogf_assert(i < meta_args_.size());
            return meta_args_[i].name();
        }
 
        const std::string& ith_arg_type_name(index_t i) const {
            ogf_assert(i < meta_args_.size());
            return meta_args_[i].type_name();
        }
 
        MetaType* ith_arg_type(index_t i) const {
            ogf_assert(i < meta_args_.size());
            return meta_args_[i].type();
        }
 
        bool ith_arg_has_default_value(index_t i) const {
            ogf_assert(i < meta_args_.size());
            return meta_args_[i].has_default_value();
        }
 
        std::string ith_arg_default_value_as_string(index_t i) const {
            return ith_arg_default_value(i).as_string();
        }
        
        const std::string& return_type_name() const { 
            return return_type_name_ ; 
        }
 
        MetaType* return_type() const ; 
 
        bool ith_arg_has_custom_attribute(
            index_t i, const std::string& name
        ) const;
 
        std::string ith_arg_custom_attribute_value(
            index_t i, const std::string& name
        ) const;
 
        size_t ith_arg_nb_custom_attributes(index_t i);
 
        std::string ith_arg_jth_custom_attribute_name(index_t i, index_t j);
 
        std::string ith_arg_jth_custom_attribute_value(index_t i, index_t j);
        
    public:
        
        const Any& ith_arg_default_value(index_t i) const {
            ogf_assert(i < meta_args_.size());
            return meta_args_[i].default_value();
        }
 
        
        const MetaArg* ith_arg(index_t i) const {
            ogf_assert(i < meta_args_.size()) ;
            return &(meta_args_[i]) ;
        }
 
        MetaArg* ith_arg(index_t i) {
            ogf_assert(i < meta_args_.size()) ;
            return &(meta_args_[i]) ;
        }
 
        void add_arg(const MetaArg& arg) {
            meta_args_.push_back(arg) ;
        }
 
        bool has_arg(const std::string& meta_arg_name) ;
 
        const MetaArg* find_arg(const std::string& meta_arg_name) const ;
 
        MetaArg* find_arg(const std::string& meta_arg_name) ;
 
 
        gom_method_adapter method_adapter() const {
            return adapter_ ;
        }
 
        void set_method_adapter(gom_method_adapter adapter) {
            adapter_ = adapter ;
        }
 
        virtual bool invoke(
            Object* target, const ArgList& args, Any& return_value
        ) ;
 
        virtual bool invoke(
            const std::string& method_name,
            const ArgList& args, Any& ret_val
        ) {
            return Object::invoke_method(method_name, args, ret_val) ;
        }
 
        virtual bool check_args(const ArgList& args) ;
 
        virtual index_t nb_used_args(const ArgList& args) ;
 
        virtual index_t nb_default_args(const ArgList& args) ;
 
        virtual void add_default_args(ArgList& args) ;
 
    protected:
        static bool emit_signal(
            Object* target, const std::string& sig_name, 
            const ArgList& args, bool called_from_slot = true
        ) ;
 
        bool emit_signal(
            const std::string& signal_name, 
            const ArgList& args, bool called_from_slot = true
        ) override {
           return emit_signal(this, signal_name, args, called_from_slot);
        }
 
    private:
        std::string return_type_name_ ;
        MetaArgList meta_args_ ;
        gom_method_adapter adapter_ ;
    } ;
 
    typedef SmartPointer<MetaMethod> MetaMethod_var ;
 
}
#endif