markinterface.h

/*  SPDX-License-Identifier: LGPL-2.0-or-later

    Copyright (C) 2001 Christoph Cullmann ([email protected])
    Copyright (C) 2005 Dominik Haumann ([email protected]) (documentation)

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

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KTEXTEDITOR_MARKINTERFACE_H
#define KTEXTEDITOR_MARKINTERFACE_H

#include <ktexteditor_export.h>

#include <QHash>
#include <QObject>

class QIcon;
class QPixmap;
class QPoint;
class QMenu;

namespace KTextEditor
{
class Document;

class Mark
{
public:
    int line;

    uint type;
};

class KTEXTEDITOR_EXPORT MarkInterface
{
public:
    MarkInterface();

    virtual ~MarkInterface();

    //
    // slots !!!
    //
public:
    virtual uint mark(int line) = 0;

    virtual void setMark(int line, uint markType) = 0;

    virtual void clearMark(int line) = 0;

    virtual void addMark(int line, uint markType) = 0;

    virtual void removeMark(int line, uint markType) = 0;

    virtual const QHash<int, KTextEditor::Mark *> &marks() = 0;

    virtual void clearMarks() = 0;

    static int reservedMarkersCount()
    {
        return 7;
    }

    enum MarkTypes {
        markType01 = 0x1,
        markType02 = 0x2,
        markType03 = 0x4,
        markType04 = 0x8,
        markType05 = 0x10,
        markType06 = 0x20,
        markType07 = 0x40,

        markType08 = 0x80,
        markType09 = 0x100,
        markType10 = 0x200,
        markType11 = 0x400,
        markType12 = 0x800,
        markType13 = 0x1000,
        markType14 = 0x2000,
        markType15 = 0x4000,
        markType16 = 0x8000,
        markType17 = 0x10000,
        markType18 = 0x20000,
        markType19 = 0x40000,
        markType20 = 0x80000,
        markType21 = 0x100000,
        markType22 = 0x200000,
        markType23 = 0x400000,
        markType24 = 0x800000,
        markType25 = 0x1000000,
        markType26 = 0x2000000,
        markType27 = 0x4000000,
        markType28 = 0x8000000,
        markType29 = 0x10000000,
        markType30 = 0x20000000,
        markType31 = 0x40000000,
        markType32 = 0x80000000,
        /* reserved marks */
        Bookmark = markType01,
        BreakpointActive = markType02,
        BreakpointReached = markType03,
        BreakpointDisabled = markType04,
        Execution = markType05,
        Warning = markType06,
        Error = markType07,
        SearchMatch = markType32,
    };

    //
    // signals !!!
    //
public:
    virtual void marksChanged(KTextEditor::Document *document) = 0;

    /*
     * Methods to modify mark properties.
     */
public:
    virtual void setMarkPixmap(MarkTypes mark, const QPixmap &pixmap) = 0;

    virtual QPixmap markPixmap(MarkTypes mark) const = 0;

    virtual void setMarkDescription(MarkTypes mark, const QString &text) = 0;

    virtual QString markDescription(MarkTypes mark) const = 0;

    virtual void setEditableMarks(uint markMask) = 0;

    virtual uint editableMarks() const = 0;

    enum MarkChangeAction {
        MarkAdded = 0,  
        MarkRemoved = 1 
    };

    //
    // signals !!!
    //
public:
    virtual void markChanged(KTextEditor::Document *document, KTextEditor::Mark mark, KTextEditor::MarkInterface::MarkChangeAction action) = 0;

Q_SIGNALS:

    void markToolTipRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint position, bool &handled);

    void markContextMenuRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint pos, bool &handled);

    void markClicked(KTextEditor::Document *document, KTextEditor::Mark mark, bool &handled);

private:
    class MarkInterfacePrivate *const d = nullptr;
};

class KTEXTEDITOR_EXPORT MarkInterfaceV2 : public MarkInterface
{
    // KF6: Merge KTextEditor::MarkInterfaceV2 into KTextEditor::MarkInterface, drop QPixmap API (kossebau)
public:
    virtual ~MarkInterfaceV2()
    {
    }

    virtual void setMarkIcon(MarkTypes markType, const QIcon &icon) = 0;

    virtual QIcon markIcon(MarkTypes markType) const = 0;
};

}

Q_DECLARE_INTERFACE(KTextEditor::MarkInterface, "org.kde.KTextEditor.MarkInterface")
Q_DECLARE_INTERFACE(KTextEditor::MarkInterfaceV2, "org.kde.KTextEditor.MarkInterfaceV2")

#endif