ScriptingPlugin.hh 8.1 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33
34
35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
42
\*===========================================================================*/

Jan Möbius's avatar
 
Jan Möbius committed
43
44
45
46
47
48
49
50
51
52
53
54
55
#ifndef SCRIPTINGPLUGIN_HH
#define SCRIPTINGPLUGIN_HH

#include <QObject>
#include <QMenuBar>

#include <OpenFlipper/common/Types.hh>
#include <OpenFlipper/BasePlugin/BaseInterface.hh>
#include <OpenFlipper/BasePlugin/MenuInterface.hh>
#include <OpenFlipper/BasePlugin/ScriptInterface.hh>
#include <OpenFlipper/BasePlugin/RPCInterface.hh>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>

56
57
58
59
60
// Include the scripttools for qt script debugging if available
#ifdef QT_SCRIPTTOOLS_LIB
  #include <QtScriptTools/QScriptEngineDebugger>
#endif

Jan Möbius's avatar
 
Jan Möbius committed
61
62
63
64
#include "highLighter.hh"
#include "scriptingWidget.hh"


65

Jan Möbius's avatar
 
Jan Möbius committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class ScriptingPlugin : public QObject, BaseInterface, MenuInterface, ScriptInterface, RPCInterface, LoggingInterface
{
Q_OBJECT
Q_INTERFACES(BaseInterface)
Q_INTERFACES(MenuInterface)
Q_INTERFACES(ScriptInterface)
Q_INTERFACES(RPCInterface)
Q_INTERFACES(LoggingInterface)

signals:
  void updateView();

  void getScriptingEngine( QScriptEngine*& _engine  );
  void getAvailableFunctions( QStringList& _functions  );

  void log(Logtype _type, QString _message);
  void log(QString _message);

84
  void getMenubarMenu (QString _name, QMenu *& _menu, bool _create);
Jan Möbius's avatar
 
Jan Möbius committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

  void getDescription(QString      _function,   QString&     _description,
                      QStringList& _parameters, QStringList& _descriptions);

private slots:

  void slotScriptInfo( QString _pluginName , QString _functionName  );
  void slotExecuteScript( QString _script );
  void slotExecuteFileScript( QString _filename );

  void slotLoadScript();
  void slotSaveScript();
  void slotSaveScriptAs();
  void pluginsInitialized();

  void noguiSupported( ) {} ;

public :

  ScriptingPlugin();

Dirk Wilden's avatar
Dirk Wilden committed
106
107
  QString name() { return (QString(tr("Scripting"))); };
  QString description( ) { return (QString(tr("Provides Scripting for OpenFlipper"))); };
Jan Möbius's avatar
 
Jan Möbius committed
108
109

private slots :
Jan Möbius's avatar
Jan Möbius committed
110

Jan Möbius's avatar
 
Jan Möbius committed
111
  void slotExecuteScriptButton();
Jan Möbius's avatar
Jan Möbius committed
112
113
114
115
116
117

  /** \brief Called everytime the text in the scriptingwidget is changed by the user
   *
   * This slot also handles syntax checking!
   */
  void slotScriptChanged();
Jan Möbius's avatar
 
Jan Möbius committed
118
119
120
121
122
123

  void slotFunctionClicked(QListWidgetItem* _item);
  void slotFunctionDoubleClicked(QListWidgetItem* _item);

  void slotApplyFilter();

Jan Möbius's avatar
Jan Möbius committed
124
125
126
  /// Called when an error is detected when checking the syntax
  void slotHighlightError();

127
128
129
  /// Triggered by the debugger button
  void slotDebuggerButton();

Jan Möbius's avatar
 
Jan Möbius committed
130
private:
Jan Möbius's avatar
Jan Möbius committed
131
132
133
134
135
136
137
138
139
140

  /// Store the last line that contained an error
  int lastProblemLine_;

  /// Store the last error message
  QString lastError_;

  /// Timer to wait until the user stopped typing before showing an error
  QTimer* errorTimer_;

Jan Möbius's avatar
 
Jan Möbius committed
141
142
143
144
145
146
147
148
149
  QList< QLabel* > descriptionLabels_;
  QVBoxLayout* descrLayout_;

//===========================================================================
/** @name Gui control from script
* @{ */
//===========================================================================

public slots:
Jan Möbius's avatar
Jan Möbius committed
150
151
152
153

  /** \brief Show the script editor widget
   *
   */
Jan Möbius's avatar
 
Jan Möbius committed
154
  void showScriptWidget();
Jan Möbius's avatar
Jan Möbius committed
155
156
157
158

  /** \brief Hide the script editor widget
   *
   */
Jan Möbius's avatar
 
Jan Möbius committed
159
160
  void hideScriptWidget();

Jan Möbius's avatar
Jan Möbius committed
161
162
163
164
  /** \brief Show the given Code in the script editor
   *
   * @param _code Code to show
   */
165
166
  void showScriptInEditor (QString _code);

167
168
169
170
171
172
173
174
  /** \brief Load Script into gui from file
  *
  * Loads a script from the given file and loads it into the widget.
  *
  * @param _filename Filename of script to load, including full path.
  */
  void slotLoadScript( QString _filename );
  
175
176
177
178
179
  /** \brief Clear the editor window
   * Clears the script editor window
   */
  void clearEditor();

Jan Möbius's avatar
 
Jan Möbius committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/** @} */

//===========================================================================
/** @name Interrupt script execution
* @{ */
//===========================================================================

public slots:

  /** Stops script execution and opens a message windows.
  *  Execution continues, when the user clicks on a button
  */
  void waitContinue( );

  /** Stops script execution and opens a message windows.
  *  Execution continues, when the user clicks on a button
  *  Also allowing the user to set a message
  */
  void waitContinue( QString _msg, int _x=-1, int _y=-1);


  /// Sleeps for some seconds in script execution ( Gui will remain functional)
  void sleep( int _seconds );

  /// Sleeps for some mseconds in script execution ( Gui will remain functional)
  void sleepmsecs( int _mseconds );

  /// Marks the current time as the frame start ( Use wait sleepFrameLength to wait until _mseconds have passed since frameStart )
  void frameStart( );

210
  /// wait until _mseconds have passed since frameStart (if more time has passed, it will return immediately)
Jan Möbius's avatar
 
Jan Möbius committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
  void waitFrameEnd( int _mseconds );

/** @} */


private :
  QString mangleScript( QString _input );

  /// Counts mseconds since a frame start has occured
  QTime frameTime_;

private :
  ScriptWidget* scriptWidget_;

225
  QStatusBar*   statusBar_;
Jan Möbius's avatar
 
Jan Möbius committed
226

227
228
229
230
231
  Highlighter*  highlighterCurrent_;
  Highlighter*  highlighterLive_;
  Highlighter*  highlighterList_;

  QString       lastFile_;
Jan Möbius's avatar
 
Jan Möbius committed
232

233
  QAction*      debuggerButton_;
Jan Möbius's avatar
Jan Möbius committed
234

235
236
237
238
239
240
#ifdef QT_SCRIPTTOOLS_LIB
  QScriptEngineDebugger* debugger_;
#endif



Jan Möbius's avatar
 
Jan Möbius committed
241
242
243
244
245
246
public slots:
  QString version() { return QString("1.0"); };
};

#endif //SCRIPTINGPLUGIN_HH