Colobot
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
system.h
Go to the documentation of this file.
1 // * This file is part of the COLOBOT source code
2 // * Copyright (C) 2001-2008, Daniel ROUX & EPSITEC SA, www.epsitec.ch
3 // * Copyright (C) 2012, Polish Portal of Colobot (PPC)
4 // *
5 // * This program is free software: you can redistribute it and/or modify
6 // * it under the terms of the GNU General Public License as published by
7 // * the Free Software Foundation, either version 3 of the License, or
8 // * (at your option) any later version.
9 // *
10 // * This program is distributed in the hope that it will be useful,
11 // * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // * GNU General Public License for more details.
14 // *
15 // * You should have received a copy of the GNU General Public License
16 // * along with this program. If not, see http://www.gnu.org/licenses/.
17 
23 #pragma once
24 
25 #include "common/singleton.h"
26 
27 #include <string>
28 
34 {
45 };
46 
54 {
55  SDR_OK,
56  SDR_CANCEL,
57  SDR_YES,
58  SDR_NO
59 };
60 
66 {
73 };
74 
75 /*
76  * Forward declaration of time stamp struct
77  * SystemTimeStamp should only be used in a pointer context.
78  * The implementation details are hidden because of platform dependence.
79  */
80 struct SystemTimeStamp;
81 
89 class CSystemUtils : public CSingleton<CSystemUtils>
90 {
91 protected:
92  CSystemUtils();
93 
94 public:
96  static CSystemUtils* Create();
97 
99  virtual void Init() = 0;
100 
102  virtual SystemDialogResult SystemDialog(SystemDialogType, const std::string &title, const std::string &message) = 0;
103 
105  TEST_VIRTUAL SystemDialogResult ConsoleSystemDialog(SystemDialogType type, const std::string& title, const std::string& message);
106 
108  TEST_VIRTUAL SystemTimeStamp* CreateTimeStamp();
109 
111  TEST_VIRTUAL void DestroyTimeStamp(SystemTimeStamp *stamp);
112 
114  TEST_VIRTUAL void CopyTimeStamp(SystemTimeStamp *dst, SystemTimeStamp *src);
115 
117  virtual void GetCurrentTimeStamp(SystemTimeStamp *stamp) = 0;
118 
120  TEST_VIRTUAL float GetTimeStampResolution(SystemTimeUnit unit = STU_SEC);
121 
123  virtual long long GetTimeStampExactResolution() = 0;
124 
126 
127  TEST_VIRTUAL float TimeStampDiff(SystemTimeStamp *before, SystemTimeStamp *after, SystemTimeUnit unit = STU_SEC);
128 
130 
131  virtual long long TimeStampExactDiff(SystemTimeStamp *before, SystemTimeStamp *after) = 0;
132 
134  virtual std::string GetDataPath();
135 
137  virtual std::string GetLangPath();
138 
140  virtual std::string GetProfileFileLocation();
141 
143  virtual std::string GetSavegameDirectoryLocation();
144 };
145 
148 {
149  return CSystemUtils::GetInstancePointer();
150 }
151 
milliseconds
Definition: system.h:70
CSingleton base class for singletons.
TEST_VIRTUAL void DestroyTimeStamp(SystemTimeStamp *stamp)
Destroys a time stamp object.
Definition: system.cpp:152
virtual void GetCurrentTimeStamp(SystemTimeStamp *stamp)=0
Returns a time stamp associated with current time.
virtual void Init()=0
Performs platform-specific initialization.
microseconds
Definition: system.h:72
virtual std::string GetSavegameDirectoryLocation()
Returns the savegame directory location.
Definition: system.cpp:210
SystemDialogType
Type of system dialog.
Definition: system.h:33
Warning message.
Definition: system.h:38
virtual long long TimeStampExactDiff(SystemTimeStamp *before, SystemTimeStamp *after)=0
Returns the exact (in nanosecond units) difference between two timestamps.
Definition: singleton.h:27
Yes/No question.
Definition: system.h:42
TEST_VIRTUAL SystemDialogResult ConsoleSystemDialog(SystemDialogType type, const std::string &title, const std::string &message)
Displays a fallback system dialog using console.
Definition: system.cpp:61
Error message.
Definition: system.h:40
static CSystemUtils * Create()
Creates system utils for specific platform.
Definition: system.cpp:46
virtual long long GetTimeStampExactResolution()=0
Returns the platform&#39;s exact (in nanosecond units) expected time stamp resolution.
TEST_VIRTUAL float GetTimeStampResolution(SystemTimeUnit unit=STU_SEC)
Returns the platform&#39;s expected time stamp resolution.
Definition: system.cpp:162
Information message.
Definition: system.h:36
virtual std::string GetLangPath()
Returns the translations path.
Definition: system.cpp:200
TEST_VIRTUAL float TimeStampDiff(SystemTimeStamp *before, SystemTimeStamp *after, SystemTimeUnit unit=STU_SEC)
Returns a difference between two timestamps in given time unit.
Definition: system.cpp:178
seconds
Definition: system.h:68
SystemTimeUnit
Time unit.
Definition: system.h:65
SystemDialogResult
Result of system dialog.
Definition: system.h:53
virtual SystemDialogResult SystemDialog(SystemDialogType, const std::string &title, const std::string &message)=0
Displays a system dialog.
virtual std::string GetProfileFileLocation()
Returns the profile (colobot.ini) file location.
Definition: system.cpp:205
Ok/Cancel question.
Definition: system.h:44
Platform-specific utils.
Definition: system.h:89
Definition: system_linux.h:28
TEST_VIRTUAL void CopyTimeStamp(SystemTimeStamp *dst, SystemTimeStamp *src)
Copies the time stamp from src to dst.
Definition: system.cpp:157
virtual std::string GetDataPath()
Returns the data path (containing textures, levels, helpfiles, etc)
Definition: system.cpp:195
CSystemUtils * GetSystemUtils()
Global function to get CSystemUtils instance.
Definition: system.h:147
TEST_VIRTUAL SystemTimeStamp * CreateTimeStamp()
Creates a new time stamp object.
Definition: system.cpp:147