]>
Dogcows Code - chaz/yoink/blob - moof/resource.hh
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.
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
);
68 static std::string
find_file(const std::string
& name
);
71 * Get the path to a resource of a given name and open it if a resource
73 * \param path The name of the resource to find. Upon successful
74 * return, this is changed to an absolute path to the resource.
75 * \param mode The open mode.
76 * \return The FILE* if the resource was found, 0 otherwise.
78 static FILE* open_file(const std::string
& path
,
79 const std::string
& mode
= "rb");
83 * Register a type with the extension of files which this type can
84 * load. If any type has already been registered with the given file
85 * extension, it will be replaced.
86 * \param extension The file extension.
89 static void register_type(const std::string
& extension
)
91 //if (!type_lookup_) type_lookup_ = type_lookup_ptr(new type_lookup);
92 loader_ptr
loader(new specific_loader
<T
>);
93 //(*type_lookup_)[extension] = loader;
94 //type_lookup_[extension] = loader;
95 manage_loader(extension
, loader
, true);
99 * Unregister the type associated with a file extension. Resources of
100 * this type will no longer be loadable, although resources which are
101 * already loaded will remain loaded.
102 * \param extension The file extension
104 static void unregister_type(const std::string
& extension
)
106 //type_lookup_.erase(extension);
107 //type_lookup_->erase(extension);
109 manage_loader(extension
, loader
, true);
113 static resource_ptr
load(const std::string
& path
);
115 static resource_ptr
reload(std::string
& path
);
119 * Construct a resource container.
120 * \param ptr A pointer to the underlying resource data.
123 explicit resource(T
* ptr
) :
125 typeinfo_(const_cast<std::type_info
*>(&typeid(T
))),
126 unloader_(new specific_unloader
<T
>(ptr
)) {}
129 * Deconstruct a resource container.
135 * Reload the resource data. This will cause the resource file to be
136 * reread, and the underlying resource data will change.
142 * Get whether or not the type of the underlying resource data matches
144 * \return True if the types match, false otherwise.
149 return *typeinfo_
== typeid(T
);
153 * Get a pointer to the underlying resource data as long as the type of
154 * the resource data matches the expected type.
155 * \return The resource data, or null if there is a type mismatch.
160 if (check
<T
>()) return (T
*)resource_
;
166 * Reloads some resources which have been modified on disk since they
167 * were loaded. Hotloading must have been enabled at compile-time.
168 * \return The number of resources reloaded.
170 static int reload_as_needed();
172 static void print_types();
183 virtual resource
* load(const std::string
& path
)
189 typedef boost::shared_ptr
<loader
> loader_ptr
;
192 class specific_loader
: public loader
196 virtual resource
* load(const std::string
& path
)
198 log_info("loading resource of type ", typeid(T
).name());
199 return new resource(new T(path
));
208 virtual ~unloader() {};
211 typedef boost::shared_ptr
<unloader
> unloader_ptr
;
214 class specific_unloader
: public unloader
218 specific_unloader(T
* object
= 0) :
221 virtual ~specific_unloader()
223 log_info("unloading resource of type ", typeid(T
).name());
234 void set_loader(const std::string
& path
, loader_ptr loader
)
242 std::type_info
* typeinfo_
;
243 unloader_ptr unloader_
;
248 typedef std::map
<std::string
,loader_ptr
> type_lookup
;
249 //typedef boost::shared_ptr<type_lookup> type_lookup_ptr;
250 //static type_lookup_ptr type_lookup_;
251 //static type_lookup type_lookup_;
253 static void manage_loader(const std::string
& extension
, loader_ptr
& loader
, bool set
= false);
255 #ifdef USE_HOTLOADING
258 void set_watch_descriptor(int wd
)
267 * The resource handle class provides a nicer way to work with resources.
268 * It allows you to work with a resource pointer as if you already know the
269 * type of the resource.
272 class resource_handle
277 * Construct a null resource handle.
282 * Construct a resource handle.
283 * \param ptr The resource pointer to reference.
285 resource_handle(resource_ptr ptr
) :
290 * Get whether or not the handle is dereferenceable to the type of this
291 * handle. A resource handle is dereferenceable if it is not a null
292 * handle and if its underlying resource is in fact the same type as is
293 * expected by the handle.
294 * \return True if the handle is dereferenceable, false otherwise.
296 operator bool () const
298 if (!resource_
) return false;
299 return resource_
->check
<T
>();
304 * Get a pointer to the underlying resource.
305 * \return The pointer, or null if this handle is not dereferenceable.
309 if (!*this) return 0;
310 return resource_
->get
<T
>();
314 * Dereference the handle all the way to the underlying resource.
315 * \return A reference to the resource.
316 * \throws std::runtime_error If this is a null handle.
318 T
& get_reference() const
320 if (!*this) throw std::runtime_error("dereference null handle");
321 return *(resource_
->get
<T
>());
326 * Same as get() for getting a pointer to the underlying resources.
327 * \return The pointer, or null if this handle is not dereferenceable.
329 T
* operator -> () const
335 * Same a get_reference() for dereferencing the handle.
336 * \return A reference to the resource.
337 * \throws std::runtime_error If this is a null handle.
339 T
& operator * () const
341 return get_reference();
347 resource_ptr resource_
;
353 #endif // _MOOF_RESOURCE_HH_
This page took 0.045874 seconds and 4 git commands to generate.