connection.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_GOM_TYPES_CONNECTION_H
#define H_OGF_GOM_TYPES_CONNECTION_H
 
#include <OGF/gom/common/common.h>
#include <OGF/gom/types/callable.h>
 
#include <string>
#include <vector>
#include <set>
 
namespace OGF {
 
    class ConnectionList;
 
    /******************************************************************/
 
    gom_attribute(abstract, "true")
    gom_class GOM_API Connection : public Callable {
    public:
 
        Connection(
            Object* source, const std::string& sig_name
        );
 
        virtual ~Connection();
 
        virtual bool invoke(const ArgList& args, Any& ret_val);
 
 
        virtual bool invoke_target(
            const ArgList& args, Any& ret_val
        ) = 0;
        
        Object* source() const {
            return source_;
        }
 
        const std::string& signal_name() const {
            return signal_name_;
        }
        
      gom_slots:
        
        Connection* if_arg(
            const std::string& name, const std::string& value
        ) {
            if(conditions_.has_arg(name)) {
                Logger::err("GOM")
                    << "if_arg(): duplicate condition for " << name 
                    << std::endl;
                return this;
            }
            conditions_.create_arg(name, value);
            return this;
        }
 
        Connection* add_arg(const std::string& name, const std::string& value) {
            if(args_.has_arg(name)) {
                Logger::err("GOM")
                    << "add_arg(): argument " << name
                    << " already exists"
                    << std::endl;
                return this;
            }
            args_.create_arg(name, value);
            return this;
        }
 
        Connection* rename_arg(const std::string& name, const std::string& new_name) {
            if(rename_args_.has_arg(name)) {
                Logger::err("GOM")
                    << "rename_arg(): duplicate rename for " << name 
                    << std::endl;
                return this;
            }
            rename_args_.create_arg(name, new_name);
            return this;
        }
 
        Connection* discard_arg(const std::string& name) {
            discard_args_.insert(name);
            return this;
        }
 
        void remove();
        
    protected:
        bool test_arg_conditions(const ArgList& args) const;
 
        bool test_arg_condition(
            const std::string& value, const std::string& condition
        ) const;
 
        void translate_args(const ArgList& args_in, ArgList& args_out);
 
    private:
        Object* source_;
        std::string signal_name_;
        ArgList conditions_;
        ArgList args_;
        ArgList rename_args_;
        std::set<std::string> discard_args_;
    };
 
    typedef SmartPointer<Connection> Connection_var;
 
    /**********************************************************************/
 
    gom_class GOM_API SlotConnection : public Connection {
      public:
        SlotConnection(
            Object* source, const std::string& sig_name,
            Object* target, const std::string& slot_name
        );
 
        bool invoke_target(
            const ArgList& args, Any& ret_val
        ) override;
        
      private:
        Object* target_;
        std::string slot_name_;
    };
 
    /**********************************************************************/    
 
    gom_class GOM_API CallableConnection : public Connection {
      public:
        CallableConnection(
            Object* source, const std::string& sig_name, Callable* target
        );
 
        bool invoke_target(
            const ArgList& args, Any& ret_val
        ) override;
        
      private:
        Callable_var target_;
    };
    
 
    /**********************************************************************/    
    
    class ConnectionList : public std::vector<Connection_var> {
    public:
        void invoke(const ArgList& args) {
            Any ret_val;
            for(unsigned int i=0; i<size(); i++) {
                (*this)[i]->invoke(args, ret_val);
            }
        }
 
        void remove(Connection* conn) {
            std::vector<Connection_var>::iterator it = this->begin();
            while(it != this->end()) {
                if(it->get() == conn) {
                    erase(it);
                    return;
                }
                ++it;
            }
            geo_assert_not_reached;
        }
    };
 
    /******************************************************************/
    
}
 
#endif