4 /* Copyright (C) 2002 The gtkmm Development Team
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the Free
18 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <glibmm/main.h>
22 #include <glibmm/exceptionhandler.h>
23 #include <glibmm/thread.h>
24 #include <glibmm/wrap.h>
25 #include <glibmm/iochannel.h>
27 #include <glib/gmessages.h>
36 class SourceConnectionNode
39 explicit inline SourceConnectionNode(const sigc::slot_base& slot);
41 static void* notify(void* data);
42 static void destroy_notify_callback(void* data);
44 inline void install(GSource* source);
45 inline sigc::slot_base* get_slot();
48 sigc::slot_base slot_;
53 SourceConnectionNode::SourceConnectionNode(const sigc::slot_base& slot)
58 slot_.set_parent(this, &SourceConnectionNode::notify);
61 void* SourceConnectionNode::notify(void* data)
63 SourceConnectionNode *const self = static_cast<SourceConnectionNode*>(data);
65 // if there is no object, this call was triggered from destroy_notify_handler(),
66 // because we set self->source_ to 0 there:
69 GSource* s = self->source_;
73 // Destroying the object triggers execution of destroy_notify_handler(),
74 // eiter immediately or later, so we leave that to do the deletion.
81 void SourceConnectionNode::destroy_notify_callback(void* data)
83 SourceConnectionNode *const self = static_cast<SourceConnectionNode*>(data);
87 // The GLib side is disconnected now, thus the GSource* is no longer valid.
95 void SourceConnectionNode::install(GSource* source)
101 sigc::slot_base* SourceConnectionNode::get_slot()
107 /* We use the callback data member of GSource to store both a pointer to our
108 * wrapper and a pointer to the connection node that is currently being used.
109 * The one and only SourceCallbackData object of a Glib::Source is constructed
110 * in the ctor of Glib::Source and destroyed after the GSource object when the
111 * reference counter of the GSource object reaches zero!
113 struct SourceCallbackData
115 explicit inline SourceCallbackData(Glib::Source* wrapper_);
117 void set_node(SourceConnectionNode* node_);
119 static void destroy_notify_callback(void* data);
121 Glib::Source* wrapper;
122 SourceConnectionNode* node;
126 SourceCallbackData::SourceCallbackData(Glib::Source* wrapper_)
132 void SourceCallbackData::set_node(SourceConnectionNode* node_)
135 SourceConnectionNode::destroy_notify_callback(node);
141 void SourceCallbackData::destroy_notify_callback(void* data)
143 SourceCallbackData *const self = static_cast<SourceCallbackData*>(data);
146 SourceConnectionNode::destroy_notify_callback(self->node);
149 Glib::Source::destroy_notify_callback(self->wrapper);
155 /* Retrieve the callback data from a wrapped GSource object.
157 static SourceCallbackData* glibmm_source_get_callback_data(GSource* source)
159 g_return_val_if_fail(source->callback_funcs->get != 0, 0);
164 // Retrieve the callback function and data.
165 (*source->callback_funcs->get)(source->callback_data, source, &func, &user_data);
167 return static_cast<SourceCallbackData*>(user_data);
170 /* Glib::Source doesn't use the callback function installed with
171 * g_source_set_callback(). Instead, it invokes the sigc++ slot
172 * directly from dispatch_vfunc(), which is both simpler and more
174 * For correctness, provide a pointer to this dummy callback rather
175 * than some random pointer. That also allows for sanity checks
176 * here as well as in Source::dispatch_vfunc().
178 static gboolean glibmm_dummy_source_callback(void*)
180 g_assert_not_reached();
184 /* Only used by SignalTimeout::connect() and SignalIdle::connect().
185 * These don't use Glib::Source, to avoid the unnecessary overhead
186 * of a completely unused wrapper object.
188 static gboolean glibmm_source_callback(void* data)
190 SourceConnectionNode *const conn_data = static_cast<SourceConnectionNode*>(data);
194 // Recreate the specific slot from the generic slot node.
195 return (*static_cast<sigc::slot<bool>*>(conn_data->get_slot()))();
199 Glib::exception_handlers_invoke();
204 static gboolean glibmm_iosource_callback(GIOChannel*, GIOCondition condition, void* data)
206 SourceCallbackData *const callback_data = static_cast<SourceCallbackData*>(data);
207 g_return_val_if_fail(callback_data->node != 0, 0);
211 // Recreate the specific slot from the generic slot node.
212 return (*static_cast<sigc::slot<bool,Glib::IOCondition>*>(callback_data->node->get_slot()))
213 ((Glib::IOCondition) condition);
217 Glib::exception_handlers_invoke();
222 } // anonymous namespace
228 /**** Glib::PollFD *********************************************************/
234 gobject_.revents = 0;
237 PollFD::PollFD(int fd)
241 gobject_.revents = 0;
244 PollFD::PollFD(int fd, IOCondition events)
247 gobject_.events = events;
248 gobject_.revents = 0;
252 /**** Glib::SignalTimeout **************************************************/
255 SignalTimeout::SignalTimeout(GMainContext* context)
260 sigc::connection SignalTimeout::connect(const sigc::slot<bool>& slot,
261 unsigned int interval, int priority)
263 SourceConnectionNode *const conn_node = new SourceConnectionNode(slot);
264 const sigc::connection connection (*conn_node->get_slot());
266 GSource *const source = g_timeout_source_new(interval);
268 if(priority != G_PRIORITY_DEFAULT)
269 g_source_set_priority(source, priority);
271 g_source_set_callback(
272 source, &glibmm_source_callback, conn_node,
273 &SourceConnectionNode::destroy_notify_callback);
275 g_source_attach(source, context_);
276 g_source_unref(source); // GMainContext holds a reference
278 conn_node->install(source);
282 SignalTimeout signal_timeout()
284 return SignalTimeout(0); // 0 means default context
288 /**** Glib::SignalIdle *****************************************************/
291 SignalIdle::SignalIdle(GMainContext* context)
296 sigc::connection SignalIdle::connect(const sigc::slot<bool>& slot, int priority)
298 SourceConnectionNode *const conn_node = new SourceConnectionNode(slot);
299 const sigc::connection connection (*conn_node->get_slot());
301 GSource *const source = g_idle_source_new();
303 if(priority != G_PRIORITY_DEFAULT)
304 g_source_set_priority(source, priority);
306 g_source_set_callback(
307 source, &glibmm_source_callback, conn_node,
308 &SourceConnectionNode::destroy_notify_callback);
310 g_source_attach(source, context_);
311 g_source_unref(source); // GMainContext holds a reference
313 conn_node->install(source);
317 SignalIdle signal_idle()
319 return SignalIdle(0); // 0 means default context
323 /**** Glib::SignalIO *******************************************************/
326 SignalIO::SignalIO(GMainContext* context)
331 sigc::connection SignalIO::connect(const sigc::slot<bool,IOCondition>& slot,
332 int fd, IOCondition condition, int priority)
334 const Glib::RefPtr<IOSource> source = IOSource::create(fd, condition);
336 if(priority != G_PRIORITY_DEFAULT)
337 source->set_priority(priority);
339 const sigc::connection connection = source->connect(slot);
341 g_source_attach(source->gobj(), context_);
346 sigc::connection SignalIO::connect(const sigc::slot<bool,IOCondition>& slot,
347 const Glib::RefPtr<IOChannel>& channel,
348 IOCondition condition, int priority)
350 const Glib::RefPtr<IOSource> source = IOSource::create(channel, condition);
352 if(priority != G_PRIORITY_DEFAULT)
353 source->set_priority(priority);
355 const sigc::connection connection = source->connect(slot);
357 g_source_attach(source->gobj(), context_);
364 return SignalIO(0); // 0 means default context
368 /**** Glib::MainContext ****************************************************/
371 Glib::RefPtr<MainContext> MainContext::create()
373 return Glib::RefPtr<MainContext>(reinterpret_cast<MainContext*>(g_main_context_new()));
377 Glib::RefPtr<MainContext> MainContext::get_default()
379 return Glib::wrap(g_main_context_default(), true);
382 bool MainContext::iteration(bool may_block)
384 return g_main_context_iteration(gobj(), may_block);
387 bool MainContext::pending()
389 return g_main_context_pending(gobj());
392 void MainContext::wakeup()
394 g_main_context_wakeup(gobj());
397 bool MainContext::acquire()
399 return g_main_context_acquire(gobj());
402 bool MainContext::wait(Glib::Cond& cond, Glib::Mutex& mutex)
404 return g_main_context_wait(gobj(), cond.gobj(), mutex.gobj());
407 void MainContext::release()
409 g_main_context_release(gobj());
412 bool MainContext::prepare(int& priority)
414 return g_main_context_prepare(gobj(), &priority);
417 bool MainContext::prepare()
419 return g_main_context_prepare(gobj(), 0);
422 void MainContext::query(int max_priority, int& timeout, std::vector<PollFD>& fds)
425 fds.resize(8); // rather bogus number, but better than 0
429 const int size_before = fds.size();
430 const int size_needed = g_main_context_query(
431 gobj(), max_priority, &timeout, reinterpret_cast<GPollFD*>(&fds.front()), size_before);
433 fds.resize(size_needed);
435 if(size_needed <= size_before)
440 bool MainContext::check(int max_priority, std::vector<PollFD>& fds)
443 return g_main_context_check(gobj(), max_priority, reinterpret_cast<GPollFD*>(&fds.front()), fds.size());
448 void MainContext::dispatch()
450 g_main_context_dispatch(gobj());
453 void MainContext::set_poll_func(GPollFunc poll_func)
455 g_main_context_set_poll_func(gobj(), poll_func);
458 GPollFunc MainContext::get_poll_func()
460 return g_main_context_get_poll_func(gobj());
463 void MainContext::add_poll(PollFD& fd, int priority)
465 g_main_context_add_poll(gobj(), fd.gobj(), priority);
468 void MainContext::remove_poll(PollFD& fd)
470 g_main_context_remove_poll(gobj(), fd.gobj());
473 SignalTimeout MainContext::signal_timeout()
475 return SignalTimeout(gobj());
478 SignalIdle MainContext::signal_idle()
480 return SignalIdle(gobj());
483 SignalIO MainContext::signal_io()
485 return SignalIO(gobj());
488 void MainContext::reference() const
490 g_main_context_ref(reinterpret_cast<GMainContext*>(const_cast<MainContext*>(this)));
493 void MainContext::unreference() const
495 g_main_context_unref(reinterpret_cast<GMainContext*>(const_cast<MainContext*>(this)));
498 GMainContext* MainContext::gobj()
500 return reinterpret_cast<GMainContext*>(this);
503 const GMainContext* MainContext::gobj() const
505 return reinterpret_cast<const GMainContext*>(this);
508 GMainContext* MainContext::gobj_copy() const
511 return const_cast<GMainContext*>(gobj());
514 Glib::RefPtr<MainContext> wrap(GMainContext* gobject, bool take_copy)
516 if(take_copy && gobject)
517 g_main_context_ref(gobject);
519 return Glib::RefPtr<MainContext>(reinterpret_cast<MainContext*>(gobject));
523 /**** Glib::MainLoop *******************************************************/
525 Glib::RefPtr<MainLoop> MainLoop::create(bool is_running)
527 return Glib::RefPtr<MainLoop>(
528 reinterpret_cast<MainLoop*>(g_main_loop_new(0, is_running)));
531 Glib::RefPtr<MainLoop> MainLoop::create(const Glib::RefPtr<MainContext>& context, bool is_running)
533 return Glib::RefPtr<MainLoop>(
534 reinterpret_cast<MainLoop*>(g_main_loop_new(Glib::unwrap(context), is_running)));
539 g_main_loop_run(gobj());
542 void MainLoop::quit()
544 g_main_loop_quit(gobj());
547 bool MainLoop::is_running()
549 return g_main_loop_is_running(gobj());
552 Glib::RefPtr<MainContext> MainLoop::get_context()
554 return Glib::wrap(g_main_loop_get_context(gobj()), true);
558 int MainLoop::depth()
560 return g_main_depth();
563 void MainLoop::reference() const
565 g_main_loop_ref(reinterpret_cast<GMainLoop*>(const_cast<MainLoop*>(this)));
568 void MainLoop::unreference() const
570 g_main_loop_unref(reinterpret_cast<GMainLoop*>(const_cast<MainLoop*>(this)));
573 GMainLoop* MainLoop::gobj()
575 return reinterpret_cast<GMainLoop*>(this);
578 const GMainLoop* MainLoop::gobj() const
580 return reinterpret_cast<const GMainLoop*>(this);
583 GMainLoop* MainLoop::gobj_copy() const
586 return const_cast<GMainLoop*>(gobj());
589 Glib::RefPtr<MainLoop> wrap(GMainLoop* gobject, bool take_copy)
591 if(take_copy && gobject)
592 g_main_loop_ref(gobject);
594 return Glib::RefPtr<MainLoop>(reinterpret_cast<MainLoop*>(gobject));
598 /**** Glib::Source *********************************************************/
601 const GSourceFuncs Source::vfunc_table_ =
603 &Source::prepare_vfunc,
604 &Source::check_vfunc,
605 &Source::dispatch_vfunc,
606 0, // finalize_vfunc // We can't use finalize_vfunc because there is no way
607 // to store a pointer to our wrapper anywhere in GSource so
608 // that it persists until finalize_vfunc would be called from here.
609 0, // closure_callback
610 0, // closure_marshal
613 unsigned int Source::attach(const Glib::RefPtr<MainContext>& context)
615 return g_source_attach(gobject_, Glib::unwrap(context));
618 unsigned int Source::attach()
620 return g_source_attach(gobject_, 0);
623 void Source::destroy()
625 g_source_destroy(gobject_);
628 void Source::set_priority(int priority)
630 g_source_set_priority(gobject_, priority);
633 int Source::get_priority() const
635 return g_source_get_priority(gobject_);
638 void Source::set_can_recurse(bool can_recurse)
640 g_source_set_can_recurse(gobject_, can_recurse);
643 bool Source::get_can_recurse() const
645 return g_source_get_can_recurse(gobject_);
648 unsigned int Source::get_id() const
650 return g_source_get_id(gobject_);
653 Glib::RefPtr<MainContext> Source::get_context()
655 return Glib::wrap(g_source_get_context(gobject_), true);
658 GSource* Source::gobj_copy() const
660 return g_source_ref(gobject_);
663 void Source::reference() const
665 g_source_ref(gobject_);
668 void Source::unreference() const
670 g_source_unref(gobject_);
675 gobject_ (g_source_new(const_cast<GSourceFuncs*>(&vfunc_table_), sizeof(GSource)))
677 g_source_set_callback(
678 gobject_, &glibmm_dummy_source_callback,
679 new SourceCallbackData(this), // our persistant callback data object
680 &SourceCallbackData::destroy_notify_callback);
683 Source::Source(GSource* cast_item, GSourceFunc callback_func)
687 g_source_set_callback(
688 gobject_, callback_func,
689 new SourceCallbackData(this), // our persistant callback data object
690 &SourceCallbackData::destroy_notify_callback);
695 // The dtor should be invoked by destroy_notify_callback() only, which clears
696 // gobject_ before deleting. However, we might also get to this point if
697 // a derived ctor threw an exception, and then we need to unref manually.
701 SourceCallbackData *const data = glibmm_source_get_callback_data(gobject_);
704 GSource *const tmp_gobject = gobject_;
707 g_source_unref(tmp_gobject);
711 sigc::connection Source::connect_generic(const sigc::slot_base& slot)
713 SourceConnectionNode *const conn_node = new SourceConnectionNode(slot);
714 const sigc::connection connection (*conn_node->get_slot());
716 // Don't override the callback data. Reuse the existing one
717 // calling SourceCallbackData::set_node() to register conn_node.
718 SourceCallbackData *const data = glibmm_source_get_callback_data(gobject_);
719 data->set_node(conn_node);
721 conn_node->install(gobject_);
725 void Source::add_poll(Glib::PollFD& poll_fd)
727 g_source_add_poll(gobject_, poll_fd.gobj());
730 void Source::remove_poll(Glib::PollFD& poll_fd)
732 g_source_remove_poll(gobject_, poll_fd.gobj());
735 void Source::get_current_time(Glib::TimeVal& current_time)
737 g_source_get_current_time(gobject_, ¤t_time);
741 Source* Source::get_wrapper(GSource* source)
743 SourceCallbackData *const data = glibmm_source_get_callback_data(source);
744 return data->wrapper;
748 gboolean Source::prepare_vfunc(GSource* source, int* timeout)
752 Source *const self = get_wrapper(source);
753 return self->prepare(*timeout);
757 Glib::exception_handlers_invoke();
763 gboolean Source::check_vfunc(GSource* source)
767 Source *const self = get_wrapper(source);
768 return self->check();
772 Glib::exception_handlers_invoke();
778 gboolean Source::dispatch_vfunc(GSource*, GSourceFunc callback, void* user_data)
780 SourceCallbackData *const callback_data = static_cast<SourceCallbackData*>(user_data);
782 g_return_val_if_fail(callback == &glibmm_dummy_source_callback, 0);
783 g_return_val_if_fail(callback_data != 0 && callback_data->node != 0, 0);
787 Source *const self = callback_data->wrapper;
788 return self->dispatch(callback_data->node->get_slot());
792 Glib::exception_handlers_invoke();
798 void Source::destroy_notify_callback(void* data)
802 Source *const self = static_cast<Source*>(data);
804 // gobject_ is already invalid at this point.
807 // No exception checking: if the dtor throws, you're out of luck anyway.
813 /**** Glib::TimeoutSource **************************************************/
816 Glib::RefPtr<TimeoutSource> TimeoutSource::create(unsigned int interval)
818 return Glib::RefPtr<TimeoutSource>(new TimeoutSource(interval));
821 sigc::connection TimeoutSource::connect(const sigc::slot<bool>& slot)
823 return connect_generic(slot);
826 TimeoutSource::TimeoutSource(unsigned int interval)
830 expiration_.assign_current_time();
831 expiration_.add_milliseconds(std::min<unsigned long>(G_MAXLONG, interval_));
834 TimeoutSource::~TimeoutSource()
837 bool TimeoutSource::prepare(int& timeout)
839 Glib::TimeVal current_time;
840 get_current_time(current_time);
842 Glib::TimeVal remaining = expiration_;
843 remaining.subtract(current_time);
845 if(remaining.negative())
852 const unsigned long milliseconds =
853 static_cast<unsigned long>(remaining.tv_sec) * 1000U +
854 static_cast<unsigned long>(remaining.tv_usec) / 1000U;
856 // Set remaining milliseconds.
857 timeout = std::min<unsigned long>(G_MAXINT, milliseconds);
859 // Check if the system time has been set backwards. (remaining > interval)
860 remaining.add_milliseconds(- std::min<unsigned long>(G_MAXLONG, interval_) - 1);
861 if(!remaining.negative())
863 // Oh well. Reset the expiration time to now + interval;
864 // this at least avoids hanging for long periods of time.
865 expiration_ = current_time;
866 expiration_.add_milliseconds(interval_);
867 timeout = std::min<unsigned int>(G_MAXINT, interval_);
871 return (timeout == 0);
874 bool TimeoutSource::check()
876 Glib::TimeVal current_time;
877 get_current_time(current_time);
879 return (expiration_ <= current_time);
882 bool TimeoutSource::dispatch(sigc::slot_base* slot)
884 const bool again = (*static_cast<sigc::slot<bool>*>(slot))();
888 get_current_time(expiration_);
889 expiration_.add_milliseconds(std::min<unsigned long>(G_MAXLONG, interval_));
896 /**** Glib::IdleSource *****************************************************/
899 Glib::RefPtr<IdleSource> IdleSource::create()
901 return Glib::RefPtr<IdleSource>(new IdleSource());
904 sigc::connection IdleSource::connect(const sigc::slot<bool>& slot)
906 return connect_generic(slot);
909 IdleSource::IdleSource()
911 set_priority(PRIORITY_DEFAULT_IDLE);
914 IdleSource::~IdleSource()
917 bool IdleSource::prepare(int& timeout)
923 bool IdleSource::check()
928 bool IdleSource::dispatch(sigc::slot_base* slot)
930 return (*static_cast<sigc::slot<bool>*>(slot))();
934 /**** Glib::IOSource *******************************************************/
937 Glib::RefPtr<IOSource> IOSource::create(int fd, IOCondition condition)
939 return Glib::RefPtr<IOSource>(new IOSource(fd, condition));
942 Glib::RefPtr<IOSource> IOSource::create(const Glib::RefPtr<IOChannel>& channel, IOCondition condition)
944 return Glib::RefPtr<IOSource>(new IOSource(channel, condition));
947 sigc::connection IOSource::connect(const sigc::slot<bool,IOCondition>& slot)
949 return connect_generic(slot);
952 IOSource::IOSource(int fd, IOCondition condition)
954 poll_fd_ (fd, condition)
959 IOSource::IOSource(const Glib::RefPtr<IOChannel>& channel, IOCondition condition)
961 Source(g_io_create_watch(channel->gobj(), (GIOCondition) condition),
962 (GSourceFunc) &glibmm_iosource_callback)
965 IOSource::~IOSource()
968 bool IOSource::prepare(int& timeout)
974 bool IOSource::check()
976 return ((poll_fd_.get_revents() & poll_fd_.get_events()) != 0);
979 bool IOSource::dispatch(sigc::slot_base* slot)
981 return (*static_cast<sigc::slot<bool,IOCondition>*>(slot))
982 (poll_fd_.get_revents());