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
35 typedef std::map<std::string, const File *> FileMap;
36 typedef std::map<std::string, const Object *> ObjectMap;
41 class Loader: public ObjectLoader<Pack>
46 void file(const std::string &);
52 IO::SeekOffset base_offset;
53 std::list<File> files;
56 Pack(IO::Seekable *, const std::string &);
58 const std::string &get_filename() const { return filename; }
59 IO::Seekable *get_io() const { return io; }
60 IO::SeekOffset get_base_offset() const { return base_offset; }
62 void collect_files(FileMap &, const std::string &) const;
68 class Loader: public ObjectLoader<File>
73 virtual void finish();
74 void object(const std::string &, const std::string &);
80 IO::SeekOffset offset;
81 IO::SeekOffset length;
83 std::list<Object> objects;
86 File(const Pack &, const std::string &);
88 RefPtr<IO::Seekable> open() const;
89 const std::string &get_filename() const { return filename; }
90 FileInfo get_info() const;
91 std::string get_full_name() const;
92 bool is_collection() const { return collection; }
94 void collect_objects(ObjectMap &) const;
105 Object(File &, const std::string &, const std::string &);
107 File &get_file() const { return file; }
108 const std::string &get_name() const { return name; }
109 const std::string &get_keyword() const { return keyword; }
112 std::list<Pack> packs;
117 /// Adds a pack file to load objects from. The index is read immediately.
118 void add_pack_file(const std::string &);
120 /** Adds a pack file with a regex to filter logical files. The index is
121 read on the first call; subsequent calls will use cached data. */
122 void add_pack_file(const std::string &, const std::string &);
124 /** Adds a pack from an existing seekable I/O object. The same object is
125 used for all accesses to the pack, so it must not be deleted before the
127 void add_pack_io(IO::Seekable &, const std::string & = std::string());
129 /** Adds a pack from an I/O object with a regex to filter logical files.
130 Multiple filters for the same I/O object can be added with repeated calls. */
131 void add_pack_io(IO::Seekable &, const std::string &, const std::string &);
134 void add_pack(IO::Seekable *, const std::string &, const std::string &);
137 /// Returns information about the files in the pack.
138 std::list<FileInfo> list_files() const;
140 virtual bool is_loadable(const CollectionItemTypeBase &, const std::string &) const;
141 virtual NameList get_names(const CollectionItemTypeBase &) const;
142 virtual void load(Collection &, const CollectionItemTypeBase &, const std::string &) const;
143 virtual IO::Seekable *open(const std::string &) const;
146 } // namespace DataFile