1 #ifndef MSP_DATAFILE_PACKSOURCE_H_
2 #define MSP_DATAFILE_PACKSOURCE_H_
4 #include <msp/core/refptr.h>
5 #include "collectionsource.h"
6 #include "objectloader.h"
12 A source that loads data from pack files. As opposed to plain collection
13 files, pack files are composed from a number of logical files. They also
14 contain an index of objects contained in the pack and which logical files they
15 are in. This allows the pack to be loaded in a piecewise manner instead of all
18 It's possible for a pack file to contain plain collection files as well. When
19 an object from such a file is requested, the entire sub-collection it is stored
22 class PackSource: public CollectionSource
28 typedef std::map<std::string, const Object *> ObjectMap;
33 class Loader: public ObjectLoader<Pack>
38 void file(const std::string &);
44 std::list<File> files;
47 Pack(const std::string &);
49 const std::string &get_filename() const { return filename; }
50 unsigned get_base_offset() const { return base_offset; }
52 void collect_objects(ObjectMap &) const;
58 class Loader: public ObjectLoader<File>
63 virtual void finish();
64 void object(const std::string &, const std::string &);
73 std::list<Object> objects;
77 File(const Pack &, const std::string &);
79 RefPtr<IO::Base> open() const;
80 const std::string &get_filename() const { return filename; }
81 std::string get_full_name() const;
82 bool is_collection() const { return collection; }
85 bool is_loaded() const { return loaded; }
87 void collect_objects(ObjectMap &) const;
98 Object(File &, const std::string &, const std::string &);
100 File &get_file() const { return file; }
101 const std::string &get_name() const { return name; }
102 const std::string &get_keyword() const { return keyword; }
105 std::list<Pack> packs;
109 /// Adds a pack file to load objects from. The index is read immediately.
110 void add_pack_file(const std::string &);
113 virtual bool is_loadable(const CollectionItemTypeBase &, const std::string &) const;
114 virtual NameList get_names(const CollectionItemTypeBase &) const;
115 virtual void load(Collection &, const CollectionItemTypeBase &, const std::string &) const;
118 } // namespace DataFile