1 #ifndef MSP_DATAFILE_COLLECTION_H_
2 #define MSP_DATAFILE_COLLECTION_H_
4 #include <msp/core/maputils.h>
5 #include <msp/core/meta.h>
6 #include <msp/core/refptr.h>
7 #include "collectionsource.h"
10 /* XXX This file is a big mess with too many things in it. However, the
11 dependencies between those things make it difficult to split up. */
17 Helper struct to determine whether a Loader has a Collection typedef.
20 struct NeedsCollection: public Sfinae
23 static Yes f(typename U::Collection *);
27 enum { value = Evaluate<sizeof(f<T>(0))>::value };
30 class CollectionItemTypeBase;
33 class CollectionItemType;
36 A collection of objects that can be loaded from a datafile. Each object is
37 identified by a name, which must be unique across the entire collection.
39 While this class can be instantiated by itself and used for storing objects,
40 loading requires that a subclass defines the supported types. See the add_type
43 Collections can have sources for loading objects on demand. Automatic loading
44 only works on a non-const Collection. See class CollectionSource for details.
46 As a last resort, a fallback collection can be designated for loading items
47 that are not present. Items retrieted from the fallback collection are shared
48 between the collections, and are only deleted when all collections in the chain
55 Loads objects into a Collection. Automatically picks up keywords from
58 class Loader: public DataFile::Loader
60 template<typename T> friend class CollectionItemType;
67 Collection &get_object() const { return coll; }
69 template<typename T, typename S>
70 void item(const std::string &n)
73 ItemLoader<T> ldr(*it, coll);
75 coll.add<S>(n, it.get());
80 template<typename T, bool = NeedsCollection<typename T::Loader>::value>
84 typedef std::map<std::string, Variant> ItemMap;
85 typedef std::list<CollectionItemTypeBase *> TypeList;
86 typedef std::list<CollectionSource *> SourceList;
93 Collection(const Collection &);
94 Collection &operator=(const Collection &);
97 virtual ~Collection();
99 /** Adds an object into the collection. The name must not pre-exist. The
100 collection takes ownership of the object. */
102 void add(const std::string &name, T *item)
105 throw std::invalid_argument("Collection::add(item)");
107 RefPtr<typename RemoveConst<T>::Type> ptr(item);
110 insert_unique(items, name, ptr);
114 // Avoid deleting the object
120 /// Gets a typed object from the collection.
122 T &get(const std::string &name) const
124 return extract<typename RemoveConst<T>::Type>(get_item(items, name));
127 /** Gets a typed object from the collection. If the name is not found,
128 automatic creation with the type's creator function (if defined) or from
129 sources (if present) is attempted. */
131 T &get(const std::string &name)
133 typedef typename RemoveConst<T>::Type NCT;
134 return extract<NCT>(get_var(name, get_type<NCT>()));
138 const Variant &get_var(const std::string &, const CollectionItemTypeBase *);
141 T &extract(const Variant &var) const;
144 std::list<T *> extract_list(const std::list<const Variant *> &vars) const
146 std::list<T *> result;
147 for(std::list<const Variant *>::const_iterator i=vars.begin(); i!=vars.end(); ++i)
148 result.push_back(&extract<T>(**i));
152 void gather_items(std::list<const Variant *> *, std::list<std::string> *, const CollectionItemTypeBase &, bool) const;
155 void gather_items(std::list<const Variant *> *vars, std::list<std::string> *names, const CollectionItemTypeBase *type, bool include_sources) const
157 if(type || (type = get_type<T>()))
158 gather_items(vars, names, *type, include_sources);
160 gather_items(vars, names, CollectionItemType<T>(), false);
164 /// Returns a list of the names of objects of one type in the collection.
166 std::list<std::string> get_names() const
168 std::list<std::string> names;
169 gather_items<typename RemoveConst<T>::Type>(0, &names, 0, false);
173 /** Returns a list of the names of objects of one type in the collection or
174 available from sources. */
176 std::list<std::string> get_names()
178 std::list<std::string> names;
179 gather_items<typename RemoveConst<T>::Type>(0, &names, 0, true);
183 /// Returns a list of objects of one type in the collection.
185 std::list<T *> get_list() const
187 std::list<const Variant *> vars;
188 gather_items<typename RemoveConst<T>::Type>(&vars, 0, 0, false);
189 return extract_list<T>(vars);
192 /** Returns a list of objects of one type, loading them from sources if
195 std::list<T *> get_list()
197 CollectionItemTypeBase *type = get_type<typename RemoveConst<T>::Type>();
199 load_items_from_sources(*type);
201 std::list<const Variant *> vars;
202 gather_items<typename RemoveConst<T>::Type>(&vars, 0, type, true);
203 return extract_list<T>(vars);
207 unsigned get_status(const std::string &, const CollectionItemTypeBase &) const;
210 unsigned get_status(const std::string &name) const
212 // XXX Should go through all applicable types
213 if(CollectionItemTypeBase *type = get_type<T>())
214 return get_status(name, *type);
216 ItemMap::const_iterator i = items.find(name);
217 return (i!=items.end() && i->second.check_type<RefPtr<T> >());
221 /// Checks whether a typed object exists in the collection.
223 bool contains(const std::string &name) const
224 { return get_status<typename RemoveConst<T>::Type>(name)==1; }
226 /** Checks whether a typed object exists in the collection or is loadable
229 bool contains(const std::string &name)
230 { return get_status<typename RemoveConst<T>::Type>(name)>0; }
232 /// Returns the name of an item in the collection.
234 const std::string &get_name(T *d) const
236 typedef RefPtr<typename RemoveConst<T>::Type> RPNCT;
238 for(ItemMap::const_iterator i=items.begin(); i!=items.end(); ++i)
239 if(i->second.check_type<RPNCT>())
240 if(i->second.value<RPNCT>().get()==d)
243 // XXX Need better exception class
244 throw std::runtime_error("Item not found in collection");
248 /** Adds a type to the collection. The returned descriptor object reference
249 can be used to define how objects of that type can be loaded. */
251 CollectionItemType<T> &add_type();
254 /// Returns the descriptor for a type, or null if one isn't defined.
256 CollectionItemTypeBase *get_type() const;
258 /// Gets a descriptor with the same type as another descriptor.
259 CollectionItemTypeBase *get_type(const CollectionItemTypeBase &) const;
261 /// Returns the descriptor for an item, or null if it's of an unknown type.
262 CollectionItemTypeBase *get_type_for_item(const Variant &) const;
265 /** Adds a source for automatically loading items. Sources are consulted
266 in the order they are added. */
267 void add_source(CollectionSource &);
270 /** Opens a raw resource, without interpreting it as object data. Null is
271 returned if no such file is found. The caller must dispose of the returned
272 object when done with it. */
273 IO::Seekable *open_raw(const std::string &) const;
276 IO::Seekable *open_from_sources(const std::string &n) { return open_raw(n); }
279 void gather_names_from_sources(std::list<std::string> &, const CollectionItemTypeBase &) const;
281 void load_items_from_sources(const CollectionItemTypeBase &);
284 /** Sets a fallback collection, which will be consulted if an item is not
286 void set_fallback(Collection *);
290 class Collection::ItemLoader<T, false>: public T::Loader
293 ItemLoader(T &o, Collection &):
299 class Collection::ItemLoader<T, true>: public T::Loader
302 ItemLoader(T &o, Collection &c):
303 T::Loader(o, dynamic_cast<typename T::Loader::Collection &>(c))
308 class CollectionItemTypeBase
313 virtual ~ExtractorBase() { }
317 struct Extractor: ExtractorBase
319 virtual T &extract(const Variant &) const = 0;
323 std::vector<std::string> suffixes;
324 std::vector<ExtractorBase *> extractors;
326 CollectionItemTypeBase() { }
328 virtual ~CollectionItemTypeBase();
330 void set_keyword(const std::string &);
331 const std::string &get_keyword() const { return kwd; }
332 void add_suffix(const std::string &);
333 bool match_name(const std::string &) const;
334 virtual bool is_same_type(const CollectionItemTypeBase &) const = 0;
335 virtual bool check_item_type(const Variant &) const = 0;
336 virtual void add_to_loader(Collection::Loader &) const = 0;
337 virtual bool can_create() const = 0;
338 virtual void create_item(Collection &, const std::string &) const = 0;
339 virtual void load_item(Collection &, Parser &, const std::string &) const = 0;
342 bool can_extract() const
344 for(std::vector<ExtractorBase *>::const_iterator i=extractors.begin(); i!=extractors.end(); ++i)
345 if(dynamic_cast<Extractor<T> *>(*i))
351 T *extract(const Variant &var) const
353 for(std::vector<ExtractorBase *>::const_iterator i=extractors.begin(); i!=extractors.end(); ++i)
354 if(Extractor<T> *ex = dynamic_cast<Extractor<T> *>(*i))
355 return &ex->extract(var);
362 Describes a type of item that can be loaded by a Collection. These are created
363 by Collection::add_type.
366 class CollectionItemType: public CollectionItemTypeBase
371 virtual ~CreatorBase() { }
373 virtual T *create(Collection &, const std::string &) const = 0;
377 struct Creator: CreatorBase
379 typedef T *(C::*FuncPtr)(const std::string &);
383 Creator(FuncPtr f): func(f) { }
385 virtual T *create(Collection &coll, const std::string &name) const
386 { return (dynamic_cast<C &>(coll).*func)(name); }
390 struct Extractor: CollectionItemTypeBase::Extractor<B>
392 virtual B &extract(const Variant &var) const
393 { return *var.value<RefPtr<T> >(); }
399 CollectionItemType():
403 ~CollectionItemType()
408 /** Sets a datafile keyword for this item type. The Collection's loader
409 will accept a statement with this keyword and a single string argument - the
411 CollectionItemType &keyword(const std::string &k)
417 /** Adds a suffix that is used to match names when looking for future
418 objects. There is no implied separator; a name matches if it ends with the
419 suffix. If a keyword is defined before any suffixes, then "."+keyword is
420 added as a suffix. */
421 CollectionItemType &suffix(const std::string &s)
427 /** Attaches a creator function to this item type. If an item is not found
428 in the Collection, the creator function for its type is called to create it.
429 The function must be a member of the Collection subclass containing the
430 type. It must return the created object, or null if it could not be
431 created. It's also permissible to load the item via other means and then
434 CollectionItemType &creator(T *(C::*func)(const std::string &))
437 creat = new Creator<C>(func);
441 /** Makes items of this type available through a base class. */
443 CollectionItemType &base()
445 extractors.push_back(new Extractor<B>);
449 virtual bool is_same_type(const CollectionItemTypeBase &other) const
450 { return dynamic_cast<const CollectionItemType<T> *>(&other); }
452 virtual bool check_item_type(const Variant &var) const
453 { return var.check_type<RefPtr<T> >(); }
455 virtual void add_to_loader(Collection::Loader &loader) const
456 { loader.add(kwd, &Collection::Loader::item<T, T>); }
458 virtual bool can_create() const
461 virtual void create_item(Collection &coll, const std::string &name) const
464 throw std::runtime_error("no creator");
465 T *obj = creat->create(coll, name);
470 virtual void load_item(Collection &coll, Parser &parser, const std::string &name) const
472 RefPtr<T> obj = new T;
473 Collection::ItemLoader<T> ldr(*obj, coll);
475 coll.add(name, obj.get());
482 T &Collection::extract(const Variant &var) const
484 if(!var.check_type<RefPtr<T> >())
485 if(CollectionItemTypeBase *type = get_type_for_item(var))
486 if(T *item = type->extract<T>(var))
489 return *var.value<RefPtr<T> >();
493 CollectionItemType<T> &Collection::add_type()
495 CollectionItemType<T> *type = new CollectionItemType<T>;
496 types.push_back(type);
501 CollectionItemTypeBase *Collection::get_type() const
503 for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j)
504 if(dynamic_cast<CollectionItemType<T> *>(*j))
506 for(TypeList::const_iterator j=types.begin(); j!=types.end(); ++j)
507 if((*j)->can_extract<T>())
512 } // namespace DataFile