doxywizard.cpp 18 KB
Newer Older
1
#include <QtGui>
2
#include "doxywizard.h"
3
#include "version.h"
4 5
#include "expert.h"
#include "wizard.h"
6

7 8 9 10
#ifdef WIN32
#include <windows.h>
#endif

11 12
#define MAX_RECENT_FILES 10

13 14
const int messageTimeout = 5000; //!< status bar message timeout in millisec.

15 16
MainWindow &MainWindow::instance()
{
17 18
  static MainWindow *theInstance = new MainWindow;
  return *theInstance;
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
}

MainWindow::MainWindow()
  : m_settings(QString::fromAscii("Doxygen.org"), QString::fromAscii("Doxywizard"))
{
  QMenu *file = menuBar()->addMenu(tr("File"));
  file->addAction(tr("Open..."), 
                  this, SLOT(openConfig()), Qt::CTRL+Qt::Key_O);
  m_recentMenu = file->addMenu(tr("Open recent"));
  file->addAction(tr("Save"), 
                  this, SLOT(saveConfig()), Qt::CTRL+Qt::Key_S);
  file->addAction(tr("Save as..."), 
                  this, SLOT(saveConfigAs()), Qt::SHIFT+Qt::CTRL+Qt::Key_S);
  file->addAction(tr("Quit"),  
                  this, SLOT(quit()), Qt::CTRL+Qt::Key_Q);

  QMenu *settings = menuBar()->addMenu(tr("Settings"));
  settings->addAction(tr("Reset to factory defaults"),
                  this,SLOT(resetToDefaults()));
  settings->addAction(tr("Use current settings at startup"),
                  this,SLOT(makeDefaults()));
40 41
  settings->addAction(tr("Clear recent list"),
                  this,SLOT(clearRecent()));
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

  QMenu *help = menuBar()->addMenu(tr("Help"));
  help->addAction(tr("Online manual"), 
                  this, SLOT(manual()), Qt::Key_F1);
  help->addAction(tr("About"), 
                  this, SLOT(about()) );

  m_expert = new Expert;
  m_wizard = new Wizard(m_expert->modelData());

  // ----------- top part ------------------
  QWidget *topPart = new QWidget;
  QVBoxLayout *rowLayout = new QVBoxLayout(topPart);

  // select working directory
  QHBoxLayout *dirLayout = new QHBoxLayout;
  m_workingDir = new QLineEdit;
  m_selWorkingDir = new QPushButton(tr("Select..."));
  dirLayout->addWidget(m_workingDir);
  dirLayout->addWidget(m_selWorkingDir);

  //------------- bottom part --------------
  QWidget *runTab = new QWidget;
  QVBoxLayout *runTabLayout = new QVBoxLayout(runTab);

  // run doxygen
  QHBoxLayout *runLayout = new QHBoxLayout;
  m_run = new QPushButton(tr("Run doxygen"));
  m_run->setEnabled(false);
  m_runStatus = new QLabel(tr("Status: not running"));
  m_saveLog = new QPushButton(tr("Save log..."));
  m_saveLog->setEnabled(false);
  QPushButton *showSettings = new QPushButton(tr("Show configuration"));
  runLayout->addWidget(m_run);
  runLayout->addWidget(m_runStatus);
  runLayout->addStretch(1);
  runLayout->addWidget(showSettings);
  runLayout->addWidget(m_saveLog);

  // output produced by doxygen
  runTabLayout->addLayout(runLayout);
  runTabLayout->addWidget(new QLabel(tr("Output produced by doxygen")));
  QGridLayout *grid = new QGridLayout;
  m_outputLog = new QTextEdit;
  m_outputLog->setReadOnly(true);
  m_outputLog->setFontFamily(QString::fromAscii("courier"));
  m_outputLog->setMinimumWidth(600);
  grid->addWidget(m_outputLog,0,0);
  grid->setColumnStretch(0,1);
  grid->setRowStretch(0,1);
  QHBoxLayout *launchLayout = new QHBoxLayout;
  m_launchHtml = new QPushButton(tr("Show HTML output"));
  launchLayout->addWidget(m_launchHtml);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
95

96 97 98
  launchLayout->addStretch(1);
  grid->addLayout(launchLayout,1,0);
  runTabLayout->addLayout(grid);
99

100 101 102 103
  QTabWidget *tabs = new QTabWidget;
  tabs->addTab(m_wizard,tr("Wizard"));
  tabs->addTab(m_expert,tr("Expert"));
  tabs->addTab(runTab,tr("Run"));
104

105 106 107 108
  rowLayout->addWidget(new QLabel(tr("Step 1: Specify the working directory from which doxygen will run")));
  rowLayout->addLayout(dirLayout);
  rowLayout->addWidget(new QLabel(tr("Step 2: Configure doxygen using the Wizard and/or Expert tab, then switch to the Run tab to generate the documentation")));
  rowLayout->addWidget(tabs);
109

110 111
  setCentralWidget(topPart);
  statusBar()->showMessage(tr("Welcome to Doxygen"),messageTimeout);
112

113 114 115
  m_runProcess = new QProcess;
  m_running = false;
  m_timer = new QTimer;
116

117 118 119 120 121 122 123 124 125 126 127 128 129
  // connect signals and slots
  connect(tabs,SIGNAL(currentChanged(int)),SLOT(selectTab(int)));
  connect(m_selWorkingDir,SIGNAL(clicked()),SLOT(selectWorkingDir()));
  connect(m_recentMenu,SIGNAL(triggered(QAction*)),SLOT(openRecent(QAction*)));
  connect(m_workingDir,SIGNAL(returnPressed()),SLOT(updateWorkingDir()));
  connect(m_runProcess,SIGNAL(readyReadStandardOutput()),SLOT(readStdout()));
  connect(m_runProcess,SIGNAL(finished(int, QProcess::ExitStatus)),SLOT(runComplete()));
  connect(m_timer,SIGNAL(timeout()),SLOT(readStdout()));
  connect(m_run,SIGNAL(clicked()),SLOT(runDoxygen()));
  connect(m_launchHtml,SIGNAL(clicked()),SLOT(showHtmlOutput()));
  connect(m_saveLog,SIGNAL(clicked()),SLOT(saveLog()));
  connect(showSettings,SIGNAL(clicked()),SLOT(showSettings()));
  connect(m_expert,SIGNAL(changed()),SLOT(configChanged()));
130 131 132 133 134 135

  loadSettings();
  updateLaunchButtonState();
  m_modified = false;
  updateTitle();
  m_wizard->refresh();
136 137
}

138
void MainWindow::closeEvent(QCloseEvent *event)
139
{
140 141 142 143 144 145 146 147 148
  if (discardUnsavedChanges())
  {
    saveSettings();
    event->accept();
  }
  else
  {
    event->ignore();
  }
149 150
}

151
void MainWindow::quit()
152
{
153 154 155 156 157
  if (discardUnsavedChanges())
  {
    saveSettings();
  }
  QApplication::exit(0);
158 159
}

160
void MainWindow::setWorkingDir(const QString &dirName)
161
{
162 163 164
    QDir::setCurrent(dirName);
    m_workingDir->setText(dirName);
    m_run->setEnabled(!dirName.isEmpty());
165 166
}

167
void MainWindow::selectWorkingDir()
168
{
169 170 171
  QString dirName = QFileDialog::getExistingDirectory(this,
        tr("Select working directory"),m_workingDir->text());
  if (!dirName.isEmpty())
172
  {
173
    setWorkingDir(dirName);
174
  }
175 176
}

177
void MainWindow::updateWorkingDir()
178
{
179
  setWorkingDir(m_workingDir->text());
180 181
}

182
void MainWindow::manual()
183
{
184
  QDesktopServices::openUrl(QUrl(QString::fromAscii("http://www.doxygen.org/manual.html")));
185
}
186

187
void MainWindow::about()
188
{
189 190 191 192 193
  QString msg;
  QTextStream t(&msg,QIODevice::WriteOnly);
  t << QString::fromAscii("<qt><center>A tool to configure and run doxygen version ")+
       QString::fromAscii(versionString)+
       QString::fromAscii(" on your source files.</center><p><br>"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
194
       "<center>Written by<br> Dimitri van Heesch<br>&copy; 2000-2013</center><p>"
195 196
       "</qt>");
  QMessageBox::about(this,tr("Doxygen GUI"),msg);
197 198
}

199
void MainWindow::openConfig()
200
{
201
  if (discardUnsavedChanges(false))
202
  {
203 204 205 206 207 208 209
    QString fn = QFileDialog::getOpenFileName(this,
        tr("Open configuration file"),
        m_workingDir->text());
    if (!fn.isEmpty())
    {
      loadConfigFromFile(fn);
    }
210 211 212
  }
}

213
void MainWindow::updateConfigFileName(const QString &fileName)
214
{
215
  if (m_fileName!=fileName)
216
  {
217 218 219 220 221
    m_fileName = fileName;
    QString curPath = QFileInfo(fileName).path();
    setWorkingDir(curPath);
    addRecentFile(fileName);
    updateTitle();
222 223 224
  }
}

225
void MainWindow::loadConfigFromFile(const QString & fileName)
226
{
227 228 229 230 231 232
  m_expert->loadConfig(fileName);
  m_wizard->refresh();
  updateConfigFileName(fileName);
  updateLaunchButtonState();
  m_modified = false;
  updateTitle();
233 234
}

235
void MainWindow::saveConfig(const QString &fileName)
236
{
237 238
  if (fileName.isEmpty()) return;
  QFile f(fileName);
239 240 241 242 243 244 245 246
  if (!f.open(QIODevice::WriteOnly)) 
  {
    QMessageBox::warning(this,
        tr("Error saving"),
        tr("Error: cannot open the file ")+fileName+tr(" for writing!\n")+
        tr("Reason given: ")+f.error());
    return;
  }
247 248 249 250 251
  QTextStream t(&f);
  m_expert->writeConfig(t,false);
  updateConfigFileName(fileName);
  m_modified = false;
  updateTitle();
252 253
}

254
bool MainWindow::saveConfig()
255
{
256
  if (m_fileName.isEmpty())
257
  {
258
    return saveConfigAs();
259
  }
260
  else
261
  {
262 263
    saveConfig(m_fileName);
    return true;
264 265 266
  }
}

267
bool MainWindow::saveConfigAs()
268
{
269 270 271 272 273
  QString fileName = QFileDialog::getSaveFileName(this, QString(), 
             m_workingDir->text()+QString::fromAscii("/Doxyfile"));
  if (fileName.isEmpty()) return false;
  saveConfig(fileName);
  return true;
274 275
}

276
void MainWindow::makeDefaults()
277
{
278 279 280 281 282
  if (QMessageBox::question(this,tr("Use current setting at startup?"),
                        tr("Do you want to save the current settings "
                           "and use them next time Doxywizard starts?"),
                        QMessageBox::Save|
                        QMessageBox::Cancel)==QMessageBox::Save)
283
  {
284 285 286
    //printf("MainWindow:makeDefaults()\n");
    m_expert->saveSettings(&m_settings);
    m_settings.setValue(QString::fromAscii("wizard/loadsettings"), true);
287
    m_settings.sync();
288 289 290
  }
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
void MainWindow::clearRecent()
{
  if (QMessageBox::question(this,tr("Clear the list of recent files?"),
                        tr("Do you want to clear the list of recently "
                           "loaded configuration files?"),
                        QMessageBox::Yes|
                        QMessageBox::Cancel)==QMessageBox::Yes)
  {
    m_recentMenu->clear();
    m_recentFiles.clear();
    for (int i=0;i<MAX_RECENT_FILES;i++)
    {
      m_settings.setValue(QString().sprintf("recent/config%d",i++),QString::fromAscii(""));
    }
    m_settings.sync();
  }
  
}

310
void MainWindow::resetToDefaults()
311
{
312 313 314 315 316
  if (QMessageBox::question(this,tr("Reset settings to their default values?"),
                        tr("Do you want to revert all settings back "
                           "to their original values?"),
                        QMessageBox::Reset|
                        QMessageBox::Cancel)==QMessageBox::Reset)
317
  {
318 319 320
    //printf("MainWindow:resetToDefaults()\n");
    m_expert->resetToDefaults();
    m_settings.setValue(QString::fromAscii("wizard/loadsettings"), false);
321
    m_settings.sync();
322
    m_wizard->refresh();
323
  }
324 325
}

326
void MainWindow::loadSettings()
327
{
328 329 330 331
  QVariant geometry     = m_settings.value(QString::fromAscii("main/geometry"), QVariant::Invalid);
  QVariant state        = m_settings.value(QString::fromAscii("main/state"),    QVariant::Invalid);
  QVariant wizState     = m_settings.value(QString::fromAscii("wizard/state"),  QVariant::Invalid);
  QVariant loadSettings = m_settings.value(QString::fromAscii("wizard/loadsettings"),  QVariant::Invalid);
332
  QVariant workingDir   = m_settings.value(QString::fromAscii("wizard/workingdir"), QVariant::Invalid);
333

334 335 336 337
  if (geometry  !=QVariant::Invalid) restoreGeometry(geometry.toByteArray());
  if (state     !=QVariant::Invalid) restoreState   (state.toByteArray());
  if (wizState  !=QVariant::Invalid) m_wizard->restoreState(wizState.toByteArray());
  if (loadSettings!=QVariant::Invalid && loadSettings.toBool())
338
  {
339
    m_expert->loadSettings(&m_settings);
340 341 342 343
    if (workingDir!=QVariant::Invalid && QDir(workingDir.toString()).exists())
    {
      setWorkingDir(workingDir.toString());
    }
344
  }
345

346
  for (int i=0;i<MAX_RECENT_FILES;i++)
347
  {
348
    QString entry = m_settings.value(QString().sprintf("recent/config%d",i)).toString();
349 350 351 352
    if (!entry.isEmpty() && QFileInfo(entry).exists())
    {
      addRecentFile(entry);
    }
353 354
  }

355 356
}

357
void MainWindow::saveSettings()
358
{
359
  QSettings settings(QString::fromAscii("Doxygen.org"), QString::fromAscii("Doxywizard"));
360

361 362 363
  m_settings.setValue(QString::fromAscii("main/geometry"), saveGeometry());
  m_settings.setValue(QString::fromAscii("main/state"),    saveState());
  m_settings.setValue(QString::fromAscii("wizard/state"),  m_wizard->saveState());
364
  m_settings.setValue(QString::fromAscii("wizard/workingdir"), m_workingDir->text());
365 366
}

367
void MainWindow::selectTab(int id)
368
{
369
  if (id==0) m_wizard->refresh();
370 371
}

372
void MainWindow::addRecentFile(const QString &fileName)
373
{
374 375
  int i=m_recentFiles.indexOf(fileName);
  if (i!=-1) m_recentFiles.removeAt(i);
376
  
377
  // not found
378
  if (m_recentFiles.count() < MAX_RECENT_FILES) // append
379
  {
380
    m_recentFiles.prepend(fileName);
381
  }
382
  else // add + drop last item
383
  {
384 385
    m_recentFiles.removeLast();
    m_recentFiles.prepend(fileName);
386
  }
387 388 389
  m_recentMenu->clear();
  i=0;
  foreach( QString str, m_recentFiles ) 
390
  {
391 392
    m_recentMenu->addAction(str);
    m_settings.setValue(QString().sprintf("recent/config%d",i++),str);
393
  }
394 395 396 397
  for (;i<MAX_RECENT_FILES;i++)
  {
    m_settings.setValue(QString().sprintf("recent/config%d",i++),QString::fromAscii(""));
  }
398 399
}

400
void MainWindow::openRecent(QAction *action)
401
{
402
  if (discardUnsavedChanges(false))
403
  {
404
    loadConfigFromFile(action->text());
405
  }
406 407
}

408
void MainWindow::runDoxygen()
409
{
410
  if (!m_running)
411
  {
412 413 414 415
    QString doxygenPath; 
#if defined(Q_OS_MACX)
    doxygenPath = qApp->applicationDirPath()+QString::fromAscii("/../Resources/");
    qDebug() << tr("Doxygen path: ") << doxygenPath;
416 417 418 419 420 421 422 423 424 425 426 427 428
    if ( !QFile(doxygenPath + QString::fromAscii("doxygen")).exists() ) 
    {
      // No doygen binary in the resources, if there is a system doxygen binary, use that instead
      if ( QFile(QString::fromAscii("/usr/local/bin/doxygen")).exists() )
      {
        doxygenPath = QString::fromAscii("/usr/local/bin/");
      }
      else 
      {
        qDebug() << tr("Can't find the doxygen command, make sure it's in your $$PATH");
        doxygenPath = QString::fromAscii("");
      }
    }
429 430
    qDebug() << tr("Getting doxygen from: ") << doxygenPath;
#endif
431

432 433 434 435 436 437 438 439
    m_runProcess->setReadChannel(QProcess::StandardOutput);
    m_runProcess->setProcessChannelMode(QProcess::MergedChannels);
    m_runProcess->setWorkingDirectory(m_workingDir->text());
    QStringList env=QProcess::systemEnvironment();
    // set PWD environment variable to m_workingDir
    env.replaceInStrings(QRegExp(QString::fromAscii("^PWD=(.*)"),Qt::CaseInsensitive), 
                         QString::fromAscii("PWD=")+m_workingDir->text());
    m_runProcess->setEnvironment(env);
440

441 442 443
    QStringList args;
    args << QString::fromAscii("-b"); // make stdout unbuffered
    args << QString::fromAscii("-");  // read config from stdin
444

445 446
    m_outputLog->clear();
    m_runProcess->start(doxygenPath + QString::fromAscii("doxygen"), args);
447

448
    if (!m_runProcess->waitForStarted())
449
    {
450 451
      m_outputLog->append(QString::fromAscii("*** Failed to run doxygen\n"));
      return;
452
    }
453 454 455
    QTextStream t(m_runProcess);
    m_expert->writeConfig(t,false);
    m_runProcess->closeWriteChannel();
456

457
    if (m_runProcess->state() == QProcess::NotRunning)
458
    {
459
      m_outputLog->append(QString::fromAscii("*** Failed to run doxygen\n"));
460 461 462
    }
    else
    {
463 464 465 466 467
      m_saveLog->setEnabled(false);
      m_running=true;
      m_run->setText(tr("Stop doxygen"));
      m_runStatus->setText(tr("Status: running"));
      m_timer->start(1000);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
468
    }
469 470 471
  }
  else
  {
472 473 474 475 476 477
    m_running=false;
    m_run->setText(tr("Run doxygen"));
    m_runStatus->setText(tr("Status: not running"));
    m_runProcess->kill();
    m_timer->stop();
    //updateRunnable(m_workingDir->text());
478 479 480
  }
}

481
void MainWindow::readStdout()
482
{
483
  if (m_running)
484
  {
485
    QByteArray data = m_runProcess->readAllStandardOutput();
486
    QString text = QString::fromUtf8(data);
487 488 489 490
    if (!text.isEmpty())
    {
      m_outputLog->append(text.trimmed());
    }
491 492 493
  }
}

494
void MainWindow::runComplete()
495
{
496
  if (m_running)
497
  {
498
    m_outputLog->append(tr("*** Doxygen has finished\n"));
499
  }
500
  else
501
  {
502
    m_outputLog->append(tr("*** Cancelled by user\n"));
503
  }
504 505 506 507 508 509 510
  m_outputLog->ensureCursorVisible();
  m_run->setText(tr("Run doxygen"));
  m_runStatus->setText(tr("Status: not running"));
  m_running=false;
  updateLaunchButtonState();
  //updateRunnable(m_workingDir->text());
  m_saveLog->setEnabled(true);
511 512
}

513
void MainWindow::updateLaunchButtonState()
514
{
515 516 517
  m_launchHtml->setEnabled(m_expert->htmlOutputPresent(m_workingDir->text()));
#if 0
  m_launchPdf->setEnabled(m_expert->pdfOutputPresent(m_workingDir->text()));
518
#endif
519 520
}

521
void MainWindow::showHtmlOutput()
522
{
523 524
  QString indexFile = m_expert->getHtmlOutputIndex(m_workingDir->text());
  QFileInfo fi(indexFile);
525
  // TODO: the following doesn't seem to work with IE
Dimitri van Heesch's avatar
Dimitri van Heesch committed
526
#ifdef WIN32
527
  //QString indexUrl(QString::fromAscii("file:///"));
528
  ShellExecute(NULL, L"open", (LPCWSTR)fi.absoluteFilePath().utf16(), NULL, NULL, SW_SHOWNORMAL);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
529 530 531
#else
  QString indexUrl(QString::fromAscii("file://"));
  indexUrl+=fi.absoluteFilePath();
532
  QDesktopServices::openUrl(QUrl(indexUrl));
533
#endif
534 535
}

536
void MainWindow::saveLog()
537
{
538 539 540 541
  QString fn = QFileDialog::getSaveFileName(this, tr("Save log file"), 
        m_workingDir->text()+
        QString::fromAscii("/doxygen_log.txt"));
  if (!fn.isEmpty())
542
  {
543 544
    QFile f(fn);
    if (f.open(QIODevice::WriteOnly))
545
    {
546 547 548
      QTextStream t(&f);
      t << m_outputLog->toPlainText();
      statusBar()->showMessage(tr("Output log saved"),messageTimeout);
549 550 551
    }
    else
    {
552 553
      QMessageBox::warning(0,tr("Warning"),
          tr("Cannot open file ")+fn+tr(" for writing. Nothing saved!"),tr("ok"));
554 555 556 557
    }
  }
}

558
void MainWindow::showSettings()
559
{
560 561 562 563 564 565 566
  QString text;
  QTextStream t(&text);
  m_expert->writeConfig(t,true);
  m_outputLog->clear();
  m_outputLog->append(text);
  m_outputLog->ensureCursorVisible();
  m_saveLog->setEnabled(true);
567 568
}

569
void MainWindow::configChanged()
570
{
571 572
  m_modified = true;
  updateTitle();
573 574
}

575
void MainWindow::updateTitle()
576
{
577 578
  QString title = tr("Doxygen GUI frontend");
  if (m_modified)
579
  {
580
    title+=QString::fromAscii(" +");
581
  }
582
  if (!m_fileName.isEmpty())
583
  {
584
    title+=QString::fromAscii(" (")+m_fileName+QString::fromAscii(")");
585
  }
586
  setWindowTitle(title);
587 588
}

589
bool MainWindow::discardUnsavedChanges(bool saveOption)
590
{
591
  if (m_modified)
592
  {
593 594
    QMessageBox::StandardButton button;
    if (saveOption)
595
    {
596 597 598 599 600 601 602 603 604 605 606
      button = QMessageBox::question(this,
          tr("Unsaved changes"),
          tr("Unsaved changes will be lost! Do you want to save the configuration file?"),
          QMessageBox::Save    |
          QMessageBox::Discard |
          QMessageBox::Cancel
          );
      if (button==QMessageBox::Save)
      {
        return saveConfig();
      }
607 608 609
    }
    else
    {
610 611 612 613 614 615
      button = QMessageBox::question(this,
          tr("Unsaved changes"),
          tr("Unsaved changes will be lost! Do you want to continue?"),
          QMessageBox::Discard |
          QMessageBox::Cancel
          );
616
    }
617
    return button==QMessageBox::Discard;
618
  }
619
  return true;
620 621
}

622
//-----------------------------------------------------------------------
623 624

int main(int argc,char **argv)
625 626
{
  QApplication a(argc,argv);
627
  MainWindow &main = MainWindow::instance();
628 629
  if (argc==2 && argv[1][0]!='-') // name of config file as an argument
  {
630
    main.loadConfigFromFile(QString::fromLocal8Bit(argv[1]));
631 632 633 634 635 636
  }
  else if (argc>1)
  {
    printf("Usage: %s [config file]\n",argv[0]);
    exit(1);
  }
637 638
  main.show();
  return a.exec();
639
}