Mir
set_command_line_handler.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016 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_SET_COMMAND_LINE_HANDLER_H
18 #define MIRAL_SET_COMMAND_LINE_HANDLER_H
19 
20 #include <functional>
21 
22 namespace mir { class Server; }
23 
24 namespace miral
25 {
26 /// Set a handler for any command line options Mir/MirAL does not recognise.
27 /// This will be invoked if any unrecognised options are found during initialisation.
28 /// Any unrecognised arguments are passed to this function. The pointers remain valid
29 /// for the duration of the call only.
30 /// If set_command_line_handler is not called the default action is to exit by
31 /// throwing mir::AbnormalExit (which will be handled by the exception handler prior to
32 /// exiting run().
34 {
35 public:
36  using Handler = std::function<void(int argc, char const* const* argv)>;
37 
38  explicit SetCommandLineHandler(Handler const& handler);
40 
41  void operator()(mir::Server& server) const;
42 
43 private:
44  Handler handler;
45 };
46 }
47 
48 #endif //MIRAL_SET_COMMAND_LINE_HANDLER_H

Copyright © 2012-2022 Canonical Ltd.
Generated on Thu Sep 8 12:37:23 UTC 2022
This documentation is licensed under the GPL version 2 or 3.