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/InsetCitation.h"
44 #include "insets/InsetCommand.h"
45 #include "insets/InsetFlex.h"
46 #include "insets/InsetGraphics.h"
47 #include "insets/InsetGraphicsParams.h"
48 #include "insets/InsetInclude.h"
49 #include "insets/InsetLabel.h"
50 #include "insets/InsetTabular.h"
52 #include "mathed/MathData.h"
53 #include "mathed/InsetMath.h"
54 #include "mathed/InsetMathHull.h"
55 #include "mathed/InsetMathRef.h"
56 #include "mathed/MathSupport.h"
58 #include "support/debug.h"
59 #include "support/docstream.h"
60 #include "support/gettext.h"
61 #include "support/lassert.h"
62 #include "support/limited_stack.h"
63 #include "support/lstrings.h"
64 #include "support/lyxalgo.h"
65 #include "support/TempFile.h"
66 #include "support/unique_ptr.h"
68 #include "frontends/alert.h"
69 #include "frontends/Clipboard.h"
70 #include "frontends/Selection.h"
76 using namespace lyx::support;
77 using lyx::frontend::Clipboard;
83 typedef pair<pit_type, int> PitPosPair;
85 typedef limited_stack<pair<ParagraphList, DocumentClassConstPtr> > CutStack;
88 // persistent selection, cleared until the next selection
89 CutStack selectionBuffer(1);
90 // temporary scratch area
93 // store whether the tabular stack is newer than the normal copy stack
94 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
95 // when we (hopefully) have a one-for-all paste mechanism.
96 bool dirty_tabular_stack_ = false;
99 bool checkPastePossible(int index)
101 return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
105 struct PasteReturnValue {
106 PasteReturnValue(pit_type r_pit, pos_type r_pos, bool r_nu) :
107 pit(r_pit), pos(r_pos), needupdate(r_nu)
116 pasteSelectionHelper(DocIterator const & cur, ParagraphList const & parlist,
117 DocumentClassConstPtr oldDocClass, cap::BranchAction branchAction,
118 ErrorList & errorlist)
120 Buffer const & buffer = *cur.buffer();
121 pit_type pit = cur.pit();
122 pos_type pos = cur.pos();
123 bool need_update = false;
126 return PasteReturnValue(pit, pos, need_update);
128 // Check whether we paste into an inset that does not
129 // produce output (needed for label duplicate check)
130 bool in_active_inset = cur.paragraph().inInset().producesOutput();
131 if (in_active_inset) {
132 for (size_type sl = 0 ; sl < cur.depth() ; ++sl) {
133 Paragraph const & outer_par = cur[sl].paragraph();
134 if (!outer_par.inInset().producesOutput()) {
135 in_active_inset = false;
141 InsetText * target_inset = cur.inset().asInsetText();
143 InsetTabular * it = cur.inset().asInsetTabular();
144 target_inset = it ? it->cell(cur.idx())->asInsetText() : nullptr;
146 LASSERT(target_inset, return PasteReturnValue(pit, pos, need_update));
148 ParagraphList & pars = target_inset->paragraphs();
149 LASSERT(pos <= pars[pit].size(),
150 return PasteReturnValue(pit, pos, need_update));
152 // Make a copy of the CaP paragraphs.
153 ParagraphList insertion = parlist;
155 // Now remove all out of the pars which is NOT allowed in the
156 // new environment and set also another font if that is required.
158 // Merge paragraphs that are to be pasted into a text inset
159 // that does not allow multiple pars.
160 InsetText * inset_text = target_inset->asInsetText();
161 if (inset_text && !inset_text->allowMultiPar()) {
162 while (insertion.size() > 1)
163 mergeParagraph(buffer.params(), insertion, 0);
166 // Convert newline to paragraph break in ParbreakIsNewline
167 if (target_inset->getLayout().parbreakIsNewline()
168 || pars[pit].layout().parbreak_is_newline) {
169 for (size_t i = 0; i != insertion.size(); ++i) {
170 for (pos_type j = 0; j != insertion[i].size(); ++j) {
171 if (insertion[i].isNewline(j)) {
172 // do not track deletion of newline
173 insertion[i].eraseChar(j, false);
174 insertion[i].setInsetOwner(target_inset);
175 breakParagraphConservative(
184 // Prevent to paste uncodable characters in verbatim and ERT.
185 // The encoding is inherited from the context here.
186 docstring uncodable_content;
187 if (target_inset->getLayout().isPassThru() && cur.getEncoding()) {
188 odocstringstream res;
189 Encoding const * e = cur.getEncoding();
190 for (size_t i = 0; i != insertion.size(); ++i) {
191 pos_type end = insertion[i].size();
192 for (pos_type j = 0; j != end; ++j) {
194 if (insertion[i].isInset(j))
196 char_type const c = insertion[i].getChar(j);
197 if (!e->encodable(c)) {
198 // do not track deletion
200 insertion[i].eraseChar(j, false);
206 docstring const uncodable = res.str();
207 if (!uncodable.empty()) {
208 if (uncodable.size() == 1)
209 uncodable_content = bformat(_("The character \"%1$s\" is uncodable in this verbatim context "
210 "and thus has not been pasted."),
213 uncodable_content = bformat(_("The characters \"%1$s\" are uncodable in this verbatim context "
214 "and thus have not been pasted."),
219 // set the paragraphs to plain layout if necessary
220 DocumentClassConstPtr newDocClass = buffer.params().documentClassPtr();
221 if (cur.inset().usePlainLayout()) {
222 bool forcePlainLayout = target_inset->forcePlainLayout();
223 Layout const & plainLayout = newDocClass->plainLayout();
224 Layout const & defaultLayout = newDocClass->defaultLayout();
225 for (auto & par : insertion) {
226 Layout const & parLayout = par.layout();
227 if (forcePlainLayout || parLayout == defaultLayout)
228 par.setLayout(plainLayout);
231 // check if we need to reset from plain layout
232 Layout const & defaultLayout = newDocClass->defaultLayout();
233 Layout const & plainLayout = newDocClass->plainLayout();
234 for (auto & par : insertion) {
235 Layout const & parLayout = par.layout();
236 if (parLayout == plainLayout)
237 par.setLayout(defaultLayout);
241 InsetText in(cur.buffer());
242 // Make sure there is no class difference.
243 in.paragraphs().clear();
244 // This works without copying any paragraph data because we have
245 // a specialized swap method for ParagraphList. This is important
246 // since we store pointers to insets at some places and we don't
247 // want to invalidate them.
248 insertion.swap(in.paragraphs());
249 cap::switchBetweenClasses(oldDocClass, newDocClass, in, errorlist);
250 // Do this here since switchBetweenClasses clears the errorlist
251 if (!uncodable_content.empty())
252 errorlist.push_back(ErrorItem(_("Uncodable content"), uncodable_content));
253 insertion.swap(in.paragraphs());
255 ParagraphList::iterator tmpbuf = insertion.begin();
256 int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
258 depth_type max_depth = pars[pit].getMaxDepthAfter();
260 for (; tmpbuf != insertion.end(); ++tmpbuf) {
261 // If we have a negative jump so that the depth would
262 // go below 0 depth then we have to redo the delta to
263 // this new max depth level so that subsequent
264 // paragraphs are aligned correctly to this paragraph
266 if (int(tmpbuf->params().depth()) + depth_delta < 0)
269 // Set the right depth so that we are not too deep or shallow.
270 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
271 if (tmpbuf->params().depth() > max_depth)
272 tmpbuf->params().depth(max_depth);
274 // Set max_depth for the next paragraph
275 max_depth = tmpbuf->getMaxDepthAfter();
277 // Set the inset owner of this paragraph.
278 tmpbuf->setInsetOwner(target_inset);
279 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
280 // do not track deletion of invalid insets
281 if (Inset * inset = tmpbuf->getInset(i))
282 if (!target_inset->insetAllowed(inset->lyxCode()))
283 tmpbuf->eraseChar(i--, false);
286 if (lyxrc.ct_markup_copied)
287 tmpbuf->setChange(Change(buffer.params().track_changes ?
288 Change::INSERTED : Change::UNCHANGED));
291 bool const empty = pars[pit].empty();
293 // Make the buf exactly the same layout as the cursor
295 insertion.begin()->makeSameLayout(pars[pit]);
298 // Prepare the paragraphs and insets for insertion.
299 insertion.swap(in.paragraphs());
301 InsetIterator const i_end = inset_iterator_end(in);
302 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
303 // Even though this will also be done later, it has to be done here
304 // since some inset might try to access the buffer() member.
305 it->setBuffer(const_cast<Buffer &>(buffer));
306 switch (it->lyxCode()) {
308 case MATH_HULL_CODE: {
309 // check for equation labels and resolve duplicates
310 InsetMathHull * ins = it->asInsetMath()->asHullInset();
311 std::vector<InsetLabel *> labels = ins->getLabels();
312 for (size_t i = 0; i != labels.size(); ++i) {
315 InsetLabel * lab = labels[i];
316 docstring const oldname = lab->getParam("name");
317 lab->updateLabel(oldname, in_active_inset);
318 // We need to update the buffer reference cache.
320 docstring const newname = lab->getParam("name");
321 if (oldname == newname)
323 // adapt the references
324 for (InsetIterator itt = inset_iterator_begin(in);
325 itt != i_end; ++itt) {
326 if (itt->lyxCode() == REF_CODE) {
327 InsetCommand * ref = itt->asInsetCommand();
328 if (ref->getParam("reference") == oldname)
329 ref->setParam("reference", newname);
330 } else if (itt->lyxCode() == MATH_REF_CODE) {
331 InsetMathRef * mi = itt->asInsetMath()->asRefInset();
332 // this is necessary to prevent an uninitialized
333 // buffer when the RefInset is in a MathBox.
334 // FIXME audit setBuffer calls
335 mi->setBuffer(const_cast<Buffer &>(buffer));
336 if (mi->getTarget() == oldname)
337 mi->changeTarget(newname);
345 // check for duplicates
346 InsetLabel & lab = static_cast<InsetLabel &>(*it);
347 docstring const oldname = lab.getParam("name");
348 lab.updateLabel(oldname, in_active_inset);
349 // We need to update the buffer reference cache.
351 docstring const newname = lab.getParam("name");
352 if (oldname == newname)
354 // adapt the references
355 for (InsetIterator itt = inset_iterator_begin(in); itt != i_end; ++itt) {
356 if (itt->lyxCode() == REF_CODE) {
357 InsetCommand & ref = static_cast<InsetCommand &>(*itt);
358 if (ref.getParam("reference") == oldname)
359 ref.setParam("reference", newname);
360 } else if (itt->lyxCode() == MATH_REF_CODE) {
361 InsetMathRef * mi = itt->asInsetMath()->asRefInset();
362 // this is necessary to prevent an uninitialized
363 // buffer when the RefInset is in a MathBox.
364 // FIXME audit setBuffer calls
365 mi->setBuffer(const_cast<Buffer &>(buffer));
366 if (mi->getTarget() == oldname)
367 mi->changeTarget(newname);
374 InsetInclude & inc = static_cast<InsetInclude &>(*it);
376 // We need to update the list of included files.
382 InsetCitation & cit = static_cast<InsetCitation &>(*it);
383 // This actually only needs to be done if the cite engine
384 // differs, but we do it in general.
386 // We need to update the list of citations.
392 // check for duplicates
393 InsetBibitem & bib = static_cast<InsetBibitem &>(*it);
394 docstring const oldkey = bib.getParam("key");
395 bib.updateCommand(oldkey, false);
396 // We need to update the buffer reference cache.
398 docstring const newkey = bib.getParam("key");
399 if (oldkey == newkey)
401 // adapt the references
402 for (InsetIterator itt = inset_iterator_begin(in);
403 itt != i_end; ++itt) {
404 if (itt->lyxCode() == CITE_CODE) {
405 InsetCommand * ref = itt->asInsetCommand();
406 if (ref->getParam("key") == oldkey)
407 ref->setParam("key", newkey);
414 // check if branch is known to target buffer
416 InsetBranch & br = static_cast<InsetBranch &>(*it);
417 docstring const name = br.branch();
420 bool const is_child = (&buffer != buffer.masterBuffer());
421 BranchList branchlist = buffer.params().branchlist();
422 if ((!is_child && branchlist.find(name))
423 || (is_child && (branchlist.find(name)
424 || buffer.masterBuffer()->params().branchlist().find(name))))
426 switch(branchAction) {
427 case cap::BRANCH_ADD: {
428 // This is for a temporary buffer, so simply create the branch.
429 // Must not use lyx::dispatch(), since tmpbuffer has no view.
431 const_cast<Buffer&>(buffer).dispatch(FuncRequest(LFUN_BRANCH_ADD, name), dr);
434 case cap::BRANCH_ASK: {
435 docstring text = bformat(
436 _("The pasted branch \"%1$s\" is undefined.\n"
437 "Do you want to add it to the document's branch list?"),
439 if (frontend::Alert::prompt(_("Unknown branch"),
440 text, 0, 1, _("&Add"), _("&Don't Add")) != 0)
442 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, name));
445 case cap::BRANCH_IGNORE:
448 // We need to update the list of branches.
457 insertion.swap(in.paragraphs());
459 // Split the paragraph for inserting the buf if necessary.
461 breakParagraphConservative(buffer.params(), pars, pit, pos);
465 pars.insert(pars.iterator_at(pit),
466 insertion.begin(), insertion.end());
468 // merge the empty par with the last par of the insertion
469 mergeParagraph(buffer.params(), pars,
470 pit + insertion.size() - 1);
472 pars.insert(pars.iterator_at(pit + 1),
473 insertion.begin(), insertion.end());
475 // merge the first par of the insertion with the current par
476 mergeParagraph(buffer.params(), pars, pit);
479 // Store the new cursor position.
480 pit_type last_paste = pit + insertion.size() - 1;
481 pit_type startpit = pit;
483 pos = pars[last_paste].size();
485 // FIXME Should we do it here, or should we let updateBuffer() do it?
486 // Set paragraph buffers. It's important to do this right away
487 // before something calls Inset::buffer() and causes a crash.
488 for (pit_type p = startpit; p <= pit; ++p)
489 pars[p].setInsetBuffers(const_cast<Buffer &>(buffer));
491 // Join (conditionally) last pasted paragraph with next one, i.e.,
492 // the tail of the spliced document paragraph
493 if (!empty && last_paste + 1 != pit_type(pars.size())) {
494 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
495 mergeParagraph(buffer.params(), pars, last_paste);
496 } else if (pars[last_paste + 1].empty()) {
497 pars[last_paste + 1].makeSameLayout(pars[last_paste]);
498 mergeParagraph(buffer.params(), pars, last_paste);
499 } else if (pars[last_paste].empty()) {
500 pars[last_paste].makeSameLayout(pars[last_paste + 1]);
501 mergeParagraph(buffer.params(), pars, last_paste);
503 pars[last_paste + 1].stripLeadingSpaces(buffer.params().track_changes);
508 return PasteReturnValue(pit, pos, need_update);
512 PitPosPair eraseSelectionHelper(BufferParams const & params,
513 ParagraphList & pars,
514 pit_type startpit, pit_type endpit,
515 int startpos, int endpos)
517 // Start of selection is really invalid.
518 if (startpit == pit_type(pars.size()) ||
519 (startpos > pars[startpit].size()))
520 return PitPosPair(endpit, endpos);
522 // Start and end is inside same paragraph
523 if (endpit == pit_type(pars.size()) || startpit == endpit) {
524 endpos -= pars[startpit].eraseChars(startpos, endpos, params.track_changes);
525 return PitPosPair(endpit, endpos);
528 for (pit_type pit = startpit; pit != endpit + 1;) {
529 pos_type const left = (pit == startpit ? startpos : 0);
530 pos_type right = (pit == endpit ? endpos : pars[pit].size() + 1);
531 bool const merge = pars[pit].isMergedOnEndOfParDeletion(params.track_changes);
533 // Logically erase only, including the end-of-paragraph character
534 pars[pit].eraseChars(left, right, params.track_changes);
536 // Separate handling of paragraph break:
537 if (merge && pit != endpit &&
539 || pars[pit].hasSameLayout(pars[endpit])
540 || pars[endpit].size() == endpos)) {
541 if (pit + 1 == endpit)
542 endpos += pars[pit].size();
543 mergeParagraph(params, pars, pit);
549 // Ensure legal cursor pos:
552 return PitPosPair(endpit, endpos);
556 Buffer * copyToTempBuffer(ParagraphList const & paragraphs, DocumentClassConstPtr docclass)
558 // This used to need to be static to avoid a memory leak. It no longer needs
559 // to be so, but the alternative is to construct a new one of these (with a
560 // new temporary directory, etc) every time, and then to destroy it. So maybe
561 // it's worth just keeping this one around.
562 static TempFile tempfile("clipboard.internal");
563 tempfile.setAutoRemove(false);
564 // The initialization of staticbuffer is thread-safe. Using a lambda
565 // guarantees that the properties are set only once.
566 static Buffer * staticbuffer = [&](){
568 theBufferList().newInternalBuffer(tempfile.name().absFileName());
570 b->inset().setBuffer(*b);
571 //initialize staticbuffer with b
574 // Use a clone for the complicated stuff so that we do not need to clean
575 // up in order to avoid a crash.
576 Buffer * buffer = staticbuffer->cloneBufferOnly();
577 LASSERT(buffer, return nullptr);
579 // This needs doing every time.
580 // Since setDocumentClass() causes deletion of the old document class
581 // we need to reset all layout pointers in paragraphs (otherwise they
582 // would be dangling).
583 ParIterator const end = buffer->par_iterator_end();
584 for (ParIterator it = buffer->par_iterator_begin(); it != end; ++it) {
585 docstring const name = it->layout().name();
586 if (docclass->hasLayout(name))
587 it->setLayout((*docclass)[name]);
589 it->setPlainOrDefaultLayout(*docclass);
591 buffer->params().setDocumentClass(docclass);
593 // we will use pasteSelectionHelper to copy the paragraphs into the
594 // temporary Buffer, since it does a lot of things to fix them up.
595 DocIterator dit = doc_iterator_begin(buffer, &buffer->inset());
597 pasteSelectionHelper(dit, paragraphs, docclass, cap::BRANCH_ADD, el);
603 void putClipboard(ParagraphList const & paragraphs,
604 DocumentClassConstPtr docclass, docstring const & plaintext,
605 BufferParams const & bp)
607 Buffer * buffer = copyToTempBuffer(paragraphs, docclass);
608 if (!buffer) // already asserted in copyToTempBuffer()
611 // We don't want to produce images that are not used. Therefore,
612 // output formulas as MathML. Even if this is not understood by all
613 // applications, the number that can parse it should go up in the future.
614 buffer->params().html_math_output = BufferParams::MathML;
616 if (lyxrc.ct_markup_copied) {
617 // Copy authors to the params. We need those pointers.
618 for (Author const & a : bp.authors())
619 buffer->params().authors().record(a);
622 // Make sure MarkAsExporting is deleted before buffer is
624 // The Buffer is being used to export. This is necessary so that the
625 // updateMacros call will record the needed information.
626 MarkAsExporting mex(buffer);
628 buffer->updateBuffer(Buffer::UpdateMaster, OutputUpdate);
629 buffer->updateMacros();
630 buffer->updateMacroInstances(OutputUpdate);
635 if (buffer->write(oslyx))
639 odocstringstream oshtml;
640 OutputParams runparams(encodings.fromLyXName("utf8"));
641 // We do not need to produce images, etc.
642 runparams.dryrun = true;
643 // We are not interested in errors (bug 8866)
644 runparams.silent = true;
645 buffer->writeLyXHTMLSource(oshtml, runparams, Buffer::FullSource);
647 theClipboard().put(lyx, oshtml.str(), plaintext);
655 /// return true if the whole ParagraphList is deleted
656 static bool isFullyDeleted(ParagraphList const & pars)
658 pit_type const pars_size = static_cast<pit_type>(pars.size());
660 // check all paragraphs
661 for (pit_type pit = 0; pit < pars_size; ++pit) {
662 if (!pars[pit].empty()) // prevent assertion failure
663 if (!pars[pit].isDeleted(0, pars[pit].size()))
670 void copySelectionHelper(Buffer const & buf, Text const & text,
671 pit_type startpit, pit_type endpit,
672 int start, int end, DocumentClassConstPtr dc, CutStack & cutstack)
674 ParagraphList const & pars = text.paragraphs();
676 // In most of these cases, we can try to recover.
677 LASSERT(0 <= start, start = 0);
678 LASSERT(start <= pars[startpit].size(), start = pars[startpit].size());
679 LASSERT(0 <= end, end = 0);
680 LASSERT(end <= pars[endpit].size(), end = pars[endpit].size());
681 LASSERT(startpit != endpit || start <= end, return);
683 // Clone the paragraphs within the selection.
684 ParagraphList copy_pars(pars.iterator_at(startpit),
685 pars.iterator_at(endpit + 1));
687 // Remove the end of the last paragraph; afterwards, remove the
688 // beginning of the first paragraph. Keep this order - there may only
689 // be one paragraph! Do not track deletions here; this is an internal
690 // action not visible to the user
692 Paragraph & back = copy_pars.back();
693 back.eraseChars(end, back.size(), false);
694 Paragraph & front = copy_pars.front();
695 front.eraseChars(0, start, false);
697 for (auto & par : copy_pars) {
698 // Since we have a copy of the paragraphs, the insets
699 // do not have a proper buffer reference. It makes
700 // sense to add them temporarily, because the
701 // operations below depend on that (acceptChanges included).
702 par.setInsetBuffers(const_cast<Buffer &>(buf));
703 // PassThru paragraphs have the Language
704 // latex_language. This is invalid for others, so we
705 // need to change it to the buffer language.
706 if (par.isPassThru())
707 par.changeLanguage(buf.params(),
708 latex_language, buf.language());
711 // do not copy text (also nested in insets) which is marked as
712 // deleted, unless the whole selection was deleted
713 if (!lyxrc.ct_markup_copied) {
714 if (!isFullyDeleted(copy_pars))
715 acceptChanges(copy_pars, buf.params());
717 rejectChanges(copy_pars, buf.params());
721 // do some final cleanup now, to make sure that the paragraphs
722 // are not linked to something else.
723 for (auto & par : copy_pars) {
725 par.setInsetOwner(nullptr);
728 cutstack.push(make_pair(copy_pars, dc));
736 void region(CursorSlice const & i1, CursorSlice const & i2,
737 Inset::row_type & r1, Inset::row_type & r2,
738 Inset::col_type & c1, Inset::col_type & c2)
740 Inset & p = i1.inset();
741 c1 = p.col(i1.idx());
742 c2 = p.col(i2.idx());
745 r1 = p.row(i1.idx());
746 r2 = p.row(i2.idx());
752 docstring grabAndEraseSelection(Cursor & cur)
754 if (!cur.selection())
756 docstring res = grabSelection(cur);
762 bool reduceSelectionToOneCell(CursorData & cur)
764 if (!cur.selection() || !cur.inMathed())
767 CursorSlice i1 = cur.selBegin();
768 CursorSlice i2 = cur.selEnd();
769 if (!i1.inset().asInsetMath())
772 // the easy case: do nothing if only one cell is selected
773 if (i1.idx() == i2.idx())
778 cur.top().pos() = cur.top().lastpos();
784 bool multipleCellsSelected(CursorData const & cur)
786 if (!cur.selection() || !cur.inMathed())
789 CursorSlice i1 = cur.selBegin();
790 CursorSlice i2 = cur.selEnd();
791 if (!i1.inset().asInsetMath())
794 if (i1.idx() == i2.idx())
801 void switchBetweenClasses(DocumentClassConstPtr oldone,
802 DocumentClassConstPtr newone, InsetText & in, ErrorList & errorlist)
806 LBUFERR(!in.paragraphs().empty());
807 if (oldone == newone)
810 DocumentClass const & oldtc = *oldone;
811 DocumentClass const & newtc = *newone;
814 ParIterator it = par_iterator_begin(in);
815 ParIterator end = par_iterator_end(in);
816 // for remembering which layouts we've had to add
817 set<docstring> newlayouts;
818 for (; it != end; ++it) {
819 docstring const name = it->layout().name();
821 // the pasted text will keep their own layout name. If this layout does
822 // not exist in the new document, it will behave like a standard layout.
823 bool const added_one = newtc.addLayoutIfNeeded(name);
825 newlayouts.insert(name);
827 if (added_one || newlayouts.find(name) != newlayouts.end()) {
829 docstring const s = bformat(_("Layout `%1$s' was not found."), name);
830 errorlist.push_back(ErrorItem(_("Layout Not Found"), s,
831 {it->id(), 0}, {it->id(), -1}));
834 if (in.usePlainLayout())
835 it->setLayout(newtc.plainLayout());
837 it->setLayout(newtc[name]);
840 // character styles and hidden table cells
841 InsetIterator const i_end = inset_iterator_end(in);
842 for (InsetIterator iit = inset_iterator_begin(in); iit != i_end; ++iit) {
843 InsetCode const code = iit->lyxCode();
844 if (code == FLEX_CODE) {
845 // FIXME: Should we verify all InsetCollapsible?
846 docstring const layoutName = iit->layoutName();
847 docstring const & n = newone->insetLayout(layoutName).name();
848 bool const is_undefined = n.empty() ||
849 n == DocumentClass::plainInsetLayout().name();
853 // The flex inset is undefined in newtc
854 docstring const oldname = from_utf8(oldtc.name());
855 docstring const newname = from_utf8(newtc.name());
857 if (oldname == newname)
858 s = bformat(_("Flex inset %1$s is undefined after "
859 "reloading `%2$s' layout."), layoutName, oldname);
861 s = bformat(_("Flex inset %1$s is undefined because of "
862 "conversion from `%2$s' layout to `%3$s'."),
863 layoutName, oldname, newname);
864 // To warn the user that something had to be done.
865 errorlist.push_back(ErrorItem(
866 _("Undefined flex inset"), s,
867 {iit.paragraph().id(), iit.pos()},
868 {iit.paragraph().id(), iit.pos() + 1}));
869 } else if (code == TABULAR_CODE) {
870 // The recursion above does not catch paragraphs in "hidden" cells,
871 // i.e., ones that are part of a multirow or multicolum. So we need
872 // to handle those separately.
873 // This is the cause of bug #9049.
874 InsetTabular * table = iit->asInsetTabular();
875 table->setLayoutForHiddenCells(newtc);
881 vector<docstring> availableSelections(Buffer const * buf)
883 vector<docstring> selList;
887 for (auto const & cut : theCuts) {
888 ParagraphList const & pars = cut.first;
890 for (auto const & para : pars) {
891 Paragraph par(para, 0, 46);
892 // adapt paragraph to current buffer.
893 par.setInsetBuffers(const_cast<Buffer &>(*buf));
894 textSel += par.asString(AS_STR_INSETS);
895 if (textSel.size() > 45) {
896 support::truncateWithEllipsis(textSel,45);
900 selList.push_back(textSel);
907 size_type numberOfSelections()
909 return theCuts.size();
914 void cutSelectionHelper(Cursor & cur, CutStack & cuts, bool realcut, bool putclip)
916 // This doesn't make sense, if there is no selection
917 if (!cur.selection())
920 // OK, we have a selection. This is always between cur.selBegin()
923 if (cur.inTexted()) {
924 Text * text = cur.text();
929 // make sure that the depth behind the selection are restored, too
930 cur.recordUndoSelection();
931 pit_type begpit = cur.selBegin().pit();
932 pit_type endpit = cur.selEnd().pit();
934 int endpos = cur.selEnd().pos();
936 BufferParams const & bp = cur.buffer()->params();
938 copySelectionHelper(*cur.buffer(),
941 cur.selBegin().pos(), endpos,
942 bp.documentClassPtr(), cuts);
943 // Stuff what we got on the clipboard.
944 // Even if there is no selection.
946 putClipboard(cuts[0].first, cuts[0].second,
947 cur.selectionAsString(true, true), bp);
950 if (begpit != endpit)
951 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
953 tie(endpit, endpos) =
954 eraseSelectionHelper(bp, text->paragraphs(), begpit, endpit,
955 cur.selBegin().pos(), endpos);
957 // cutSelection can invalidate the cursor so we need to set
959 // we prefer the end for when tracking changes
963 // need a valid cursor. (Lgb)
964 cur.clearSelection();
966 // After a cut operation, we must make sure that the Buffer is updated
967 // because some further operation might need updated label information for
968 // example. So we cannot just use "cur.forceBufferUpdate()" here.
970 cur.buffer()->updateBuffer();
972 // tell tabular that a recent copy happened
973 dirtyTabularStack(false);
976 if (cur.inMathed()) {
977 if (cur.selBegin().idx() != cur.selEnd().idx()) {
978 // The current selection spans more than one cell.
980 cur.recordUndoInset();
982 // Record only the current cell to avoid a jumping
994 void cutSelection(Cursor & cur, bool realcut)
996 cutSelectionHelper(cur, theCuts, realcut, true);
1000 void cutSelectionToTemp(Cursor & cur, bool realcut)
1002 cutSelectionHelper(cur, tempCut, realcut, false);
1006 void copySelection(Cursor const & cur)
1008 copySelection(cur, cur.selectionAsString(true, true));
1012 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext)
1016 BufferParams const & bp = cur.buffer()->params();
1017 par.setLayout(bp.documentClass().plainLayout());
1018 Font font(inherit_font, bp.language);
1019 par.insertInset(0, inset, font, Change(Change::UNCHANGED));
1020 pars.push_back(par);
1021 theCuts.push(make_pair(pars, bp.documentClassPtr()));
1023 // stuff the selection onto the X clipboard, from an explicit copy request
1024 putClipboard(theCuts[0].first, theCuts[0].second, plaintext, bp);
1030 void copySelectionToStack(CursorData const & cur, CutStack & cutstack)
1032 // this doesn't make sense, if there is no selection
1033 if (!cur.selection())
1036 // copySelection can not yet handle the case of cross idx selection
1037 if (cur.selBegin().idx() != cur.selEnd().idx())
1040 if (cur.inTexted()) {
1041 Text * text = cur.text();
1043 // ok we have a selection. This is always between cur.selBegin()
1044 // and sel_end cursor
1045 copySelectionHelper(*cur.buffer(), *text,
1046 cur.selBegin().pit(), cur.selEnd().pit(),
1047 cur.selBegin().pos(), cur.selEnd().pos(),
1048 cur.buffer()->params().documentClassPtr(),
1050 // Reset the dirty_tabular_stack_ flag only when something
1051 // is copied to the clipboard (not to the selectionBuffer).
1052 if (&cutstack == &theCuts)
1053 dirtyTabularStack(false);
1056 if (cur.inMathed()) {
1057 //lyxerr << "copySelection in mathed" << endl;
1060 BufferParams const & bp = cur.buffer()->params();
1061 // FIXME This should be the plain layout...right?
1062 par.setLayout(bp.documentClass().plainLayout());
1063 // For pasting into text, we set the language to the paragraph language
1064 // (rather than the default_language which is always English; see #2596)
1065 par.insert(0, grabSelection(cur), Font(sane_font, par.getParLanguage(bp)),
1066 Change(Change::UNCHANGED));
1067 pars.push_back(par);
1068 cutstack.push(make_pair(pars, bp.documentClassPtr()));
1075 void copySelectionToStack()
1077 if (!selectionBuffer.empty())
1078 theCuts.push(selectionBuffer[0]);
1082 void copySelectionToTemp(Cursor & cur)
1084 copySelectionToStack(cur, tempCut);
1088 void copySelection(Cursor const & cur, docstring const & plaintext)
1090 // In tablemode, because copy and paste actually use special table stack
1091 // we do not attempt to get selected paragraphs under cursor. Instead, a
1092 // paragraph with the plain text version is generated so that table cells
1093 // can be pasted as pure text somewhere else.
1094 if (cur.selBegin().idx() != cur.selEnd().idx()) {
1097 BufferParams const & bp = cur.buffer()->params();
1098 par.setLayout(bp.documentClass().plainLayout());
1099 // Replace (column-separating) tabs by space (#4449)
1100 docstring const clean_text = subst(plaintext, '\t', ' ');
1101 // For pasting into text, we set the language to the paragraph language
1102 // (rather than the default_language which is always English; see #11898)
1103 par.insert(0, clean_text, Font(sane_font, par.getParLanguage(bp)),
1104 Change(Change::UNCHANGED));
1105 pars.push_back(par);
1106 theCuts.push(make_pair(pars, bp.documentClassPtr()));
1108 copySelectionToStack(cur, theCuts);
1111 // stuff the selection onto the X clipboard, from an explicit copy request
1112 putClipboard(theCuts[0].first, theCuts[0].second, plaintext,
1113 cur.buffer()->params());
1117 void saveSelection(Cursor const & cur)
1119 // This function is called, not when a selection is formed, but when
1120 // a selection is cleared. Therefore, multiple keyboard selection
1121 // will not repeatively trigger this function (bug 3877).
1123 && cur.selBegin() == cur.bv().cursor().selBegin()
1124 && cur.selEnd() == cur.bv().cursor().selEnd()) {
1125 LYXERR(Debug::SELECTION, "saveSelection: '" << cur.selectionAsString(true, true) << "'");
1126 copySelectionToStack(cur, selectionBuffer);
1133 return !selectionBuffer.empty();
1137 void clearSelection()
1139 selectionBuffer.clear();
1143 void clearCutStack()
1150 docstring selection(size_t sel_index, DocumentClassConstPtr docclass)
1152 if (sel_index >= theCuts.size())
1155 unique_ptr<Buffer> buffer(copyToTempBuffer(theCuts[sel_index].first,
1160 return buffer->paragraphs().back().asString(AS_STR_INSETS | AS_STR_NEWLINES);
1164 void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
1165 DocumentClassConstPtr docclass, ErrorList & errorList,
1166 cap::BranchAction branchAction)
1168 if (cur.inTexted()) {
1169 Text * text = cur.text();
1172 PasteReturnValue prv =
1173 pasteSelectionHelper(cur, parlist, docclass, branchAction, errorList);
1174 cur.forceBufferUpdate();
1175 cur.clearSelection();
1176 text->setCursor(cur, prv.pit, prv.pos);
1179 // mathed is handled in InsetMathNest/InsetMathGrid
1180 LATTEST(!cur.inMathed());
1184 bool pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index)
1186 // this does not make sense, if there is nothing to paste
1187 if (!checkPastePossible(sel_index))
1191 pasteParagraphList(cur, theCuts[sel_index].first,
1192 theCuts[sel_index].second, errorList, BRANCH_ASK);
1197 bool pasteFromTemp(Cursor & cur, ErrorList & errorList)
1199 // this does not make sense, if there is nothing to paste
1200 if (tempCut.empty() || tempCut[0].first.empty())
1204 pasteParagraphList(cur, tempCut[0].first,
1205 tempCut[0].second, errorList, BRANCH_IGNORE);
1210 bool pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs,
1211 Clipboard::TextType type)
1213 // Use internal clipboard if it is the most recent one
1214 // This overrides asParagraphs and type on purpose!
1215 if (theClipboard().isInternal())
1216 return pasteFromStack(cur, errorList, 0);
1218 // First try LyX format
1219 if ((type == Clipboard::LyXTextType ||
1220 type == Clipboard::LyXOrPlainTextType ||
1221 type == Clipboard::AnyTextType) &&
1222 theClipboard().hasTextContents(Clipboard::LyXTextType)) {
1223 string lyx = theClipboard().getAsLyX();
1225 Buffer buffer(string(), false);
1226 buffer.setUnnamed(true);
1227 if (buffer.readString(lyx)) {
1229 pasteParagraphList(cur, buffer.paragraphs(),
1230 buffer.params().documentClassPtr(), errorList);
1236 // Then try TeX and HTML
1237 Clipboard::TextType types[2] = {Clipboard::HtmlTextType, Clipboard::LaTeXTextType};
1238 string names[2] = {"html", "latexclipboard"};
1239 for (int i = 0; i < 2; ++i) {
1240 if (type != types[i] && type != Clipboard::AnyTextType)
1242 bool available = theClipboard().hasTextContents(types[i]);
1244 // If a specific type was explicitly requested, try to
1245 // interpret plain text: The user told us that the clipboard
1246 // contents is in the desired format
1247 if (!available && type == types[i]) {
1248 types[i] = Clipboard::PlainTextType;
1249 available = theClipboard().hasTextContents(types[i]);
1253 docstring text = theClipboard().getAsText(types[i]);
1254 available = !text.empty();
1256 Buffer buffer(string(), false);
1257 buffer.setUnnamed(true);
1258 available = buffer.importString(names[i], text, errorList);
1260 available = !buffer.paragraphs().empty();
1261 if (available && !buffer.paragraphs()[0].empty()) {
1262 // TeX2lyx (also used in the HTML chain) assumes English as document language
1263 // if no language is explicitly set (as is the case here).
1264 // We thus reset the temp buffer's language to the context language
1265 buffer.changeLanguage(buffer.language(), cur.getFont().language());
1267 pasteParagraphList(cur, buffer.paragraphs(),
1268 buffer.params().documentClassPtr(), errorList);
1275 // Then try plain text
1276 docstring const text = theClipboard().getAsText(Clipboard::PlainTextType);
1281 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1283 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1284 cur.forceBufferUpdate();
1289 void pasteSimpleText(Cursor & cur, bool asParagraphs)
1292 // Use internal clipboard if it is the most recent one
1293 if (theClipboard().isInternal()) {
1294 if (!checkPastePossible(0))
1297 ParagraphList const & pars = theCuts[0].first;
1298 ParagraphList::const_iterator it = pars.begin();
1299 for (; it != pars.end(); ++it) {
1300 if (it != pars.begin())
1302 text += (*it).asString();
1304 asParagraphs = false;
1306 // Then try plain text
1307 text = theClipboard().getAsText(Clipboard::PlainTextType);
1314 cutSelection(cur, false);
1316 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1318 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1322 void pasteClipboardGraphics(Cursor & cur, ErrorList & /* errorList */,
1323 Clipboard::GraphicsType preferedType)
1325 LASSERT(theClipboard().hasGraphicsContents(preferedType), return);
1327 // get picture from clipboard
1328 FileName filename = theClipboard().getAsGraphics(cur, preferedType);
1329 if (filename.empty())
1332 // create inset for graphic
1333 InsetGraphics * inset = new InsetGraphics(cur.buffer());
1334 InsetGraphicsParams params;
1335 params.filename = support::DocFileName(filename.absFileName(), false);
1336 inset->setParams(params);
1342 void pasteSelection(Cursor & cur, ErrorList & errorList)
1344 if (selectionBuffer.empty())
1347 pasteParagraphList(cur, selectionBuffer[0].first,
1348 selectionBuffer[0].second, errorList);
1352 void replaceSelectionWithString(Cursor & cur, docstring const & str)
1355 DocIterator selbeg = cur.selectionBegin();
1357 // Get font setting before we cut, we need a copy here, not a bare reference.
1359 selbeg.paragraph().getFontSettings(cur.buffer()->params(), selbeg.pos());
1361 // Insert the new string
1362 pos_type pos = cur.selEnd().pos();
1363 Paragraph & par = cur.selEnd().paragraph();
1364 for (auto const & c : str) {
1365 par.insertChar(pos, c, font, cur.buffer()->params().track_changes);
1369 // Cut the selection
1370 cutSelection(cur, false);
1374 void replaceSelection(Cursor & cur)
1376 if (cur.selection())
1377 cutSelection(cur, false);
1381 void eraseSelection(Cursor & cur)
1383 //lyxerr << "cap::eraseSelection begin: " << cur << endl;
1384 CursorSlice const & i1 = cur.selBegin();
1385 CursorSlice const & i2 = cur.selEnd();
1386 if (!i1.asInsetMath()) {
1387 LYXERR0("Can't erase this selection");
1393 InsetMath * p = i1.asInsetMath();
1394 if (i1.idx() == i2.idx()) {
1395 i1.cell().erase(i1.pos(), i2.pos());
1396 // We may have deleted i1.cell(cur.pos()).
1397 // Make sure that pos is valid.
1398 if (cur.pos() > cur.lastpos())
1399 cur.pos() = cur.lastpos();
1400 } else if (p->nrows() > 0 && p->ncols() > 0) {
1401 // This is a grid, delete a nice square region
1402 Inset::row_type r1, r2;
1403 Inset::col_type c1, c2;
1404 region(i1, i2, r1, r2, c1, c2);
1405 for (Inset::row_type row = r1; row <= r2; ++row)
1406 for (Inset::col_type col = c1; col <= c2; ++col)
1407 p->cell(p->index(row, col)).clear();
1408 // We've deleted the whole cell. Only pos 0 is valid.
1411 Inset::idx_type idx1 = i1.idx();
1412 Inset::idx_type idx2 = i2.idx();
1415 for (Inset::idx_type idx = idx1 ; idx <= idx2; ++idx)
1416 p->cell(idx).clear();
1417 // We've deleted the whole cell. Only pos 0 is valid.
1421 // need a valid cursor. (Lgb)
1422 cur.clearSelection();
1423 //lyxerr << "cap::eraseSelection end: " << cur << endl;
1427 void selDel(Cursor & cur)
1429 //lyxerr << "cap::selDel" << endl;
1430 if (cur.selection())
1431 eraseSelection(cur);
1435 void selClearOrDel(Cursor & cur)
1437 //lyxerr << "cap::selClearOrDel" << endl;
1438 if (lyxrc.auto_region_delete)
1441 cur.selection(false);
1445 docstring grabSelection(CursorData const & cur)
1447 if (!cur.selection())
1451 // grab selection by glueing multiple cells together. This is not what
1452 // we want because selections spanning multiple cells will get "&" and "\\"
1455 for (DocIterator dit = cur.selectionBegin();
1456 dit != cur.selectionEnd(); dit.forwardPos())
1457 os << asString(dit.cell());
1461 CursorSlice i1 = cur.selBegin();
1462 CursorSlice i2 = cur.selEnd();
1464 if (i1.idx() == i2.idx()) {
1465 if (i1.inset().asInsetMath()) {
1466 MathData::const_iterator it = i1.cell().begin();
1467 Buffer * buf = cur.buffer();
1468 return asString(MathData(buf, it + i1.pos(), it + i2.pos()));
1470 return from_ascii("unknown selection 1");
1474 Inset::row_type r1, r2;
1475 Inset::col_type c1, c2;
1476 region(i1, i2, r1, r2, c1, c2);
1479 if (i1.inset().asInsetMath()) {
1480 for (Inset::row_type row = r1; row <= r2; ++row) {
1483 for (Inset::col_type col = c1; col <= c2; ++col) {
1486 data += asString(i1.asInsetMath()->
1487 cell(i1.asInsetMath()->index(row, col)));
1491 data = from_ascii("unknown selection 2");
1497 void dirtyTabularStack(bool b)
1499 dirty_tabular_stack_ = b;
1503 bool tabularStackDirty()
1505 return dirty_tabular_stack_;