pqPythonShell.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqPythonShell_h
#define pqPythonShell_h

#include "pqPythonModule.h" //  needed for PQPYTHON_EXPORT.
#include <QScopedPointer>   // needed for QScopedPointer.
#include <QWidget>

class vtkObject;
class pqConsoleWidget;

class PQPYTHON_EXPORT pqPythonShell : public QWidget
{
  Q_OBJECT
  typedef QWidget Superclass;

public:
  pqPythonShell(QWidget* parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags{});
  ~pqPythonShell() override;

  void* consoleLocals();


  void setFontSize(int fontSize);

  enum PrintMode
  {
    STATUS,
    OUTPUT,
    ERROR
  };

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void printMessage(const QString&);

  void clear();

  void executeScript(const QString&);

  void reset();

  bool isExecuting() const;

  void printString(const QString&, PrintMode mode = STATUS);

  static void setPreamble(const QStringList& statements);
  static const QStringList& preamble();

  void initialize();

Q_SIGNALS:
  void executing(bool starting);

protected Q_SLOTS:
  void pushScript(const QString&);
  void runScript();

protected: // NOLINT(readability-redundant-access-specifiers)
  pqConsoleWidget* ConsoleWidget;
  const char* Prompt;
  static QStringList Preamble;

  static const char* PS1() { return ">>> "; }
  static const char* PS2() { return "... "; }

  bool prompt(const QString& indent = QString());

  void HandleInterpreterEvents(vtkObject* caller, unsigned long eventid, void* calldata);

private:
  Q_DISABLE_COPY(pqPythonShell)
  bool Prompted;

  class pqInternals;
  friend class pqInternals;
  QScopedPointer<pqInternals> Internals;
};

#endif // !pqPythonShell_h