Mir
Loading...
Searching...
No Matches
runner.h
Go to the documentation of this file.
1/*
2 * Copyright © Canonical Ltd.
3 *
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 or 3 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#ifndef MIRAL_RUNNER_H
18#define MIRAL_RUNNER_H
19
20#include "mir/optional_value.h"
21#include "mir/fd.h"
22
23#include <functional>
24#include <initializer_list>
25#include <memory>
26
27namespace mir { class Server; }
28
34namespace miral
35{
37struct FdHandle { public: virtual ~FdHandle(); };
38
41{
42public:
43 MirRunner(int argc, char const* argv[]);
44 MirRunner(int argc, char const* argv[], char const* config_file);
46
49 void add_start_callback(std::function<void()> const& start_callback);
50
53 void add_stop_callback(std::function<void()> const& stop_callback);
54
58 std::initializer_list<int> signals,
59 std::function<void(int)> const& handler);
60
65 mir::Fd fd,
66 std::function<void(int)> const& handler)
67 -> std::unique_ptr<miral::FdHandle>;
68
73 void set_exception_handler(std::function<void()> const& handler);
74
78 auto run_with(std::initializer_list<std::function<void(::mir::Server&)>> options) -> int;
79
81 void stop();
82
88 auto config_file() const -> std::string;
89
95 auto display_config_file() const -> std::string;
96
99 auto wayland_display() const -> mir::optional_value<std::string>;
100
103 auto x11_display() const -> mir::optional_value<std::string>;
104
105private:
106 MirRunner(MirRunner const&) = delete;
107 MirRunner& operator=(MirRunner const&) = delete;
108 struct Self;
109 std::unique_ptr<Self> const self;
110};
111}
112
113#endif //MIRAL_RUNNER_H
Definition fd.h:32
Runner for applying initialization options to Mir.
Definition runner.h:41
MirRunner(int argc, char const *argv[])
void add_stop_callback(std::function< void()> const &stop_callback)
Add a callback to be invoked when the server is about to stop, If multiple callbacks are added they w...
auto run_with(std::initializer_list< std::function< void(::mir::Server &)> > options) -> int
Apply the supplied initialization options and run the Mir server.
auto register_fd_handler(mir::Fd fd, std::function< void(int)> const &handler) -> std::unique_ptr< miral::FdHandle >
Add a watch on a file descriptor. The handler will be triggered when there is data to read on the Fd.
void add_start_callback(std::function< void()> const &start_callback)
Add a callback to be invoked when the server has started, If multiple callbacks are added they will b...
auto config_file() const -> std::string
Name of the .config file. The .config file is located via the XDG Base Directory Specification: $XDG_...
auto x11_display() const -> mir::optional_value< std::string >
Get the X11 socket name (if any) usable as a $DISPLAY value.
MirRunner(int argc, char const *argv[], char const *config_file)
void stop()
Tell the Mir server to exit.
void set_exception_handler(std::function< void()> const &handler)
Set a handler for exceptions caught in run_with(). run_with() invokes handler() in catch (....
void register_signal_handler(std::initializer_list< int > signals, std::function< void(int)> const &handler)
Add signal handler to the server's main loop.
auto wayland_display() const -> mir::optional_value< std::string >
Get the Wayland endpoint name (if any) usable as a $WAYLAND_DISPLAY value.
auto display_config_file() const -> std::string
Name of the .display configuration file. The .display file is located via the XDG Base Directory Spec...
Definition splash_session.h:22
Mir Abstraction Layer.
Definition floating_window_manager.h:29
STL namespace.
A handle which keeps a file descriptor registered to the main loop until it is dropped.
Definition runner.h:37
virtual ~FdHandle()

Copyright © 2012-2024 Canonical Ltd.
Generated on Sat Aug 17 07:04:01 UTC 2024
This documentation is licensed under the GPL version 2 or 3.