src/frontends/qt4/GuiCompare.cpp

   1 /**
   2  * \file GuiCompare.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Vincent van Ravesteijn
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "GuiCompare.h"
  14
  15 #include "Buffer.h"
  16 #include "BufferView.h"
  17 #include "BufferList.h"
  18 #include "buffer_funcs.h"
  19 #include "Compare.h"
  20 #include "FuncRequest.h"
  21 #include "GuiView.h"
  22 #include "LyXRC.h"
  23 #include "qt_helpers.h"
  24
  25 #include "frontends/alert.h"
  26
  27 #include "support/debug.h"
  28 #include "support/filetools.h"
  29 #include "support/FileName.h"
  30 #include "support/gettext.h"
  31
  32 #include <QThread>
  33
  34
  35 using namespace std;
  36 using namespace lyx::support;
  37
  38 namespace lyx {
  39 namespace frontend {
  40
  41
  42 GuiCompare::GuiCompare(GuiView & lv)
  43         : GuiDialog(lv, "compare", qt_("Compare LyX files")),
  44         compare_(0), dest_buffer_(0), old_buffer_(0), new_buffer_(0)
  45 {
  46         setupUi(this);
  47         setModal(Qt::WindowModal);
  48
  49         connect(okPB, SIGNAL(clicked()), this, SLOT(slotOK()));
  50         connect(closePB, SIGNAL(clicked()), this, SLOT(slotCancel()));
  51
  52         connect(newFilePB, SIGNAL(clicked()), this, SLOT(selectNewFile()));
  53         connect(oldFilePB, SIGNAL(clicked()), this, SLOT(selectOldFile()));
  54
  55         connect(newFileCB, SIGNAL(currentIndexChanged(int)),
  56                 this, SLOT(changeAdaptor()));
  57         connect(newFileCB, SIGNAL(editTextChanged(const QString &)),
  58                 this, SLOT(changeAdaptor()));
  59         connect(oldFileCB, SIGNAL(currentIndexChanged(int)),
  60                 this, SLOT(changeAdaptor()));
  61         connect(oldFileCB, SIGNAL(editTextChanged(const QString &)),
  62                 this, SLOT(changeAdaptor()));
  63
  64         newSettingsRB->setChecked(true);
  65
  66         progressBar->setValue(0);
  67         progressBar->setEnabled(false);
  68
  69         bc().setPolicy(ButtonPolicy::OkApplyCancelPolicy);
  70         bc().setOK(okPB);
  71 }
  72
  73 GuiCompare::~GuiCompare()
  74 {
  75         if (compare_)
  76                 delete compare_;
  77 }
  78
  79 void GuiCompare::closeEvent(QCloseEvent *)
  80 {
  81         slotCancel();
  82 }
  83
  84
  85 void GuiCompare::changeAdaptor()
  86 {
  87         changed();
  88 }
  89
  90
  91 bool GuiCompare::isValid()
  92 {
  93         bool const valid = !newFileCB->currentText().isEmpty()
  94                 && !oldFileCB->currentText().isEmpty();
  95         return valid;
  96 }
  97
  98
  99 void GuiCompare::updateContents()
 100 {
 101         if (compare_ && compare_->isRunning())
 102                 return;
 103
 104         QString restore_filename1 = newFileCB->currentText();
 105         QString restore_filename2 = oldFileCB->currentText();
 106         newFileCB->clear();
 107         oldFileCB->clear();
 108         progressBar->setValue(0);
 109         statusBar->clearMessage();
 110         BufferList::iterator it = theBufferList().begin();
 111         BufferList::iterator const end = theBufferList().end();
 112         for (; it != end; ++it) {
 113                 QString filename = toqstr((*it)->absFileName());
 114                 newFileCB->addItem(filename);
 115                 oldFileCB->addItem(filename);
 116         }
 117         if (lyxview().documentBufferView())
 118                 newFileCB->setEditText(toqstr(buffer().absFileName()));
 119         else
 120                 newFileCB->setEditText(restore_filename1);
 121
 122         if (!restore_filename2.isEmpty())
 123                 oldFileCB->setEditText(restore_filename2);
 124         else
 125                 oldFileCB->clearEditText();
 126
 127         if (isValid()) {
 128                 bc().setValid(isValid());
 129                 bc().apply();
 130         }
 131 }
 132
 133
 134 void GuiCompare::selectNewFile()
 135 {
 136         QString name = browse(newFileCB->currentText());
 137         if (!name.isEmpty())
 138                 newFileCB->setEditText(name);
 139         changed();
 140 }
 141
 142
 143 void GuiCompare::selectOldFile()
 144 {
 145         QString name = browse(oldFileCB->currentText());
 146         if (!name.isEmpty())
 147                 oldFileCB->setEditText(name);
 148         changed();
 149 }
 150
 151
 152 QString GuiCompare::browse(QString const & in_name) const
 153 {
 154         QString const title = qt_("Select document");
 155
 156         QStringList const & filters = fileFilters(qt_("LyX Documents (*.lyx)"));
 157
 158         QString filename;
 159         if (lyxview().documentBufferView()) {
 160                 QString path = bufferFilepath();
 161                 filename = browseRelFile(in_name, path, title, filters, false,
 162                         qt_("Documents|#o#O"), toqstr(lyxrc.document_path));
 163         } else {
 164                 QString path = toqstr(lyxrc.document_path);
 165                 QString rel_filename = browseRelFile(in_name, path, title, filters, false,
 166                         qt_("Documents|#o#O"), toqstr(lyxrc.document_path));
 167                 filename = makeAbsPath(rel_filename, path);
 168         }
 169         return filename;
 170 }
 171
 172
 173 void GuiCompare::enableControls(bool enable) const
 174 {
 175         newFileLA->setEnabled(enable);
 176         newFilePB->setEnabled(enable);
 177         newFileCB->setEnabled(enable);
 178         oldFileLA->setEnabled(enable);
 179         oldFilePB->setEnabled(enable);
 180         oldFileCB->setEnabled(enable);
 181         okPB->setEnabled(enable);
 182         groupBox->setEnabled(enable);
 183         progressBar->setEnabled(!enable);
 184
 185         if (enable)
 186                 closePB->setText(qt_("Close"));
 187         else
 188                 closePB->setText(qt_("Cancel"));
 189 }
 190
 191
 192 void GuiCompare::error()
 193 {
 194         Alert::error(_("Error"), _("Error while comparing documents."));
 195         finished(true);
 196 }
 197
 198 void GuiCompare::finished(bool aborted)
 199 {
 200         enableControls(true);
 201
 202         if (compare_) {
 203                 delete compare_;
 204                 compare_ = 0;
 205         }
 206
 207         if (aborted) {
 208                 if (dest_buffer_) {
 209                         dest_buffer_->markClean();
 210                         theBufferList().release(dest_buffer_);
 211                 }
 212                 progressBar->setValue(0);
 213                 statusBar->showMessage(qt_("Aborted"), 5000);
 214         } else {
 215                 hideView();
 216                 bc().ok();
 217                 if (dest_buffer_) {
 218                         dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
 219                                 dest_buffer_->absFileName()));
 220                 }
 221                 statusBar->showMessage(qt_("Finished"), 5000);
 222         }
 223 }
 224
 225
 226 void GuiCompare::progress(int val)
 227 {
 228         progressBar->setValue(progressBar->value() + val);
 229 }
 230
 231
 232 void GuiCompare::progressMax(int max) const
 233 {
 234         progressBar->setMaximum(max);
 235 }
 236
 237
 238 void GuiCompare::setStatusMessage(QString msg)
 239 {
 240         statusBar->showMessage(msg);
 241 }
 242
 243
 244 void GuiCompare::slotOK()
 245 {
 246         enableControls(false);
 247         if (!run())
 248                 error();
 249 }
 250
 251
 252 void GuiCompare::slotCancel()
 253 {
 254         if (compare_ && compare_->isRunning()) {
 255                 statusBar->showMessage(qt_("Aborting process..."));
 256                 compare_->abort();
 257         } else {
 258                 GuiDialog::slotClose();
 259                 progressBar->setValue(0);
 260                 statusBar->clearMessage();
 261         }
 262 }
 263
 264
 265 Buffer const * GuiCompare::bufferFromFileName(string const & file) const
 266 {
 267         FileName fname;
 268         if (FileName::isAbsolute(file))
 269                 fname.set(file);
 270         else if (lyxview().documentBufferView())
 271                 fname = support::makeAbsPath(file, fromqstr(bufferFilepath()));
 272
 273         if (fname.empty()
 274                         || (!fname.exists() && !theBufferList().getBuffer(fname))) {
 275                 LYXERR0( "Unable to read: " << file);
 276                 return 0;
 277         }
 278         return loadIfNeeded(fname);
 279 }
 280
 281
 282 int GuiCompare::run()
 283 {
 284         progressBar->setValue(0);
 285
 286         new_buffer_ = bufferFromFileName(fromqstr(newFileCB->currentText()));
 287         old_buffer_ = bufferFromFileName(fromqstr(oldFileCB->currentText()));
 288
 289         // new buffer that will carry the output
 290         FileName initpath(lyxrc.document_path);
 291         dest_buffer_ = newUnnamedFile(initpath, to_utf8(_("differences")));
 292
 293         if (!new_buffer_ || !old_buffer_ || !dest_buffer_)
 294                 return 0;
 295
 296         dest_buffer_->changed(true);
 297         dest_buffer_->markDirty();
 298
 299         // get the options from the dialog
 300         CompareOptions options;
 301         options.settings_from_new = newSettingsRB->isChecked();
 302
 303         // init the compare object and start it
 304         compare_ = new Compare(new_buffer_, old_buffer_, dest_buffer_, options);
 305         connect(compare_, SIGNAL(error()), this, SLOT(error()));
 306         connect(compare_, SIGNAL(finished(bool)), this, SLOT(finished(bool)));
 307         connect(compare_, SIGNAL(progress(int)), this, SLOT(progress(int)));
 308         connect(compare_, SIGNAL(progressMax(int)), this, SLOT(progressMax(int)));
 309         connect(compare_, SIGNAL(statusMessage(QString)),
 310                 this, SLOT(setStatusMessage(QString)));
 311         compare_->start(QThread::LowPriority);
 312         return 1;
 313 }
 314
 315
 316 Dialog * createGuiCompare(GuiView & lv) { return new GuiCompare(lv); }
 317
 318
 319 } // namespace frontend
 320 } // namespace lyx
 321
 322
 323 #include "moc_GuiCompare.cpp"