Mercurial > fife-parpg

comparison engine/core/util/base/fifeclass.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_CLASS_H
23 #define FIFE_CLASS_H
24
25 // Standard C++ library includes
26 #include <cassert>
27
28 // 3rd party library includes
29
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34 #include "util/resource/resource.h"
35
36 namespace FIFE {
37
38 typedef unsigned int fifeid_t;
39
40 /** Base class for all fife classes
41 * Used e.g. to track instances over swig conversion
42 */
43 class FifeClass: public virtual IReferenceCounted {
44 public:
45 FifeClass(): m_fifeid(m_curid++), m_refcount(0) { }
46
47 virtual ~FifeClass() { assert(m_refcount == 0); }
48
49 /** Gets unique id of this instance inside the engine
50 */
51 fifeid_t getFifeId() { return m_fifeid; }
52
53 /** Calling this method marks resource be used by some resource client.
54 * It adds one to resource counter that is kept up by the resource itself.
55 * When resource is about to be deleted (e.g. due to pooling algorithms),
56 * reference counter is inspected. In case value is non-zero, resource
57 * shouldn't be deleted.
58 */
59 virtual void addRef() { m_refcount++; };
60
61 /** Calling this method unmarks resource be used by a resource client.
62 * @see addRef
63 */
64 virtual void decRef() { m_refcount--; };
65
66 /** Gets the current reference count
67 * @see addRef
68 */
69 virtual unsigned int getRefCount() { return m_refcount; };
70
71 private:
72 fifeid_t m_fifeid;
73 static fifeid_t m_curid;
74 unsigned int m_refcount;
75 };
76 }
77
78 #endif