KoStore.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 David Faure <faure@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef __koStore_h_
#define __koStore_h_
 
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqiodevice.h>
#include <tqvaluestack.h>
#include <koffice_export.h>
 
class TQWidget;
 
class KURL;

class KOSTORE_EXPORT KoStore
{
public:
 
  enum Mode { Read, Write };
  enum Backend { Auto, Tar, Zip, Directory };

  static KoStore* createStore( const TQString& fileName, Mode mode, const TQCString & appIdentification = "", Backend backend = Auto );

  static KoStore* createStore( TQIODevice *device, Mode mode, const TQCString & appIdentification = "", Backend backend = Auto );

  static KoStore* createStore( TQWidget* window, const KURL& url, Mode mode, const TQCString & appIdentification = "", Backend backend = Auto );

  virtual ~KoStore();

  bool open( const TQString & name );

  bool isOpen() const;

  bool close();

  TQIODevice* device() const;

  TQByteArray read( unsigned long int max );

  TQ_LONG write( const TQByteArray& _data );

  TQ_LONG read( char *_buffer, TQ_ULONG _len );

  virtual TQ_LONG write( const char* _data, TQ_ULONG _len );

  TQIODevice::Offset size() const;

  bool bad() const { return !m_bGood; } // :)

  Mode mode() const { return m_mode; }

  bool enterDirectory( const TQString& directory );

  bool leaveDirectory();

  TQString currentPath() const;

  TQString currentDirectory() const;
 

  void pushDirectory();

  void popDirectory();

  bool hasFile( const TQString& fileName ) const;

  bool addLocalFile( const TQString &fileName, const TQString &destName );

  TQStringList addLocalDirectory( const TQString &dirPath, const TQString &dest );
 

  bool extractFile( const TQString &srcName, const TQString &fileName );


  bool at( TQIODevice::Offset pos );
  TQIODevice::Offset at() const;
  bool atEnd() const;

  void disallowNameExpansion( void );
 
protected:
 
  KoStore() {}

  virtual bool init( Mode mode );
  virtual bool openWrite( const TQString& name ) = 0;
  virtual bool openRead( const TQString& name ) = 0;

  virtual bool closeRead() = 0;
  virtual bool closeWrite() = 0;

  virtual bool enterRelativeDirectory( const TQString& dirName ) = 0;
  virtual bool enterAbsoluteDirectory( const TQString& path ) = 0;

  virtual bool fileExists( const TQString& absPath ) const = 0;
 
private:
  static Backend determineBackend( TQIODevice* dev );

  TQString toExternalNaming( const TQString & _internalNaming ) const;

  TQString expandEncodedPath( TQString intern ) const;

  TQString expandEncodedDirectory( TQString intern ) const;
 
  mutable enum
  {
      NAMING_VERSION_2_1,
      NAMING_VERSION_2_2,
      NAMING_VERSION_RAW  
  } m_namingVersion;

  bool enterDirectoryInternal( const TQString& directory );
 
protected:
 
  Mode m_mode;

  TQStringList m_strFiles;

  TQStringList m_currentPath;

  TQValueStack<TQString> m_directoryStack;

  TQString m_sName;
  TQIODevice::Offset m_iSize;

  TQIODevice * m_stream;
 
  bool m_bIsOpen;
  bool m_bGood;
 
  static const int s_area;
 
private:
  KoStore( const KoStore& store );  
  KoStore& operator=( const KoStore& store );  
 
  class Private;
  Private * d;
 
};
 
#endif