clanapp.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28
29 #pragma once
30
31 #include <vector>
32 #include <string>
33 #include <memory>
34
35 namespace clan
36 {
39
43 class Application
44 {
45 public:
46 virtual ~Application() { }
47
52 virtual bool update() = 0;
53
55 static void use_timeout_timing(int timeout_ms);
56
58 static const std::vector<std::string> &main_args();
59 };
60
61 class ApplicationInstancePrivate
62 {
63 public:
64 ApplicationInstancePrivate(bool catch_exceptions = true);
65 virtual std::unique_ptr<Application> create() = 0;
66 };
67
83 template<typename ApplicationClass>
84 class ApplicationInstance : ApplicationInstancePrivate
85 {
88 public:
90 ApplicationInstance(bool catch_exceptions = true) : ApplicationInstancePrivate(catch_exceptions)
91 {
92 }
93
97 private:
98 std::unique_ptr<Application> create() override
99 {
100 return std::unique_ptr<Application>(new ApplicationClass());
101 }
103 };
104
106 }
clan::Application::~Application
virtual ~Application()
Definition: clanapp.h:46
clan
Definition: clanapp.h:35
clan::Application::update
virtual bool update()=0
Main loop update handler.
clan::ApplicationInstance
Helper class to create cross platform applications.
Definition: clanapp.h:84
clan::Application::main_args
static const std::vector< std::string > & main_args()
Returns the command line arguments passed to the application.
clan::Application
Base class for the application object.
Definition: clanapp.h:43
clan::ApplicationInstance::ApplicationInstance
ApplicationInstance(bool catch_exceptions=true)
Clan Application constructor.
Definition: clanapp.h:90
clan::ApplicationInstancePrivate::ApplicationInstancePrivate
ApplicationInstancePrivate(bool catch_exceptions=true)
clan::Application::use_timeout_timing
static void use_timeout_timing(int timeout_ms)
Set update handler to wait a certain amount of milliseconds between each update.
clan::ApplicationInstancePrivate
Definition: clanapp.h:61
clan::ApplicationInstancePrivate::create
virtual std::unique_ptr< Application > create()=0