2 * \file FindAndReplace.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Tommaso Cucinotta
8 * Full author contact details are available in file CREDITS.
13 #include "FindAndReplace.h"
16 #include "GuiApplication.h"
18 #include "GuiWorkArea.h"
19 #include "qt_helpers.h"
22 #include "BufferParams.h"
23 #include "BufferList.h"
24 #include "TextClass.h"
26 #include "FuncRequest.h"
29 #include "frontends/alert.h"
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"
38 #include <QCloseEvent>
43 using namespace lyx::support;
49 FindAndReplaceWidget::FindAndReplaceWidget(GuiView & view)
50 : QTabWidget(&view), view_(view)
53 find_work_area_->setGuiView(view_);
54 find_work_area_->init();
55 find_work_area_->setFrameStyle(QFrame::StyledPanel);
57 setFocusProxy(find_work_area_);
58 replace_work_area_->setGuiView(view_);
59 replace_work_area_->init();
60 replace_work_area_->setFrameStyle(QFrame::StyledPanel);
62 // We don't want two cursors blinking.
63 find_work_area_->stopBlinkingCursor();
64 replace_work_area_->stopBlinkingCursor();
68 bool FindAndReplaceWidget::eventFilter(QObject * obj, QEvent * event)
70 if (event->type() != QEvent::KeyPress
71 || (obj != find_work_area_ && obj != replace_work_area_))
72 return QWidget::eventFilter(obj, event);
74 QKeyEvent * e = static_cast<QKeyEvent *> (event);
77 if (e->modifiers() == Qt::NoModifier) {
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);
90 if (obj == find_work_area_)
91 on_findNextPB_clicked();
93 on_replacePB_clicked();
95 searchbackCB->setChecked(searchback);
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));
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));
126 // standard event processing
127 return QWidget::eventFilter(obj, event);
131 static vector<string> const & allManualsFiles()
133 static vector<string> v;
134 static const char * files[] = {
135 "Intro", "UserGuide", "Tutorial", "Additional",
136 "EmbeddedObjects", "Math", "Customization", "Shortcuts",
137 "LFUNs", "LaTeXConfig"
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());
150 /** Switch p_buf to point to next document buffer.
152 ** Return true if restarted from master-document buffer.
154 static bool nextDocumentBuffer(Buffer * & buf)
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(), /**/);
162 if (it == children.end()) {
163 buf = *children.begin();
171 /** Switch p_buf to point to previous document buffer.
173 ** Return true if restarted from last child buffer.
175 static bool prevDocumentBuffer(Buffer * & buf)
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()) {
194 /** Switch buf to point to next or previous buffer in search scope.
196 ** Return true if restarted from scratch.
198 static bool nextPrevBuffer(Buffer * & buf,
199 FindAndReplaceOptions const & opt)
201 bool restarted = false;
203 case FindAndReplaceOptions::S_BUFFER:
206 case FindAndReplaceOptions::S_DOCUMENT:
208 restarted = nextDocumentBuffer(buf);
210 restarted = prevDocumentBuffer(buf);
212 case FindAndReplaceOptions::S_OPEN_BUFFERS:
214 buf = theBufferList().next(buf);
215 restarted = (buf == *theBufferList().begin());
217 buf = theBufferList().previous(buf);
218 restarted = (buf == *(theBufferList().end() - 1));
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) {
229 if (it == manuals.end()) {
230 it = manuals.begin();
234 if (it == manuals.begin()) {
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);
246 buf = theBufferList().getBuffer(fname);
253 /** Find the finest question message to post to the user */
254 docstring getQuestionString(FindAndReplaceOptions const & opt)
258 case FindAndReplaceOptions::S_BUFFER:
261 case FindAndReplaceOptions::S_DOCUMENT:
262 scope = _("Master document");
264 case FindAndReplaceOptions::S_OPEN_BUFFERS:
265 scope = _("Open files");
267 case FindAndReplaceOptions::S_ALL_MANUALS:
268 scope = _("Manuals");
271 docstring message = opt.forward ?
272 bformat(_("%1$s: the end was reached while searching forward.\n"
273 "Continue searching from the beginning?"),
275 bformat(_("%1$s: the beginning was reached while searching backward.\n"
276 "Continue searching from the end?"),
283 /// Return true if a match was found
284 bool FindAndReplaceWidget::findAndReplaceScope(FindAndReplaceOptions & opt, bool replace_all)
286 BufferView * bv = view_.documentBufferView();
289 Buffer * buf = &bv->buffer();
290 Buffer * buf_orig = &bv->buffer();
291 DocIterator cur_orig(bv->cursor());
292 int wrap_answer = -1;
295 FuncRequest cmd(LFUN_WORD_FINDADV, from_utf8(oss.str()));
297 view_.message(_("Advanced search in progress (press ESC to cancel) . . ."));
298 theApp()->startLongOperation();
300 if (opt.scope == FindAndReplaceOptions::S_ALL_MANUALS) {
301 vector<string> const & v = allManualsFiles();
302 if (std::find(v.begin(), v.end(), buf->absFileName()) == v.end()) {
303 FileName const & fname = FileName(*v.begin());
304 if (!theBufferList().exists(fname)) {
305 guiApp->currentView()->setBusy(false);
306 theApp()->stopLongOperation();
307 guiApp->currentView()->loadDocument(fname, false);
308 theApp()->startLongOperation();
309 guiApp->currentView()->setBusy(true);
311 buf = theBufferList().getBuffer(fname);
313 view_.setBusy(false);
317 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
318 buf->absFileName()));
319 bv = view_.documentBufferView();
320 bv->cursor().clear();
321 bv->cursor().push_back(CursorSlice(buf->inset()));
326 LYXERR(Debug::FIND, "Dispatching LFUN_WORD_FINDADV");
328 LYXERR(Debug::FIND, "dispatched");
329 if (bv->cursor().result().dispatched()) {
330 // New match found and selected (old selection replaced if needed)
333 view_.setBusy(false);
334 theApp()->stopLongOperation();
336 } else if (replace_all)
337 bv->clearSelection();
339 if (theApp()->longOperationCancelled()) {
340 // Search aborted by user
341 view_.message(_("Advanced search cancelled by user"));
342 view_.setBusy(false);
343 theApp()->stopLongOperation();
347 // No match found in current buffer (however old selection might have been replaced)
348 // select next buffer in scope, if any
349 bool const prompt = nextPrevBuffer(buf, opt);
353 if (wrap_answer != -1)
355 docstring q = getQuestionString(opt);
356 view_.setBusy(false);
357 theApp()->stopLongOperation();
358 wrap_answer = frontend::Alert::prompt(
359 _("Wrap search?"), q,
360 0, 1, _("&Yes"), _("&No"));
361 theApp()->startLongOperation();
363 if (wrap_answer == 1)
366 if (buf != &view_.documentBufferView()->buffer())
367 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
368 buf->absFileName()));
369 bv = view_.documentBufferView();
371 bv->cursor().clear();
372 bv->cursor().push_back(CursorSlice(buf->inset()));
374 //lyx::dispatch(FuncRequest(LFUN_BUFFER_END));
375 bv->cursor().setCursor(doc_iterator_end(buf));
376 bv->cursor().backwardPos();
377 LYXERR(Debug::FIND, "findBackAdv5: cur: "
380 bv->clearSelection();
381 } while (wrap_answer != 1);
382 if (buf_orig != &view_.documentBufferView()->buffer())
383 lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
384 buf_orig->absFileName()));
385 bv = view_.documentBufferView();
386 // This may happen after a replace occurred
387 if (cur_orig.pos() > cur_orig.lastpos())
388 cur_orig.pos() = cur_orig.lastpos();
389 bv->cursor().setCursor(cur_orig);
390 view_.setBusy(false);
391 theApp()->stopLongOperation();
396 /// Return true if a match was found
397 bool FindAndReplaceWidget::findAndReplace(
398 bool casesensitive, bool matchword, bool backwards,
399 bool expandmacros, bool ignoreformat, bool replace,
400 bool keep_case, bool replace_all)
402 Buffer & find_buf = find_work_area_->bufferView().buffer();
403 docstring const & find_buf_name = find_buf.fileName().absoluteFilePath();
405 if (find_buf.text().empty()) {
406 view_.message(_("Nothing to search"));
410 Buffer & repl_buf = replace_work_area_->bufferView().buffer();
411 docstring const & repl_buf_name = replace ?
412 repl_buf.fileName().absoluteFilePath() : docstring();
414 FindAndReplaceOptions::SearchScope scope =
415 FindAndReplaceOptions::S_BUFFER;
416 if (CurrentDocument->isChecked())
417 scope = FindAndReplaceOptions::S_BUFFER;
418 else if (MasterDocument->isChecked())
419 scope = FindAndReplaceOptions::S_DOCUMENT;
420 else if (OpenDocuments->isChecked())
421 scope = FindAndReplaceOptions::S_OPEN_BUFFERS;
422 else if (AllManualsRB->isChecked())
423 scope = FindAndReplaceOptions::S_ALL_MANUALS;
425 LASSERT(false, /**/);
426 LYXERR(Debug::FIND, "FindAndReplaceOptions: "
427 << "find_buf_name=" << find_buf_name
428 << ", casesensitiv=" << casesensitive
429 << ", matchword=" << matchword
430 << ", backwards=" << backwards
431 << ", expandmacros=" << expandmacros
432 << ", ignoreformat=" << ignoreformat
433 << ", repl_buf_name" << repl_buf_name
434 << ", keep_case=" << keep_case
435 << ", scope=" << scope);
436 FindAndReplaceOptions opt(find_buf_name, casesensitive, matchword,
437 !backwards, expandmacros, ignoreformat,
438 repl_buf_name, keep_case, scope);
439 return findAndReplaceScope(opt, replace_all);
443 bool FindAndReplaceWidget::findAndReplace(bool backwards, bool replace, bool replace_all)
445 if (! view_.currentMainWorkArea()) {
446 view_.message(_("No open document(s) in which to search"));
449 // Finalize macros that are being typed, both in main document and in search or replacement WAs
450 if (view_.currentWorkArea()->bufferView().cursor().macroModeClose())
451 view_.currentWorkArea()->bufferView().processUpdateFlags(Update::Force);
452 if (view_.currentMainWorkArea()->bufferView().cursor().macroModeClose())
453 view_.currentMainWorkArea()->bufferView().processUpdateFlags(Update::Force);
455 // FIXME: create a Dialog::returnFocus()
456 // or something instead of this:
457 view_.setCurrentWorkArea(view_.currentMainWorkArea());
458 return findAndReplace(caseCB->isChecked(),
459 wordsCB->isChecked(),
461 expandMacrosCB->isChecked(),
462 ignoreFormatCB->isChecked(),
464 keepCaseCB->isChecked(),
469 void FindAndReplaceWidget::hideDialog()
471 dispatch(FuncRequest(LFUN_DIALOG_TOGGLE, "findreplaceadv"));
475 void FindAndReplaceWidget::on_findNextPB_clicked()
477 findAndReplace(searchbackCB->isChecked(), false);
478 find_work_area_->setFocus();
482 void FindAndReplaceWidget::on_replacePB_clicked()
484 findAndReplace(searchbackCB->isChecked(), true);
485 replace_work_area_->setFocus();
489 void FindAndReplaceWidget::on_replaceallPB_clicked()
491 findAndReplace(searchbackCB->isChecked(), true, true);
492 replace_work_area_->setFocus();
496 /** Copy selected elements from bv's BufferParams to the dest_bv's one
497 ** We don't want to copy'em all, e.g., not the default master **/
498 static void copy_params(BufferView const & bv, BufferView & dest_bv) {
499 Buffer const & doc_buf = bv.buffer();
500 BufferParams const & doc_bp = doc_buf.params();
501 string const & lang = doc_bp.language->lang();
502 string const & doc_class = doc_bp.documentClass().name();
503 Buffer & dest_buf = dest_bv.buffer();
504 dest_buf.params().setLanguage(lang);
505 dest_buf.params().setBaseClass(doc_class);
506 dest_buf.params().makeDocumentClass();
507 dest_bv.cursor().current_font.setLanguage(doc_bp.language);
511 void FindAndReplaceWidget::showEvent(QShowEvent * /* ev */)
513 LYXERR(Debug::DEBUG, "showEvent()" << endl);
514 BufferView * bv = view_.documentBufferView();
516 copy_params(*bv, find_work_area_->bufferView());
517 copy_params(*bv, replace_work_area_->bufferView());
520 find_work_area_->installEventFilter(this);
521 replace_work_area_->installEventFilter(this);
523 view_.setCurrentWorkArea(find_work_area_);
524 LYXERR(Debug::FIND, "Selecting entire find buffer");
525 dispatch(FuncRequest(LFUN_BUFFER_BEGIN));
526 dispatch(FuncRequest(LFUN_BUFFER_END_SELECT));
530 void FindAndReplaceWidget::hideEvent(QHideEvent *ev)
532 replace_work_area_->removeEventFilter(this);
533 find_work_area_->removeEventFilter(this);
534 this->QWidget::hideEvent(ev);
538 bool FindAndReplaceWidget::initialiseParams(std::string const & /*params*/)
544 void FindAndReplace::updateView()
546 widget_->updateGUI();
550 FindAndReplace::FindAndReplace(GuiView & parent,
551 Qt::DockWidgetArea area, Qt::WindowFlags flags)
552 : DockView(parent, "findreplaceadv", qt_("Advanced Find and Replace"),
555 widget_ = new FindAndReplaceWidget(parent);
557 setFocusProxy(widget_);
561 FindAndReplace::~FindAndReplace()
568 bool FindAndReplace::initialiseParams(std::string const & params)
570 return widget_->initialiseParams(params);
574 void FindAndReplaceWidget::updateGUI()
576 bool replace_enabled = view_.documentBufferView()
577 && !view_.documentBufferView()->buffer().isReadonly();
578 replace_work_area_->setEnabled(replace_enabled);
579 replacePB->setEnabled(replace_enabled);
580 replaceallPB->setEnabled(replace_enabled);
584 Dialog * createGuiSearchAdv(GuiView & lv)
586 FindAndReplace * gui = new FindAndReplace(lv, Qt::RightDockWidgetArea);
588 // On Mac show and floating
589 gui->setFloating(true);
595 } // namespace frontend
599 #include "moc_FindAndReplace.cpp"