aboutsummaryrefslogtreecommitdiff
path: root/common/archive.h
diff options
context:
space:
mode:
authorJohannes Schickel2010-10-13 03:57:44 +0000
committerJohannes Schickel2010-10-13 03:57:44 +0000
commit75e8452b6e6a2bf4fb2f588aa00b428a60d873b5 (patch)
treef29541d55309487a94bd1d38e8b53bb3dde9aec6 /common/archive.h
parent48ee83b88957dab86bc763e9ef21a70179fa8679 (diff)
parente9f50882ea5b6beeefa994040be9d3bab6a1f107 (diff)
downloadscummvm-rg350-75e8452b6e6a2bf4fb2f588aa00b428a60d873b5.tar.gz
scummvm-rg350-75e8452b6e6a2bf4fb2f588aa00b428a60d873b5.tar.bz2
scummvm-rg350-75e8452b6e6a2bf4fb2f588aa00b428a60d873b5.zip
OPENGL: Merged from trunk, from rev 52105 to 53396.
This includes an rather hacky attempt to merge all the recent gp2x backend changes into the branch. I suppose the gp2x backend and probably all new backends, i.e. gph, dingux etc., might not compile anymore. Since I have no way of testing those it would be nice if porters could look into getting those up to speed in this branch. svn-id: r53399
Diffstat (limited to 'common/archive.h')
-rw-r--r--common/archive.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/common/archive.h b/common/archive.h
index 1cc983f77b..c12ca79be0 100644
--- a/common/archive.h
+++ b/common/archive.h
@@ -79,7 +79,8 @@ public:
/**
- * Archive allows searches of (file)names into an arbitrary container.
+ * Archive allows managing of member of arbitrary containers in a uniform
+ * fashion, allowing lookup by (file)names.
* It also supports opening a file and returning an usable input stream.
*/
class Archive {
@@ -87,24 +88,23 @@ public:
virtual ~Archive() { }
/**
- * Check if a name is present in the Archive. Patterns are not allowed,
- * as this is meant to be a quick File::exists() replacement.
+ * Check if a member with the given name is present in the Archive.
+ * Patterns are not allowed, as this is meant to be a quick File::exists()
+ * replacement.
*/
virtual bool hasFile(const String &name) = 0;
/**
- * Add all the names present in the Archive which match pattern to
- * list. Returned names can be used as parameters to createReadStreamForMember.
- * Must not remove elements from the list.
+ * Add all members of the Archive matching the specified pattern to list.
+ * Must only append to list, and not remove elements from it.
*
- * @return the number of names added to list
+ * @return the number of members added to list
*/
virtual int listMatchingMembers(ArchiveMemberList &list, const String &pattern);
/**
- * Add all the names present in the Archive to list. Returned
- * names can be used as parameters to createReadStreamForMember.
- * Must not remove elements from the list.
+ * Add all members of the Archive to list.
+ * Must only append to list, and not remove elements from it.
*
* @return the number of names added to list
*/
@@ -116,8 +116,8 @@ public:
virtual ArchiveMemberPtr getMember(const String &name) = 0;
/**
- * Create a stream bound to a member in the archive. If no member with the
- * specified name exists, then 0 is returned.
+ * Create a stream bound to a member with the specified name in the
+ * archive. If no member with this name exists, 0 is returned.
* @return the newly created input stream
*/
virtual SeekableReadStream *createReadStreamForMember(const String &name) const = 0;