kmfolderindex.h

/*
    This file is part of KMail, the KDE mail client.
    Copyright (c) 2000 Don Sanders <sanders@kde.org>
 
    KMail is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License, version 2, as
    published by the Free Software Foundation.
 
    KMail 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
    General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
// Virtual base class for mail folder with .*.index style index
 
#ifndef kmfolderindex_h
#define kmfolderindex_h
 
#include "folderstorage.h"
#include "kmmsglist.h"
 
class KMFolderIndex: public FolderStorage
{
  TQ_OBJECT
  
  //TODO:Have to get rid of this friend declaration and add necessary pure
  //virtuals to kmfolder.h so that KMMsgBase::parent() can be a plain KMFolder
  //rather than a KMFolderIndex. Need this for database indices.
  friend class ::KMMsgBase;
public:
 
  enum IndexStatus { IndexOk,
                     IndexMissing,
                     IndexCorrupt,
                     IndexTooOld
  };
 
  KMFolderIndex(KMFolder* folder, const char* name=0);
  virtual ~KMFolderIndex();
  virtual int count(bool cache = false) const;
 
  virtual KMMsgBase* takeIndexEntry( int idx ) { return mMsgList.take( idx ); }
  virtual KMMsgInfo* setIndexEntry( int idx, KMMessage *msg );
  virtual void clearIndex(bool autoDelete=true, bool syncDict = false);
  virtual void truncateIndex();
 
  virtual const KMMsgBase* getMsgBase(int idx) const { return mMsgList[idx]; }
  virtual KMMsgBase* getMsgBase(int idx) { return mMsgList[idx]; }
 
  virtual int find(const KMMsgBase* msg) const { return mMsgList.find((KMMsgBase*)msg); }
  int find( const KMMessage * msg ) const { return FolderStorage::find( msg ); }
 
  int serialIndexId() const { return mIndexId; }
 
  uchar *indexStreamBasePtr() { return mIndexStreamPtr; }
 
  bool indexSwapByteOrder() { return mIndexSwapByteOrder; }
  int  indexSizeOfLong() { return mIndexSizeOfLong; }
 
  virtual TQString indexLocation() const;
  virtual int writeIndex( bool createEmptyIndex = false );
 
  void recreateIndex( bool readIndexAfterwards = true );
  void silentlyRecreateIndex();
 
  virtual IndexStatus indexStatus() = 0;
 
public slots:
  virtual int updateIndex();
 
protected:
  bool readIndex();
 
  bool readIndexHeader(int *gv=0);
 
  virtual int createIndexFromContents() = 0;
 
  bool updateIndexStreamPtr(bool just_close=FALSE);
 
  virtual void fillMessageDict();
 
  FILE* mIndexStream;
  KMMsgList mMsgList;
 
  off_t mHeaderOffset;
 
  uchar *mIndexStreamPtr;
  int mIndexStreamPtrLength, mIndexId;
  bool mIndexSwapByteOrder; // Index file was written with swapped byte order
  int mIndexSizeOfLong; // Index file was written with longs of this size
 
private:
  void updateInvitationAndAddressFieldsFromContents();
 
};
 
#endif /*kmfolderindex_h*/