model_p.h

Go to the documentation of this file.

/******************************************************************************
 *
 *  Copyright 2008 Szymon Tomasz Stefanek <pragma@kvirc.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 __MESSAGELIST_CORE_MODEL_P_H__
#define __MESSAGELIST_CORE_MODEL_P_H__

#include "model.h"
#include <config-messagelist.h>

namespace MessageList
{

namespace Core
{

class ModelPrivate
{
public:
  ModelPrivate( Model *owner ) : q( owner ) { }

  void fillView();

  void checkIfDateChanged();

  void viewItemJobStep();

  MessageItem * findMessageParent( MessageItem *mi );
  MessageItem * guessMessageParent( MessageItem *mi );

  void attachMessageToParent( Item *pParent, MessageItem *mi );
  void messageDetachedUpdateParentProperties( Item *oldParent, MessageItem *mi );
  void attachMessageToGroupHeader( MessageItem *mi );
  void attachGroup( GroupHeaderItem *ghi );

  enum ViewItemJobResult
  {
    ViewItemJobCompleted,
    ViewItemJobInterrupted
  };
  ViewItemJobResult viewItemJobStepInternal();
  ViewItemJobResult viewItemJobStepInternalForJob( ViewItemJob *job, const QTime &tStart );

  // FIXME: Those look like they should be made virtual in some job class! -> Refactor
  ViewItemJobResult viewItemJobStepInternalForJobPass1Fill( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass1Cleanup( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass1Update( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass2( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass3( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass4( ViewItemJob *job, const QTime &tStart );
  ViewItemJobResult viewItemJobStepInternalForJobPass5( ViewItemJob *job, const QTime &tStart );
  void clearJobList();
  void clearUnassignedMessageLists();
  void clearOrphanChildrenHash();
  void clearThreadingCacheMessageSubjectMD5ToMessageItem();
  void addMessageToSubjectBasedThreadingCache( MessageItem * mi );
  void removeMessageFromSubjectBasedThreadingCache( MessageItem * mi );
  void clear();
  void syncExpandedStateOfSubtree( Item *root );
  void saveExpandedStateOfSubtree( Item *root );

#ifdef KDEPIM_FOLDEROPEN_PROFILE
  // This prints out all the stats we collected
  void printStatistics();
#endif

  enum PropertyChanges
  {
    DateChanged = 1,
    MaxDateChanged = (1 << 1),
    ActionItemStatusChanged = (1 << 2),
    UnreadStatusChanged = (1 << 3),
    ImportantStatusChanged = (1 << 4)
  };

  bool handleItemPropertyChanges( int propertyChangeMask, Item * parent, Item * item );

  void propagateItemPropertiesToParent( Item * item );

  bool applyFilterToSubtree( Item * item, const QModelIndex &parentIndex );


  // Slots connected to the underlying StorageModel.

  void slotStorageModelRowsInserted( const QModelIndex &parent, int from, int to );
  void slotStorageModelRowsRemoved( const QModelIndex &parent, int from, int to );
  void slotStorageModelDataChanged( const QModelIndex &fromIndex, const QModelIndex &toIndex );
  void slotStorageModelHeaderDataChanged( Qt::Orientation orientation, int first, int last );
  void slotStorageModelLayoutChanged();
  void slotApplyFilter();


  Model * const q;

  int mRecursionCounterForReset;

  StorageModel *mStorageModel;

  const Aggregation * mAggregation;

  const Theme * mTheme;

  const SortOrder * mSortOrder;

  const Filter *mFilter;

  QTimer mFillStepTimer;

  QHash< QString, GroupHeaderItem * > mGroupHeaderItemHash;

  QHash< QByteArray, MessageItem * > mThreadingCacheMessageIdMD5ToMessageItem;

  QMultiHash< QByteArray, MessageItem * > mThreadingCacheMessageInReplyToIdMD5ToMessageItem;

  QHash< QByteArray, QList< MessageItem * > * > mThreadingCacheMessageSubjectMD5ToMessageItem;

  QHash< GroupHeaderItem *, GroupHeaderItem * > mGroupHeadersThatNeedUpdate;

  QList< MessageItem * > mUnassignedMessageListForPass2;

  QList< MessageItem * > mUnassignedMessageListForPass3;

  QList< MessageItem * > mUnassignedMessageListForPass4;

  QHash< MessageItem *, MessageItem * > mOrphanChildrenHash;

  QList< ViewItemJob * > mViewItemJobs;

  QDate mTodayDate;

  Item *mRootItem;

  View *mView;

  time_t mViewItemJobStepStartTime;

  int mViewItemJobStepChunkTimeout;

  int mViewItemJobStepIdleInterval;

  int mViewItemJobStepMessageCheckCount;

  ModelInvariantRowMapper * mInvariantRowMapper;

  QString mCachedTodayLabel;

  QString mCachedYesterdayLabel;

  QString mCachedUnknownLabel;

  QString mCachedLastWeekLabel;

  QString mCachedTwoWeeksAgoLabel;

  QString mCachedThreeWeeksAgoLabel;

  QString mCachedFourWeeksAgoLabel;

  QString mCachedFiveWeeksAgoLabel;

  qint32 mCachedWatchedOrIgnoredStatusBits;

  bool mInLengthyJobBatch;

  Item * mCurrentItemToRestoreAfterViewItemJobStep;

  bool mLoading;

  PreSelectionMode mPreSelectionMode;

  // Oldest and newest item while loading the model
  // Not valid afterwards anymore. Used for pre-selection of the newest/oldest message
  MessageItem *mOldestItem;
  MessageItem *mNewestItem;

  MessageItem * mLastSelectedMessageInFolder;

  MessageItemSetManager * mPersistentSetManager;

  Model * mModelForItemFunctions;

  bool mStorageModelContainsOutboundMessages;
};

} // namespace Core

} // namespace MessageList

#endif