Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/buildsystem3/src/core/Core.h @ 2702

Last change on this file since 2702 was 2702, checked in by rgrieder, 15 years ago

Completed work on installation:

  • The CMake switch INSTALL_COPYABLE tells whether you will be able to move the installed directory or not. If TRUE then all folders, including log and config directory, will be put into the CMAKE_INSTALL_PREFIX. Furthermore, relative paths are used, which get resolved at run time.
  • If INSTALL_COPYABLE is set to FALSE, the standard operating system directories will be used. That also means on Windows files get written to the Application Data/.orxonox folder instead of Program Files/Orxonox
  • Default configuration is INSTALL_COPYABLE=TRUE for Windows and FALSE for Unix
  • Split OrxonoxConfig.h.in in two to avoid complete recompiles when changing only a path or INSTALL_COPYABLE
  • Added a global constant character: CP_SLASH which stands for cross platform slash, meaning '/' on Unix and '
    ' on Windows
  • Core class now has methods getFooPath(), getFooPathString() and getFooPathPOSIXString() where Foo can be Media, Log or Config
  • getFooPathPOSIXString() will always return a directory formatted with slashes, even on Windows
  • getFooPath() returns a reference to the boost::filesystem::path
  • boost/filesystem.hpp does not get included to Core.h because it has a very large rat tail
  • The platform specific directory stuff gets done in Core::postMainInitialisation()
  • Adjusted all classes using the media path
  • Property svn:eol-style set to native
File size: 5.5 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      Reto Grieder
26 *
27 */
28
29/**
30    @file
31    @brief Declaration of the Core class.
32
33    The Core class is a singleton, only used to configure some variables
34    in the core through the config-file.
35*/
36
37#ifndef _Core_H__
38#define _Core_H__
39
40#include "CorePrereqs.h"
41
42#include <cassert>
43#include "OrxonoxClass.h"
44#include "util/OutputHandler.h"
45
46// Only allow main to access postMainInitialisation, so we need a forward declaration
47int main(int, char**);
48// boost::filesystem header has quite a large tail, use forward declaration
49namespace boost { namespace filesystem
50{
51    struct path_traits;
52    template<class String, class Traits> class basic_path;
53    typedef basic_path< std::string, path_traits> path;
54} }
55
56namespace orxonox
57{
58    //! The Core class is a singleton, only used to configure some config-values.
59    class _CoreExport Core : public OrxonoxClass
60    {
61        friend int ::main(int, char**); // sets isDevBuild_s
62
63        public:
64            Core();
65            ~Core();
66            void setConfigValues();
67
68            static Core& getInstance() { assert(Core::singletonRef_s); return *Core::singletonRef_s; }
69
70            static int   getSoftDebugLevel(OutputHandler::OutputDevice device = OutputHandler::LD_All);
71            static void  setSoftDebugLevel(OutputHandler::OutputDevice device, int level);
72            static const std::string& getLanguage();
73            static void  resetLanguage();
74
75            static bool isDevBuild() { return Core::isDevBuild_s; }
76
77            static void tsetMediaPath(const std::string& path)
78            { assert(singletonRef_s); singletonRef_s->_tsetMediaPath(path); }
79            static const boost::filesystem::path& getMediaPath();
80            static const boost::filesystem::path& getConfigPath();
81            static const boost::filesystem::path& getLogPath();
82            static std::string getMediaPathString();
83            static std::string getConfigPathString();
84            static std::string getLogPathString();
85            static std::string getMediaPathPOSIXString();
86            static std::string getConfigPathPOSIXString();
87            static std::string getLogPathPOSIXString();
88
89            // fast access global variables.
90            static bool showsGraphics() { return bShowsGraphics_s; }
91            static bool hasServer()     { return bHasServer_s; }
92            static bool isClient()      { return bIsClient_s; }
93            static bool isStandalone()  { return bIsStandalone_s; }
94            static bool isMaster()      { return bIsMaster_s; }
95            static void setShowsGraphics(bool val) { bShowsGraphics_s = val; updateIsMaster(); }
96            static void setHasServer    (bool val) { bHasServer_s     = val; updateIsMaster(); }
97            static void setIsClient     (bool val) { bIsClient_s      = val; updateIsMaster(); }
98            static void setIsStandalone (bool val) { bIsStandalone_s  = val; updateIsMaster(); }
99            static void updateIsMaster  ()         { bIsMaster_s      = (bHasServer_s || bIsStandalone_s); }
100
101        private:
102            Core(const Core&);
103            void resetLanguageIntern();
104            void initializeRandomNumberGenerator();
105            void debugLevelChanged();
106            void languageChanged();
107            void mediaPathChanged();
108            void _tsetMediaPath(const std::string& path);
109
110            static void postMainInitialisation();
111            static void checkDevBuild();
112            static void setExecutablePath();
113            static void createDirectories();
114
115            int softDebugLevel_;                            //!< The debug level
116            int softDebugLevelConsole_;                     //!< The debug level for the console
117            int softDebugLevelLogfile_;                     //!< The debug level for the logfile
118            int softDebugLevelShell_;                       //!< The debug level for the ingame shell
119            std::string language_;                          //!< The language
120            bool bInitializeRandomNumberGenerator_;         //!< If true, srand(time(0)) is called
121            std::string mediaPathString_;                   //!< Path to the data/media file folder as string
122
123            static bool bShowsGraphics_s;                   //!< global variable that tells whether to show graphics
124            static bool bHasServer_s;                       //!< global variable that tells whether this is a server
125            static bool bIsClient_s;
126            static bool bIsStandalone_s;
127            static bool bIsMaster_s;
128
129            static bool isDevBuild_s;                       //!< True for builds in the build directory (not installed)
130
131            static Core* singletonRef_s;
132    };
133}
134
135#endif /* _Core_H__ */
Note: See TracBrowser for help on using the repository browser.