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.
26 #include <boost/shared_ptr.hpp>
27 #include <boost/function.hpp>
29 #include <moof/debug.hh>
32 #include "../config.h"
40 typedef boost::shared_ptr
<resource
> resource_ptr
;
44 * Generic resource class capable of containing any type of resource,
45 * providing a type-safe interface.
51 // FIXME: this won't be necessary once the existing code is modified to
52 // use the resource handles
56 * Add a directory to search when looking for resource files.
57 * \param paths A colon-separated list of directory paths.
59 static void add_search_paths(const std::string
& paths
);
62 * Add directories to search when looking for resource files.
63 * \param pathList The list of directory paths.
65 static void add_search_paths(const std::vector
<std::string
>& pathList
);
69 * Get the path to a resource of a given name.
70 * \param path The name of the resource to find. Upon successful
71 * return, this is changed to an absolute path to the resource.
72 * \return True if a path to a resource was found, false otherwise.
74 static bool find(const std::string
& file
);
77 * Get the path to a resource of a given name and open it if a resource
79 * \param path The name of the resource to find. Upon successful
80 * return, this is changed to an absolute path to the resource.
81 * \param mode The open mode.
82 * \return The FILE* if the resource was found, 0 otherwise.
84 static FILE* open_file(const std::string
& path
,
85 const std::string
& mode
= "rb");
89 * Register a type with the extension of files which this type can
90 * load. If any type has already been registered with the given file
91 * extension, it will be replaced.
92 * \param extension The file extension.
95 static void register_type(const std::string
& extension
)
97 if (!type_lookup_
) type_lookup_
= type_lookup_ptr(new type_lookup
);
98 loader_ptr
loader(new specific_loader
<T
>);
99 (*type_lookup_
)[extension
] = loader
;
103 * Unregister the type associated with a file extension. Resources of
104 * this type will no longer be loadable, although resources which are
105 * already loaded will remain loaded.
106 * \param extension The file extension
108 static void unregister_type(const std::string
& extension
)
110 type_lookup_
->erase(extension
);
114 static resource_ptr
load(const std::string
& path
);
116 static resource_ptr
reload(std::string
& path
);
120 * Construct a resource container.
121 * \param ptr A pointer to the underlying resource data.
124 explicit resource(T
* ptr
) :
126 typeinfo_(const_cast<std::type_info
*>(&typeid(T
))),
127 unloader_(new specific_unloader
<T
>(ptr
)) {}
130 * Deconstruct a resource container.
136 * Reload the resource data. This will cause the resource file to be
137 * reread, and the underlying resource data will change.
143 * Get whether or not the type of the underlying resource data matches
145 * \return True if the types match, false otherwise.
150 return *typeinfo_
== typeid(T
);
154 * Get a pointer to the underlying resource data as long as the type of
155 * the resource data matches the expected type.
156 * \return The resource data, or null if there is a type mismatch.
161 if (check
<T
>()) return (T
*)resource_
;
167 * Reloads some resources which have been modified on disk since they
168 * were loaded. Hotloading must have been enabled at compile-time.
169 * \return The number of resources reloaded.
171 static int reload_as_needed();
182 virtual resource
* load(const std::string
& path
)
188 typedef boost::shared_ptr
<loader
> loader_ptr
;
191 class specific_loader
: public loader
195 virtual resource
* load(const std::string
& path
)
197 return new resource(new T(path
));
206 virtual ~unloader() {};
209 typedef boost::shared_ptr
<unloader
> unloader_ptr
;
212 class specific_unloader
: public unloader
216 specific_unloader(T
* object
= 0) :
219 virtual ~specific_unloader()
221 log_warning("unloading resource of type ", typeid(T
).name());
232 void set_loader(const std::string
& path
, loader_ptr loader
)
240 std::type_info
* typeinfo_
;
241 unloader_ptr unloader_
;
246 typedef std::map
<std::string
,loader_ptr
> type_lookup
;
247 typedef boost::shared_ptr
<type_lookup
> type_lookup_ptr
;
248 static type_lookup_ptr type_lookup_
;
250 #ifdef USE_HOTLOADING
253 void set_watch_descriptor(int wd
)
262 * The resource handle class provides a nicer way to work with resources.
263 * It allows you to work with a resource pointer as if you already know the
264 * type of the resource.
267 class resource_handle
272 * Construct a null resource handle.
277 * Construct a resource handle.
278 * \param ptr The resource pointer to reference.
280 resource_handle(resource_ptr ptr
) :
285 * Get whether or not the handle is dereferenceable to the type of this
286 * handle. A resource handle is dereferenceable if it is not a null
287 * handle and if its underlying resource is in fact the same type as is
288 * expected by the handle.
289 * \return True if the handle is dereferenceable, false otherwise.
291 operator bool () const
293 if (!resource_
) return false;
294 return resource_
->check
<T
>();
299 * Get a pointer to the underlying resource.
300 * \return The pointer, or null if this handle is not dereferenceable.
304 if (!*this) return 0;
305 return resource_
->get
<T
>();
309 * Dereference the handle all the way to the underlying resource.
310 * \return A reference to the resource.
311 * \throws std::runtime_error If this is a null handle.
313 T
& get_reference() const
315 if (!*this) throw std::runtime_error("dereference null handle");
316 return *(resource_
->get
<T
>());
321 * Same as get() for getting a pointer to the underlying resources.
322 * \return The pointer, or null if this handle is not dereferenceable.
324 T
* operator -> () const
330 * Same a get_reference() for dereferencing the handle.
331 * \return A reference to the resource.
332 * \throws std::runtime_error If this is a null handle.
334 T
& operator * () const
336 return get_reference();
342 resource_ptr resource_
;
348 #endif // _MOOF_RESOURCE_HH_