common/unarj.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
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (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, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  *
  21  * $URL$
  22  * $Id$
  23  *
  24  */
  25
  26 #ifndef COMMON_UNARJ_H
  27 #define COMMON_UNARJ_H
  28
  29 #include "common/file.h"
  30 #include "common/hash-str.h"
  31
  32 namespace Common {
  33
  34 struct ArjHeader;
  35
  36 typedef HashMap<String, int, IgnoreCase_Hash, IgnoreCase_EqualTo> ArjFilesMap;
  37
  38 // TODO: Get rid of this class, by implementing an ArjArchive subclass of Common::Archive.
  39 // Then ArjFile can be substituted by a SearchSet full of ArjArchives plus SearchMan.
  40 class ArjFile : public SeekableReadStream, public NonCopyable {
  41 public:
  42         ArjFile();
  43         ~ArjFile();
  44
  45         void enableFallback(bool val) { _fallBack = val; }
  46
  47         void registerArchive(const String &filename);
  48
  49         bool open(const Common::String &filename);
  50         void close();
  51
  52         uint32 read(void *dataPtr, uint32 dataSize);
  53         bool eos() const;
  54         int32 pos() const;
  55         int32 size() const;
  56         bool seek(int32 offset, int whence = SEEK_SET);
  57         bool isOpen() { return _uncompressed != 0; }
  58
  59 private:
  60         bool _fallBack;
  61
  62         Array<ArjHeader *> _headers;
  63         ArjFilesMap _fileMap;
  64         StringMap _archMap;
  65
  66         SeekableReadStream *_uncompressed;
  67 };
  68
  69 } // End of namespace Common
  70
  71 #endif