kopetemessagehandler.h

Go to the documentation of this file.

/*
    kopetemessagehandler.h - Kopete Message Filtering

    Copyright (c) 2004      by Richard Smith         <kde@metafoo.co.uk>
    Kopete    (c) 2002-2004 by the Kopete developers <kopete-devel@kde.org>

    *************************************************************************
    *                                                                       *
    * This library is free software; you can redistribute it and/or         *
    * modify it under the terms of the GNU Lesser General Public            *
    * License as published by the Free Software Foundation; either          *
    * version 2 of the License, or (at your option) any later version.      *
    *                                                                       *
    *************************************************************************
*/

#ifndef KOPETEMESSAGEHANDLER_H
#define KOPETEMESSAGEHANDLER_H

#include <QtCore/QObject>
#include <QtCore/QLinkedList>

#include "kopete_export.h"

//FIXME: Message::MessageDirection could be moved into namespace Kopete
// to avoid this being included everywhere
#include "kopetemessage.h"

namespace Kopete
{

class MessageEvent;
class ChatSession;

class KOPETE_EXPORT MessageHandler : public QObject
{
    Q_OBJECT
public:
    MessageHandler();
    virtual ~MessageHandler() = 0;

    MessageHandler *next();
    // FIXME: remove?
    void setNext( MessageHandler *next );

    virtual int capabilities();

    virtual void handleMessage( MessageEvent *event );

    void handleMessageInternal( MessageEvent *event );
private slots:
    void messageAccepted( Kopete::MessageEvent *event );

private:
    class Private;
    Private * const d;
};

class KOPETE_EXPORT MessageHandlerFactory
{
public:
    MessageHandlerFactory();
    virtual ~MessageHandlerFactory();
    
    typedef QLinkedList<MessageHandlerFactory*> FactoryList;
    static FactoryList messageHandlerFactories();
    
    virtual MessageHandler *create( ChatSession *manager, Message::MessageDirection direction ) = 0;
    
    enum SpecialStage
    {
        StageDoNotCreate = -10000, 
        StageStart = 0,            
        StageEnd = 10000           
    };
    
    enum InboundStage
    {
        InStageStart = 0,        
        InStageToSent = 2000,    
        InStageToDesired = 5000, 
        InStageFormat = 7000,    
        InStageEnd = 10000       
    };
    
    enum OutboundStage
    {
        OutStageStart = 0,        
        OutStageParse = 2000,     
        OutStageToDesired = 4000, 
        OutStageFormat = 6000,    
        OutStageToSent = 8000,    
        OutStageEnd = 10000       
    };
    
    enum InternalStage
    {
        IntStageStart = 0,  
        IntStageEnd = 10000 
    };
    
    enum Offset
    {
        OffsetBefore = -90,
        OffsetVeryEarly = -60,
        OffsetEarly = -30,
        OffsetNormal = 0,
        OffsetLate = 30,
        OffsetVeryLate = 60,
        OffsetAfter = 90
    };
    
    virtual int filterPosition( ChatSession *manager, Message::MessageDirection direction ) = 0;
    
private:
    // noncopyable
    MessageHandlerFactory(const MessageHandlerFactory &);
    void operator=(const MessageHandlerFactory &);
    
    class Private;
    Private * const d;
};

}

#endif

// vim: set noet ts=4 sts=4 sw=4: