src/frontends/qt4/FindAndReplace.cpp

   1 /**
   2  * \file FindAndReplace.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Tommaso Cucinotta
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "FindAndReplace.h"
  14
  15 #include "Lexer.h"
  16 #include "GuiApplication.h"
  17 #include "GuiView.h"
  18 #include "GuiWorkArea.h"
  19 #include "qt_helpers.h"
  20 #include "Language.h"
  21
  22 #include "BufferParams.h"
  23 #include "BufferList.h"
  24 #include "TextClass.h"
  25 #include "Cursor.h"
  26 #include "FuncRequest.h"
  27 #include "lyxfind.h"
  28
  29 #include "frontends/alert.h"
  30
  31 #include "support/debug.h"
  32 #include "support/filetools.h"
  33 #include "support/FileName.h"
  34 #include "support/gettext.h"
  35 #include "support/lassert.h"
  36 #include "support/lstrings.h"
  37
  38 #include <QCloseEvent>
  39 #include <QLineEdit>
  40 #include <QMenu>
  41
  42 using namespace std;
  43 using namespace lyx::support;
  44
  45 namespace lyx {
  46 namespace frontend {
  47
  48
  49 FindAndReplaceWidget::FindAndReplaceWidget(GuiView & view)
  50         : QTabWidget(&view), view_(view)
  51 {
  52         setupUi(this);
  53         find_work_area_->setGuiView(view_);
  54         find_work_area_->init();
  55         find_work_area_->setFrameStyle(QFrame::StyledPanel);
  56
  57         setFocusProxy(find_work_area_);
  58         replace_work_area_->setGuiView(view_);
  59         replace_work_area_->init();
  60         replace_work_area_->setFrameStyle(QFrame::StyledPanel);
  61
  62         // We don't want two cursors blinking.
  63         find_work_area_->stopBlinkingCursor();
  64         replace_work_area_->stopBlinkingCursor();
  65 }
  66
  67
  68 bool FindAndReplaceWidget::eventFilter(QObject * obj, QEvent * event)
  69 {
  70         if (event->type() != QEvent::KeyPress
  71                   || (obj != find_work_area_ && obj != replace_work_area_))
  72                 return QWidget::eventFilter(obj, event);
  73
  74         QKeyEvent * e = static_cast<QKeyEvent *> (event);
  75         switch (e->key()) {
  76         case Qt::Key_Escape:
  77                 if (e->modifiers() == Qt::NoModifier) {
  78                         hideDialog();
  79                         return true;
  80                 }
  81                 break;
  82
  83         case Qt::Key_Enter:
  84         case Qt::Key_Return: {
  85                 // with shift we (temporarily) change search/replace direction
  86                 bool const searchback = searchbackCB->isChecked();
  87                 if (e->modifiers() == Qt::ShiftModifier && !searchback)
  88                         searchbackCB->setChecked(!searchback);
  89
  90                 if (obj == find_work_area_)
  91                         on_findNextPB_clicked();
  92                 else
  93                         on_replacePB_clicked();
  94                 // back to how it was
  95                 searchbackCB->setChecked(searchback);
  96                 return true;
  97                 break;
  98                 }
  99         case Qt::Key_Tab:
 100                 if (e->modifiers() == Qt::NoModifier) {
 101                         if (obj == find_work_area_){
 102                                 LYXERR(Debug::FIND, "Focusing replace WA");
 103                                 replace_work_area_->setFocus();
 104                                 LYXERR(Debug::FIND, "Selecting entire replace buffer");
 105                                 dispatch(FuncRequest(LFUN_BUFFER_BEGIN));
 106                                 dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
 107                                 return true;
 108                         }
 109                 }
 110                 break;
 111
 112         case Qt::Key_Backtab:
 113                 if (obj == replace_work_area_) {
 114                         LYXERR(Debug::FIND, "Focusing find WA");
 115                         find_work_area_->setFocus();
 116                         LYXERR(Debug::FIND, "Selecting entire find buffer");
 117                         dispatch(FuncRequest(LFUN_BUFFER_BEGIN));
 118                         dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
 119                         return true;
 120                 }
 121                 break;
 122
 123         default:
 124                 break;
 125         }
 126         // standard event processing
 127         return QWidget::eventFilter(obj, event);
 128 }
 129
 130
 131 static vector<string> const & allManualsFiles()
 132 {
 133         static vector<string> v;
 134         static const char * files[] = {
 135                 "Intro", "UserGuide", "Tutorial", "Additional",
 136                 "EmbeddedObjects", "Math", "Customization", "Shortcuts",
 137                 "LFUNs", "LaTeXConfig"
 138         };
 139         if (v.empty()) {
 140                 FileName fname;
 141                 for (size_t i = 0; i < sizeof(files) / sizeof(files[0]); ++i) {
 142                         fname = i18nLibFileSearch("doc", files[i], "lyx");
 143                         v.push_back(fname.absFileName());
 144                 }
 145         }
 146         return v;
 147 }
 148
 149
 150 /** Switch p_buf to point to next document buffer.
 151  **
 152  ** Return true if restarted from master-document buffer.
 153  **/
 154 static bool nextDocumentBuffer(Buffer * & buf)
 155 {
 156         ListOfBuffers const children = buf->allRelatives();
 157         LYXERR(Debug::FIND, "children.size()=" << children.size());
 158         ListOfBuffers::const_iterator it =
 159                 find(children.begin(), children.end(), buf);
 160         LASSERT(it != children.end(), /**/);
 161         ++it;
 162         if (it == children.end()) {
 163                 buf = *children.begin();
 164                 return true;
 165         }
 166         buf = *it;
 167         return false;
 168 }
 169
 170
 171 /** Switch p_buf to point to previous document buffer.
 172  **
 173  ** Return true if restarted from last child buffer.
 174  **/
 175 static bool prevDocumentBuffer(Buffer * & buf)
 176 {
 177         ListOfBuffers const children = buf->allRelatives();
 178         LYXERR(Debug::FIND, "children.size()=" << children.size());
 179         ListOfBuffers::const_iterator it =
 180                 find(children.begin(), children.end(), buf);
 181         LASSERT(it != children.end(), /**/)
 182         if (it == children.begin()) {
 183                 it = children.end();
 184                 --it;
 185                 buf = *it;
 186                 return true;
 187         }
 188         --it;
 189         buf = *it;
 190         return false;
 191 }
 192
 193
 194 /** Switch buf to point to next or previous buffer in search scope.
 195  **
 196  ** Return true if restarted from scratch.
 197  **/
 198 static bool nextPrevBuffer(Buffer * & buf,
 199                              FindAndReplaceOptions const & opt)
 200 {
 201         bool restarted = false;
 202         switch (opt.scope) {
 203         case FindAndReplaceOptions::S_BUFFER:
 204                 restarted = true;
 205                 break;
 206         case FindAndReplaceOptions::S_DOCUMENT:
 207                 if (opt.forward)
 208                         restarted = nextDocumentBuffer(buf);
 209                 else
 210                         restarted = prevDocumentBuffer(buf);
 211                 break;
 212         case FindAndReplaceOptions::S_OPEN_BUFFERS:
 213                 if (opt.forward) {
 214                         buf = theBufferList().next(buf);
 215                         restarted = (buf == *theBufferList().begin());
 216                 } else {
 217                         buf = theBufferList().previous(buf);
 218                         restarted = (buf == *(theBufferList().end() - 1));
 219                 }
 220                 break;
 221         case FindAndReplaceOptions::S_ALL_MANUALS:
 222                 vector<string> const & manuals = allManualsFiles();
 223                 vector<string>::const_iterator it =
 224                         find(manuals.begin(), manuals.end(), buf->absFileName());
 225                 if (it == manuals.end())
 226                         it = manuals.begin();
 227                 else if (opt.forward) {
 228                         ++it;
 229                         if (it == manuals.end()) {
 230                                 it = manuals.begin();
 231                                 restarted = true;
 232                         }
 233                 } else {
 234                         if (it == manuals.begin()) {
 235                                 it = manuals.end();
 236                                 restarted = true;
 237                         }
 238                         --it;
 239                 }
 240                 FileName const & fname = FileName(*it);
 241                 if (!theBufferList().exists(fname)) {
 242                         guiApp->currentView()->setBusy(false);
 243                         guiApp->currentView()->loadDocument(fname, false);
 244                         guiApp->currentView()->setBusy(true);
 245                 }
 246                 buf = theBufferList().getBuffer(fname);
 247                 break;
 248         }
 249         return restarted;
 250 }
 251
 252
 253 /** Find the finest question message to post to the user */
 254 docstring getQuestionString(FindAndReplaceOptions const & opt)
 255 {
 256         docstring scope;
 257         switch (opt.scope) {
 258         case FindAndReplaceOptions::S_BUFFER:
 259                 scope = _("File");
 260                 break;
 261         case FindAndReplaceOptions::S_DOCUMENT:
 262                 scope = _("Master document");
 263                 break;
 264         case FindAndReplaceOptions::S_OPEN_BUFFERS:
 265                 scope = _("Open files");
 266                 break;
 267         case FindAndReplaceOptions::S_ALL_MANUALS:
 268                 scope = _("Manuals");
 269                 break;
 270         }
 271         docstring message = opt.forward ?
 272                 bformat(_("%1$s: the end was reached while searching forward.\n"
 273                           "Continue searching from the beginning?"),
 274                         scope) :
 275                 bformat(_("%1$s: the beginning was reached while searching backward.\n"
 276                           "Continue searching from the end?"),
 277                         scope);
 278
 279         return message;
 280 }
 281
 282
 283 /// Return true if a match was found
 284 bool FindAndReplaceWidget::findAndReplaceScope(FindAndReplaceOptions & opt, bool replace_all)
 285 {
 286         BufferView * bv = view_.documentBufferView();
 287         if (!bv)
 288                 return false;
 289         Buffer * buf = &bv->buffer();
 290         Buffer * buf_orig = &bv->buffer();
 291         DocIterator cur_orig(bv->cursor());
 292         int wrap_answer = -1;
 293         ostringstream oss;
 294         oss << opt;
 295         FuncRequest cmd(LFUN_WORD_FINDADV, from_utf8(oss.str()));
 296
 297         view_.setBusy(true);
 298         if (opt.scope == FindAndReplaceOptions::S_ALL_MANUALS) {
 299                 vector<string> const & v = allManualsFiles();
 300                 if (std::find(v.begin(), v.end(), buf->absFileName()) == v.end()) {
 301                         FileName const & fname = FileName(*v.begin());
 302                         if (!theBufferList().exists(fname)) {
 303                                 guiApp->currentView()->setBusy(false);
 304                                 guiApp->currentView()->loadDocument(fname, false);
 305                                 guiApp->currentView()->setBusy(true);
 306                         }
 307                         buf = theBufferList().getBuffer(fname);
 308                         lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
 309                                                   buf->absFileName()));
 310                         bv = view_.documentBufferView();
 311                         bv->cursor().clear();
 312                         bv->cursor().push_back(CursorSlice(buf->inset()));
 313                 }
 314         }
 315
 316         do {
 317                 LYXERR(Debug::FIND, "Dispatching LFUN_WORD_FINDADV");
 318                 dispatch(cmd);
 319                 LYXERR(Debug::FIND, "dispatched");
 320                 if (bv->cursor().result().dispatched()) {
 321                         // New match found and selected (old selection replaced if needed)
 322                         if (replace_all)
 323                                 continue;
 324                         view_.setBusy(false);
 325                         return true;
 326                 }
 327
 328                 // No match found in current buffer (however old selection might have been replaced)
 329                 // select next buffer in scope, if any
 330                 bool prompt = nextPrevBuffer(buf, opt);
 331                 if (prompt) {
 332                         if (wrap_answer != -1)
 333                                 break;
 334                         docstring q = getQuestionString(opt);
 335                         view_.setBusy(false);
 336                         wrap_answer = frontend::Alert::prompt(
 337                                 _("Wrap search?"), q,
 338                                 0, 1, _("&Yes"), _("&No"));
 339                         view_.setBusy(true);
 340                         if (wrap_answer == 1)
 341                                 break;
 342                 }
 343                 if (buf != &view_.documentBufferView()->buffer())
 344                         lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
 345                                                   buf->absFileName()));
 346                 bv = view_.documentBufferView();
 347                 if (opt.forward) {
 348                         bv->cursor().clear();
 349                         bv->cursor().push_back(CursorSlice(buf->inset()));
 350                 } else {
 351                         //lyx::dispatch(FuncRequest(LFUN_BUFFER_END));
 352                         bv->cursor().setCursor(doc_iterator_end(buf));
 353                         bv->cursor().backwardPos();
 354                         LYXERR(Debug::FIND, "findBackAdv5: cur: "
 355                                 << bv->cursor());
 356                 }
 357                 bv->clearSelection();
 358         } while (wrap_answer != 1);
 359         if (buf_orig != &view_.documentBufferView()->buffer())
 360                 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
 361                                           buf_orig->absFileName()));
 362         bv = view_.documentBufferView();
 363         // This may happen after a replace occurred
 364         if (cur_orig.pos() > cur_orig.lastpos())
 365                 cur_orig.pos() = cur_orig.lastpos();
 366         bv->cursor().setCursor(cur_orig);
 367         view_.setBusy(false);
 368         return false;
 369 }
 370
 371
 372 /// Return true if a match was found
 373 bool FindAndReplaceWidget::findAndReplace(
 374         bool casesensitive, bool matchword, bool backwards,
 375         bool expandmacros, bool ignoreformat, bool replace,
 376         bool keep_case, bool replace_all)
 377 {
 378         Buffer & find_buf = find_work_area_->bufferView().buffer();
 379         docstring const & find_buf_name = find_buf.fileName().absoluteFilePath();
 380
 381         if (find_buf.text().empty()) {
 382                 view_.message(_("Nothing to search"));
 383                 return false;
 384         }
 385
 386         Buffer & repl_buf = replace_work_area_->bufferView().buffer();
 387         docstring const & repl_buf_name = replace ?
 388                 repl_buf.fileName().absoluteFilePath() : docstring();
 389
 390         FindAndReplaceOptions::SearchScope scope =
 391                 FindAndReplaceOptions::S_BUFFER;
 392         if (CurrentDocument->isChecked())
 393                 scope = FindAndReplaceOptions::S_BUFFER;
 394         else if (MasterDocument->isChecked())
 395                 scope = FindAndReplaceOptions::S_DOCUMENT;
 396         else if (OpenDocuments->isChecked())
 397                 scope = FindAndReplaceOptions::S_OPEN_BUFFERS;
 398         else if (AllManualsRB->isChecked())
 399                 scope = FindAndReplaceOptions::S_ALL_MANUALS;
 400         else
 401                 LASSERT(false, /**/);
 402         LYXERR(Debug::FIND, "FindAndReplaceOptions: "
 403                << "find_buf_name=" << find_buf_name
 404                << ", casesensitiv=" << casesensitive
 405                << ", matchword=" << matchword
 406                << ", backwards=" << backwards
 407                << ", expandmacros=" << expandmacros
 408                << ", ignoreformat=" << ignoreformat
 409                << ", repl_buf_name" << repl_buf_name
 410                << ", keep_case=" << keep_case
 411                << ", scope=" << scope);
 412         FindAndReplaceOptions opt(find_buf_name, casesensitive, matchword,
 413                                   !backwards, expandmacros, ignoreformat,
 414                                   repl_buf_name, keep_case, scope);
 415         return findAndReplaceScope(opt, replace_all);
 416 }
 417
 418
 419 bool FindAndReplaceWidget::findAndReplace(bool backwards, bool replace, bool replace_all)
 420 {
 421         if (! view_.currentMainWorkArea()) {
 422                 view_.message(_("No open document(s) in which to search"));
 423                 return false;
 424         }
 425         // Finalize macros that are being typed, both in main document and in search or replacement WAs
 426         if (view_.currentWorkArea()->bufferView().cursor().macroModeClose())
 427                 view_.currentWorkArea()->bufferView().processUpdateFlags(Update::Force);
 428         if (view_.currentMainWorkArea()->bufferView().cursor().macroModeClose())
 429                 view_.currentMainWorkArea()->bufferView().processUpdateFlags(Update::Force);
 430
 431         // FIXME: create a Dialog::returnFocus()
 432         // or something instead of this:
 433         view_.setCurrentWorkArea(view_.currentMainWorkArea());
 434         return findAndReplace(caseCB->isChecked(),
 435                 wordsCB->isChecked(),
 436                 backwards,
 437                 expandMacrosCB->isChecked(),
 438                 ignoreFormatCB->isChecked(),
 439                 replace,
 440                 keepCaseCB->isChecked(),
 441                 replace_all);
 442 }
 443
 444
 445 void FindAndReplaceWidget::hideDialog()
 446 {
 447         dispatch(FuncRequest(LFUN_DIALOG_TOGGLE, "findreplaceadv"));
 448 }
 449
 450
 451 void FindAndReplaceWidget::on_findNextPB_clicked()
 452 {
 453         findAndReplace(searchbackCB->isChecked(), false);
 454         find_work_area_->setFocus();
 455 }
 456
 457
 458 void FindAndReplaceWidget::on_replacePB_clicked()
 459 {
 460         findAndReplace(searchbackCB->isChecked(), true);
 461         replace_work_area_->setFocus();
 462 }
 463
 464
 465 void FindAndReplaceWidget::on_replaceallPB_clicked()
 466 {
 467         findAndReplace(searchbackCB->isChecked(), true, true);
 468         replace_work_area_->setFocus();
 469 }
 470
 471
 472 /** Copy selected elements from bv's BufferParams to the dest_bv's one
 473  ** We don't want to copy'em all, e.g., not the default master **/
 474 static void copy_params(BufferView const & bv, BufferView & dest_bv) {
 475         Buffer const & doc_buf = bv.buffer();
 476         BufferParams const & doc_bp = doc_buf.params();
 477         string const & lang = doc_bp.language->lang();
 478         string const & doc_class = doc_bp.documentClass().name();
 479         Buffer & dest_buf = dest_bv.buffer();
 480         dest_buf.params().setLanguage(lang);
 481         dest_buf.params().setBaseClass(doc_class);
 482         dest_buf.params().makeDocumentClass();
 483         dest_bv.cursor().current_font.setLanguage(doc_bp.language);
 484 }
 485
 486
 487 void FindAndReplaceWidget::showEvent(QShowEvent * /* ev */)
 488 {
 489         LYXERR(Debug::DEBUG, "showEvent()" << endl);
 490         BufferView * bv = view_.documentBufferView();
 491         if (bv) {
 492                 copy_params(*bv, find_work_area_->bufferView());
 493                 copy_params(*bv, replace_work_area_->bufferView());
 494         }
 495
 496         find_work_area_->installEventFilter(this);
 497         replace_work_area_->installEventFilter(this);
 498
 499         view_.setCurrentWorkArea(find_work_area_);
 500         LYXERR(Debug::FIND, "Selecting entire find buffer");
 501         dispatch(FuncRequest(LFUN_BUFFER_BEGIN));
 502         dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
 503 }
 504
 505
 506 void FindAndReplaceWidget::hideEvent(QHideEvent *ev)
 507 {
 508         replace_work_area_->removeEventFilter(this);
 509         find_work_area_->removeEventFilter(this);
 510         this->QWidget::hideEvent(ev);
 511 }
 512
 513
 514 bool FindAndReplaceWidget::initialiseParams(std::string const & /*params*/)
 515 {
 516         return true;
 517 }
 518
 519
 520 FindAndReplace::FindAndReplace(GuiView & parent,
 521                 Qt::DockWidgetArea area, Qt::WindowFlags flags)
 522         : DockView(parent, "findreplaceadv", qt_("Advanced Find and Replace"),
 523                    area, flags)
 524 {
 525         widget_ = new FindAndReplaceWidget(parent);
 526         setWidget(widget_);
 527         setFocusProxy(widget_);
 528 }
 529
 530
 531 FindAndReplace::~FindAndReplace()
 532 {
 533         setFocusProxy(0);
 534         delete widget_;
 535 }
 536
 537
 538 bool FindAndReplace::initialiseParams(std::string const & params)
 539 {
 540         return widget_->initialiseParams(params);
 541 }
 542
 543
 544 Dialog * createGuiSearchAdv(GuiView & lv)
 545 {
 546         FindAndReplace * gui = new FindAndReplace(lv, Qt::RightDockWidgetArea);
 547 #ifdef Q_WS_MACX
 548         // On Mac show and floating
 549         gui->setFloating(true);
 550 #endif
 551         return gui;
 552 }
 553
 554
 555 } // namespace frontend
 556 } // namespace lyx
 557
 558
 559 #include "moc_FindAndReplace.cpp"