1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
13 #include "BufferView.h"
15 #include "lyxcursor.h"
17 #include "frontends/LyXView.h"
18 #include "bufferlist.h"
19 #include "frontends/screen.h"
21 #include "BufferView_pimpl.h"
24 #include "undo_funcs.h"
26 #include "iterators.h"
29 #include "frontends/Alert.h"
30 #include "frontends/Dialogs.h"
32 #include "insets/insetcommand.h" //ChangeRefs
33 #include "insets/inseterror.h"
35 #include "support/FileInfo.h"
36 #include "support/filetools.h"
37 #include "support/lyxfunctional.h" //equal_1st_in_pair
38 #include "support/types.h"
39 #include "support/lyxalgo.h" // lyx_count
43 extern BufferList bufferlist;
55 // Inserts a file into current document
56 bool BufferView::insertLyXFile(string const & filen)
58 // Copyright CHT Software Service GmbH
61 // Insert a LyXformat - file into current buffer
63 // Moved from lyx_cb.C (Lgb)
65 if (filen.empty()) return false;
67 string const fname = MakeAbsPath(filen);
69 // check if file exist
70 FileInfo const fi(fname);
73 Alert::alert(_("Error!"),
74 _("Specified file is unreadable: "),
75 MakeDisplayPath(fname, 50));
81 ifstream ifs(fname.c_str());
83 Alert::alert(_("Error!"),
84 _("Cannot open specified file: "),
85 MakeDisplayPath(fname, 50));
89 int const c = ifs.peek();
97 lyxerr[Debug::INFO] << "Will insert file with header" << endl;
98 res = buffer()->readFile(lex, text->cursor.par());
100 lyxerr[Debug::INFO] << "Will insert file without header"
102 res = buffer()->readLyXformat2(lex, text->cursor.par());
110 bool BufferView::removeAutoInsets()
112 // keep track of which pos and par the cursor was on
113 Paragraph * cursor_par = text->cursor.par();
114 Paragraph * cursor_par_prev = cursor_par ? cursor_par->previous() : 0;
115 Paragraph * cursor_par_next = cursor_par ? cursor_par->next() : 0;
116 pos_type cursor_pos = text->cursor.pos();
120 // Trap the deletion of the paragraph the cursor is in.
121 // Iterate until we find a paragraph that won't be immediately deleted.
122 // In reality this should mean we only execute the body of the while
123 // loop once at most. However for safety we iterate rather than just
124 // make this an if () conditional.
125 while ((cursor_par_prev || cursor_par_next)
126 && text->setCursor(this,
127 cursor_par_prev ? cursor_par_prev : cursor_par_next,
129 // We just removed cursor_par so have to fix the "cursor"
130 if (cursor_par_prev) {
134 cursor_par = cursor_par_prev;
135 cursor_pos = cursor_par->size();
139 cursor_par = cursor_par_next;
142 cursor_par_prev = cursor_par->previous();
143 cursor_par_next = cursor_par->next();
146 // Iterate through the paragraphs removing autoDelete insets as we go.
147 // If the paragraph ends up empty after all the autoDelete insets are
148 // removed that paragraph will be removed by the next setCursor() call.
149 ParIterator it = buffer()->par_iterator_begin();
150 ParIterator end = buffer()->par_iterator_end();
151 for (; it != end; ++it) {
152 Paragraph * par = *it;
153 Paragraph * par_prev = par ? par->previous() : 0;
154 bool removed = false;
156 if (text->setCursor(this, par, 0)
157 && cursor_par == par_prev) {
158 // The previous setCursor line was deleted and that
159 // was the cursor_par line. This can only happen if an
160 // error box was the sole item on cursor_par.
161 // It is possible for cursor_par_prev to be stray if
162 // the line it pointed to only had a error box on it
163 // so we have to set it to a known correct value.
164 // This is often the same value it already had.
165 cursor_par_prev = par->previous();
166 if (cursor_par_prev) {
167 // '|' = par, '.' = cursor_par, 'E' = error box
168 // First step below may occur before while{}
170 // E -> .E -> |.E -> . -> |b
173 cursor_par = cursor_par_prev;
174 cursor_pos = cursor_par_prev->size();
175 cursor_par_prev = cursor_par->previous();
176 // cursor_par_next remains the same
177 } else if (cursor_par_next) {
178 // First step below may occur before while{}
180 // E -> |.E -> |. -> . -> .|a
182 cursor_par = cursor_par_next;
184 // cursor_par_prev remains unset
185 cursor_par_next = cursor_par->next();
187 // I can't find a way to trigger this
188 // so it should be unreachable code
189 // unless the buffer is corrupted.
190 lyxerr << "BufferView::removeAutoInsets() is bad\n";
194 InsetList::iterator pit = par->insetlist.begin();
195 InsetList::iterator pend = par->insetlist.end();
197 while (pit != pend) {
198 if (pit.getInset()->autoDelete()) {
200 pos_type const pos = pit.getPos();
203 // We just invalidated par's inset iterators so
204 // we get the next valid iterator position
205 pit = par->insetlist.insetIterator(pos);
206 // and ensure we have a valid end iterator.
207 pend = par->insetlist.end();
209 if (cursor_par == par) {
210 // update the saved cursor position
211 if (cursor_pos > pos)
220 text->redoParagraph(this);
224 // It is possible that the last line is empty if it was cursor_par
225 // and/or only had an error inset on it. So we set the cursor to the
226 // start of the doc to force its removal and ensure a valid saved cursor
227 if (text->setCursor(this, text->ownerParagraph(), 0)
228 && 0 == cursor_par_next) {
229 cursor_par = cursor_par_prev;
230 cursor_pos = cursor_par->size();
231 } else if (cursor_pos > cursor_par->size()) {
232 // Some C-Enter lines were removed by the setCursor call which
233 // then invalidated cursor_pos. It could still be "wrong" because
234 // the cursor may appear to have jumped but since we collapsed
235 // some C-Enter lines this should be a reasonable compromise.
236 cursor_pos = cursor_par->size();
239 // restore the original cursor in its corrected location.
240 text->setCursorIntern(this, cursor_par, cursor_pos);
246 void BufferView::insertErrors(TeXErrors & terr)
248 // Save the cursor position
249 LyXCursor cursor = text->cursor;
251 TeXErrors::Errors::const_iterator cit = terr.begin();
252 TeXErrors::Errors::const_iterator end = terr.end();
253 for (; cit != end; ++cit) {
254 string const desctext(cit->error_desc);
255 string const errortext(cit->error_text);
256 string const msgtxt = desctext + '\n' + errortext;
257 int const errorrow = cit->error_in_line;
259 // Insert error string for row number
263 if (buffer()->texrow.getIdFromRow(errorrow, tmpid, tmppos)) {
264 buffer()->texrow.increasePos(tmpid, tmppos);
267 Paragraph * texrowpar = 0;
270 texrowpar = text->ownerParagraph();
273 texrowpar = buffer()->getParFromID(tmpid);
280 InsetError * new_inset = new InsetError(msgtxt);
281 text->setCursorIntern(this, texrowpar, tmppos);
282 text->insertInset(this, new_inset);
283 text->fullRebreak(this);
286 // Restore the cursor position
287 text->setCursorIntern(this, cursor.par(), cursor.pos());
291 void BufferView::setCursorFromRow(int row)
296 buffer()->texrow.getIdFromRow(row, tmpid, tmppos);
298 Paragraph * texrowpar;
301 texrowpar = text->ownerParagraph();
304 texrowpar = buffer()->getParFromID(tmpid);
306 text->setCursor(this, texrowpar, tmppos);
310 bool BufferView::insertInset(Inset * inset, string const & lout)
312 return pimpl_->insertInset(inset, lout);
316 /* This is also a buffer property (ale) */
317 // Not so sure about that. a goto Label function can not be buffer local, just
318 // think how this will work in a multiwindo/buffer environment, all the
319 // cursors in all the views showing this buffer will move. (Lgb)
320 // OK, then no cursor action should be allowed in buffer. (ale)
321 bool BufferView::gotoLabel(string const & label)
324 for (Buffer::inset_iterator it = buffer()->inset_iterator_begin();
325 it != buffer()->inset_iterator_end(); ++it) {
326 vector<string> labels = (*it)->getLabelList();
327 if (find(labels.begin(),labels.end(),label)
330 text->setCursor(this, it.getPar(), it.getPos());
331 text->selection.cursor = text->cursor;
332 update(text, BufferView::SELECT|BufferView::FITCUR);
340 void BufferView::menuUndo()
345 owner()->message(_("Undo"));
348 update(text, BufferView::SELECT|BufferView::FITCUR);
350 owner()->message(_("No further undo information"));
352 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
357 void BufferView::menuRedo()
362 owner()->message(_("Redo"));
365 update(text, BufferView::SELECT|BufferView::FITCUR);
367 owner()->message(_("No further redo information"));
369 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
374 void BufferView::copyEnvironment()
377 text->copyEnvironmentType();
378 owner()->message(_("Paragraph environment type copied"));
383 void BufferView::pasteEnvironment()
386 text->pasteEnvironmentType(this);
387 owner()->message(_("Paragraph environment type set"));
388 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
393 void BufferView::copy()
396 getLyXText()->copySelection(this);
397 owner()->message(_("Copy"));
402 void BufferView::cut(bool realcut)
406 update(text, BufferView::SELECT|BufferView::FITCUR);
407 text->cutSelection(this, true, realcut);
408 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
409 owner()->message(_("Cut"));
414 void BufferView::paste()
419 owner()->message(_("Paste"));
422 // clear the selection
424 text->clearSelection();
425 update(text, BufferView::SELECT|BufferView::FITCUR);
428 text->pasteSelection(this);
430 text->clearSelection();
431 update(text, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
432 // why fake a selection only I think it should be a real one and not only
433 // a painted one (Jug 20020318).
435 // clear the selection
437 text->clearSelection();
438 update(text, BufferView::SELECT|BufferView::FITCUR);
443 /* these functions are for the spellchecker */
444 WordLangTuple const BufferView::nextWord(float & value)
448 return WordLangTuple();
451 return text->selectNextWordToSpellcheck(this, value);
455 void BufferView::selectLastWord()
457 if (!available()) return;
459 LyXCursor cur = text->selection.cursor;
462 text->selection.cursor = cur;
463 text->selectSelectedWord(this);
464 toggleSelection(false);
465 update(text, BufferView::SELECT|BufferView::FITCUR);
469 void BufferView::endOfSpellCheck()
471 if (!available()) return;
475 text->selectSelectedWord(this);
476 text->clearSelection();
477 update(text, BufferView::SELECT|BufferView::FITCUR);
481 void BufferView::replaceWord(string const & replacestring)
483 if (!available()) return;
485 LyXText * tt = getLyXText();
487 update(tt, BufferView::SELECT|BufferView::FITCUR);
489 /* clear the selection (if there is any) */
490 toggleSelection(false);
491 update(tt, BufferView::SELECT|BufferView::FITCUR);
493 /* clear the selection (if there is any) */
494 toggleSelection(false);
495 tt->replaceSelectionWithString(this, replacestring);
497 tt->setSelectionOverString(this, replacestring);
499 // Go back so that replacement string is also spellchecked
500 for (string::size_type i = 0; i < replacestring.length() + 1; ++i) {
501 tt->cursorLeft(this);
503 update(tt, BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
505 // End of spellchecker stuff
508 bool BufferView::lockInset(UpdatableInset * inset)
512 // don't relock if we're already locked
513 if (theLockingInset() == inset)
515 if (!theLockingInset()) {
516 // first check if it's the inset under the cursor we want lock
517 // should be most of the time
518 char const c = text->cursor.par()->getChar(text->cursor.pos());
519 if (c == Paragraph::META_INSET) {
520 Inset * in = text->cursor.par()->getInset(text->cursor.pos());
522 theLockingInset(inset);
526 // Then do a deep look of the inset and lock the right one
527 Paragraph * par = &*(buffer()->paragraphs.begin());
528 int const id = inset->id();
530 InsetList::iterator it =
531 par->insetlist.begin();
532 InsetList::iterator const end =
533 par->insetlist.end();
534 for (; it != end; ++it) {
535 if (it.getInset() == inset) {
536 text->setCursorIntern(this, par, it.getPos());
537 theLockingInset(inset);
540 if (it.getInset()->getInsetFromID(id)) {
541 text->setCursorIntern(this, par, it.getPos());
542 it.getInset()->edit(this);
543 return theLockingInset()->lockInsetInInset(this, inset);
550 return theLockingInset()->lockInsetInInset(this, inset);
554 void BufferView::showLockedInsetCursor(int x, int y, int asc, int desc)
556 if (available() && theLockingInset() && !theLockingInset()->nodraw()) {
557 LyXCursor cursor = text->cursor;
558 Inset * locking_inset = theLockingInset()->getLockingInset();
560 if ((cursor.pos() - 1 >= 0) &&
561 cursor.par()->isInset(cursor.pos() - 1) &&
562 (cursor.par()->getInset(cursor.pos() - 1) ==
564 text->setCursor(this, cursor,
565 cursor.par(), cursor.pos() - 1);
566 LyXScreen::Cursor_Shape shape = LyXScreen::BAR_SHAPE;
567 LyXText * txt = getLyXText();
568 if (locking_inset->isTextInset() &&
569 locking_inset->lyxCode() != Inset::ERT_CODE &&
570 (txt->real_current_font.language() !=
571 buffer()->params.language
572 || txt->real_current_font.isVisibleRightToLeft()
573 != buffer()->params.language->RightToLeft()))
574 shape = (txt->real_current_font.isVisibleRightToLeft())
575 ? LyXScreen::REVERSED_L_SHAPE
576 : LyXScreen::L_SHAPE;
577 y += cursor.iy() + theLockingInset()->insetInInsetY();
578 screen().showManualCursor(text, x, y, asc, desc,
584 void BufferView::hideLockedInsetCursor()
586 if (theLockingInset() && available()) {
587 screen().hideCursor();
592 bool BufferView::fitLockedInsetCursor(int x, int y, int asc, int desc)
594 if (theLockingInset() && available()) {
595 y += text->cursor.iy() + theLockingInset()->insetInInsetY();
596 if (screen().fitManualCursor(this, text, x, y, asc, desc)) {
605 int BufferView::unlockInset(UpdatableInset * inset)
609 if (inset && theLockingInset() == inset) {
610 inset->insetUnlock(this);
612 // make sure we update the combo !
613 owner()->setLayout(getLyXText()->cursor.par()->layout()->name());
614 // Tell the paragraph dialog that we changed paragraph
615 owner()->getDialogs()->updateParagraph();
618 } else if (inset && theLockingInset() &&
619 theLockingInset()->unlockInsetInInset(this, inset)) {
620 // Tell the paragraph dialog that we changed paragraph
621 owner()->getDialogs()->updateParagraph();
622 // owner inset has updated the layout combo
626 return bufferlist.unlockInset(inset);
630 void BufferView::lockedInsetStoreUndo(Undo::undo_kind kind)
632 if (!theLockingInset())
633 return; // shouldn't happen
634 if (kind == Undo::EDIT) // in this case insets would not be stored!
638 text->cursor.par()->next());
642 void BufferView::updateInset(Inset * inset, bool mark_dirty)
644 pimpl_->updateInset(inset, mark_dirty);
648 bool BufferView::ChangeInsets(Inset::Code code,
649 string const & from, string const & to)
651 bool need_update = false;
652 LyXCursor cursor = text->cursor;
653 LyXCursor tmpcursor = cursor;
654 cursor.par(tmpcursor.par());
655 cursor.pos(tmpcursor.pos());
657 ParIterator end = buffer()->par_iterator_end();
658 for (ParIterator it = buffer()->par_iterator_begin();
660 Paragraph * par = *it;
661 bool changed_inset = false;
662 for (InsetList::iterator it2 = par->insetlist.begin();
663 it2 != par->insetlist.end(); ++it2) {
664 if (it2.getInset()->lyxCode() == code) {
665 InsetCommand * inset = static_cast<InsetCommand *>(it2.getInset());
666 if (inset->getContents() == from) {
667 inset->setContents(to);
668 changed_inset = true;
677 // The test it.size()==1 was needed to prevent crashes.
678 // How to set the cursor corretly when it.size()>1 ??
679 if (it.size() == 1) {
680 text->setCursorIntern(this, par, 0);
681 text->redoParagraphs(this, text->cursor,
682 text->cursor.par()->next());
683 text->fullRebreak(this);
687 text->setCursorIntern(this, cursor.par(), cursor.pos());
692 bool BufferView::ChangeRefsIfUnique(string const & from, string const & to)
694 // Check if the label 'from' appears more than once
695 vector<string> labels = buffer()->getLabelList();
697 if (lyx::count(labels.begin(), labels.end(), from) > 1)
700 return ChangeInsets(Inset::REF_CODE, from, to);
704 bool BufferView::ChangeCitationsIfUnique(string const & from,
707 typedef pair<string, string> StringPair;
709 vector<StringPair> keys = buffer()->getBibkeyList();
710 if (count_if(keys.begin(), keys.end(),
711 lyx::equal_1st_in_pair<StringPair>(from))
715 return ChangeInsets(Inset::CITE_CODE, from, to);
719 UpdatableInset * BufferView::theLockingInset() const
721 // If NULL is not allowed we should put an Assert here. (Lgb)
723 return text->the_locking_inset;
728 void BufferView::theLockingInset(UpdatableInset * inset)
730 text->the_locking_inset = inset;
734 LyXText * BufferView::getLyXText() const
736 if (theLockingInset()) {
737 LyXText * txt = theLockingInset()->getLyXText(this, true);
745 LyXText * BufferView::getParentText(Inset * inset) const
747 if (inset->owner()) {
748 LyXText * txt = inset->getLyXText(this);
749 inset = inset->owner();
750 while (inset && inset->getLyXText(this) == txt)
751 inset = inset->owner();
753 return inset->getLyXText(this);
759 Language const * BufferView::getParentLanguage(Inset * inset) const
761 LyXText * text = getParentText(inset);
762 return text->cursor.par()->getFontSettings(buffer()->params,
763 text->cursor.pos()).language();