Ticket #8904: archivemember.patch

archive.cpp

@@ -30 +30 @@
 namespace Common {
 
 
-int Archive::matchPattern(StringList &list, const String &pattern) {
+int Archive::matchPattern(ArchiveMemberList &list, const String &pattern) {
         // Get all "names" (TODO: "files" ?)
-        StringList allNames;
+        ArchiveMemberList allNames;
         getAllNames(allNames);
 
         int matches = 0;
@@ -41 +41 @@
         String lowercasePattern = pattern;
         lowercasePattern.toLowercase();
 
-        StringList::iterator it = allNames.begin();
+        ArchiveMemberList::iterator it = allNames.begin();
         for ( ; it != allNames.end(); it++) {
-                if (it->matchString(lowercasePattern)) {
+                if ((*it)->getName().matchString(lowercasePattern)) {
                         list.push_back(*it);
                         matches++;
                 }
@@ -52 +52 @@
         return matches;
 }
 
+/**
+ *  FSDirectoryMemeber is the implementation of ArchiveMember used by
+ *  by FSDirectory. It is right now a light wrapper or FSNode.
+ */
+class FSDirectoryMember : public ArchiveMember {
+        FilesystemNode  _node;
 
+public:
+        FSDirectoryMember(FilesystemNode &node) : _node(node) {
+        }
+
+        /*
+                NOTE/FIXME: since I assume that the only use case for getName()
+                is for error messages, I am returning the full path of the node
+                here. This seems better than we did before, when matchPattern
+                and getAllNames used to work with StringList, and we used to
+                put the relative path of the file to the list instead.
+        */
+        String getName() const {
+                return _node.getPath();
+        }
+
+        SeekableReadStream *open() {
+                return _node.openForReading();
+        }
+};
+
+typedef SharedPtr<FSDirectoryMember> FSDirectoryMemberPtr;
+
+
 FSDirectory::FSDirectory(const FilesystemNode &node, int depth)
   : _node(node), _cached(false), _depth(depth) {
 }
@@ -159 +188 @@
 
 }
 
-int FSDirectory::getAllNames(StringList &list) {
+int FSDirectory::getAllNames(ArchiveMemberList &list) {
         if (!_node.isDirectory())
                 return 0;
 
@@ -169 +198 @@
                 _cached = true;
         }
 
-        // Small optimization: Ensure the StringList has to grow at most once
-        list.reserve(list.size() + _fileCache.size());
-        
         // Add all filenames from our cache
         NodeCache::iterator it = _fileCache.begin();
         for ( ; it != _fileCache.end(); it++) {
-                list.push_back((*it)._key);
+                list.push_back(FSDirectoryMemberPtr(new FSDirectoryMember((*it)._value)));
         }
-        
+
         return _fileCache.size();
 }
 
 
 
+
+
 SearchSet::ArchiveList::iterator SearchSet::find(const String &name) const {
         ArchiveList::iterator it = _list.begin();
         for ( ; it != _list.end(); it++) {
@@ -265 +293 @@
         return false;
 }
 
-int SearchSet::matchPattern(StringList &list, const String &pattern) {
+int SearchSet::matchPattern(ArchiveMemberList &list, const String &pattern) {
         // Shall we short circuit out if pattern is empty?
 
         int matches = 0;
@@ -278 +306 @@
         return matches;
 }
 
+
 SeekableReadStream *SearchSet::openFile(const String &name) {
         if (name.empty()) {
                 return 0;

archive.h

@@ -37 +37 @@
 namespace Common {
 
 /**
+ * ArchiveMember is the base class for the objects returned when Archive
+ * is searched using matchPattern() or getAllNames(), thus - possibly -
+ * yielding multiple matches.
+ */
+class ArchiveMember {
+public:
+        virtual ~ArchiveMember() { }
+
+        /**
+         * Return a name (or description) of the instance.
+         */
+        virtual String getName() const = 0;
+
+        /**
+         * Open the underlying file/handle/entity for reading.
+         */
+        virtual SeekableReadStream *open() = 0;
+};
+
+typedef List<SharedPtr<ArchiveMember> > ArchiveMemberList;
+
+
+/**
  * FilePtr is a convenient way to keep track of a SeekableReadStream without
  * having to worry about releasing its memory.
  */
@@ -57 +80 @@
         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 openFile.
+         * Add all the objects present in the Archive which match pattern to
+         * list.
          * Must not remove elements from the list.
          *
          * @return the number of names added to list
          */
-        virtual int matchPattern(StringList &list, const String &pattern);
+        virtual int matchPattern(ArchiveMemberList &list, const String &pattern);
 
         /**
-         * Add all the names present in the Archive to list. Returned
-         * names can be used as parameters to openFile.
+         * Add all the names present in the Archive to list.
          * Must not remove elements from the list.
          *
          * @return the number of names added to list
          */
-        virtual int getAllNames(StringList &list) = 0;
+        virtual int getAllNames(ArchiveMemberList &list) = 0;
 
         /**
          * Create a stream bound to a file in the archive.
@@ -138 +160 @@
         FSDirectory *getSubDirectory(const String &name);
 
         virtual bool hasFile(const String &name);
-        virtual int getAllNames(StringList &list);
+        virtual int getAllNames(ArchiveMemberList &list);
         virtual SeekableReadStream *openFile(const String &name);
 };
 
@@ -191 +213 @@
         void setPriority(const String& name, uint priority);
 
         virtual bool hasFile(const String &name);
-        virtual int matchPattern(StringList &list, const String &pattern);
-        virtual int getAllNames(StringList &list) {
+        virtual int matchPattern(ArchiveMemberList &list, const String &pattern);
+        virtual int getAllNames(ArchiveMemberList &list) {
                 return matchPattern(list, "*");
         }
 
@@ -239 +261 @@
 
 
         virtual bool hasFile(const String &name);
-        virtual int getAllNames(StringList &list) {
+        virtual int getAllNames(ArchiveMemberList &list) {
                 return matchPattern(list, "*");
         }