kateautoindent.h

/* This file is part of the KDE libraries
   Copyright (C) 2003 Jesse Yurkovich <yurkjes@iit.edu>
   Copyright (C) 2004 >Anders Lund <anders@alweb.dk> (KateVarIndent class)
   Copyright (C) 2005 Dominik Haumann <dhdev@gmx.de> (basic support for config page)

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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_AUTO_INDENT_H
#define KATE_AUTO_INDENT_H

#include "kateconfig.h"

#include <QObject>

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

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