iclentry.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/
 
#pragma once
 
#include <QHashFunctions>
#include <QFlags>
#include <QMetaType>
#include <util/azoth/emitters/clentry.h>
#include "azothcommon.h"
#include "iaccount.h"
#include "message.h"
 
class QAction;
class QImage;
 
namespace LC::Azoth
{
    class IAccount;
    class IMessage;

    class ICLEntry
    {
    protected:
        Emitters::CLEntry Emitter_;
 
        virtual ~ICLEntry () = default;
    public:
        Emitters::CLEntry& GetCLEntryEmitter () { return Emitter_; }

        enum Feature
        {
            FPermanentEntry         = 0b00000000, 
            FSessionEntry           = 0b00000001, 
            FMaskLongetivity        = 0b00000011, 
            FSupportsRenames        = 0b00000100, 
            FSupportsAuth           = 0b00001000, 
            FSupportsGrouping       = 0b00010000, 
            FSelfContact            = 0b00100000, 
        };
 
        Q_DECLARE_FLAGS (Features, Feature)
 
        enum class EntryType : std::uint8_t
        {
            Chat,           
            MUC,            
            PrivateChat,    
            UnauthEntry,    
        };

        virtual QObject* GetQObject () = 0;

        virtual IAccount* GetParentAccount () const = 0;

        virtual ICLEntry* GetParentCLEntry () const
        {
            return nullptr;
        }
 
        QObject* GetParentCLEntryObject () const
        {
            if (const auto entry = GetParentCLEntry ())
                return entry->GetQObject ();
            return nullptr;
        }

        virtual Features GetEntryFeatures () const = 0;

        virtual EntryType GetEntryType () const = 0;

        virtual QString GetEntryName () const = 0;

        virtual void SetEntryName (const QString& name) = 0;
 
        [[deprecated("Use GetGlobalPersistentID() or GetGlobalStrongestID()")]]
        QString GetEntryID () const
        {
            return GetGlobalStrongestID ().ToString ();
        }
 
        [[deprecated("Use GetConventionalID()")]]
        QString GetHumanReadableID () const
        {
            return GetConventionalID ().ToString ();
        }

        virtual std::optional<EntryPersistentId> GetPersistentID () const = 0;
 
        std::optional<GlobalPersistentId> GetGlobalPersistentID () const
        {
            if (const auto persistentId = GetPersistentID ())
                return GlobalId { GetParentAccount ()->GetAccountID (), *persistentId };
            return {};
        }

        virtual EntryConventionalId GetConventionalID () const = 0;
 
        GlobalConventionalId GetGlobalConventionalID () const
        {
            return GlobalId { GetParentAccount ()->GetAccountID (), GetConventionalID () };
        }
 
        EntryStrongestId GetStrongestID () const
        {
            if (const auto persistentId = GetPersistentID ())
                return *persistentId;
            return GetConventionalID ();
        }
 
        GlobalStrongestId GetGlobalStrongestID () const
        {
            if (const auto persistentId = GetGlobalPersistentID ())
                return *persistentId;
            return GetGlobalConventionalID ();
        }
 
        virtual QString GetHumanReadableAddress () const
        {
            return GetConventionalID ().ToString ();
        }

        virtual QStringList Groups () const = 0;

        virtual void SetGroups (const QStringList& groups) = 0;

        virtual QStringList Variants () const = 0;

        virtual void SendMessage (const OutgoingMessage& message) = 0;

        virtual QList<IMessage*> GetAllMessages () const = 0;

        virtual void PurgeMessages (const QDateTime& before) = 0;

        virtual void SetChatPartState (ChatPartState state,
                const QString& variant) = 0;

        virtual EntryStatus GetStatus (const QString& variant = QString ()) const = 0;

        virtual void ShowInfo () = 0;

        virtual QList<QAction*> GetActions () const = 0;

        virtual QMap<QString, QVariant> GetClientInfo (const QString& variant) const = 0;

        virtual void MarkMsgsRead () = 0;

        virtual void ChatTabClosed () = 0;
    };
}
 
Q_DECLARE_OPERATORS_FOR_FLAGS (LC::Azoth::ICLEntry::Features)
Q_DECLARE_INTERFACE (LC::Azoth::ICLEntry, "org.Deviant.LeechCraft.Azoth.ICLEntry/1.0")