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"
19 #include "buffer_funcs.h"
20 #include "bufferparams.h"
23 #include "errorlist.h"
24 #include "funcrequest.h"
26 #include "insetiterator.h"
32 #include "lyxtextclasslist.h"
33 #include "paragraph.h"
34 #include "paragraph_funcs.h"
35 #include "ParagraphParameters.h"
36 #include "ParagraphList_fwd.h"
37 #include "pariterator.h"
40 #include "insets/insetcharstyle.h"
41 #include "insets/insettabular.h"
43 #include "mathed/MathData.h"
44 #include "mathed/InsetMath.h"
45 #include "mathed/MathSupport.h"
47 #include "support/lstrings.h"
49 #include "frontends/Clipboard.h"
50 #include "frontends/Selection.h"
52 #include <boost/tuple/tuple.hpp>
66 using support::bformat;
67 using frontend::Clipboard;
71 typedef std::pair<pit_type, int> PitPosPair;
73 typedef limited_stack<pair<ParagraphList, textclass_type> > CutStack;
76 // persistent selection, cleared until the next selection
77 CutStack selectionBuffer(1);
79 // store whether the tabular stack is newer than the normal copy stack
80 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
81 // when we (hopefully) have a one-for-all paste mechanism.
82 bool dirty_tabular_stack_ = false;
85 void region(CursorSlice const & i1, CursorSlice const & i2,
86 InsetBase::row_type & r1, InsetBase::row_type & r2,
87 InsetBase::col_type & c1, InsetBase::col_type & c2)
89 InsetBase & p = i1.inset();
101 bool checkPastePossible(int index)
103 return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
107 pair<PitPosPair, pit_type>
108 pasteSelectionHelper(LCursor & cur, ParagraphList const & parlist,
109 textclass_type textclass, ErrorList & errorlist)
111 Buffer const & buffer = cur.buffer();
112 pit_type pit = cur.pit();
113 pos_type pos = cur.pos();
114 ParagraphList & pars = cur.text()->paragraphs();
117 return make_pair(PitPosPair(pit, pos), pit);
119 BOOST_ASSERT (pos <= pars[pit].size());
121 // Make a copy of the CaP paragraphs.
122 ParagraphList insertion = parlist;
123 textclass_type const tc = buffer.params().textclass;
125 // Now remove all out of the pars which is NOT allowed in the
126 // new environment and set also another font if that is required.
128 // Convert newline to paragraph break in ERT inset.
129 // This should not be here!
130 if (pars[pit].inInset() &&
131 pars[pit].inInset()->lyxCode() == InsetBase::ERT_CODE) {
132 for (ParagraphList::size_type i = 0; i < insertion.size(); ++i) {
133 for (pos_type j = 0; j < insertion[i].size(); ++j) {
134 if (insertion[i].isNewline(j)) {
135 // do not track deletion of newline
136 insertion[i].eraseChar(j, false);
137 breakParagraphConservative(
145 // If we are in an inset which returns forceDefaultParagraphs,
146 // set the paragraphs to default
147 if (cur.inset().forceDefaultParagraphs(cur.idx())) {
148 LyXLayout_ptr const layout =
149 buffer.params().getLyXTextClass().defaultLayout();
150 ParagraphList::iterator const end = insertion.end();
151 for (ParagraphList::iterator par = insertion.begin();
156 // Make sure there is no class difference.
158 // This works without copying any paragraph data because we have
159 // a specialized swap method for ParagraphList. This is important
160 // since we store pointers to insets at some places and we don't
161 // want to invalidate them.
162 insertion.swap(in.paragraphs());
163 cap::switchBetweenClasses(textclass, tc, in, errorlist);
164 insertion.swap(in.paragraphs());
166 ParagraphList::iterator tmpbuf = insertion.begin();
167 int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
169 depth_type max_depth = pars[pit].getMaxDepthAfter();
171 for (; tmpbuf != insertion.end(); ++tmpbuf) {
172 // If we have a negative jump so that the depth would
173 // go below 0 depth then we have to redo the delta to
174 // this new max depth level so that subsequent
175 // paragraphs are aligned correctly to this paragraph
177 if (int(tmpbuf->params().depth()) + depth_delta < 0)
180 // Set the right depth so that we are not too deep or shallow.
181 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
182 if (tmpbuf->params().depth() > max_depth)
183 tmpbuf->params().depth(max_depth);
185 // Only set this from the 2nd on as the 2nd depends
186 // for maxDepth still on pit.
187 if (tmpbuf != insertion.begin())
188 max_depth = tmpbuf->getMaxDepthAfter();
190 // Set the inset owner of this paragraph.
191 tmpbuf->setInsetOwner(pars[pit].inInset());
192 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
193 if (tmpbuf->getChar(i) == Paragraph::META_INSET &&
194 !pars[pit].insetAllowed(tmpbuf->getInset(i)->lyxCode()))
195 // do not track deletion of invalid insets
196 tmpbuf->eraseChar(i--, false);
199 tmpbuf->setChange(Change(buffer.params().trackChanges ?
200 Change::INSERTED : Change::UNCHANGED));
203 bool const empty = pars[pit].empty();
205 // Make the buf exactly the same layout as the cursor
207 insertion.begin()->makeSameLayout(pars[pit]);
210 // Prepare the paragraphs and insets for insertion.
211 // A couple of insets store buffer references so need updating.
212 insertion.swap(in.paragraphs());
214 ParIterator fpit = par_iterator_begin(in);
215 ParIterator fend = par_iterator_end(in);
217 for (; fpit != fend; ++fpit) {
218 InsetList::const_iterator lit = fpit->insetlist.begin();
219 InsetList::const_iterator eit = fpit->insetlist.end();
221 for (; lit != eit; ++lit) {
222 switch (lit->inset->lyxCode()) {
223 case InsetBase::TABULAR_CODE: {
224 InsetTabular * it = static_cast<InsetTabular*>(lit->inset);
234 insertion.swap(in.paragraphs());
236 // Split the paragraph for inserting the buf if necessary.
238 breakParagraphConservative(buffer.params(), pars, pit, pos);
242 pars.insert(boost::next(pars.begin(), pit),
246 // merge the empty par with the last par of the insertion
247 mergeParagraph(buffer.params(), pars,
248 pit + insertion.size() - 1);
250 pars.insert(boost::next(pars.begin(), pit + 1),
254 // merge the first par of the insertion with the current par
255 mergeParagraph(buffer.params(), pars, pit);
258 pit_type last_paste = pit + insertion.size() - 1;
260 // Store the new cursor position.
262 pos = pars[last_paste].size();
264 // Join (conditionally) last pasted paragraph with next one, i.e.,
265 // the tail of the spliced document paragraph
266 if (!empty && last_paste + 1 != pit_type(pars.size())) {
267 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
268 mergeParagraph(buffer.params(), pars, last_paste);
269 } else if (pars[last_paste + 1].empty()) {
270 pars[last_paste + 1].makeSameLayout(pars[last_paste]);
271 mergeParagraph(buffer.params(), pars, last_paste);
272 } else if (pars[last_paste].empty()) {
273 pars[last_paste].makeSameLayout(pars[last_paste + 1]);
274 mergeParagraph(buffer.params(), pars, last_paste);
276 pars[last_paste + 1].stripLeadingSpaces(buffer.params().trackChanges);
281 return make_pair(PitPosPair(pit, pos), last_paste + 1);
285 PitPosPair eraseSelectionHelper(BufferParams const & params,
286 ParagraphList & pars,
287 pit_type startpit, pit_type endpit,
288 int startpos, int endpos, bool doclear)
290 // Start of selection is really invalid.
291 if (startpit == pit_type(pars.size()) ||
292 (startpos > pars[startpit].size()))
293 return PitPosPair(endpit, endpos);
295 // Start and end is inside same paragraph
296 if (endpit == pit_type(pars.size()) || startpit == endpit) {
297 endpos -= pars[startpit].eraseChars(startpos, endpos, params.trackChanges);
298 return PitPosPair(endpit, endpos);
301 for (pit_type pit = startpit; pit != endpit + 1;) {
302 pos_type const left = (pit == startpit ? startpos : 0);
303 pos_type const right = (pit == endpit ? endpos : pars[pit].size() + 1);
305 bool const merge = pars[pit].isMergedOnEndOfParDeletion(params.trackChanges);
307 // Logically erase only, including the end-of-paragraph character
308 pars[pit].eraseChars(left, right, params.trackChanges);
310 // Separate handling of paragraph break:
311 if (merge && pit != endpit &&
312 (pit + 1 != endpit || pars[pit].hasSameLayout(pars[pit + 1]))) {
313 pos_type const thissize = pars[pit].size();
315 pars[pit + 1].stripLeadingSpaces(params.trackChanges);
316 mergeParagraph(params, pars, pit);
324 // Ensure legal cursor pos:
327 return PitPosPair(endpit, endpos);
331 void putClipboard(ParagraphList const & paragraphs, textclass_type textclass,
332 docstring const & plaintext)
334 Buffer buffer(string(), false);
335 buffer.setUnnamed(true);
336 buffer.paragraphs() = paragraphs;
337 buffer.params().textclass = textclass;
338 std::ostringstream lyx;
339 if (buffer.write(lyx))
340 theClipboard().put(lyx.str(), plaintext);
342 theClipboard().put(string(), plaintext);
346 void copySelectionHelper(Buffer const & buf, ParagraphList & pars,
347 pit_type startpit, pit_type endpit,
348 int start, int end, textclass_type tc, CutStack & cutstack)
350 BOOST_ASSERT(0 <= start && start <= pars[startpit].size());
351 BOOST_ASSERT(0 <= end && end <= pars[endpit].size());
352 BOOST_ASSERT(startpit != endpit || start <= end);
354 // Clone the paragraphs within the selection.
355 ParagraphList paragraphs(boost::next(pars.begin(), startpit),
356 boost::next(pars.begin(), endpit + 1));
358 ParagraphList::iterator it = paragraphs.begin();
359 ParagraphList::iterator it_end = paragraphs.end();
361 for (; it != it_end; it++) {
362 // ERT paragraphs have the Language latex_language.
363 // This is invalid outside of ERT, so we need to change it
364 // to the buffer language.
365 if (it->ownerCode() == InsetBase::ERT_CODE) {
366 it->changeLanguage(buf.params(), latex_language,
369 it->setInsetOwner(0);
372 // Cut out the end of the last paragraph.
373 Paragraph & back = paragraphs.back();
374 // do not track deletion here; it is an internal action not visible to the user
375 back.eraseChars(end, back.size(), false);
377 // Cut out the begin of the first paragraph
378 Paragraph & front = paragraphs.front();
379 // again, do not track deletion
380 front.eraseChars(0, start, false);
382 cutstack.push(make_pair(paragraphs, tc));
392 docstring grabAndEraseSelection(LCursor & cur)
394 if (!cur.selection())
396 docstring res = grabSelection(cur);
402 void switchBetweenClasses(textclass_type c1, textclass_type c2,
403 InsetText & in, ErrorList & errorlist)
405 BOOST_ASSERT(!in.paragraphs().empty());
409 LyXTextClass const & tclass1 = textclasslist[c1];
410 LyXTextClass const & tclass2 = textclasslist[c2];
413 ParIterator end = par_iterator_end(in);
414 for (ParIterator it = par_iterator_begin(in); it != end; ++it) {
415 string const name = it->layout()->name();
416 bool hasLayout = tclass2.hasLayout(name);
419 it->layout(tclass2[name]);
421 it->layout(tclass2.defaultLayout());
423 if (!hasLayout && name != tclass1.defaultLayoutName()) {
424 docstring const s = bformat(
425 _("Layout had to be changed from\n%1$s to %2$s\n"
426 "because of class conversion from\n%3$s to %4$s"),
427 from_utf8(name), from_utf8(it->layout()->name()),
428 from_utf8(tclass1.name()), from_utf8(tclass2.name()));
429 // To warn the user that something had to be done.
430 errorlist.push_back(ErrorItem(_("Changed Layout"), s,
437 InsetIterator const i_end = inset_iterator_end(in);
438 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
439 if (it->lyxCode() == InsetBase::CHARSTYLE_CODE) {
440 InsetCharStyle & inset =
441 static_cast<InsetCharStyle &>(*it);
442 string const name = inset.params().type;
443 CharStyles::iterator const found_cs =
444 tclass2.charstyle(name);
445 if (found_cs == tclass2.charstyles().end()) {
446 // The character style is undefined in tclass2
447 inset.setUndefined();
448 docstring const s = bformat(_(
449 "Character style %1$s is "
450 "undefined because of class "
451 "conversion from\n%2$s to %3$s"),
452 from_utf8(name), from_utf8(tclass1.name()),
453 from_utf8(tclass2.name()));
454 // To warn the user that something had to be done.
455 errorlist.push_back(ErrorItem(
456 _("Undefined character style"),
457 s, it.paragraph().id(), it.pos(), it.pos() + 1));
458 } else if (inset.undefined()) {
459 // The character style is undefined in
460 // tclass1 and is defined in tclass2
461 inset.setDefined(found_cs);
468 std::vector<docstring> const availableSelections(Buffer const & buffer)
470 vector<docstring> selList;
472 CutStack::const_iterator cit = theCuts.begin();
473 CutStack::const_iterator end = theCuts.end();
474 for (; cit != end; ++cit) {
475 // we do not use cit-> here because gcc 2.9x does not
477 ParagraphList const & pars = (*cit).first;
479 ParagraphList::const_iterator pit = pars.begin();
480 ParagraphList::const_iterator pend = pars.end();
481 for (; pit != pend; ++pit) {
482 asciiSel += pit->asString(buffer, false);
483 if (asciiSel.size() > 25) {
484 asciiSel.replace(22, docstring::npos,
490 selList.push_back(asciiSel);
497 size_type numberOfSelections()
499 return theCuts.size();
503 void cutSelection(LCursor & cur, bool doclear, bool realcut)
505 // This doesn't make sense, if there is no selection
506 if (!cur.selection())
509 // OK, we have a selection. This is always between cur.selBegin()
512 if (cur.inTexted()) {
513 LyXText * text = cur.text();
516 // make sure that the depth behind the selection are restored, too
517 recordUndoSelection(cur);
518 pit_type begpit = cur.selBegin().pit();
519 pit_type endpit = cur.selEnd().pit();
521 int endpos = cur.selEnd().pos();
523 BufferParams const & bp = cur.buffer().params();
525 copySelectionHelper(cur.buffer(),
528 cur.selBegin().pos(), endpos,
529 bp.textclass, theCuts);
530 // Stuff what we got on the clipboard.
531 // Even if there is no selection.
532 putClipboard(theCuts[0].first, theCuts[0].second,
533 cur.selectionAsString(true));
536 boost::tie(endpit, endpos) =
537 eraseSelectionHelper(bp,
540 cur.selBegin().pos(), endpos,
543 // sometimes necessary
545 text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges);
547 // cutSelection can invalidate the cursor so we need to set
549 // we prefer the end for when tracking changes
553 // need a valid cursor. (Lgb)
554 cur.clearSelection();
555 updateLabels(cur.buffer());
556 theSelection().haveSelection(false);
558 // tell tabular that a recent copy happened
559 dirtyTabularStack(false);
562 if (cur.inMathed()) {
563 if (cur.selBegin().idx() != cur.selEnd().idx()) {
564 // The current selection spans more than one cell.
566 recordUndoInset(cur);
568 // Record only the current cell to avoid a jumping
579 void copySelection(LCursor & cur)
581 copySelection(cur, cur.selectionAsString(true));
587 void copySelectionToStack(LCursor & cur, CutStack & cutstack)
589 // this doesn't make sense, if there is no selection
590 if (!cur.selection())
593 if (cur.inTexted()) {
594 LyXText * text = cur.text();
596 // ok we have a selection. This is always between cur.selBegin()
597 // and sel_end cursor
599 // copy behind a space if there is one
600 ParagraphList & pars = text->paragraphs();
601 pos_type pos = cur.selBegin().pos();
602 pit_type par = cur.selBegin().pit();
603 while (pos < pars[par].size()
604 && pars[par].isLineSeparator(pos)
605 && (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
608 copySelectionHelper(cur.buffer(), pars, par, cur.selEnd().pit(),
609 pos, cur.selEnd().pos(), cur.buffer().params().textclass, cutstack);
612 if (cur.inMathed()) {
613 //lyxerr << "copySelection in mathed" << endl;
616 BufferParams const & bp = cur.buffer().params();
617 par.layout(bp.getLyXTextClass().defaultLayout());
618 par.insert(0, grabSelection(cur), LyXFont(), Change(Change::UNCHANGED));
620 cutstack.push(make_pair(pars, bp.textclass));
627 void copySelectionToStack()
629 if (!selectionBuffer.empty())
630 theCuts.push(selectionBuffer[0]);
634 void copySelection(LCursor & cur, docstring const & plaintext)
636 copySelectionToStack(cur, theCuts);
638 // stuff the selection onto the X clipboard, from an explicit copy request
639 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
643 void saveSelection(LCursor & cur)
645 lyxerr[Debug::ACTION] << "cap::saveSelection: `"
646 << to_utf8(cur.selectionAsString(true)) << "'." << endl;
649 copySelectionToStack(cur, selectionBuffer);
650 // tell X whether we now have a valid selection
651 theSelection().haveSelection(cur.selection());
657 return !selectionBuffer.empty();
661 void clearSelection()
663 selectionBuffer.clear();
667 docstring getSelection(Buffer const & buf, size_t sel_index)
669 return sel_index < theCuts.size()
670 ? theCuts[sel_index].first.back().asString(buf, false)
675 void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
676 textclass_type textclass, ErrorList & errorList)
678 if (cur.inTexted()) {
679 LyXText * text = cur.text();
685 boost::tie(ppp, endpit) =
686 pasteSelectionHelper(cur, parlist,
687 textclass, errorList);
688 updateLabels(cur.buffer());
689 cur.clearSelection();
690 text->setCursor(cur.top(), ppp.first, ppp.second);
693 // mathed is handled in InsetMathNest/InsetMathGrid
694 BOOST_ASSERT(!cur.inMathed());
698 void pasteFromStack(LCursor & cur, ErrorList & errorList, size_t sel_index)
700 // this does not make sense, if there is nothing to paste
701 if (!checkPastePossible(sel_index))
705 pasteParagraphList(cur, theCuts[sel_index].first,
706 theCuts[sel_index].second, errorList);
712 void pasteClipboard(LCursor & cur, ErrorList & errorList, bool asParagraphs)
714 // Use internal clipboard if it is the most recent one
715 if (theClipboard().isInternal()) {
716 pasteClipboard(cur, errorList, 0);
720 // First try LyX format
721 if (theClipboard().hasLyXContents()) {
722 string lyx = theClipboard().getAsLyX();
724 Buffer buffer(string(), false);
725 buffer.setUnnamed(true);
726 if (buffer.readString(lyx)) {
728 pasteParagraphList(cur, buffer.paragraphs(),
729 buffer.params().textclass, errorList);
736 // Then try plain text
737 docstring const text = theClipboard().getAsText();
742 cur.text()->insertStringAsParagraphs(cur, text);
744 cur.text()->insertStringAsLines(cur, text);
748 void pasteSelection(LCursor & cur, ErrorList & errorList)
750 if (selectionBuffer.empty())
753 pasteParagraphList(cur, selectionBuffer[0].first,
754 selectionBuffer[0].second, errorList);
759 void replaceSelectionWithString(LCursor & cur, docstring const & str, bool backwards)
762 DocIterator selbeg = cur.selectionBegin();
764 // Get font setting before we cut
766 selbeg.paragraph().getFontSettings(cur.buffer().params(), selbeg.pos());
768 // Insert the new string
769 pos_type pos = cur.selEnd().pos();
770 Paragraph & par = cur.selEnd().paragraph();
771 docstring::const_iterator cit = str.begin();
772 docstring::const_iterator end = str.end();
773 for (; cit != end; ++cit, ++pos)
774 par.insertChar(pos, *cit, font, cur.buffer().params().trackChanges);
777 cutSelection(cur, true, false);
779 // select the replacement
781 selbeg.pos() += str.length();
782 cur.setSelection(selbeg, -int(str.length()));
784 cur.setSelection(selbeg, str.length());
789 void replaceSelection(LCursor & cur)
792 cutSelection(cur, true, false);
796 void eraseSelection(LCursor & cur)
798 //lyxerr << "cap::eraseSelection begin: " << cur << endl;
799 CursorSlice const & i1 = cur.selBegin();
800 CursorSlice const & i2 = cur.selEnd();
801 if (i1.inset().asInsetMath()) {
803 if (i1.idx() == i2.idx()) {
804 i1.cell().erase(i1.pos(), i2.pos());
805 // We may have deleted i1.cell(cur.pos()).
806 // Make sure that pos is valid.
807 if (cur.pos() > cur.lastpos())
808 cur.pos() = cur.lastpos();
810 InsetMath * p = i1.asInsetMath();
811 InsetBase::row_type r1, r2;
812 InsetBase::col_type c1, c2;
813 region(i1, i2, r1, r2, c1, c2);
814 for (InsetBase::row_type row = r1; row <= r2; ++row)
815 for (InsetBase::col_type col = c1; col <= c2; ++col)
816 p->cell(p->index(row, col)).clear();
817 // We've deleted the whole cell. Only pos 0 is valid.
820 // need a valid cursor. (Lgb)
821 cur.clearSelection();
822 theSelection().haveSelection(false);
824 lyxerr << "can't erase this selection 1" << endl;
826 //lyxerr << "cap::eraseSelection end: " << cur << endl;
830 void selDel(LCursor & cur)
832 //lyxerr << "cap::selDel" << endl;
838 void selClearOrDel(LCursor & cur)
840 //lyxerr << "cap::selClearOrDel" << endl;
841 if (lyxrc.auto_region_delete)
844 cur.selection() = false;
848 docstring grabSelection(LCursor const & cur)
850 if (!cur.selection())
853 // FIXME: What is wrong with the following?
855 std::ostringstream os;
856 for (DocIterator dit = cur.selectionBegin();
857 dit != cur.selectionEnd(); dit.forwardPos())
858 os << asString(dit.cell());
862 CursorSlice i1 = cur.selBegin();
863 CursorSlice i2 = cur.selEnd();
865 if (i1.idx() == i2.idx()) {
866 if (i1.inset().asInsetMath()) {
867 MathArray::const_iterator it = i1.cell().begin();
868 return asString(MathArray(it + i1.pos(), it + i2.pos()));
870 return from_ascii("unknown selection 1");
874 InsetBase::row_type r1, r2;
875 InsetBase::col_type c1, c2;
876 region(i1, i2, r1, r2, c1, c2);
879 if (i1.inset().asInsetMath()) {
880 for (InsetBase::row_type row = r1; row <= r2; ++row) {
883 for (InsetBase::col_type col = c1; col <= c2; ++col) {
886 data += asString(i1.asInsetMath()->
887 cell(i1.asInsetMath()->index(row, col)));
891 data = from_ascii("unknown selection 2");
897 void dirtyTabularStack(bool b)
899 dirty_tabular_stack_ = b;
903 bool tabularStackDirty()
905 return dirty_tabular_stack_;