// This file was GENERATED by command: // pump.py callback_list.h.pump // DO NOT EDIT BY HAND!!! // Copyright 2013 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef BASE_CALLBACK_LIST_H_ #define BASE_CALLBACK_LIST_H_ #include #include "base/basictypes.h" #include "base/callback.h" #include "base/callback_internal.h" #include "base/compiler_specific.h" #include "base/logging.h" #include "base/memory/scoped_ptr.h" // OVERVIEW: // // A container for a list of callbacks. Unlike a normal STL vector or list, // this container can be modified during iteration without invalidating the // iterator. It safely handles the case of a callback removing itself // or another callback from the list while callbacks are being run. // // TYPICAL USAGE: // // class MyWidget { // public: // ... // // typedef base::Callback OnFooCallback; // // scoped_ptr::Subscription> // RegisterCallback(const OnFooCallback& cb) { // return callback_list_.Add(cb); // } // // private: // void NotifyFoo(const Foo& foo) { // callback_list_.Notify(foo); // } // // base::CallbackList callback_list_; // // DISALLOW_COPY_AND_ASSIGN(MyWidget); // }; // // // class MyWidgetListener { // public: // MyWidgetListener::MyWidgetListener() { // foo_subscription_ = MyWidget::GetCurrent()->RegisterCallback( // base::Bind(&MyWidgetListener::OnFoo, this))); // } // // MyWidgetListener::~MyWidgetListener() { // // Subscription gets deleted automatically and will deregister // // the callback in the process. // } // // private: // void OnFoo(const Foo& foo) { // // Do something. // } // // scoped_ptr::Subscription> // foo_subscription_; // // DISALLOW_COPY_AND_ASSIGN(MyWidgetListener); // }; namespace base { namespace internal { template class CallbackListBase { public: class Subscription { public: Subscription(CallbackListBase* list, typename std::list::iterator iter) : list_(list), iter_(iter) { } ~Subscription() { if (list_->active_iterator_count_) iter_->Reset(); else list_->callbacks_.erase(iter_); } private: CallbackListBase* list_; typename std::list::iterator iter_; DISALLOW_COPY_AND_ASSIGN(Subscription); }; // Add a callback to the list. The callback will remain registered until the // returned Subscription is destroyed, which must occur before the // CallbackList is destroyed. scoped_ptr Add(const CallbackType& cb) WARN_UNUSED_RESULT { DCHECK(!cb.is_null()); return scoped_ptr( new Subscription(this, callbacks_.insert(callbacks_.end(), cb))); } protected: // An iterator class that can be used to access the list of callbacks. class Iterator { public: explicit Iterator(CallbackListBase* list) : list_(list), list_iter_(list_->callbacks_.begin()) { ++list_->active_iterator_count_; } Iterator(const Iterator& iter) : list_(iter.list_), list_iter_(iter.list_iter_) { ++list_->active_iterator_count_; } ~Iterator() { if (list_ && --list_->active_iterator_count_ == 0) { list_->Compact(); } } CallbackType* GetNext() { while ((list_iter_ != list_->callbacks_.end()) && list_iter_->is_null()) ++list_iter_; CallbackType* cb = NULL; if (list_iter_ != list_->callbacks_.end()) { cb = &(*list_iter_); ++list_iter_; } return cb; } private: CallbackListBase* list_; typename std::list::iterator list_iter_; }; CallbackListBase() : active_iterator_count_(0) {} ~CallbackListBase() { DCHECK_EQ(0, active_iterator_count_); DCHECK_EQ(0U, callbacks_.size()); } // Returns an instance of a CallbackListBase::Iterator which can be used // to run callbacks. Iterator GetIterator() { return Iterator(this); } // Compact the list: remove any entries which were NULLed out during // iteration. void Compact() { typename std::list::iterator it = callbacks_.begin(); while (it != callbacks_.end()) { if ((*it).is_null()) it = callbacks_.erase(it); else ++it; } } private: std::list callbacks_; int active_iterator_count_; DISALLOW_COPY_AND_ASSIGN(CallbackListBase); }; } // namespace internal template class CallbackList; template <> class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify() { internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2, typename internal::CallbackParamTraits::ForwardType a3) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2, a3); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2, typename internal::CallbackParamTraits::ForwardType a3, typename internal::CallbackParamTraits::ForwardType a4) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2, a3, a4); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2, typename internal::CallbackParamTraits::ForwardType a3, typename internal::CallbackParamTraits::ForwardType a4, typename internal::CallbackParamTraits::ForwardType a5) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2, a3, a4, a5); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2, typename internal::CallbackParamTraits::ForwardType a3, typename internal::CallbackParamTraits::ForwardType a4, typename internal::CallbackParamTraits::ForwardType a5, typename internal::CallbackParamTraits::ForwardType a6) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2, a3, a4, a5, a6); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; template class CallbackList : public internal::CallbackListBase > { public: typedef Callback CallbackType; CallbackList() {} void Notify(typename internal::CallbackParamTraits::ForwardType a1, typename internal::CallbackParamTraits::ForwardType a2, typename internal::CallbackParamTraits::ForwardType a3, typename internal::CallbackParamTraits::ForwardType a4, typename internal::CallbackParamTraits::ForwardType a5, typename internal::CallbackParamTraits::ForwardType a6, typename internal::CallbackParamTraits::ForwardType a7) { typename internal::CallbackListBase::Iterator it = this->GetIterator(); CallbackType* cb; while ((cb = it.GetNext()) != NULL) { cb->Run(a1, a2, a3, a4, a5, a6, a7); } } private: DISALLOW_COPY_AND_ASSIGN(CallbackList); }; } // namespace base #endif // BASE_CALLBACK_LIST_H_