FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
resource.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library 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 GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_RESOURE_H
23 #define FIFE_RESOURE_H
24 
25 // Standard C++ library includes
26 #include <string>
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/base/sharedptr.h"
35 
36 namespace FIFE {
37 
38  typedef std::size_t ResourceHandle;
39 
40  class IResource;
41 
43  public:
45  virtual ~IResourceLoader() { }
46 
47  virtual void load(IResource* resource) = 0;
48  };
49 
50  class IResource {
51  public:
53  RES_INVALID = 0,
55  RES_LOADED
56  };
57 
58  IResource(const std::string& name, IResourceLoader* loader = 0)
59  : m_name(name),
60  m_loader(loader),
61  m_state(RES_NOT_LOADED),
62  m_handle(m_curhandle++) { }
63 
64  virtual ~IResource() { }
65 
66  virtual const std::string& getName() { return m_name; }
67 
68  ResourceHandle getHandle() { return m_handle; }
69 
70  virtual ResourceState getState() { return m_state; }
71  virtual void setState(const ResourceState& state) { m_state = state; }
72 
73  virtual size_t getSize() = 0;
74 
75  virtual void load() = 0;
76  virtual void free() = 0;
77 
78  protected:
79  std::string m_name;
82 
83  private:
84  ResourceHandle m_handle;
85  static ResourceHandle m_curhandle;
86  };
87 
89 
90 } //FIFE
91 
92 #endif
ResourceHandle m_handle
Definition: resource.h:84
virtual ResourceState getState()
Definition: resource.h:70
IResourceLoader * m_loader
Definition: resource.h:80
IResource(const std::string &name, IResourceLoader *loader=0)
Definition: resource.h:58
std::size_t ResourceHandle
Definition: resource.h:38
virtual ~IResource()
Definition: resource.h:64
SharedPtr< IResource > ResourcePtr
Definition: resource.h:88
std::string m_name
Definition: resource.h:79
virtual const std::string & getName()
Definition: resource.h:66
ResourceState m_state
Definition: resource.h:81
virtual ~IResourceLoader()
Definition: resource.h:45
shared pointer implementation to provide automatic reference counting and deletion when last referenc...
Definition: sharedptr.h:42
virtual void setState(const ResourceState &state)
Definition: resource.h:71
static ResourceHandle m_curhandle
Definition: resource.h:85
virtual void load(IResource *resource)=0
ResourceHandle getHandle()
Definition: resource.h:68