/usr/include/glibmm-2.4/glibmm/main.h is in libglibmm-2.4-dev 2.56.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 | #ifndef _GLIBMM_MAIN_H
#define _GLIBMM_MAIN_H
/* Copyright (C) 2002 The gtkmm 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, see <http://www.gnu.org/licenses/>.
*/
#include <glibmmconfig.h>
#include <glibmm/refptr.h>
#include <glibmm/timeval.h>
#include <glibmm/priorities.h>
#include <glibmm/iochannel.h>
#include <sigc++/sigc++.h>
#include <vector>
#include <cstddef>
namespace Glib
{
#ifndef GLIBMM_DISABLE_DEPRECATED
class Cond;
class Mutex;
namespace Threads
{
class Cond;
class Mutex;
}
#endif // GLIBMM_DISABLE_DEPRECATED
/** @defgroup MainLoop The Main Event Loop
* Manages all available sources of events.
* @{
*/
class PollFD
{
public:
using fd_t = decltype(GPollFD::fd);
PollFD();
explicit PollFD(fd_t fd);
PollFD(fd_t fd, IOCondition events);
void set_fd(fd_t fd) { gobject_.fd = fd; }
fd_t get_fd() const { return gobject_.fd; }
void set_events(IOCondition events) { gobject_.events = events; }
IOCondition get_events() const { return static_cast<IOCondition>(gobject_.events); }
void set_revents(IOCondition revents) { gobject_.revents = revents; }
IOCondition get_revents() const { return static_cast<IOCondition>(gobject_.revents); }
GPollFD* gobj() { return &gobject_; }
const GPollFD* gobj() const { return &gobject_; }
private:
GPollFD gobject_;
};
// Concerning SignalTimeout::connect_once(), SignalTimeout::connect_seconds_once()
// and SignalIdle::connect_once():
// See https://bugzilla.gnome.org/show_bug.cgi?id=396963 and
// http://bugzilla.gnome.org/show_bug.cgi?id=512348 about the sigc::trackable issue.
// It's recommended to replace sigc::slot<void>& by std::function<void()>& in
// Threads::Thread::create() and ThreadPool::push() at the next ABI break.
// Such a replacement would be a mixed blessing in SignalTimeout and SignalIdle.
// In a single-threaded program auto-disconnection of trackable slots is safe
// and can be useful.
class SignalTimeout
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
explicit inline SignalTimeout(GMainContext* context);
#endif
/** Connects a timeout handler.
*
* Note that timeout functions may be delayed, due to the processing of other
* event sources. Thus they should not be relied on for precise timing.
* After each call to the timeout function, the time of the next
* timeout is recalculated based on the current time and the given interval
* (it does not try to 'catch up' time lost in delays).
*
* If you want to have a timer in the "seconds" range and do not care
* about the exact time of the first call of the timer, use the
* connect_seconds() function; this function allows for more
* optimizations and more efficient system power usage.
*
* @code
* bool timeout_handler() { ... }
* Glib::signal_timeout().connect(sigc::ptr_fun(&timeout_handler), 1000);
* @endcode
* is equivalent to:
* @code
* bool timeout_handler() { ... }
* const auto timeout_source = Glib::TimeoutSource::create(1000);
* timeout_source->connect(sigc::ptr_fun(&timeout_handler));
* timeout_source->attach(Glib::MainContext::get_default());
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalTimeout
* object's MainContext runs.
*
* @param slot A slot to call when @a interval has elapsed.
* If <tt>timeout_handler()</tt> returns <tt>false</tt> the handler is disconnected.
* @param interval The timeout in milliseconds.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*/
sigc::connection connect(
const sigc::slot<bool>& slot, unsigned int interval, int priority = PRIORITY_DEFAULT);
/** Connects a timeout handler that runs only once.
* This method takes a function pointer to a function with a void return
* and no parameters. After running once it is not called again.
*
* Because sigc::trackable is not thread-safe, if the slot represents a
* non-static method of a class deriving from sigc::trackable, and the slot is
* created by sigc::mem_fun(), connect_once() should only be called from
* the thread where the SignalTimeout object's MainContext runs. You can use,
* say, boost::bind() or, in C++11, std::bind() or a C++11 lambda expression
* instead of sigc::mem_fun().
*
* @see connect()
* @param slot A slot to call when @a interval has elapsed. For example:
* @code
* void on_timeout_once()
* @endcode
* @param interval The timeout in milliseconds.
* @param priority The priority of the new event source.
*/
void connect_once(
const sigc::slot<void>& slot, unsigned int interval, int priority = PRIORITY_DEFAULT);
/** Connects a timeout handler with whole second granularity.
*
* Unlike connect(), this operates at whole second granularity.
* The initial starting point of the timer is determined by the implementation
* and the implementation is expected to group multiple timers together so that
* they fire all at the same time.
*
* To allow this grouping, the @a interval to the first timer is rounded
* and can deviate up to one second from the specified interval.
* Subsequent timer iterations will generally run at the specified interval.
*
* @code
* bool timeout_handler() { ... }
* Glib::signal_timeout().connect_seconds(sigc::ptr_fun(&timeout_handler), 5);
* @endcode
* is equivalent to:
* @code
* bool timeout_handler() { ... }
* const auto timeout_source = Glib::TimeoutSource::create(5000);
* timeout_source->connect(sigc::ptr_fun(&timeout_handler));
* timeout_source->attach(Glib::MainContext::get_default());
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalTimeout
* object's MainContext runs.
*
* @param slot A slot to call when @a interval has elapsed.
* If <tt>timeout_handler()</tt> returns <tt>false</tt> the handler is disconnected.
* @param interval The timeout in seconds.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*
* @newin{2,14}
*/
sigc::connection connect_seconds(
const sigc::slot<bool>& slot, unsigned int interval, int priority = PRIORITY_DEFAULT);
/** Connects a timeout handler that runs only once with whole second
* granularity.
*
* This method takes a function pointer to a function with a void return
* and no parameters. After running once it is not called again.
*
* Because sigc::trackable is not thread-safe, if the slot represents a
* non-static method of a class deriving from sigc::trackable, and the slot is
* created by sigc::mem_fun(), connect_seconds_once() should only be called from
* the thread where the SignalTimeout object's MainContext runs. You can use,
* say, boost::bind() or, in C++11, std::bind() or a C++11 lambda expression
* instead of sigc::mem_fun().
*
* @see connect_seconds()
* @param slot A slot to call when @a interval has elapsed. For example:
* @code
* void on_timeout_once()
* @endcode
* @param interval The timeout in seconds.
* @param priority The priority of the new event source.
*/
void connect_seconds_once(
const sigc::slot<void>& slot, unsigned int interval, int priority = PRIORITY_DEFAULT);
private:
GMainContext* context_;
// no copy assignment
SignalTimeout& operator=(const SignalTimeout&);
};
class SignalIdle
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
explicit inline SignalIdle(GMainContext* context);
#endif
/** Connects an idle handler.
* @code
* bool idle_handler() { ... }
* Glib::signal_idle().connect(sigc::ptr_fun(&idle_handler));
* @endcode
* is equivalent to:
* @code
* bool idle_handler() { ... }
* const auto idle_source = Glib::IdleSource::create();
* idle_source->connect(sigc::ptr_fun(&idle_handler));
* idle_source->attach(Glib::MainContext::get_default());
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalIdle
* object's MainContext runs.
*
* @param slot A slot to call when the main loop is idle.
* If <tt>idle_handler()</tt> returns <tt>false</tt> the handler is disconnected.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*/
sigc::connection connect(const sigc::slot<bool>& slot, int priority = PRIORITY_DEFAULT_IDLE);
/** Connects an idle handler that runs only once.
* This method takes a function pointer to a function with a void return
* and no parameters. After running once it is not called again.
*
* Because sigc::trackable is not thread-safe, if the slot represents a
* non-static method of a class deriving from sigc::trackable, and the slot is
* created by sigc::mem_fun(), connect_once() should only be called from
* the thread where the SignalIdle object's MainContext runs. You can use,
* say, boost::bind() or, in C++11, std::bind() or a C++11 lambda expression
* instead of sigc::mem_fun().
*
* @see connect()
* @param slot A slot to call when the main loop is idle. For example:
* @code
* void on_idle_once()
* @endcode
* @param priority The priority of the new event source.
*/
void connect_once(const sigc::slot<void>& slot, int priority = PRIORITY_DEFAULT_IDLE);
private:
GMainContext* context_;
// no copy assignment
SignalIdle& operator=(const SignalIdle&);
};
class SignalIO
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
explicit inline SignalIO(GMainContext* context);
#endif
/** Connects an I/O handler that watches a file descriptor.
* @code
* bool io_handler(Glib::IOCondition io_condition) { ... }
* Glib::signal_io().connect(sigc::ptr_fun(&io_handler), fd, Glib::IO_IN | Glib::IO_HUP);
* @endcode
* is equivalent to:
* @code
* bool io_handler(Glib::IOCondition io_condition) { ... }
* const auto io_source = Glib::IOSource::create(fd, Glib::IO_IN | Glib::IO_HUP);
* io_source->connect(sigc::ptr_fun(&io_handler));
* io_source->attach(Glib::MainContext::get_default());
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalIO
* object's MainContext runs.
*
* @param slot A slot to call when polling @a fd results in an event that matches @a condition.
* The event will be passed as a parameter to @a slot.
* If <tt>io_handler()</tt> returns <tt>false</tt> the handler is disconnected.
* @param fd The file descriptor (or a @c HANDLE on Win32 systems) to watch.
* @param condition The conditions to watch for.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*/
sigc::connection connect(const sigc::slot<bool, IOCondition>& slot, PollFD::fd_t fd, IOCondition condition,
int priority = PRIORITY_DEFAULT);
/** Connects an I/O handler that watches an I/O channel.
* @code
* bool io_handler(Glib::IOCondition io_condition) { ... }
* Glib::signal_io().connect(sigc::ptr_fun(&io_handler), channel, Glib::IO_IN | Glib::IO_HUP);
* @endcode
* is equivalent to:
* @code
* bool io_handler(Glib::IOCondition io_condition) { ... }
* const auto io_source = Glib::IOSource::create(channel, Glib::IO_IN | Glib::IO_HUP);
* io_source->connect(sigc::ptr_fun(&io_handler));
* io_source->attach(Glib::MainContext::get_default());
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalIO
* object's MainContext runs.
*
* @param slot A slot to call when polling @a channel results in an event that matches @a
* condition.
* The event will be passed as a parameter to @a slot.
* If <tt>io_handler()</tt> returns <tt>false</tt> the handler is disconnected.
* @param channel The IOChannel object to watch.
* @param condition The conditions to watch for.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*/
sigc::connection connect(const sigc::slot<bool, IOCondition>& slot,
const Glib::RefPtr<IOChannel>& channel, IOCondition condition, int priority = PRIORITY_DEFAULT);
private:
GMainContext* context_;
// no copy assignment
SignalIO& operator=(const SignalIO&);
};
class SignalChildWatch
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
explicit inline SignalChildWatch(GMainContext* context);
#endif
/** Connects a child watch handler.
* @code
* void child_watch_handler(GPid pid, int child_status) { ... }
* Glib::signal_child_watch().connect(sigc::ptr_fun(&child_watch_handler), pid);
* @endcode
*
* This method is not thread-safe. You should call it, or manipulate the
* returned sigc::connection object, only from the thread where the SignalChildWatch
* object's MainContext runs.
*
* @param slot A slot to call when child process @a pid exited.
* @param pid The child process to watch for.
* @param priority The priority of the new event source.
* @return A connection handle, which can be used to disconnect the handler.
*/
sigc::connection connect(
const sigc::slot<void, GPid, int>& slot, GPid pid, int priority = PRIORITY_DEFAULT);
private:
GMainContext* context_;
// no copy assignment
SignalChildWatch& operator=(const SignalChildWatch&);
};
/** Convenience timeout signal.
* @return A signal proxy; you want to use SignalTimeout::connect().
*/
SignalTimeout signal_timeout();
/** Convenience idle signal.
* @return A signal proxy; you want to use SignalIdle::connect().
*/
SignalIdle signal_idle();
/** Convenience I/O signal.
* @return A signal proxy; you want to use SignalIO::connect().
*/
SignalIO signal_io();
/** Convenience child watch signal.
* @return A signal proxy; you want to use SignalChildWatch::connect().
*/
SignalChildWatch signal_child_watch();
/** Main context.
*/
class MainContext
{
public:
using CppObjectType = Glib::MainContext;
using BaseObjectType = GMainContext;
// noncopyable
MainContext(const MainContext& other) = delete;
MainContext& operator=(const MainContext& other) = delete;
/** Creates a new MainContext.
* @return The new MainContext.
*/
static Glib::RefPtr<MainContext> create();
/** Returns the default main context.
* This is the main context used for main loop functions when a main loop is not explicitly
* specified.
* @return The new MainContext.
*/
static Glib::RefPtr<MainContext> get_default();
/** Runs a single iteration for the given main loop.
* This involves checking to see if any event sources are ready to be processed, then if no events
* sources are
* ready and may_block is true, waiting for a source to become ready, then dispatching the highest
* priority events
* sources that are ready. Note that even when may_block is true, it is still possible for
* iteration() to return
* false, since the the wait may be interrupted for other reasons than an event source becoming
* ready.
* @param may_block Whether the call may block.
* @return true if events were dispatched.
*/
bool iteration(bool may_block);
/** Checks if any sources have pending events for the given context.
* @return true if events are pending.
*/
bool pending();
/** If context is currently waiting in a poll(), interrupt the poll(), and continue the iteration
* process.
*/
void wakeup();
/** Tries to become the owner of the specified context.
* If some other thread is the owner of the context, returns <tt>false</tt> immediately. Ownership
* is properly recursive:
* the owner can require ownership again and will release ownership when release() is called as
* many times as
* acquire().
* You must be the owner of a context before you can call prepare(), query(), check(), dispatch().
* @return true if the operation succeeded, and this thread is now the owner of context.
*/
bool acquire();
#ifndef GLIBMM_DISABLE_DEPRECATED
/** Tries to become the owner of the specified context, as with acquire(). But if another thread
* is the owner,
* atomically drop mutex and wait on cond until that owner releases ownership or until cond is
* signaled, then try
* again (once) to become the owner.
* @param cond A condition variable.
* @param mutex A mutex, currently held.
* @return true if the operation succeeded, and this thread is now the owner of context.
*
* @deprecated Use wait(Glib::Threads::Cond& cond, Glib::Threads::Mutex& mutex) instead.
*/
bool wait(Glib::Cond& cond, Glib::Mutex& mutex);
// Deprecated mostly because it uses deprecated Glib::Threads:: for parameters.
/** Tries to become the owner of the specified context, as with acquire(). But if another thread
* is the owner,
* atomically drop mutex and wait on cond until that owner releases ownership or until cond is
* signaled, then try
* again (once) to become the owner.
* @param cond A condition variable.
* @param mutex A mutex, currently held.
* @return true if the operation succeeded, and this thread is now the owner of context.
*
* @deprecated Please use the underlying g_main_context_wait() function if you really need this
* functionality.
*/
bool wait(Glib::Threads::Cond& cond, Glib::Threads::Mutex& mutex);
#endif // GLIBMM_DISABLE_DEPRECATED
/** Releases ownership of a context previously acquired by this thread with acquire(). If the
* context was acquired
* multiple times, the only release ownership when release() is called as many times as it was
* acquired.
*/
void release();
/** Prepares to poll sources within a main loop. The resulting information for polling is
* determined by calling query().
* @param priority Location to store priority of highest priority source already ready.
* @return true if some source is ready to be dispatched prior to polling.
*/
bool prepare(int& priority);
/** Prepares to poll sources within a main loop. The resulting information for polling is
* determined by calling query().
* @return true if some source is ready to be dispatched prior to polling.
*/
bool prepare();
/** Determines information necessary to poll this main loop.
* @param max_priority Maximum priority source to check.
* @param timeout Location to store timeout to be used in polling.
* @param fds Location to store Glib::PollFD records that need to be polled.
* @return the number of records actually stored in fds, or, if more than n_fds records need to be
* stored, the number of records that need to be stored.
*/
void query(int max_priority, int& timeout, std::vector<PollFD>& fds);
/** Passes the results of polling back to the main loop.
* @param max_priority Maximum numerical priority of sources to check.
* @param fds Vector of Glib::PollFD's that was passed to the last call to query()
* @return true if some sources are ready to be dispatched.
*/
bool check(int max_priority, std::vector<PollFD>& fds);
/** Dispatches all pending sources.
*/
void dispatch();
// TODO: Use slot instead?
/** Sets the function to use to handle polling of file descriptors. It will be used instead of the
* poll() system call (or GLib's replacement function, which is used where poll() isn't
* available).
* This function could possibly be used to integrate the GLib event loop with an external event
* loop.
* @param poll_func The function to call to poll all file descriptors.
*/
void set_poll_func(GPollFunc poll_func);
/** Gets the poll function set by g_main_context_set_poll_func().
* @return The poll function
*/
GPollFunc get_poll_func();
/** Adds a file descriptor to the set of file descriptors polled for this context. This will very
* seldomly be used directly. Instead a typical event source will use Glib::Source::add_poll()
* instead.
* @param fd A PollFD structure holding information about a file descriptor to watch.
* @param priority The priority for this file descriptor which should be the same as the priority
* used for Glib::Source::attach() to ensure that the file descriptor is polled whenever the
* results may be needed.
*/
void add_poll(PollFD& fd, int priority);
/** Removes file descriptor from the set of file descriptors to be polled for a particular
* context.
* @param fd A PollFD structure holding information about a file descriptor.
*/
void remove_poll(PollFD& fd);
/** Invokes a function in such a way that this MainContext is owned during
* the invocation of @a slot.
*
* If the context is owned by the current thread, @a slot is called
* directly. Otherwise, if the context is the thread-default main context
* of the current thread and acquire() succeeds, then
* @a slot is called and release() is called afterwards.
*
* In any other case, an idle source is created to call @a slot and
* that source is attached to the context (presumably to be run in another
* thread).
*
* Note that, as with normal idle functions, @a slot should probably
* return <tt>false</tt>. If it returns <tt>true</tt>, it will be continuously
* run in a loop (and may prevent this call from returning).
*
* If an idle source is created to call @a slot, invoke() may return before
* @a slot is called.
*
* Because sigc::trackable is not thread-safe, if the slot represents a
* non-static method of a class deriving from sigc::trackable, and the slot is
* created by sigc::mem_fun(), invoke() should only be called from
* the thread where the context runs. You can use, say, boost::bind() or,
* in C++11, std::bind() or a C++11 lambda expression instead of sigc::mem_fun().
*
* @param slot A slot to call.
* @param priority The priority of the idle source, if one is created.
*
* @newin{2,38}
*/
void invoke(const sigc::slot<bool>& slot, int priority = PRIORITY_DEFAULT);
/** Timeout signal, attached to this MainContext.
* @return A signal proxy; you want to use SignalTimeout::connect().
*/
SignalTimeout signal_timeout();
/** Idle signal, attached to this MainContext.
* @return A signal proxy; you want to use SignalIdle::connect().
*/
SignalIdle signal_idle();
/** I/O signal, attached to this MainContext.
* @return A signal proxy; you want to use SignalIO::connect().
*/
SignalIO signal_io();
/** child watch signal, attached to this MainContext.
* @return A signal proxy; you want to use SignalChildWatch::connect().
*/
SignalChildWatch signal_child_watch();
void reference() const;
void unreference() const;
GMainContext* gobj();
const GMainContext* gobj() const;
GMainContext* gobj_copy() const;
private:
// Glib::MainContext can neither be constructed nor deleted.
MainContext();
void operator delete(void*, std::size_t);
};
/** @relates Glib::MainContext */
Glib::RefPtr<MainContext> wrap(GMainContext* gobject, bool take_copy = false);
class MainLoop
{
public:
using CppObjectType = Glib::MainLoop;
using BaseObjectType = GMainLoop;
static Glib::RefPtr<MainLoop> create(bool is_running = false);
static Glib::RefPtr<MainLoop> create(
const Glib::RefPtr<MainContext>& context, bool is_running = false);
/** Runs a main loop until quit() is called on the loop.
* If this is called for the thread of the loop's MainContext, it will process events from the
* loop, otherwise it will simply wait.
*/
void run();
/** Stops a MainLoop from running. Any calls to run() for the loop will return.
*/
void quit();
/** Checks to see if the main loop is currently being run via run().
* @return true if the mainloop is currently being run.
*/
bool is_running();
/** Returns the MainContext of loop.
* @return The MainContext of loop.
*/
Glib::RefPtr<MainContext> get_context();
// TODO: C++ize the (big) g_main_depth docs here.
static int depth();
/** Increases the reference count on a MainLoop object by one.
*/
void reference() const;
/** Decreases the reference count on a MainLoop object by one.
* If the result is zero, free the loop and free all associated memory.
*/
void unreference() const;
GMainLoop* gobj();
const GMainLoop* gobj() const;
GMainLoop* gobj_copy() const;
private:
// Glib::MainLoop can neither be constructed nor deleted.
MainLoop();
void operator delete(void*, std::size_t);
MainLoop(const MainLoop&);
MainLoop& operator=(const MainLoop&);
};
/** @relates Glib::MainLoop */
Glib::RefPtr<MainLoop> wrap(GMainLoop* gobject, bool take_copy = false);
class Source
{
public:
using CppObjectType = Glib::Source;
using BaseObjectType = GSource;
// noncopyable
Source(const Source&) = delete;
Source& operator=(const Source&) = delete;
static Glib::RefPtr<Source> create() /* = 0 */;
/** Adds a Source to a context so that it will be executed within that context.
* @param context A MainContext.
* @return The ID for the source within the MainContext.
*/
unsigned int attach(const Glib::RefPtr<MainContext>& context);
/** Adds a Source to a context so that it will be executed within that context.
* The default context will be used.
* @return The ID for the source within the MainContext.
*/
unsigned int attach();
// TODO: Does this destroy step make sense in C++? Should it just be something that happens in a
// destructor?
/** Removes a source from its MainContext, if any, and marks it as destroyed.
* The source cannot be subsequently added to another context.
*/
void destroy();
/** Sets the priority of a source. While the main loop is being run, a source will be dispatched
* if it is ready to be dispatched and no sources at a higher (numerically smaller) priority are
* ready to be dispatched.
* @param priority The new priority.
*/
void set_priority(int priority);
/** Gets the priority of a source.
* @return The priority of the source.
*/
int get_priority() const;
/** Sets whether a source can be called recursively.
* If @a can_recurse is true, then while the source is being dispatched then this source will be
* processed normally. Otherwise, all processing of this source is blocked until the dispatch
* function returns.
* @param can_recurse Whether recursion is allowed for this source.
*/
void set_can_recurse(bool can_recurse);
/** Checks whether a source is allowed to be called recursively. see set_can_recurse().
* @return Whether recursion is allowed.
*/
bool get_can_recurse() const;
/** Returns the numeric ID for a particular source.
* The ID of a source is unique within a particular main loop context. The reverse mapping from ID
* to source is done by MainContext::find_source_by_id().
* @return The ID for the source.
*/
unsigned int get_id() const;
// TODO: Add a const version of this method?
/** Gets the MainContext with which the source is associated.
* Calling this function on a destroyed source is an error.
* @return The MainContext with which the source is associated, or a null RefPtr if the context
* has not yet been added to a source.
*/
Glib::RefPtr<MainContext> get_context();
GSource* gobj() { return gobject_; }
const GSource* gobj() const { return gobject_; }
GSource* gobj_copy() const;
void reference() const;
void unreference() const;
protected:
/** Construct an object that uses the virtual functions prepare(), check() and dispatch().
*/
Source();
/** Wrap an existing GSource object and install the given callback function.
* The constructed object doesn't use the virtual functions prepare(), check() and dispatch().
* This constructor is for use by derived types that need to wrap a GSource object.
* The callback function can be a static member function. But beware -
* depending on the actual implementation of the GSource's virtual functions
* the expected type of the callback function can differ from GSourceFunc.
*/
Source(GSource* cast_item, GSourceFunc callback_func);
virtual ~Source() noexcept;
sigc::connection connect_generic(const sigc::slot_base& slot);
/** Adds a file descriptor to the set of file descriptors polled for this source.
* The event source's check function will typically test the revents field in the PollFD and
* return true if events need to be processed.
* @param poll_fd A PollFD object holding information about a file descriptor to watch.
*/
void add_poll(PollFD& poll_fd);
/** Removes a file descriptor from the set of file descriptors polled for this source.
* @param poll_fd A PollFD object previously passed to add_poll().
*/
void remove_poll(PollFD& poll_fd);
#ifndef GLIBMM_DISABLE_DEPRECATED
/** Gets the "current time" to be used when checking this source.
*
* @param[out] current_time Glib::TimeVal in which to store current time.
*
* @deprecated Use get_time() instead.
*/
void get_current_time(Glib::TimeVal& current_time);
#endif // GLIBMM_DISABLE_DEPRECATED
// TODO: Remove mention of g_get_monotonic time when we wrap it in C++.
/** Gets the time to be used when checking this source. The advantage of
* calling this function over calling g_get_monotonic_time() directly is
* that when checking multiple sources, GLib can cache a single value
* instead of having to repeatedly get the system monotonic time.
*
* The time here is the system monotonic time, if available, or some
* other reasonable alternative otherwise. See g_get_monotonic_time().
*
* @result The monotonic time in microseconds.
*
* @newin{2,28}
*/
gint64 get_time() const;
virtual bool prepare(int& timeout) = 0;
virtual bool check() = 0;
virtual bool dispatch(sigc::slot_base* slot) = 0;
private:
GSource* gobject_;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static inline Source* get_wrapper(GSource* source);
static const GSourceFuncs vfunc_table_;
static gboolean prepare_vfunc(GSource* source, int* timeout);
static gboolean check_vfunc(GSource* source);
static gboolean dispatch_vfunc(GSource* source, GSourceFunc callback, void* user_data);
public:
static void destroy_notify_callback(void* data);
// Used by SignalXyz, possibly in other files.
static sigc::connection attach_signal_source(const sigc::slot_base& slot, int priority,
GSource* source, GMainContext* context, GSourceFunc callback_func);
// Used by SignalXyz in other files.
static sigc::slot_base* get_slot_from_connection_node(void* data);
// Used by derived Source classes in other files.
static sigc::slot_base* get_slot_from_callback_data(void* data);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};
class TimeoutSource : public Glib::Source
{
public:
using CppObjectType = Glib::TimeoutSource;
static Glib::RefPtr<TimeoutSource> create(unsigned int interval);
sigc::connection connect(const sigc::slot<bool>& slot);
protected:
explicit TimeoutSource(unsigned int interval);
~TimeoutSource() noexcept override;
bool prepare(int& timeout) override;
bool check() override;
bool dispatch(sigc::slot_base* slot) override;
private:
// TODO: Replace with gint64, because TimeVal is deprecated, when we can break ABI.
Glib::TimeVal expiration_;
unsigned int interval_;
};
class IdleSource : public Glib::Source
{
public:
using CppObjectType = Glib::IdleSource;
static Glib::RefPtr<IdleSource> create();
sigc::connection connect(const sigc::slot<bool>& slot);
protected:
IdleSource();
~IdleSource() noexcept override;
bool prepare(int& timeout) override;
bool check() override;
bool dispatch(sigc::slot_base* slot_data) override;
};
class IOSource : public Glib::Source
{
public:
using CppObjectType = Glib::IOSource;
static Glib::RefPtr<IOSource> create(PollFD::fd_t fd, IOCondition condition);
static Glib::RefPtr<IOSource> create(
const Glib::RefPtr<IOChannel>& channel, IOCondition condition);
sigc::connection connect(const sigc::slot<bool, IOCondition>& slot);
protected:
IOSource(PollFD::fd_t fd, IOCondition condition);
IOSource(const Glib::RefPtr<IOChannel>& channel, IOCondition condition);
/** Wrap an existing GSource object and install the given callback function.
* This constructor is for use by derived types that need to wrap a GSource object.
* @see Source::Source(GSource*, GSourceFunc).
* @newin{2,42}
*/
IOSource(GSource* cast_item, GSourceFunc callback_func);
~IOSource() noexcept override;
bool prepare(int& timeout) override;
bool check() override;
bool dispatch(sigc::slot_base* slot) override;
private:
PollFD poll_fd_;
};
/** @} group MainLoop */
} // namespace Glib
#endif /* _GLIBMM_MAIN_H */
|