ScriptingPlugin.hh 8.4 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
4 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 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * 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 COPYRIGHT HOLDER *
 * 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.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42

43

44 45 46
#ifndef SCRIPTINGPLUGIN_HH
#define SCRIPTINGPLUGIN_HH

Jan Möbius's avatar
Jan Möbius committed
47

48 49 50 51 52 53
#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>

54 55 56 57 58
// 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
59 60
#include "widgets/highLighter.hh"
#include "widgets/scriptingWidget.hh"
61

Jan Möbius's avatar
Jan Möbius committed
62 63
#include <QObject>
#include <QMenuBar>
64

65 66 67 68 69 70 71 72 73
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)

74 75
  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-Scripting")

76 77 78 79 80 81 82 83 84
signals:
  void updateView();

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

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

85
  void getMenubarMenu (QString _name, QMenu *& _menu, bool _create);
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

  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
107 108
  QString name() { return (QString(tr("Scripting"))); };
  QString description( ) { return (QString(tr("Provides Scripting for OpenFlipper"))); };
109 110

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

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

  /** \brief Called everytime the text in the scriptingwidget is changed by the user
   *
   * This slot also handles syntax checking!
   */
  void slotScriptChanged();
119 120 121 122 123 124

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

  void slotApplyFilter();

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

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

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

  /// 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_;

142 143 144 145 146 147 148 149 150
  QList< QLabel* > descriptionLabels_;
  QVBoxLayout* descrLayout_;

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

public slots:
151 152 153 154

  /** \brief Show the script editor widget
   *
   */
155
  void showScriptWidget();
156 157 158 159

  /** \brief Hide the script editor widget
   *
   */
160 161
  void hideScriptWidget();

162 163 164 165
  /** \brief Show the given Code in the script editor
   *
   * @param _code Code to show
   */
166 167
  void showScriptInEditor (QString _code);

168 169 170 171 172 173 174 175
  /** \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 );
  
176 177 178 179 180
  /** \brief Clear the editor window
   * Clears the script editor window
   */
  void clearEditor();

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 210
/** @} */

//===========================================================================
/** @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( );

211
  /// wait until _mseconds have passed since frameStart (if more time has passed, it will return immediately)
212 213 214 215 216 217 218 219 220 221 222 223 224 225
  void waitFrameEnd( int _mseconds );

/** @} */


private :
  QString mangleScript( QString _input );

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

private :
  ScriptWidget* scriptWidget_;

226
  QStatusBar*   statusBar_;
227

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

  QString       lastFile_;
233

234 235 236 237 238
  /** Path to the directory where the current script is executed.
   *  This might be empty, if a script is not saved!
   */
  QString       scriptPath_;

239
  QAction*      debuggerButton_;
Jan Möbius's avatar
Jan Möbius committed
240

241 242
#ifdef ENABLE_SCRIPT_DEBUGGER
 #ifdef QT_SCRIPTTOOLS_LIB
243
  QScriptEngineDebugger* debugger_;
244
 #endif
245 246 247 248
#endif



249 250 251 252 253 254
public slots:
  QString version() { return QString("1.0"); };
};

#endif //SCRIPTINGPLUGIN_HH