lyx_mirror/src/BufferView.C

/**
 * \file BufferView.C
 * Copyright 1995-2002 the LyX Team
 * Read the file COPYING
 *
 * \author unknown
 * \author John Levon <moz@compsoc.man.ac.uk>
 */

#include <config.h>

#include "BufferView.h"
#include "BufferView_pimpl.h"

#include "BufferView_pimpl.h"
#include "LaTeX.h"
#include "ParagraphParameters.h"
#include "WordLangTuple.h"
#include "buffer.h"
#include "bufferlist.h"
#include "debug.h"
#include "gettext.h"
#include "iterators.h"
#include "language.h"
#include "lyxcursor.h"
#include "lyxlex.h"
#include "lyxtext.h"
#include "undo_funcs.h"
#include "changes.h"

#include "frontends/Alert.h"
#include "frontends/Dialogs.h"
#include "frontends/LyXView.h"
#include "frontends/WorkArea.h"
#include "frontends/screen.h"

#include "insets/insetcommand.h" // ChangeRefs
#include "insets/inseterror.h"
#include "insets/updatableinset.h"

#include "support/FileInfo.h"
#include "support/filetools.h"
#include "support/lyxfunctional.h" // equal_1st_in_pair
#include "support/types.h"
#include "support/lyxalgo.h" // lyx_count
#include "support/BoostFormat.h"

#include <fstream>

extern BufferList bufferlist;

using lyx::pos_type;

using std::pair;
using std::endl;
using std::ifstream;
using std::vector;
using std::find;
using std::count_if;


BufferView::BufferView(LyXView * owner, int xpos, int ypos,
		       int width, int height)
	: pimpl_(new Pimpl(this, owner, xpos, ypos, width, height))
{
	text = 0;
}


BufferView::~BufferView()
{
	delete text;
	delete pimpl_;
}


Buffer * BufferView::buffer() const
{
	return pimpl_->buffer_;
}


LyXScreen & BufferView::screen() const
{
	return pimpl_->screen();
}


LyXView * BufferView::owner() const
{
	return pimpl_->owner_;
}


Painter & BufferView::painter() const
{
	return pimpl_->painter();
}


void BufferView::buffer(Buffer * b)
{
	pimpl_->buffer(b);
}


void BufferView::reload()
{
	string const fn = buffer()->fileName();
	if (bufferlist.close(buffer(), false))
		buffer(bufferlist.loadLyXFile(fn));
}


void BufferView::resize()
{
	if (pimpl_->buffer_) {
		pimpl_->resizeCurrentBuffer();
	}
}


void BufferView::repaint()
{
	pimpl_->repaint();
}


bool BufferView::fitCursor()
{
	return pimpl_->fitCursor();
}


void BufferView::update()
{
	pimpl_->update();
}


void BufferView::updateScrollbar()
{
	pimpl_->updateScrollbar();
}


void BufferView::scrollDocView(int value)
{
	pimpl_->scrollDocView(value);
}


void BufferView::redoCurrentBuffer()
{
	pimpl_->redoCurrentBuffer();
}


bool BufferView::available() const
{
	return pimpl_->available();
}


Change const BufferView::getCurrentChange()
{
	return pimpl_->getCurrentChange();
}


void BufferView::beforeChange(LyXText * text)
{
	pimpl_->beforeChange(text);
}


void BufferView::savePosition(unsigned int i)
{
	pimpl_->savePosition(i);
}


void BufferView::restorePosition(unsigned int i)
{
	pimpl_->restorePosition(i);
}


bool BufferView::isSavedPosition(unsigned int i)
{
	return pimpl_->isSavedPosition(i);
}


void BufferView::update(LyXText * text, UpdateCodes f)
{
	pimpl_->update(text, f);
}


void BufferView::update(UpdateCodes f)
{
	pimpl_->update(f);
}


void BufferView::switchKeyMap()
{
	pimpl_->switchKeyMap();
}


void BufferView::insetUnlock()
{
	pimpl_->insetUnlock();
}


int BufferView::workWidth() const
{
	return pimpl_->workarea().workWidth();
}


void BufferView::showCursor()
{
	pimpl_->showCursor();
}


void BufferView::hideCursor()
{
	pimpl_->hideCursor();
}


void BufferView::toggleSelection(bool b)
{
	pimpl_->toggleSelection(b);
}


void BufferView::toggleToggle()
{
	pimpl_->toggleToggle();
}


void BufferView::center()
{
	pimpl_->center();
}


string const BufferView::getClipboard() const
{
	return pimpl_->workarea().getClipboard();
}


void BufferView::stuffClipboard(string const & stuff) const
{
	pimpl_->stuffClipboard(stuff);
}


BufferView::UpdateCodes operator|(BufferView::UpdateCodes uc1,
				  BufferView::UpdateCodes uc2)
{
	return static_cast<BufferView::UpdateCodes>
		(static_cast<int>(uc1) | static_cast<int>(uc2));
}


bool BufferView::dispatch(FuncRequest const & ev)
{
	return pimpl_->dispatch(ev);
}


void BufferView::scroll(int lines)
{
	pimpl_->scroll(lines);
}


// Inserts a file into current document
bool BufferView::insertLyXFile(string const & filen)
	//
	// Copyright CHT Software Service GmbH
	// Uwe C. Schroeder
	//
	// Insert a LyXformat - file into current buffer
	//
	// Moved from lyx_cb.C (Lgb)
{
	if (filen.empty())
		return false;

	string const fname = MakeAbsPath(filen);

	// check if file exist
	FileInfo const fi(fname);

	if (!fi.readable()) {
		string const file = MakeDisplayPath(fname, 50);
#if USE_BOOST_FORMAT
		boost::format fmt(_("The specified document\n%1$s\ncould not be read."));
		fmt % file;
		string text = fmt.str();
#else
		string text = _("The specified document\n");
		text += file + _(" could not be read.");
#endif
		Alert::error(_("Could not read document"), text);
		return false;
	}

	beforeChange(text);

	ifstream ifs(fname.c_str());
	if (!ifs) {
		string const file = MakeDisplayPath(fname, 50);
#if USE_BOOST_FORMAT
		boost::format fmt(_("Could not open the specified document\n%1$s."));
		fmt % file;
		string text = fmt.str();
#else
		string text = _("Could not open the specified document\n");
		text += file + ".";
#endif
		Alert::error(_("Could not open file"), text);
		return false;
	}

	int const c = ifs.peek();

	LyXLex lex(0, 0);
	lex.setStream(ifs);

	bool res = true;

	if (c == '#') {
		// FIXME: huh ? No we won't !
		lyxerr[Debug::INFO] << "Will insert file with header" << endl;
		res = buffer()->readFile(lex, fname, ParagraphList::iterator(text->cursor.par()));
	} else {
		lyxerr[Debug::INFO] << "Will insert file without header"
				    << endl;
		res = buffer()->readBody(lex, ParagraphList::iterator(text->cursor.par()));
	}

	resize();
	return res;
}


bool BufferView::removeAutoInsets()
{
	// keep track of which pos and par the cursor was on
	Paragraph * cursor_par = &*text->cursor.par();
	Paragraph * cursor_par_prev = cursor_par ? cursor_par->previous() : 0;
	Paragraph * cursor_par_next = cursor_par ? cursor_par->next() : 0;
	pos_type cursor_pos = text->cursor.pos();

	bool found = false;

	// Trap the deletion of the paragraph the cursor is in.
	// Iterate until we find a paragraph that won't be immediately deleted.
	// In reality this should mean we only execute the body of the while
	// loop once at most.  However for safety we iterate rather than just
	// make this an if () conditional.
	while ((cursor_par_prev || cursor_par_next)
	       && text->setCursor(
				  cursor_par_prev ? cursor_par_prev : cursor_par_next,
				  0)) {
		// We just removed cursor_par so have to fix the "cursor"
		if (cursor_par_prev) {
			// '.' = cursor_par
			//  a -> a.
			// .
			cursor_par = cursor_par_prev;
			cursor_pos = cursor_par->size();
		} else {
			// .  -> .a
			//  a
			cursor_par = cursor_par_next;
			cursor_pos = 0;
		}
		cursor_par_prev = cursor_par->previous();
		cursor_par_next = cursor_par->next();
	}

	// Iterate through the paragraphs removing autoDelete insets as we go.
	// If the paragraph ends up empty after all the autoDelete insets are
	// removed that paragraph will be removed by the next setCursor() call.
	ParIterator it = buffer()->par_iterator_begin();
	ParIterator end = buffer()->par_iterator_end();
	for (; it != end; ++it) {
		Paragraph * par = *it;
		Paragraph * par_prev = par ? par->previous() : 0;
		bool removed = false;

		if (text->setCursor(par, 0)
		    && cursor_par == par_prev) {
			// The previous setCursor line was deleted and that
			// was the cursor_par line.  This can only happen if an
			// error box was the sole item on cursor_par.
			// It is possible for cursor_par_prev to be stray if
			// the line it pointed to only had a error box on it
			// so we have to set it to a known correct value.
			// This is often the same value it already had.
			cursor_par_prev = par->previous();
			if (cursor_par_prev) {
				// '|' = par, '.' = cursor_par, 'E' = error box
				// First step below may occur before while{}
				//  a    |a      a     a     a.
				//  E -> .E -> |.E -> .  -> |b
				// .      b      b    |b
				//  b
				cursor_par = cursor_par_prev;
				cursor_pos = cursor_par_prev->size();
				cursor_par_prev = cursor_par->previous();
				// cursor_par_next remains the same
			} else if (cursor_par_next) {
				// First step below may occur before while{}
				// .
				//  E -> |.E -> |.  -> . -> .|a
				//  a      a      a    |a
				cursor_par = cursor_par_next;
				cursor_pos = 0;
				// cursor_par_prev remains unset
				cursor_par_next = cursor_par->next();
			} else {
				// I can't find a way to trigger this
				// so it should be unreachable code
				// unless the buffer is corrupted.
				lyxerr << "BufferView::removeAutoInsets() is bad\n";
			}
		}

		InsetList::iterator pit = par->insetlist.begin();
		InsetList::iterator pend = par->insetlist.end();

		while (pit != pend) {
			if (pit.getInset()->autoDelete()) {
				removed = true;
				pos_type const pos = pit.getPos();

				par->erase(pos);
				// We just invalidated par's inset iterators so
				// we get the next valid iterator position
				pit = par->insetlist.insetIterator(pos);
				// and ensure we have a valid end iterator.
				pend = par->insetlist.end();

				if (cursor_par == par) {
					// update the saved cursor position
					if (cursor_pos > pos)
						--cursor_pos;
				}
			} else {
				++pit;
			}
		}
		if (removed) {
			found = true;
			text->redoParagraph();
		}
	}

	// It is possible that the last line is empty if it was cursor_par
	// and/or only had an error inset on it.  So we set the cursor to the
	// start of the doc to force its removal and ensure a valid saved cursor
	if (text->setCursor(&*text->ownerParagraphs().begin(), 0)
	    && 0 == cursor_par_next) {
		cursor_par = cursor_par_prev;
		cursor_pos = cursor_par->size();
	} else if (cursor_pos > cursor_par->size()) {
		// Some C-Enter lines were removed by the setCursor call which
		// then invalidated cursor_pos. It could still be "wrong" because
		// the cursor may appear to have jumped but since we collapsed
		// some C-Enter lines this should be a reasonable compromise.
		cursor_pos = cursor_par->size();
	}

	// restore the original cursor in its corrected location.
	text->setCursorIntern(cursor_par, cursor_pos);

	return found;
}


void BufferView::insertErrors(TeXErrors & terr)
{
	// Save the cursor position
	LyXCursor cursor = text->cursor;

	TeXErrors::Errors::const_iterator cit = terr.begin();
	TeXErrors::Errors::const_iterator end = terr.end();
	for (; cit != end; ++cit) {
		string const desctext(cit->error_desc);
		string const errortext(cit->error_text);
		string const msgtxt = desctext + '\n' + errortext;
		int const errorrow = cit->error_in_line;

		// Insert error string for row number
		int tmpid = -1;
		int tmppos = -1;

		if (buffer()->texrow.getIdFromRow(errorrow, tmpid, tmppos)) {
			buffer()->texrow.increasePos(tmpid, tmppos);
		}

		Paragraph * texrowpar = 0;

		if (tmpid == -1) {
			texrowpar = &*text->ownerParagraphs().begin();
			tmppos = 0;
		} else {
			texrowpar = buffer()->getParFromID(tmpid);
		}

		if (texrowpar == 0)
			continue;

		freezeUndo();
		InsetError * new_inset = new InsetError(msgtxt);
		text->setCursorIntern(texrowpar, tmppos);
		text->insertInset(new_inset);
		text->fullRebreak();
		unFreezeUndo();
	}
	// Restore the cursor position
	text->setCursorIntern(cursor.par(), cursor.pos());
}


void BufferView::setCursorFromRow(int row)
{
	int tmpid = -1;
	int tmppos = -1;

	buffer()->texrow.getIdFromRow(row, tmpid, tmppos);

	Paragraph * texrowpar;

	if (tmpid == -1) {
		texrowpar = &*text->ownerParagraphs().begin();
		tmppos = 0;
	} else {
		texrowpar = buffer()->getParFromID(tmpid);
	}
	text->setCursor(texrowpar, tmppos);
}


bool BufferView::insertInset(Inset * inset, string const & lout)
{
	return pimpl_->insertInset(inset, lout);
}


void BufferView::gotoLabel(string const & label)
{
	for (Buffer::inset_iterator it = buffer()->inset_iterator_begin();
	     it != buffer()->inset_iterator_end(); ++it) {
		vector<string> labels = it->getLabelList();
		if (find(labels.begin(),labels.end(),label)
		     != labels.end()) {
			beforeChange(text);
			text->setCursor(it.getPar(), it.getPos());
			text->selection.cursor = text->cursor;
			update(text, BufferView::SELECT);
			return;
		}
	}
}


void BufferView::undo()
{
	if (!available())
		return;

	owner()->message(_("Undo"));
	hideCursor();
	beforeChange(text);
	update(text, BufferView::SELECT);
	if (!textUndo(this))
		owner()->message(_("No further undo information"));
	else
		update(text, BufferView::SELECT);
	switchKeyMap();
}


void BufferView::redo()
{
	if (!available())
		return;

	owner()->message(_("Redo"));
	hideCursor();
	beforeChange(text);
	update(text, BufferView::SELECT);
	if (!textRedo(this))
		owner()->message(_("No further redo information"));
	else
		update(text, BufferView::SELECT);
	switchKeyMap();
}


void BufferView::copyEnvironment()
{
	if (available()) {
		text->copyEnvironmentType();
		owner()->message(_("Paragraph environment type copied"));
	}
}


void BufferView::pasteEnvironment()
{
	if (available()) {
		text->pasteEnvironmentType();
		owner()->message(_("Paragraph environment type set"));
		update(text, BufferView::SELECT);
	}
}


// these functions are for the spellchecker
WordLangTuple const BufferView::nextWord(float & value)
{
	if (!available()) {
		value = 1;
		return WordLangTuple();
	}

	return text->selectNextWordToSpellcheck(value);
}


void BufferView::selectLastWord()
{
	if (!available())
		return;

	LyXCursor cur = text->selection.cursor;
	hideCursor();
	beforeChange(text);
	text->selection.cursor = cur;
	text->selectSelectedWord();
	toggleSelection(false);
	update(text, BufferView::SELECT);
}


void BufferView::endOfSpellCheck()
{
	if (!available()) return;

	hideCursor();
	beforeChange(text);
	text->selectSelectedWord();
	text->clearSelection();
	update(text, BufferView::SELECT);
}


void BufferView::replaceWord(string const & replacestring)
{
	if (!available())
		return;

	LyXText * tt = getLyXText();
	hideCursor();
	update(tt, BufferView::SELECT);

	// clear the selection (if there is any)
	toggleSelection(false);
	update(tt, BufferView::SELECT);

	// clear the selection (if there is any)
	toggleSelection(false);
	tt->replaceSelectionWithString(replacestring);

	tt->setSelectionRange(replacestring.length());

	// Go back so that replacement string is also spellchecked
	for (string::size_type i = 0; i < replacestring.length() + 1; ++i) {
		tt->cursorLeft(this);
	}
	update(tt, BufferView::SELECT);

	// FIXME: should be done through LFUN
	buffer()->markDirty();
	fitCursor();
}
// End of spellchecker stuff


bool BufferView::lockInset(UpdatableInset * inset)
{
	if (!inset)
		return false;
	// don't relock if we're already locked
	if (theLockingInset() == inset)
		return true;
	if (!theLockingInset()) {
		// first check if it's the inset under the cursor we want lock
		// should be most of the time
		if (text->cursor.pos() < text->cursor.par()->size()
		    && text->cursor.par()->getChar(text->cursor.pos()) ==
		    Paragraph::META_INSET) {
			Inset * in = text->cursor.par()->getInset(text->cursor.pos());
			if (inset == in) {
				theLockingInset(inset);
				return true;
			}
		}
		// Then do a deep look of the inset and lock the right one
		int const id = inset->id();
		ParagraphList::iterator pit = buffer()->paragraphs.begin();
		ParagraphList::iterator pend = buffer()->paragraphs.end();
		for (; pit != pend; ++pit) {
			InsetList::iterator it = pit->insetlist.begin();
			InsetList::iterator end = pit->insetlist.end();
			for (; it != end; ++it) {
				if (it.getInset() == inset) {
					text->setCursorIntern(&*pit, it.getPos());
					theLockingInset(inset);
					return true;
				}
				if (it.getInset()->getInsetFromID(id)) {
					text->setCursorIntern(&*pit, it.getPos());
					it.getInset()->edit(this);
					return theLockingInset()->lockInsetInInset(this, inset);
				}
			}
		}
		return false;
	}
	return theLockingInset()->lockInsetInInset(this, inset);
}


void BufferView::showLockedInsetCursor(int x, int y, int asc, int desc)
{
	if (available() && theLockingInset() && !theLockingInset()->nodraw()) {
		LyXCursor cursor = text->cursor;
		Inset * locking_inset = theLockingInset()->getLockingInset();

		if ((cursor.pos() - 1 >= 0) &&
		    cursor.par()->isInset(cursor.pos() - 1) &&
		    (cursor.par()->getInset(cursor.pos() - 1) ==
		     locking_inset))
			text->setCursor(cursor,
					cursor.par(), cursor.pos() - 1);
		LyXScreen::Cursor_Shape shape = LyXScreen::BAR_SHAPE;
		LyXText * txt = getLyXText();
		if (locking_inset->isTextInset() &&
		    locking_inset->lyxCode() != Inset::ERT_CODE &&
		    (txt->real_current_font.language() !=
		     buffer()->params.language
		     || txt->real_current_font.isVisibleRightToLeft()
		     != buffer()->params.language->RightToLeft()))
			shape = (txt->real_current_font.isVisibleRightToLeft())
				? LyXScreen::REVERSED_L_SHAPE
				: LyXScreen::L_SHAPE;
		y += cursor.iy() + theLockingInset()->insetInInsetY();
		screen().showManualCursor(text, x, y, asc, desc,
						  shape);
	}
}


void BufferView::hideLockedInsetCursor()
{
	if (theLockingInset() && available()) {
		screen().hideCursor();
	}
}


bool BufferView::fitLockedInsetCursor(int x, int y, int asc, int desc)
{
	if (theLockingInset() && available()) {
		y += text->cursor.iy() + theLockingInset()->insetInInsetY();
		if (screen().fitManualCursor(this, text, x, y, asc, desc)) {
			updateScrollbar();
			return true;
		}
	}
	return false;
}


int BufferView::unlockInset(UpdatableInset * inset)
{
	if (!inset)
		return 0;
	if (inset && theLockingInset() == inset) {
		inset->insetUnlock(this);
		theLockingInset(0);
		// make sure we update the combo !
		owner()->setLayout(getLyXText()->cursor.par()->layout()->name());
		// Tell the paragraph dialog that we changed paragraph
		dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
		finishUndo();
		return 0;
	} else if (inset && theLockingInset() &&
		   theLockingInset()->unlockInsetInInset(this, inset)) {
		// Tell the paragraph dialog that we changed paragraph
		dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
		// owner inset has updated the layout combo
		finishUndo();
		return 0;
	}
	return 1;
}


void BufferView::lockedInsetStoreUndo(Undo::undo_kind kind)
{
	if (!theLockingInset())
		return; // shouldn't happen
	if (kind == Undo::EDIT) // in this case insets would not be stored!
		kind = Undo::FINISH;
	setUndo(this, kind,
		&*text->cursor.par(),
		text->cursor.par()->next());
}


void BufferView::updateInset(Inset * inset)
{
	pimpl_->updateInset(inset);
}


bool BufferView::ChangeInsets(Inset::Code code,
			      string const & from, string const & to)
{
	bool need_update = false;
	LyXCursor cursor = text->cursor;
	LyXCursor tmpcursor = cursor;
	cursor.par(tmpcursor.par());
	cursor.pos(tmpcursor.pos());

	ParIterator end = buffer()->par_iterator_end();
	for (ParIterator it = buffer()->par_iterator_begin();
	     it != end; ++it) {
		Paragraph * par = *it;
		bool changed_inset = false;
		for (InsetList::iterator it2 = par->insetlist.begin();
		     it2 != par->insetlist.end(); ++it2) {
			if (it2.getInset()->lyxCode() == code) {
				InsetCommand * inset = static_cast<InsetCommand *>(it2.getInset());
				if (inset->getContents() == from) {
					inset->setContents(to);
					changed_inset = true;
				}
			}
		}
		if (changed_inset) {
			need_update = true;

			// FIXME

			// The test it.size()==1 was needed to prevent crashes.
			// How to set the cursor corretly when it.size()>1 ??
			if (it.size() == 1) {
				text->setCursorIntern(par, 0);
				text->redoParagraphs(text->cursor,
						     text->cursor.par()->next());
				text->fullRebreak();
			}
		}
	}
	text->setCursorIntern(cursor.par(), cursor.pos());
	return need_update;
}


bool BufferView::ChangeRefsIfUnique(string const & from, string const & to)
{
	// Check if the label 'from' appears more than once
	vector<string> labels = buffer()->getLabelList();

	if (lyx::count(labels.begin(), labels.end(), from) > 1)
		return false;

	return ChangeInsets(Inset::REF_CODE, from, to);
}


bool BufferView::ChangeCitationsIfUnique(string const & from, string const & to)
{
	typedef pair<string, string> StringPair;

	vector<StringPair> keys;
	buffer()->fillWithBibKeys(keys);
	if (count_if(keys.begin(), keys.end(),
		     lyx::equal_1st_in_pair<StringPair>(from))
	    > 1)
		return false;

	return ChangeInsets(Inset::CITE_CODE, from, to);
}


UpdatableInset * BufferView::theLockingInset() const
{
	// If NULL is not allowed we should put an Assert here. (Lgb)
	if (text)
		return text->the_locking_inset;
	return 0;
}


void BufferView::theLockingInset(UpdatableInset * inset)
{
	text->the_locking_inset = inset;
}


LyXText * BufferView::getLyXText() const
{
	if (theLockingInset()) {
		LyXText * txt = theLockingInset()->getLyXText(this, true);
		if (txt)
			return txt;
	}
	return text;
}


LyXText * BufferView::getParentText(Inset * inset) const
{
	if (inset->owner()) {
		LyXText * txt = inset->getLyXText(this);
		inset = inset->owner();
		while (inset && inset->getLyXText(this) == txt)
			inset = inset->owner();
		if (inset)
			return inset->getLyXText(this);
	}
	return text;
}


Language const * BufferView::getParentLanguage(Inset * inset) const
{
	LyXText * text = getParentText(inset);
	return text->cursor.par()->getFontSettings(buffer()->params,
						   text->cursor.pos()).language();
}


Encoding const * BufferView::getEncoding() const
{
	LyXText * t = getLyXText();
	if (!t)
		return 0;

	LyXCursor const & c= t->cursor;
	LyXFont const font = c.par()->getFont(buffer()->params, c.pos());
	return font.language()->encoding();
}


void BufferView::haveSelection(bool sel)
{
	pimpl_->workarea().haveSelection(sel);
}


int BufferView::workHeight() const
{
	return pimpl_->workarea().workHeight();
}