2 * \file CutAndPaste.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Alfredo Braunstein
11 * Full author contact details are available in file CREDITS.
16 #include "CutAndPaste.h"
18 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
27 #include "ErrorList.h"
29 #include "FuncRequest.h"
30 #include "InsetIterator.h"
31 #include "InsetList.h"
36 #include "Paragraph.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "TextClass.h"
41 #include "insets/InsetBibitem.h"
42 #include "insets/InsetBranch.h"
43 #include "insets/InsetCommand.h"
44 #include "insets/InsetFlex.h"
45 #include "insets/InsetGraphics.h"
46 #include "insets/InsetGraphicsParams.h"
47 #include "insets/InsetInclude.h"
48 #include "insets/InsetLabel.h"
49 #include "insets/InsetTabular.h"
51 #include "mathed/MathData.h"
52 #include "mathed/InsetMath.h"
53 #include "mathed/InsetMathHull.h"
54 #include "mathed/InsetMathRef.h"
55 #include "mathed/MathSupport.h"
57 #include "support/debug.h"
58 #include "support/docstream.h"
59 #include "support/gettext.h"
60 #include "support/lassert.h"
61 #include "support/limited_stack.h"
62 #include "support/lstrings.h"
64 #include "frontends/alert.h"
65 #include "frontends/Clipboard.h"
66 #include "frontends/Selection.h"
68 #include <boost/tuple/tuple.hpp>
69 #include <boost/next_prior.hpp>
74 using namespace lyx::support;
75 using lyx::frontend::Clipboard;
81 typedef pair<pit_type, int> PitPosPair;
83 typedef limited_stack<pair<ParagraphList, DocumentClassConstPtr> > CutStack;
86 // persistent selection, cleared until the next selection
87 CutStack selectionBuffer(1);
89 // store whether the tabular stack is newer than the normal copy stack
90 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
91 // when we (hopefully) have a one-for-all paste mechanism.
92 bool dirty_tabular_stack_ = false;
95 bool checkPastePossible(int index)
97 return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
101 struct PasteReturnValue {
102 PasteReturnValue(pit_type r_par, pos_type r_pos, bool r_nu) :
103 par(r_par), pos(r_pos), needupdate(r_nu)
112 pasteSelectionHelper(DocIterator const & cur, ParagraphList const & parlist,
113 DocumentClassConstPtr oldDocClass, ErrorList & errorlist)
115 Buffer const & buffer = *cur.buffer();
116 pit_type pit = cur.pit();
117 pos_type pos = cur.pos();
118 bool need_update = false;
119 InsetText * target_inset = cur.inset().asInsetText();
121 InsetTabular * it = cur.inset().asInsetTabular();
122 target_inset = it? it->cell(cur.idx())->asInsetText() : 0;
124 LASSERT(target_inset, return PasteReturnValue(pit, pos, need_update));
125 ParagraphList & pars = target_inset->paragraphs();
128 return PasteReturnValue(pit, pos, need_update);
130 BOOST_ASSERT (pos <= pars[pit].size());
132 // Make a copy of the CaP paragraphs.
133 ParagraphList insertion = parlist;
134 DocumentClassConstPtr newDocClass = buffer.params().documentClassPtr();
136 // Now remove all out of the pars which is NOT allowed in the
137 // new environment and set also another font if that is required.
139 // Convert newline to paragraph break in ParbreakIsNewline
140 if (target_inset->getLayout().parbreakIsNewline()
141 || pars[pit].layout().parbreak_is_newline) {
142 for (size_t i = 0; i != insertion.size(); ++i) {
143 for (pos_type j = 0; j != insertion[i].size(); ++j) {
144 if (insertion[i].isNewline(j)) {
145 // do not track deletion of newline
146 insertion[i].eraseChar(j, false);
147 insertion[i].setInsetOwner(target_inset);
148 breakParagraphConservative(
157 // set the paragraphs to plain layout if necessary
158 if (cur.inset().usePlainLayout()) {
159 bool forcePlainLayout = cur.inset().forcePlainLayout();
160 Layout const & plainLayout = newDocClass->plainLayout();
161 Layout const & defaultLayout = newDocClass->defaultLayout();
162 ParagraphList::iterator const end = insertion.end();
163 ParagraphList::iterator par = insertion.begin();
164 for (; par != end; ++par) {
165 Layout const & parLayout = par->layout();
166 if (forcePlainLayout || parLayout == defaultLayout)
167 par->setLayout(plainLayout);
169 } else { // check if we need to reset from plain layout
170 Layout const & defaultLayout = newDocClass->defaultLayout();
171 Layout const & plainLayout = newDocClass->plainLayout();
172 ParagraphList::iterator const end = insertion.end();
173 ParagraphList::iterator par = insertion.begin();
174 for (; par != end; ++par) {
175 Layout const & parLayout = par->layout();
176 if (parLayout == plainLayout)
177 par->setLayout(defaultLayout);
181 InsetText in(cur.buffer());
182 // Make sure there is no class difference.
183 in.paragraphs().clear();
184 // This works without copying any paragraph data because we have
185 // a specialized swap method for ParagraphList. This is important
186 // since we store pointers to insets at some places and we don't
187 // want to invalidate them.
188 insertion.swap(in.paragraphs());
189 cap::switchBetweenClasses(oldDocClass, newDocClass, in, errorlist);
190 insertion.swap(in.paragraphs());
192 ParagraphList::iterator tmpbuf = insertion.begin();
193 int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
195 depth_type max_depth = pars[pit].getMaxDepthAfter();
197 for (; tmpbuf != insertion.end(); ++tmpbuf) {
198 // If we have a negative jump so that the depth would
199 // go below 0 depth then we have to redo the delta to
200 // this new max depth level so that subsequent
201 // paragraphs are aligned correctly to this paragraph
203 if (int(tmpbuf->params().depth()) + depth_delta < 0)
206 // Set the right depth so that we are not too deep or shallow.
207 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
208 if (tmpbuf->params().depth() > max_depth)
209 tmpbuf->params().depth(max_depth);
211 // Only set this from the 2nd on as the 2nd depends
212 // for maxDepth still on pit.
213 if (tmpbuf != insertion.begin())
214 max_depth = tmpbuf->getMaxDepthAfter();
216 // Set the inset owner of this paragraph.
217 tmpbuf->setInsetOwner(target_inset);
218 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
219 // do not track deletion of invalid insets
220 if (Inset * inset = tmpbuf->getInset(i))
221 if (!target_inset->insetAllowed(inset->lyxCode()))
222 tmpbuf->eraseChar(i--, false);
225 tmpbuf->setChange(Change(buffer.params().trackChanges ?
226 Change::INSERTED : Change::UNCHANGED));
229 bool const empty = pars[pit].empty();
231 // Make the buf exactly the same layout as the cursor
233 insertion.begin()->makeSameLayout(pars[pit]);
236 // Prepare the paragraphs and insets for insertion.
237 insertion.swap(in.paragraphs());
239 InsetIterator const i_end = inset_iterator_end(in);
240 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
241 // Even though this will also be done later, it has to be done here
242 // since some inset might going to try to access
243 // the buffer() member.
244 it->setBuffer(const_cast<Buffer &>(buffer));
245 switch (it->lyxCode()) {
247 case MATH_HULL_CODE: {
248 // check for equation labels and resolve duplicates
249 InsetMathHull * ins = it->asInsetMath()->asHullInset();
250 std::vector<InsetLabel *> labels = ins->getLabels();
251 for (size_t i = 0; i != labels.size(); ++i) {
254 InsetLabel * lab = labels[i];
255 docstring const oldname = lab->getParam("name");
256 lab->updateLabel(oldname);
257 // We need to update the buffer reference cache.
259 docstring const newname = lab->getParam("name");
260 if (oldname == newname)
262 // adapt the references
263 for (InsetIterator itt = inset_iterator_begin(in);
264 itt != i_end; ++itt) {
265 if (itt->lyxCode() == REF_CODE) {
266 InsetCommand * ref = itt->asInsetCommand();
267 if (ref->getParam("reference") == oldname)
268 ref->setParam("reference", newname);
269 } else if (itt->lyxCode() == MATH_REF_CODE) {
270 InsetMathRef * mi = itt->asInsetMath()->asRefInset();
271 // this is necessary to prevent an uninitialized
272 // buffer when the RefInset is in a MathBox.
273 // FIXME audit setBuffer calls
274 mi->setBuffer(const_cast<Buffer &>(buffer));
275 if (mi->getTarget() == oldname)
276 mi->changeTarget(newname);
284 // check for duplicates
285 InsetLabel & lab = static_cast<InsetLabel &>(*it);
286 docstring const oldname = lab.getParam("name");
287 lab.updateLabel(oldname);
288 // We need to update the buffer reference cache.
290 docstring const newname = lab.getParam("name");
291 if (oldname == newname)
293 // adapt the references
294 for (InsetIterator itt = inset_iterator_begin(in); itt != i_end; ++itt) {
295 if (itt->lyxCode() == REF_CODE) {
296 InsetCommand & ref = static_cast<InsetCommand &>(*itt);
297 if (ref.getParam("reference") == oldname)
298 ref.setParam("reference", newname);
299 } else if (itt->lyxCode() == MATH_REF_CODE) {
300 InsetMathRef * mi = itt->asInsetMath()->asRefInset();
301 // this is necessary to prevent an uninitialized
302 // buffer when the RefInset is in a MathBox.
303 // FIXME audit setBuffer calls
304 mi->setBuffer(const_cast<Buffer &>(buffer));
305 if (mi->getTarget() == oldname)
306 mi->changeTarget(newname);
313 InsetInclude & inc = static_cast<InsetInclude &>(*it);
315 // We need to update the list of included files.
321 // check for duplicates
322 InsetBibitem & bib = static_cast<InsetBibitem &>(*it);
323 docstring const oldkey = bib.getParam("key");
324 bib.updateCommand(oldkey, false);
325 // We need to update the buffer reference cache.
327 docstring const newkey = bib.getParam("key");
328 if (oldkey == newkey)
330 // adapt the references
331 for (InsetIterator itt = inset_iterator_begin(in);
332 itt != i_end; ++itt) {
333 if (itt->lyxCode() == CITE_CODE) {
334 InsetCommand * ref = itt->asInsetCommand();
335 if (ref->getParam("key") == oldkey)
336 ref->setParam("key", newkey);
343 // check if branch is known to target buffer
345 InsetBranch & br = static_cast<InsetBranch &>(*it);
346 docstring const name = br.branch();
349 bool const is_child = (&buffer != buffer.masterBuffer());
350 BranchList branchlist = buffer.params().branchlist();
351 if ((!is_child && branchlist.find(name))
352 || (is_child && (branchlist.find(name)
353 || buffer.masterBuffer()->params().branchlist().find(name))))
355 // FIXME: add an option to add the branch to the master's BranchList.
356 docstring text = bformat(
357 _("The pasted branch \"%1$s\" is undefined.\n"
358 "Do you want to add it to the document's branch list?"),
360 if (frontend::Alert::prompt(_("Unknown branch"),
361 text, 0, 1, _("&Add"), _("&Don't Add")) != 0)
363 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, name));
364 // We need to update the list of branches.
373 insertion.swap(in.paragraphs());
375 // Split the paragraph for inserting the buf if necessary.
377 breakParagraphConservative(buffer.params(), pars, pit, pos);
381 pars.insert(boost::next(pars.begin(), pit),
385 // merge the empty par with the last par of the insertion
386 mergeParagraph(buffer.params(), pars,
387 pit + insertion.size() - 1);
389 pars.insert(boost::next(pars.begin(), pit + 1),
393 // merge the first par of the insertion with the current par
394 mergeParagraph(buffer.params(), pars, pit);
397 // Store the new cursor position.
398 pit_type last_paste = pit + insertion.size() - 1;
399 pit_type startpit = pit;
401 pos = pars[last_paste].size();
403 // FIXME Should we do it here, or should we let updateBuffer() do it?
404 // Set paragraph buffers. It's important to do this right away
405 // before something calls Inset::buffer() and causes a crash.
406 for (pit_type p = startpit; p <= pit; ++p)
407 pars[p].setBuffer(const_cast<Buffer &>(buffer));
409 // Join (conditionally) last pasted paragraph with next one, i.e.,
410 // the tail of the spliced document paragraph
411 if (!empty && last_paste + 1 != pit_type(pars.size())) {
412 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
413 mergeParagraph(buffer.params(), pars, last_paste);
414 } else if (pars[last_paste + 1].empty()) {
415 pars[last_paste + 1].makeSameLayout(pars[last_paste]);
416 mergeParagraph(buffer.params(), pars, last_paste);
417 } else if (pars[last_paste].empty()) {
418 pars[last_paste].makeSameLayout(pars[last_paste + 1]);
419 mergeParagraph(buffer.params(), pars, last_paste);
421 pars[last_paste + 1].stripLeadingSpaces(buffer.params().trackChanges);
426 return PasteReturnValue(pit, pos, need_update);
430 PitPosPair eraseSelectionHelper(BufferParams const & params,
431 ParagraphList & pars,
432 pit_type startpit, pit_type endpit,
433 int startpos, int endpos)
435 // Start of selection is really invalid.
436 if (startpit == pit_type(pars.size()) ||
437 (startpos > pars[startpit].size()))
438 return PitPosPair(endpit, endpos);
440 // Start and end is inside same paragraph
441 if (endpit == pit_type(pars.size()) || startpit == endpit) {
442 endpos -= pars[startpit].eraseChars(startpos, endpos, params.trackChanges);
443 return PitPosPair(endpit, endpos);
446 for (pit_type pit = startpit; pit != endpit + 1;) {
447 pos_type const left = (pit == startpit ? startpos : 0);
448 pos_type right = (pit == endpit ? endpos : pars[pit].size() + 1);
449 bool const merge = pars[pit].isMergedOnEndOfParDeletion(params.trackChanges);
451 // Logically erase only, including the end-of-paragraph character
452 pars[pit].eraseChars(left, right, params.trackChanges);
454 // Separate handling of paragraph break:
455 if (merge && pit != endpit &&
457 || pars[pit].hasSameLayout(pars[endpit])
458 || pars[endpit].size() == endpos)) {
459 if (pit + 1 == endpit)
460 endpos += pars[pit].size();
461 mergeParagraph(params, pars, pit);
467 // Ensure legal cursor pos:
470 return PitPosPair(endpit, endpos);
474 void putClipboard(ParagraphList const & paragraphs,
475 DocumentClassConstPtr docclass, docstring const & plaintext)
477 // This used to need to be static to avoid a memory leak. It no longer needs
478 // to be so, but the alternative is to construct a new one of these (with a
479 // new temporary directory, etc) every time, and then to destroy it. So maybe
480 // it's worth just keeping this one around.
481 static Buffer * staticbuffer = theBufferList().newInternalBuffer(
482 FileName::tempName("clipboard.internal").absFileName());
484 // These two things only really need doing the first time.
485 staticbuffer->setUnnamed(true);
486 staticbuffer->inset().setBuffer(*staticbuffer);
488 // Use a clone for the complicated stuff so that we do not need to clean
489 // up in order to avoid a crash.
490 Buffer * buffer = staticbuffer->cloneBufferOnly();
491 LASSERT(buffer, return);
493 // This needs doing every time.
494 buffer->params().setDocumentClass(docclass);
496 // we will use pasteSelectionHelper to copy the paragraphs into the
497 // temporary Buffer, since it does a lot of things to fix them up.
498 DocIterator dit = doc_iterator_begin(buffer, &buffer->inset());
500 pasteSelectionHelper(dit, paragraphs, docclass, el);
502 // We don't want to produce images that are not used. Therefore,
503 // output formulas as MathML. Even if this is not understood by all
504 // applications, the number that can parse it should go up in the future.
505 buffer->params().html_math_output = BufferParams::MathML;
507 // Make sure MarkAsExporting is deleted before buffer is
509 // The Buffer is being used to export. This is necessary so that the
510 // updateMacros call will record the needed information.
511 MarkAsExporting mex(buffer);
513 buffer->updateBuffer(Buffer::UpdateMaster, OutputUpdate);
514 buffer->updateMacros();
515 buffer->updateMacroInstances(OutputUpdate);
520 if (buffer->write(oslyx))
524 odocstringstream oshtml;
525 OutputParams runparams(encodings.fromLyXName("utf8"));
526 buffer->writeLyXHTMLSource(oshtml, runparams, Buffer::FullSource);
528 theClipboard().put(lyx, oshtml.str(), plaintext);
536 /// return true if the whole ParagraphList is deleted
537 static bool isFullyDeleted(ParagraphList const & pars)
539 pit_type const pars_size = static_cast<pit_type>(pars.size());
541 // check all paragraphs
542 for (pit_type pit = 0; pit < pars_size; ++pit) {
543 if (!pars[pit].empty()) // prevent assertion failure
544 if (!pars[pit].isDeleted(0, pars[pit].size()))
551 void copySelectionHelper(Buffer const & buf, Text const & text,
552 pit_type startpit, pit_type endpit,
553 int start, int end, DocumentClassConstPtr dc, CutStack & cutstack)
555 ParagraphList const & pars = text.paragraphs();
557 // In most of these cases, we can try to recover.
558 LASSERT(0 <= start, start = 0);
559 LASSERT(start <= pars[startpit].size(), start = pars[startpit].size());
560 LASSERT(0 <= end, end = 0);
561 LASSERT(end <= pars[endpit].size(), end = pars[endpit].size());
562 LASSERT(startpit != endpit || start <= end, return);
564 // Clone the paragraphs within the selection.
565 ParagraphList copy_pars(boost::next(pars.begin(), startpit),
566 boost::next(pars.begin(), endpit + 1));
568 // Remove the end of the last paragraph; afterwards, remove the
569 // beginning of the first paragraph. Keep this order - there may only
570 // be one paragraph! Do not track deletions here; this is an internal
571 // action not visible to the user
573 Paragraph & back = copy_pars.back();
574 back.eraseChars(end, back.size(), false);
575 Paragraph & front = copy_pars.front();
576 front.eraseChars(0, start, false);
578 ParagraphList::iterator it = copy_pars.begin();
579 ParagraphList::iterator it_end = copy_pars.end();
581 for (; it != it_end; ++it) {
582 // Since we have a copy of the paragraphs, the insets
583 // do not have a proper buffer reference. It makes
584 // sense to add them temporarily, because the
585 // operations below depend on that (acceptChanges included).
586 it->setBuffer(const_cast<Buffer &>(buf));
587 // PassThru paragraphs have the Language
588 // latex_language. This is invalid for others, so we
589 // need to change it to the buffer language.
590 if (it->isPassThru())
591 it->changeLanguage(buf.params(),
592 latex_language, buf.language());
595 // do not copy text (also nested in insets) which is marked as
596 // deleted, unless the whole selection was deleted
597 if (!isFullyDeleted(copy_pars))
598 acceptChanges(copy_pars, buf.params());
600 rejectChanges(copy_pars, buf.params());
603 // do some final cleanup now, to make sure that the paragraphs
604 // are not linked to something else.
605 it = copy_pars.begin();
606 for (; it != it_end; ++it) {
607 it->setBuffer(*static_cast<Buffer *>(0));
608 it->setInsetOwner(0);
611 cutstack.push(make_pair(copy_pars, dc));
621 void region(CursorSlice const & i1, CursorSlice const & i2,
622 Inset::row_type & r1, Inset::row_type & r2,
623 Inset::col_type & c1, Inset::col_type & c2)
625 Inset & p = i1.inset();
626 c1 = p.col(i1.idx());
627 c2 = p.col(i2.idx());
630 r1 = p.row(i1.idx());
631 r2 = p.row(i2.idx());
637 docstring grabAndEraseSelection(Cursor & cur)
639 if (!cur.selection())
641 docstring res = grabSelection(cur);
647 bool reduceSelectionToOneCell(Cursor & cur)
649 if (!cur.selection() || !cur.inMathed())
652 CursorSlice i1 = cur.selBegin();
653 CursorSlice i2 = cur.selEnd();
654 if (!i1.inset().asInsetMath())
657 // the easy case: do nothing if only one cell is selected
658 if (i1.idx() == i2.idx())
663 cur.top().pos() = cur.top().lastpos();
669 bool multipleCellsSelected(Cursor const & cur)
671 if (!cur.selection() || !cur.inMathed())
674 CursorSlice i1 = cur.selBegin();
675 CursorSlice i2 = cur.selEnd();
676 if (!i1.inset().asInsetMath())
679 if (i1.idx() == i2.idx())
686 void switchBetweenClasses(DocumentClassConstPtr oldone,
687 DocumentClassConstPtr newone, InsetText & in, ErrorList & errorlist)
691 LBUFERR(!in.paragraphs().empty());
692 if (oldone == newone)
695 DocumentClass const & oldtc = *oldone;
696 DocumentClass const & newtc = *newone;
699 ParIterator it = par_iterator_begin(in);
700 ParIterator end = par_iterator_end(in);
701 // for remembering which layouts we've had to add
702 set<docstring> newlayouts;
703 for (; it != end; ++it) {
704 docstring const name = it->layout().name();
706 // the pasted text will keep their own layout name. If this layout does
707 // not exist in the new document, it will behave like a standard layout.
708 bool const added_one = newtc.addLayoutIfNeeded(name);
710 newlayouts.insert(name);
712 if (added_one || newlayouts.find(name) != newlayouts.end()) {
714 docstring const s = bformat(_("Layout `%1$s' was not found."), name);
716 ErrorItem(_("Layout Not Found"), s, it->id(), 0, it->size()));
719 if (in.usePlainLayout())
720 it->setLayout(newtc.plainLayout());
722 it->setLayout(newtc[name]);
726 InsetIterator const i_end = inset_iterator_end(in);
727 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
728 if (it->lyxCode() != FLEX_CODE)
729 // FIXME: Should we verify all InsetCollapsable?
732 docstring const layoutName = it->layoutName();
733 docstring const & n = newone->insetLayout(layoutName).name();
734 bool const is_undefined = n.empty() ||
735 n == DocumentClass::plainInsetLayout().name();
739 // The flex inset is undefined in newtc
740 docstring const oldname = from_utf8(oldtc.name());
741 docstring const newname = from_utf8(newtc.name());
743 if (oldname == newname)
744 s = bformat(_("Flex inset %1$s is undefined after "
745 "reloading `%2$s' layout."), layoutName, oldname);
747 s = bformat(_("Flex inset %1$s is undefined because of "
748 "conversion from `%2$s' layout to `%3$s'."),
749 layoutName, oldname, newname);
750 // To warn the user that something had to be done.
751 errorlist.push_back(ErrorItem(
752 _("Undefined flex inset"),
753 s, it.paragraph().id(), it.pos(), it.pos() + 1));
758 vector<docstring> availableSelections(Buffer const * buf)
760 vector<docstring> selList;
764 CutStack::const_iterator cit = theCuts.begin();
765 CutStack::const_iterator end = theCuts.end();
766 for (; cit != end; ++cit) {
767 // we do not use cit-> here because gcc 2.9x does not
769 ParagraphList const & pars = (*cit).first;
771 ParagraphList::const_iterator pit = pars.begin();
772 ParagraphList::const_iterator pend = pars.end();
773 for (; pit != pend; ++pit) {
774 Paragraph par(*pit, 0, 26);
775 // adapt paragraph to current buffer.
776 par.setBuffer(const_cast<Buffer &>(*buf));
777 asciiSel += par.asString(AS_STR_INSETS);
778 if (asciiSel.size() > 25) {
779 asciiSel.replace(22, docstring::npos,
785 selList.push_back(asciiSel);
792 size_type numberOfSelections()
794 return theCuts.size();
798 void cutSelection(Cursor & cur, bool doclear, bool realcut)
800 // This doesn't make sense, if there is no selection
801 if (!cur.selection())
804 // OK, we have a selection. This is always between cur.selBegin()
807 if (cur.inTexted()) {
808 Text * text = cur.text();
813 // make sure that the depth behind the selection are restored, too
814 cur.recordUndoSelection();
815 pit_type begpit = cur.selBegin().pit();
816 pit_type endpit = cur.selEnd().pit();
818 int endpos = cur.selEnd().pos();
820 BufferParams const & bp = cur.buffer()->params();
822 copySelectionHelper(*cur.buffer(),
825 cur.selBegin().pos(), endpos,
826 bp.documentClassPtr(), theCuts);
827 // Stuff what we got on the clipboard.
828 // Even if there is no selection.
829 putClipboard(theCuts[0].first, theCuts[0].second,
830 cur.selectionAsString(true));
833 if (begpit != endpit)
834 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
836 boost::tie(endpit, endpos) =
837 eraseSelectionHelper(bp,
840 cur.selBegin().pos(), endpos);
842 // cutSelection can invalidate the cursor so we need to set
844 // we prefer the end for when tracking changes
848 // sometimes necessary
850 && text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges))
853 // need a valid cursor. (Lgb)
854 cur.clearSelection();
856 // After a cut operation, we must make sure that the Buffer is updated
857 // because some further operation might need updated label information for
858 // example. So we cannot just use "cur.forceBufferUpdate()" here.
860 cur.buffer()->updateBuffer();
862 // tell tabular that a recent copy happened
863 dirtyTabularStack(false);
866 if (cur.inMathed()) {
867 if (cur.selBegin().idx() != cur.selEnd().idx()) {
868 // The current selection spans more than one cell.
870 cur.recordUndoInset();
872 // Record only the current cell to avoid a jumping
883 void copySelection(Cursor const & cur)
885 copySelection(cur, cur.selectionAsString(true));
889 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext)
893 BufferParams const & bp = cur.buffer()->params();
894 par.setLayout(bp.documentClass().plainLayout());
895 par.insertInset(0, inset, Change(Change::UNCHANGED));
897 theCuts.push(make_pair(pars, bp.documentClassPtr()));
899 // stuff the selection onto the X clipboard, from an explicit copy request
900 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
906 void copySelectionToStack(Cursor const & cur, CutStack & cutstack)
908 // this doesn't make sense, if there is no selection
909 if (!cur.selection())
912 // copySelection can not yet handle the case of cross idx selection
913 if (cur.selBegin().idx() != cur.selEnd().idx())
916 if (cur.inTexted()) {
917 Text * text = cur.text();
919 // ok we have a selection. This is always between cur.selBegin()
920 // and sel_end cursor
922 // copy behind a space if there is one
923 ParagraphList & pars = text->paragraphs();
924 pos_type pos = cur.selBegin().pos();
925 pit_type par = cur.selBegin().pit();
926 while (pos < pars[par].size() &&
927 pars[par].isLineSeparator(pos) &&
928 (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
931 copySelectionHelper(*cur.buffer(), *text, par, cur.selEnd().pit(),
932 pos, cur.selEnd().pos(),
933 cur.buffer()->params().documentClassPtr(), cutstack);
935 // Reset the dirty_tabular_stack_ flag only when something
936 // is copied to the clipboard (not to the selectionBuffer).
937 if (&cutstack == &theCuts)
938 dirtyTabularStack(false);
941 if (cur.inMathed()) {
942 //lyxerr << "copySelection in mathed" << endl;
945 BufferParams const & bp = cur.buffer()->params();
946 // FIXME This should be the plain layout...right?
947 par.setLayout(bp.documentClass().plainLayout());
948 par.insert(0, grabSelection(cur), Font(), Change(Change::UNCHANGED));
950 cutstack.push(make_pair(pars, bp.documentClassPtr()));
957 void copySelectionToStack()
959 if (!selectionBuffer.empty())
960 theCuts.push(selectionBuffer[0]);
964 void copySelection(Cursor const & cur, docstring const & plaintext)
966 // In tablemode, because copy and paste actually use special table stack
967 // we do not attempt to get selected paragraphs under cursor. Instead, a
968 // paragraph with the plain text version is generated so that table cells
969 // can be pasted as pure text somewhere else.
970 if (cur.selBegin().idx() != cur.selEnd().idx()) {
973 BufferParams const & bp = cur.buffer()->params();
974 par.setLayout(bp.documentClass().plainLayout());
975 par.insert(0, plaintext, Font(), Change(Change::UNCHANGED));
977 theCuts.push(make_pair(pars, bp.documentClassPtr()));
979 copySelectionToStack(cur, theCuts);
982 // stuff the selection onto the X clipboard, from an explicit copy request
983 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
987 void saveSelection(Cursor const & cur)
989 // This function is called, not when a selection is formed, but when
990 // a selection is cleared. Therefore, multiple keyboard selection
991 // will not repeatively trigger this function (bug 3877).
993 && cur.selBegin() == cur.bv().cursor().selBegin()
994 && cur.selEnd() == cur.bv().cursor().selEnd()) {
995 LYXERR(Debug::SELECTION, "saveSelection: '" << cur.selectionAsString(true) << "'");
996 copySelectionToStack(cur, selectionBuffer);
1003 return !selectionBuffer.empty();
1007 void clearSelection()
1009 selectionBuffer.clear();
1013 void clearCutStack()
1019 docstring selection(size_t sel_index)
1021 return sel_index < theCuts.size()
1022 ? theCuts[sel_index].first.back().asString(AS_STR_INSETS | AS_STR_NEWLINES)
1027 void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
1028 DocumentClassConstPtr docclass, ErrorList & errorList)
1030 if (cur.inTexted()) {
1031 Text * text = cur.text();
1034 PasteReturnValue prv =
1035 pasteSelectionHelper(cur, parlist, docclass, errorList);
1037 cur.forceBufferUpdate();
1038 cur.clearSelection();
1039 text->setCursor(cur, prv.par, prv.pos);
1042 // mathed is handled in InsetMathNest/InsetMathGrid
1043 LATTEST(!cur.inMathed());
1047 void pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index)
1049 // this does not make sense, if there is nothing to paste
1050 if (!checkPastePossible(sel_index))
1054 pasteParagraphList(cur, theCuts[sel_index].first,
1055 theCuts[sel_index].second, errorList);
1059 void pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs,
1060 Clipboard::TextType type)
1062 // Use internal clipboard if it is the most recent one
1063 // This overrides asParagraphs and type on purpose!
1064 if (theClipboard().isInternal()) {
1065 pasteFromStack(cur, errorList, 0);
1069 // First try LyX format
1070 if ((type == Clipboard::LyXTextType ||
1071 type == Clipboard::LyXOrPlainTextType ||
1072 type == Clipboard::AnyTextType) &&
1073 theClipboard().hasTextContents(Clipboard::LyXTextType)) {
1074 string lyx = theClipboard().getAsLyX();
1076 // For some strange reason gcc 3.2 and 3.3 do not accept
1077 // Buffer buffer(string(), false);
1078 Buffer buffer("", false);
1079 buffer.setUnnamed(true);
1080 if (buffer.readString(lyx)) {
1082 pasteParagraphList(cur, buffer.paragraphs(),
1083 buffer.params().documentClassPtr(), errorList);
1089 // Then try TeX and HTML
1090 Clipboard::TextType types[2] = {Clipboard::HtmlTextType, Clipboard::LaTeXTextType};
1091 string names[2] = {"html", "latex"};
1092 for (int i = 0; i < 2; ++i) {
1093 if (type != types[i] && type != Clipboard::AnyTextType)
1095 bool available = theClipboard().hasTextContents(types[i]);
1097 // If a specific type was explicitly requested, try to
1098 // interpret plain text: The user told us that the clipboard
1099 // contents is in the desired format
1100 if (!available && type == types[i]) {
1101 types[i] = Clipboard::PlainTextType;
1102 available = theClipboard().hasTextContents(types[i]);
1106 docstring text = theClipboard().getAsText(types[i]);
1107 available = !text.empty();
1109 // For some strange reason gcc 3.2 and 3.3 do not accept
1110 // Buffer buffer(string(), false);
1111 Buffer buffer("", false);
1112 buffer.setUnnamed(true);
1113 if (buffer.importString(names[i], text, errorList)) {
1115 pasteParagraphList(cur, buffer.paragraphs(),
1116 buffer.params().documentClassPtr(), errorList);
1123 // Then try plain text
1124 docstring const text = theClipboard().getAsText(Clipboard::PlainTextType);
1129 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1131 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1135 void pasteSimpleText(Cursor & cur, bool asParagraphs)
1138 // Use internal clipboard if it is the most recent one
1139 if (theClipboard().isInternal()) {
1140 if (!checkPastePossible(0))
1143 ParagraphList const & pars = theCuts[0].first;
1144 ParagraphList::const_iterator it = pars.begin();
1145 for (; it != pars.end(); ++it) {
1146 if (it != pars.begin())
1148 text += (*it).asString();
1150 asParagraphs = false;
1152 // Then try plain text
1153 text = theClipboard().getAsText(Clipboard::PlainTextType);
1160 cutSelection(cur, true, false);
1162 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1164 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1168 void pasteClipboardGraphics(Cursor & cur, ErrorList & /* errorList */,
1169 Clipboard::GraphicsType preferedType)
1171 LASSERT(theClipboard().hasGraphicsContents(preferedType), return);
1173 // get picture from clipboard
1174 FileName filename = theClipboard().getAsGraphics(cur, preferedType);
1175 if (filename.empty())
1178 // create inset for graphic
1179 InsetGraphics * inset = new InsetGraphics(cur.buffer());
1180 InsetGraphicsParams params;
1181 params.filename = support::DocFileName(filename.absFileName(), false);
1182 inset->setParams(params);
1188 void pasteSelection(Cursor & cur, ErrorList & errorList)
1190 if (selectionBuffer.empty())
1193 pasteParagraphList(cur, selectionBuffer[0].first,
1194 selectionBuffer[0].second, errorList);
1198 void replaceSelectionWithString(Cursor & cur, docstring const & str)
1201 DocIterator selbeg = cur.selectionBegin();
1203 // Get font setting before we cut, we need a copy here, not a bare reference.
1205 selbeg.paragraph().getFontSettings(cur.buffer()->params(), selbeg.pos());
1207 // Insert the new string
1208 pos_type pos = cur.selEnd().pos();
1209 Paragraph & par = cur.selEnd().paragraph();
1210 docstring::const_iterator cit = str.begin();
1211 docstring::const_iterator end = str.end();
1212 for (; cit != end; ++cit, ++pos)
1213 par.insertChar(pos, *cit, font, cur.buffer()->params().trackChanges);
1215 // Cut the selection
1216 cutSelection(cur, true, false);
1220 void replaceSelection(Cursor & cur)
1222 if (cur.selection())
1223 cutSelection(cur, true, false);
1227 void eraseSelection(Cursor & cur)
1229 //lyxerr << "cap::eraseSelection begin: " << cur << endl;
1230 CursorSlice const & i1 = cur.selBegin();
1231 CursorSlice const & i2 = cur.selEnd();
1232 if (i1.inset().asInsetMath()) {
1235 if (i1.idx() == i2.idx()) {
1236 i1.cell().erase(i1.pos(), i2.pos());
1237 // We may have deleted i1.cell(cur.pos()).
1238 // Make sure that pos is valid.
1239 if (cur.pos() > cur.lastpos())
1240 cur.pos() = cur.lastpos();
1242 InsetMath * p = i1.asInsetMath();
1243 Inset::row_type r1, r2;
1244 Inset::col_type c1, c2;
1245 region(i1, i2, r1, r2, c1, c2);
1246 for (Inset::row_type row = r1; row <= r2; ++row)
1247 for (Inset::col_type col = c1; col <= c2; ++col)
1248 p->cell(p->index(row, col)).clear();
1249 // We've deleted the whole cell. Only pos 0 is valid.
1252 // need a valid cursor. (Lgb)
1253 cur.clearSelection();
1255 lyxerr << "can't erase this selection 1" << endl;
1257 //lyxerr << "cap::eraseSelection end: " << cur << endl;
1261 void selDel(Cursor & cur)
1263 //lyxerr << "cap::selDel" << endl;
1264 if (cur.selection())
1265 eraseSelection(cur);
1269 void selClearOrDel(Cursor & cur)
1271 //lyxerr << "cap::selClearOrDel" << endl;
1272 if (lyxrc.auto_region_delete)
1275 cur.setSelection(false);
1279 docstring grabSelection(Cursor const & cur)
1281 if (!cur.selection())
1285 // grab selection by glueing multiple cells together. This is not what
1286 // we want because selections spanning multiple cells will get "&" and "\\"
1289 for (DocIterator dit = cur.selectionBegin();
1290 dit != cur.selectionEnd(); dit.forwardPos())
1291 os << asString(dit.cell());
1295 CursorSlice i1 = cur.selBegin();
1296 CursorSlice i2 = cur.selEnd();
1298 if (i1.idx() == i2.idx()) {
1299 if (i1.inset().asInsetMath()) {
1300 MathData::const_iterator it = i1.cell().begin();
1301 Buffer * buf = cur.buffer();
1302 return asString(MathData(buf, it + i1.pos(), it + i2.pos()));
1304 return from_ascii("unknown selection 1");
1308 Inset::row_type r1, r2;
1309 Inset::col_type c1, c2;
1310 region(i1, i2, r1, r2, c1, c2);
1313 if (i1.inset().asInsetMath()) {
1314 for (Inset::row_type row = r1; row <= r2; ++row) {
1317 for (Inset::col_type col = c1; col <= c2; ++col) {
1320 data += asString(i1.asInsetMath()->
1321 cell(i1.asInsetMath()->index(row, col)));
1325 data = from_ascii("unknown selection 2");
1331 void dirtyTabularStack(bool b)
1333 dirty_tabular_stack_ = b;
1337 bool tabularStackDirty()
1339 return dirty_tabular_stack_;