lyx_mirror/src/CutAndPaste.C

/* This file is part of
 * ======================================================
 * 
 *           LyX, The Document Processor
 * 	 
 *           Copyright 1995-2001 The LyX Team.
 *
 * ====================================================== */

#include <config.h>

#ifdef __GNUG__
#pragma implementation
#endif

#include "CutAndPaste.h"
//#include "debug.h"
#include "BufferView.h"
#include "buffer.h"
#include "paragraph.h"
#include "ParagraphParameters.h"
#include "lyxcursor.h"
#include "gettext.h"
#include "iterators.h"
#include "lyxtextclasslist.h"

#include "insets/inseterror.h"

using std::pair;
using lyx::pos_type;
using lyx::textclass_type;

extern BufferView * current_view;

// J<>rgen, note that this means that you cannot currently have a list
// of selections cut/copied. So IMHO later we should have a
// list/vector/deque that we could store
// struct selection_item {
//       Paragraph * buf;
//       LyXTextClassList::size_type textclass;
// };
// in and some method of choosing beween them (based on the first few chars
// in the selection probably.) This would be a nice feature and quite
// easy to implement. (Lgb)
//
// Sure but I just cleaned up this code for now with the same functionality
// as before. I also want to add a XClipboard function so that we can copy
// text from LyX to some other X-application in the form of ASCII or in the
// form of LaTeX (or Docbook depending on the document-class!). Think how nice
// it could be to select a math-inset do a "Copy to X-Clipboard as LaTeX" and
// then do a middle mouse button click in the application you want and have
// the whole formula there in LaTeX-Code. (Jug)

namespace {

Paragraph * buf = 0;
textclass_type textclass = 0;

// for now here this should be in another Cut&Paste Class!
// J<>rgen, I moved this out of CutAndPaste since it does not operate on any
// member of the CutAndPaste class and in addition it was private.
// Perhaps it even should take a parameter? (Lgb)
void DeleteBuffer()
{
	if (!buf)
		return;
	
	Paragraph * tmppar;
	
	while (buf) {
		tmppar =  buf;
		buf = buf->next();
		delete tmppar;
	}
	buf = 0;
}

} // namespace anon


bool CutAndPaste::cutSelection(Paragraph * startpar, Paragraph ** endpar,
                               int start, int & end, char tc, bool doclear,
							   bool realcut)
{
	if (!startpar || (start > startpar->size()))
		return false;
	
	if (realcut)
		DeleteBuffer();
	
	textclass = tc;
	
	if (!(*endpar) || startpar == (*endpar)) {
		// only within one paragraph
		if (realcut)
			buf = new Paragraph;
		pos_type i = start;
		if (end > startpar->size())
			end = startpar->size();
		for (; i < end; ++i) {
			if (realcut)
				startpar->copyIntoMinibuffer(*current_view->buffer(),
				                             start);
			startpar->erase(start);
			if (realcut)
				buf->insertFromMinibuffer(buf->size());
		}
		end = start - 1;
	} else {
		// more than one paragraph
		(*endpar)->breakParagraphConservative(current_view->buffer()->params,
		                                      end);
		*endpar = (*endpar)->next();
		end = 0;
		
		startpar->breakParagraphConservative(current_view->buffer()->params,
		                                     start);
		
		// store the selection
		if (realcut) {
			buf = startpar->next();
			buf->previous(0);
		} else {
			startpar->next()->previous(0);
		}
		(*endpar)->previous()->next(0);
		
		// cut the selection
		startpar->next(*endpar);
		
		(*endpar)->previous(startpar);
		
		// the cut selection should begin with standard layout
		if (realcut) {
			buf->params().clear();
			buf->bibkey = 0;
			buf->layout(textclasslist[current_view->buffer()->params.textclass].defaultLayoutName());
		}

		// paste the paragraphs again, if possible
		if (doclear)
			startpar->next()->stripLeadingSpaces(textclass);
		if (startpar->hasSameLayout(startpar->next()) ||
		    !startpar->next()->size()) {
			startpar->pasteParagraph(current_view->buffer()->params);
			(*endpar) = startpar; // this because endpar gets deleted here!
		}
		// this paragraph's are of noone's owner!
		Paragraph * p = buf;
		while (p) {
			p->setInsetOwner(0);
			p = p->next();
		}
	}
	return true;
}


bool CutAndPaste::copySelection(Paragraph * startpar, Paragraph * endpar,
				int start, int end, char tc)
{
	if (!startpar || (start > startpar->size()))
		return false;
	
	DeleteBuffer();
	
	textclass = tc;
	
	if (!endpar || startpar == endpar) {
		// only within one paragraph
		buf = new Paragraph;
		pos_type i = start;
		if (end > startpar->size())
			end = startpar->size();
		for (; i < end; ++i) {
			startpar->copyIntoMinibuffer(*current_view->buffer(), i);
			buf->insertFromMinibuffer(buf->size());
		}
	} else {
		// copy more than one paragraph
		// clone the paragraphs within the selection
		Paragraph * tmppar = startpar;
		buf = new Paragraph(*tmppar, false);
		Paragraph * tmppar2 = buf;
		
		while (tmppar != endpar
		       && tmppar->next()) {
			tmppar = tmppar->next();
			tmppar2->next(new Paragraph(*tmppar, false));
			tmppar2->next()->previous(tmppar2);
			tmppar2 = tmppar2->next();
		}
		tmppar2->next(0);
		
		// the buf paragraph is too big
		pos_type tmpi2 = start;
		for (; tmpi2; --tmpi2)
			buf->erase(0);
		
		// now tmppar 2 is too big, delete all after end
		tmpi2 = end;
		while (tmppar2->size() > tmpi2) {
			tmppar2->erase(tmppar2->size() - 1);
		}
		// this paragraph's are of noone's owner!
		tmppar = buf;
		while (tmppar) {
			tmppar->setInsetOwner(0);
			tmppar = tmppar->next();
		}
	}
	return true;
}


bool CutAndPaste::pasteSelection(Paragraph ** par, Paragraph ** endpar,
                                 int & pos, char tc)
{
	if (!checkPastePossible(*par))
		return false;
	
	if (pos > (*par)->size())
		pos = (*par)->size();
	
#if 0
	// Paragraph * tmpbuf;
	Paragraph * tmppar = *par;
	int tmppos = pos;

	// There are two cases: cutbuffer only one paragraph or many
	if (!buf->next()) {
		// only within a paragraph
		Paragraph * tmpbuf = new Paragraph(*buf, false);
		
		// Some provisions should be done here for checking
		// if we are inserting at the beginning of a
		// paragraph. If there are a space at the beginning
		// of the text to insert and we are inserting at
		// the beginning of the paragraph the space should
		// be removed.
		while (buf->size()) {
			// This is an attempt to fix the
			// "never insert a space at the
			// beginning of a paragraph" problem.
			if (!tmppos && buf->isLineSeparator(0)) {
				buf->erase(0);
			} else {
				buf->cutIntoMinibuffer(current_view->buffer()->params, 0);
				buf->erase(0);
				if (tmppar->insertFromMinibuffer(tmppos))
					++tmppos;
			}
		}
		delete buf;
		buf = tmpbuf;
		*endpar = tmppar->next();
		pos = tmppos;
	} else
#endif
	{
		// many paragraphs
		
		// make a copy of the simple cut_buffer
		Paragraph * tmpbuf = buf;
		Paragraph * simple_cut_clone = new Paragraph(*tmpbuf, false);
		Paragraph * tmpbuf2 = simple_cut_clone;
		
		while (tmpbuf->next()) {
			tmpbuf = tmpbuf->next();
			tmpbuf2->next(new Paragraph(*tmpbuf, false));
			tmpbuf2->next()->previous(tmpbuf2);
			tmpbuf2 = tmpbuf2->next();
		}

		// now remove all out of the buffer which is NOT allowed in the
		// new environment and set also another font if that is required
		tmpbuf = buf;
		int depth_delta = (*par)->params().depth() - tmpbuf->params().depth();
		// temporary set *par as previous of tmpbuf as we might have to realize
		// the font.
		tmpbuf->previous(*par);
		Paragraph::depth_type max_depth = (*par)->getMaxDepthAfter(current_view->buffer());
		while(tmpbuf) {
			// if we have a negative jump so that the depth would go below
			// 0 depth then we have to redo the delta to this new max depth
			// level so that subsequent paragraphs are aligned correctly to
			// this paragraph at level 0.
			if ((static_cast<int>(tmpbuf->params().depth()) + depth_delta) < 0)
				depth_delta = 0;
			// set the right depth so that we are not too deep or shallow.
			tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
			if (tmpbuf->params().depth() > max_depth)
				tmpbuf->params().depth(max_depth);
			// only set this from the 2nd on as the 2nd depends for maxDepth
			// still on *par
			if (tmpbuf->previous() != (*par))
				max_depth = tmpbuf->getMaxDepthAfter(current_view->buffer());
			// set the inset owner of this paragraph
			tmpbuf->setInsetOwner((*par)->inInset());
			for(pos_type i = 0; i < tmpbuf->size(); ++i) {
				if (tmpbuf->getChar(i) == Paragraph::META_INSET) {
					if (!(*par)->insetAllowed(tmpbuf->getInset(i)->lyxCode()))
					{
						tmpbuf->erase(i--);
					}
				} else {
					LyXFont f1 = tmpbuf->getFont(current_view->buffer()->params,i);
					LyXFont f2 = f1;
					if (!(*par)->checkInsertChar(f1)) {
						tmpbuf->erase(i--);
					} else if (f1 != f2) {
						tmpbuf->setFont(i, f1);
					}
				}
			}
			tmpbuf = tmpbuf->next();
		}
		// now reset it to 0
		buf->previous(0);
		
		// make sure there is no class difference
		SwitchLayoutsBetweenClasses(textclass, tc, buf,
		                            current_view->buffer()->params);
		
		// make the buf exactly the same layout than
		// the cursor paragraph
		buf->makeSameLayout(*par);
		
		// find the end of the buffer
		Paragraph * lastbuffer = buf;
		while (lastbuffer->next())
			lastbuffer = lastbuffer->next();
		
		bool paste_the_end = false;
		
		// open the paragraph for inserting the buf
		// if necessary
		if (((*par)->size() > pos) || !(*par)->next()) {
			(*par)->breakParagraphConservative(current_view->buffer()->params,
			                                   pos);
			paste_the_end = true;
		}
		// set the end for redoing later
		*endpar = (*par)->next()->next();
		
		// paste it!
		lastbuffer->next((*par)->next());
		(*par)->next()->previous(lastbuffer);
		
		(*par)->next(buf);
		buf->previous(*par);
		
		if ((*par)->next() == lastbuffer)
			lastbuffer = *par;
		
		(*par)->pasteParagraph(current_view->buffer()->params);
		// store the new cursor position
		*par = lastbuffer;
		pos = lastbuffer->size();
		// maybe some pasting
		if (lastbuffer->next() && paste_the_end) {
			if (lastbuffer->next()->hasSameLayout(lastbuffer)) {
				lastbuffer->pasteParagraph(current_view->buffer()->params);
			} else if (!lastbuffer->next()->size()) {
				lastbuffer->next()->makeSameLayout(lastbuffer);
				lastbuffer->pasteParagraph(current_view->buffer()->params);
			} else if (!lastbuffer->size()) {
				lastbuffer->makeSameLayout(lastbuffer->next());
				lastbuffer->pasteParagraph(current_view->buffer()->params);
			} else
				lastbuffer->next()->stripLeadingSpaces(tc);
		}
		// restore the simple cut buffer
		buf = simple_cut_clone;
	}
	
	return true;
}


int CutAndPaste::nrOfParagraphs()
{
	if (!buf)
		return 0;
	
	int n = 1;
	Paragraph * tmppar = buf;
	while (tmppar->next()) {
		++n;
		tmppar = tmppar->next();
	}
	return n;
}


int CutAndPaste::SwitchLayoutsBetweenClasses(textclass_type c1,
					     textclass_type c2,
					     Paragraph * par,
					     BufferParams const & bparams)
{
	int ret = 0;
	if (!par || c1 == c2)
		return ret;

	ParIterator end = ParIterator();
	for (ParIterator it = ParIterator(par); it != end; ++it) {
		par = *it;
		string const name = par->layout();
		LyXTextClass const & tclass = textclasslist[c2];
		
		bool hasLayout = tclass.hasLayout(name);
		
		string lay = tclass.defaultLayoutName();
		if (hasLayout) {
			lay = name;
		} else {
			// not found: use default layout
			lay = tclass.defaultLayoutName();
		}
		par->layout(lay);
		
		if (name != par->layout()) {
			++ret;
			string const s = _("Layout had to be changed from\n")
				+ name + _(" to ")
				+ par->layout()
				+ _("\nbecause of class conversion from\n")
				+ textclasslist[c1].name() + _(" to ")
				+ textclasslist[c2].name();
			InsetError * new_inset = new InsetError(s);
			par->insertInset(0, new_inset,
					 LyXFont(LyXFont::ALL_INHERIT,
						 bparams.language));
		}
	}
	return ret;
}


bool CutAndPaste::checkPastePossible(Paragraph *)
{
	if (!buf) return false;
	
	return true;
}