logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

zipios::CollectionCollection

Author

       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++                                         Tue Mar 24 2020                 zipios::CollectionCollection(3)

Constructor & Destructor Documentation

zipios::CollectionCollection::CollectionCollection()[explicit]
       Constructor.

       Definition at line 16 of file collcoll.cpp.

   zipios::CollectionCollection::CollectionCollection(constCollectionCollection&src)[inline]
       Copy constructor.

       Definition at line 118 of file collcoll.h.

Detailed Description

CollectionCollection is a FileCollection that consists of an arbitrary number of FileCollections. With a
       CollectionCollection the user can use multiple FileCollections transparently, making it easy for a
       program to keep some of its files in a zip archive and others stored in ordinary files.
       CollectionCollection can be used to create a simple virtual filesystem, where all collections are mounted
       in /. If more than one collection contain a file with the same path only the one in the first added
       collection will be accessible.

       Definition at line 26 of file collcoll.h.

Member Function Documentation

boolzipios::CollectionCollection::addCollection(constFileCollection&collection)
       Adds a collection.

       Parameterscollection The collection to add.

       Returns
           true if the collection was added succesfully and the added collection is valid.

       Definition at line 21 of file collcoll.cpp.

   boolzipios::CollectionCollection::addCollection(FileCollection*collection)
       Adds the collection pointed to by collection. The CollectionCollection will call delete on the pointer
       when it is destructed, so the caller should make absolutely sure to only pass in a collection created
       with new and be sure to leave it alone after adding it. If the collection is not added false is returned
       and the caller remains responsible for the collection pointed to by collection.

       Parameterscollection A pointer to the collection to add.

       Returns
           true if the collection was added succesfully and the added collection is valid.

       Definition at line 31 of file collcoll.cpp.

   FileCollection*zipios::CollectionCollection::clone()const[virtual]
       Create a heap allocated clone of the object this method is called for. The caller is responsible for
       deallocating the clone when he is done with it.

       Returns
           A heap allocated copy of the object this method is called for.

       Implements zipios::FileCollection.

       Definition at line 108 of file collcoll.cpp.

   voidzipios::CollectionCollection::close()[virtual]
       Closes the FileCollection.

       Implements zipios::FileCollection.

       Definition at line 41 of file collcoll.cpp.

   ConstEntrieszipios::CollectionCollection::entries()const[virtual]
       Returns a vector of const pointers to the entries in the FileCollection.

       Returns
           a ConstEntries containing the entries of the FileCollection.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented from zipios::FileCollection.

       Definition at line 46 of file collcoll.cpp.

   voidzipios::CollectionCollection::getEntry(conststring&name,ConstEntryPointer&cep,std::vector<FileCollection*>::const_iterator&it,MatchPathmatchpath=MATCH)const[protected]
       A protected getEntry member function, that not only finds an entry that match the name, if such an entry
       exists in the collection, it also returns, which collection it was found in.

       Definition at line 123 of file collcoll.cpp.

   ConstEntryPointerzipios::CollectionCollection::getEntry(conststring&name,MatchPathmatchpath=MATCH)const[virtual]
       Returns a ConstEntryPointer to a FileEntry object for the entry with the specified name. To ignore the
       path part of the filename in search of a match, specify FileCollection::IGNORE as the second argument.

       Parametersname A string containing the name of the entry to get.
           matchpath Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be
           ignored.

       Returns
           A ConstEntryPointer to the found entry. The returned pointer equals zero if no entry is found.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Reimplemented from zipios::FileCollection.

       Definition at line 58 of file collcoll.cpp.

   istream*zipios::CollectionCollection::getInputStream(constConstEntryPointer&entry)[virtual]
       Returns a pointer to an opened istream for the specified FileEntry. It is the callers responsibility to
       delete the stream when he is done with it. Returns 0, if there is no such FileEntry in the
       FileCollection.

       Parametersentry A ConstEntryPointer to the FileEntry to get an istream to.

       Returns
           an open istream for the specified entry. The istream is allocated on heap and it is the users
           responsibility to delete it when he is done with it.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implements zipios::FileCollection.

       Definition at line 72 of file collcoll.cpp.

   istream*zipios::CollectionCollection::getInputStream(conststring&entry_name,MatchPathmatchpath=MATCH)[virtual]
       Returns a pointer to an opened istream for the specified entry name. It is the callers responsibility to
       delete the stream when he is done with it. Returns 0, if there is no entry with the specified name in the
       FileCollection.

       Parametersmatchpath Speficy MATCH, if the path should match as well, specify IGNORE, if the path should be
           ignored.

       Returns
           an open istream for the specified entry. The istream is allocated on heap and it is the users
           responsibility to delete it when he is done with it.

       ExceptionsInvalidStateExceptionThrownifthecollectionisinvalid.

       Implements zipios::FileCollection.

       Definition at line 80 of file collcoll.cpp.

   CollectionCollection&zipios::CollectionCollection::inst()[inline],[static]
       This static method provides a singleton instance of a CollectionCollection. The instance is instantiated
       the first time the method is called.

       Returns
           A pointer to a singleton CollectionCollection instance.

       Definition at line 111 of file collcoll.h.

   constCollectionCollection&zipios::CollectionCollection::operator=(constCollectionCollection&src)[inline]
       Copy assignment operator.

       Definition at line 129 of file collcoll.h.

   intzipios::CollectionCollection::size()const[virtual]
       Returns the number in entries in all collections kept by the CollectionCollection object.

       Reimplemented from zipios::FileCollection.

       Definition at line 98 of file collcoll.cpp.

Name

       zipios::CollectionCollection

Synopsis

       #include <collcoll.h>

       Inherits zipios::FileCollection.

   PublicMemberFunctionsCollectionCollection ()
           Constructor.
       CollectionCollection (const CollectionCollection &src)
           Copy constructor.
       const CollectionCollection & operator= (const CollectionCollection &src)
           Copy assignment operator.
       bool addCollection (const FileCollection &collection)
       bool addCollection (FileCollection *collection)
           Adds the collection pointed to by collection.
       virtual void close ()
           Closes the FileCollection.
       virtual ConstEntriesentries () const
       virtual ConstEntryPointergetEntry (const string &name, MatchPath matchpath=MATCH) const
       virtual istream * getInputStream (const ConstEntryPointer &entry)
       virtual istream * getInputStream (const string &entry_name, MatchPath matchpath=MATCH)
           Returns a pointer to an opened istream for the specified entry name.
       virtual int size () const
           Returns the number in entries in all collections kept by the CollectionCollection object.
       virtual FileCollection * clone () const
           Create a heap allocated clone of the object this method is called for.

   StaticPublicMemberFunctions
       static CollectionCollection & inst ()

   ProtectedMemberFunctions
       void getEntry (const string &name, ConstEntryPointer &cep, std::vector< FileCollection *
           >::const_iterator &it, MatchPath matchpath=MATCH) const
           A protected getEntry member function, that not only finds an entry that match the name, if such an
           entry exists in the collection, it also returns, which collection it was found in.

   ProtectedAttributes
       vector< FileCollection * > _collectionsAdditionalInheritedMembers

See Also