-/*] Copyright (c) 2009-2010, Charles McGarvey [**************************
+/*] Copyright (c) 2009-2011, Charles McGarvey [*****************************
**] All rights reserved.
*
-* vi:ts=4 sw=4 tw=75
-*
* Distributable under the terms and conditions of the 2-clause BSD license;
* see the file COPYING for a complete text of the license.
*
-**************************************************************************/
+*****************************************************************************/
#ifndef _MOOF_RESOURCE_HH_
#define _MOOF_RESOURCE_HH_
-/**
- * \file resource.hh
- * Interface for textures, sounds, and other types of resources.
- */
-
-#include "config.h"
-
-#include <cstdio>
#include <map>
#include <stdexcept>
#include <string>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
-#include <moof/debug.hh>
+/**
+ * \file resource.hh
+ * Interface for textures, sounds, and other types of resources.
+ */
namespace moof {
class resource;
typedef boost::shared_ptr<resource> resource_ptr;
-
/**
* Generic resource class capable of containing any type of resource,
* providing a type-safe interface.
{
public:
- // XXX: this won't be necessary once the existing code is modified to
- // use the resource handles
- resource() {}
-
/**
* Add a directory to search when looking for resource files.
* \param paths A colon-separated list of directory paths.
*/
- static void add_search_paths(const std::string& paths);
-
+ static void set_search_paths(const std::string& paths);
/**
- * Get the path to a resource of a given name.
- * \param path The name of the resource to find. Upon successful
- * return, this is changed to an absolute path to the resource.
- * \return True if a path to a resource was found, false otherwise.
- * XXX this is legacy
+ * Get the path to a resource of a given name. This uses the search
+ * path(s) and resources prefixes to locate resource files.
+ * \param name The name or partial path of the resource to find.
+ * \return The full path of the resource.
*/
- static bool find(const std::string& file);
-
static std::string find_file(const std::string& name);
- static std::string find_file(const std::string& name,
- const std::string& ext);
-
/**
- * Get the path to a resource of a given name and open it if a resource
- * was found.
- * \param path The name of the resource to find. Upon successful
- * return, this is changed to an absolute path to the resource.
- * \param mode The open mode.
- * \return The FILE* if the resource was found, 0 otherwise.
- * XXX deprecated
+ * Get the path to a resource of a given name and explicit type. This
+ * uses the search path(s) and resources prefixes to locate resource
+ * files.
+ * \param name The name or partial path of the resource to find.
+ * \param ext The extension is appended to the name if the same
+ * extension is not already a part of name.
+ * \return The full path of the resource.
*/
- static FILE* open_file(const std::string& path,
- const std::string& mode = "rb");
-
+ static std::string
+ find_file(const std::string& name, const std::string& ext);
/**
* Register a type with the extension of files which this type can
*/
template <class T>
static void register_type(const std::string& extension,
- const std::string& prefix = "")
+ const std::string& prefix = "")
{
loader_ptr loader(new specific_loader<T>(prefix));
- printf("registered type with prefix %s", loader->prefix().c_str());
call_registry(extension, loader, set);
}
* Unregister the type associated with a file extension. Resources of
* this type will no longer be loadable, although resources which are
* already loaded will remain loaded.
- * \param extension The file extension
+ * \param extension The file extension.
*/
static void unregister_type(const std::string& extension)
{
call_registry(extension, loader, set);
}
-
- static resource_ptr load(const std::string& name);
- static resource_ptr load(const std::string& name,
- const std::string& ext);
-
- static resource_ptr reload(std::string& path);
-
-
/**
- * Construct a resource container.
- * \param ptr A pointer to the underlying resource data.
+ * Find and load a resource by name or path.
+ * \param name The name or partial path of the resource. This should
+ * include the extension so that the correct loader can be chosen.
+ * \return The resource.
*/
- template <class T>
- explicit resource(T* ptr) :
- resource_(ptr),
- typeinfo_(const_cast<std::type_info*>(&typeid(T))),
- unloader_(new specific_unloader<T>(ptr)) {}
+ static resource_ptr load(const std::string& name);
/**
- * Deconstruct a resource container.
+ * Find and load a resource by name or path.
+ * \param name The name or partial path of the resource. This should
+ * include the extension so that the correct loader can be chosen.
+ * \param
+ * \return The resource.
*/
- virtual ~resource();
-
+ static resource_ptr
+ load(const std::string& name, const std::string& ext);
/**
* Reload the resource data. This will cause the resource file to be
*/
void reload();
+ /**
+ * Get the path of file from which this resource was loaded.
+ * \return The path.
+ */
+ std::string path() const
+ {
+ return path_;
+ }
+
+ /**
+ * Reloads some resources which have been modified on disk since they
+ * were loaded. Hotloading must have been enabled at compile-time.
+ * \return The number of resources reloaded.
+ */
+ static int reload_as_needed();
/**
* Get whether or not the type of the underlying resource data matches
return 0;
}
-
/**
- * Reloads some resources which have been modified on disk since they
- * were loaded. Hotloading must have been enabled at compile-time.
- * \return The number of resources reloaded.
+ * Deconstruct a resource container.
*/
- static int reload_as_needed();
-
+ virtual ~resource();
private:
- static resource_ptr load_with_path(const std::string& path);
+ template <class T>
+ explicit resource(T* ptr) :
+ resource_(ptr),
+ typeinfo_(const_cast<std::type_info*>(&typeid(T))),
+ unloader_(new specific_unloader<T>(ptr)),
+ wd_(-1) {}
+
+ static resource_ptr
+ load_with_path(const std::string& path, const std::string& extension);
class loader
{
public:
- //loader() {}
loader(const std::string& prefix) :
prefix_(prefix) {}
return prefix_;
}
-
private:
std::string prefix_;
{
public:
- //specific_loader() {}
specific_loader(const std::string& prefix) :
loader(prefix) {}
virtual resource* load(const std::string& path)
{
- log_info("loading resource of type ", typeid(T).name());
return new resource(new T(path));
}
};
-
class unloader
{
public:
virtual ~specific_unloader()
{
- log_info("unloading resource of type ", typeid(T).name());
delete object_;
}
-
private:
T* object_;
};
-
- void set_loader(const std::string& path, loader_ptr loader)
- {
- path_ = path;
- loader_ = loader;
- }
-
-
- void* resource_;
- std::type_info* typeinfo_;
- unloader_ptr unloader_;
-
- std::string path_;
- loader_ptr loader_;
-
- typedef std::map<std::string,loader_ptr> type_lookup;
- //typedef boost::shared_ptr<type_lookup> type_lookup_ptr;
- //static type_lookup_ptr type_lookup_;
- //static type_lookup type_lookup_;
-
enum registry_action
{
lookup,
};
static bool call_registry(const std::string& extension,
- loader_ptr& loader,
- registry_action action);
-
-#ifdef USE_HOTLOADING
- int wd_;
+ loader_ptr& loader, registry_action action);
- void set_watch_descriptor(int wd)
- {
- wd_ = wd;
- }
-#endif
+ void* resource_;
+ std::type_info* typeinfo_;
+ unloader_ptr unloader_;
+ int wd_;
+ std::string path_;
+ std::string type_;
};
resource_handle(const std::string& name, const std::string& ext) :
resource_(resource::load(name, ext)) {}
-
-
/**
* Get whether or not the handle is dereferenceable to the type of this
* handle. A resource handle is dereferenceable if it is not a null
return resource_->check<T>();
}
-
/**
* Get a pointer to the underlying resource.
* \return The pointer, or null if this handle is not dereferenceable.
return *(resource_->get<T>());
}
-
/**
* Same as get() for getting a pointer to the underlying resources.
* \return The pointer, or null if this handle is not dereferenceable.
return get_reference();
}
-
/**
* Unload the resource associated with this handle.
*/
resource_ = resource_ptr();
}
-
private:
resource_ptr resource_;
};
+/**
+ * This macro easily registers types to act as resources. It should be
+ * used in a module file in global scope.
+ * \param TYPE The type (class), qualified as needed for the scope.
+ * \param EXT The file extension the resource uses.
+ * \param PREFIX The path prefix where a resource of this type could be.
+ */
+#define MOOF_REGISTER_RESOURCE(TYPE, EXT, PREFIX) \
+namespace { \
+ struct EXT { \
+ EXT() { moof::resource::register_type<TYPE>(#EXT, #PREFIX); } \
+ ~EXT() { moof::resource::unregister_type(#EXT); } \
+ }; \
+ static EXT EXT; \
+}
+
} // namespace moof
projects / chaz / yoink / blobdiff