MessageDisplay.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidQtWidgets/Common/Configurable.h"
#include "MantidQtWidgets/Common/Message.h"
#include "MantidQtWidgets/Common/QtSignalChannel.h"
 
#include <QHash>
#include <QTextCharFormat>
#include <QTextCursor>
#include <QWidget>
 
//----------------------------------------------------------
// Forward declarations
//----------------------------------------------------------
class QAction;
class QActionGroup;
class QMenu;
class QPlainTextEdit;
class QPoint;
class QSettings;
class QShowEvent;
class QSignalMapper;
 
namespace MantidQt {
namespace MantidWidgets {
 
class EXPORT_OPT_MANTIDQT_COMMON MessageDisplaySettings {
public:
  MessageDisplaySettings(int logLevel = 0, int maximumLineCount = 8192);
 
  [[nodiscard]] int logLevel() const;
  [[nodiscard]] int maximumLineCount() const;
 
private:
  int m_logLevel;
  int m_maximumLineCount;
};
 
class EXPORT_OPT_MANTIDQT_COMMON MessageDisplay : public QWidget, public Configurable<MessageDisplaySettings> {
  Q_OBJECT
  Q_PROPERTY(QString source READ source WRITE setSource)
 
public:
  [[nodiscard]] MessageDisplaySettings readSettings(const QSettings &storage) const;
  void restoreSettings(const MessageDisplaySettings &settings) override;
  [[nodiscard]] MessageDisplaySettings captureSettings() const override;
  void saveSettings(QSettings &storage, const MessageDisplaySettings &settings) const;
 
public:
  MessageDisplay(QWidget *parent = nullptr);
  MessageDisplay(const QFont &font, QWidget *parent = nullptr);
  MessageDisplay(const MessageDisplay &) = delete;
  MessageDisplay &operator=(const MessageDisplay &) = delete;
  ~MessageDisplay() override;
 
  // Setup logging framework connections
  void attachLoggingChannel(int logLevel = 0);
  void setSource(const QString &source);
  inline const QString &source() const { return m_logChannel->source(); }
  QPlainTextEdit *getTextEdit() { return m_textDisplay; }
  const QList<Message> &getHistory() { return m_messageHistory; }
  QMenu *generateContextMenu();
  void filterMessages();
  void filePathModified(const QString &oldPath, const QString &newPath);
  void appendToHistory(const Message &msg);
  inline bool showFrameworkOutput() const { return m_showFrameworkOutput; }
  void setShowFrameworkOutput(const bool &show) { m_showFrameworkOutput = show; }
  inline bool showAllScriptOutput() const { return m_showAllScriptOutput; }
  void setShowAllScriptOutput(const bool &show) { m_showAllScriptOutput = show; }
  inline bool showActiveScriptOutput() const { return m_showActiveScriptOutput; }
  void setShowActiveScriptOutput(const bool &show) { m_showActiveScriptOutput = show; }
  inline const QString &activeScript() const { return m_activeScript; }
  void setActiveScript(const QString &scriptPath) { m_activeScript = scriptPath; }
 
signals:
  void errorReceived(const QString &text);
  void warningReceived(const QString &text);
 
public slots:
  void appendFatal(const QString &text);
  void appendError(const QString &text);
  void appendWarning(const QString &text);
  void appendNotice(const QString &text);
  void appendInformation(const QString &text);
  void appendDebug(const QString &text);
  void append(const Message &msg);
  void appendPython(const QString &text, const int &priority, const QString &fileName);
  void replace(const Message &msg);
  void clear();
  QTextCursor moveCursorToEnd();
  bool isScrollbarAtBottom() const;
  void scrollToTop();
  void scrollToBottom();
 
private slots:
  void showContextMenu(const QPoint &event);
  void setLogLevel(int priority);
  void setScrollbackLimit();
  int maximumLineCount() const;
  void setMaximumLineCount(int count);
 
private:
  void initActions();
  void initFormats();
  void setupTextArea(const QFont &font);
  QTextCharFormat format(const Message::Priority priority) const;
  bool shouldBeDisplayed(const Message &msg);
 
  QtSignalChannel *m_logChannel;
  QPlainTextEdit *m_textDisplay;
  QHash<Message::Priority, QTextCharFormat> m_formats;
  QActionGroup *m_loglevels;
  QSignalMapper *m_logLevelMapping;
  QAction *m_error, *m_warning, *m_notice, *m_information, *m_debug;
  QList<Message> m_messageHistory;
  bool m_showFrameworkOutput{true}, m_showAllScriptOutput{true}, m_showActiveScriptOutput{false};
  QString m_activeScript;
};
} // namespace MantidWidgets
} // namespace MantidQt