kmmsgdict.h

/*
 * This file is part of KMail, the KDE mail client
 * Copyright (c)  Ronen Tzur <rtzur@shani.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.
 *
 */
#ifndef __KMMSGDICT
#define __KMMSGDICT
 
#include <tqvaluelist.h>
#include <tqptrlist.h>
 
class KMFolder;
class KMMsgBase;
class KMMessage;
class KMMsgDictEntry;
class KMMsgDictREntry;
class KMDict;
class TQString;
class FolderStorage;

class KMMsgDict
{
  template<class> friend class KStaticDeleter;
  public:
    static const KMMsgDict* instance();

    void getLocation( unsigned long key, KMFolder **retFolder, int *retIndex ) const;
    void getLocation( const KMMsgBase *msg, KMFolder **retFolder, int *retIndex ) const;
    void getLocation( const KMMessage *msg, KMFolder **retFolder, int *retIndex ) const;

    unsigned long getMsgSerNum( KMFolder *folder, int index ) const;

    static TQValueList<unsigned long> serNumList(TQPtrList<KMMsgBase> msgList);
 
private:
 /* FIXME It would be better to do without these, they are the classes
  * involved in filling and maintaining the dict. The MsgList needs access
  * because of things it does that should be in FolderIndex, probably, which
  * the message list is an implementation detail of. */
  friend class FolderStorage;
  friend class KMMsgList;
  friend class KMFolderIndex;
 
  // Access for those altering the dict, our friend classes
  static KMMsgDict* mutableInstance();

  unsigned long insert(unsigned long msgSerNum, const KMMsgBase *msg, int index = -1);

  unsigned long insert(const KMMsgBase *msg, int index = -1);

  void replace(unsigned long msgSerNum,
               const KMMsgBase *msg, int index = -1);

  void remove(unsigned long msgSerNum);

  unsigned long remove(const KMMsgBase *msg);

  void update(const KMMsgBase *msg, int index, int newIndex);
 
 
  // ----- per folder serial number on-disk structure handling ("ids files")
  
  static TQString getFolderIdsLocation( const FolderStorage &folder );

  bool isFolderIdsOutdated( const FolderStorage &folder );

  int readFolderIds( FolderStorage & );

  int writeFolderIds( const FolderStorage & );

  int touchFolderIds( const FolderStorage & );

  int appendToFolderIds( FolderStorage&, int index );

  bool hasFolderIds( const FolderStorage & );

  bool removeFolderIds( FolderStorage & );

  KMMsgDictREntry *openFolderIds( const FolderStorage &, bool truncate);
 
 
  // --------- helpers ------------

  static void deleteRentry(KMMsgDictREntry *entry);

  unsigned long getNextMsgSerNum();
 
  // prevent creation and deletion, we are a singleton
  KMMsgDict();
  ~KMMsgDict();

  unsigned long nextMsgSerNum;

  KMDict *dict;

  static KMMsgDict *m_self;
};
 
#endif /* __KMMSGDICT */