Developer Documentation
PythonInterpreter.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 #pragma once
43 
44 #include <OpenFlipper/Core/Core.hh>
45 
49 class PythonInterpreter : public QObject {
50  Q_OBJECT
51 
52  signals:
54  void log(Logtype _type , QString _message );
55 
56 public:
57 
58 
60 
69 
75  bool runScript(QString _script);
76 
82  QString runScriptOutput(QString _script);
83 
84 
85 private:
86 
91 
95  void initPython();
96 
100  void resetInterpreter();
101 
102 
103  bool modulesInitialized();
104 
109  void pyOutput(const char* w);
110 
115  void pyError(const char* w);
116 
117 
118 private:
119  bool externalLogging_;
120  QString LogErr;
121  QString LogOut;
122 };
123 
132 void setCorePointer( Core* _core );
133 
134 
135 
void log(Logtype _type, QString _message)
Log with OUT,WARN or ERR as type.
void resetInterpreter()
Resets the interpreter and all states.
PythonInterpreter()
private constructor because of singleton
bool runScript(QString _script)
Run a script. Output is passed to the standard logging facilities of OpenFlipper. ...
static PythonInterpreter * getInstance()
Creates or returns an instance of the interpreter.
Definition: Core.hh:132
Logtype
Log types for Message Window.
QString runScriptOutput(QString _script)
This class provides OpenFlippers Python interpreter.
void pyOutput(const char *w)
Callback to redirect cout log to OpenFlipper logger.
void pyError(const char *w)
Callback to redirect cerr log to OpenFlipper logger.
void initPython()
Initialize OpenFlipper Python Interpreter.