autobrace.h

Go to the documentation of this file.

#ifndef AUTOBRACE_H
#define AUTOBRACE_H

#include <ktexteditor/plugin.h>
#include <ktexteditor/view.h>
#include <ktexteditor/document.h>
#include <kpluginfactory.h>

#include <QtCore/QEvent>
#include <QtCore/QObject>
#include <QtCore/QHash>
#include <QtCore/QVariantList>

class AutoBracePlugin
    : public KTextEditor::Plugin
{
  Q_OBJECT

  public:
    explicit AutoBracePlugin(QObject *parent = 0, const QVariantList &args = QVariantList());
    virtual ~AutoBracePlugin();

    static AutoBracePlugin *self() { return plugin; }

    void addView (KTextEditor::View *view);
    void removeView (KTextEditor::View *view);

    void readConfig();
    void writeConfig();

    virtual void readConfig (KConfig *) {}
    virtual void writeConfig (KConfig *) {}

    bool autoBrackets() const { return m_autoBrackets; }
    void setAutoBrackets(bool y) { m_autoBrackets = y; }
    bool autoQuotations() const { return m_autoQuotations; }
    void setAutoQuotations(bool y) { m_autoQuotations = y; }
  private:
    static AutoBracePlugin *plugin;
    QHash<class KTextEditor::View*, class KTextEditor::Document*> m_documents;
    QHash<class KTextEditor::Document*, class AutoBracePluginDocument*> m_docplugins;
    bool m_autoBrackets;
    bool m_autoQuotations;
};

class AutoBracePluginDocument
   : public QObject, public KXMLGUIClient
{
  Q_OBJECT

  public:
    explicit AutoBracePluginDocument(KTextEditor::Document *document, const bool& autoBrackets, const bool& autoQuotations);
    ~AutoBracePluginDocument();

  private Q_SLOTS:
    void slotTextChanged(KTextEditor::Document *document);
    void slotTextInserted(KTextEditor::Document *document, const KTextEditor::Range& range);
    void slotTextRemoved(KTextEditor::Document *document, const KTextEditor::Range& range);

    void connectSlots(KTextEditor::Document* document);
    void disconnectSlots(KTextEditor::Document* document);

  private:
    bool isInsertionCandidate(KTextEditor::Document *document, int openingBraceLine);

  Q_SIGNALS:
    void indent();

  private:
    void insertAutoBracket(KTextEditor::Document *document,const KTextEditor::Range& range,
                         const QString& brace);
    const QString previousToken(KTextEditor::Document *document,const KTextEditor::Range& range);
    const QString nextToken(KTextEditor::Document *document,const KTextEditor::Range& range);

    int m_insertionLine;
    QString m_indentation;
    bool m_withSemicolon;
    QMap<QString,QString> m_brackets;
    KTextEditor::Range m_lastRange;
    const bool& m_autoBrackets;
    const bool& m_autoQuotations;
};

K_PLUGIN_FACTORY_DECLARATION(AutoBracePluginFactory)

#endif // AUTOBRACE_H