katetemplatehandler.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries and the Kate part.
 *
 *  Copyright (C) 2004,2010 Joseph Wenninger <jowenn@kde.org>
 *  Copyright (C) 2009 Milian Wolff <mail@milianw.de>
 *
 *  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_TEMPLATE_HANDLER_H_
#define _KATE_TEMPLATE_HANDLER_H_

#include <QtCore/QPointer>
#include <QtCore/QObject>
#include <QtCore/QMap>
#include <QtCore/QHash>
#include <QtCore/QString>
#include <QtCore/QList>
#include <QtCore/QRegExp>

class KateDocument;

class KateView;

class KateUndoManager;

class KateTemplateScript;

namespace KTextEditor
{

class MovingCursor;

class MovingRange;
}

class KateTemplateHandler: public QObject
{
  Q_OBJECT

public:
  KateTemplateHandler(KateView *view,
                      const KTextEditor::Cursor& position,
                      const QString &templateString,
                      const QMap<QString, QString> &initialValues,
                      KateUndoManager* undoManager,
                      KateTemplateScript* templateScript);

  virtual ~KateTemplateHandler();

protected:
  virtual bool eventFilter(QObject* object, QEvent* event);

private:
  void insertText(const KTextEditor::Cursor& position, const QString& text);

  void handleTemplateString(const QMap<QString, QString> &initialValues);

  void setupEventHandler(KTextEditor::View* view);

  void jumpToPreviousRange();

  void jumpToNextRange();

  void setCurrentRange(KTextEditor::MovingRange* range);

  void syncMirroredRanges(KTextEditor::MovingRange* range);

public:

  class MirrorBehaviour
  {

  public:
    MirrorBehaviour(); //clone
    MirrorBehaviour(const QString &regexp, const QString &replacement, const QString &flags);   //regexp
    MirrorBehaviour(KateTemplateScript* templateScript, const QString& functionName, KateTemplateHandler* handler);   //scripted
    ~MirrorBehaviour();
    QString getMirrorString(const QString &source);

  private:
    enum Behaviour {
      Clone = 0,
      Regexp = 1,
      Scripted = 2
    };
    Behaviour m_behaviour;
    QString m_search;
    QString m_replace;
    QRegExp m_expr;
    bool m_global;
    KateTemplateScript* m_templateScript;
    QString m_functionName;
    KateTemplateHandler *m_handler;
  };

private:

  QHash<KTextEditor::MovingRange*, MirrorBehaviour> m_mirrorBehaviour;


  void jumpToFinalCursorPosition();

  KateDocument *doc();

private Q_SLOTS:
  void cleanupAndExit();

  void slotTemplateInserted(KTextEditor::Document* document, const KTextEditor::Range& range);
  void slotViewCreated(KTextEditor::Document* document, KTextEditor::View* view);
  void slotTextChanged(KTextEditor::Document* document, const KTextEditor::Range& oldRange);

  void setEditWithUndo(const bool &enabled);

public:
  KateView* view();

private:
  KateView *m_view;
  KateUndoManager *const m_undoManager;
  QList<KTextEditor::MovingRange*> m_templateRanges;

  QMap<KTextEditor::MovingRange*, QList<KTextEditor::MovingRange*> > m_templateRangesChildren;
  QMap<KTextEditor::MovingRange*, KTextEditor::MovingRange*> m_templateRangesChildToParent;

  KTextEditor::MovingRange *m_wholeTemplateRange;
  KTextEditor::MovingCursor *m_finalCursorPosition;
  KTextEditor::Cursor m_lastCaretPosition;
  QList<KTextEditor::MovingRange*> m_uneditedRanges;
  QList<KTextEditor::MovingRange*> m_masterRanges;
  bool m_isMirroring;
  bool m_editWithUndo;
  bool m_jumping;
  KateTemplateScript* m_templateScript;

  QList<KTextEditor::MovingRange*> m_spacersMovingRanges;

  bool m_initialRemodify;
};


#endif

// kate: indent-mode cstyle; space-indent on; indent-width 2; replace-tabs on;  replace-tabs on;  replace-tabs on;  replace-tabs on;