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 copy_pars(boost::next(pars.begin(), startpit),
356 boost::next(pars.begin(), endpit + 1));
358 // Remove the end of the last paragraph; afterwards, remove the beginning
359 // of the first paragraph. Keep this order - there may only be one paragraph!
360 // Do not track deletions here; this is an internal action not visible to the user
361 Paragraph & back = copy_pars.back();
362 back.eraseChars(end, back.size(), false);
363 Paragraph & front = copy_pars.front();
364 front.eraseChars(0, start, false);
366 ParagraphList::iterator it = copy_pars.begin();
367 ParagraphList::iterator it_end = copy_pars.end();
369 for (; it != it_end; it++) {
370 // ERT paragraphs have the Language latex_language.
371 // This is invalid outside of ERT, so we need to change it
372 // to the buffer language.
373 if (it->ownerCode() == InsetBase::ERT_CODE) {
374 it->changeLanguage(buf.params(), latex_language,
377 it->setInsetOwner(0);
380 // do not copy text (also nested in insets) which is marked as deleted
381 // acceptChanges() is defined for LyXText rather than ParagraphList
382 // Thus we must wrap copy_pars into a LyXText object and cross our fingers
384 copy_pars.swap(lt.paragraphs());
385 lt.acceptChanges(buf.params());
386 copy_pars.swap(lt.paragraphs());
388 cutstack.push(make_pair(copy_pars, tc));
398 docstring grabAndEraseSelection(LCursor & cur)
400 if (!cur.selection())
402 docstring res = grabSelection(cur);
408 void switchBetweenClasses(textclass_type c1, textclass_type c2,
409 InsetText & in, ErrorList & errorlist)
411 BOOST_ASSERT(!in.paragraphs().empty());
415 LyXTextClass const & tclass1 = textclasslist[c1];
416 LyXTextClass const & tclass2 = textclasslist[c2];
419 ParIterator end = par_iterator_end(in);
420 for (ParIterator it = par_iterator_begin(in); it != end; ++it) {
421 string const name = it->layout()->name();
422 bool hasLayout = tclass2.hasLayout(name);
425 it->layout(tclass2[name]);
427 it->layout(tclass2.defaultLayout());
429 if (!hasLayout && name != tclass1.defaultLayoutName()) {
430 docstring const s = bformat(
431 _("Layout had to be changed from\n%1$s to %2$s\n"
432 "because of class conversion from\n%3$s to %4$s"),
433 from_utf8(name), from_utf8(it->layout()->name()),
434 from_utf8(tclass1.name()), from_utf8(tclass2.name()));
435 // To warn the user that something had to be done.
436 errorlist.push_back(ErrorItem(_("Changed Layout"), s,
443 InsetIterator const i_end = inset_iterator_end(in);
444 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
445 if (it->lyxCode() == InsetBase::CHARSTYLE_CODE) {
446 InsetCharStyle & inset =
447 static_cast<InsetCharStyle &>(*it);
448 string const name = inset.params().type;
449 CharStyles::iterator const found_cs =
450 tclass2.charstyle(name);
451 if (found_cs == tclass2.charstyles().end()) {
452 // The character style is undefined in tclass2
453 inset.setUndefined();
454 docstring const s = bformat(_(
455 "Character style %1$s is "
456 "undefined because of class "
457 "conversion from\n%2$s to %3$s"),
458 from_utf8(name), from_utf8(tclass1.name()),
459 from_utf8(tclass2.name()));
460 // To warn the user that something had to be done.
461 errorlist.push_back(ErrorItem(
462 _("Undefined character style"),
463 s, it.paragraph().id(), it.pos(), it.pos() + 1));
464 } else if (inset.undefined()) {
465 // The character style is undefined in
466 // tclass1 and is defined in tclass2
467 inset.setDefined(found_cs);
474 std::vector<docstring> const availableSelections(Buffer const & buffer)
476 vector<docstring> selList;
478 CutStack::const_iterator cit = theCuts.begin();
479 CutStack::const_iterator end = theCuts.end();
480 for (; cit != end; ++cit) {
481 // we do not use cit-> here because gcc 2.9x does not
483 ParagraphList const & pars = (*cit).first;
485 ParagraphList::const_iterator pit = pars.begin();
486 ParagraphList::const_iterator pend = pars.end();
487 for (; pit != pend; ++pit) {
488 asciiSel += pit->asString(buffer, false);
489 if (asciiSel.size() > 25) {
490 asciiSel.replace(22, docstring::npos,
496 selList.push_back(asciiSel);
503 size_type numberOfSelections()
505 return theCuts.size();
509 void cutSelection(LCursor & cur, bool doclear, bool realcut)
511 // This doesn't make sense, if there is no selection
512 if (!cur.selection())
515 // OK, we have a selection. This is always between cur.selBegin()
518 if (cur.inTexted()) {
519 LyXText * text = cur.text();
522 // make sure that the depth behind the selection are restored, too
523 recordUndoSelection(cur);
524 pit_type begpit = cur.selBegin().pit();
525 pit_type endpit = cur.selEnd().pit();
527 int endpos = cur.selEnd().pos();
529 BufferParams const & bp = cur.buffer().params();
531 copySelectionHelper(cur.buffer(),
534 cur.selBegin().pos(), endpos,
535 bp.textclass, theCuts);
536 // Stuff what we got on the clipboard.
537 // Even if there is no selection.
538 putClipboard(theCuts[0].first, theCuts[0].second,
539 cur.selectionAsString(true));
542 boost::tie(endpit, endpos) =
543 eraseSelectionHelper(bp,
546 cur.selBegin().pos(), endpos,
549 // cutSelection can invalidate the cursor so we need to set
551 // we prefer the end for when tracking changes
555 // sometimes necessary
557 && text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges))
560 // need a valid cursor. (Lgb)
561 cur.clearSelection();
562 updateLabels(cur.buffer());
563 theSelection().haveSelection(false);
565 // tell tabular that a recent copy happened
566 dirtyTabularStack(false);
569 if (cur.inMathed()) {
570 if (cur.selBegin().idx() != cur.selEnd().idx()) {
571 // The current selection spans more than one cell.
573 recordUndoInset(cur);
575 // Record only the current cell to avoid a jumping
586 void copySelection(LCursor & cur)
588 copySelection(cur, cur.selectionAsString(true));
594 void copySelectionToStack(LCursor & cur, CutStack & cutstack)
596 // this doesn't make sense, if there is no selection
597 if (!cur.selection())
600 if (cur.inTexted()) {
601 LyXText * text = cur.text();
603 // ok we have a selection. This is always between cur.selBegin()
604 // and sel_end cursor
606 // copy behind a space if there is one
607 ParagraphList & pars = text->paragraphs();
608 pos_type pos = cur.selBegin().pos();
609 pit_type par = cur.selBegin().pit();
610 while (pos < pars[par].size()
611 && pars[par].isLineSeparator(pos)
612 && (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
615 copySelectionHelper(cur.buffer(), pars, par, cur.selEnd().pit(),
616 pos, cur.selEnd().pos(), cur.buffer().params().textclass, cutstack);
619 if (cur.inMathed()) {
620 //lyxerr << "copySelection in mathed" << endl;
623 BufferParams const & bp = cur.buffer().params();
624 par.layout(bp.getLyXTextClass().defaultLayout());
625 par.insert(0, grabSelection(cur), LyXFont(), Change(Change::UNCHANGED));
627 cutstack.push(make_pair(pars, bp.textclass));
634 void copySelectionToStack()
636 if (!selectionBuffer.empty())
637 theCuts.push(selectionBuffer[0]);
641 void copySelection(LCursor & cur, docstring const & plaintext)
643 copySelectionToStack(cur, theCuts);
645 // stuff the selection onto the X clipboard, from an explicit copy request
646 putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
650 void saveSelection(LCursor & cur)
652 lyxerr[Debug::ACTION] << "cap::saveSelection: `"
653 << to_utf8(cur.selectionAsString(true)) << "'." << endl;
656 copySelectionToStack(cur, selectionBuffer);
657 // tell X whether we now have a valid selection
658 theSelection().haveSelection(cur.selection());
664 return !selectionBuffer.empty();
668 void clearSelection()
670 selectionBuffer.clear();
674 docstring getSelection(Buffer const & buf, size_t sel_index)
676 return sel_index < theCuts.size()
677 ? theCuts[sel_index].first.back().asString(buf, false)
682 void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
683 textclass_type textclass, ErrorList & errorList)
685 if (cur.inTexted()) {
686 LyXText * text = cur.text();
692 boost::tie(ppp, endpit) =
693 pasteSelectionHelper(cur, parlist,
694 textclass, errorList);
695 updateLabels(cur.buffer());
696 cur.clearSelection();
697 text->setCursor(cur.top(), ppp.first, ppp.second);
700 // mathed is handled in InsetMathNest/InsetMathGrid
701 BOOST_ASSERT(!cur.inMathed());
705 void pasteFromStack(LCursor & cur, ErrorList & errorList, size_t sel_index)
707 // this does not make sense, if there is nothing to paste
708 if (!checkPastePossible(sel_index))
712 pasteParagraphList(cur, theCuts[sel_index].first,
713 theCuts[sel_index].second, errorList);
719 void pasteClipboard(LCursor & cur, ErrorList & errorList, bool asParagraphs)
721 // Use internal clipboard if it is the most recent one
722 if (theClipboard().isInternal()) {
723 pasteClipboard(cur, errorList, 0);
727 // First try LyX format
728 if (theClipboard().hasLyXContents()) {
729 string lyx = theClipboard().getAsLyX();
731 Buffer buffer(string(), false);
732 buffer.setUnnamed(true);
733 if (buffer.readString(lyx)) {
735 pasteParagraphList(cur, buffer.paragraphs(),
736 buffer.params().textclass, errorList);
743 // Then try plain text
744 docstring const text = theClipboard().getAsText();
749 cur.text()->insertStringAsParagraphs(cur, text);
751 cur.text()->insertStringAsLines(cur, text);
755 void pasteSelection(LCursor & cur, ErrorList & errorList)
757 if (selectionBuffer.empty())
760 pasteParagraphList(cur, selectionBuffer[0].first,
761 selectionBuffer[0].second, errorList);
766 void replaceSelectionWithString(LCursor & cur, docstring const & str, bool backwards)
769 DocIterator selbeg = cur.selectionBegin();
771 // Get font setting before we cut
773 selbeg.paragraph().getFontSettings(cur.buffer().params(), selbeg.pos());
775 // Insert the new string
776 pos_type pos = cur.selEnd().pos();
777 Paragraph & par = cur.selEnd().paragraph();
778 docstring::const_iterator cit = str.begin();
779 docstring::const_iterator end = str.end();
780 for (; cit != end; ++cit, ++pos)
781 par.insertChar(pos, *cit, font, cur.buffer().params().trackChanges);
784 cutSelection(cur, true, false);
786 // select the replacement
788 selbeg.pos() += str.length();
789 cur.setSelection(selbeg, -int(str.length()));
791 cur.setSelection(selbeg, str.length());
796 void replaceSelection(LCursor & cur)
799 cutSelection(cur, true, false);
803 void eraseSelection(LCursor & cur)
805 //lyxerr << "cap::eraseSelection begin: " << cur << endl;
806 CursorSlice const & i1 = cur.selBegin();
807 CursorSlice const & i2 = cur.selEnd();
808 if (i1.inset().asInsetMath()) {
810 if (i1.idx() == i2.idx()) {
811 i1.cell().erase(i1.pos(), i2.pos());
812 // We may have deleted i1.cell(cur.pos()).
813 // Make sure that pos is valid.
814 if (cur.pos() > cur.lastpos())
815 cur.pos() = cur.lastpos();
817 InsetMath * p = i1.asInsetMath();
818 InsetBase::row_type r1, r2;
819 InsetBase::col_type c1, c2;
820 region(i1, i2, r1, r2, c1, c2);
821 for (InsetBase::row_type row = r1; row <= r2; ++row)
822 for (InsetBase::col_type col = c1; col <= c2; ++col)
823 p->cell(p->index(row, col)).clear();
824 // We've deleted the whole cell. Only pos 0 is valid.
827 // need a valid cursor. (Lgb)
828 cur.clearSelection();
829 theSelection().haveSelection(false);
831 lyxerr << "can't erase this selection 1" << endl;
833 //lyxerr << "cap::eraseSelection end: " << cur << endl;
837 void selDel(LCursor & cur)
839 //lyxerr << "cap::selDel" << endl;
845 void selClearOrDel(LCursor & cur)
847 //lyxerr << "cap::selClearOrDel" << endl;
848 if (lyxrc.auto_region_delete)
851 cur.selection() = false;
855 docstring grabSelection(LCursor const & cur)
857 if (!cur.selection())
860 // FIXME: What is wrong with the following?
862 std::ostringstream os;
863 for (DocIterator dit = cur.selectionBegin();
864 dit != cur.selectionEnd(); dit.forwardPos())
865 os << asString(dit.cell());
869 CursorSlice i1 = cur.selBegin();
870 CursorSlice i2 = cur.selEnd();
872 if (i1.idx() == i2.idx()) {
873 if (i1.inset().asInsetMath()) {
874 MathArray::const_iterator it = i1.cell().begin();
875 return asString(MathArray(it + i1.pos(), it + i2.pos()));
877 return from_ascii("unknown selection 1");
881 InsetBase::row_type r1, r2;
882 InsetBase::col_type c1, c2;
883 region(i1, i2, r1, r2, c1, c2);
886 if (i1.inset().asInsetMath()) {
887 for (InsetBase::row_type row = r1; row <= r2; ++row) {
890 for (InsetBase::col_type col = c1; col <= c2; ++col) {
893 data += asString(i1.asInsetMath()->
894 cell(i1.asInsetMath()->index(row, col)));
898 data = from_ascii("unknown selection 2");
904 void dirtyTabularStack(bool b)
906 dirty_tabular_stack_ = b;
910 bool tabularStackDirty()
912 return dirty_tabular_stack_;