File indexing completed on 2025-04-27 13:12:47

 /*
     This file is part of the KDE project
 
     SPDX-FileCopyrightText: 2001, 2003 Peter Kelly <pmk@post.com>
     SPDX-FileCopyrightText: 2006, 2007 Leo Savernik <l.savernik@aon.at>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef TESTUTILS_H
 #define TESTUTILS_H
 
 #include "katescriptview.h"
 
 #include "katescriptdocument.h"
 #include <QJSEngine>
 
 namespace KTextEditor
 {
 class ViewPrivate;
 }
 class RegressionTest;
 class KCmdLineArgs;
 class OutputObject;
 class KateViewObject;
 class KateDocumentObject;
 
 /**
  * @internal
  * The backbone of Kate's automatic regression tests.
  */
 class TestScriptEnv : public QObject
 {
 public:
     explicit TestScriptEnv(KTextEditor::DocumentPrivate *part, bool &cflag);
     ~TestScriptEnv() override;
 
     QJSEngine *engine() const
     {
         return m_engine;
     }
 
     /** returns the output object */
     OutputObject *output() const
     {
         return m_output;
     }
 
 private:
     QJSEngine *m_engine;
     KateViewObject *m_viewObj;
     KateDocumentObject *m_docObj;
 
     OutputObject *m_output;
 };
 
 /**
  * @internal
  */
 class KateViewObject : public KateScriptView
 {
     Q_OBJECT
 
 public:
     explicit KateViewObject(QJSEngine *engine, KTextEditor::ViewPrivate *view);
     ~KateViewObject() override;
 
     // Edit functions
     Q_INVOKABLE void keyReturn(int cnt = 1);
     Q_INVOKABLE void backspace(int cnt = 1);
     Q_INVOKABLE void deleteWordLeft(int cnt = 1);
     Q_INVOKABLE void keyDelete(int cnt = 1);
     Q_INVOKABLE void deleteWordRight(int cnt = 1);
     Q_INVOKABLE void transpose(int cnt = 1);
     Q_INVOKABLE void cursorLeft(int cnt = 1);
     Q_INVOKABLE void shiftCursorLeft(int cnt = 1);
     Q_INVOKABLE void cursorRight(int cnt = 1);
     Q_INVOKABLE void shiftCursorRight(int cnt = 1);
     Q_INVOKABLE void wordLeft(int cnt = 1);
     Q_INVOKABLE void shiftWordLeft(int cnt = 1);
     Q_INVOKABLE void wordRight(int cnt = 1);
     Q_INVOKABLE void shiftWordRight(int cnt = 1);
     Q_INVOKABLE void home(int cnt = 1);
     Q_INVOKABLE void shiftHome(int cnt = 1);
     Q_INVOKABLE void end(int cnt = 1);
     Q_INVOKABLE void shiftEnd(int cnt = 1);
     Q_INVOKABLE void up(int cnt = 1);
     Q_INVOKABLE void shiftUp(int cnt = 1);
     Q_INVOKABLE void down(int cnt = 1);
     Q_INVOKABLE void shiftDown(int cnt = 1);
     Q_INVOKABLE void scrollUp(int cnt = 1);
     Q_INVOKABLE void scrollDown(int cnt = 1);
     Q_INVOKABLE void topOfView(int cnt = 1);
     Q_INVOKABLE void shiftTopOfView(int cnt = 1);
     Q_INVOKABLE void bottomOfView(int cnt = 1);
     Q_INVOKABLE void shiftBottomOfView(int cnt = 1);
     Q_INVOKABLE void pageUp(int cnt = 1);
     Q_INVOKABLE void shiftPageUp(int cnt = 1);
     Q_INVOKABLE void pageDown(int cnt = 1);
     Q_INVOKABLE void shiftPageDown(int cnt = 1);
     Q_INVOKABLE void top(int cnt = 1);
     Q_INVOKABLE void shiftTop(int cnt = 1);
     Q_INVOKABLE void bottom(int cnt = 1);
     Q_INVOKABLE void shiftBottom(int cnt = 1);
     Q_INVOKABLE void toMatchingBracket(int cnt = 1);
     Q_INVOKABLE void shiftToMatchingBracket(int cnt = 1);
 
     Q_INVOKABLE void type(const QString &str);
     Q_INVOKABLE void paste(const QString &str);
 
     /**
      * Toggle auto brackets. If you make use of it, make sure to
      * disable them again at the end of your test, otherwise any following tests may fail.
      */
     Q_INVOKABLE void setAutoBrackets(bool enable = true);
 
     /*
      * Whether to replace tabs with spaces
      */
     Q_INVOKABLE void replaceTabs(bool enable = true);
 
     // Aliases
     Q_INVOKABLE void enter(int cnt = 1); // KeyReturn
     Q_INVOKABLE void cursorPrev(int cnt = 1); // CursorLeft
     Q_INVOKABLE void left(int cnt = 1); // CursorLeft
     Q_INVOKABLE void prev(int cnt = 1); // CursorLeft
     Q_INVOKABLE void shiftCursorPrev(int cnt = 1); // ShiftCursorLeft
     Q_INVOKABLE void shiftLeft(int cnt = 1); // ShiftCursorLeft
     Q_INVOKABLE void shiftPrev(int cnt = 1); // ShiftCursorLeft
     Q_INVOKABLE void cursorNext(int cnt = 1); // CursorRight
     Q_INVOKABLE void right(int cnt = 1); // CursorRight
     Q_INVOKABLE void next(int cnt = 1); // CursorRight
     Q_INVOKABLE void shiftCursorNext(int cnt = 1); // ShiftCursorRight
     Q_INVOKABLE void shiftRight(int cnt = 1); // ShiftCursorRight
     Q_INVOKABLE void shiftNext(int cnt = 1); // ShiftCursorRight
     Q_INVOKABLE void wordPrev(int cnt = 1); // WordLeft
     Q_INVOKABLE void shiftWordPrev(int cnt = 1); // ShiftWordLeft
     Q_INVOKABLE void wordNext(int cnt = 1); // WordRight
     Q_INVOKABLE void shiftWordNext(int cnt = 1); // ShiftWordRight
 
 private:
     Q_DISABLE_COPY(KateViewObject)
 };
 
 /**
  * @internal
  */
 class KateDocumentObject : public KateScriptDocument
 {
     Q_OBJECT
 
 public:
     explicit KateDocumentObject(QJSEngine *engine, KTextEditor::DocumentPrivate *doc);
     ~KateDocumentObject() override;
 
 private:
     Q_DISABLE_COPY(KateDocumentObject)
 };
 
 /**
  * Customizing output to result-files. Writing any output into result files
  * inhibits outputting the content of the katepart after script execution,
  * enabling one to check for coordinates and the like.
  * @internal
  */
 class OutputObject : public QObject
 {
     Q_OBJECT
 
 public:
     OutputObject(KTextEditor::ViewPrivate *v, bool &cflag);
     ~OutputObject() override;
 
     void output(bool cp, bool ln);
 
     Q_INVOKABLE void write();
     Q_INVOKABLE void writeln();
     Q_INVOKABLE void writeLn();
 
     Q_INVOKABLE void print();
     Q_INVOKABLE void println();
     Q_INVOKABLE void printLn();
 
     Q_INVOKABLE void writeCursorPosition();
     Q_INVOKABLE void writeCursorPositionln();
 
     Q_INVOKABLE void cursorPosition();
     Q_INVOKABLE void cursorPositionln();
     Q_INVOKABLE void cursorPositionLn();
 
     Q_INVOKABLE void pos();
     Q_INVOKABLE void posln();
     Q_INVOKABLE void posLn();
 
 private:
     KTextEditor::ViewPrivate *view;
     bool &cflag;
 };
 #endif // TESTUTILS_H