Blame sigc++/signal_base.cc

Packit f47435
/*
Packit f47435
 * Copyright 2003, The libsigc++ Development Team
Packit f47435
 *
Packit f47435
 *  This library is free software; you can redistribute it and/or
Packit f47435
 *  modify it under the terms of the GNU Lesser General Public
Packit f47435
 *  License as published by the Free Software Foundation; either
Packit f47435
 *  version 2.1 of the License, or (at your option) any later version.
Packit f47435
 *
Packit f47435
 *  This library is distributed in the hope that it will be useful,
Packit f47435
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit f47435
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Packit f47435
 *  Lesser General Public License for more details.
Packit f47435
 *
Packit f47435
 *  You should have received a copy of the GNU Lesser General Public
Packit f47435
 *  License along with this library; if not, write to the Free Software
Packit f47435
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Packit f47435
 */
Packit f47435
#include <sigc++/signal_base.h>
Packit f47435
#include <memory> // std::unique_ptr
Packit f47435
Packit f47435
namespace sigc {
Packit f47435
namespace internal {
Packit f47435
Packit f47435
// Data sent from signal_impl::insert() to slot_rep::set_parent() when a slot is
Packit f47435
// connected, and then sent from slot_rep::disconnect() to signal_impl::notify()
Packit f47435
// when the slot is disconnected. Bug 167714.
Packit f47435
struct self_and_iter
Packit f47435
{
Packit f47435
  signal_impl* self_;
Packit f47435
  signal_impl::iterator_type iter_;
Packit f47435
Packit f47435
  self_and_iter(signal_impl* self, signal_impl::iterator_type iter)
Packit f47435
    : self_(self), iter_(iter) {}
Packit f47435
};
Packit f47435
Packit f47435
signal_impl::signal_impl()
Packit f47435
: ref_count_(0), exec_count_(0), deferred_(false)
Packit f47435
{}
Packit f47435
Packit f47435
// only MSVC needs this to guarantee that all new/delete are executed from the DLL module
Packit f47435
#ifdef SIGC_NEW_DELETE_IN_LIBRARY_ONLY
Packit f47435
void* signal_impl::operator new(size_t size_)
Packit f47435
{
Packit f47435
  return malloc(size_);
Packit f47435
}
Packit f47435
Packit f47435
void signal_impl::operator delete(void* p)
Packit f47435
{
Packit f47435
  free(p);
Packit f47435
}
Packit f47435
#endif
Packit f47435
Packit f47435
void signal_impl::clear()
Packit f47435
{
Packit f47435
  // Don't let signal_impl::notify() erase the slots. It would invalidate the
Packit f47435
  // iterator in the following loop.
Packit f47435
  const bool saved_deferred = deferred_;
Packit f47435
  signal_exec exec(this);
Packit f47435
Packit f47435
  // Disconnect all connected slots before they are deleted.
Packit f47435
  // signal_impl::notify() will be called and delete the self_and_iter structs.
Packit f47435
  for (auto& slot : slots_)
Packit f47435
    slot.disconnect();
Packit f47435
Packit f47435
  deferred_ = saved_deferred;
Packit f47435
Packit f47435
  slots_.clear();
Packit f47435
}
Packit f47435
Packit f47435
signal_impl::size_type signal_impl::size() const noexcept
Packit f47435
{
Packit f47435
  return slots_.size();
Packit f47435
}
Packit f47435
Packit f47435
bool signal_impl::blocked() const noexcept
Packit f47435
{
Packit f47435
  for (const auto& slot : const_cast<const std::list<slot_base>&>(slots_))
Packit f47435
  {
Packit f47435
    if (!slot.blocked())
Packit f47435
      return false;
Packit f47435
  }
Packit f47435
  return true;
Packit f47435
}
Packit f47435
Packit f47435
void signal_impl::block(bool should_block) noexcept
Packit f47435
{
Packit f47435
  for (auto& slot : slots_)
Packit f47435
  {
Packit f47435
    slot.block(should_block);
Packit f47435
  }
Packit f47435
}
Packit f47435
Packit f47435
signal_impl::iterator_type signal_impl::connect(const slot_base& slot_)
Packit f47435
{
Packit f47435
  return insert(slots_.end(), slot_);
Packit f47435
}
Packit f47435
Packit f47435
signal_impl::iterator_type signal_impl::connect(slot_base&& slot_)
Packit f47435
{
Packit f47435
  return insert(slots_.end(), std::move(slot_));
Packit f47435
}
Packit f47435
Packit f47435
signal_impl::iterator_type signal_impl::erase(iterator_type i)
Packit f47435
{
Packit f47435
  // Don't let signal_impl::notify() erase the slot. It would be more
Packit f47435
  // difficult to get the correct return value from signal_impl::erase().
Packit f47435
  const bool saved_deferred = deferred_;
Packit f47435
  signal_exec exec(this);
Packit f47435
Packit f47435
  // Disconnect the slot before it is deleted.
Packit f47435
  // signal_impl::notify() will be called and delete the self_and_iter struct.
Packit f47435
  i->disconnect();
Packit f47435
Packit f47435
  deferred_ = saved_deferred;
Packit f47435
Packit f47435
  return slots_.erase(i);
Packit f47435
}
Packit f47435
    
Packit f47435
signal_impl::iterator_type signal_impl::insert(signal_impl::iterator_type i, const slot_base& slot_)
Packit f47435
{
Packit f47435
  auto temp = slots_.insert(i, slot_);
Packit f47435
  auto si = new self_and_iter(this, temp);
Packit f47435
  temp->set_parent(si, &notify);
Packit f47435
  return temp;
Packit f47435
}
Packit f47435
Packit f47435
signal_impl::iterator_type signal_impl::insert(signal_impl::iterator_type i, slot_base&& slot_)
Packit f47435
{
Packit f47435
  auto temp = slots_.insert(i, std::move(slot_));
Packit f47435
  auto si = new self_and_iter(this, temp);
Packit f47435
  temp->set_parent(si, &notify);
Packit f47435
  return temp;
Packit f47435
}
Packit f47435
Packit f47435
void signal_impl::sweep()
Packit f47435
{
Packit f47435
  // The deletion of a slot may cause the deletion of a signal_base,
Packit f47435
  // a decrementation of ref_count_, and the deletion of this.
Packit f47435
  // In that case, the deletion of this is deferred to ~signal_exec().
Packit f47435
  signal_exec exec(this);
Packit f47435
Packit f47435
  deferred_ = false;
Packit f47435
  auto i = slots_.begin();
Packit f47435
  while (i != slots_.end())
Packit f47435
    if ((*i).empty())
Packit f47435
      i = slots_.erase(i);
Packit f47435
    else
Packit f47435
      ++i;
Packit f47435
}
Packit f47435
Packit f47435
//static
Packit f47435
void* signal_impl::notify(void* d)
Packit f47435
{
Packit f47435
  std::unique_ptr<self_and_iter> si(static_cast<self_and_iter*>(d));
Packit f47435
Packit f47435
  if (si->self_->exec_count_ == 0)
Packit f47435
  {
Packit f47435
    // The deletion of a slot may cause the deletion of a signal_base,
Packit f47435
    // a decrementation of si->self_->ref_count_, and the deletion of si->self_.
Packit f47435
    // In that case, the deletion of si->self_ is deferred to ~signal_exec().
Packit f47435
    signal_exec exec(si->self_);
Packit f47435
    si->self_->slots_.erase(si->iter_);
Packit f47435
  }
Packit f47435
  else                           // This is occuring during signal emission or slot erasure.
Packit f47435
    si->self_->deferred_ = true; // => sweep() will be called from ~signal_exec() after signal emission.
Packit f47435
  return nullptr;                // This is safer because we don't have to care about our
Packit f47435
                                 // iterators in emit(), clear(), and erase().
Packit f47435
}
Packit f47435
Packit f47435
} /* namespace internal */
Packit f47435
Packit f47435
signal_base::signal_base() noexcept
Packit f47435
: impl_(nullptr)
Packit f47435
{}
Packit f47435
Packit f47435
signal_base::signal_base(const signal_base& src) noexcept
Packit f47435
: trackable(),
Packit f47435
  impl_(src.impl())
Packit f47435
{
Packit f47435
  impl_->reference();
Packit f47435
}
Packit f47435
Packit f47435
signal_base::signal_base(signal_base&& src)
Packit f47435
: trackable(std::move(src)),
Packit f47435
  impl_(std::move(src.impl_))
Packit f47435
{
Packit f47435
  src.impl_ = nullptr;
Packit f47435
}
Packit f47435
Packit f47435
signal_base::~signal_base()
Packit f47435
{
Packit f47435
  if (impl_)
Packit f47435
  {
Packit f47435
    // Disconnect all slots before impl_ is deleted.
Packit f47435
    // TODO: Move the signal_impl::clear() call to ~signal_impl() when ABI can be broken.
Packit f47435
    if (impl_->ref_count_ == 1)
Packit f47435
      impl_->clear();
Packit f47435
Packit f47435
    impl_->unreference();
Packit f47435
  }
Packit f47435
}
Packit f47435
Packit f47435
void signal_base::clear()
Packit f47435
{
Packit f47435
  if (impl_)
Packit f47435
    impl_->clear();
Packit f47435
}
Packit f47435
Packit f47435
signal_base::size_type signal_base::size() const noexcept
Packit f47435
{
Packit f47435
  return (impl_ ? impl_->size() : 0);
Packit f47435
}
Packit f47435
Packit f47435
bool signal_base::blocked() const noexcept
Packit f47435
{
Packit f47435
  return (impl_ ? impl_->blocked() : true);
Packit f47435
}
Packit f47435
Packit f47435
void signal_base::block(bool should_block) noexcept
Packit f47435
{
Packit f47435
  if (impl_)
Packit f47435
    impl_->block(should_block);
Packit f47435
}
Packit f47435
Packit f47435
void signal_base::unblock() noexcept
Packit f47435
{
Packit f47435
  if (impl_)
Packit f47435
    impl_->block(false);
Packit f47435
}
Packit f47435
Packit f47435
signal_base::iterator_type signal_base::connect(const slot_base& slot_)
Packit f47435
{
Packit f47435
  return impl()->connect(slot_);
Packit f47435
}
Packit f47435
Packit f47435
signal_base::iterator_type signal_base::connect(slot_base&& slot_)
Packit f47435
{
Packit f47435
  return impl()->connect(std::move(slot_));
Packit f47435
}
Packit f47435
Packit f47435
signal_base::iterator_type signal_base::insert(iterator_type i, const slot_base& slot_)
Packit f47435
{
Packit f47435
  return impl()->insert(i, slot_);
Packit f47435
}
Packit f47435
Packit f47435
signal_base::iterator_type signal_base::insert(iterator_type i, slot_base&& slot_)
Packit f47435
{
Packit f47435
  return impl()->insert(i, std::move(slot_));
Packit f47435
}
Packit f47435
Packit f47435
signal_base::iterator_type signal_base::erase(iterator_type i)
Packit f47435
{
Packit f47435
  return impl()->erase(i);
Packit f47435
}
Packit f47435
Packit f47435
signal_base& signal_base::operator=(const signal_base& src)
Packit f47435
{
Packit f47435
  if (src.impl_ == impl_) return *this;
Packit f47435
Packit f47435
  if (impl_)
Packit f47435
  {
Packit f47435
    // Disconnect all slots before impl_ is deleted.
Packit f47435
    // TODO: Move the signal_impl::clear() call to ~signal_impl() when ABI can be broken.
Packit f47435
    if (impl_->ref_count_ == 1)
Packit f47435
      impl_->clear();
Packit f47435
Packit f47435
    impl_->unreference();
Packit f47435
  }
Packit f47435
  impl_ = src.impl();
Packit f47435
  impl_->reference();
Packit f47435
  return *this;
Packit f47435
}
Packit f47435
Packit f47435
signal_base& signal_base::operator=(signal_base&& src)
Packit f47435
{
Packit f47435
  if (src.impl_ == impl_) return *this;
Packit f47435
Packit f47435
  if (impl_)
Packit f47435
  {
Packit f47435
    // Disconnect all slots before impl_ is deleted.
Packit f47435
    // TODO: Move the signal_impl::clear() call to ~signal_impl() when ABI can be broken.
Packit f47435
    if (impl_->ref_count_ == 1)
Packit f47435
      impl_->clear();
Packit f47435
Packit f47435
    impl_->unreference();
Packit f47435
  }
Packit f47435
Packit f47435
  src.notify_callbacks();
Packit f47435
  impl_ = src.impl_;
Packit f47435
  src.impl_ = nullptr;
Packit f47435
Packit f47435
  return *this;
Packit f47435
}
Packit f47435
Packit f47435
internal::signal_impl* signal_base::impl() const
Packit f47435
{
Packit f47435
  if (!impl_) {
Packit f47435
    impl_ = new internal::signal_impl;
Packit f47435
    impl_->reference();  // start with a reference count of 1
Packit f47435
  }
Packit f47435
  return impl_;
Packit f47435
}
Packit f47435
Packit f47435
} /* sigc */