default saveAnalysisAs to users home directory
[mussa.git] / qui / MussaWindow.cpp
1 #include "py/python.hpp"
2 #include "qui/MussaWindow.hpp"
3 #include "mussa_exceptions.hpp"
4
5 #include <QAction>
6 #include <QApplication>
7 #include <QAssistantClient>
8 #include <QCloseEvent>
9 #include <QDir>
10 #include <QFileDialog>
11 #include <QHBoxLayout>
12 #include <QIcon>
13 #include <QMenuBar>
14 #include <QMessageBox>
15 #include <QScrollBar>
16 #include <QStatusBar>
17 #include <QString>
18 #include <QStringList>
19 #include <QWhatsThis>
20
21 #include <memory>
22 #include <iterator>
23 #include <iostream>
24
25 #include <boost/filesystem/path.hpp>
26 #include <boost/filesystem/operations.hpp>
27 namespace fs = boost::filesystem;
28 #include <boost/bind.hpp>
29
30 using namespace std;
31
32 MussaWindow::MussaWindow(Mussa *analysis_, QWidget *parent) :
33   QMainWindow(parent),
34   analysis(analysis_),
35   motif_editor(0),
36   setup_analysis_dialog(this),
37   browser(this),
38   mussaViewTB("Path Views"),
39   zoom(),
40   threshold(),
41   progress_dialog(0),
42   aboutAction(0),
43   closeAction(0),
44   createNewAnalysisAction(0),
45   createSubAnalysisAction(0),
46   editMotifsAction(0),
47   loadMotifListAction(0),
48   loadMupaAction(0),
49   loadSavedAnalysisAction(0),
50   mussaManualAssistantAction(0),
51   newMussaWindowAction(0),
52   saveMotifListAction(0),
53   showMussaViewToolbarAction(0),
54   toggleMotifsAction(0),
55   saveBrowserPixmapAction(0),
56   whatsThisAction(0),
57   viewMussaAlignmentAction(0),
58   manualAssistant(0)
59 {
60   setupActions();
61   setupMainMenu();
62   setupAssistant();
63
64   //This next setWhatsThis function prevents
65   // a segfault when using WhatsThis feature with 
66   // opengl widget.
67   //scene->setWhatsThis(tr("Mussa in OpenGL!"));
68   setCentralWidget(&browser);
69   // well updatePosition isn't quite right as we really just need
70   // to call update()
71   connect(this, SIGNAL(changedAnnotations()), &browser, SLOT(update()));
72
73   //mussaViewTB.addAction(toggleMotifsAction);
74   mussaViewTB.addWidget(&zoom);
75   
76   connect(&zoom, SIGNAL(valueChanged(double)), 
77           &browser, SLOT(setZoom(double)));
78   
79   // threshold range is set in updateAnalysis
80   
81   //scene->setClipPlane(20);
82   // FIXME: for when we get the paths drawn at the appropriate depth
83   //connect(&threshold, SIGNAL(thresholdChanged(int)),
84   //        this, SLOT(setClipPlane(int)));
85   connect(&threshold, SIGNAL(thresholdChanged(int)),
86           this, SLOT(setSoftThreshold(int)));
87   mussaViewTB.addWidget(&threshold);
88
89   addToolBar(&mussaViewTB);
90
91   statusBar()->showMessage("Welcome to mussa", 2000);
92   connect(analysis, SIGNAL(progress(const std::string&, int, int)),
93           this, SLOT(updateProgress(const std::string&, int, int)));
94   updateAnalysis();
95 }
96
97 void MussaWindow::setAnalysis(Mussa *new_analysis)
98 {
99   if (new_analysis != 0) {
100     // only switch mussas if we loaded without error
101     clear();
102     delete analysis;
103     analysis = new_analysis;
104     setWindowTitle(analysis->get_name().c_str());
105     updateAnalysis();
106   }
107 }
108
109 void MussaWindow::setupActions()
110 {
111   // we really don't want to run this more than once.
112   assert (closeAction == 0);
113
114   // the ever popular about box
115   aboutAction = new QAction(tr("&About"), this);
116   connect(aboutAction, SIGNAL(triggered()), this, SLOT(about()));
117   aboutAction->setIcon(QIcon(":/icons/info.png"));
118
119   // add exit
120   closeAction = new QAction(tr("&Close"), this);
121   closeAction->setStatusTip(tr("Close this window"));
122   connect(closeAction, SIGNAL(triggered()), this, SLOT(close()));
123   closeAction->setIcon(QIcon(":/icons/exit.png"));
124   
125   createNewAnalysisAction = new QAction(tr("Create Analysis"), this);
126   connect(createNewAnalysisAction, SIGNAL(triggered()), 
127           this, SLOT(createNewAnalysis()));
128   createNewAnalysisAction->setIcon(QIcon(":/icons/filenew.png"));
129   
130   createSubAnalysisAction = new QAction(tr("Add to Subanalysis"), this);
131   connect(createSubAnalysisAction, SIGNAL(triggered()), 
132           this, SLOT(createSubAnalysis()));
133
134   saveAnalysisAction = new QAction(tr("&Save Analysis"), this);
135   connect(saveAnalysisAction, SIGNAL(triggered()), 
136           this, SLOT(saveAnalysis()));
137   saveAnalysisAction->setIcon(QIcon(":/icons/filesave.png"));
138
139   saveAnalysisAsAction = new QAction(tr("Save Analysis &As"), this);
140   connect(saveAnalysisAsAction, SIGNAL(triggered()), 
141           this, SLOT(saveAnalysisAs()));
142   saveAnalysisAsAction->setIcon(QIcon(":/icons/filesave.png"));
143
144   editMotifsAction = new QAction(tr("Edit Motifs"), this);;
145   connect(editMotifsAction, SIGNAL(triggered()), this, SLOT(editMotifs()));
146   
147   loadMotifListAction = new QAction(tr("Load Motif List"), this);
148   connect(loadMotifListAction, SIGNAL(triggered()), 
149           this, SLOT(loadMotifList()));
150   loadMotifListAction->setIcon(QIcon(":/icons/fileopen.png"));
151   
152   loadMupaAction = new QAction(tr("Create Analysis from File"), this);
153   connect(loadMupaAction, SIGNAL(triggered()), 
154           this, SLOT(loadMupa()));
155   loadMupaAction->setIcon(QIcon(":/icons/fileopen.png"));
156
157   loadSavedAnalysisAction = new QAction(tr("Load Existing &Analysis"), this);
158   connect(loadSavedAnalysisAction, SIGNAL(triggered()), 
159           this, SLOT(loadSavedAnalysis()));
160   loadSavedAnalysisAction->setIcon(QIcon(":/icons/fileopen.png"));
161
162   mussaManualAssistantAction = new QAction(tr("Mussagl Manual..."), this);
163   mussaManualAssistantAction->setIcon(QIcon(":/icons/contents.png"));
164   connect(mussaManualAssistantAction, SIGNAL(triggered()),
165           this, SLOT(showManual()));
166
167   newMussaWindowAction = new QAction(tr("&New Mussa Window"), this);
168   newMussaWindowAction->setStatusTip("open another mussa window to allow comparing results");
169   connect(newMussaWindowAction, SIGNAL(triggered()), 
170           this, SLOT(newMussaWindow()));
171   newMussaWindowAction->setIcon(QIcon(":/icons/window_new.png"));
172
173   saveMotifListAction = new QAction(tr("Save Motifs"), this);
174   connect(saveMotifListAction, SIGNAL(triggered()), 
175           this, SLOT(saveMotifList()));
176   saveMotifListAction->setIcon(QIcon(":/icons/filesave.png"));
177
178   showMussaViewToolbarAction = new QAction(tr("Show Toolbar"), this);
179   connect(showMussaViewToolbarAction, SIGNAL(triggered()), 
180           this, SLOT(showMussaToolbar()));
181   showMussaViewToolbarAction->setCheckable(true);
182   showMussaViewToolbarAction->setChecked(true);
183
184   toggleMotifsAction = new QAction(tr("Toggle Motifs"), this);
185   connect(toggleMotifsAction, SIGNAL(triggered()), 
186           this, SLOT(toggleMotifs()));
187   toggleMotifsAction->setCheckable(true);
188   toggleMotifsAction->setIcon(QIcon(":/icons/motif_icon.png"));
189   toggleMotifsAction->setWhatsThis(tr("Toggle motif annotations on/off\n\n"
190                                    "You can load motif annotations via "
191                                    "'File->Load Motif List' menu option."));
192
193   //Save pixel map action
194   saveBrowserPixmapAction = new QAction(tr("Save to image..."), this);
195   connect(saveBrowserPixmapAction, (SIGNAL(triggered())),
196           &browser, SLOT(promptSaveBrowserPixmap()));
197   saveBrowserPixmapAction->setIcon(QIcon(":/icons/image2.png"));
198
199   viewMussaAlignmentAction = new QAction(tr("View sequence alignment"), this);
200   connect(viewMussaAlignmentAction, SIGNAL(triggered()),
201           this, SLOT(viewMussaAlignment() ));
202   viewMussaAlignmentAction->setWhatsThis(tr("Create a zoomed in window "
203                                             "showing alignment of the seqcomp "
204                                             "defined paths"));
205
206   whatsThisAction = QWhatsThis::createAction(this);
207   whatsThisAction->setIcon(QIcon(":/icons/help.png"));
208
209
210 }
211
212 void MussaWindow::closeEvent(QCloseEvent *event)
213 {
214   if(isClearingAnalysisSafe()) {
215     event->accept();
216   } else {
217     event->ignore();
218   }
219 }
220
221 void MussaWindow::setupMainMenu()
222 {
223   // we need to run setupActions first
224   assert (closeAction != 0);
225
226   QMenu *newMenu = menuBar()->addMenu(tr("&File"));
227   
228   newMenu->addAction(newMussaWindowAction);
229   newMenu->addAction(createNewAnalysisAction);
230   newMenu->addAction(loadMupaAction);
231   newMenu->addAction(loadSavedAnalysisAction);
232   newMenu->addAction(saveAnalysisAction);
233   newMenu->addAction(saveAnalysisAsAction);
234   newMenu->addSeparator();
235   newMenu->addAction(loadMotifListAction);
236   newMenu->addAction(saveMotifListAction);
237   newMenu->addSeparator();
238   newMenu->addAction(saveBrowserPixmapAction);
239   newMenu->addSeparator();
240   newMenu->addAction(closeAction);
241
242   newMenu = menuBar()->addMenu(tr("&Edit"));
243   newMenu->addAction(editMotifsAction);
244   newMenu->addAction(&browser.getCopySelectedSequenceAsFastaAction());
245   newMenu->addAction(createSubAnalysisAction);
246  
247   newMenu = menuBar()->addMenu(tr("&View"));
248   newMenu->addAction(viewMussaAlignmentAction);
249   newMenu->addAction(showMussaViewToolbarAction);
250
251   newMenu = menuBar()->addMenu(tr("&Help"));
252   newMenu->addAction(mussaManualAssistantAction);
253   newMenu->addAction(whatsThisAction);
254   newMenu->addSeparator();
255   newMenu->addAction(aboutAction);
256
257   // add some extra features to the context menu
258   QMenu& popupMenu = browser.getPopupMenu();
259   popupMenu.addAction(viewMussaAlignmentAction);
260   popupMenu.addAction(createSubAnalysisAction);
261 }
262
263 void MussaWindow::setupAssistant()
264 {
265 #if defined(QT_ASSISTANT_FOUND)
266   QStringList manualAssistantArgs;
267   manualAssistantArgs = QStringList();
268   manualAssistantArgs << "-profile" << "./doc/manual/mussagl_manual.adp";
269   manualAssistant = new QAssistantClient("assistant", this);
270   manualAssistant->setArguments(manualAssistantArgs);
271   connect(manualAssistant, SIGNAL(error(QString)),
272           this, SLOT(assistantError(QString)));
273 #endif
274 }
275   
276 void MussaWindow::about()
277 {
278   QString msg("Welcome to Multiple Species Sequence Analysis\n"
279               "(c) 2005-2006 California Institute of Technology\n"
280               "Tristan De Buysscher, Diane Trout\n");
281    msg += "\n\r";
282    msg += "Path: ";
283    msg += QDir::currentPath();
284    msg += "\n";
285    msg += "OpenGL: ";
286    msg += (char *)glGetString(GL_VERSION);
287    msg += "\n";
288    QMessageBox::about(this, tr("About mussa"), msg);
289 }
290
291 void MussaWindow::clear()
292 {
293   aligned_windows.clear();
294   browser.clear();
295 }
296
297 void MussaWindow::createNewAnalysis()
298 {
299   try {
300     // ideally we should open a new window if there's an analysis
301     // but this should work for the moment.
302     if (not isClearingAnalysisSafe()) return;
303
304     if (setup_analysis_dialog.exec()) {
305       Mussa *m = 0;
306       m = setup_analysis_dialog.getMussa();
307       setAnalysis(m);
308     }
309   } catch(mussa_error e) {
310     QString msg(e.what());
311     QMessageBox::warning(this, tr("Create New Analysis"), msg);
312   }
313 }
314
315 void MussaWindow::createSubAnalysis()
316 {
317   list<SequenceLocation> result;
318   SequenceLocationModel& model = subanalysis_window.getModel();
319   browser.copySelectedTracksAsSeqLocation(result);
320   for(list<SequenceLocation>::iterator result_itor = result.begin();
321       result_itor != result.end();
322       ++result_itor)
323   {
324     model.push_back(*result_itor);
325   }
326
327   if (not subanalysis_window.isVisible()) {
328     subanalysis_window.show();
329   }
330 }
331
332 void MussaWindow::saveAnalysis()
333 {
334   // if we've got an analysis
335   if (analysis and not analysis->empty()) {
336     // if it doesn't have a name we need to pick one
337     if (analysis->get_analysis_path().empty()) {
338       saveAnalysisAs();
339     }      
340     // if we've got a name, has it changed any?
341     else if (analysis->is_dirty()) {
342       analysis->save();
343     }
344   }
345 }
346
347 void MussaWindow::saveAnalysisAs()
348 {
349   std::auto_ptr<QFileDialog> dialog(new QFileDialog(this));
350   dialog->setAcceptMode(QFileDialog::AcceptSave);
351   dialog->setFileMode(QFileDialog::AnyFile);
352   dialog->setDirectory(QDir::home());
353
354   QStringList fileNames;
355   if (not dialog->exec()) {
356     return;
357   }
358   fileNames = dialog->selectedFiles();
359    
360   if (fileNames.size() != 1) {
361     return;
362   }
363
364   fs::path save_path(fileNames[0].toStdString());
365   // do you want to overwrite?
366   if (fs::exists(save_path) and 
367       QMessageBox::question(
368         this,
369         tr("Overwrite File? -- Mussa"),
370         tr("A file called %1 already exists"
371            "do you want to overwrite it?")
372            .arg(fileNames[0]),
373         tr("&Yes"), tr("&No"),
374         QString(), 0, 1)
375       ) {
376     return;
377   }
378   analysis->save(save_path);
379 }
380
381 bool MussaWindow::isClearingAnalysisSafe()
382 {
383   if (analysis and not analysis->empty() and analysis->is_dirty()) {
384     switch (QMessageBox::question(
385       this,
386       tr("Save Unsaved Changes -- Mussa"),
387       tr("There are unsaved changes,\ndo you want to save?"),
388       tr("&Yes"), tr("&No"), tr("&Cancel"),
389       0, 2)) {
390     case 0:
391       // save
392       saveAnalysis();
393       break;
394     case 1:
395       // don't save
396       break;
397     case 2:
398       // don't replace 
399       return false;
400       break;
401     default:
402       // error
403       throw runtime_error("isClearingAnalysis QMesageBox failure");
404     }
405   } 
406   // if we're here we've been saved and can replace
407   return true;
408 }
409
410 void MussaWindow::editMotifs()
411 {
412   if (motif_editor != 0) {
413     motif_editor->hide();
414     delete motif_editor;
415   }
416   motif_editor = new MotifEditor(analysis);
417   connect(motif_editor, SIGNAL(changedMotifs()), 
418           this, SLOT(updateAnnotations()));
419   motif_editor->show();
420 }
421
422 void MussaWindow::loadMotifList()
423 {
424   QString caption("Load a motif list");
425   QString filter("Motif list(*.txt *.mtl)");
426   QString path = QFileDialog::getOpenFileName(this,
427                                                    caption, 
428                                                    QDir::currentPath(),
429                                                    filter);
430   // user hit cancel?
431   if (path.isNull()) 
432     return;
433   // try to load safely
434   try {
435     fs::path converted_path(path.toStdString(), fs::native);
436     analysis->load_motifs(converted_path);
437   } catch (runtime_error e) {
438     QString msg("Unable to load ");
439     msg += path;
440     msg += "\n";
441     msg += e.what();
442     QMessageBox::warning(this, "Load Motifs", msg);
443   }
444   assert (analysis != 0);
445 }
446
447 void MussaWindow::saveMotifList()
448 {
449   NotImplementedBox();
450 }
451
452 void MussaWindow::loadMupa()
453 {
454   QString caption("Load a mussa parameter file");
455   QString filter("Mussa Parameters (*.mupa)");
456   QString mupa_path = QFileDialog::getOpenFileName(this,
457                                                    caption, 
458                                                    QDir::currentPath(),
459                                                    filter);
460   // user hit cancel?
461   if (mupa_path.isNull()) 
462     return;
463   // try to load safely
464   try {
465     // ideally we should open a new window if there's an analysis
466     // but this should work for the moment.
467     if (not isClearingAnalysisSafe()) return;
468
469     Mussa *m = new Mussa;
470     fs::path converted_path(mupa_path.toStdString(), fs::native);
471     connect(m, SIGNAL(progress(const std::string&, int, int)),
472             this, SLOT(updateProgress(const std::string&, int, int)));
473     m->load_mupa_file(converted_path);
474     m->analyze();
475     setAnalysis(m);
476     setWindowTitle(converted_path.native_file_string().c_str());
477   } catch (mussa_load_error e) {
478     QString msg("Unable to load ");
479     msg += mupa_path;
480     msg += "\n";
481     msg += e.what();
482     QMessageBox::warning(this, "Load Parameter", msg);
483   }
484   assert (analysis != 0);
485 }
486
487 void MussaWindow::loadSavedAnalysis()
488 {
489   QString caption("Load a previously run analysis");
490   QString muway_dir = QFileDialog::getExistingDirectory(this,
491                                                         caption, 
492                                                         QDir::currentPath());
493   // user hit cancel?
494   if (muway_dir.isNull()) 
495     return;
496   // try to safely load
497   try {
498     // ideally we should open a new window if there's an analysis
499     // but this should work for the moment.
500     if (not isClearingAnalysisSafe()) return;
501
502     Mussa *m = new Mussa;
503     fs::path converted_path(muway_dir.toStdString(), fs::native);
504     connect(m, SIGNAL(progress(const std::string&, int, int)),
505             this, SLOT(updateProgress(const std::string&, int, int)));
506     m->load(converted_path);
507     // only switch mussas if we loaded without error
508     setAnalysis(m);
509     setWindowTitle(converted_path.native_file_string().c_str());
510   } catch (mussa_load_error e) {
511     QString msg("Unable to load ");
512     msg += muway_dir;
513     msg += "\n";
514     msg += e.what();
515     QMessageBox::warning(this, "Load Parameter", msg);
516   }
517   assert (analysis != 0);
518 }
519
520 void MussaWindow::newMussaWindow()
521 {
522   Mussa *a = new Mussa();
523   MussaWindow *win = new MussaWindow(a);
524   win->show();
525 }
526
527 void MussaWindow::setSoftThreshold(int threshold)
528 {
529   if (analysis->get_soft_threshold() != threshold) {
530     analysis->set_soft_threshold(threshold);
531     analysis->nway();
532     updateLinks();
533     update();
534   }
535 }
536
537 void MussaWindow::showMussaToolbar()
538 {
539   if (mussaViewTB.isVisible())
540     mussaViewTB.hide();
541   else
542     mussaViewTB.show();
543 }
544
545 void MussaWindow::toggleMotifs()
546 {
547   NotImplementedBox();
548 }
549
550 void MussaWindow::showManual()
551 {
552 #if QT_QTASSISTANT_FOUND
553   manualAssistant->openAssistant();
554 #else
555   try {
556     boost::python::object webopen = get_py()["webbrowser.open"];
557     webopen("http://woldlab.caltech.edu/~king/mussagl_manual/");
558   } catch( boost::python::error_already_set ) {
559     PyErr_Print();
560   }
561 #endif //QT_QTASSISTANT_FOUND
562 }
563
564 void MussaWindow::assistantError(QString message)
565 {
566   //std::cout << "QAssistantError: " << message.toStdString() << "\n";
567   QMessageBox::warning ( this, "Warning: Mussagl Manual", message, 
568                          QMessageBox::Ok, 
569                          QMessageBox::NoButton);
570 }
571
572 void MussaWindow::NotImplementedBox()
573 {
574   QMessageBox::warning(this, QObject::tr("mussa"), QObject::tr("Not implemented yet"));
575 }      
576
577 void MussaWindow::viewMussaAlignment()
578 {
579   const set<int>& selected_paths = browser.selectedPaths();
580   if (selected_paths.size() == 0 ) {
581     QMessageBox::warning(this, 
582                          QObject::tr("mussa"),
583                          QObject::tr("you should probably select some paths "
584                                      "first"));
585   } else {
586     boost::shared_ptr<MussaAlignedWindow> ma_win( 
587       new MussaAlignedWindow(*analysis, selected_paths)
588     );
589
590     aligned_windows.push_back(ma_win);
591     connect(this, SIGNAL(changedAnnotations()), 
592             aligned_windows.back().get(), SLOT(update()));
593     aligned_windows.back()->show();
594   }
595 }
596                         
597 void MussaWindow::updateAnalysis()
598 {
599   threshold.setRange(analysis->get_threshold(),analysis->get_window());
600
601   const Mussa::vector_sequence_type& seqs = analysis->sequences();
602   browser.setSequences(seqs, analysis->colorMapper());
603   updateLinks();
604   browser.zoomOut();
605   zoom.setValue(browser.zoom());
606 }
607
608 void MussaWindow::updateAnnotations()
609 {
610   // motifs were changed in the sequences by 
611   // Mussa::update_sequences_motifs
612   emit changedAnnotations();
613   browser.update();
614 }
615
616 void MussaWindow::updateLinks()
617 {
618   browser.clear_links();
619   bool reversed = false;
620   const NwayPaths& nway = analysis->paths();
621
622   typedef list<ConservedPath> conserved_paths;
623   typedef conserved_paths::const_iterator const_conserved_paths_itor;
624   for(const_conserved_paths_itor path_itor = nway.refined_pathz.begin();
625       path_itor != nway.refined_pathz.end();
626       ++path_itor)
627   {
628     // since we were drawing to the start of a window, and opengl lines
629     // are centered around the two connecting points our lines were slightly
630     // offset. the idea of window_offset is to adjust them to the
631     // right for forward compliment or left for reverse compliment
632     // FIXME: figure out how to unit test these computations
633     //GLfloat window_offset = (path_itor->window_size)/2.0;
634
635     size_t track_len = path_itor->track_indexes.size();
636     vector<int> normalized_path;
637     normalized_path.reserve(track_len);
638     vector<bool> rc_flags(false, track_len);
639     for (size_t track_i=0; track_i != track_len; ++track_i)
640     {
641       int x = path_itor->track_indexes[track_i];
642       // at some point when we modify the pathz data structure to keep
643       // track of the score we can put grab the depth here.
644       //
645       // are we reverse complimented?
646       if ( x>=0) {
647         reversed = false;
648       } else {
649         reversed = true;
650         // make positive 
651         x = -x;
652       }
653       normalized_path.push_back(x);
654       rc_flags.push_back(reversed);
655     }
656     browser.link(normalized_path, rc_flags, path_itor->window_size);
657   }
658   browser.update();
659 }
660
661 void 
662 MussaWindow::updateProgress(const string& description, int current, int max)
663 {  
664   // if we're done  
665   if (current == max) {
666     if (progress_dialog != 0) {
667       progress_dialog->hide();
668       delete progress_dialog;
669       progress_dialog = 0;
670     }
671   } else {
672     // if we're starting, create the dialog
673     if (progress_dialog == 0) {
674       QString desc(description.c_str());
675       QString cancel("Cancel");
676       progress_dialog = new QProgressDialog(desc, cancel, current, max, this);
677       progress_dialog->show();
678     } else {
679       // just update the dialog
680       progress_dialog->setValue(current);
681     }
682   }
683   qApp->processEvents();
684 }