mirror of
https://github.com/OpenFOAM/ThirdParty-6.git
synced 2025-12-08 06:57:43 +00:00
ParaView-5.0.1: Added the source-tree to ThirdParty-dev and patched as described in the README file
Resolves bug-report http://bugs.openfoam.org/view.php?id=2098
This commit is contained in:
141
ParaView-5.0.1/Qt/Python/pqPythonShell.h
Normal file
141
ParaView-5.0.1/Qt/Python/pqPythonShell.h
Normal file
@ -0,0 +1,141 @@
|
||||
/*=========================================================================
|
||||
|
||||
Program: ParaView
|
||||
Module: pqPythonShell.h
|
||||
|
||||
Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
|
||||
All rights reserved.
|
||||
|
||||
ParaView is a free software; you can redistribute it and/or modify it
|
||||
under the terms of the ParaView license version 1.2.
|
||||
|
||||
See License_v1.2.txt for the full ParaView license.
|
||||
A copy of this license can be obtained by contacting
|
||||
Kitware Inc.
|
||||
28 Corporate Drive
|
||||
Clifton Park, NY 12065
|
||||
USA
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
|
||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
=========================================================================*/
|
||||
#ifndef _pqPythonShell_h
|
||||
#define _pqPythonShell_h
|
||||
|
||||
#include "pqPythonModule.h" // needed for PQPYTHON_EXPORT.
|
||||
#include <QWidget>
|
||||
#include "pqTimer.h"
|
||||
|
||||
class vtkObject;
|
||||
class pqConsoleWidget;
|
||||
class vtkPythonInteractiveInterpreter;
|
||||
|
||||
/// pqPythonShell is a QWidget subclass that provides an interactive Python
|
||||
/// shell. It uses vtkPythonInterpreter to provide an interactive Python
|
||||
/// terminal without starting a separate Python event loop.
|
||||
///
|
||||
/// Python will be initialized (if not already), when pqPythonShell is
|
||||
/// instantiated.
|
||||
///
|
||||
/// \sa pqConsoleWidget, pqPythonDialog.
|
||||
class PQPYTHON_EXPORT pqPythonShell : public QWidget
|
||||
{
|
||||
Q_OBJECT
|
||||
typedef QWidget Superclass;
|
||||
public:
|
||||
pqPythonShell(QWidget* parent=0, Qt::WindowFlags flags=0);
|
||||
~pqPythonShell();
|
||||
|
||||
/// Returns the interactive console context (the locals() dict).
|
||||
/// You can use static_cast<PythonObject*>() to convert the void pointer.
|
||||
/// See vtkPythonInteractiveInterpreter::GetInteractiveConsoleLocalsPyObject().
|
||||
void* consoleLocals();
|
||||
|
||||
enum PrintMode
|
||||
{
|
||||
STATUS,
|
||||
OUTPUT,
|
||||
ERROR
|
||||
};
|
||||
|
||||
public slots:
|
||||
/// Prints some text on the shell.
|
||||
void printMessage(const QString&);
|
||||
|
||||
/// Clears the terminal. This does not change the state of the Python
|
||||
/// interpreter, just clears the text shown in the Widget.
|
||||
void clear();
|
||||
|
||||
/// Execute an arbitrary python script/string. This simply execute the Python
|
||||
/// script in the global Python interpreter.
|
||||
void executeScript(const QString&);
|
||||
|
||||
/// Resets the python interactive interpreter. This does not affect the global
|
||||
/// Python interpreter.
|
||||
void reset();
|
||||
|
||||
/// Returns true is the shell is currently executing a script/command.
|
||||
bool isExecuting() const
|
||||
{ return this->Executing; }
|
||||
|
||||
/// Use this method instead of calling pqConsoleWidget::printString()
|
||||
/// directly. That helps us keep track of whether we need to show the prompt
|
||||
/// or not.
|
||||
void printString(const QString&, PrintMode mode=STATUS);
|
||||
|
||||
/// Set a list of statements to be run each time the interpreter is reset.
|
||||
///
|
||||
/// By default, this imports the paraview.simple module.
|
||||
/// If you call this method, be aware that the preamble is
|
||||
/// assumed not to have any multi-line statements.
|
||||
static void setPreamble(const QStringList& statements);
|
||||
|
||||
signals:
|
||||
/// signal fired whenever the shell starts (starting=true) and finishes
|
||||
/// (starting=false) executing a Python command/script. This can be used by
|
||||
/// the UI to block user input while the script is executing.
|
||||
void executing(bool starting);
|
||||
|
||||
protected slots:
|
||||
void pushScript(const QString&);
|
||||
void setExecuting(bool val) { this->Executing = val; }
|
||||
|
||||
protected:
|
||||
pqConsoleWidget* ConsoleWidget;
|
||||
vtkPythonInteractiveInterpreter* Interpreter;
|
||||
const char* Prompt;
|
||||
static QStringList Preamble;
|
||||
|
||||
static const char* PS1() { return ">>> "; }
|
||||
static const char* PS2() { return "... "; }
|
||||
|
||||
/// Called to setup the Python interpreter during startup or after the Python
|
||||
/// environment was finalized.
|
||||
void setupInterpreter();
|
||||
friend class pqPythonManager;
|
||||
|
||||
/// Show the user-input prompt, if needed. Returns true if the prompt was
|
||||
/// re-rendered, otherwise false.
|
||||
bool prompt(const QString& indent=QString());
|
||||
|
||||
void HandleInterpreterEvents(
|
||||
vtkObject* caller, unsigned long eventid, void* calldata);
|
||||
|
||||
private:
|
||||
Q_DISABLE_COPY(pqPythonShell);
|
||||
|
||||
bool Prompted;
|
||||
bool Executing;
|
||||
};
|
||||
|
||||
#endif // !_pqPythonShell_h
|
||||
Reference in New Issue
Block a user