kateautoindent.h

/*
    SPDX-FileCopyrightText: 2003 Jesse Yurkovich <[email protected]>

    KateVarIndent class:
    SPDX-FileCopyrightText: 2004 Anders Lund <[email protected]>

    Basic support for config page:
    SPDX-FileCopyrightText: 2005 Dominik Haumann <[email protected]>

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

#ifndef KATE_AUTO_INDENT_H
#define KATE_AUTO_INDENT_H

#include "kateconfig.h"

#include <QObject>

#include <KActionMenu>
#include <ktexteditor/cursor.h>

namespace KTextEditor
{
class DocumentPrivate;
}
class KateIndentScript;
class KateHighlighting;

class KateAutoIndent : public QObject
{
    Q_OBJECT
    /*
     * Static methods to list indention modes
     */
public:
    static QStringList listModes();

    static QStringList listIdentifiers();

    static QString modeName(int mode);

    static QString modeDescription(int mode);

    static QString modeRequiredStyle(int mode);

    static uint modeNumber(const QString &name);

    static int modeCount();

    /*
     * Construction + Destruction
     */
public:
    explicit KateAutoIndent(KTextEditor::DocumentPrivate *doc);

    ~KateAutoIndent();

    /*
     * Internal helper for the subclasses and itself
     */
private:
    QString tabString(int length, int align) const;

    bool doIndent(int line, int indentDepth, int align = 0);

    bool doIndentRelative(int line, int change);

    void keepIndent(int line);

    void scriptIndent(KTextEditor::ViewPrivate *view, const KTextEditor::Cursor &position, QChar typedChar);

    static bool isStyleProvided(const KateIndentScript *script, const KateHighlighting *highlight);

public:
    void setMode(const QString &name);

    void checkRequiredStyle();

    const QString &modeName() const
    {
        return m_mode;
    }

    void updateConfig();

    bool changeIndent(const KTextEditor::Range &range, int change);

    void indent(KTextEditor::ViewPrivate *view, const KTextEditor::Range &range);

    void userTypedChar(KTextEditor::ViewPrivate *view, const KTextEditor::Cursor &position, QChar typedChar);

public Q_SLOTS:
    void reloadScript();

    /*
     * needed data
     */
private:
    KTextEditor::DocumentPrivate *doc; 
    int tabWidth; 
    int indentWidth; 
    bool useSpaces; 
    bool keepExtra; 
    QString m_mode;
    KateIndentScript *m_script;
};

class KateViewIndentationAction : public KActionMenu
{
    Q_OBJECT

public:
    KateViewIndentationAction(KTextEditor::DocumentPrivate *_doc, const QString &text, QObject *parent);

private:
    KTextEditor::DocumentPrivate *doc;
    QActionGroup *actionGroup;

public Q_SLOTS:
    void slotAboutToShow();

private Q_SLOTS:
    void setMode(QAction *);
};

#endif