F:/KPlato/koffice/libs/store/KoStore.h

Aller à la documentation de ce fichier.

// -*- c-basic-offset: 2 -*-
/* 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 <QString>
#include <QStringList>
#include <QIODevice>
#include <q3valuestack.h>
#include <QByteArray>
#include <koffice_export.h>

class QWidget;

class KUrl;

class KOSTORE_EXPORT KoStore
{
public:

  enum Mode { Read, Write };
  enum Backend { Auto, Tar, Zip, Directory, Encrypted };

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

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

  static KoStore* createStore( QWidget* window, const KUrl& url, Mode mode, const QByteArray & appIdentification = "", Backend backend = Auto );

  virtual ~KoStore();

  bool open( const QString & name );

  bool isOpen() const;

  bool close();

  QIODevice* device() const;

  QByteArray read( qint64 max );

  qint64 write( const QByteArray& _data );

  qint64 read( char *_buffer, qint64 _len );

  virtual qint64 write( const char* _data, qint64 _len );

  qint64 size() const;

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

  Mode mode() const { return m_mode; }

  bool enterDirectory( const QString& directory );

  bool leaveDirectory();

  QString currentPath() const;

  QString currentDirectory() const;


  void pushDirectory();

  void popDirectory();

  bool hasFile( const QString& fileName ) const;

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

  bool addDataToFile( QByteArray &buffer, const QString &destName );

  QStringList addLocalDirectory( const QString &dirPath, const QString &dest );


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

  bool extractFile( const QString &srcName, QByteArray &data );


  bool seek( qint64 pos );
  qint64 pos() const;
  bool atEnd() const;

  void disallowNameExpansion( void );

protected:

  KoStore() {}

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

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

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

  virtual bool fileExists( const QString& absPath ) const = 0;

private:
  static Backend determineBackend( QIODevice* dev );

  QString toExternalNaming( const QString & _internalNaming ) const;

  QString expandEncodedPath( QString intern ) const;

  QString expandEncodedDirectory( QString intern ) const;

  mutable enum
  {
      NAMING_VERSION_2_1,
      NAMING_VERSION_2_2,
      NAMING_VERSION_RAW  
  } m_namingVersion;

  bool enterDirectoryInternal( const QString& directory );

  bool extractFile( const QString &srcName, QIODevice &buffer );

protected:

  Mode m_mode;

  QStringList m_strFiles;

  QStringList m_currentPath;

  QString m_sName;
  qint64 m_iSize;

  QIODevice * m_stream;

  bool m_bIsOpen;
  bool m_bGood;

  static const int s_area;

private:
  Q3ValueStack<QString> m_directoryStack;

private:
  KoStore( const KoStore& store );  
  KoStore& operator=( const KoStore& store );  

  class Private;
  Private * d;

};

#endif

---