ktexteditor.cpp

/*
    SPDX-FileCopyrightText: 2001 Christoph Cullmann <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#include "kateview.h"
 
#include "cursor.h"
 
#include "configpage.h"
 
#include "editor.h"
 
#include "document.h"
 
#include "view.h"
 
#include "plugin.h"
 
#include "command.h"
#include "inlinenote.h"
#include "inlinenotedata.h"
#include "inlinenoteinterface.h"
#include "inlinenoteprovider.h"
#include "katerenderer.h"
#include "katevariableexpansionmanager.h"
#include "markinterface.h"
#include "modificationinterface.h"
#include "sessionconfiginterface.h"
#include "texthintinterface.h"
#include "variable.h"
 
#include "abstractannotationitemdelegate.h"
#include "annotationinterface.h"
 
#include "katecmd.h"
#include "kateconfig.h"
#include "kateglobal.h"
#include "katesyntaxmanager.h"
 
using namespace KTextEditor;
 
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
Cursor Cursor::fromString(const QStringRef &str) Q_DECL_NOEXCEPT
{
    return fromString(QStringView(str));
}
#endif
 
Cursor Cursor::fromString(QStringView str) Q_DECL_NOEXCEPT
{
    // parse format "(line, column)"
    const int startIndex = str.indexOf(QLatin1Char('('));
    const int endIndex = str.indexOf(QLatin1Char(')'));
    const int commaIndex = str.indexOf(QLatin1Char(','));
 
    if (startIndex < 0 || endIndex < 0 || commaIndex < 0 || commaIndex < startIndex || endIndex < commaIndex || endIndex < startIndex) {
        return invalid();
    }
 
    bool ok1 = false;
    bool ok2 = false;
 
    const int line = str.mid(startIndex + 1, commaIndex - startIndex - 1).toString().toInt(&ok1); // FIXME KF6, Qt 5.15.2 and higher
    const int column = str.mid(commaIndex + 1, endIndex - commaIndex - 1).toString().toInt(&ok2); // FIXME KF6, Qt 5.15.2 and higher
 
    if (!ok1 || !ok2) {
        return invalid();
    }
 
    return {line, column};
}
 
Editor::Editor(EditorPrivate *impl)
    : QObject()
    , d(impl)
{
}
 
Editor::~Editor() = default;
 
Editor *KTextEditor::Editor::instance()
{
    // Just use internal KTextEditor::EditorPrivate::self()
    return KTextEditor::EditorPrivate::self();
}
 
QString Editor::defaultEncoding() const
{
    // return default encoding in global config object
    return d->documentConfig()->encoding();
}
 
bool Editor::registerVariableMatch(const QString &name, const QString &description, ExpandFunction expansionFunc)
{
    const auto var = Variable(name, description, expansionFunc, false);
    return d->variableExpansionManager()->addVariable(var);
}
 
bool Editor::registerVariablePrefix(const QString &prefix, const QString &description, ExpandFunction expansionFunc)
{
    const auto var = Variable(prefix, description, expansionFunc, true);
    return d->variableExpansionManager()->addVariable(var);
}
 
bool Editor::unregisterVariableMatch(const QString &variable)
{
    return d->variableExpansionManager()->removeVariable(variable);
}
 
bool Editor::unregisterVariablePrefix(const QString &variable)
{
    return d->variableExpansionManager()->removeVariable(variable);
}
 
bool Editor::expandVariable(const QString &variable, KTextEditor::View *view, QString &output) const
{
    return d->variableExpansionManager()->expandVariable(variable, view, output);
}
 
void Editor::expandText(const QString &text, KTextEditor::View *view, QString &output) const
{
    output = d->variableExpansionManager()->expandText(text, view);
}
 
void Editor::addVariableExpansion(const QVector<QWidget *> &widgets, const QStringList &variables) const
{
    d->variableExpansionManager()->showDialog(widgets, variables);
}
 
QFont Editor::font() const
{
    return d->rendererConfig()->baseFont();
}
 
KSyntaxHighlighting::Theme Editor::theme() const
{
    return KateHlManager::self()->repository().theme(d->rendererConfig()->schema());
}
 
const KSyntaxHighlighting::Repository &Editor::repository() const
{
    return KateHlManager::self()->repository();
}
 
bool View::insertText(const QString &text)
{
    KTextEditor::Document *doc = document();
    if (!doc) {
        return false;
    }
    return doc->insertText(cursorPosition(), text, blockSelection());
}
 
bool View::isStatusBarEnabled() const
{
    // is the status bar around?
    return !!d->statusBar();
}
 
void View::setStatusBarEnabled(bool enable)
{
    // no state change, do nothing
    if (enable == !!d->statusBar()) {
        return;
    }
 
    // else toggle it
    d->toggleStatusBar();
}
 
bool View::insertTemplate(const KTextEditor::Cursor &insertPosition, const QString &templateString, const QString &script)
{
    return d->insertTemplateInternal(insertPosition, templateString, script);
}
 
void View::setViewInputMode(InputMode inputMode)
{
    d->setInputMode(inputMode);
}
 
KSyntaxHighlighting::Theme View::theme() const
{
    return KateHlManager::self()->repository().theme(d->renderer()->config()->schema());
}
 
void View::setCursorPositions(const QVector<KTextEditor::Cursor> &positions)
{
    d->setCursors(positions);
}
 
QVector<KTextEditor::Cursor> View::cursorPositions() const
{
    return d->cursors();
}
 
void View::setSelections(const QVector<KTextEditor::Range> &ranges)
{
    d->setSelections(ranges);
}
 
QVector<KTextEditor::Range> View::selectionRanges() const
{
    return d->selectionRanges();
}
 
ConfigPage::ConfigPage(QWidget *parent)
    : QWidget(parent)
    , d(nullptr)
{
}
 
ConfigPage::~ConfigPage() = default;
 
QString ConfigPage::fullName() const
{
    return name();
}
 
QIcon ConfigPage::icon() const
{
    return QIcon::fromTheme(QStringLiteral("document-properties"));
}
 
View::View(ViewPrivate *impl, QWidget *parent)
    : QWidget(parent)
    , KXMLGUIClient()
    , d(impl)
{
}
 
View::~View() = default;
 
Plugin::Plugin(QObject *parent)
    : QObject(parent)
    , d(nullptr)
{
}
 
Plugin::~Plugin() = default;
 
int Plugin::configPages() const
{
    return 0;
}
 
ConfigPage *Plugin::configPage(int, QWidget *)
{
    return nullptr;
}
 
MarkInterface::MarkInterface() = default;
 
MarkInterface::~MarkInterface() = default;
 
ModificationInterface::ModificationInterface() = default;
 
ModificationInterface::~ModificationInterface() = default;
 
SessionConfigInterface::SessionConfigInterface() = default;
 
SessionConfigInterface::~SessionConfigInterface() = default;
 
TextHintInterface::TextHintInterface() = default;
 
TextHintInterface::~TextHintInterface() = default;
 
TextHintProvider::TextHintProvider() = default;
 
TextHintProvider::~TextHintProvider() = default;
 
InlineNoteInterface::InlineNoteInterface() = default;
 
InlineNoteInterface::~InlineNoteInterface() = default;
 
InlineNoteProvider::InlineNoteProvider() = default;
 
InlineNoteProvider::~InlineNoteProvider() = default;
 
KateInlineNoteData::KateInlineNoteData(KTextEditor::InlineNoteProvider *provider,
                                       const KTextEditor::View *view,
                                       const KTextEditor::Cursor position,
                                       int index,
                                       bool underMouse,
                                       const QFont &font,
                                       int lineHeight)
    : m_provider(provider)
    , m_view(view)
    , m_position(position)
    , m_index(index)
    , m_underMouse(underMouse)
    , m_font(font)
    , m_lineHeight(lineHeight)
{
}
 
InlineNote::InlineNote(const KateInlineNoteData &data)
    : d(data)
{
}
 
qreal InlineNote::width() const
{
    return d.m_provider->inlineNoteSize(*this).width();
}
 
bool KTextEditor::InlineNote::underMouse() const
{
    return d.m_underMouse;
}
 
void KTextEditor::InlineNoteProvider::inlineNoteActivated(const InlineNote &note, Qt::MouseButtons buttons, const QPoint &globalPos)
{
    Q_UNUSED(note);
    Q_UNUSED(buttons);
    Q_UNUSED(globalPos);
}
 
void KTextEditor::InlineNoteProvider::inlineNoteFocusInEvent(const KTextEditor::InlineNote &note, const QPoint &globalPos)
{
    Q_UNUSED(note);
    Q_UNUSED(globalPos);
}
 
void KTextEditor::InlineNoteProvider::inlineNoteFocusOutEvent(const KTextEditor::InlineNote &note)
{
    Q_UNUSED(note);
}
 
void KTextEditor::InlineNoteProvider::inlineNoteMouseMoveEvent(const KTextEditor::InlineNote &note, const QPoint &globalPos)
{
    Q_UNUSED(note);
    Q_UNUSED(globalPos);
}
 
KTextEditor::InlineNoteProvider *InlineNote::provider() const
{
    return d.m_provider;
}
 
const KTextEditor::View *InlineNote::view() const
{
    return d.m_view;
}
 
QFont InlineNote::font() const
{
    return d.m_font;
}
 
int InlineNote::index() const
{
    return d.m_index;
}
 
int InlineNote::lineHeight() const
{
    return d.m_lineHeight;
}
 
KTextEditor::Cursor InlineNote::position() const
{
    return d.m_position;
}
 
Command::Command(const QStringList &cmds, QObject *parent)
    : QObject(parent)
    , m_cmds(cmds)
    , d(nullptr)
{
    // register this command
    static_cast<KTextEditor::EditorPrivate *>(KTextEditor::Editor::instance())->cmdManager()->registerCommand(this);
}
 
Command::~Command()
{
    // unregister this command, if instance is still there!
    if (KTextEditor::Editor::instance()) {
        static_cast<KTextEditor::EditorPrivate *>(KTextEditor::Editor::instance())->cmdManager()->unregisterCommand(this);
    }
}
 
bool Command::supportsRange(const QString &)
{
    return false;
}
 
KCompletion *Command::completionObject(KTextEditor::View *, const QString &)
{
    return nullptr;
}
 
bool Command::wantsToProcessText(const QString &)
{
    return false;
}
 
void Command::processText(KTextEditor::View *, const QString &)
{
}
 
void View::setScrollPosition(KTextEditor::Cursor &cursor)
{
    d->setScrollPositionInternal(cursor);
}
 
void View::setHorizontalScrollPosition(int x)
{
    d->setHorizontalScrollPositionInternal(x);
}
 
KTextEditor::Cursor View::maxScrollPosition() const
{
    return d->maxScrollPositionInternal();
}
 
int View::firstDisplayedLine(LineType lineType) const
{
    return d->firstDisplayedLineInternal(lineType);
}
 
int View::lastDisplayedLine(LineType lineType) const
{
    return d->lastDisplayedLineInternal(lineType);
}
 
QRect View::textAreaRect() const
{
    return d->textAreaRectInternal();
}
 
StyleOptionAnnotationItem::StyleOptionAnnotationItem()
    : contentFontMetrics(QFont())
{
}
 
StyleOptionAnnotationItem::StyleOptionAnnotationItem(const StyleOptionAnnotationItem &other)
    : QStyleOption(Version, Type)
    , contentFontMetrics(QFont())
{
    *this = other;
}
 
StyleOptionAnnotationItem::StyleOptionAnnotationItem(int version)
    : QStyleOption(version, Type)
    , contentFontMetrics(QFont())
{
}
 
AbstractAnnotationItemDelegate::AbstractAnnotationItemDelegate(QObject *parent)
    : QObject(parent)
{
}
 
AbstractAnnotationItemDelegate::~AbstractAnnotationItemDelegate() = default;