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 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 // The Buffer is being used to export. This is necessary so that the
508 // updateMacros call will record the needed information.
509 MarkAsExporting mex(buffer);
511 buffer->updateBuffer(Buffer::UpdateMaster, OutputUpdate);
512 buffer->updateMacros();
513 buffer->updateMacroInstances(OutputUpdate);
518 if (buffer->write(oslyx))
522 odocstringstream oshtml;
523 OutputParams runparams(encodings.fromLyXName("utf8"));
524 buffer->writeLyXHTMLSource(oshtml, runparams, Buffer::FullSource);
526 theClipboard().put(lyx, oshtml.str(), plaintext);
533 /// return true if the whole ParagraphList is deleted
534 static bool isFullyDeleted(ParagraphList const & pars)
536 pit_type const pars_size = static_cast<pit_type>(pars.size());
538 // check all paragraphs
539 for (pit_type pit = 0; pit < pars_size; ++pit) {
540 if (!pars[pit].empty()) // prevent assertion failure
541 if (!pars[pit].isDeleted(0, pars[pit].size()))
548 void copySelectionHelper(Buffer const & buf, Text const & text,
549 pit_type startpit, pit_type endpit,
550 int start, int end, DocumentClassConstPtr dc, CutStack & cutstack)
552 ParagraphList const & pars = text.paragraphs();
554 LASSERT(0 <= start && start <= pars[startpit].size(), /**/);
555 LASSERT(0 <= end && end <= pars[endpit].size(), /**/);
556 LASSERT(startpit != endpit || start <= end, /**/);
558 // Clone the paragraphs within the selection.
559 ParagraphList copy_pars(boost::next(pars.begin(), startpit),
560 boost::next(pars.begin(), endpit + 1));
562 // Remove the end of the last paragraph; afterwards, remove the
563 // beginning of the first paragraph. Keep this order - there may only
564 // be one paragraph! Do not track deletions here; this is an internal
565 // action not visible to the user
567 Paragraph & back = copy_pars.back();
568 back.eraseChars(end, back.size(), false);
569 Paragraph & front = copy_pars.front();
570 front.eraseChars(0, start, false);
572 ParagraphList::iterator it = copy_pars.begin();
573 ParagraphList::iterator it_end = copy_pars.end();
575 for (; it != it_end; ++it) {
576 // Since we have a copy of the paragraphs, the insets
577 // do not have a proper buffer reference. It makes
578 // sense to add them temporarily, because the
579 // operations below depend on that (acceptChanges included).
580 it->setBuffer(const_cast<Buffer &>(buf));
581 // PassThru paragraphs have the Language
582 // latex_language. This is invalid for others, so we
583 // need to change it to the buffer language.
584 if (it->isPassThru())
585 it->changeLanguage(buf.params(),
586 latex_language, buf.language());
589 // do not copy text (also nested in insets) which is marked as
590 // deleted, unless the whole selection was deleted
591 if (!isFullyDeleted(copy_pars))
592 acceptChanges(copy_pars, buf.params());
594 rejectChanges(copy_pars, buf.params());
597 // do some final cleanup now, to make sure that the paragraphs
598 // are not linked to something else.
599 it = copy_pars.begin();
600 for (; it != it_end; ++it) {
601 it->setBuffer(*static_cast<Buffer *>(0));
602 it->setInsetOwner(0);
605 cutstack.push(make_pair(copy_pars, dc));
615 void region(CursorSlice const & i1, CursorSlice const & i2,
616 Inset::row_type & r1, Inset::row_type & r2,
617 Inset::col_type & c1, Inset::col_type & c2)
619 Inset & p = i1.inset();
620 c1 = p.col(i1.idx());
621 c2 = p.col(i2.idx());
624 r1 = p.row(i1.idx());
625 r2 = p.row(i2.idx());
631 docstring grabAndEraseSelection(Cursor & cur)
633 if (!cur.selection())
635 docstring res = grabSelection(cur);
641 bool reduceSelectionToOneCell(Cursor & cur)
643 if (!cur.selection() || !cur.inMathed())
646 CursorSlice i1 = cur.selBegin();
647 CursorSlice i2 = cur.selEnd();
648 if (!i1.inset().asInsetMath())
651 // the easy case: do nothing if only one cell is selected
652 if (i1.idx() == i2.idx())
657 cur.top().pos() = cur.top().lastpos();
663 bool multipleCellsSelected(Cursor const & cur)
665 if (!cur.selection() || !cur.inMathed())
668 CursorSlice i1 = cur.selBegin();
669 CursorSlice i2 = cur.selEnd();
670 if (!i1.inset().asInsetMath())
673 if (i1.idx() == i2.idx())
680 void switchBetweenClasses(DocumentClassConstPtr oldone,
681 DocumentClassConstPtr newone, InsetText & in, ErrorList & errorlist)
685 LASSERT(!in.paragraphs().empty(), /**/);
686 if (oldone == newone)
689 DocumentClass const & oldtc = *oldone;
690 DocumentClass const & newtc = *newone;
693 ParIterator it = par_iterator_begin(in);
694 ParIterator end = par_iterator_end(in);
695 // for remembering which layouts we've had to add
696 set<docstring> newlayouts;
697 for (; it != end; ++it) {
698 docstring const name = it->layout().name();
700 // the pasted text will keep their own layout name. If this layout does
701 // not exist in the new document, it will behave like a standard layout.
702 bool const added_one = newtc.addLayoutIfNeeded(name);
704 newlayouts.insert(name);
706 if (added_one || newlayouts.find(name) != newlayouts.end()) {
708 docstring const s = bformat(_("Layout `%1$s' was not found."), name);
710 ErrorItem(_("Layout Not Found"), s, it->id(), 0, it->size()));
713 if (in.usePlainLayout())
714 it->setLayout(newtc.plainLayout());
716 it->setLayout(newtc[name]);
720 InsetIterator const i_end = inset_iterator_end(in);
721 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
722 if (it->lyxCode() != FLEX_CODE)
723 // FIXME: Should we verify all InsetCollapsable?
726 docstring const layoutName = it->layoutName();
727 docstring const & n = newone->insetLayout(layoutName).name();
728 bool const is_undefined = n.empty() ||
729 n == DocumentClass::plainInsetLayout().name();
733 // The flex inset is undefined in newtc
734 docstring const oldname = from_utf8(oldtc.name());
735 docstring const newname = from_utf8(newtc.name());
737 if (oldname == newname)
738 s = bformat(_("Flex inset %1$s is undefined after "
739 "reloading `%2$s' layout."), layoutName, oldname);
741 s = bformat(_("Flex inset %1$s is undefined because of "
742 "conversion from `%2$s' layout to `%3$s'."),
743 layoutName, oldname, newname);
744 // To warn the user that something had to be done.
745 errorlist.push_back(ErrorItem(
746 _("Undefined flex inset"),
747 s, it.paragraph().id(), it.pos(), it.pos() + 1));
752 vector<docstring> availableSelections(Buffer const * buf)
754 vector<docstring> selList;
758 CutStack::const_iterator cit = theCuts.begin();
759 CutStack::const_iterator end = theCuts.end();
760 for (; cit != end; ++cit) {
761 // we do not use cit-> here because gcc 2.9x does not
763 ParagraphList const & pars = (*cit).first;
765 ParagraphList::const_iterator pit = pars.begin();
766 ParagraphList::const_iterator pend = pars.end();
767 for (; pit != pend; ++pit) {
768 Paragraph par(*pit, 0, 26);
769 // adapt paragraph to current buffer.
770 par.setBuffer(const_cast<Buffer &>(*buf));
771 asciiSel += par.asString(AS_STR_INSETS);
772 if (asciiSel.size() > 25) {
773 asciiSel.replace(22, docstring::npos,
779 selList.push_back(asciiSel);
786 size_type numberOfSelections()
788 return theCuts.size();
792 void cutSelection(Cursor & cur, bool doclear, bool realcut)
794 // This doesn't make sense, if there is no selection
795 if (!cur.selection())
798 // OK, we have a selection. This is always between cur.selBegin()
801 if (cur.inTexted()) {
802 Text * text = cur.text();
807 // make sure that the depth behind the selection are restored, too
808 cur.recordUndoSelection();
809 pit_type begpit = cur.selBegin().pit();
810 pit_type endpit = cur.selEnd().pit();
812 int endpos = cur.selEnd().pos();
814 BufferParams const & bp = cur.buffer()->params();
816 copySelectionHelper(*cur.buffer(),
819 cur.selBegin().pos(), endpos,
820 bp.documentClassPtr(), theCuts);
821 // Stuff what we got on the clipboard.
822 // Even if there is no selection.
823 putClipboard(theCuts[0].first, theCuts[0].second,
824 cur.selectionAsString(true));
827 if (begpit != endpit)
828 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
830 boost::tie(endpit, endpos) =
831 eraseSelectionHelper(bp,
834 cur.selBegin().pos(), endpos);
836 // cutSelection can invalidate the cursor so we need to set
838 // we prefer the end for when tracking changes
842 // sometimes necessary
844 && text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges))
847 // need a valid cursor. (Lgb)
848 cur.clearSelection();
850 // After a cut operation, we must make sure that the Buffer is updated
851 // because some further operation might need updated label information for
852 // example. So we cannot just use "cur.forceBufferUpdate()" here.
854 cur.buffer()->updateBuffer();
856 // tell tabular that a recent copy happened
857 dirtyTabularStack(false);
860 if (cur.inMathed()) {
861 if (cur.selBegin().idx() != cur.selEnd().idx()) {
862 // The current selection spans more than one cell.
864 cur.recordUndoInset();
866 // Record only the current cell to avoid a jumping
877 void copySelection(Cursor const & cur)
879 copySelection(cur, cur.selectionAsString(true));
883 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext)
887 BufferParams const & bp = cur.buffer()->params();
888 par.setLayout(bp.documentClass().plainLayout());
889 par.insertInset(0, inset, Change(Change::UNCHANGED));
891 theCuts.push(make_pair(pars, bp.documentClassPtr()));
893 // stuff the selection onto the X clipboard, from an explicit copy request
894 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
900 void copySelectionToStack(Cursor const & cur, CutStack & cutstack)
902 // this doesn't make sense, if there is no selection
903 if (!cur.selection())
906 // copySelection can not yet handle the case of cross idx selection
907 if (cur.selBegin().idx() != cur.selEnd().idx())
910 if (cur.inTexted()) {
911 Text * text = cur.text();
913 // ok we have a selection. This is always between cur.selBegin()
914 // and sel_end cursor
916 // copy behind a space if there is one
917 ParagraphList & pars = text->paragraphs();
918 pos_type pos = cur.selBegin().pos();
919 pit_type par = cur.selBegin().pit();
920 while (pos < pars[par].size() &&
921 pars[par].isLineSeparator(pos) &&
922 (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
925 copySelectionHelper(*cur.buffer(), *text, par, cur.selEnd().pit(),
926 pos, cur.selEnd().pos(),
927 cur.buffer()->params().documentClassPtr(), cutstack);
929 // Reset the dirty_tabular_stack_ flag only when something
930 // is copied to the clipboard (not to the selectionBuffer).
931 if (&cutstack == &theCuts)
932 dirtyTabularStack(false);
935 if (cur.inMathed()) {
936 //lyxerr << "copySelection in mathed" << endl;
939 BufferParams const & bp = cur.buffer()->params();
940 // FIXME This should be the plain layout...right?
941 par.setLayout(bp.documentClass().plainLayout());
942 par.insert(0, grabSelection(cur), Font(), Change(Change::UNCHANGED));
944 cutstack.push(make_pair(pars, bp.documentClassPtr()));
951 void copySelectionToStack()
953 if (!selectionBuffer.empty())
954 theCuts.push(selectionBuffer[0]);
958 void copySelection(Cursor const & cur, docstring const & plaintext)
960 // In tablemode, because copy and paste actually use special table stack
961 // we do not attempt to get selected paragraphs under cursor. Instead, a
962 // paragraph with the plain text version is generated so that table cells
963 // can be pasted as pure text somewhere else.
964 if (cur.selBegin().idx() != cur.selEnd().idx()) {
967 BufferParams const & bp = cur.buffer()->params();
968 par.setLayout(bp.documentClass().plainLayout());
969 par.insert(0, plaintext, Font(), Change(Change::UNCHANGED));
971 theCuts.push(make_pair(pars, bp.documentClassPtr()));
973 copySelectionToStack(cur, theCuts);
976 // stuff the selection onto the X clipboard, from an explicit copy request
977 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
981 void saveSelection(Cursor const & cur)
983 // This function is called, not when a selection is formed, but when
984 // a selection is cleared. Therefore, multiple keyboard selection
985 // will not repeatively trigger this function (bug 3877).
987 && cur.selBegin() == cur.bv().cursor().selBegin()
988 && cur.selEnd() == cur.bv().cursor().selEnd()) {
989 LYXERR(Debug::SELECTION, "saveSelection: '" << cur.selectionAsString(true) << "'");
990 copySelectionToStack(cur, selectionBuffer);
997 return !selectionBuffer.empty();
1001 void clearSelection()
1003 selectionBuffer.clear();
1007 void clearCutStack()
1013 docstring selection(size_t sel_index)
1015 return sel_index < theCuts.size()
1016 ? theCuts[sel_index].first.back().asString(AS_STR_INSETS | AS_STR_NEWLINES)
1021 void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
1022 DocumentClassConstPtr docclass, ErrorList & errorList)
1024 if (cur.inTexted()) {
1025 Text * text = cur.text();
1026 LASSERT(text, /**/);
1028 PasteReturnValue prv =
1029 pasteSelectionHelper(cur, parlist, docclass, errorList);
1031 cur.forceBufferUpdate();
1032 cur.clearSelection();
1033 text->setCursor(cur, prv.par, prv.pos);
1036 // mathed is handled in InsetMathNest/InsetMathGrid
1037 LASSERT(!cur.inMathed(), /**/);
1041 void pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index)
1043 // this does not make sense, if there is nothing to paste
1044 if (!checkPastePossible(sel_index))
1048 pasteParagraphList(cur, theCuts[sel_index].first,
1049 theCuts[sel_index].second, errorList);
1053 void pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs,
1054 Clipboard::TextType type)
1056 // Use internal clipboard if it is the most recent one
1057 // This overrides asParagraphs and type on purpose!
1058 if (theClipboard().isInternal()) {
1059 pasteFromStack(cur, errorList, 0);
1063 // First try LyX format
1064 if ((type == Clipboard::LyXTextType ||
1065 type == Clipboard::LyXOrPlainTextType ||
1066 type == Clipboard::AnyTextType) &&
1067 theClipboard().hasTextContents(Clipboard::LyXTextType)) {
1068 string lyx = theClipboard().getAsLyX();
1070 // For some strange reason gcc 3.2 and 3.3 do not accept
1071 // Buffer buffer(string(), false);
1072 Buffer buffer("", false);
1073 buffer.setUnnamed(true);
1074 if (buffer.readString(lyx)) {
1076 pasteParagraphList(cur, buffer.paragraphs(),
1077 buffer.params().documentClassPtr(), errorList);
1083 // Then try TeX and HTML
1084 Clipboard::TextType types[2] = {Clipboard::HtmlTextType, Clipboard::LaTeXTextType};
1085 string names[2] = {"html", "latex"};
1086 for (int i = 0; i < 2; ++i) {
1087 if (type != types[i] && type != Clipboard::AnyTextType)
1089 bool available = theClipboard().hasTextContents(types[i]);
1091 // If a specific type was explicitly requested, try to
1092 // interpret plain text: The user told us that the clipboard
1093 // contents is in the desired format
1094 if (!available && type == types[i]) {
1095 types[i] = Clipboard::PlainTextType;
1096 available = theClipboard().hasTextContents(types[i]);
1100 docstring text = theClipboard().getAsText(types[i]);
1101 available = !text.empty();
1103 // For some strange reason gcc 3.2 and 3.3 do not accept
1104 // Buffer buffer(string(), false);
1105 Buffer buffer("", false);
1106 buffer.setUnnamed(true);
1107 if (buffer.importString(names[i], text, errorList)) {
1109 pasteParagraphList(cur, buffer.paragraphs(),
1110 buffer.params().documentClassPtr(), errorList);
1117 // Then try plain text
1118 docstring const text = theClipboard().getAsText(Clipboard::PlainTextType);
1123 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1125 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1129 void pasteSimpleText(Cursor & cur, bool asParagraphs)
1132 // Use internal clipboard if it is the most recent one
1133 if (theClipboard().isInternal()) {
1134 if (!checkPastePossible(0))
1137 ParagraphList const & pars = theCuts[0].first;
1138 ParagraphList::const_iterator it = pars.begin();
1139 for (; it != pars.end(); ++it) {
1140 if (it != pars.begin())
1142 text += (*it).asString();
1144 asParagraphs = false;
1146 // Then try plain text
1147 text = theClipboard().getAsText(Clipboard::PlainTextType);
1154 cutSelection(cur, true, false);
1156 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1158 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1162 void pasteClipboardGraphics(Cursor & cur, ErrorList & /* errorList */,
1163 Clipboard::GraphicsType preferedType)
1165 LASSERT(theClipboard().hasGraphicsContents(preferedType), /**/);
1167 // get picture from clipboard
1168 FileName filename = theClipboard().getAsGraphics(cur, preferedType);
1169 if (filename.empty())
1172 // create inset for graphic
1173 InsetGraphics * inset = new InsetGraphics(cur.buffer());
1174 InsetGraphicsParams params;
1175 params.filename = support::DocFileName(filename.absFileName(), false);
1176 inset->setParams(params);
1182 void pasteSelection(Cursor & cur, ErrorList & errorList)
1184 if (selectionBuffer.empty())
1187 pasteParagraphList(cur, selectionBuffer[0].first,
1188 selectionBuffer[0].second, errorList);
1192 void replaceSelectionWithString(Cursor & cur, docstring const & str)
1195 DocIterator selbeg = cur.selectionBegin();
1197 // Get font setting before we cut, we need a copy here, not a bare reference.
1199 selbeg.paragraph().getFontSettings(cur.buffer()->params(), selbeg.pos());
1201 // Insert the new string
1202 pos_type pos = cur.selEnd().pos();
1203 Paragraph & par = cur.selEnd().paragraph();
1204 docstring::const_iterator cit = str.begin();
1205 docstring::const_iterator end = str.end();
1206 for (; cit != end; ++cit, ++pos)
1207 par.insertChar(pos, *cit, font, cur.buffer()->params().trackChanges);
1209 // Cut the selection
1210 cutSelection(cur, true, false);
1214 void replaceSelection(Cursor & cur)
1216 if (cur.selection())
1217 cutSelection(cur, true, false);
1221 void eraseSelection(Cursor & cur)
1223 //lyxerr << "cap::eraseSelection begin: " << cur << endl;
1224 CursorSlice const & i1 = cur.selBegin();
1225 CursorSlice const & i2 = cur.selEnd();
1226 if (i1.inset().asInsetMath()) {
1229 if (i1.idx() == i2.idx()) {
1230 i1.cell().erase(i1.pos(), i2.pos());
1231 // We may have deleted i1.cell(cur.pos()).
1232 // Make sure that pos is valid.
1233 if (cur.pos() > cur.lastpos())
1234 cur.pos() = cur.lastpos();
1236 InsetMath * p = i1.asInsetMath();
1237 Inset::row_type r1, r2;
1238 Inset::col_type c1, c2;
1239 region(i1, i2, r1, r2, c1, c2);
1240 for (Inset::row_type row = r1; row <= r2; ++row)
1241 for (Inset::col_type col = c1; col <= c2; ++col)
1242 p->cell(p->index(row, col)).clear();
1243 // We've deleted the whole cell. Only pos 0 is valid.
1246 // need a valid cursor. (Lgb)
1247 cur.clearSelection();
1249 lyxerr << "can't erase this selection 1" << endl;
1251 //lyxerr << "cap::eraseSelection end: " << cur << endl;
1255 void selDel(Cursor & cur)
1257 //lyxerr << "cap::selDel" << endl;
1258 if (cur.selection())
1259 eraseSelection(cur);
1263 void selClearOrDel(Cursor & cur)
1265 //lyxerr << "cap::selClearOrDel" << endl;
1266 if (lyxrc.auto_region_delete)
1269 cur.setSelection(false);
1273 docstring grabSelection(Cursor const & cur)
1275 if (!cur.selection())
1279 // grab selection by glueing multiple cells together. This is not what
1280 // we want because selections spanning multiple cells will get "&" and "\\"
1283 for (DocIterator dit = cur.selectionBegin();
1284 dit != cur.selectionEnd(); dit.forwardPos())
1285 os << asString(dit.cell());
1289 CursorSlice i1 = cur.selBegin();
1290 CursorSlice i2 = cur.selEnd();
1292 if (i1.idx() == i2.idx()) {
1293 if (i1.inset().asInsetMath()) {
1294 MathData::const_iterator it = i1.cell().begin();
1295 Buffer * buf = cur.buffer();
1296 return asString(MathData(buf, it + i1.pos(), it + i2.pos()));
1298 return from_ascii("unknown selection 1");
1302 Inset::row_type r1, r2;
1303 Inset::col_type c1, c2;
1304 region(i1, i2, r1, r2, c1, c2);
1307 if (i1.inset().asInsetMath()) {
1308 for (Inset::row_type row = r1; row <= r2; ++row) {
1311 for (Inset::col_type col = c1; col <= c2; ++col) {
1314 data += asString(i1.asInsetMath()->
1315 cell(i1.asInsetMath()->index(row, col)));
1319 data = from_ascii("unknown selection 2");
1325 void dirtyTabularStack(bool b)
1327 dirty_tabular_stack_ = b;
1331 bool tabularStackDirty()
1333 return dirty_tabular_stack_;