callback_1.h

Go to the documentation of this file.

/*
 * *** ATTENTION!  DO NOT MODIFY THIS FILE DIRECTLY! ***
 * 
 * It has automatically been generated from callback_x.tmpl.h
 * by param_expander.py on Sun Nov 09 16:55:50 2008.
 */

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */



/** @class lass::util::Callback1
 *  @ingroup Callback
 *  @brief callback with 1 parameter(s) but without returnvalue.
 *  @date 2002
 *  @author Bram de Greve [Bramz] (contact: bramz@users.sourceforge.net)
 *
 *  It's a single object that can hold a reference to a free function or an
 *  object/(const) method pair.  Once the callback is constructed, it works
 *  completely transparent.  All it shows to the client is a function that
 *  takes one parameter but gives no returnvalue.
 */



#ifndef LASS_GUARDIAN_OF_INCLUSION_UTIL_CALLBACK_1_H
#define LASS_GUARDIAN_OF_INCLUSION_UTIL_CALLBACK_1_H



// --- OLD INTERFACES ----------------------------------------------------------

#include "util_common.h"
#include "shared_ptr.h"
#include "impl/dispatcher_1.h"
#include "callback_common.h"




// --- NEW INTERFACES ----------------------------------------------------------

namespace lass
{
namespace util
{


// THE CALLBACK:
// This is the actuall class you use to hold callbacks:

template
<
    typename P1
>
class Callback1
{
public:

    typedef Callback1<P1> TSelf;
    typedef SharedPtr< impl::Dispatcher1<P1> > TDispatcherPtr;

    // STRUCTORS

    /** Default constructor, construct empty callback.
     */
    Callback1()
    {
    }

    /** Construct function callback
     */
    template <typename FunctionType>
    Callback1(FunctionType iFunction):
        dispatcher_(new impl::Dispatcher1Function<P1, FunctionType>(iFunction))
    {
    }

    /** Construct object/method callback.
     */
    template <typename ObjectPtr, typename Method>
    Callback1(ObjectPtr iObject, Method iMethod):
        dispatcher_(new impl::Dispatcher1Method<P1, ObjectPtr, Method>(iObject, iMethod))
    {
    }

    /** copy constructor
     */
    Callback1(const TSelf& iOther):
        dispatcher_(iOther.dispatcher_)
    {
    }



    // OPERATORS

    /** assignment operator
     */
    template <typename Other>
    TSelf& operator=(const Other& iOther)
    {
        TSelf temp(iOther);
        swap(temp);
        return *this;
    }

    /** THE operator.  Executes the callback.
     */
    void operator()(typename util::CallTraits<P1>::TParam iP1) const
    {
        if (!isEmpty())
        {
            dispatcher_->call(iP1);
        }
    }


    // METHODS

    /** Reset to empty callback.
     */
    void reset()
    {
        dispatcher_.reset();
    }

    /** Returns true if no callback dispatcher is assigned to this object.
     */
    bool isEmpty() const
    {
        return dispatcher_.isEmpty();
    }

    /** return this->isEmpty()
     */
    bool operator!() const
    {
        return dispatcher_.isEmpty(); 
    }

    /** return !this->isEmpty())
     */
    operator num::SafeBool() const
    {
        return dispatcher_.isEmpty() ? num::safeFalse : num::safeTrue;
    }

    /** Swaps the dispatcher of this callback with the dispatcher of another.
     */
    void swap(TSelf& iOther)
    {
        dispatcher_.swap(iOther.dispatcher_);
    }

private:

    TDispatcherPtr dispatcher_;
};



/** make a Callback1 from a function
 *  @relates Callback1
 */
template <typename P1> inline
Callback1<P1> makeCallback(void (*iFunction)(P1))
{
    return Callback1<P1>(iFunction);
}



/** make a Callback1 from a callback
 *  @relates Callback1
 */
template <typename P1> inline
const Callback1<P1>& makeCallback(const Callback1<P1>& iCallback)
{
    return iCallback;
}



/** make a Callback1 from a object and method
 *  @relates Callback1
 */
template <typename ObjectPtr, typename Object, typename P1> inline
Callback1<P1> makeCallback(ObjectPtr iObject, void (Object::*iMethod)(P1))
{
    return Callback1<P1>(iObject, iMethod);
}



/** make a Callback1 from a object and const method
 *  @relates Callback1
 */
template <typename ObjectPtr, typename Object, typename P1> inline
Callback1<P1> makeCallback(ObjectPtr iObject, void (Object::*iMethod)(P1) const)
{
    return Callback1<P1>(iObject, iMethod);
}



}

}

#define LASS_PRIM_HAVE_PY_EXPORT_TRAITS_CALLBACK_1
#ifdef LASS_GUARDIAN_OF_INCLUSION_UTIL_CALLBACK_PYTHON_H
#   include "callback_python.h"
#endif

#endif // Guardian of Inclusion

// EOF