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"
20 #include "BufferView.h"
23 #include "errorlist.h"
24 #include "funcrequest.h"
26 #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/math_data.h"
42 #include "mathed/math_inset.h"
43 #include "mathed/math_support.h"
45 #include "support/lstrings.h"
47 #include <boost/tuple/tuple.hpp>
51 using lyx::textclass_type;
53 using lyx::support::bformat;
65 typedef std::pair<lyx::pit_type, int> PitPosPair;
67 typedef limited_stack<pair<ParagraphList, textclass_type> > CutStack;
71 class resetOwnerAndChanges : public std::unary_function<Paragraph, void> {
73 void operator()(Paragraph & p) const {
80 void region(CursorSlice const & i1, CursorSlice const & i2,
81 InsetBase::row_type & r1, InsetBase::row_type & r2,
82 InsetBase::col_type & c1, InsetBase::col_type & c2)
84 InsetBase & p = i1.inset();
96 bool checkPastePossible(int index)
98 return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
102 void pasteSelectionHelper(LCursor & cur, size_t cut_index)
105 Buffer const & buffer = cur.buffer();
106 InsetText & inset = static_cast<InsetText &>(cur.inset());
107 pit_type pit = cur.pit();
108 pos_type pos = cur.pos();
109 pit_type endpit = pit;
110 textclass_type const & tc = buffer.params().textclass;
113 if (checkPastePossible(cut_index)) {
114 ParagraphList & pars = inset.paragraphs();
115 BOOST_ASSERT (pos <= pars[pit].size());
117 // Make a copy of the CaP paragraphs.
118 ParagraphList insertion = theCuts[cut_index].first;
119 textclass_type const textclass = theCuts[cut_index].second;
121 // Now remove all out of the pars which is NOT allowed in the
122 // new environment and set also another font if that is required.
124 // Convert newline to paragraph break in ERT inset.
125 // This should not be here!
126 if (pars[pit].inInset() &&
127 pars[pit].inInset()->lyxCode() == InsetBase::ERT_CODE) {
128 for (ParagraphList::size_type i = 0; i < insertion.size(); ++i) {
129 for (pos_type j = 0; j < insertion[i].size(); ++j) {
130 if (insertion[i].isNewline(j)) {
131 insertion[i].erase(j);
132 breakParagraphConservative(
140 // Make sure there is no class difference.
141 lyx::cap::SwitchBetweenClasses(textclass, tc, insertion, errorlist);
143 ParagraphList::iterator tmpbuf = insertion.begin();
144 int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
146 Paragraph::depth_type max_depth = pars[pit].getMaxDepthAfter();
148 for (; tmpbuf != insertion.end(); ++tmpbuf) {
149 // If we have a negative jump so that the depth would
150 // go below 0 depth then we have to redo the delta to
151 // this new max depth level so that subsequent
152 // paragraphs are aligned correctly to this paragraph
154 if (int(tmpbuf->params().depth()) + depth_delta < 0)
157 // Set the right depth so that we are not too deep or shallow.
158 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
159 if (tmpbuf->params().depth() > max_depth)
160 tmpbuf->params().depth(max_depth);
162 // Only set this from the 2nd on as the 2nd depends
163 // for maxDepth still on pit.
164 if (tmpbuf != insertion.begin())
165 max_depth = tmpbuf->getMaxDepthAfter();
167 // Set the inset owner of this paragraph.
168 tmpbuf->setInsetOwner(pars[pit].inInset());
169 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
170 if (tmpbuf->getChar(i) == Paragraph::META_INSET &&
171 !inset.insetAllowed(tmpbuf->getInset(i)->lyxCode()))
176 bool const empty = pars[pit].empty();
178 // Make the buf exactly the same layout as the cursor
180 insertion.begin()->makeSameLayout(pars[pit]);
183 // Prepare the paragraphs and insets for insertion.
184 // A couple of insets store buffer references so need updating.
186 std::swap(in.paragraphs(), insertion);
188 ParIterator fpit = par_iterator_begin(in);
189 ParIterator fend = par_iterator_end(in);
191 for (; fpit != fend; ++fpit) {
192 InsetList::iterator lit = fpit->insetlist.begin();
193 InsetList::iterator eit = fpit->insetlist.end();
195 for (; lit != eit; ++lit) {
196 switch (lit->inset->lyxCode()) {
197 case InsetBase::TABULAR_CODE: {
198 InsetTabular * it = static_cast<InsetTabular*>(lit->inset);
208 std::swap(in.paragraphs(), insertion);
210 // Split the paragraph for inserting the buf if necessary.
212 breakParagraphConservative(buffer.params(), pars, pit, pos);
216 pars.insert(pars.begin() + pit, insertion.begin(),
219 // merge the empty par with the last par of the insertion
220 mergeParagraph(buffer.params(), pars,
221 pit + insertion.size() - 1);
223 pars.insert(pars.begin() + pit + 1, insertion.begin(),
226 // merge the first par of the insertion with the current par
227 mergeParagraph(buffer.params(), pars, pit);
230 pit_type last_paste = pit + insertion.size() - 1;
232 // Store the new cursor position.
234 pos = pars[last_paste].size();
236 // Maybe some pasting.
237 if (!empty && last_paste + 1 != pit_type(pars.size())) {
238 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
239 mergeParagraph(buffer.params(), pars, last_paste);
240 } else if (pars[last_paste + 1].empty()) {
241 pars[last_paste + 1].makeSameLayout(pars[last_paste]);
242 mergeParagraph(buffer.params(), pars, last_paste);
243 } else if (pars[last_paste].empty()) {
244 pars[last_paste].makeSameLayout(pars[last_paste + 1]);
245 mergeParagraph(buffer.params(), pars, last_paste);
247 pars[last_paste + 1].stripLeadingSpaces();
252 endpit = last_paste + 1;
255 bufferErrors(cur.buffer(), errorlist);
256 cur.bv().showErrorList(_("Paste"));
257 cur.clearSelection();
259 BOOST_ASSERT(cur.text());
260 cur.text()->setCursor(cur, pit, pos);
262 updateCounters(cur.buffer());
266 PitPosPair eraseSelectionHelper(BufferParams const & params,
267 ParagraphList & pars,
268 pit_type startpit, pit_type endpit,
269 int startpos, int endpos, bool doclear)
271 if (startpit == pit_type(pars.size()) ||
272 (startpos > pars[startpit].size()))
273 return PitPosPair(endpit, endpos);
275 if (endpit == pit_type(pars.size()) ||
276 startpit == endpit) {
277 endpos -= pars[startpit].erase(startpos, endpos);
278 return PitPosPair(endpit, endpos);
281 // clear end/begin fragments of the first/last par in selection
282 bool all_erased = true;
284 pars[startpit].erase(startpos, pars[startpit].size());
285 if (pars[startpit].size() != startpos)
288 endpos -= pars[endpit].erase(0, endpos);
292 // Loop through the deleted pars if any, erasing as needed
293 for (pit_type pit = startpit + 1; pit != endpit;) {
294 // "erase" the contents of the par
295 pars[pit].erase(0, pars[pit].size());
296 if (!pars[pit].size()) {
297 // remove the par if it's now empty
298 pars.erase(pars.begin() + pit);
306 #if 0 // FIXME: why for cut but not copy ?
307 // the cut selection should begin with standard layout
309 buf->params().clear();
311 buf->layout(textclasslist[buffer->params.textclass].defaultLayoutName());
315 if (startpit + 1 == pit_type(pars.size()))
316 return PitPosPair(endpit, endpos);
319 pars[startpit + 1].stripLeadingSpaces();
322 // paste the paragraphs again, if possible
324 (pars[startpit].hasSameLayout(pars[startpit + 1]) ||
325 pars[startpit + 1].empty())) {
326 mergeParagraph(params, pars, startpit);
327 // this because endpar gets deleted here!
332 return PitPosPair(endpit, endpos);
337 void copySelectionHelper(ParagraphList & pars,
338 pit_type startpit, pit_type endpit,
339 int start, int end, textclass_type tc)
341 BOOST_ASSERT(0 <= start && start <= pars[startpit].size());
342 BOOST_ASSERT(0 <= end && end <= pars[endpit].size());
343 BOOST_ASSERT(startpit != endpit || start <= end);
345 // Clone the paragraphs within the selection.
346 ParagraphList paragraphs(pars.begin() + startpit, pars.begin() + endpit + 1);
347 for_each(paragraphs.begin(), paragraphs.end(), resetOwnerAndChanges());
349 // Cut out the end of the last paragraph.
350 Paragraph & back = paragraphs.back();
351 back.erase(end, back.size());
353 // Cut out the begin of the first paragraph
354 Paragraph & front = paragraphs.front();
355 front.erase(0, start);
357 theCuts.push(make_pair(paragraphs, tc));
366 string grabAndEraseSelection(LCursor & cur)
368 if (!cur.selection())
370 string res = grabSelection(cur);
372 cur.selection() = false;
377 void SwitchBetweenClasses(textclass_type c1, textclass_type c2,
378 ParagraphList & pars, ErrorList & errorlist)
380 BOOST_ASSERT(!pars.empty());
384 LyXTextClass const & tclass1 = textclasslist[c1];
385 LyXTextClass const & tclass2 = textclasslist[c2];
388 std::swap(in.paragraphs(), pars);
391 ParIterator end = par_iterator_end(in);
392 for (ParIterator it = par_iterator_begin(in); it != end; ++it) {
393 string const name = it->layout()->name();
394 bool hasLayout = tclass2.hasLayout(name);
397 it->layout(tclass2[name]);
399 it->layout(tclass2.defaultLayout());
401 if (!hasLayout && name != tclass1.defaultLayoutName()) {
402 string const s = bformat(
403 _("Layout had to be changed from\n%1$s to %2$s\n"
404 "because of class conversion from\n%3$s to %4$s"),
405 name, it->layout()->name(), tclass1.name(), tclass2.name());
406 // To warn the user that something had to be done.
407 errorlist.push_back(ErrorItem(_("Changed Layout"), s,
414 InsetIterator const i_end = inset_iterator_end(in);
415 for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
416 if (it->lyxCode() == InsetBase::CHARSTYLE_CODE) {
417 InsetCharStyle & inset =
418 static_cast<InsetCharStyle &>(*it);
419 string const name = inset.params().type;
420 CharStyles::iterator const found_cs =
421 tclass2.charstyle(name);
422 if (found_cs == tclass2.charstyles().end()) {
423 // The character style is undefined in tclass2
424 inset.setUndefined();
425 string const s = bformat(_(
426 "Character style %1$s is "
427 "undefined because of class "
428 "conversion from\n%2$s to %3$s"),
429 name, tclass1.name(), tclass2.name());
430 // To warn the user that something had to be done.
431 errorlist.push_back(ErrorItem(
432 _("Undefined character style"),
433 s, it.paragraph().id(),
434 it.pos(), it.pos() + 1));
435 } else if (inset.undefined()) {
436 // The character style is undefined in
437 // tclass1 and is defined in tclass2
438 inset.setDefined(found_cs);
443 std::swap(in.paragraphs(), pars);
447 std::vector<string> const availableSelections(Buffer const & buffer)
449 vector<string> selList;
451 CutStack::const_iterator cit = theCuts.begin();
452 CutStack::const_iterator end = theCuts.end();
453 for (; cit != end; ++cit) {
454 // we do not use cit-> here because gcc 2.9x does not
456 ParagraphList const & pars = (*cit).first;
458 ParagraphList::const_iterator pit = pars.begin();
459 ParagraphList::const_iterator pend = pars.end();
460 for (; pit != pend; ++pit) {
461 asciiSel += pit->asString(buffer, false);
462 if (asciiSel.size() > 25) {
463 asciiSel.replace(22, string::npos, "...");
468 selList.push_back(asciiSel);
477 return theCuts.empty() ? 0 : theCuts[0].first.size();
481 void cutSelection(LCursor & cur, bool doclear, bool realcut)
483 if (cur.inTexted()) {
484 LyXText * text = cur.text();
486 // Stuff what we got on the clipboard. Even if there is no selection.
488 // There is a problem with having the stuffing here in that the
489 // larger the selection the slower LyX will get. This can be
490 // solved by running the line below only when the selection has
491 // finished. The solution used currently just works, to make it
492 // faster we need to be more clever and probably also have more
493 // calls to stuffClipboard. (Lgb)
494 cur.bv().stuffClipboard(cur.selectionAsString(true));
496 // This doesn't make sense, if there is no selection
497 if (!cur.selection())
500 // OK, we have a selection. This is always between cur.selBegin()
503 // make sure that the depth behind the selection are restored, too
504 recordUndoSelection(cur);
505 pit_type begpit = cur.selBegin().pit();
506 pit_type endpit = cur.selEnd().pit();
508 int endpos = cur.selEnd().pos();
510 BufferParams const & bp = cur.buffer().params();
512 copySelectionHelper(text->paragraphs(),
514 cur.selBegin().pos(), endpos,
518 boost::tie(endpit, endpos) =
519 eraseSelectionHelper(bp,
522 cur.selBegin().pos(), endpos,
525 // sometimes necessary
527 text->paragraphs()[begpit].stripLeadingSpaces();
529 // cutSelection can invalidate the cursor so we need to set
531 // we prefer the end for when tracking changes
535 // need a valid cursor. (Lgb)
536 cur.clearSelection();
537 updateCounters(cur.buffer());
540 if (cur.inMathed()) {
541 lyxerr << "cutSelection in mathed" << endl;
544 cur.selection() = false;
550 void copySelection(LCursor & cur)
552 // stuff the selection onto the X clipboard, from an explicit copy request
553 cur.bv().stuffClipboard(cur.selectionAsString(true));
555 // this doesn't make sense, if there is no selection
556 if (!cur.selection())
559 if (cur.inTexted()) {
560 LyXText * text = cur.text();
562 // ok we have a selection. This is always between cur.selBegin()
563 // and sel_end cursor
565 // copy behind a space if there is one
566 ParagraphList & pars = text->paragraphs();
567 pos_type pos = cur.selBegin().pos();
568 pit_type par = cur.selBegin().pit();
569 while (pos < pars[par].size()
570 && pars[par].isLineSeparator(pos)
571 && (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
574 copySelectionHelper(pars, par, cur.selEnd().pit(),
575 pos, cur.selEnd().pos(), cur.buffer().params().textclass);
578 if (cur.inMathed()) {
579 //lyxerr << "copySelection in mathed" << endl;
581 pars.push_back(Paragraph());
582 BufferParams const & bp = cur.buffer().params();
583 pars.back().layout(bp.getLyXTextClass().defaultLayout());
584 for_each(pars.begin(), pars.end(), resetOwnerAndChanges());
585 pars.back().insert(0, grabSelection(cur), LyXFont());
586 theCuts.push(make_pair(pars, bp.textclass));
591 std::string getSelection(Buffer const & buf, size_t sel_index)
593 return sel_index < theCuts.size()
594 ? theCuts[sel_index].first.back().asString(buf, false)
599 void pasteSelection(LCursor & cur, size_t sel_index)
601 // this does not make sense, if there is nothing to paste
602 if (!checkPastePossible(sel_index))
605 pasteSelectionHelper(cur, sel_index);
607 lyxerr << "### should be handled in MathNest/GridInset" << endl;
611 void setSelectionRange(LCursor & cur, pos_type length)
613 LyXText * text = cur.text();
619 text->cursorRight(cur);
624 // simple replacing. The font of the first selected character is used
625 void replaceSelectionWithString(LCursor & cur, string const & str)
627 LyXText * text = cur.text();
631 // Get font setting before we cut
632 pos_type pos = cur.selEnd().pos();
633 Paragraph & par = text->getPar(cur.selEnd().pit());
635 par.getFontSettings(cur.buffer().params(), cur.selBegin().pos());
637 // Insert the new string
638 string::const_iterator cit = str.begin();
639 string::const_iterator end = str.end();
640 for (; cit != end; ++cit, ++pos)
641 par.insertChar(pos, (*cit), font);
644 cutSelection(cur, true, false);
648 void replaceSelection(LCursor & cur)
651 cutSelection(cur, true, false);
655 // only used by the spellchecker
656 void replaceWord(LCursor & cur, string const & replacestring)
658 LyXText * text = cur.text();
661 replaceSelectionWithString(cur, replacestring);
662 setSelectionRange(cur, replacestring.length());
664 // Go back so that replacement string is also spellchecked
665 for (string::size_type i = 0; i < replacestring.length() + 1; ++i)
666 text->cursorLeft(cur);
670 void eraseSelection(LCursor & cur)
672 //lyxerr << "LCursor::eraseSelection begin: " << cur << endl;
673 CursorSlice const & i1 = cur.selBegin();
674 CursorSlice const & i2 = cur.selEnd();
675 if (i1.inset().asMathInset()) {
677 if (i1.idx() == i2.idx()) {
678 i1.cell().erase(i1.pos(), i2.pos());
680 MathInset * p = i1.asMathInset();
681 InsetBase::row_type r1, r2;
682 InsetBase::col_type c1, c2;
683 region(i1, i2, r1, r2, c1, c2);
684 for (InsetBase::row_type row = r1; row <= r2; ++row)
685 for (InsetBase::col_type col = c1; col <= c2; ++col)
686 p->cell(p->index(row, col)).clear();
687 // We've deleted the whole cell. Only pos 0 is valid.
692 lyxerr << "can't erase this selection 1" << endl;
694 //lyxerr << "LCursor::eraseSelection end: " << cur << endl;
698 void selDel(LCursor & cur)
700 //lyxerr << "LCursor::selDel" << endl;
701 if (cur.selection()) {
703 cur.selection() = false;
708 void selClearOrDel(LCursor & cur)
710 //lyxerr << "LCursor::selClearOrDel" << endl;
711 if (lyxrc.auto_region_delete)
714 cur.selection() = false;
718 string grabSelection(LCursor & cur)
720 if (!cur.selection())
723 CursorSlice i1 = cur.selBegin();
724 CursorSlice i2 = cur.selEnd();
726 if (i1.idx() == i2.idx()) {
727 if (i1.inset().asMathInset()) {
728 MathArray::const_iterator it = i1.cell().begin();
729 return asString(MathArray(it + i1.pos(), it + i2.pos()));
731 return "unknown selection 1";
735 InsetBase::row_type r1, r2;
736 InsetBase::col_type c1, c2;
737 region(i1, i2, r1, r2, c1, c2);
740 if (i1.inset().asMathInset()) {
741 for (InsetBase::row_type row = r1; row <= r2; ++row) {
744 for (InsetBase::col_type col = c1; col <= c2; ++col) {
747 data += asString(i1.asMathInset()->
748 cell(i1.asMathInset()->index(row, col)));
752 data = "unknown selection 2";