ScriptEditor.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------
// Includes
//----------------------------------
#include "DllOption.h"
#include <QDialog>
#include <QTextDocument>
#include <Qsci/qsciscintilla.h>
 
//----------------------------------
// Forward declarations
//----------------------------------
class FindReplaceDialog;
 
class QAction;
class QMenu;
class QMimeData;
class QKeyEvent;
class QMouseEvent;
class QsciAPIs;
 
class EXPORT_OPT_MANTIDQT_COMMON ScriptEditor : public QsciScintilla {
  // Qt macro
  Q_OBJECT
 
public:
  class SaveCancelledException : public std::exception {
  public:
    const char *what() const noexcept override { return m_msg.c_str(); }
 
  private:
    std::string m_msg{"File Saving was cancelled"};
  };
 
public:
  ScriptEditor(const QString &lexerName, const QFont &font = QFont(), QWidget *parent = nullptr);
  ScriptEditor(QWidget *parent = nullptr, QsciLexer *lexer = nullptr, QString settingsGroup = "");
  ~ScriptEditor() override;
 
  void setSettingsGroup(const QString &name);
  const QString &settingsGroup() const;
  void readSettings();
  void writeSettings();
 
  void setLexer(QsciLexer * /*codelexer*/) override final;
  // Make the object resize to margin to fit the contents
  void setAutoMarginResize();
  void enableAutoCompletion(AutoCompletionSource source = QsciScintilla::AcsAPIs);
  void disableAutoCompletion();
 
  // Size hint
  QSize sizeHint() const override;
  // Unhide base class method to avoid intel compiler warning
  using QsciScintilla::setText;
  void setText(int lineno, const QString &text, int index = 0);
  void keyPressEvent(QKeyEvent *event) override;
  const inline QString &fileName() const { return m_filename; }
  void setFileName(const QString &filename);
 
  void wheelEvent(QWheelEvent *e) override;
 
  void clearKeyBinding(const QString &keyCombination);
 
  inline QsciAPIs *scintillaAPI() const { return m_completer; }
 
  void replaceAll(const QString &search, const QString &replace, bool regex, bool caseSensitive, bool matchWords,
                  bool wrap, bool forward = true);
 
  int getZoom() const;
 
public slots:
  void saveAs();
  void saveToCurrentFile();
  void saveScript(const QString &filename);
 
  void padMargin();
  void setMarkerState(bool enabled);
  void updateProgressMarkerFromThread(int lineno, bool error = false);
  void updateProgressMarker(int lineno, bool error = false);
  void markExecutingLineAsError();
  void updateCompletionAPI(const QStringList &keywords);
  void print();
  virtual void showFindReplaceDialog();
  void markFileAsModified();
 
signals:
  void undoAvailable(bool /*_t1*/);
  void redoAvailable(bool /*_t1*/);
  void textZoomedIn();
  void textZoomedOut();
  void fileNameChanged(const QString &fileName);
  void progressMade(const int progress);
  void editorFocusIn(const QString &filename);
 
protected:
  virtual void writeToDevice(QIODevice &device) const;
 
  void dropEvent(QDropEvent *de) override;
  void dragMoveEvent(QDragMoveEvent *de) override;
  void dragEnterEvent(QDragEnterEvent *de) override;
  QByteArray fromMimeData(const QMimeData *source, bool &rectangular) const override;
  void focusInEvent(QFocusEvent *fe) override;
 
private slots:
 
private:
  void forwardKeyPressToBase(QKeyEvent *event);
 
  QString m_filename;
 
  int m_progressArrowKey;
  int m_currentExecLine;
  QsciAPIs *m_completer;
  static QColor g_success_colour;
  static QColor g_error_colour;
  int m_previousKey;
  FindReplaceDialog *m_findDialog;
  QString m_settingsGroup;
};