tNamedFactory.h

Classes:

class
A helper template class for registering creation methods to name strings.
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _TFACTORY_H_
25#define _TFACTORY_H_
26
27#ifndef _TDICTIONARY_H_
28#include "core/util/tDictionary.h"
29#endif
30#ifndef _TORQUE_STRING_H_
31#include "core/util/str.h"
32#endif
33
34
35/// A helper template class for registering creation 
36/// methods to name strings.
37template <typename Type>
38class NamedFactory
39{
40protected:
41
42   typedef Type*(*FactorySig)();
43
44   typedef Map<String,FactorySig> FactoryMap;
45
46   ///
47   static FactoryMap& getFactoryMap()
48   {
49      static FactoryMap theMap;
50      return theMap;
51   }
52
53public:
54
55   /// Add a new creation method to the factory.
56   static void add( const char *name, FactorySig func )
57   {
58      getFactoryMap().insert( name, func );
59   }
60
61   /// Create an object instance by name.
62   static Type* create( const char *name )
63   {
64      typename FactoryMap::Iterator iter = getFactoryMap().find( name );
65      if ( iter == getFactoryMap().end() )
66         return NULL;
67
68      return iter->value();
69   }
70
71   /// Create an object instance of the first entry in the factory.
72   static Type* create()
73   {
74      typename FactoryMap::Iterator iter = getFactoryMap().begin();
75      if ( iter == getFactoryMap().end() )
76         return NULL;
77
78      return iter->value();
79   }
80};
81
82
83#endif //_TFACTORY_H_
84
85