ScriptingPlugin.cc 22.2 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-2014 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
56
#include "ScriptingPlugin.hh"

#include <ACG/GL/GLState.hh>

#include <OpenFlipper/BasePlugin/PluginFunctions.hh>

#include "OpenFlipper/common/GlobalOptions.hh"

#include <QFileDialog>
#include <QFile>
#include <QFileInfo>
#include <QTextStream>
#include <QSyntaxHighlighter>

57
58
59
60
61
#if QT_VERSION >= 0x050000 
#include <QtWidgets>
#else
#include <QtGui>
#endif
62
63


Jan Möbius's avatar
Jan Möbius committed
64
65
66
67
68
69
70
71
72
73
ScriptingPlugin::ScriptingPlugin() :
   lastProblemLine_(0),
   lastError_(""),
   errorTimer_(0),
   descrLayout_(0),
   scriptWidget_(0),
   statusBar_(0),
   highlighterCurrent_(0),
   highlighterLive_(0),
   highlighterList_(0),
74
   lastFile_(""),
Jan Möbius's avatar
Jan Möbius committed
75
   scriptPath_(""),
76
   debuggerButton_(0)
77
#ifdef ENABLE_SCRIPT_DEBUGGER
78
  #ifdef QT_SCRIPTTOOLS_LIB
79
   ,debugger_(0)
80
  #endif
81
#endif
Jan Möbius's avatar
Jan Möbius committed
82
{
Jan Möbius's avatar
 
Jan Möbius committed
83
84
85
86
87
88
89
90
91
92
93

}

void ScriptingPlugin::pluginsInitialized() {

  if ( OpenFlipper::Options::nogui() )
    return;

  ///@todo register objectid variable

  // Scriping Menu
94
  QMenu *scriptingMenu;
Jan Möbius's avatar
 
Jan Möbius committed
95

96
  emit getMenubarMenu(tr("&Scripting"), scriptingMenu, true );
Jan Möbius's avatar
 
Jan Möbius committed
97
98

  QIcon icon;
Dirk Wilden's avatar
Dirk Wilden committed
99
  QAction* showWidget = scriptingMenu->addAction( tr("Show script editor") );
Jan Möbius's avatar
 
Jan Möbius committed
100
101
102
103
104
105
106
  icon.addFile(OpenFlipper::Options::iconDirStr()+OpenFlipper::Options::dirSeparator()+"scriptEditor.png");
  showWidget->setIcon(icon);
  connect( showWidget, SIGNAL( triggered() ) ,
           this      , SLOT( showScriptWidget() ));

  scriptWidget_ = new ScriptWidget();

Jan Möbius's avatar
Jan Möbius committed
107
108
109

  QString iconPath = OpenFlipper::Options::iconDirStr() + OpenFlipper::Options::dirSeparator();

Jan Möbius's avatar
 
Jan Möbius committed
110
111
  scriptWidget_->setWindowIcon( OpenFlipper::Options::OpenFlipperIcon() );

Jan Möbius's avatar
Jan Möbius committed
112
  icon.addFile(iconPath+"document-open.png");
Jan Möbius's avatar
 
Jan Möbius committed
113
114
  scriptWidget_->actionLoad_Script->setIcon(icon);

Jan Möbius's avatar
Jan Möbius committed
115
  icon.addFile(iconPath+"document-save.png");
Jan Möbius's avatar
 
Jan Möbius committed
116
117
  scriptWidget_->actionSave_Script->setIcon(icon);

Jan Möbius's avatar
Jan Möbius committed
118
  icon.addFile(iconPath+"document-save-as.png");
Jan Möbius's avatar
 
Jan Möbius committed
119
120
  scriptWidget_->actionSave_Script_As->setIcon(icon);

Jan Möbius's avatar
Jan Möbius committed
121
  icon.addFile(iconPath+"window-close.png");
Jan Möbius's avatar
 
Jan Möbius committed
122
123
  scriptWidget_->actionClose->setIcon(icon);

124
125
126
127
128
  // ==================================================================
  // Add a toolbar
  // ==================================================================

  QToolBar* toolBar = new QToolBar(tr("Scripting Toolbar"));
Jan Möbius's avatar
Jan Möbius committed
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

  QAction* openButton = new QAction(QIcon(iconPath + "document-open.png"), "Open", toolBar);
  toolBar->addAction(openButton);
  connect (openButton, SIGNAL( triggered() ), this, SLOT( slotLoadScript() ) );

  QAction* saveButton = new QAction(QIcon(iconPath + "document-save.png"), "Save", toolBar);
  toolBar->addAction(saveButton);
  connect (saveButton, SIGNAL( triggered() ), this, SLOT( slotSaveScript() ) );

  QAction* saveAsButton = new QAction(QIcon(iconPath + "document-save-as.png"), "Save as", toolBar);
  toolBar->addAction(saveAsButton);
  connect (saveAsButton, SIGNAL( triggered() ), this, SLOT( slotSaveScriptAs() ) );

  toolBar->addSeparator();

144
145
146
147
  debuggerButton_ = new QAction(QIcon(iconPath + "script-debugger.png"), "Enable Debugger", toolBar);
  debuggerButton_->setCheckable(true);
  toolBar->addAction(debuggerButton_);

148
#ifdef ENABLE_SCRIPT_DEBUGGER
149
150
151
152
153
154
155
156
  if ( OpenFlipperSettings().value("Scripting/QtScriptDebugger",true).toBool() )
    debuggerButton_->setChecked(true);
  else
    debuggerButton_->setChecked(false);

  connect (debuggerButton_, SIGNAL( triggered() ), this, SLOT( slotDebuggerButton() ) );
#else
  debuggerButton_->setEnabled(false);
157
  debuggerButton_->setToolTip(tr("QtScriptTools library not available. Debugger is not available!"));
158
159
160
161
#endif

  toolBar->addSeparator();

Jan Möbius's avatar
Jan Möbius committed
162
163
164
165
166
167
  QAction* executeButton = new QAction(QIcon(iconPath + "arrow-right.png"), "Execute", toolBar);
  toolBar->addAction(executeButton);
  connect (executeButton, SIGNAL( triggered() ), this, SLOT( slotExecuteScriptButton() ) );

  scriptWidget_->addToolBar(toolBar);

168
169
170
171
172
173
174
175
176
177
  // ==================================================================
  // Create a status bar
  // ==================================================================

  statusBar_ = new QStatusBar();

  scriptWidget_->setStatusBar( statusBar_ );

  // ==================================================================

Jan Möbius's avatar
 
Jan Möbius committed
178
179
180
181
182
183
184
185
186
187
188
  scriptWidget_->hide();

  scriptWidget_->resize(scriptWidget_->width() , std::min(QApplication::desktop()->screenGeometry().height() - 150 , 800) );

  connect (scriptWidget_->actionLoad_Script, SIGNAL( triggered() ), this, SLOT( slotLoadScript() ) );
  scriptWidget_->actionLoad_Script->setShortcut( QKeySequence(Qt::CTRL + Qt::Key_O) );
  connect (scriptWidget_->actionSave_Script, SIGNAL( triggered() ), this, SLOT( slotSaveScript() ) );
  scriptWidget_->actionSave_Script->setShortcut( QKeySequence(Qt::CTRL + Qt::Key_S) );
  connect (scriptWidget_->actionSave_Script_As, SIGNAL( triggered() ), this, SLOT( slotSaveScriptAs() ) );
  connect (scriptWidget_->actionClose, SIGNAL( triggered() ), scriptWidget_, SLOT( close() ) );

Jan Möbius's avatar
Jan Möbius committed
189
  connect (scriptWidget_->currentScript, SIGNAL( textChanged() ), this, SLOT( slotScriptChanged() ) );
Jan Möbius's avatar
 
Jan Möbius committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

  connect (scriptWidget_->functionList, SIGNAL( itemClicked(QListWidgetItem*) ),
           this,                          SLOT( slotFunctionClicked(QListWidgetItem*) ));
  connect (scriptWidget_->functionList, SIGNAL( itemDoubleClicked(QListWidgetItem*) ),
           this,                          SLOT( slotFunctionDoubleClicked(QListWidgetItem*) ));

  //filter
  connect (scriptWidget_->filterButton, SIGNAL( clicked() ),
           this,                          SLOT( slotApplyFilter() ));
  connect (scriptWidget_->resetButton, SIGNAL( clicked() ),
           scriptWidget_->functionList,  SLOT( reset() ));
  connect (scriptWidget_->resetButton, SIGNAL( clicked() ),
           scriptWidget_->filterEdit,  SLOT( clear() ));
  connect (scriptWidget_->functionList, SIGNAL(getDescription(QString,QString&,QStringList&,QStringList&)),
           this                       , SIGNAL(getDescription(QString,QString&,QStringList&,QStringList&)));

  scriptWidget_->description->setVisible( false );

208
  highlighterCurrent_ = new Highlighter( scriptWidget_->currentScript->document() );
Jan Möbius's avatar
 
Jan Möbius committed
209
210
211
  highlighterLive_    = new Highlighter( scriptWidget_->liveEdit );
//   highlighterList_    = new Highlighter( scriptWidget_->functionList  );
  frameTime_.start();
Jan Möbius's avatar
Jan Möbius committed
212
213
214
215
216
217
218
219


  // Timer for syntax error while editing. If the Syntax is not correct
  // And the text does not change for a specified time, the line will be highlighted
  // And a message printed to the status bar
  errorTimer_ = new QTimer();
  errorTimer_->setSingleShot(true);
  connect(errorTimer_,SIGNAL(timeout()),this,SLOT(slotHighlightError()));
220
221
222
223
224

  // ==================================================================
  // Setup scripting debugger if available
  // ==================================================================

225
#ifdef ENABLE_SCRIPT_DEBUGGER
226
 #ifdef QT_SCRIPTTOOLS_LIB
227
228
229
230
  QScriptEngine* engine;
  emit getScriptingEngine( engine  );
  debugger_ = new QScriptEngineDebugger;

231
  if ( OpenFlipperSettings().value("Scripting/QtScriptDebugger",false).toBool() )
232
    debugger_->attachTo(engine);
233
 #endif
234
#endif
Jan Möbius's avatar
 
Jan Möbius committed
235
236
237
238
239
240
}

void ScriptingPlugin::slotApplyFilter(){
  scriptWidget_->functionList->filter( scriptWidget_->filterEdit->text() );
}

Jan Möbius's avatar
Jan Möbius committed
241
void ScriptingPlugin::slotScriptChanged(){
Jan Möbius's avatar
 
Jan Möbius committed
242
  scriptWidget_->actionSave_Script->setEnabled( true );
Jan Möbius's avatar
Jan Möbius committed
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

  // Stop timers, as the text changed!
  errorTimer_->stop();

  // Check the current script for syntax
  const QString script = scriptWidget_->currentScript->toPlainText();
  QScriptSyntaxCheckResult syntaxCheck = QScriptEngine::checkSyntax ( script );

  switch (syntaxCheck.state() ) {
    case QScriptSyntaxCheckResult::Error :
      lastProblemLine_ = syntaxCheck.errorLineNumber();
      lastError_       = syntaxCheck.errorMessage();
      errorTimer_->start(500);
      break;
    case QScriptSyntaxCheckResult::Valid :
      break;
Jan Möbius's avatar
Jan Möbius committed
259
    default :
Jan Möbius's avatar
Jan Möbius committed
260
      break;
Jan Möbius's avatar
Jan Möbius committed
261
262
263
264
265
266
  }
}

void ScriptingPlugin::slotHighlightError() {
  scriptWidget_->currentScript->highLightErrorLine(lastProblemLine_);
  statusBar_->showMessage(lastError_,5000);
Jan Möbius's avatar
 
Jan Möbius committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
}

void ScriptingPlugin::showScriptWidget( ) {
  if ( OpenFlipper::Options::nogui() )
    return;

  scriptWidget_->show();

  // Update list of available functions
  QStringList completeList;
  emit getAvailableFunctions( completeList  );

  QStringList plugins;
  QStringList functions;

  scriptWidget_->functionList->clear( );

  //Update Highlighters
  for ( int i = 0  ; i <  completeList.size() ; ++i) {

    QString plugin   = completeList[i].section('.',0,0);
288
289
290
291
292
293

    // Global functions start with - and are not added as plugins!
    if (plugin != "-") {
      if ( ! plugins.contains( plugin ) )
        plugins.push_back( plugin );
    }
Jan Möbius's avatar
 
Jan Möbius committed
294
295
296
297
298
299
300


    QString function = completeList[i].section('.',1,1);
    function         = function.section('(',0,0);
    if ( ! functions.contains( function ) )
      functions.push_back( function );

301
302
303
304
305
    // Either write the whole string or cut the "-." for global functions
    if ( plugin != "-")
      scriptWidget_->functionList->addItem( completeList[i] );
    else
      scriptWidget_->functionList->addItem( completeList[i].right(completeList[i].size() - 2) );
Jan Möbius's avatar
 
Jan Möbius committed
306
307
308

  }

309
310
311
  // Sort the available functions
  scriptWidget_->functionList->sortItems ( );

Jan Möbius's avatar
 
Jan Möbius committed
312
313
314
315
316
317
318
319
320
321
  highlighterCurrent_->pluginPatterns_   = plugins;
  highlighterCurrent_->functionPatterns_ = functions;
  highlighterCurrent_->update();
  highlighterCurrent_->rehighlight();

  highlighterLive_->pluginPatterns_      = plugins;
  highlighterLive_->functionPatterns_    = functions;
  highlighterLive_->update();
  highlighterLive_->rehighlight();

322
323
324
  // Bring it to foreground
  scriptWidget_->raise();

Jan Möbius's avatar
 
Jan Möbius committed
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
}

void ScriptingPlugin::hideScriptWidget( ) {
  if ( OpenFlipper::Options::nogui() )
    return;

  scriptWidget_->hide();
}

void ScriptingPlugin::slotScriptInfo( QString _pluginName , QString _functionName  ) {

  if ( OpenFlipper::Options::scripting() || OpenFlipper::Options::nogui()  )
    return;

  scriptWidget_->liveEdit->append( _pluginName + "." + _functionName );

  QScrollBar* bar = scriptWidget_->liveEdit->verticalScrollBar();
  bar->setValue(bar->maximum());
}

void ScriptingPlugin::slotExecuteScript( QString _script ) {
346
347
348
349

  if ( OpenFlipper::Options::gui())
    statusBar_->showMessage(tr("Executing Script"));

Jan Möbius's avatar
 
Jan Möbius committed
350
351
352
353
354
355
356
  QScriptEngine* engine;
  emit getScriptingEngine( engine  );

  /// Switch scripting mode on
  OpenFlipper::Options::scripting(true);

  // Get the filename of the script and set it in the scripting environment
Jan Möbius's avatar
Jan Möbius committed
357
  engine->globalObject().setProperty("ScriptPath",OpenFlipper::Options::currentScriptDirStr());
Jan Möbius's avatar
 
Jan Möbius committed
358

359
  // Execute the script
Jan Möbius's avatar
 
Jan Möbius committed
360
  engine->evaluate( _script );
361
362
363

  // Catch errors and print some reasonable error message to log and statusbar
  bool error = false;
Jan Möbius's avatar
 
Jan Möbius committed
364
  if ( engine->hasUncaughtException() ) {
365
    error = true;
Jan Möbius's avatar
 
Jan Möbius committed
366
367
    QScriptValue result = engine->uncaughtException();
    QString exception = result.toString();
368
369
370
    int lineNumber = engine->uncaughtExceptionLineNumber();
    emit log( LOGERR , tr("Script execution failed at line %1, with : %2 ").arg(lineNumber).arg(exception) );

371
    if ( OpenFlipper::Options::gui()) {
372
        statusBar_->showMessage(tr("Script execution failed at line %1, with : %2 ").arg(lineNumber).arg(exception));
373
374
375
376
377
378
379
380

        // Get cursor and move it to the line containing the error
        QTextCursor cursor = scriptWidget_->currentScript->textCursor();
        cursor.setPosition(0);
        cursor.movePosition ( QTextCursor::Down, QTextCursor::MoveAnchor, lineNumber - 1 );
        scriptWidget_->currentScript->setTextCursor(cursor);

        scriptWidget_->currentScript->highLightErrorLine(lineNumber);
Jan Möbius's avatar
Jan Möbius committed
381
382
383
384

        lastProblemLine_ = lineNumber;
        lastError_       = exception;

385
    }
Jan Möbius's avatar
 
Jan Möbius committed
386
387
  }

388
389
390
  if ( OpenFlipper::Options::gui() && !error)
    statusBar_->clearMessage();

Jan Möbius's avatar
 
Jan Möbius committed
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
  /// Switch scripting mode off
  OpenFlipper::Options::scripting(false);
}

void ScriptingPlugin::slotExecuteFileScript( QString _filename ) {
  QString script;

  QFile data(_filename);
  if (data.open(QFile::ReadOnly)) {
    QTextStream input(&data);
    do {
      script.append(input.readLine() + "\n");
    } while (!input.atEnd());

    if ( OpenFlipper::Options::gui() )
406
      scriptWidget_->currentScript->setPlainText(script);
Jan Möbius's avatar
 
Jan Möbius committed
407

Jan Möbius's avatar
Jan Möbius committed
408
409
410
    // Set the correct execution environment
    OpenFlipper::Options::currentScriptDir( _filename.section(OpenFlipper::Options::dirSeparator(), 0, -2) );

Jan Möbius's avatar
 
Jan Möbius committed
411
412
413
    slotExecuteScript(script);

  } else
Dirk Wilden's avatar
Dirk Wilden committed
414
    emit log(LOGERR,tr("Unable to open script file!"));
Jan Möbius's avatar
 
Jan Möbius committed
415
416
417
418
419
420
}

void ScriptingPlugin::slotExecuteScriptButton() {
  slotExecuteScript( scriptWidget_->currentScript->toPlainText() );
}

421
422
void ScriptingPlugin::slotDebuggerButton() {

423
#ifdef ENABLE_SCRIPT_DEBUGGER
424
 #ifdef QT_SCRIPTTOOLS_LIB
425
426
427
428
429
430
431
432
433
434
  QScriptEngine* engine;
  emit getScriptingEngine( engine  );

  if ( debuggerButton_->isChecked() ) {
    debugger_->attachTo(engine);
  } else {
    debugger_->detach();
  }

  OpenFlipperSettings().setValue("Scripting/QtScriptDebugger",debuggerButton_->isChecked());
435
 #endif
436
437
438
439
#endif

}

Jan Möbius's avatar
 
Jan Möbius committed
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
QString ScriptingPlugin::mangleScript(QString _input ) {

  // Update list of available functions
  QStringList functions;
  emit getAvailableFunctions( functions  );

  std::cerr << "Todo : mangle script " << std::endl;
  return _input;

}

void ScriptingPlugin::sleep( int _seconds ) {

  if ( OpenFlipper::Options::nogui() )
    return;

  QTimer timer;

  timer.setSingleShot(true);
  timer.start( _seconds * 1000 );

  while (timer.isActive() )
    QApplication::processEvents();

}

void ScriptingPlugin::sleepmsecs( int _mseconds ) {

  if ( OpenFlipper::Options::nogui() )
    return;

  QTimer timer;

  timer.setSingleShot(true);
  timer.start( _mseconds );

  while (timer.isActive() )
    QApplication::processEvents();

}

void ScriptingPlugin::frameStart( ) {
  frameTime_.restart();
}

void ScriptingPlugin::waitFrameEnd( int _mseconds ) {
  int elapsed = frameTime_.elapsed();

  // Wait remaining time
  if ( elapsed < _mseconds ) {
    sleepmsecs( _mseconds - elapsed );
  }

  // restart timer
  frameTime_.restart();

}


void ScriptingPlugin::waitContinue( ) {
  if ( OpenFlipper::Options::nogui() )
    return;

  QMessageBox box;

Dirk Wilden's avatar
Dirk Wilden committed
505
506
  box.addButton(tr("Continue"),QMessageBox::AcceptRole);
  box.setText(tr("Script execution has been interrupted"));
Jan Möbius's avatar
 
Jan Möbius committed
507
508
  box.setIcon(QMessageBox::Information);
  box.setWindowModality(Qt::NonModal);
Dirk Wilden's avatar
Dirk Wilden committed
509
  box.setWindowTitle(tr("Continue?"));
Jan Möbius's avatar
 
Jan Möbius committed
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
  box.setWindowFlags( box.windowFlags() | Qt::WindowStaysOnTopHint);
  box.show();

  while ( box.isVisible() )
    QApplication::processEvents();

}

void ScriptingPlugin::waitContinue( QString _msg, int _x, int _y ) {
  if ( OpenFlipper::Options::nogui() )
    return;

  QMessageBox box;


Dirk Wilden's avatar
Dirk Wilden committed
525
  box.addButton(tr("Continue"),QMessageBox::AcceptRole);
Jan Möbius's avatar
 
Jan Möbius committed
526
527
528
  box.setText(_msg);
  box.setIcon(QMessageBox::Information);
  box.setWindowModality(Qt::NonModal);
Dirk Wilden's avatar
Dirk Wilden committed
529
  box.setWindowTitle(tr("Continue?"));
Jan Möbius's avatar
 
Jan Möbius committed
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
  box.setWindowFlags( box.windowFlags() | Qt::WindowStaysOnTopHint);
  if(_x!=-1 && _y!=-1)
    box.move(_x,_y);
  box.show();

  while ( box.isVisible() )
    QApplication::processEvents();

}


void ScriptingPlugin::slotLoadScript(){
  QString filename = QFileDialog::getOpenFileName(0,
     tr("Load Script"),OpenFlipper::Options::currentScriptDirStr(), tr("Script Files (*.ofs)"));

  if (filename == "")
    return;
547
548
549
  
  slotLoadScript(filename);
}
Jan Möbius's avatar
 
Jan Möbius committed
550

551
552
553
554
555
556
557
558
559
560
561
562
563
564
void ScriptingPlugin::slotLoadScript( QString _filename ) {
  
  if (_filename == "")
      return;
    
  // Check if we are in gui mode. Otherwise just ignore this call
  if ( OpenFlipper::Options::gui() ) {
    scriptWidget_->currentScript->clear();
  
    QFile data(_filename);
    
    if (data.open(QFile::ReadOnly)) {
      QTextStream input(&data);
      do {
565
        scriptWidget_->currentScript->appendPlainText(input.readLine());
566
567
568
569
570
571
572
573
574
575
576
      } while (!input.atEnd());
      
      lastFile_ = _filename;
      OpenFlipper::Options::currentScriptDir( QFileInfo(_filename).absolutePath() );
      
      scriptWidget_->actionSave_Script->setEnabled( false );
      
      scriptWidget_->show();
    }
  }
  
Jan Möbius's avatar
 
Jan Möbius committed
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
}

void ScriptingPlugin::slotSaveScript(){

  QFile file(lastFile_);

  if ( !file.exists())
    slotSaveScriptAs();
  else{
    //write script to file
    if (file.open(QFile::WriteOnly)) {
      QTextStream output(&file);
      output << scriptWidget_->currentScript->toPlainText();
    }
    scriptWidget_->actionSave_Script->setEnabled( false );
  }
}

void ScriptingPlugin::slotSaveScriptAs(){
  QString filename = QFileDialog::getSaveFileName(scriptWidget_,
Jan Möbius's avatar
Jan Möbius committed
597
      tr("Save Script"),OpenFlipper::Options::currentScriptDirStr(), tr("Script Files (*.ofs)"));
Jan Möbius's avatar
 
Jan Möbius committed
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615

  if (filename == "") return;

  QFile data(filename);

  //perhaps add an extension
  if (!data.exists()){
    QFileInfo fi(filename);
    if (fi.completeSuffix() == ""){
      filename = filename + ".ofs";
      data.setFileName(filename);
    }
  }

  //write script to file
  if (data.open(QFile::WriteOnly)) {
    QTextStream output(&data);
    output << scriptWidget_->currentScript->toPlainText();
Jan Möbius's avatar
Jan Möbius committed
616
  }
Jan Möbius's avatar
 
Jan Möbius committed
617

Jan Möbius's avatar
Jan Möbius committed
618
  lastFile_ = filename;
Jan Möbius's avatar
 
Jan Möbius committed
619
  OpenFlipper::Options::currentScriptDir( QFileInfo(filename).absolutePath() );
Jan Möbius's avatar
Jan Möbius committed
620

Jan Möbius's avatar
 
Jan Möbius committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
  scriptWidget_->actionSave_Script->setEnabled( false );
}

void ScriptingPlugin::slotFunctionClicked(QListWidgetItem * _item)
{

  QString slotDescription;
  QStringList params;
  QStringList descriptions;

  emit getDescription(_item->text(), slotDescription, params, descriptions);

  if ( !slotDescription.isEmpty() ){

    if (descriptionLabels_.count() > 0){
      //first remove old stuff
      for (int i = 0; i < descriptionLabels_.count(); i++){
        descrLayout_->removeWidget( descriptionLabels_[i] );
        delete descriptionLabels_[i];
      }
      descriptionLabels_.clear();
    }else
      descrLayout_ = new QVBoxLayout();

    QLabel* lSlotName = new QLabel("<B>" + _item->text() + "</B>");
    QLabel* lDescription = new QLabel(slotDescription);
    lDescription->setWordWrap(true);

    descrLayout_->addWidget(lSlotName);
    descrLayout_->addWidget(lDescription);

    descriptionLabels_.append(lSlotName);
    descriptionLabels_.append(lDescription);

    if ( params.count() == descriptions.count() ){

      //get parameter-types from function-name
      QString typeStr = _item->text().section("(",1,1).section(")",0,0);
      QStringList types = typeStr.split(",");

      if (types.count() == params.count()){

        for(int p=0; p < params.count(); p++ ){
          QLabel* param = new QLabel("<B>" + types[p] + " " + params[p] + ":</B>" );
          QLabel* descr = new QLabel(descriptions[p]);
          descr->setWordWrap(true);
          descrLayout_->addWidget(param);
          descrLayout_->addWidget(descr);

          descriptionLabels_.append(param);
          descriptionLabels_.append(descr);
        }

      }

    }


    scriptWidget_->description->setLayout( descrLayout_ );
  }

  scriptWidget_->description->setVisible( !slotDescription.isEmpty() );
}

void ScriptingPlugin::slotFunctionDoubleClicked(QListWidgetItem * _item)
{
  scriptWidget_->currentScript->insertPlainText( _item->text() );
}

690
691
692
693
694
void ScriptingPlugin::showScriptInEditor(QString _code)
{
  if ( OpenFlipper::Options::nogui() )
    return;

695
  /*
Jan Möbius's avatar
Jan Möbius committed
696
   * This is called from the VSI and other plugins with pure code
697
698
699
   * we do not want to overwrite any previously opened scripts
   */
  lastFile_ = "";
Jan Möbius's avatar
Jan Möbius committed
700
  OpenFlipper::Options::currentScriptDir( "" );
701

702
703
  showScriptWidget ();

704
  scriptWidget_->currentScript->setPlainText(_code);
705
706
}

707
void ScriptingPlugin::clearEditor() {
708
709
710
  if ( OpenFlipper::Options::nogui() )
     return;

711
712
713
  scriptWidget_->currentScript->clear();
}

Matthias Möller's avatar
Matthias Möller committed
714
715
716
#if QT_VERSION < 0x050000
  Q_EXPORT_PLUGIN2( skriptingplugin , ScriptingPlugin );
#endif
Jan Möbius's avatar
 
Jan Möbius committed
717