katecmds.h

Go to the documentation of this file.

/*  This file is part of the KDE libraries and the Kate part.
 *
 *  Copyright (C) 2003-2005 Anders Lund <anders@alweb.dk>
 *  Copyright (C) 2001-2010 Christoph Cullmann <cullmann@kde.org>
 *  Copyright (C) 2001 Charles Samuels <charles@kde.org>
 *
 *  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_CMDS_H__
#define __KATE_CMDS_H__

#include <ktexteditor/commandinterface.h>
#include "kateviinputmodemanager.h"
#include "kateviglobal.h"
#include "kateregexpsearch.h"

#include <QtCore/QStringList>

class KateDocument;
class KCompletion;

namespace KateCommands
{

class CoreCommands : public KTextEditor::Command, public KTextEditor::CommandExtension,
  public KTextEditor::RangeCommand
{
  CoreCommands() { }
  static CoreCommands* m_instance;

  public:
    ~CoreCommands() { m_instance = 0; }

    bool exec( class KTextEditor::View *view, const QString &cmd, QString &errorMsg );

    bool exec( class KTextEditor::View *view, const QString &cmd, QString &errorMsg,
        const KTextEditor::Range &range = KTextEditor::Range(-1, -0, -1, 0) );

    bool supportsRange(const QString &range);

    bool help( class KTextEditor::View *, const QString &, QString & );

    const QStringList &cmds();

    KCompletion *completionObject( KTextEditor::View *, const QString & );

    virtual void flagCompletions( QStringList& ) {}
    virtual bool wantsToProcessText( const QString & ) { return false; }
    virtual void processText( KTextEditor::View *, const QString & ) {}

    static CoreCommands* self() {
      if (m_instance == 0) {
        m_instance = new CoreCommands();
      }
      return m_instance;
    }
};

class ViCommands : public KTextEditor::Command, public KTextEditor::CommandExtension,
  public KTextEditor::RangeCommand
{
  ViCommands() { }
  static ViCommands* m_instance;

  public:
    ~ViCommands() { m_instance = 0; }

    bool exec( class KTextEditor::View *view, const QString &cmd, QString &msg );

    bool exec( class KTextEditor::View *view, const QString &cmd, QString &msg,
        const KTextEditor::Range &range = KTextEditor::Range(-1, -0, -1, 0));

    bool supportsRange(const QString &range);

    bool help( class KTextEditor::View *, const QString &, QString & ) {return false;}

    const QStringList &cmds();

    KCompletion *completionObject( KTextEditor::View *, const QString & );

    virtual void flagCompletions( QStringList& ) {}
    virtual bool wantsToProcessText( const QString & ) { return false; }
    virtual void processText( KTextEditor::View *, const QString & ) {}

    static ViCommands* self() {
      if (m_instance == 0) {
        m_instance = new ViCommands();
      }
      return m_instance;
    }
private:
  const QStringList& mappingCommands();
  KateViGlobal::MappingMode modeForMapCommand(const QString& mapCommand);
  bool isMapCommandRecursive(const QString& mapCommand);
};

class AppCommands : public KTextEditor::Command
{
  AppCommands();
  static AppCommands* m_instance;

  public:
    ~AppCommands() { m_instance = 0; }

    bool exec( class KTextEditor::View *view, const QString &cmd, QString &msg );

    bool help( class KTextEditor::View *, const QString &, QString & );

    const QStringList &cmds();

    static AppCommands* self() {
      if (m_instance == 0) {
        m_instance = new AppCommands();
      }
      return m_instance;
    }

  private:
    QRegExp re_write;
    /*QRegExp re_quit;
    QRegExp re_exit;
    QRegExp re_changeBuffer;
    QRegExp re_edit;
    QRegExp re_new;*/
};
class SedReplace : public KTextEditor::Command, public KTextEditor::RangeCommand
{
  SedReplace() { }
  static SedReplace* m_instance;

  public:
    ~SedReplace() { m_instance = 0; }

    bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg);

    bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg,
        const KTextEditor::Range &r);

    bool supportsRange(const QString &) { return true; }

    bool help (class KTextEditor::View *, const QString &, QString &) { return false; }

    const QStringList &cmds () { static QStringList l("s"); if (l.isEmpty()) l << "%s" << "$s"; return l; }

    static SedReplace* self() {
      if (m_instance == 0) {
        m_instance = new SedReplace();
      }
      return m_instance;
    }

    static bool parse(const QString& sedReplaceString, QString& destDelim, int& destFindBeginPos, int& destFindEndPos, int& destReplaceBeginPos, int& destReplaceEndPos);

    class InteractiveSedReplacer
    {
    public:
      InteractiveSedReplacer(KateDocument* doc, const QString& findPattern, const QString& replacePattern, bool caseSensitive, bool onlyOnePerLine, int startLine, int endLine);
      KTextEditor::Range currentMatch();
      void skipCurrentMatch();
      void replaceCurrentMatch();
      void replaceAllRemaining();
      QString currentMatchReplacementConfirmationMessage();
      QString finalStatusReportMessage();
    private:
      const QString m_findPattern;
      const QString m_replacePattern;
      bool m_onlyOnePerLine;
      int m_startLine;
      int m_endLine;
      KateDocument *m_doc;
      KateRegExpSearch m_regExpSearch;

      int m_numReplacementsDone;
      int m_numLinesTouched;
      int m_lastChangedLineNum;

      KTextEditor::Cursor m_currentSearchPos;
      const QVector<KTextEditor::Range> fullCurrentMatch();
      QString replacementTextForCurrentMatch();
    };

  private:
};

class Character : public KTextEditor::Command
{
  Character() { }
  static Character* m_instance;

  public:
    ~Character() { m_instance = 0; }

    bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg);

    bool help (class KTextEditor::View *, const QString &, QString &);

    const QStringList &cmds () { static QStringList test("char"); return test; }

    static Character* self() {
      if (m_instance == 0) {
        m_instance = new Character();
      }
      return m_instance;
    }
};

class Date : public KTextEditor::Command
{
  Date() { }
  static Date* m_instance;

  public:
    ~Date() { m_instance = 0; }

    bool exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg);

    bool help (class KTextEditor::View *, const QString &, QString &);

    const QStringList &cmds () { static QStringList test("date"); return test; }

    static Date* self() {
      if (m_instance == 0) {
        m_instance = new Date();
      }
      return m_instance;
    }
};


} // namespace KateCommands
#endif

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