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
10 * Full author contact details are available in file CREDITS.
15 #include "CutAndPaste.h"
18 #include "buffer_funcs.h"
19 #include "bufferparams.h"
22 #include "errorlist.h"
23 #include "funcrequest.h"
25 #include "insetiterator.h"
30 #include "lyxtextclasslist.h"
31 #include "paragraph.h"
32 #include "paragraph_funcs.h"
33 #include "ParagraphParameters.h"
34 #include "ParagraphList_fwd.h"
35 #include "pariterator.h"
38 #include "insets/insetcharstyle.h"
39 #include "insets/insettabular.h"
41 #include "mathed/MathData.h"
42 #include "mathed/InsetMath.h"
43 #include "mathed/MathSupport.h"
45 #include "support/lstrings.h"
47 #include "frontends/Clipboard.h"
49 #include <boost/tuple/tuple.hpp>
54 using support::bformat;
55 using frontend::Clipboard;
67 typedef std::pair<pit_type, int> PitPosPair;
69 typedef limited_stack<pair<ParagraphList, textclass_type> > CutStack;
73 // store whether the tabular stack is newer than the normal copy stack
74 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
75 // when we (hopefully) have a one-for-all paste mechanism.
76 bool dirty_tabular_stack_;
78 class resetParagraph : public std::unary_function<Paragraph, Buffer const &> {
80 resetParagraph(Buffer const & b) : buffer_(b) {}
81 void operator()(Paragraph & p) const {
82 // FIXME: change tracking (MG)
83 // set p's text to INSERTED in CT mode; clear CT info otherwise
85 // ERT paragraphs have the Language latex_language.
86 // This is invalid outside of ERT, so we need to change it
87 // to the buffer language.
88 if (p.ownerCode() == InsetBase::ERT_CODE) {
89 p.changeLanguage(buffer_.params(), latex_language,
90 buffer_.getLanguage());
95 Buffer const & buffer_;
99 void region(CursorSlice const & i1, CursorSlice const & i2,
100 InsetBase::row_type & r1, InsetBase::row_type & r2,
101 InsetBase::col_type & c1, InsetBase::col_type & c2)
103 InsetBase & p = i1.inset();
104 c1 = p.col(i1.idx());
105 c2 = p.col(i2.idx());
108 r1 = p.row(i1.idx());
109 r2 = p.row(i2.idx());
115 bool checkPastePossible(int index)
117 return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
121 pair<PitPosPair, pit_type>
122 pasteSelectionHelper(LCursor & cur, ParagraphList const & parlist,
123 textclass_type textclass, ErrorList & errorlist)
125 Buffer const & buffer = cur.buffer();
126 pit_type pit = cur.pit();
127 pos_type pos = cur.pos();
128 ParagraphList & pars = cur.text()->paragraphs();
131 return make_pair(PitPosPair(pit, pos), pit);
133 BOOST_ASSERT (pos <= pars[pit].size());
135 // Make a copy of the CaP paragraphs.
136 ParagraphList insertion = parlist;
137 textclass_type const tc = buffer.params().textclass;
139 // Now remove all out of the pars which is NOT allowed in the
140 // new environment and set also another font if that is required.
142 // Convert newline to paragraph break in ERT inset.
143 // This should not be here!
144 if (pars[pit].inInset() &&
145 pars[pit].inInset()->lyxCode() == InsetBase::ERT_CODE) {
146 for (ParagraphList::size_type i = 0; i < insertion.size(); ++i) {
147 for (pos_type j = 0; j < insertion[i].size(); ++j) {
148 if (insertion[i].isNewline(j)) {
149 // do not track deletion of newline
150 insertion[i].eraseChar(j, false);
151 breakParagraphConservative(
159 // If we are in an inset which returns forceDefaultParagraphs,
160 // set the paragraphs to default
161 if (cur.inset().forceDefaultParagraphs(cur.idx())) {
162 LyXLayout_ptr const layout =
163 buffer.params().getLyXTextClass().defaultLayout();
164 ParagraphList::iterator const end = insertion.end();
165 for (ParagraphList::iterator par = insertion.begin();
170 // Make sure there is no class difference.
172 // This works without copying any paragraph data because we have
173 // a specialized swap method for ParagraphList. This is important
174 // since we store pointers to insets at some places and we don't
175 // want to invalidate them.
176 insertion.swap(in.paragraphs());
177 cap::switchBetweenClasses(textclass, tc, in, errorlist);
178 insertion.swap(in.paragraphs());
180 ParagraphList::iterator tmpbuf = insertion.begin();
181 int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
183 depth_type max_depth = pars[pit].getMaxDepthAfter();
185 for (; tmpbuf != insertion.end(); ++tmpbuf) {
186 // If we have a negative jump so that the depth would
187 // go below 0 depth then we have to redo the delta to
188 // this new max depth level so that subsequent
189 // paragraphs are aligned correctly to this paragraph
191 if (int(tmpbuf->params().depth()) + depth_delta < 0)
194 // Set the right depth so that we are not too deep or shallow.
195 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
196 if (tmpbuf->params().depth() > max_depth)
197 tmpbuf->params().depth(max_depth);
199 // Only set this from the 2nd on as the 2nd depends
200 // for maxDepth still on pit.
201 if (tmpbuf != insertion.begin())
202 max_depth = tmpbuf->getMaxDepthAfter();
204 // Set the inset owner of this paragraph.
205 tmpbuf->setInsetOwner(pars[pit].inInset());
206 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
207 if (tmpbuf->getChar(i) == Paragraph::META_INSET &&
208 !pars[pit].insetAllowed(tmpbuf->getInset(i)->lyxCode()))
209 // do not track deletion of invalid insets
210 tmpbuf->eraseChar(i--, false);
213 // FIXME: Change tracking (MG)
214 // set tmpbuf's text to INSERTED in CT mode; clear CT info otherwise
217 bool const empty = pars[pit].empty();
219 // Make the buf exactly the same layout as the cursor
221 insertion.begin()->makeSameLayout(pars[pit]);
224 // Prepare the paragraphs and insets for insertion.
225 // A couple of insets store buffer references so need updating.
226 insertion.swap(in.paragraphs());
228 ParIterator fpit = par_iterator_begin(in);
229 ParIterator fend = par_iterator_end(in);
231 for (; fpit != fend; ++fpit) {
232 InsetList::iterator lit = fpit->insetlist.begin();
233 InsetList::iterator eit = fpit->insetlist.end();
235 for (; lit != eit; ++lit) {
236 switch (lit->inset->lyxCode()) {
237 case InsetBase::TABULAR_CODE: {
238 InsetTabular * it = static_cast<InsetTabular*>(lit->inset);
248 insertion.swap(in.paragraphs());
250 // Split the paragraph for inserting the buf if necessary.
252 breakParagraphConservative(buffer.params(), pars, pit, pos);
256 pars.insert(boost::next(pars.begin(), pit),
260 // merge the empty par with the last par of the insertion
261 mergeParagraph(buffer.params(), pars,
262 pit + insertion.size() - 1);
264 pars.insert(boost::next(pars.begin(), pit + 1),
268 // merge the first par of the insertion with the current par
269 mergeParagraph(buffer.params(), pars, pit);
272 pit_type last_paste = pit + insertion.size() - 1;
274 // Store the new cursor position.
276 pos = pars[last_paste].size();
278 // Join (conditionally) last pasted paragraph with next one, i.e.,
279 // the tail of the spliced document paragraph
280 if (!empty && last_paste + 1 != pit_type(pars.size())) {
281 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
282 mergeParagraph(buffer.params(), pars, last_paste);
283 } else if (pars[last_paste + 1].empty()) {
284 pars[last_paste + 1].makeSameLayout(pars[last_paste]);
285 mergeParagraph(buffer.params(), pars, last_paste);
286 } else if (pars[last_paste].empty()) {
287 pars[last_paste].makeSameLayout(pars[last_paste + 1]);
288 mergeParagraph(buffer.params(), pars, last_paste);
290 pars[last_paste + 1].stripLeadingSpaces();
295 return make_pair(PitPosPair(pit, pos), last_paste + 1);
299 PitPosPair eraseSelectionHelper(BufferParams const & params,
300 ParagraphList & pars,
301 pit_type startpit, pit_type endpit,
302 int startpos, int endpos, bool doclear)
304 // Start of selection is really invalid.
305 if (startpit == pit_type(pars.size()) ||
306 (startpos > pars[startpit].size()))
307 return PitPosPair(endpit, endpos);
309 // Start and end is inside same paragraph
310 if (endpit == pit_type(pars.size()) || startpit == endpit) {
311 endpos -= pars[startpit].eraseChars(startpos, endpos, params.trackChanges);
312 return PitPosPair(endpit, endpos);
315 // A paragraph break has to be physically removed by merging, but
316 // only if either (1) change tracking is off, or (2) the para break
318 for (pit_type pit = startpit; pit != endpit + 1;) {
319 // FIXME: Change tracking (MG)
320 bool const merge = !params.trackChanges ||
321 pars[pit].isInserted(pars[pit].size());
322 pos_type const left = ( pit == startpit ? startpos : 0 );
323 pos_type const right = ( pit == endpit ? endpos :
324 pars[pit].size() + 1 );
325 // Logical erase only:
326 pars[pit].eraseChars(left, right, false);
327 // Separate handling of para break:
328 if (merge && pit != endpit &&
329 (pit + 1 != endpit || pars[pit].hasSameLayout(pars[pit + 1]))) {
330 pos_type const thissize = pars[pit].size();
332 pars[pit + 1].stripLeadingSpaces();
333 mergeParagraph(params, pars, pit);
341 // Ensure legal cursor pos:
344 return PitPosPair(endpit, endpos);
348 void copySelectionHelper(Buffer const & buf, ParagraphList & pars,
349 pit_type startpit, pit_type endpit,
350 int start, int end, textclass_type tc)
352 BOOST_ASSERT(0 <= start && start <= pars[startpit].size());
353 BOOST_ASSERT(0 <= end && end <= pars[endpit].size());
354 BOOST_ASSERT(startpit != endpit || start <= end);
356 // Clone the paragraphs within the selection.
357 ParagraphList paragraphs(boost::next(pars.begin(), startpit),
358 boost::next(pars.begin(), endpit + 1));
360 for_each(paragraphs.begin(), paragraphs.end(), resetParagraph(buf));
362 // Cut out the end of the last paragraph.
363 Paragraph & back = paragraphs.back();
364 // do not track deletion here; it is an internal action not visible to the user
365 back.eraseChars(end, back.size(), false);
367 // Cut out the begin of the first paragraph
368 Paragraph & front = paragraphs.front();
369 // again, do not track deletion
370 front.eraseChars(0, start, false);
372 theCuts.push(make_pair(paragraphs, tc));
382 docstring grabAndEraseSelection(LCursor & cur)
384 if (!cur.selection())
386 docstring res = grabSelection(cur);
392 void switchBetweenClasses(textclass_type c1, textclass_type c2,
393 InsetText & in, ErrorList & errorlist)
395 BOOST_ASSERT(!in.paragraphs().empty());
399 LyXTextClass const & tclass1 = textclasslist[c1];
400 LyXTextClass const & tclass2 = textclasslist[c2];
403 ParIterator end = par_iterator_end(in);
404 for (ParIterator it = par_iterator_begin(in); it != end; ++it) {
405 string const name = it->layout()->name();
406 bool hasLayout = tclass2.hasLayout(name);
409 it->layout(tclass2[name]);
411 it->layout(tclass2.defaultLayout());
413 if (!hasLayout && name != tclass1.defaultLayoutName()) {
414 docstring const s = bformat(
415 _("Layout had to be changed from\n%1$s to %2$s\n"
416 "because of class conversion from\n%3$s to %4$s"),
417 from_utf8(name), from_utf8(it->layout()->name()),
418 from_utf8(tclass1.name()), from_utf8(tclass2.name()));
419 // To warn the user that something had to be done.
420 errorlist.push_back(ErrorItem(_("Changed Layout"), s,
427 InsetIterator const i_end = inset_iterator_end(in);
428 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
429 if (it->lyxCode() == InsetBase::CHARSTYLE_CODE) {
430 InsetCharStyle & inset =
431 static_cast<InsetCharStyle &>(*it);
432 string const name = inset.params().type;
433 CharStyles::iterator const found_cs =
434 tclass2.charstyle(name);
435 if (found_cs == tclass2.charstyles().end()) {
436 // The character style is undefined in tclass2
437 inset.setUndefined();
438 docstring const s = bformat(_(
439 "Character style %1$s is "
440 "undefined because of class "
441 "conversion from\n%2$s to %3$s"),
442 from_utf8(name), from_utf8(tclass1.name()),
443 from_utf8(tclass2.name()));
444 // To warn the user that something had to be done.
445 errorlist.push_back(ErrorItem(
446 _("Undefined character style"),
447 s, it.paragraph().id(), it.pos(), it.pos() + 1));
448 } else if (inset.undefined()) {
449 // The character style is undefined in
450 // tclass1 and is defined in tclass2
451 inset.setDefined(found_cs);
458 std::vector<docstring> const availableSelections(Buffer const & buffer)
460 vector<docstring> selList;
462 CutStack::const_iterator cit = theCuts.begin();
463 CutStack::const_iterator end = theCuts.end();
464 for (; cit != end; ++cit) {
465 // we do not use cit-> here because gcc 2.9x does not
467 ParagraphList const & pars = (*cit).first;
469 ParagraphList::const_iterator pit = pars.begin();
470 ParagraphList::const_iterator pend = pars.end();
471 for (; pit != pend; ++pit) {
472 asciiSel += pit->asString(buffer, false);
473 if (asciiSel.size() > 25) {
474 asciiSel.replace(22, docstring::npos,
480 selList.push_back(asciiSel);
487 size_type numberOfSelections()
489 return theCuts.size();
493 void cutSelection(LCursor & cur, bool doclear, bool realcut)
495 // This doesn't make sense, if there is no selection
496 if (!cur.selection())
499 // OK, we have a selection. This is always between cur.selBegin()
502 if (cur.inTexted()) {
503 LyXText * text = cur.text();
505 // Stuff what we got on the clipboard. Even if there is no selection.
507 // There is a problem with having the stuffing here in that the
508 // larger the selection the slower LyX will get. This can be
509 // solved by running the line below only when the selection has
510 // finished. The solution used currently just works, to make it
511 // faster we need to be more clever and probably also have more
512 // calls to theSelection().put. (Lgb)
513 // theSelection().put(cur.selectionAsString(true));
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,
532 boost::tie(endpit, endpos) =
533 eraseSelectionHelper(bp,
536 cur.selBegin().pos(), endpos,
539 // sometimes necessary
541 text->paragraphs()[begpit].stripLeadingSpaces();
543 // cutSelection can invalidate the cursor so we need to set
545 // we prefer the end for when tracking changes
549 // need a valid cursor. (Lgb)
550 cur.clearSelection();
551 updateLabels(cur.buffer());
553 // tell tabular that a recent copy happened
554 dirtyTabularStack(false);
557 if (cur.inMathed()) {
558 if (cur.selBegin().idx() != cur.selEnd().idx()) {
559 // The current selection spans more than one cell.
561 recordUndoInset(cur);
563 // Record only the current cell to avoid a jumping
574 void copySelection(LCursor & cur)
576 // stuff the selection onto the X clipboard, from an explicit copy request
577 theClipboard().put(cur.selectionAsString(true));
579 // this doesn't make sense, if there is no selection
580 if (!cur.selection())
583 if (cur.inTexted()) {
584 LyXText * text = cur.text();
586 // ok we have a selection. This is always between cur.selBegin()
587 // and sel_end cursor
589 // copy behind a space if there is one
590 ParagraphList & pars = text->paragraphs();
591 pos_type pos = cur.selBegin().pos();
592 pit_type par = cur.selBegin().pit();
593 while (pos < pars[par].size()
594 && pars[par].isLineSeparator(pos)
595 && (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
598 copySelectionHelper(cur.buffer(), pars, par, cur.selEnd().pit(),
599 pos, cur.selEnd().pos(), cur.buffer().params().textclass);
602 if (cur.inMathed()) {
603 //lyxerr << "copySelection in mathed" << endl;
605 pars.push_back(Paragraph());
606 BufferParams const & bp = cur.buffer().params();
607 pars.back().layout(bp.getLyXTextClass().defaultLayout());
608 for_each(pars.begin(), pars.end(), resetParagraph(cur.buffer()));
609 // FIXME: change tracking (MG)
610 pars.back().insert(0, grabSelection(cur), LyXFont(), Change(Change::UNCHANGED));
611 theCuts.push(make_pair(pars, bp.textclass));
613 // tell tabular that a recent copy happened
614 dirtyTabularStack(false);
618 docstring getSelection(Buffer const & buf, size_t sel_index)
620 return sel_index < theCuts.size()
621 ? theCuts[sel_index].first.back().asString(buf, false)
626 void pasteParagraphList(LCursor & cur, ParagraphList const & parlist,
627 textclass_type textclass, ErrorList & errorList)
629 if (cur.inTexted()) {
630 LyXText * text = cur.text();
638 boost::tie(ppp, endpit) =
639 pasteSelectionHelper(cur, parlist,
640 textclass, errorList);
641 updateLabels(cur.buffer());
642 cur.clearSelection();
643 text->setCursor(cur, ppp.first, ppp.second);
646 // mathed is handled in InsetMathNest/InsetMathGrid
647 BOOST_ASSERT(!cur.inMathed());
651 void pasteSelection(LCursor & cur, ErrorList & errorList, size_t sel_index)
653 // this does not make sense, if there is nothing to paste
654 if (!checkPastePossible(sel_index))
657 pasteParagraphList(cur, theCuts[sel_index].first,
658 theCuts[sel_index].second, errorList);
663 // simple replacing. The font of the first selected character is used
664 void replaceSelectionWithString(LCursor & cur, string const & str, bool backwards)
667 DocIterator selbeg = cur.selectionBegin();
669 // Get font setting before we cut
671 selbeg.paragraph().getFontSettings(cur.buffer().params(), selbeg.pos());
673 // Insert the new string
674 pos_type pos = cur.selEnd().pos();
675 Paragraph & par = cur.selEnd().paragraph();
676 string::const_iterator cit = str.begin();
677 string::const_iterator end = str.end();
678 for (; cit != end; ++cit, ++pos)
679 par.insertChar(pos, (*cit), font, cur.buffer().params().trackChanges);
682 cutSelection(cur, true, false);
684 // select the replacement
686 selbeg.pos() += str.length();
687 cur.setSelection(selbeg, -int(str.length()));
689 cur.setSelection(selbeg, str.length());
693 void replaceSelection(LCursor & cur)
696 cutSelection(cur, true, false);
700 void eraseSelection(LCursor & cur)
702 //lyxerr << "LCursor::eraseSelection begin: " << cur << endl;
703 CursorSlice const & i1 = cur.selBegin();
704 CursorSlice const & i2 = cur.selEnd();
705 if (i1.inset().asInsetMath()) {
707 if (i1.idx() == i2.idx()) {
708 i1.cell().erase(i1.pos(), i2.pos());
709 // We may have deleted i1.cell(cur.pos()).
710 // Make sure that pos is valid.
711 if (cur.pos() > cur.lastpos())
712 cur.pos() = cur.lastpos();
714 InsetMath * p = i1.asInsetMath();
715 InsetBase::row_type r1, r2;
716 InsetBase::col_type c1, c2;
717 region(i1, i2, r1, r2, c1, c2);
718 for (InsetBase::row_type row = r1; row <= r2; ++row)
719 for (InsetBase::col_type col = c1; col <= c2; ++col)
720 p->cell(p->index(row, col)).clear();
721 // We've deleted the whole cell. Only pos 0 is valid.
724 // need a valid cursor. (Lgb)
725 cur.clearSelection();
727 lyxerr << "can't erase this selection 1" << endl;
729 //lyxerr << "LCursor::eraseSelection end: " << cur << endl;
733 void selDel(LCursor & cur)
735 //lyxerr << "LCursor::selDel" << endl;
741 void selClearOrDel(LCursor & cur)
743 //lyxerr << "LCursor::selClearOrDel" << endl;
744 if (lyxrc.auto_region_delete)
747 cur.selection() = false;
751 docstring grabSelection(LCursor const & cur)
753 if (!cur.selection())
756 // FIXME: What is wrong with the following?
758 std::ostringstream os;
759 for (DocIterator dit = cur.selectionBegin();
760 dit != cur.selectionEnd(); dit.forwardPos())
761 os << asString(dit.cell());
765 CursorSlice i1 = cur.selBegin();
766 CursorSlice i2 = cur.selEnd();
768 if (i1.idx() == i2.idx()) {
769 if (i1.inset().asInsetMath()) {
770 MathArray::const_iterator it = i1.cell().begin();
771 return asString(MathArray(it + i1.pos(), it + i2.pos()));
773 return from_ascii("unknown selection 1");
777 InsetBase::row_type r1, r2;
778 InsetBase::col_type c1, c2;
779 region(i1, i2, r1, r2, c1, c2);
782 if (i1.inset().asInsetMath()) {
783 for (InsetBase::row_type row = r1; row <= r2; ++row) {
786 for (InsetBase::col_type col = c1; col <= c2; ++col) {
789 data += asString(i1.asInsetMath()->
790 cell(i1.asInsetMath()->index(row, col)));
794 data = from_ascii("unknown selection 2");
800 void dirtyTabularStack(bool b)
802 dirty_tabular_stack_ = b;
806 bool tabularStackDirty()
808 return dirty_tabular_stack_;