Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SuperOrxoBros_HS18/src/libraries/core/class/IdentifierManager.h @ 12177

Last change on this file since 12177 was 12177, checked in by siramesh, 5 years ago

Super Orxo Bros Final (Sidharth Ramesh, Nisa Balta, Jeff Ren)

File size: 5.4 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 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Class Identifier
32*/
33
34#ifndef _IdentifierManager_H__
35#define _IdentifierManager_H__
36
37#include "core/CorePrereqs.h"
38
39#include <typeindex>
40#include <map>
41#include <unordered_map>
42#include <set>
43#include <list>
44#include <string>
45
46#include "util/Singleton.h"
47
48namespace orxonox
49{
50    class _CoreExport IdentifierManager : public Singleton<IdentifierManager>
51    {
52        friend class Singleton<IdentifierManager>;
53
54        public:
55            IdentifierManager();
56            ~IdentifierManager() = default;
57
58            void addIdentifier(Identifier* identifier);
59            void removeIdentifier(Identifier* identifier);
60
61
62            /////////////////////////////
63            ////// Class Hierarchy //////
64            /////////////////////////////
65            void createClassHierarchy();
66            void verifyClassHierarchy(const std::set<Identifier*>& initializedIdentifiers);
67            void destroyClassHierarchy();
68
69            void createdObject(Identifiable* identifiable);
70
71            /// Returns true, if a branch of the class-hierarchy is being created, causing all new objects to store their parents.
72            inline bool isCreatingHierarchy()
73                { return (hierarchyCreatingCounter_s > 0); }
74
75
76            //////////////////////////
77            ///// Identifier Map /////
78            //////////////////////////
79            Identifier* getIdentifierByString(const std::string& name);
80            Identifier* getIdentifierByLowercaseString(const std::string& name);
81            Identifier* getIdentifierByID(uint32_t id);
82            Identifier* getIdentifierByTypeInfo(const std::type_info& typeInfo);
83
84            void clearNetworkIDs();
85
86            /// Returns the map that stores all Identifiers with their names.
87            inline const std::map<std::string, Identifier*>& getIdentifierByStringMap()
88                { return this->identifierByString_; }
89            /// Returns the map that stores all Identifiers with their names in lowercase.
90            inline const std::map<std::string, Identifier*>& getIdentifierByLowercaseStringMap()
91                { return this->identifierByLowercaseString_; }
92            /// Returns the map that stores all Identifiers with their IDs.
93            inline const std::map<uint32_t, Identifier*>& getIdentifierByNetworkIdMap()
94                { return this->identifierByNetworkId_; }
95
96        private:
97            // non-copyable:
98            IdentifierManager(const IdentifierManager&) = delete;
99            IdentifierManager& operator=(const IdentifierManager&) = delete;
100
101            /// Increases the hierarchyCreatingCounter_s variable, causing all new objects to store their parents.
102            inline void startCreatingHierarchy()
103                { hierarchyCreatingCounter_s++; }
104            /// Decreases the hierarchyCreatingCounter_s variable, causing the objects to stop storing their parents.
105            inline void stopCreatingHierarchy()
106                { hierarchyCreatingCounter_s--; }
107
108            std::set<Identifier*> identifiers_;                                      //!< All identifiers. This is only used internally.
109            std::unordered_map<std::type_index, Identifier*> identifierByTypeIndex_; //!< Map that stores all Identifiers with their type_index.
110            std::map<std::string, Identifier*> identifierByString_;                  //!< Map that stores all Identifiers with their names.
111            std::map<std::string, Identifier*> identifierByLowercaseString_;         //!< Map that stores all Identifiers with their names in lowercase.
112            std::map<uint32_t, Identifier*> identifierByNetworkId_;                  //!< Returns the map that stores all Identifiers with their network IDs.
113
114            int hierarchyCreatingCounter_s;                         //!< Bigger than zero if at least one Identifier stores its parents (its an int instead of a bool to avoid conflicts with multithreading)
115
116            /// Used while creating the object hierarchy to keep track of the identifiers of a newly created object (and all other objects that get created as
117            /// a consequence of this, e.g. nested member objects).
118            std::map<Identifiable*, std::list<const Identifier*>> identifierTraceOfNewObject_;
119            Identifier* recordTraceForIdentifier_; //!< The identifier for which we want to record the trace of identifiers during object creation. If null, no trace is recorded.
120
121            static IdentifierManager* singletonPtr_s;
122    };
123}
124
125#endif /* _IdentifierManager_H__ */
Note: See TracBrowser for help on using the repository browser.