diff options
Diffstat (limited to 'libs/sigc++2/sigc++/functors/slot_base.h')
| -rw-r--r-- | libs/sigc++2/sigc++/functors/slot_base.h | 319 |
1 files changed, 0 insertions, 319 deletions
diff --git a/libs/sigc++2/sigc++/functors/slot_base.h b/libs/sigc++2/sigc++/functors/slot_base.h deleted file mode 100644 index bb2ed343f3..0000000000 --- a/libs/sigc++2/sigc++/functors/slot_base.h +++ /dev/null @@ -1,319 +0,0 @@ -/* - * Copyright 2003, The libsigc++ Development Team - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - * - */ -#ifndef _SIGC_SLOT_BASE_HPP_ -#define _SIGC_SLOT_BASE_HPP_ - -#include <sigc++config.h> -#include <sigc++/trackable.h> -#include <sigc++/functors/functor_trait.h> - -namespace sigc -{ - -namespace internal { - -typedef void* (*hook)(void*); - -/** Internal representation of a slot. - * Derivations of this class can be considered as a link - * between a slot and the functor that the slot should - * execute in operator(). This link is needed because in - * libsigc++2 the slot doesn't necessarily have exactly the - * same function signature as the functor thus allowing for - * implicit conversions. - * The base class slot_rep serves the purpose to - * - form a common pointer type (slot_rep*), - * - offer the possibility to create duplicates (dup()), - * - offer a notification callback (notify()), - * - implement some of slot_base's interface that depends - * on the notification callback, i.e. - * -# the possibility to set a single parent with a callback - * (set_parent()) that is executed from notify(), - * -# a generic function pointer, call_, that is simply - * set to zero in notify() to invalidate the slot. - * slot_rep inherits trackable so that connection objects can - * refer to the slot and are notified when the slot is destroyed. - */ -struct SIGC_API slot_rep : public trackable -{ - /* NB: Instead of slot_rep we could inherit slot_base from trackable. - * However, a simple benchmark seems to indicate that this slows - * down dereferencing of slot list iterators. Martin. */ - - /// Callback that invokes the contained functor. - /* This can't be a virtual function since number of arguments - * must be flexible. We use function pointers to slot_call::call_it() - * instead. call_ is set to zero to indicate that the slot is invalid. - */ - hook call_; - - /// Callback that detaches the slot_rep object from referred trackables and destroys it. - /* This could be a replaced by a virtual dtor. However since this struct is - * crucual for the efficiency of the whole library we want to avoid this. - */ - hook destroy_; - - /** Callback that makes a deep copy of the slot_rep object. - * @return A deep copy of the slot_rep object. - */ - hook dup_; - - /** Callback of parent_. */ - hook cleanup_; - - /** Parent object whose callback cleanup_ is executed on notification. */ - void* parent_; - - inline slot_rep(hook call__, hook destroy__, hook dup__) - : call_(call__), destroy_(destroy__), dup_(dup__), cleanup_(0), parent_(0) {} - - inline ~slot_rep() - { destroy(); } - - // only MSVC needs this to guarantee that all new/delete are executed from the DLL module -#ifdef SIGC_NEW_DELETE_IN_LIBRARY_ONLY - void* operator new(size_t size_); - void operator delete(void* p); -#endif - - /** Destroys the slot_rep object (but doesn't delete it). - */ - inline void destroy() - { if (destroy_) (*destroy_)(this); } - - /** Makes a deep copy of the slot_rep object. - * @return A deep copy of the slot_rep object. - */ - inline slot_rep* dup() const - { return (slot_rep*)(*dup_)(const_cast<slot_rep*>(this)); } - - /** Set the parent with a callback. - * slots have one parent exclusively. - * @param parent The new parent. - * @param cleanup The callback to execute from notify(). - */ - inline void set_parent(void* parent, hook cleanup) - { - parent_ = parent; - cleanup_ = cleanup; - } - - /// Invalidates the slot and executes the parent's cleanup callback. - void disconnect(); - - /** Callback that invalidates the slot. - * This callback is registered in every object of a trackable - * inherited type that is referred by this slot_rep object. - * It is executed when the slot becomes invalid because of some - * referred object dying. - * @param data The slot_rep object that is becoming invalid (@p this). - */ - static void* notify(void* data); -}; - -/** Functor used to add a dependency to a trackable. - * Consequently slot_rep::notify() gets executed when the - * trackable is destroyed or overwritten. - */ -struct SIGC_API slot_do_bind -{ - /** The slot_rep object trackables should notify on destruction. */ - slot_rep* rep_; - - /** Construct a slot_do_bind functor. - * @param rep The slot_rep object trackables should notify on destruction. - */ - inline slot_do_bind(slot_rep* rep) : rep_(rep) {} - - /** Adds a dependency to @p t. - * @param t The trackable object to add a callback to. - */ - inline void operator()(const trackable* t) const - { t->add_destroy_notify_callback(rep_, &slot_rep::notify); } -}; - -/// Functor used to remove a dependency from a trackable. -struct SIGC_API slot_do_unbind -{ - /** The slot_rep object trackables don't need to notify on destruction any more. */ - slot_rep* rep_; - - /** Construct a slot_do_unbind functor. - * @param rep The slot_rep object trackables don't need to notify on destruction any more. - */ - inline slot_do_unbind(slot_rep* rep) : rep_(rep) {} - - /** Removes a dependency from @p t. - * @param t The trackable object to remove the callback from. - */ - inline void operator()(const trackable* t) const - { t->remove_destroy_notify_callback(rep_); } -}; - -} //namespace internal - - -/** @defgroup slot Slots - * Slots are type-safe representations of callback methods and functions. - * A Slot can be constructed from any function, regardless of whether it is a global function, - * a member method, static, or virtual. - * - * Use the sigc::mem_fun() and sigc::ptr_fun() template functions to get a sigc::slot, like so: - * - * @code - * sigc::slot<void, int> sl = sigc::mem_fun(someobj,& SomeClass::somemethod); - * @endcode - * - * or - * - * @code - * sigc::slot<void, int> sl = sigc::ptr_fun(&somefunction); - * @endcode - * - * or - * - * @code - * m_Button.signal_clicked().connect( sigc::mem_fun(*this, &MyWindow::on_button_clicked) ); - * @endcode - * - * The compiler will complain if SomeClass::somemethod, etc. have the wrong signature. - * - * You can also pass slots as method parameters where you might normally pass a function pointer. - * - * @ingroup functors - */ - -/** Base type for slots. - * slot_base integrates most of the interface of the derived - * sigc::slot templates. slots - * can be connected to signals, be disconnected at some later point - * (disconnect()) and temporarily be blocked (block(), unblock()). - * The validity of a slot can be tested with empty(). - * - * The internal representation of a sigc::internal::slot_rep derived - * type is built from slot_base's derivations. set_parent() is used to - * register a notification callback that is executed when the slot gets - * invalid. add_destroy_notify_callback() is used by connection objects - * to add a notification callback that is executed on destruction. - * - * @ingroup slot - */ -class SIGC_API slot_base : public functor_base -{ - typedef internal::slot_rep rep_type; - -public: - /// Constructs an empty slot. - slot_base(); - - /** Constructs a slot from an existing slot_rep object. - * @param rep The slot_rep object this slot should contain. - */ - explicit slot_base(rep_type* rep); - - /** Constructs a slot, copying an existing one. - * @param src The existing slot to copy. - */ - slot_base(const slot_base& src); - - ~slot_base(); - - /** Tests whether a slot is null, because the default constructor was used. - * Test a slot for null like so: - * @code - * if(slot) - * do_something() - * @endcode - */ - operator bool() const; - - /** Sets the parent of this slot. - * This function is used by signals to register a notification callback. - * This notification callback is executed when the slot becomes invalid - * because of some referred object dying. - * @param parent The new parent. - * @param cleanup The notification callback. - */ - void set_parent(void* parent, void* (*cleanup)(void*)) const; - - typedef trackable::func_destroy_notify func_destroy_notify; - /** Add a callback that is executed (notified) when the slot is detroyed. - * This function is used internally by connection objects. - * @param data Passed into func upon notification. - * @param func Callback executed upon destruction of the object. - */ - void add_destroy_notify_callback(void* data, func_destroy_notify func) const; - - /** Remove a callback previously installed with add_destroy_notify_callback(). - * The callback is not executed. - * @param data Parameter passed into previous call to add_destroy_notify_callback(). - */ - void remove_destroy_notify_callback(void* data) const; - - /** Returns whether the slot is invalid. - * @return @p true if the slot is invalid (empty). - */ - inline bool empty() const - { return (!rep_ || !rep_->call_); } - - /** Returns whether the slot is blocked. - * @return @p true if the slot is blocked. - */ - inline bool blocked() const - { return blocked_; } - - /** Sets the blocking state. - * If @e should_block is @p true then the blocking state is set. - * Subsequent calls to slot::operator()() don't invoke the functor - * contained by this slot until unblock() or block() with - * @e should_block = @p false is called. - * @param should_block Indicates whether the blocking state should be set or unset. - * @return @p true if the slot was in blocking state before. - */ - bool block(bool should_block = true); - - /** Unsets the blocking state. - * @return @p true if the slot was in blocking state before. - */ - bool unblock(); - - /** Disconnects the slot. - * Invalidates the slot and notifies the parent. - */ - void disconnect(); - -protected: - /** Overrides this slot making a copy from another slot. - * @param src The slot from which to make a copy. - * @return @p this. - */ - slot_base& operator=(const slot_base& src); - -public: // public to avoid template friend declarations - /** Typed slot_rep object that contains a functor. */ - mutable rep_type *rep_; - - /** Indicates whether the slot is blocked. */ - bool blocked_; -}; - -} //namespace sigc - -#endif //_SIGC_SLOT_BASE_HPP_ - |