ScummVM API documentation
xarc.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef STARK_ARCHIVE_H
23 #define STARK_ARCHIVE_H
24 
25 #include "common/archive.h"
26 #include "common/stream.h"
27 
28 namespace Stark {
29 namespace Formats {
30 
31 class XARCMember;
32 
33 class XARCArchive : public Common::Archive {
34 public:
35  bool open(const Common::Path &filename);
36  Common::Path getFilename() const;
37 
38  // Archive API
39  bool hasFile(const Common::Path &path) const;
40  int listMatchingMembers(Common::ArchiveMemberList &list, const Common::Path &pattern, bool matchPathComponents = false) const;
41  int listMembers(Common::ArchiveMemberList &list) const;
42  const Common::ArchiveMemberPtr getMember(const Common::Path &path) const;
44 
45  Common::SeekableReadStream *createReadStreamForMember(const XARCMember *member) const;
46 
47 private:
48  Common::Path _filename;
50 };
51 
52 } // End of namespace Formats
53 } // End of namespace Stark
54 
55 #endif // STARK_ARCHIVE_H
Common::SeekableReadStream * createReadStreamForMember(const Common::Path &path) const
const Common::ArchiveMemberPtr getMember(const Common::Path &path) const
Definition: list.h:44
Definition: path.h:52
Definition: stream.h:745
Definition: archive.h:141
Definition: xarc.h:33
int listMatchingMembers(Common::ArchiveMemberList &list, const Common::Path &pattern, bool matchPathComponents=false) const
Definition: console.h:27
bool hasFile(const Common::Path &path) const
int listMembers(Common::ArchiveMemberList &list) const