jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Forward.h>
30#include <AK/Noncopyable.h>
31#include <AK/NonnullOwnPtr.h>
32#include <AK/Vector.h>
33#include <AK/WeakPtr.h>
34#include <LibCore/Forward.h>
35#include <sys/time.h>
36
37namespace Core {
38
39class EventLoop {
40public:
41 EventLoop();
42 ~EventLoop();
43
44 int exec();
45
46 enum class WaitMode {
47 WaitForEvents,
48 PollForEvents,
49 };
50
51 // processe events, generally called by exec() in a loop.
52 // this should really only be used for integrating with other event loops
53 void pump(WaitMode = WaitMode::WaitForEvents);
54
55 void post_event(Object& receiver, NonnullOwnPtr<Event>&&);
56
57 static EventLoop& main();
58 static EventLoop& current();
59
60 bool was_exit_requested() const { return m_exit_requested; }
61
62 static int register_timer(Object&, int milliseconds, bool should_reload, TimerShouldFireWhenNotVisible);
63 static bool unregister_timer(int timer_id);
64
65 static void register_notifier(Badge<Notifier>, Notifier&);
66 static void unregister_notifier(Badge<Notifier>, Notifier&);
67
68 void quit(int);
69 void unquit();
70
71 void take_pending_events_from(EventLoop& other)
72 {
73 m_queued_events.append(move(other.m_queued_events));
74 }
75
76 static void wake();
77
78private:
79 void wait_for_event(WaitMode);
80 void get_next_timer_expiration(timeval&);
81
82 struct QueuedEvent {
83 AK_MAKE_NONCOPYABLE(QueuedEvent);
84
85 public:
86 QueuedEvent(Object& receiver, NonnullOwnPtr<Event>);
87 QueuedEvent(QueuedEvent&&);
88 ~QueuedEvent();
89
90 WeakPtr<Object> receiver;
91 NonnullOwnPtr<Event> event;
92 };
93
94 Vector<QueuedEvent, 64> m_queued_events;
95
96 bool m_exit_requested { false };
97 int m_exit_code { 0 };
98
99 static int s_wake_pipe_fds[2];
100
101 struct Private;
102 NonnullOwnPtr<Private> m_private;
103};
104
105}