#ifndef MSP_DATAFILE_COLLECTION_H_
#define MSP_DATAFILE_COLLECTION_H_
+#include <msp/core/attributes.h>
#include <msp/core/maputils.h>
-#include <msp/core/meta.h>
#include <msp/core/refptr.h>
#include "collectionsource.h"
#include "loader.h"
+#include "meta.h"
/* XXX This file is a big mess with too many things in it. However, the
dependencies between those things make it difficult to split up. */
namespace Msp {
namespace DataFile {
-/**
-Helper struct to determine whether a Loader has a Collection typedef.
-*/
-template<typename T>
-struct NeedsCollection
-{
- struct Yes { char c[2]; };
- struct No { char c; };
-
- template<typename U>
- static Yes f(typename U::Collection *);
- template<typename U>
- static No f(...);
-
- enum { value = (sizeof(f<T>(0))==sizeof(Yes)) };
-};
-
class CollectionItemTypeBase;
template<typename T>
Collections can have sources for loading objects on demand. Automatic loading
only works on a non-const Collection. See class CollectionSource for details.
-A fallback collection can be designated as another way of loading items that
-are not present. Items retrieted from the fallback collection are shared
+As a last resort, a fallback collection can be designated for loading items
+that are not present. Items retrieted from the fallback collection are shared
between the collections, and are only deleted when all collections in the chain
have been destroyed.
*/
private:
typedef std::map<std::string, Variant> ItemMap;
- typedef std::list<CollectionItemTypeBase *> TypeList;
- typedef std::list<CollectionSource *> SourceList;
+ typedef std::vector<CollectionItemTypeBase *> TypeList;
+ typedef std::vector<const CollectionSource *> SourceList;
TypeList types;
ItemMap items;
T &get(const std::string &name)
{
typedef typename RemoveConst<T>::Type NCT;
- return extract<NCT>(get_var(name, get_type<NCT>()));
+ return extract<NCT>(get_var(name, get_type<NCT>(name)));
}
private:
T &extract(const Variant &var) const;
template<typename T>
- std::list<T *> extract_list(const std::list<const Variant *> &vars) const
+ std::list<T *> extract_list(const std::vector<const Variant *> &vars) const
{
std::list<T *> result;
- for(std::list<const Variant *>::const_iterator i=vars.begin(); i!=vars.end(); ++i)
+ for(std::vector<const Variant *>::const_iterator i=vars.begin(); i!=vars.end(); ++i)
result.push_back(&extract<T>(**i));
return result;
}
- void gather_items(std::list<const Variant *> *, std::list<std::string> *, const CollectionItemTypeBase &, bool) const;
+ void gather_items(std::vector<const Variant *> *, std::list<std::string> *, const CollectionItemTypeBase &, bool) const;
template<typename T>
- void gather_items(std::list<const Variant *> *vars, std::list<std::string> *names, const CollectionItemTypeBase *type, bool include_sources) const
+ void gather_items(std::vector<const Variant *> *vars, std::list<std::string> *names, const CollectionItemTypeBase *type, bool include_sources) const
{
if(type || (type = get_type<T>()))
gather_items(vars, names, *type, include_sources);
template<typename T>
std::list<T *> get_list() const
{
- std::list<const Variant *> vars;
+ std::vector<const Variant *> vars;
gather_items<typename RemoveConst<T>::Type>(&vars, 0, 0, false);
return extract_list<T>(vars);
}
if(type)
load_items_from_sources(*type);
- std::list<const Variant *> vars;
+ std::vector<const Variant *> vars;
gather_items<typename RemoveConst<T>::Type>(&vars, 0, type, true);
return extract_list<T>(vars);
}
template<typename T>
CollectionItemType<T> &add_type();
+ /** Returns a mutable reference to an existing type descriptor. This can be
+ used to e.g. override the creator function of a type added by a base class. */
+ template<typename T>
+ CollectionItemType<T> &modify_type();
+
private:
- /// Returns the descriptor for a type, or null if one isn't defined.
+ /** Returns the descriptor for a type, or null if one isn't defined. An
+ optional name can be given to prioritize matching types. */
template<typename T>
- CollectionItemTypeBase *get_type() const;
+ CollectionItemTypeBase *get_type(const std::string & = std::string()) const;
+
+ /// Gets a descriptor with the same type as another descriptor.
+ CollectionItemTypeBase *get_type(const CollectionItemTypeBase &) const;
/// Returns the descriptor for an item, or null if it's of an unknown type.
CollectionItemTypeBase *get_type_for_item(const Variant &) const;
protected:
- void add_source(CollectionSource &);
+ /** Adds a source for automatically loading items. Sources are consulted
+ in the order they are added. */
+ void add_source(const CollectionSource &);
+
+public:
+ /** Opens a raw resource, without interpreting it as object data. Null is
+ returned if no such file is found. The caller must dispose of the returned
+ object when done with it. */
+ IO::Seekable *open_raw(const std::string &) const;
- IO::Seekable *open_from_sources(const std::string &);
+protected:
+ // Deprecated. Use open_raw instead.
+ DEPRECATED IO::Seekable *open_from_sources(const std::string &n) { return open_raw(n); }
private:
void gather_names_from_sources(std::list<std::string> &, const CollectionItemTypeBase &) const;
/** Sets a fallback collection, which will be consulted if an item is not
found. */
void set_fallback(Collection *);
+
+ Collection *get_fallback() const { return fallback; }
};
template<typename T>
Creator(FuncPtr f): func(f) { }
virtual T *create(Collection &coll, const std::string &name) const
- { return (static_cast<C &>(coll).*func)(name); }
+ { return (dynamic_cast<C &>(coll).*func)(name); }
};
template<typename B>
return *this;
}
- /** Adds a suffix that is used to match names when looking for future
+ /** Adds a suffix that is used to match names when looking for loadable
objects. There is no implied separator; a name matches if it ends with the
suffix. If a keyword is defined before any suffixes, then "."+keyword is
added as a suffix. */
}
template<typename T>
-CollectionItemTypeBase *Collection::get_type() const
+CollectionItemType<T> &Collection::modify_type()
+{
+ for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j)
+ if(CollectionItemType<T> *t = dynamic_cast<CollectionItemType<T> *>(*j))
+ return *t;
+
+ throw std::logic_error("type not found in collection");
+}
+
+template<typename T>
+CollectionItemTypeBase *Collection::get_type(const std::string &name) const
{
for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j)
if(dynamic_cast<CollectionItemType<T> *>(*j))
return *j;
+ CollectionItemTypeBase *type = 0;
for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j)
if((*j)->can_extract<T>())
- return *j;
- return 0;
+ {
+ if(!name.empty() && (*j)->match_name(name))
+ return *j;
+ type = *j;
+ }
+ return type;
}
} // namespace DataFile
projects / libs / datafile.git / blobdiff