2 /*] Copyright (c) 2009-2010, Charles McGarvey [**************************
3 **] All rights reserved.
7 * Distributable under the terms and conditions of the 2-clause BSD license;
8 * see the file COPYING for a complete text of the license.
10 **************************************************************************/
12 #ifndef _MOOF_RESOURCE_HH_
13 #define _MOOF_RESOURCE_HH_
17 * Interface for textures, sounds, and other types of resources.
20 #include "../config.h"
28 #include <boost/shared_ptr.hpp>
29 #include <boost/function.hpp>
31 #include <moof/debug.hh>
38 typedef boost::shared_ptr
<resource
> resource_ptr
;
42 * Generic resource class capable of containing any type of resource,
43 * providing a type-safe interface.
49 // FIXME: this won't be necessary once the existing code is modified to
50 // use the resource handles
54 * Add a directory to search when looking for resource files.
55 * \param paths A colon-separated list of directory paths.
57 static void add_search_paths(const std::string
& paths
);
61 * Get the path to a resource of a given name.
62 * \param path The name of the resource to find. Upon successful
63 * return, this is changed to an absolute path to the resource.
64 * \return True if a path to a resource was found, false otherwise.
66 static bool find(const std::string
& file
);
69 * Get the path to a resource of a given name and open it if a resource
71 * \param path The name of the resource to find. Upon successful
72 * return, this is changed to an absolute path to the resource.
73 * \param mode The open mode.
74 * \return The FILE* if the resource was found, 0 otherwise.
76 static FILE* open_file(const std::string
& path
,
77 const std::string
& mode
= "rb");
81 * Register a type with the extension of files which this type can
82 * load. If any type has already been registered with the given file
83 * extension, it will be replaced.
84 * \param extension The file extension.
87 static void register_type(const std::string
& extension
)
89 if (!type_lookup_
) type_lookup_
= type_lookup_ptr(new type_lookup
);
90 loader_ptr
loader(new specific_loader
<T
>);
91 (*type_lookup_
)[extension
] = loader
;
95 * Unregister the type associated with a file extension. Resources of
96 * this type will no longer be loadable, although resources which are
97 * already loaded will remain loaded.
98 * \param extension The file extension
100 static void unregister_type(const std::string
& extension
)
102 type_lookup_
->erase(extension
);
106 static resource_ptr
load(const std::string
& path
);
108 static resource_ptr
reload(std::string
& path
);
112 * Construct a resource container.
113 * \param ptr A pointer to the underlying resource data.
116 explicit resource(T
* ptr
) :
118 typeinfo_(const_cast<std::type_info
*>(&typeid(T
))),
119 unloader_(new specific_unloader
<T
>(ptr
)) {}
122 * Deconstruct a resource container.
128 * Reload the resource data. This will cause the resource file to be
129 * reread, and the underlying resource data will change.
135 * Get whether or not the type of the underlying resource data matches
137 * \return True if the types match, false otherwise.
142 return *typeinfo_
== typeid(T
);
146 * Get a pointer to the underlying resource data as long as the type of
147 * the resource data matches the expected type.
148 * \return The resource data, or null if there is a type mismatch.
153 if (check
<T
>()) return (T
*)resource_
;
159 * Reloads some resources which have been modified on disk since they
160 * were loaded. Hotloading must have been enabled at compile-time.
161 * \return The number of resources reloaded.
163 static int reload_as_needed();
174 virtual resource
* load(const std::string
& path
)
180 typedef boost::shared_ptr
<loader
> loader_ptr
;
183 class specific_loader
: public loader
187 virtual resource
* load(const std::string
& path
)
189 return new resource(new T(path
));
198 virtual ~unloader() {};
201 typedef boost::shared_ptr
<unloader
> unloader_ptr
;
204 class specific_unloader
: public unloader
208 specific_unloader(T
* object
= 0) :
211 virtual ~specific_unloader()
213 log_warning("unloading resource of type ", typeid(T
).name());
224 void set_loader(const std::string
& path
, loader_ptr loader
)
232 std::type_info
* typeinfo_
;
233 unloader_ptr unloader_
;
238 typedef std::map
<std::string
,loader_ptr
> type_lookup
;
239 typedef boost::shared_ptr
<type_lookup
> type_lookup_ptr
;
240 static type_lookup_ptr type_lookup_
;
242 #ifdef USE_HOTLOADING
245 void set_watch_descriptor(int wd
)
254 * The resource handle class provides a nicer way to work with resources.
255 * It allows you to work with a resource pointer as if you already know the
256 * type of the resource.
259 class resource_handle
264 * Construct a null resource handle.
269 * Construct a resource handle.
270 * \param ptr The resource pointer to reference.
272 resource_handle(resource_ptr ptr
) :
277 * Get whether or not the handle is dereferenceable to the type of this
278 * handle. A resource handle is dereferenceable if it is not a null
279 * handle and if its underlying resource is in fact the same type as is
280 * expected by the handle.
281 * \return True if the handle is dereferenceable, false otherwise.
283 operator bool () const
285 if (!resource_
) return false;
286 return resource_
->check
<T
>();
291 * Get a pointer to the underlying resource.
292 * \return The pointer, or null if this handle is not dereferenceable.
296 if (!*this) return 0;
297 return resource_
->get
<T
>();
301 * Dereference the handle all the way to the underlying resource.
302 * \return A reference to the resource.
303 * \throws std::runtime_error If this is a null handle.
305 T
& get_reference() const
307 if (!*this) throw std::runtime_error("dereference null handle");
308 return *(resource_
->get
<T
>());
313 * Same as get() for getting a pointer to the underlying resources.
314 * \return The pointer, or null if this handle is not dereferenceable.
316 T
* operator -> () const
322 * Same a get_reference() for dereferencing the handle.
323 * \return A reference to the resource.
324 * \throws std::runtime_error If this is a null handle.
326 T
& operator * () const
328 return get_reference();
334 resource_ptr resource_
;
340 #endif // _MOOF_RESOURCE_HH_