kateindentscript.h

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

    Copyright (C) 2008 Paul Giannaros <[email protected]>
    Copyright (C) 2009-2018 Dominik Haumann <[email protected]>

    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 KATE_INDENT_SCRIPT_H
#define KATE_INDENT_SCRIPT_H

#include "katescript.h"
#include "kateview.h"

class KateIndentScriptHeader
{
public:
    KateIndentScriptHeader() = default;

    inline void setName(const QString &name)
    {
        m_name = name;
    }
    inline const QString &name() const
    {
        return m_name;
    }

    inline void setRequiredStyle(const QString &requiredStyle)
    {
        m_requiredStyle = requiredStyle;
    }
    inline const QString &requiredStyle() const
    {
        return m_requiredStyle;
    }

    inline void setIndentLanguages(const QStringList &indentLanguages)
    {
        m_indentLanguages = indentLanguages;
    }
    inline const QStringList &indentLanguages() const
    {
        return m_indentLanguages;
    }

    inline void setPriority(int priority)
    {
        m_priority = priority;
    }
    inline int priority() const
    {
        return m_priority;
    }

    inline void setBaseName(const QString &baseName)
    {
        m_baseName = baseName;
    }
    inline const QString &baseName() const
    {
        return m_baseName;
    }

private:
    QString m_name; 

    QString m_requiredStyle;
    QStringList m_indentLanguages;
    int m_priority = 0;

    QString m_baseName;
};

class KateIndentScript : public KateScript
{
public:
    explicit KateIndentScript(const QString &url, const KateIndentScriptHeader &header);

    const QString &triggerCharacters();

    const KateIndentScriptHeader &indentHeader() const;

    QPair<int, int> indent(KTextEditor::ViewPrivate *view, const KTextEditor::Cursor &position, QChar typedCharacter, int indentWidth);

private:
    QString m_triggerCharacters;
    bool m_triggerCharactersSet = false;
    KateIndentScriptHeader m_indentHeader;
};

#endif