src/fileview.cpp

   1 /*
   2         Description: file viewer window
   3
   4         Author: Marco Costalba (C) 2005-2007
   5
   6         Copyright: See COPYING file that comes with this distribution
   7
   8 */
   9 #include <QHelpEvent>
  10 #include "mainimpl.h"
  11 #include "git.h"
  12 #include "annotate.h"
  13 #include "listview.h"
  14 #include "filecontent.h"
  15 #include "fileview.h"
  16
  17 #define MAX_LINE_NUM 5
  18
  19 FileView::FileView(MainImpl* mi, Git* g) : Domain(mi, g, false) {
  20
  21         fileTab = new Ui_TabFile();
  22         fileTab->setupUi(container);
  23         fileTab->histListView->setup(this, git);
  24         fileTab->textEditFile->setup(this, git, fileTab->listWidgetAnn);
  25
  26         // an empty string turn off the special-value text display
  27         fileTab->spinBoxRevision->setSpecialValueText(" ");
  28
  29         // Add GNU source-highlight version to tooltip, or add a message that it's not installed.
  30         QToolButton* highlight = fileTab->toolButtonHighlightText;
  31         highlight->setToolTip(highlight->toolTip().arg(git->textHighlighterVersion()));
  32
  33         clear(true); // init some stuff
  34
  35         fileTab->listWidgetAnn->installEventFilter(this);
  36
  37         connect(git, SIGNAL(loadCompleted(const FileHistory*, const QString&)),
  38                 this, SLOT(on_loadCompleted(const FileHistory*, const QString&)));
  39
  40         connect(m(), SIGNAL(changeFont(const QFont&)),
  41                 fileTab->histListView, SLOT(on_changeFont(const QFont&)));
  42
  43         connect(fileTab->histListView, SIGNAL(contextMenu(const QString&, int)),
  44                 this, SLOT(on_contextMenu(const QString&, int)));
  45
  46         connect(fileTab->textEditFile, SIGNAL(annotationAvailable(bool)),
  47                 this, SLOT(on_annotationAvailable(bool)));
  48
  49         connect(fileTab->textEditFile, SIGNAL(fileAvailable(bool)),
  50                 this, SLOT(on_fileAvailable(bool)));
  51
  52         connect(fileTab->textEditFile, SIGNAL(revIdSelected(int)),
  53                 this, SLOT(on_revIdSelected(int)));
  54
  55         connect(fileTab->toolButtonCopy, SIGNAL(clicked()),
  56                 this, SLOT(on_toolButtonCopy_clicked()));
  57
  58         connect(fileTab->toolButtonShowAnnotate, SIGNAL(toggled(bool)),
  59                 this, SLOT(on_toolButtonShowAnnotate_toggled(bool)));
  60
  61         connect(fileTab->toolButtonFindAnnotate, SIGNAL(toggled(bool)),
  62                 this, SLOT(on_toolButtonFindAnnotate_toggled(bool)));
  63
  64         connect(fileTab->toolButtonGoNext, SIGNAL(clicked()),
  65                 this, SLOT(on_toolButtonGoNext_clicked()));
  66
  67         connect(fileTab->toolButtonGoPrev, SIGNAL(clicked()),
  68                 this, SLOT(on_toolButtonGoPrev_clicked()));
  69
  70         connect(fileTab->toolButtonRangeFilter, SIGNAL(toggled(bool)),
  71                 this, SLOT(on_toolButtonRangeFilter_toggled(bool)));
  72
  73         connect(fileTab->toolButtonPin, SIGNAL(toggled(bool)),
  74                 this, SLOT(on_toolButtonPin_toggled(bool)));
  75
  76         connect(fileTab->toolButtonHighlightText, SIGNAL(toggled(bool)),
  77                 this, SLOT(on_toolButtonHighlightText_toggled(bool)));
  78
  79         connect(fileTab->spinBoxRevision, SIGNAL(valueChanged(int)),
  80                 this, SLOT(on_spinBoxRevision_valueChanged(int)));
  81 }
  82
  83 FileView::~FileView() {
  84
  85         if (!parent())
  86                 return;
  87
  88         delete fileTab->textEditFile; // must be deleted before fileTab
  89         delete fileTab;
  90         showStatusBarMessage(""); // cleanup any pending progress info
  91         QApplication::restoreOverrideCursor();
  92 }
  93
  94 bool FileView::eventFilter(QObject* obj, QEvent* e) {
  95
  96         QListWidget* lw = fileTab->listWidgetAnn;
  97         if (e->type() == QEvent::ToolTip && obj == lw) {
  98                 QHelpEvent* h = static_cast<QHelpEvent*>(e);
  99                 int id = fileTab->textEditFile->itemAnnId(lw->itemAt(h->pos()));
 100                 QRegExp re;
 101                 SCRef sha(fileTab->histListView->shaFromAnnId(id));
 102                 SCRef d(git->getDesc(sha, re, re, false, model()));
 103                 lw->setToolTip(d);
 104         }
 105         return QObject::eventFilter(obj, e);
 106 }
 107
 108 void FileView::clear(bool complete) {
 109
 110         Domain::clear(complete);
 111
 112         if (complete) {
 113                 setTabCaption("File");
 114                 fileTab->toolButtonCopy->setEnabled(false);
 115         }
 116         fileTab->textEditFile->clearAll(); // emits file/ann available signals
 117
 118         fileTab->toolButtonPin->setEnabled(false);
 119         fileTab->toolButtonPin->setChecked(false); // TODO signals pressed() and clicked() are not emitted
 120         fileTab->spinBoxRevision->setEnabled(false);
 121         fileTab->spinBoxRevision->setValue(fileTab->spinBoxRevision->minimum()); // clears the box
 122 }
 123
 124 bool FileView::goToCurrentAnnotation(int direction) {
 125
 126         SCRef ids = fileTab->histListView->currentText(QGit::ANN_ID_COL);
 127         int id = (!ids.isEmpty() ? ids.toInt() : 0);
 128         fileTab->textEditFile->goToAnnotation(id, direction);
 129         return (id != 0);
 130 }
 131
 132 void FileView::updateSpinBoxValue() {
 133
 134         SCRef ids = fileTab->histListView->currentText(QGit::ANN_ID_COL);
 135         if (    ids.isEmpty()
 136             || !fileTab->spinBoxRevision->isEnabled()
 137             ||  fileTab->spinBoxRevision->value() == ids.toInt())
 138                 return;
 139
 140         fileTab->spinBoxRevision->setValue(ids.toInt()); // emit QSpinBox::valueChanged()
 141 }
 142
 143 bool FileView::isMatch(SCRef sha) {
 144
 145         static RangeInfo r; // fast path here, avoid allocation on each call
 146         if (!fileTab->textEditFile->getRange(sha, &r))
 147                 return false;
 148
 149         return r.modified;
 150 }
 151
 152 void FileView::filterOnRange(bool isOn) {
 153
 154         int matchedCnt = fileTab->histListView->filterRows(isOn, false);
 155         QString msg;
 156         if (isOn)
 157                 msg = QString("Found %1 matches. Toggle filter "
 158                               "button to remove the filter").arg(matchedCnt);
 159
 160         showStatusBarMessage(msg);
 161         QApplication::postEvent(this, new MessageEvent(msg)); // deferred message, after update
 162 }
 163
 164 bool FileView::doUpdate(bool force) {
 165
 166         if (st.fileName().isEmpty())
 167                 return false;
 168
 169         if (st.isChanged(StateInfo::FILE_NAME) || force) {
 170
 171                 clear(false);
 172                 setTabCaption(st.fileName());
 173
 174                 if (git->startFileHistory(st.sha(), st.fileName(), model())) {
 175                         QApplication::restoreOverrideCursor();
 176                         QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
 177                         showStatusBarMessage("Retrieving history of '" +
 178                                               st.fileName() + "'...");
 179                 }
 180         } else if (fileTab->histListView->update() || st.sha().isEmpty()) {
 181
 182                 updateSpinBoxValue();
 183                 showStatusBarMessage(git->getRevInfo(st.sha()));
 184         }
 185         if (!fileTab->toolButtonPin->isChecked())
 186                 fileTab->textEditFile->doUpdate();
 187
 188         return true; // always accept new state
 189 }
 190
 191 // ************************************ SLOTS ********************************
 192
 193 void FileView::updateEnabledButtons() {
 194
 195         QToolButton* copy = fileTab->toolButtonCopy;
 196         QToolButton* showAnnotate = fileTab->toolButtonShowAnnotate;
 197         QToolButton* findAnnotate = fileTab->toolButtonFindAnnotate;
 198         QToolButton* goPrev = fileTab->toolButtonGoPrev;
 199         QToolButton* goNext = fileTab->toolButtonGoNext;
 200         QToolButton* rangeFilter = fileTab->toolButtonRangeFilter;
 201         QToolButton* highlight = fileTab->toolButtonHighlightText;
 202
 203         bool fileAvailable = fileTab->textEditFile->isFileAvailable();
 204         bool annotateAvailable = fileTab->textEditFile->isAnnotateAvailable();
 205
 206         // first enable
 207         copy->setEnabled(fileAvailable);
 208         showAnnotate->setEnabled(annotateAvailable);
 209         findAnnotate->setEnabled(annotateAvailable);
 210         goPrev->setEnabled(annotateAvailable);
 211         goNext->setEnabled(annotateAvailable);
 212         rangeFilter->setEnabled(annotateAvailable);
 213         highlight->setEnabled(fileAvailable && git->isTextHighlighter());
 214
 215         // then disable
 216         if (!showAnnotate->isChecked()) {
 217                 findAnnotate->setEnabled(false);
 218                 goPrev->setEnabled(false);
 219                 goNext->setEnabled(false);
 220         }
 221         if (highlight->isChecked())
 222                 rangeFilter->setEnabled(false);
 223
 224         if (rangeFilter->isChecked())
 225                 highlight->setEnabled(false);
 226
 227         // special case: reset range filter when changing file
 228         if (!annotateAvailable && rangeFilter->isChecked())
 229                 rangeFilter->toggle();
 230 }
 231
 232 void FileView::on_toolButtonCopy_clicked() {
 233
 234         fileTab->textEditFile->copySelection();
 235 }
 236
 237 void FileView::on_toolButtonShowAnnotate_toggled(bool b) {
 238
 239         updateEnabledButtons();
 240         fileTab->textEditFile->setShowAnnotate(b);
 241
 242         if (b && fileTab->toolButtonFindAnnotate->isChecked())
 243                 goToCurrentAnnotation();
 244 }
 245
 246 void FileView::on_toolButtonFindAnnotate_toggled(bool b) {
 247
 248         updateEnabledButtons();
 249         if (b)
 250                 goToCurrentAnnotation();
 251 }
 252
 253 void FileView::on_toolButtonGoNext_clicked() {
 254
 255         goToCurrentAnnotation(1);
 256 }
 257
 258 void FileView::on_toolButtonGoPrev_clicked() {
 259
 260         goToCurrentAnnotation(-1);
 261 }
 262
 263 void FileView::on_toolButtonPin_toggled(bool b) {
 264 // button is enabled and togglable only if st.sha() is found
 265
 266         fileTab->spinBoxRevision->setDisabled(b);
 267
 268         if (!b) {
 269                 updateSpinBoxValue(); // UPDATE() call is filtered in this case
 270                 fileTab->textEditFile->doUpdate(true);
 271         }
 272 }
 273
 274 void FileView::on_toolButtonRangeFilter_toggled(bool b) {
 275
 276         updateEnabledButtons();
 277         if (b) {
 278                 if (!fileTab->textEditFile->isAnnotateAvailable()) {
 279                         dbs("ASSERT in on_toolButtonRangeFilter_toggled: annotate not available");
 280                         return;
 281                 }
 282                 if (!fileTab->textEditFile->textCursor().hasSelection()) {
 283                         showStatusBarMessage("Please select some text");
 284                         return;
 285                 }
 286         }
 287         bool rangeFilterActive = fileTab->textEditFile->rangeFilter(b);
 288         filterOnRange(rangeFilterActive);
 289 }
 290
 291 void FileView::on_toolButtonHighlightText_toggled(bool b) {
 292
 293         updateEnabledButtons();
 294         fileTab->textEditFile->setHighlightSource(b);
 295 }
 296
 297 void FileView::on_spinBoxRevision_valueChanged(int id) {
 298
 299         if (id != fileTab->spinBoxRevision->minimum()) {
 300
 301                 SCRef selRev(fileTab->histListView->shaFromAnnId(id));
 302                 if (st.sha() != selRev) { // to avoid looping
 303                         st.setSha(selRev);
 304                         st.setSelectItem(true);
 305                         UPDATE();
 306                 }
 307         }
 308 }
 309
 310 void FileView::on_loadCompleted(const FileHistory* f, const QString& msg) {
 311
 312         QApplication::restoreOverrideCursor();
 313
 314         if (f != model())
 315                 return;
 316
 317         showStatusBarMessage("");
 318         fileTab->histListView->showIdValues();
 319         int maxId = model()->rowCount();
 320         if (maxId == 0)
 321                 return;
 322
 323         fileTab->spinBoxRevision->setMaximum(maxId);
 324         fileTab->toolButtonPin->setEnabled(true);
 325         fileTab->spinBoxRevision->setEnabled(true);
 326
 327         // update histListView now to avoid to miss
 328         // following status bar messages
 329         doUpdate(false);
 330
 331         QString histTime = msg.section(" ms", 0, 0).section(" ", -1);
 332         if (fileTab->textEditFile->startAnnotate(model(), histTime))
 333                 showStatusBarMessage("Annotating revisions of '" + st.fileName() + "'...");
 334 }
 335
 336 void FileView::showAnnotation() {
 337
 338         if (  !fileTab->toolButtonPin->isChecked()
 339             && fileTab->toolButtonShowAnnotate->isEnabled()
 340             && fileTab->toolButtonShowAnnotate->isChecked()) {
 341
 342                 fileTab->textEditFile->setShowAnnotate(true);
 343
 344                 if (   fileTab->toolButtonFindAnnotate->isEnabled()
 345                     && fileTab->toolButtonFindAnnotate->isChecked())
 346
 347                         goToCurrentAnnotation();
 348         }
 349 }
 350
 351 void FileView::on_annotationAvailable(bool b) {
 352
 353         updateEnabledButtons();
 354         if (b)
 355                 showAnnotation(); // in case annotation got ready after file
 356 }
 357
 358 void FileView::on_fileAvailable(bool b) {
 359
 360         updateEnabledButtons();
 361         if (b) {
 362                 // code range is independent from annotation
 363                 if (fileTab->toolButtonRangeFilter->isChecked())
 364                         fileTab->textEditFile->goToRangeStart();
 365
 366                 showAnnotation(); // in case file got ready after annotation
 367         }
 368 }
 369
 370 void FileView::on_revIdSelected(int id) {
 371
 372         if (id == 0)
 373                 return;
 374
 375         if (fileTab->spinBoxRevision->isEnabled())
 376                 fileTab->spinBoxRevision->setValue(id);
 377         else {
 378                 ListView* h = fileTab->histListView;
 379                 int row = h->model()->rowCount() - id;
 380                 QModelIndex idx = h->model()->index(row, 0);
 381                 h->setCurrentIndex(idx);
 382         }
 383 }