3 * Copyright 1995-2002 the LyX Team
4 * Read the file COPYING
7 * \author John Levon <moz@compsoc.man.ac.uk>
12 #include "BufferView.h"
13 #include "BufferView_pimpl.h"
16 #include "ParagraphParameters.h"
17 #include "WordLangTuple.h"
19 #include "bufferlist.h"
22 #include "errorlist.h"
23 #include "iterators.h"
25 #include "lyxcursor.h"
28 #include "undo_funcs.h"
30 #include "paragraph_funcs.h"
32 #include "frontends/Alert.h"
33 #include "frontends/Dialogs.h"
34 #include "frontends/LyXView.h"
35 #include "frontends/WorkArea.h"
36 #include "frontends/screen.h"
38 #include "insets/insetcommand.h" // ChangeRefs
39 #include "insets/inseterror.h"
40 #include "insets/updatableinset.h"
42 #include "support/FileInfo.h"
43 #include "support/filetools.h"
44 #include "support/lyxfunctional.h" // equal_1st_in_pair
45 #include "support/types.h"
46 #include "support/lyxalgo.h" // lyx_count
50 extern BufferList bufferlist;
62 BufferView::BufferView(LyXView * owner, int xpos, int ypos,
63 int width, int height)
64 : pimpl_(new Pimpl(this, owner, xpos, ypos, width, height))
70 BufferView::~BufferView()
77 Buffer * BufferView::buffer() const
79 return pimpl_->buffer_;
83 LyXScreen & BufferView::screen() const
85 return pimpl_->screen();
89 LyXView * BufferView::owner() const
91 return pimpl_->owner_;
95 Painter & BufferView::painter() const
97 return pimpl_->painter();
101 void BufferView::buffer(Buffer * b)
107 bool BufferView::loadLyXFile(string const & fn, bool tl)
109 return pimpl_->loadLyXFile(fn, tl);
113 void BufferView::reload()
115 string const fn = buffer()->fileName();
116 if (bufferlist.close(buffer(), false))
121 void BufferView::resize()
123 if (pimpl_->buffer_) {
124 pimpl_->resizeCurrentBuffer();
129 void BufferView::repaint()
135 bool BufferView::fitCursor()
137 return pimpl_->fitCursor();
141 void BufferView::update()
147 void BufferView::updateScrollbar()
149 pimpl_->updateScrollbar();
153 void BufferView::scrollDocView(int value)
155 pimpl_->scrollDocView(value);
159 void BufferView::redoCurrentBuffer()
161 pimpl_->redoCurrentBuffer();
165 bool BufferView::available() const
167 return pimpl_->available();
171 Change const BufferView::getCurrentChange()
173 return pimpl_->getCurrentChange();
177 void BufferView::beforeChange(LyXText * text)
179 pimpl_->beforeChange(text);
183 void BufferView::savePosition(unsigned int i)
185 pimpl_->savePosition(i);
189 void BufferView::restorePosition(unsigned int i)
191 pimpl_->restorePosition(i);
195 bool BufferView::isSavedPosition(unsigned int i)
197 return pimpl_->isSavedPosition(i);
201 void BufferView::update(LyXText * text, UpdateCodes f)
203 pimpl_->update(text, f);
207 void BufferView::update(UpdateCodes f)
213 void BufferView::switchKeyMap()
215 pimpl_->switchKeyMap();
219 void BufferView::insetUnlock()
221 pimpl_->insetUnlock();
225 int BufferView::workWidth() const
227 return pimpl_->workarea().workWidth();
231 void BufferView::toggleSelection(bool b)
233 pimpl_->toggleSelection(b);
237 void BufferView::toggleToggle()
239 pimpl_->toggleToggle();
243 void BufferView::center()
249 string const BufferView::getClipboard() const
251 return pimpl_->workarea().getClipboard();
255 void BufferView::stuffClipboard(string const & stuff) const
257 pimpl_->stuffClipboard(stuff);
261 BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
262 BufferView::UpdateCodes uc2)
264 return static_cast<BufferView::UpdateCodes>
265 (static_cast<int>(uc1) | static_cast<int>(uc2));
269 bool BufferView::dispatch(FuncRequest const & ev)
271 return pimpl_->dispatch(ev);
275 void BufferView::scroll(int lines)
277 pimpl_->scroll(lines);
281 // Inserts a file into current document
282 bool BufferView::insertLyXFile(string const & filen)
284 // Copyright CHT Software Service GmbH
287 // Insert a LyXformat - file into current buffer
289 // Moved from lyx_cb.C (Lgb)
294 string const fname = MakeAbsPath(filen);
296 // check if file exist
297 FileInfo const fi(fname);
299 if (!fi.readable()) {
300 string const file = MakeDisplayPath(fname, 50);
302 bformat(_("The specified document\n%1$s\ncould not be read."), file);
303 Alert::error(_("Could not read document"), text);
309 ifstream ifs(fname.c_str());
311 string const file = MakeDisplayPath(fname, 50);
313 bformat(_("Could not open the specified document %1$s\n"), file);
314 Alert::error(_("Could not open file"), text);
318 int const c = ifs.peek();
326 // FIXME: huh ? No we won't !
327 lyxerr[Debug::INFO] << "Will insert file with header" << endl;
328 res = buffer()->readFile(lex, fname, ParagraphList::iterator(text->cursor.par()));
330 lyxerr[Debug::INFO] << "Will insert file without header"
332 res = buffer()->readBody(lex, ParagraphList::iterator(text->cursor.par()));
340 void BufferView::resetErrorList()
342 pimpl_->errorlist_.clear();
346 void BufferView::setErrorList(ErrorList const & el)
348 pimpl_->errorlist_ = el;
352 void BufferView::addError(ErrorItem const & ei)
354 pimpl_->errorlist_.push_back(ei);
359 void BufferView::showErrorList(string const & action) const
361 if (getErrorList().size()) {
362 string const title = bformat(_("LyX: %1$s errors (%2$s)"), action, buffer()->fileName());
363 owner()->getDialogs().show("errorlist", title);
369 BufferView::getErrorList() const
371 return pimpl_->errorlist_;
375 void BufferView::setCursorFromRow(int row)
380 buffer()->texrow.getIdFromRow(row, tmpid, tmppos);
382 ParagraphList::iterator texrowpar;
385 texrowpar = text->ownerParagraphs().begin();
388 texrowpar = buffer()->getParFromID(tmpid).pit();
390 text->setCursor(texrowpar, tmppos);
394 bool BufferView::insertInset(Inset * inset, string const & lout)
396 return pimpl_->insertInset(inset, lout);
400 void BufferView::gotoLabel(string const & label)
402 for (Buffer::inset_iterator it = buffer()->inset_iterator_begin();
403 it != buffer()->inset_iterator_end(); ++it) {
404 vector<string> labels;
405 it->getLabelList(labels);
406 if (find(labels.begin(),labels.end(),label)
409 text->setCursor(it.getPar(), it.getPos());
410 text->selection.cursor = text->cursor;
411 update(text, BufferView::SELECT);
418 void BufferView::undo()
423 owner()->message(_("Undo"));
425 update(text, BufferView::SELECT);
427 owner()->message(_("No further undo information"));
429 update(text, BufferView::SELECT);
434 void BufferView::redo()
439 owner()->message(_("Redo"));
441 update(text, BufferView::SELECT);
443 owner()->message(_("No further redo information"));
445 update(text, BufferView::SELECT);
450 // these functions are for the spellchecker
451 WordLangTuple const BufferView::nextWord(float & value)
455 return WordLangTuple();
458 return text->selectNextWordToSpellcheck(value);
462 void BufferView::selectLastWord()
467 LyXCursor cur = text->selection.cursor;
469 text->selection.cursor = cur;
470 text->selectSelectedWord();
471 toggleSelection(false);
472 update(text, BufferView::SELECT);
476 void BufferView::endOfSpellCheck()
478 if (!available()) return;
481 text->selectSelectedWord();
482 text->clearSelection();
483 update(text, BufferView::SELECT);
487 void BufferView::replaceWord(string const & replacestring)
492 LyXText * tt = getLyXText();
493 update(tt, BufferView::SELECT);
495 // clear the selection (if there is any)
496 toggleSelection(false);
497 update(tt, BufferView::SELECT);
499 // clear the selection (if there is any)
500 toggleSelection(false);
501 tt->replaceSelectionWithString(replacestring);
503 tt->setSelectionRange(replacestring.length());
505 // Go back so that replacement string is also spellchecked
506 for (string::size_type i = 0; i < replacestring.length() + 1; ++i) {
507 tt->cursorLeft(this);
509 update(tt, BufferView::SELECT);
511 // FIXME: should be done through LFUN
512 buffer()->markDirty();
515 // End of spellchecker stuff
518 bool BufferView::lockInset(UpdatableInset * inset)
522 // don't relock if we're already locked
523 if (theLockingInset() == inset)
525 if (!theLockingInset()) {
526 // first check if it's the inset under the cursor we want lock
527 // should be most of the time
528 if (text->cursor.pos() < text->cursor.par()->size()
529 && text->cursor.par()->getChar(text->cursor.pos()) ==
530 Paragraph::META_INSET) {
531 Inset * in = text->cursor.par()->getInset(text->cursor.pos());
533 theLockingInset(inset);
537 // Then do a deep look of the inset and lock the right one
538 int const id = inset->id();
539 ParagraphList::iterator pit = buffer()->paragraphs.begin();
540 ParagraphList::iterator pend = buffer()->paragraphs.end();
541 for (; pit != pend; ++pit) {
542 InsetList::iterator it = pit->insetlist.begin();
543 InsetList::iterator end = pit->insetlist.end();
544 for (; it != end; ++it) {
545 if (it->inset == inset) {
546 text->setCursorIntern(pit, it->pos);
547 theLockingInset(inset);
550 if (it->inset->getInsetFromID(id)) {
551 text->setCursorIntern(pit, it->pos);
552 FuncRequest cmd(this, LFUN_INSET_EDIT, "left");
553 it->inset->localDispatch(cmd);
554 return theLockingInset()->lockInsetInInset(this, inset);
560 return theLockingInset()->lockInsetInInset(this, inset);
564 bool BufferView::fitLockedInsetCursor(int x, int y, int asc, int desc)
566 if (theLockingInset() && available()) {
567 y += text->cursor.iy() + theLockingInset()->insetInInsetY();
568 if (screen().fitManualCursor(this, text, x, y, asc, desc)) {
577 void BufferView::hideCursor()
579 screen().hideCursor();
583 int BufferView::unlockInset(UpdatableInset * inset)
587 if (inset && theLockingInset() == inset) {
588 inset->insetUnlock(this);
590 // make sure we update the combo !
591 owner()->setLayout(getLyXText()->cursor.par()->layout()->name());
592 // Tell the paragraph dialog that we changed paragraph
593 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
596 } else if (inset && theLockingInset() &&
597 theLockingInset()->unlockInsetInInset(this, inset)) {
598 // Tell the paragraph dialog that we changed paragraph
599 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
600 // owner inset has updated the layout combo
608 void BufferView::lockedInsetStoreUndo(Undo::undo_kind kind)
610 if (!theLockingInset())
611 return; // shouldn't happen
612 if (kind == Undo::EDIT) // in this case insets would not be stored!
614 setUndo(this, kind, text->cursor.par());
618 void BufferView::updateInset(Inset * inset)
620 pimpl_->updateInset(inset);
624 bool BufferView::ChangeInsets(Inset::Code code,
625 string const & from, string const & to)
627 bool need_update = false;
628 LyXCursor cursor = text->cursor;
629 LyXCursor tmpcursor = cursor;
630 cursor.par(tmpcursor.par());
631 cursor.pos(tmpcursor.pos());
633 ParIterator end = buffer()->par_iterator_end();
634 for (ParIterator it = buffer()->par_iterator_begin();
636 bool changed_inset = false;
637 for (InsetList::iterator it2 = it->insetlist.begin();
638 it2 != it->insetlist.end(); ++it2) {
639 if (it2->inset->lyxCode() == code) {
640 InsetCommand * inset = static_cast<InsetCommand *>(it2->inset);
641 if (inset->getContents() == from) {
642 inset->setContents(to);
643 changed_inset = true;
652 // The test it.size()==1 was needed to prevent crashes.
653 // How to set the cursor corretly when it.size()>1 ??
654 if (it.size() == 1) {
655 text->setCursorIntern(it.pit(), 0);
656 text->redoParagraphs(text->cursor,
657 boost::next(text->cursor.par()));
662 text->setCursorIntern(cursor.par(), cursor.pos());
667 bool BufferView::ChangeRefsIfUnique(string const & from, string const & to)
669 // Check if the label 'from' appears more than once
670 vector<string> labels;
671 buffer()->getLabelList(labels);
673 if (lyx::count(labels.begin(), labels.end(), from) > 1)
676 return ChangeInsets(Inset::REF_CODE, from, to);
680 bool BufferView::ChangeCitationsIfUnique(string const & from, string const & to)
682 typedef pair<string, string> StringPair;
684 vector<StringPair> keys;
685 buffer()->fillWithBibKeys(keys);
686 if (count_if(keys.begin(), keys.end(),
687 lyx::equal_1st_in_pair<StringPair>(from))
691 return ChangeInsets(Inset::CITE_CODE, from, to);
695 UpdatableInset * BufferView::theLockingInset() const
697 // If NULL is not allowed we should put an Assert here. (Lgb)
699 return text->the_locking_inset;
704 void BufferView::theLockingInset(UpdatableInset * inset)
706 text->the_locking_inset = inset;
710 LyXText * BufferView::getLyXText() const
712 if (theLockingInset()) {
713 LyXText * txt = theLockingInset()->getLyXText(this, true);
721 LyXText * BufferView::getParentText(Inset * inset) const
723 if (inset->owner()) {
724 LyXText * txt = inset->getLyXText(this);
725 inset = inset->owner();
726 while (inset && inset->getLyXText(this) == txt)
727 inset = inset->owner();
729 return inset->getLyXText(this);
735 Language const * BufferView::getParentLanguage(Inset * inset) const
737 LyXText * text = getParentText(inset);
738 return text->cursor.par()->getFontSettings(buffer()->params,
739 text->cursor.pos()).language();
743 Encoding const * BufferView::getEncoding() const
745 LyXText * t = getLyXText();
749 LyXCursor const & c = t->cursor;
750 LyXFont const font = c.par()->getFont(buffer()->params, c.pos(),
751 outerFont(c.par(), t->ownerParagraphs()));
752 return font.language()->encoding();
756 void BufferView::haveSelection(bool sel)
758 pimpl_->workarea().haveSelection(sel);
762 int BufferView::workHeight() const
764 return pimpl_->workarea().workHeight();