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
|
/***********************************************************************
filename: CEGuiBaseApplication.h
created: 24/9/2004
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGuiBaseApplication_h_
#define _CEGuiBaseApplication_h_
// If this looks wanky, it's becase it is! Behold that this is not as fullblown
// as it could be though.
#ifndef PATH_MAX
# include <stdlib.h>
# ifndef PATH_MAX
# include <limits.h>
# endif
# ifndef PATH_MAX
# ifdef _MAX_PATH
# define PATH_MAX _MAX_PATH
# else
# define PATH_MAX 260
# endif
# endif
#endif
/*************************************************************************
Forward refs
*************************************************************************/
class CEGuiSample;
/*!
\brief
Base application abstract base class.
The "BaseApplication" family of classes are used to start up and execute a host application for
CeGui samples in a consistent manner.
*/
class CEGuiBaseApplication
{
public:
/*!
\brief
Constructor.
*/
CEGuiBaseApplication() :
d_quitting(false)
{ }
/*!
\brief
Destructor
*/
virtual ~CEGuiBaseApplication()
{ }
/*!
\brief
Start the base application
This will fully initialise the application, finish initialisation of the demo via calls to 'sampleApp', and finally
control execution of the sample.
\param sampleApp
Pointer to the CEGuiSample object that the CEGuiBaseApplication is being invoked for.
\return
- true if the application initialised and ran okay (cleanup call is required).
- false if the application failed to initialise (no cleanup call is required).
*/
virtual bool execute(CEGuiSample* sampleApp) = 0;
/*!
\brief
Performs any required cleanup of the base application system.
*/
virtual void cleanup() = 0;
/*!
\brief
Set whether the BaseApplication should clean up and exit.
\param quit
- true if the application should clean up and exit.
\return
Nothing.
*/
virtual void setQuitting(bool quit = true) { d_quitting = quit; }
/*!
\brief
Return whether the app is currently set to quit.
\return
- true if the application will terminate at its earliest opportunity.
- false if the application will keep running.
*/
virtual bool isQuitting() const { return d_quitting; }
protected:
/*!
\brief
Setup standard sample resource group directory locations. Default uses
the CEGUI::DefaultResourceProvider - override if the sample base app
being implemented uses something else!
*/
virtual void initialiseResourceGroupDirectories();
//! initialise the standard default resource groups used by the samples.
virtual void initialiseDefaultResourceGroups();
/*!
\brief
Return the path prefix to use for datafiles. The value returned
is obtained via a environment variable named 'CEGUI_SAMPLE_DATAPATH'
if the variable is not set, a default will be used depending on the
build system in use.
*/
const char* getDataPathPrefix() const;
//! name of env var that holds the path prefix to the data files.
static const char DATAPATH_VAR_NAME[];
bool d_quitting; //!< true when the base app should cleanup and exit.
};
#endif // end of guard _CEGuiBaseApplication_h_
|
