X-Git-Url: http://git.tdb.fi/?p=libs%2Fdatafile.git;a=blobdiff_plain;f=source%2Fcollection.h;h=06b8e348cbe3d2a7e16ce2735971802efa73a863;hp=9f5ddfcf7f78e5ba988636cc501edf05a87247a2;hb=43b8dee0bf05dee1b4a07cc001fae0c81ec53a2f;hpb=76c532f3f5ff079cf7b2016343a1ff73d497c50f diff --git a/source/collection.h b/source/collection.h index 9f5ddfc..06b8e34 100644 --- a/source/collection.h +++ b/source/collection.h @@ -4,8 +4,12 @@ #include #include #include +#include "collectionsource.h" #include "loader.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 { @@ -13,17 +17,14 @@ namespace DataFile { Helper struct to determine whether a Loader has a Collection typedef. */ template -struct NeedsCollection +struct NeedsCollection: public Sfinae { - struct Yes { char c[2]; }; - struct No { char c; }; - template static Yes f(typename U::Collection *); template static No f(...); - enum { value = (sizeof(f(0))==sizeof(Yes)) }; + enum { value = Evaluate(0))>::value }; }; class CollectionItemTypeBase; @@ -39,9 +40,13 @@ While this class can be instantiated by itself and used for storing objects, loading requires that a subclass defines the supported types. See the add_type method for details. -Collections also support a notion of "future objects". These are objects which -are known to be possible to load, but loading them is deferred to the first -time they are requested. +Collections can have sources for loading objects on demand. Automatic loading +only works on a non-const Collection. See class CollectionSource for details. + +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. */ class Collection { @@ -72,21 +77,23 @@ public: } }; -protected: template::value> class ItemLoader; private: typedef std::map ItemMap; typedef std::list TypeList; + typedef std::list SourceList; TypeList types; ItemMap items; + SourceList sources; + Collection *fallback; Collection(const Collection &); Collection &operator=(const Collection &); public: - Collection() { } + Collection(); virtual ~Collection(); /** Adds an object into the collection. The name must not pre-exist. The @@ -97,157 +104,130 @@ public: if(!item) throw std::invalid_argument("Collection::add(item)"); - typedef RefPtr::Type> RPNCT; - - ItemMap::iterator i = items.find(name); - if(i!=items.end()) + RefPtr::Type> ptr(item); + try { - if(i->second.check_type()) - { - // Replace a future object placeholder - RPNCT &ptr = i->second.value(); - if(!ptr) - { - ptr = item; - return; - } - } - - throw key_error(typeid(ItemMap)); + insert_unique(items, name, ptr); + } + catch(...) + { + // Avoid deleting the object + ptr.release(); + throw; } - - items.insert(ItemMap::value_type(name, RPNCT(item))); } -protected: - /** Adds the name of a future object to the collection. The object itself - will be loaded on first access. The calling subclass should be prepared to - create the object on request. */ + /// Gets a typed object from the collection. template - void add_future(const std::string &name) + T &get(const std::string &name) const { - RefPtr::Type> ptr(0); - insert_unique(items, name, ptr); + return extract::Type>(get_item(items, name)); } - /** Adds the name of a future object, guessing its type. If a type matching - the name can't be found, nothing is done. */ - void add_future(const std::string &name); - - /** Adds the name of a future object, using a keyword to determine its type. - The keyword must be known to the collection. */ - void add_future_with_keyword(const std::string &name, const std::string &); - -public: - /// Gets a typed object from the collection. + /** Gets a typed object from the collection. If the name is not found, + automatic creation with the type's creator function (if defined) or from + sources (if present) is attempted. */ template - T &get(const std::string &name) const + T &get(const std::string &name) { typedef typename RemoveConst::Type NCT; - - T *ptr = get_item(items, name).value >().get(); - if(!ptr) - throw key_error(typeid(ItemMap)); - return *ptr; + return extract(get_var(name, get_type())); } - /** Gets a typed object from the collection. If the name is not found in - and a creator for the item type is defined, it is invoked. */ +private: + const Variant &get_var(const std::string &, const CollectionItemTypeBase *); + template - T &get(const std::string &); + T &extract(const Variant &var) const; -private: template - void collect_items(std::list *objects, std::list *names, std::list *future_names) const + std::list extract_list(const std::list &vars) const { - typedef RefPtr::Type> RPNCT; + std::list result; + for(std::list::const_iterator i=vars.begin(); i!=vars.end(); ++i) + result.push_back(&extract(**i)); + return result; + } - for(ItemMap::const_iterator i=items.begin(); i!=items.end(); ++i) - if(i->second.check_type()) - { - T *ptr = i->second.value().get(); - if(ptr) - { - if(objects) - objects->push_back(ptr); - if(names) - names->push_back(i->first); - } - else if(future_names) - future_names->push_back(i->first); - } + void gather_items(std::list *, std::list *, const CollectionItemTypeBase &, bool) const; + + template + void gather_items(std::list *vars, std::list *names, const CollectionItemTypeBase *type, bool include_sources) const + { + if(type || (type = get_type())) + gather_items(vars, names, *type, include_sources); + else + gather_items(vars, names, CollectionItemType(), false); } public: - /** Returns a list of the names of loaded objects of one type in the - collection. */ + /// Returns a list of the names of objects of one type in the collection. template std::list get_names() const { - std::list result; - collect_items(0, &result, 0); - return result; + std::list names; + gather_items::Type>(0, &names, 0, false); + return names; } - /** Returns a list of the names of objects of one type in the collection, - including any future objects. */ + /** Returns a list of the names of objects of one type in the collection or + available from sources. */ template std::list get_names() { - std::list result; - collect_items(0, &result, &result); - return result; + std::list names; + gather_items::Type>(0, &names, 0, true); + return names; } - /// Returns a list of loaded objects of one type in the collection. + /// Returns a list of objects of one type in the collection. template std::list get_list() const { - std::list result; - collect_items(&result, 0, 0); - return result; + std::list vars; + gather_items::Type>(&vars, 0, 0, false); + return extract_list(vars); } - /** Returns a list of objects of one type in the collection. Any future - objects of that type are loaded and returned in the list. */ + /** Returns a list of objects of one type, loading them from sources if + necessary. */ template std::list get_list() { - std::list result; - std::list future; - collect_items(&result, 0, &future); - for(std::list::iterator i=future.begin(); i!=future.end(); ++i) - result.push_back(&get(*i)); - return result; + CollectionItemTypeBase *type = get_type::Type>(); + if(type) + load_items_from_sources(*type); + + std::list vars; + gather_items::Type>(&vars, 0, type, true); + return extract_list(vars); } private: + unsigned get_status(const std::string &, const CollectionItemTypeBase &) const; + template unsigned get_status(const std::string &name) const { - ItemMap::const_iterator i = items.find(name); - if(i==items.end()) - return false; - - typedef RefPtr::Type> RPNCT; - if(!i->second.check_type()) - return false; + // XXX Should go through all applicable types + if(CollectionItemTypeBase *type = get_type()) + return get_status(name, *type); - T *ptr = i->second.value().get(); - return ptr ? 1 : 2; + ItemMap::const_iterator i = items.find(name); + return (i!=items.end() && i->second.check_type >()); } public: - /// Checks whether a typed object exists and is loaded in the collection. + /// Checks whether a typed object exists in the collection. template bool contains(const std::string &name) const - { return get_status(name)==1; } + { return get_status::Type>(name)==1; } - /** Checks whether a typed object exists in the collection, as either a - loaded or future object. */ + /** Checks whether a typed object exists in the collection or is loadable + from a source. */ template bool contains(const std::string &name) - { return get_status(name)>0; } + { return get_status::Type>(name)>0; } /// Returns the name of an item in the collection. template @@ -269,6 +249,43 @@ protected: can be used to define how objects of that type can be loaded. */ template CollectionItemType &add_type(); + +private: + /// Returns the descriptor for a type, or null if one isn't defined. + template + CollectionItemTypeBase *get_type() 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: + /** 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; + +protected: + IO::Seekable *open_from_sources(const std::string &n) { return open_raw(n); } + +private: + void gather_names_from_sources(std::list &, const CollectionItemTypeBase &) const; + + void load_items_from_sources(const CollectionItemTypeBase &); + +protected: + /** 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 @@ -293,23 +310,22 @@ public: class CollectionItemTypeBase { protected: - class TagBase + struct ExtractorBase { - protected: - TagBase() { } - public: - virtual ~TagBase() { } + virtual ~ExtractorBase() { } }; template - class Tag: public TagBase - { }; + struct Extractor: ExtractorBase + { + virtual T &extract(const Variant &) const = 0; + }; std::string kwd; std::vector suffixes; - TagBase *tag; + std::vector extractors; - CollectionItemTypeBase(); + CollectionItemTypeBase() { } public: virtual ~CollectionItemTypeBase(); @@ -317,14 +333,30 @@ public: const std::string &get_keyword() const { return kwd; } void add_suffix(const std::string &); bool match_name(const std::string &) const; + virtual bool is_same_type(const CollectionItemTypeBase &) const = 0; + virtual bool check_item_type(const Variant &) const = 0; virtual void add_to_loader(Collection::Loader &) const = 0; virtual bool can_create() const = 0; virtual void create_item(Collection &, const std::string &) const = 0; - virtual Variant create_future() const = 0; + virtual void load_item(Collection &, Parser &, const std::string &) const = 0; + + template + bool can_extract() const + { + for(std::vector::const_iterator i=extractors.begin(); i!=extractors.end(); ++i) + if(dynamic_cast *>(*i)) + return true; + return false; + } template - bool check_type() const - { return dynamic_cast *>(tag); } + T *extract(const Variant &var) const + { + for(std::vector::const_iterator i=extractors.begin(); i!=extractors.end(); ++i) + if(Extractor *ex = dynamic_cast *>(*i)) + return &ex->extract(var); + return 0; + } }; @@ -336,71 +368,43 @@ template class CollectionItemType: public CollectionItemTypeBase { private: - class CreatorBase + struct CreatorBase { - protected: - CreatorBase() { } - public: virtual ~CreatorBase() { } virtual T *create(Collection &, const std::string &) const = 0; }; template - class Creator: public CreatorBase + struct Creator: CreatorBase { - public: typedef T *(C::*FuncPtr)(const std::string &); - private: FuncPtr func; - public: Creator(FuncPtr f): func(f) { } virtual T *create(Collection &coll, const std::string &name) const - { return (static_cast(coll).*func)(name); } - }; - - class StoreBase - { - protected: - StoreBase() { } - public: - virtual ~StoreBase() { } - - virtual void store(Collection &, const std::string &, T *) = 0; - virtual Variant create_future() const = 0; - - virtual void add_to_loader(Collection::Loader &, const std::string &) = 0; + { return (dynamic_cast(coll).*func)(name); } }; - template - class Store: public StoreBase + template + struct Extractor: CollectionItemTypeBase::Extractor { - public: - virtual void store(Collection &coll, const std::string &name, T *obj) - { coll.add(name, static_cast(obj)); } - - virtual Variant create_future() const - { return RefPtr(0); } - - virtual void add_to_loader(Collection::Loader &loader, const std::string &kwd) - { loader.add(kwd, &Collection::Loader::item); } + virtual B &extract(const Variant &var) const + { return *var.value >(); } }; CreatorBase *creat; - StoreBase *store; public: CollectionItemType(): - creat(0), store(new Store) - { tag = new Tag; } + creat(0) + { } ~CollectionItemType() { delete creat; - delete store; } /** Sets a datafile keyword for this item type. The Collection's loader @@ -436,20 +440,22 @@ public: return *this; } - /** Specifies the storage type for items of this type. It must be a base - class of the actual type. */ - template - CollectionItemType &store_as() + /** Makes items of this type available through a base class. */ + template + CollectionItemType &base() { - delete tag; - tag = new Tag; - delete store; - store = new Store; + extractors.push_back(new Extractor); return *this; } + virtual bool is_same_type(const CollectionItemTypeBase &other) const + { return dynamic_cast *>(&other); } + + virtual bool check_item_type(const Variant &var) const + { return var.check_type >(); } + virtual void add_to_loader(Collection::Loader &loader) const - { store->add_to_loader(loader, kwd); } + { loader.add(kwd, &Collection::Loader::item); } virtual bool can_create() const { return creat!=0; } @@ -460,32 +466,29 @@ public: throw std::runtime_error("no creator"); T *obj = creat->create(coll, name); if(obj) - store->store(coll, name, obj); + coll.add(name, obj); } - virtual Variant create_future() const - { return store->create_future(); } + virtual void load_item(Collection &coll, Parser &parser, const std::string &name) const + { + RefPtr obj = new T; + Collection::ItemLoader ldr(*obj, coll); + ldr.load(parser); + coll.add(name, obj.get()); + obj.release(); + } }; template -T &Collection::get(const std::string &name) +T &Collection::extract(const Variant &var) const { - typedef typename RemoveConst::Type NCT; - - ItemMap::iterator i = items.find(name); - if(i!=items.end()) - { - NCT *ptr = i->second.value >().get(); - if(ptr) - return *ptr; - } + if(!var.check_type >()) + if(CollectionItemTypeBase *type = get_type_for_item(var)) + if(T *item = type->extract(var)) + return *item; - for(TypeList::iterator j=types.begin(); j!=types.end(); ++j) - if((*j)->can_create() && (*j)->check_type()) - (*j)->create_item(*this, name); - - return *get_item(items, name).value >(); + return *var.value >(); } template @@ -496,6 +499,18 @@ CollectionItemType &Collection::add_type() return *type; } +template +CollectionItemTypeBase *Collection::get_type() const +{ + for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j) + if(dynamic_cast *>(*j)) + return *j; + for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j) + if((*j)->can_extract()) + return *j; + return 0; +} + } // namespace DataFile } // namespace Msp