]> git.lyx.org Git - lyx.git/blob - src/CutAndPaste.cpp
Set "dryrun" to true for XHTML copying routine. This suppresses
[lyx.git] / src / CutAndPaste.cpp
1 /**
2  * \file CutAndPaste.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Jürgen Vigna
7  * \author Lars Gullik Bjønnes
8  * \author Alfredo Braunstein
9  * \author Michael Gerz
10  *
11  * Full author contact details are available in file CREDITS.
12  */
13
14 #include <config.h>
15
16 #include "CutAndPaste.h"
17
18 #include "BranchList.h"
19 #include "Buffer.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
23 #include "BufferView.h"
24 #include "Changes.h"
25 #include "Cursor.h"
26 #include "Encoding.h"
27 #include "ErrorList.h"
28 #include "FuncCode.h"
29 #include "FuncRequest.h"
30 #include "InsetIterator.h"
31 #include "InsetList.h"
32 #include "Language.h"
33 #include "LyX.h"
34 #include "LyXRC.h"
35 #include "Text.h"
36 #include "Paragraph.h"
37 #include "ParagraphParameters.h"
38 #include "ParIterator.h"
39 #include "TextClass.h"
40
41 #include "insets/InsetBibitem.h"
42 #include "insets/InsetBranch.h"
43 #include "insets/InsetCommand.h"
44 #include "insets/InsetFlex.h"
45 #include "insets/InsetGraphics.h"
46 #include "insets/InsetGraphicsParams.h"
47 #include "insets/InsetInclude.h"
48 #include "insets/InsetLabel.h"
49 #include "insets/InsetTabular.h"
50
51 #include "mathed/MathData.h"
52 #include "mathed/InsetMath.h"
53 #include "mathed/InsetMathHull.h"
54 #include "mathed/InsetMathRef.h"
55 #include "mathed/MathSupport.h"
56
57 #include "support/debug.h"
58 #include "support/docstream.h"
59 #include "support/gettext.h"
60 #include "support/lassert.h"
61 #include "support/limited_stack.h"
62 #include "support/lstrings.h"
63
64 #include "frontends/alert.h"
65 #include "frontends/Clipboard.h"
66 #include "frontends/Selection.h"
67
68 #include <boost/tuple/tuple.hpp>
69 #include <boost/next_prior.hpp>
70
71 #include <string>
72
73 using namespace std;
74 using namespace lyx::support;
75 using lyx::frontend::Clipboard;
76
77 namespace lyx {
78
79 namespace {
80
81 typedef pair<pit_type, int> PitPosPair;
82
83 typedef limited_stack<pair<ParagraphList, DocumentClassConstPtr> > CutStack;
84
85 CutStack theCuts(10);
86 // persistent selection, cleared until the next selection
87 CutStack selectionBuffer(1);
88
89 // store whether the tabular stack is newer than the normal copy stack
90 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
91 // when we (hopefully) have a one-for-all paste mechanism.
92 bool dirty_tabular_stack_ = false;
93
94
95 bool checkPastePossible(int index)
96 {
97         return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
98 }
99
100
101 struct PasteReturnValue {
102         PasteReturnValue(pit_type r_par, pos_type r_pos, bool r_nu) :
103           par(r_par), pos(r_pos), needupdate(r_nu)
104         {}
105
106         pit_type par;
107         pos_type pos;
108         bool needupdate;
109 };
110
111 PasteReturnValue
112 pasteSelectionHelper(DocIterator const & cur, ParagraphList const & parlist,
113                      DocumentClassConstPtr oldDocClass, Buffer * tmpbuffer,
114                      ErrorList & errorlist)
115 {
116         Buffer const & buffer = *cur.buffer();
117         pit_type pit = cur.pit();
118         pos_type pos = cur.pos();
119         bool need_update = false;
120         InsetText * target_inset = cur.inset().asInsetText();
121         if (!target_inset) {
122                 InsetTabular * it = cur.inset().asInsetTabular();
123                 target_inset = it? it->cell(cur.idx())->asInsetText() : 0;
124         }
125         LASSERT(target_inset, return PasteReturnValue(pit, pos, need_update));
126         ParagraphList & pars = target_inset->paragraphs();
127
128         if (parlist.empty())
129                 return PasteReturnValue(pit, pos, need_update);
130
131         BOOST_ASSERT (pos <= pars[pit].size());
132
133         // Make a copy of the CaP paragraphs.
134         ParagraphList insertion = parlist;
135         DocumentClassConstPtr newDocClass = buffer.params().documentClassPtr();
136
137         // Now remove all out of the pars which is NOT allowed in the
138         // new environment and set also another font if that is required.
139
140         // Convert newline to paragraph break in ParbreakIsNewline
141         if (target_inset->getLayout().parbreakIsNewline()
142             || pars[pit].layout().parbreak_is_newline) {
143                 for (size_t i = 0; i != insertion.size(); ++i) {
144                         for (pos_type j = 0; j != insertion[i].size(); ++j) {
145                                 if (insertion[i].isNewline(j)) {
146                                         // do not track deletion of newline
147                                         insertion[i].eraseChar(j, false);
148                                         insertion[i].setInsetOwner(target_inset);
149                                         breakParagraphConservative(
150                                                         buffer.params(),
151                                                         insertion, i, j);
152                                         break;
153                                 }
154                         }
155                 }
156         }
157
158         // set the paragraphs to plain layout if necessary
159         if (cur.inset().usePlainLayout()) {
160                 bool forcePlainLayout = cur.inset().forcePlainLayout();
161                 Layout const & plainLayout = newDocClass->plainLayout();
162                 Layout const & defaultLayout = newDocClass->defaultLayout();
163                 ParagraphList::iterator const end = insertion.end();
164                 ParagraphList::iterator par = insertion.begin();
165                 for (; par != end; ++par) {
166                         Layout const & parLayout = par->layout();
167                         if (forcePlainLayout || parLayout == defaultLayout)
168                                 par->setLayout(plainLayout);
169                 }
170         } else { // check if we need to reset from plain layout
171                 Layout const & defaultLayout = newDocClass->defaultLayout();
172                 Layout const & plainLayout = newDocClass->plainLayout();
173                 ParagraphList::iterator const end = insertion.end();
174                 ParagraphList::iterator par = insertion.begin();
175                 for (; par != end; ++par) {
176                         Layout const & parLayout = par->layout();
177                         if (parLayout == plainLayout)
178                                 par->setLayout(defaultLayout);
179                 }
180         }
181
182         InsetText in(cur.buffer());
183         // Make sure there is no class difference.
184         in.paragraphs().clear();
185         // This works without copying any paragraph data because we have
186         // a specialized swap method for ParagraphList. This is important
187         // since we store pointers to insets at some places and we don't
188         // want to invalidate them.
189         insertion.swap(in.paragraphs());
190         cap::switchBetweenClasses(oldDocClass, newDocClass, in, errorlist);
191         insertion.swap(in.paragraphs());
192
193         ParagraphList::iterator tmpbuf = insertion.begin();
194         int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
195
196         depth_type max_depth = pars[pit].getMaxDepthAfter();
197
198         for (; tmpbuf != insertion.end(); ++tmpbuf) {
199                 // If we have a negative jump so that the depth would
200                 // go below 0 depth then we have to redo the delta to
201                 // this new max depth level so that subsequent
202                 // paragraphs are aligned correctly to this paragraph
203                 // at level 0.
204                 if (int(tmpbuf->params().depth()) + depth_delta < 0)
205                         depth_delta = 0;
206
207                 // Set the right depth so that we are not too deep or shallow.
208                 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
209                 if (tmpbuf->params().depth() > max_depth)
210                         tmpbuf->params().depth(max_depth);
211
212                 // Only set this from the 2nd on as the 2nd depends
213                 // for maxDepth still on pit.
214                 if (tmpbuf != insertion.begin())
215                         max_depth = tmpbuf->getMaxDepthAfter();
216
217                 // Set the inset owner of this paragraph.
218                 tmpbuf->setInsetOwner(target_inset);
219                 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
220                         // do not track deletion of invalid insets
221                         if (Inset * inset = tmpbuf->getInset(i))
222                                 if (!target_inset->insetAllowed(inset->lyxCode()))
223                                         tmpbuf->eraseChar(i--, false);
224                 }
225
226                 tmpbuf->setChange(Change(buffer.params().trackChanges ?
227                                          Change::INSERTED : Change::UNCHANGED));
228         }
229
230         bool const empty = pars[pit].empty();
231         if (!empty) {
232                 // Make the buf exactly the same layout as the cursor
233                 // paragraph.
234                 insertion.begin()->makeSameLayout(pars[pit]);
235         }
236
237         // Prepare the paragraphs and insets for insertion.
238         insertion.swap(in.paragraphs());
239
240         InsetIterator const i_end = inset_iterator_end(in);
241         for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
242                 // Even though this will also be done later, it has to be done here 
243                 // since some inset might going to try to access
244                 // the buffer() member.
245                 it->setBuffer(const_cast<Buffer &>(buffer));
246                 switch (it->lyxCode()) {
247
248                 case MATH_HULL_CODE: {
249                         // check for equation labels and resolve duplicates
250                         InsetMathHull * ins = it->asInsetMath()->asHullInset();
251                         std::vector<InsetLabel *> labels = ins->getLabels();
252                         for (size_t i = 0; i != labels.size(); ++i) {
253                                 if (!labels[i])
254                                         continue;
255                                 InsetLabel * lab = labels[i];
256                                 docstring const oldname = lab->getParam("name");
257                                 lab->updateLabel(oldname);
258                                 // We need to update the buffer reference cache.
259                                 need_update = true;
260                                 docstring const newname = lab->getParam("name");
261                                 if (oldname == newname)
262                                         continue;
263                                 // adapt the references
264                                 for (InsetIterator itt = inset_iterator_begin(in);
265                                       itt != i_end; ++itt) {
266                                         if (itt->lyxCode() == REF_CODE) {
267                                                 InsetCommand * ref = itt->asInsetCommand();
268                                                 if (ref->getParam("reference") == oldname)
269                                                         ref->setParam("reference", newname);
270                                         } else if (itt->lyxCode() == MATH_REF_CODE) {
271                                                 InsetMathRef * mi = itt->asInsetMath()->asRefInset();
272                                                 // this is necessary to prevent an uninitialized
273                                                 // buffer when the RefInset is in a MathBox.
274                                                 // FIXME audit setBuffer calls
275                                                 mi->setBuffer(const_cast<Buffer &>(buffer));
276                                                 if (mi->getTarget() == oldname)
277                                                         mi->changeTarget(newname);
278                                         }
279                                 }
280                         }
281                         break;
282                 }
283
284                 case LABEL_CODE: {
285                         // check for duplicates
286                         InsetLabel & lab = static_cast<InsetLabel &>(*it);
287                         docstring const oldname = lab.getParam("name");
288                         lab.updateLabel(oldname);
289                         // We need to update the buffer reference cache.
290                         need_update = true;
291                         docstring const newname = lab.getParam("name");
292                         if (oldname == newname)
293                                 break;
294                         // adapt the references
295                         for (InsetIterator itt = inset_iterator_begin(in); itt != i_end; ++itt) {
296                                 if (itt->lyxCode() == REF_CODE) {
297                                         InsetCommand & ref = static_cast<InsetCommand &>(*itt);
298                                         if (ref.getParam("reference") == oldname)
299                                                 ref.setParam("reference", newname);
300                                 } else if (itt->lyxCode() == MATH_REF_CODE) {
301                                         InsetMathRef * mi = itt->asInsetMath()->asRefInset();
302                                         // this is necessary to prevent an uninitialized
303                                         // buffer when the RefInset is in a MathBox.
304                                         // FIXME audit setBuffer calls
305                                         mi->setBuffer(const_cast<Buffer &>(buffer));
306                                         if (mi->getTarget() == oldname)
307                                                 mi->changeTarget(newname);
308                                 }
309                         }
310                         break;
311                 }
312
313                 case INCLUDE_CODE: {
314                         InsetInclude & inc = static_cast<InsetInclude &>(*it);
315                         inc.updateCommand();
316                         // We need to update the list of included files.
317                         need_update = true;
318                         break;
319                 }
320
321                 case BIBITEM_CODE: {
322                         // check for duplicates
323                         InsetBibitem & bib = static_cast<InsetBibitem &>(*it);
324                         docstring const oldkey = bib.getParam("key");
325                         bib.updateCommand(oldkey, false);
326                         // We need to update the buffer reference cache.
327                         need_update = true;
328                         docstring const newkey = bib.getParam("key");
329                         if (oldkey == newkey)
330                                 break;
331                         // adapt the references
332                         for (InsetIterator itt = inset_iterator_begin(in);
333                              itt != i_end; ++itt) {
334                                 if (itt->lyxCode() == CITE_CODE) {
335                                         InsetCommand * ref = itt->asInsetCommand();
336                                         if (ref->getParam("key") == oldkey)
337                                                 ref->setParam("key", newkey);
338                                 }
339                         }
340                         break;
341                 }
342
343                 case BRANCH_CODE: {
344                         // check if branch is known to target buffer
345                         // or its master
346                         InsetBranch & br = static_cast<InsetBranch &>(*it);
347                         docstring const name = br.branch();
348                         if (name.empty())
349                                 break;
350                         bool const is_child = (&buffer != buffer.masterBuffer());
351                         BranchList branchlist = buffer.params().branchlist();
352                         if ((!is_child && branchlist.find(name))
353                             || (is_child && (branchlist.find(name)
354                                 || buffer.masterBuffer()->params().branchlist().find(name))))
355                                 break;
356                         if (tmpbuffer) {
357                                 // This is for a temporary buffer, so simply create the branch.
358                                 // Must not use lyx::dispatch(), since tmpbuffer has no view.
359                                 DispatchResult dr;
360                                 tmpbuffer->dispatch(FuncRequest(LFUN_BRANCH_ADD, name), dr);
361                         } else {
362                                 docstring text = bformat(
363                                         _("The pasted branch \"%1$s\" is undefined.\n"
364                                           "Do you want to add it to the document's branch list?"),
365                                         name);
366                                 if (frontend::Alert::prompt(_("Unknown branch"),
367                                           text, 0, 1, _("&Add"), _("&Don't Add")) != 0)
368                                         break;
369                                 lyx::dispatch(FuncRequest(LFUN_BRANCH_ADD, name));
370                         }
371                         // We need to update the list of branches.
372                         need_update = true;
373                         break;
374                 }
375
376                 default:
377                         break; // nothing
378                 }
379         }
380         insertion.swap(in.paragraphs());
381
382         // Split the paragraph for inserting the buf if necessary.
383         if (!empty)
384                 breakParagraphConservative(buffer.params(), pars, pit, pos);
385
386         // Paste it!
387         if (empty) {
388                 pars.insert(boost::next(pars.begin(), pit),
389                             insertion.begin(),
390                             insertion.end());
391
392                 // merge the empty par with the last par of the insertion
393                 mergeParagraph(buffer.params(), pars,
394                                pit + insertion.size() - 1);
395         } else {
396                 pars.insert(boost::next(pars.begin(), pit + 1),
397                             insertion.begin(),
398                             insertion.end());
399
400                 // merge the first par of the insertion with the current par
401                 mergeParagraph(buffer.params(), pars, pit);
402         }
403
404         // Store the new cursor position.
405         pit_type last_paste = pit + insertion.size() - 1;
406         pit_type startpit = pit;
407         pit = last_paste;
408         pos = pars[last_paste].size();
409
410         // FIXME Should we do it here, or should we let updateBuffer() do it?
411         // Set paragraph buffers. It's important to do this right away
412         // before something calls Inset::buffer() and causes a crash.
413         for (pit_type p = startpit; p <= pit; ++p)
414                 pars[p].setBuffer(const_cast<Buffer &>(buffer));
415
416         // Join (conditionally) last pasted paragraph with next one, i.e.,
417         // the tail of the spliced document paragraph
418         if (!empty && last_paste + 1 != pit_type(pars.size())) {
419                 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
420                         mergeParagraph(buffer.params(), pars, last_paste);
421                 } else if (pars[last_paste + 1].empty()) {
422                         pars[last_paste + 1].makeSameLayout(pars[last_paste]);
423                         mergeParagraph(buffer.params(), pars, last_paste);
424                 } else if (pars[last_paste].empty()) {
425                         pars[last_paste].makeSameLayout(pars[last_paste + 1]);
426                         mergeParagraph(buffer.params(), pars, last_paste);
427                 } else {
428                         pars[last_paste + 1].stripLeadingSpaces(buffer.params().trackChanges);
429                         ++last_paste;
430                 }
431         }
432
433         return PasteReturnValue(pit, pos, need_update);
434 }
435
436
437 PitPosPair eraseSelectionHelper(BufferParams const & params,
438         ParagraphList & pars,
439         pit_type startpit, pit_type endpit,
440         int startpos, int endpos)
441 {
442         // Start of selection is really invalid.
443         if (startpit == pit_type(pars.size()) ||
444             (startpos > pars[startpit].size()))
445                 return PitPosPair(endpit, endpos);
446
447         // Start and end is inside same paragraph
448         if (endpit == pit_type(pars.size()) || startpit == endpit) {
449                 endpos -= pars[startpit].eraseChars(startpos, endpos, params.trackChanges);
450                 return PitPosPair(endpit, endpos);
451         }
452
453         for (pit_type pit = startpit; pit != endpit + 1;) {
454                 pos_type const left  = (pit == startpit ? startpos : 0);
455                 pos_type right = (pit == endpit ? endpos : pars[pit].size() + 1);
456                 bool const merge = pars[pit].isMergedOnEndOfParDeletion(params.trackChanges);
457
458                 // Logically erase only, including the end-of-paragraph character
459                 pars[pit].eraseChars(left, right, params.trackChanges);
460
461                 // Separate handling of paragraph break:
462                 if (merge && pit != endpit &&
463                     (pit + 1 != endpit 
464                      || pars[pit].hasSameLayout(pars[endpit])
465                      || pars[endpit].size() == endpos)) {
466                         if (pit + 1 == endpit)
467                                 endpos += pars[pit].size();
468                         mergeParagraph(params, pars, pit);
469                         --endpit;
470                 } else
471                         ++pit;
472         }
473
474         // Ensure legal cursor pos:
475         endpit = startpit;
476         endpos = startpos;
477         return PitPosPair(endpit, endpos);
478 }
479
480
481 void putClipboard(ParagraphList const & paragraphs, 
482         DocumentClassConstPtr docclass, docstring const & plaintext)
483 {
484         // This used to need to be static to avoid a memory leak. It no longer needs
485         // to be so, but the alternative is to construct a new one of these (with a
486         // new temporary directory, etc) every time, and then to destroy it. So maybe
487         // it's worth just keeping this one around.
488         static Buffer * staticbuffer = theBufferList().newInternalBuffer(
489                 FileName::tempName("clipboard.internal").absFileName());
490
491         // These two things only really need doing the first time.
492         staticbuffer->setUnnamed(true);
493         staticbuffer->inset().setBuffer(*staticbuffer);
494
495         // Use a clone for the complicated stuff so that we do not need to clean
496         // up in order to avoid a crash.
497         Buffer * buffer = staticbuffer->cloneBufferOnly();
498         LASSERT(buffer, return);
499
500         // This needs doing every time.
501         buffer->params().setDocumentClass(docclass);
502
503         // we will use pasteSelectionHelper to copy the paragraphs into the
504         // temporary Buffer, since it does a lot of things to fix them up.
505         DocIterator dit = doc_iterator_begin(buffer, &buffer->inset());
506         ErrorList el;
507         pasteSelectionHelper(dit, paragraphs, docclass, buffer, el);
508
509         // We don't want to produce images that are not used. Therefore,
510         // output formulas as MathML. Even if this is not understood by all
511         // applications, the number that can parse it should go up in the future.
512         buffer->params().html_math_output = BufferParams::MathML;
513
514         // Make sure MarkAsExporting is deleted before buffer is
515         {
516                 // The Buffer is being used to export. This is necessary so that the
517                 // updateMacros call will record the needed information.
518                 MarkAsExporting mex(buffer);
519
520                 buffer->updateBuffer(Buffer::UpdateMaster, OutputUpdate);
521                 buffer->updateMacros();
522                 buffer->updateMacroInstances(OutputUpdate);
523
524                 // LyX's own format
525                 string lyx;
526                 ostringstream oslyx;
527                 if (buffer->write(oslyx))
528                         lyx = oslyx.str();
529
530                 // XHTML format
531                 odocstringstream oshtml;
532                 OutputParams runparams(encodings.fromLyXName("utf8"));
533                 // We do not need to produce images, etc.
534                 runparams.dryrun = true;
535                 buffer->writeLyXHTMLSource(oshtml, runparams, Buffer::FullSource);
536
537                 theClipboard().put(lyx, oshtml.str(), plaintext);
538         }
539
540         // Save that memory
541         delete buffer;
542 }
543
544
545 /// return true if the whole ParagraphList is deleted
546 static bool isFullyDeleted(ParagraphList const & pars)
547 {
548         pit_type const pars_size = static_cast<pit_type>(pars.size());
549
550         // check all paragraphs
551         for (pit_type pit = 0; pit < pars_size; ++pit) {
552                 if (!pars[pit].empty())   // prevent assertion failure
553                         if (!pars[pit].isDeleted(0, pars[pit].size()))
554                                 return false;
555         }
556         return true;
557 }
558
559
560 void copySelectionHelper(Buffer const & buf, Text const & text,
561         pit_type startpit, pit_type endpit,
562         int start, int end, DocumentClassConstPtr dc, CutStack & cutstack)
563 {
564         ParagraphList const & pars = text.paragraphs();
565
566         // In most of these cases, we can try to recover.
567         LASSERT(0 <= start, start = 0);
568         LASSERT(start <= pars[startpit].size(), start = pars[startpit].size());
569         LASSERT(0 <= end, end = 0);
570         LASSERT(end <= pars[endpit].size(), end = pars[endpit].size());
571         LASSERT(startpit != endpit || start <= end, return);
572
573         // Clone the paragraphs within the selection.
574         ParagraphList copy_pars(boost::next(pars.begin(), startpit),
575                                 boost::next(pars.begin(), endpit + 1));
576
577         // Remove the end of the last paragraph; afterwards, remove the
578         // beginning of the first paragraph. Keep this order - there may only
579         // be one paragraph!  Do not track deletions here; this is an internal
580         // action not visible to the user
581
582         Paragraph & back = copy_pars.back();
583         back.eraseChars(end, back.size(), false);
584         Paragraph & front = copy_pars.front();
585         front.eraseChars(0, start, false);
586
587         ParagraphList::iterator it = copy_pars.begin();
588         ParagraphList::iterator it_end = copy_pars.end();
589
590         for (; it != it_end; ++it) {
591                 // Since we have a copy of the paragraphs, the insets
592                 // do not have a proper buffer reference. It makes
593                 // sense to add them temporarily, because the
594                 // operations below depend on that (acceptChanges included).
595                 it->setBuffer(const_cast<Buffer &>(buf));
596                 // PassThru paragraphs have the Language
597                 // latex_language. This is invalid for others, so we
598                 // need to change it to the buffer language.
599                 if (it->isPassThru())
600                         it->changeLanguage(buf.params(), 
601                                            latex_language, buf.language());
602         }
603
604         // do not copy text (also nested in insets) which is marked as
605         // deleted, unless the whole selection was deleted
606         if (!isFullyDeleted(copy_pars))
607                 acceptChanges(copy_pars, buf.params());
608         else
609                 rejectChanges(copy_pars, buf.params());
610
611
612         // do some final cleanup now, to make sure that the paragraphs
613         // are not linked to something else.
614         it = copy_pars.begin();
615         for (; it != it_end; ++it) {
616                 it->setBuffer(*static_cast<Buffer *>(0));
617                 it->setInsetOwner(0);
618         }
619
620         cutstack.push(make_pair(copy_pars, dc));
621 }
622
623 } // namespace anon
624
625
626
627
628 namespace cap {
629
630 void region(CursorSlice const & i1, CursorSlice const & i2,
631             Inset::row_type & r1, Inset::row_type & r2,
632             Inset::col_type & c1, Inset::col_type & c2)
633 {
634         Inset & p = i1.inset();
635         c1 = p.col(i1.idx());
636         c2 = p.col(i2.idx());
637         if (c1 > c2)
638                 swap(c1, c2);
639         r1 = p.row(i1.idx());
640         r2 = p.row(i2.idx());
641         if (r1 > r2)
642                 swap(r1, r2);
643 }
644
645
646 docstring grabAndEraseSelection(Cursor & cur)
647 {
648         if (!cur.selection())
649                 return docstring();
650         docstring res = grabSelection(cur);
651         eraseSelection(cur);
652         return res;
653 }
654
655
656 bool reduceSelectionToOneCell(Cursor & cur)
657 {
658         if (!cur.selection() || !cur.inMathed())
659                 return false;
660
661         CursorSlice i1 = cur.selBegin();
662         CursorSlice i2 = cur.selEnd();
663         if (!i1.inset().asInsetMath())
664                 return false;
665
666         // the easy case: do nothing if only one cell is selected
667         if (i1.idx() == i2.idx())
668                 return true;
669         
670         cur.top().pos() = 0;
671         cur.resetAnchor();
672         cur.top().pos() = cur.top().lastpos();
673         
674         return true;
675 }
676
677
678 bool multipleCellsSelected(Cursor const & cur)
679 {
680         if (!cur.selection() || !cur.inMathed())
681                 return false;
682         
683         CursorSlice i1 = cur.selBegin();
684         CursorSlice i2 = cur.selEnd();
685         if (!i1.inset().asInsetMath())
686                 return false;
687         
688         if (i1.idx() == i2.idx())
689                 return false;
690         
691         return true;
692 }
693
694
695 void switchBetweenClasses(DocumentClassConstPtr oldone,
696                 DocumentClassConstPtr newone, InsetText & in, ErrorList & errorlist)
697 {
698         errorlist.clear();
699
700         LBUFERR(!in.paragraphs().empty());
701         if (oldone == newone)
702                 return;
703         
704         DocumentClass const & oldtc = *oldone;
705         DocumentClass const & newtc = *newone;
706
707         // layouts
708         ParIterator it = par_iterator_begin(in);
709         ParIterator end = par_iterator_end(in);
710         // for remembering which layouts we've had to add
711         set<docstring> newlayouts;
712         for (; it != end; ++it) {
713                 docstring const name = it->layout().name();
714
715                 // the pasted text will keep their own layout name. If this layout does
716                 // not exist in the new document, it will behave like a standard layout.
717                 bool const added_one = newtc.addLayoutIfNeeded(name);
718                 if (added_one)
719                         newlayouts.insert(name);
720
721                 if (added_one || newlayouts.find(name) != newlayouts.end()) {
722                         // Warn the user.
723                         docstring const s = bformat(_("Layout `%1$s' was not found."), name);
724                         errorlist.push_back(
725                                 ErrorItem(_("Layout Not Found"), s, it->id(), 0, it->size()));
726                 }
727
728                 if (in.usePlainLayout())
729                         it->setLayout(newtc.plainLayout());
730                 else
731                         it->setLayout(newtc[name]);
732         }
733
734         // character styles
735         InsetIterator const i_end = inset_iterator_end(in);
736         for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
737                 if (it->lyxCode() != FLEX_CODE)
738                         // FIXME: Should we verify all InsetCollapsable?
739                         continue;
740
741                 docstring const layoutName = it->layoutName();
742                 docstring const & n = newone->insetLayout(layoutName).name();
743                 bool const is_undefined = n.empty() ||
744                         n == DocumentClass::plainInsetLayout().name();
745                 if (!is_undefined)
746                         continue;
747
748                 // The flex inset is undefined in newtc
749                 docstring const oldname = from_utf8(oldtc.name());
750                 docstring const newname = from_utf8(newtc.name());
751                 docstring s;
752                 if (oldname == newname)
753                         s = bformat(_("Flex inset %1$s is undefined after "
754                                 "reloading `%2$s' layout."), layoutName, oldname);
755                 else
756                         s = bformat(_("Flex inset %1$s is undefined because of "
757                                 "conversion from `%2$s' layout to `%3$s'."),
758                                 layoutName, oldname, newname);
759                 // To warn the user that something had to be done.
760                 errorlist.push_back(ErrorItem(
761                                 _("Undefined flex inset"),
762                                 s, it.paragraph().id(), it.pos(), it.pos() + 1));
763         }
764 }
765
766
767 vector<docstring> availableSelections(Buffer const * buf)
768 {
769         vector<docstring> selList;
770         if (!buf)
771                 return selList;
772
773         CutStack::const_iterator cit = theCuts.begin();
774         CutStack::const_iterator end = theCuts.end();
775         for (; cit != end; ++cit) {
776                 // we do not use cit-> here because gcc 2.9x does not
777                 // like it (JMarc)
778                 ParagraphList const & pars = (*cit).first;
779                 docstring asciiSel;
780                 ParagraphList::const_iterator pit = pars.begin();
781                 ParagraphList::const_iterator pend = pars.end();
782                 for (; pit != pend; ++pit) {
783                         Paragraph par(*pit, 0, 26);
784                         // adapt paragraph to current buffer.
785                         par.setBuffer(const_cast<Buffer &>(*buf));
786                         asciiSel += par.asString(AS_STR_INSETS);
787                         if (asciiSel.size() > 25) {
788                                 asciiSel.replace(22, docstring::npos,
789                                                  from_ascii("..."));
790                                 break;
791                         }
792                 }
793
794                 selList.push_back(asciiSel);
795         }
796
797         return selList;
798 }
799
800
801 size_type numberOfSelections()
802 {
803         return theCuts.size();
804 }
805
806
807 void cutSelection(Cursor & cur, bool doclear, bool realcut)
808 {
809         // This doesn't make sense, if there is no selection
810         if (!cur.selection())
811                 return;
812
813         // OK, we have a selection. This is always between cur.selBegin()
814         // and cur.selEnd()
815
816         if (cur.inTexted()) {
817                 Text * text = cur.text();
818                 LBUFERR(text);
819
820                 saveSelection(cur);
821
822                 // make sure that the depth behind the selection are restored, too
823                 cur.recordUndoSelection();
824                 pit_type begpit = cur.selBegin().pit();
825                 pit_type endpit = cur.selEnd().pit();
826
827                 int endpos = cur.selEnd().pos();
828
829                 BufferParams const & bp = cur.buffer()->params();
830                 if (realcut) {
831                         copySelectionHelper(*cur.buffer(),
832                                 *text,
833                                 begpit, endpit,
834                                 cur.selBegin().pos(), endpos,
835                                 bp.documentClassPtr(), theCuts);
836                         // Stuff what we got on the clipboard.
837                         // Even if there is no selection.
838                         putClipboard(theCuts[0].first, theCuts[0].second,
839                                 cur.selectionAsString(true));
840                 }
841
842                 if (begpit != endpit)
843                         cur.screenUpdateFlags(Update::Force | Update::FitCursor);
844
845                 boost::tie(endpit, endpos) =
846                         eraseSelectionHelper(bp,
847                                 text->paragraphs(),
848                                 begpit, endpit,
849                                 cur.selBegin().pos(), endpos);
850
851                 // cutSelection can invalidate the cursor so we need to set
852                 // it anew. (Lgb)
853                 // we prefer the end for when tracking changes
854                 cur.pos() = endpos;
855                 cur.pit() = endpit;
856
857                 // sometimes necessary
858                 if (doclear
859                         && text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges))
860                         cur.fixIfBroken();
861
862                 // need a valid cursor. (Lgb)
863                 cur.clearSelection();
864
865                 // After a cut operation, we must make sure that the Buffer is updated
866                 // because some further operation might need updated label information for
867                 // example. So we cannot just use "cur.forceBufferUpdate()" here.
868                 // This fixes #7071.
869                 cur.buffer()->updateBuffer();
870
871                 // tell tabular that a recent copy happened
872                 dirtyTabularStack(false);
873         }
874
875         if (cur.inMathed()) {
876                 if (cur.selBegin().idx() != cur.selEnd().idx()) {
877                         // The current selection spans more than one cell.
878                         // Record all cells
879                         cur.recordUndoInset();
880                 } else {
881                         // Record only the current cell to avoid a jumping
882                         // cursor after undo
883                         cur.recordUndo();
884                 }
885                 if (realcut)
886                         copySelection(cur);
887                 eraseSelection(cur);
888         }
889 }
890
891
892 void copySelection(Cursor const & cur)
893 {
894         copySelection(cur, cur.selectionAsString(true));
895 }
896
897
898 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext)
899 {
900         ParagraphList pars;
901         Paragraph par;
902         BufferParams const & bp = cur.buffer()->params();
903         par.setLayout(bp.documentClass().plainLayout());
904         par.insertInset(0, inset, Change(Change::UNCHANGED));
905         pars.push_back(par);
906         theCuts.push(make_pair(pars, bp.documentClassPtr()));
907
908         // stuff the selection onto the X clipboard, from an explicit copy request
909         putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
910 }
911
912
913 namespace {
914
915 void copySelectionToStack(Cursor const & cur, CutStack & cutstack)
916 {
917         // this doesn't make sense, if there is no selection
918         if (!cur.selection())
919                 return;
920
921         // copySelection can not yet handle the case of cross idx selection
922         if (cur.selBegin().idx() != cur.selEnd().idx())
923                 return;
924
925         if (cur.inTexted()) {
926                 Text * text = cur.text();
927                 LBUFERR(text);
928                 // ok we have a selection. This is always between cur.selBegin()
929                 // and sel_end cursor
930
931                 // copy behind a space if there is one
932                 ParagraphList & pars = text->paragraphs();
933                 pos_type pos = cur.selBegin().pos();
934                 pit_type par = cur.selBegin().pit();
935                 while (pos < pars[par].size() &&
936                        pars[par].isLineSeparator(pos) &&
937                        (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
938                         ++pos;
939
940                 copySelectionHelper(*cur.buffer(), *text, par, cur.selEnd().pit(),
941                         pos, cur.selEnd().pos(), 
942                         cur.buffer()->params().documentClassPtr(), cutstack);
943
944                 // Reset the dirty_tabular_stack_ flag only when something
945                 // is copied to the clipboard (not to the selectionBuffer).
946                 if (&cutstack == &theCuts)
947                         dirtyTabularStack(false);
948         }
949
950         if (cur.inMathed()) {
951                 //lyxerr << "copySelection in mathed" << endl;
952                 ParagraphList pars;
953                 Paragraph par;
954                 BufferParams const & bp = cur.buffer()->params();
955                 // FIXME This should be the plain layout...right?
956                 par.setLayout(bp.documentClass().plainLayout());
957                 par.insert(0, grabSelection(cur), Font(), Change(Change::UNCHANGED));
958                 pars.push_back(par);
959                 cutstack.push(make_pair(pars, bp.documentClassPtr()));
960         }
961 }
962
963 }
964
965
966 void copySelectionToStack()
967 {
968         if (!selectionBuffer.empty())
969                 theCuts.push(selectionBuffer[0]);
970 }
971
972
973 void copySelection(Cursor const & cur, docstring const & plaintext)
974 {
975         // In tablemode, because copy and paste actually use special table stack
976         // we do not attempt to get selected paragraphs under cursor. Instead, a
977         // paragraph with the plain text version is generated so that table cells
978         // can be pasted as pure text somewhere else.
979         if (cur.selBegin().idx() != cur.selEnd().idx()) {
980                 ParagraphList pars;
981                 Paragraph par;
982                 BufferParams const & bp = cur.buffer()->params();
983                 par.setLayout(bp.documentClass().plainLayout());
984                 par.insert(0, plaintext, Font(), Change(Change::UNCHANGED));
985                 pars.push_back(par);
986                 theCuts.push(make_pair(pars, bp.documentClassPtr()));
987         } else {
988                 copySelectionToStack(cur, theCuts);
989         }
990
991         // stuff the selection onto the X clipboard, from an explicit copy request
992         putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
993 }
994
995
996 void saveSelection(Cursor const & cur)
997 {
998         // This function is called, not when a selection is formed, but when
999         // a selection is cleared. Therefore, multiple keyboard selection
1000         // will not repeatively trigger this function (bug 3877).
1001         if (cur.selection() 
1002             && cur.selBegin() == cur.bv().cursor().selBegin()
1003             && cur.selEnd() == cur.bv().cursor().selEnd()) {
1004                 LYXERR(Debug::SELECTION, "saveSelection: '" << cur.selectionAsString(true) << "'");
1005                 copySelectionToStack(cur, selectionBuffer);
1006         }
1007 }
1008
1009
1010 bool selection()
1011 {
1012         return !selectionBuffer.empty();
1013 }
1014
1015
1016 void clearSelection()
1017 {
1018         selectionBuffer.clear();
1019 }
1020
1021
1022 void clearCutStack()
1023 {
1024         theCuts.clear();
1025 }
1026
1027
1028 docstring selection(size_t sel_index)
1029 {
1030         return sel_index < theCuts.size()
1031                 ? theCuts[sel_index].first.back().asString(AS_STR_INSETS | AS_STR_NEWLINES)
1032                 : docstring();
1033 }
1034
1035
1036 void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
1037                         DocumentClassConstPtr docclass, ErrorList & errorList)
1038 {
1039         if (cur.inTexted()) {
1040                 Text * text = cur.text();
1041                 LBUFERR(text);
1042
1043                 PasteReturnValue prv =
1044                         pasteSelectionHelper(cur, parlist, docclass, 0, errorList);
1045                 cur.forceBufferUpdate();
1046                 cur.clearSelection();
1047                 text->setCursor(cur, prv.par, prv.pos);
1048         }
1049
1050         // mathed is handled in InsetMathNest/InsetMathGrid
1051         LATTEST(!cur.inMathed());
1052 }
1053
1054
1055 void pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index)
1056 {
1057         // this does not make sense, if there is nothing to paste
1058         if (!checkPastePossible(sel_index))
1059                 return;
1060
1061         cur.recordUndo();
1062         pasteParagraphList(cur, theCuts[sel_index].first,
1063                            theCuts[sel_index].second, errorList);
1064 }
1065
1066
1067 void pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs,
1068                         Clipboard::TextType type)
1069 {
1070         // Use internal clipboard if it is the most recent one
1071         // This overrides asParagraphs and type on purpose!
1072         if (theClipboard().isInternal()) {
1073                 pasteFromStack(cur, errorList, 0);
1074                 return;
1075         }
1076
1077         // First try LyX format
1078         if ((type == Clipboard::LyXTextType ||
1079              type == Clipboard::LyXOrPlainTextType ||
1080              type == Clipboard::AnyTextType) &&
1081             theClipboard().hasTextContents(Clipboard::LyXTextType)) {
1082                 string lyx = theClipboard().getAsLyX();
1083                 if (!lyx.empty()) {
1084                         // For some strange reason gcc 3.2 and 3.3 do not accept
1085                         // Buffer buffer(string(), false);
1086                         Buffer buffer("", false);
1087                         buffer.setUnnamed(true);
1088                         if (buffer.readString(lyx)) {
1089                                 cur.recordUndo();
1090                                 pasteParagraphList(cur, buffer.paragraphs(),
1091                                         buffer.params().documentClassPtr(), errorList);
1092                                 return;
1093                         }
1094                 }
1095         }
1096
1097         // Then try TeX and HTML
1098         Clipboard::TextType types[2] = {Clipboard::HtmlTextType, Clipboard::LaTeXTextType};
1099         string names[2] = {"html", "latex"};
1100         for (int i = 0; i < 2; ++i) {
1101                 if (type != types[i] && type != Clipboard::AnyTextType)
1102                         continue;
1103                 bool available = theClipboard().hasTextContents(types[i]);
1104
1105                 // If a specific type was explicitly requested, try to
1106                 // interpret plain text: The user told us that the clipboard
1107                 // contents is in the desired format
1108                 if (!available && type == types[i]) {
1109                         types[i] = Clipboard::PlainTextType;
1110                         available = theClipboard().hasTextContents(types[i]);
1111                 }
1112
1113                 if (available) {
1114                         docstring text = theClipboard().getAsText(types[i]);
1115                         available = !text.empty();
1116                         if (available) {
1117                                 // For some strange reason gcc 3.2 and 3.3 do not accept
1118                                 // Buffer buffer(string(), false);
1119                                 Buffer buffer("", false);
1120                                 buffer.setUnnamed(true);
1121                                 if (buffer.importString(names[i], text, errorList)) {
1122                                         cur.recordUndo();
1123                                         pasteParagraphList(cur, buffer.paragraphs(),
1124                                                 buffer.params().documentClassPtr(), errorList);
1125                                         return;
1126                                 }
1127                         }
1128                 }
1129         }
1130
1131         // Then try plain text
1132         docstring const text = theClipboard().getAsText(Clipboard::PlainTextType);
1133         if (text.empty())
1134                 return;
1135         cur.recordUndo();
1136         if (asParagraphs)
1137                 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1138         else
1139                 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1140 }
1141
1142
1143 void pasteSimpleText(Cursor & cur, bool asParagraphs)
1144 {
1145         docstring text;
1146         // Use internal clipboard if it is the most recent one
1147         if (theClipboard().isInternal()) {
1148                 if (!checkPastePossible(0))
1149                         return;
1150
1151                 ParagraphList const & pars = theCuts[0].first;
1152                 ParagraphList::const_iterator it = pars.begin();
1153                 for (; it != pars.end(); ++it) {
1154                         if (it != pars.begin())
1155                                 text += "\n";
1156                         text += (*it).asString();
1157                 }
1158                 asParagraphs = false;
1159         } else {
1160                 // Then try plain text
1161                 text = theClipboard().getAsText(Clipboard::PlainTextType);
1162         }
1163
1164         if (text.empty())
1165                 return;
1166
1167         cur.recordUndo();
1168         cutSelection(cur, true, false);
1169         if (asParagraphs)
1170                 cur.text()->insertStringAsParagraphs(cur, text, cur.current_font);
1171         else
1172                 cur.text()->insertStringAsLines(cur, text, cur.current_font);
1173 }
1174
1175
1176 void pasteClipboardGraphics(Cursor & cur, ErrorList & /* errorList */,
1177                             Clipboard::GraphicsType preferedType)
1178 {
1179         LASSERT(theClipboard().hasGraphicsContents(preferedType), return);
1180
1181         // get picture from clipboard
1182         FileName filename = theClipboard().getAsGraphics(cur, preferedType);
1183         if (filename.empty())
1184                 return;
1185
1186         // create inset for graphic
1187         InsetGraphics * inset = new InsetGraphics(cur.buffer());
1188         InsetGraphicsParams params;
1189         params.filename = support::DocFileName(filename.absFileName(), false);
1190         inset->setParams(params);
1191         cur.recordUndo();
1192         cur.insert(inset);
1193 }
1194
1195
1196 void pasteSelection(Cursor & cur, ErrorList & errorList)
1197 {
1198         if (selectionBuffer.empty())
1199                 return;
1200         cur.recordUndo();
1201         pasteParagraphList(cur, selectionBuffer[0].first,
1202                            selectionBuffer[0].second, errorList);
1203 }
1204
1205
1206 void replaceSelectionWithString(Cursor & cur, docstring const & str)
1207 {
1208         cur.recordUndo();
1209         DocIterator selbeg = cur.selectionBegin();
1210
1211         // Get font setting before we cut, we need a copy here, not a bare reference.
1212         Font const font =
1213                 selbeg.paragraph().getFontSettings(cur.buffer()->params(), selbeg.pos());
1214
1215         // Insert the new string
1216         pos_type pos = cur.selEnd().pos();
1217         Paragraph & par = cur.selEnd().paragraph();
1218         docstring::const_iterator cit = str.begin();
1219         docstring::const_iterator end = str.end();
1220         for (; cit != end; ++cit, ++pos)
1221                 par.insertChar(pos, *cit, font, cur.buffer()->params().trackChanges);
1222
1223         // Cut the selection
1224         cutSelection(cur, true, false);
1225 }
1226
1227
1228 void replaceSelection(Cursor & cur)
1229 {
1230         if (cur.selection())
1231                 cutSelection(cur, true, false);
1232 }
1233
1234
1235 void eraseSelection(Cursor & cur)
1236 {
1237         //lyxerr << "cap::eraseSelection begin: " << cur << endl;
1238         CursorSlice const & i1 = cur.selBegin();
1239         CursorSlice const & i2 = cur.selEnd();
1240         if (i1.inset().asInsetMath()) {
1241                 saveSelection(cur);
1242                 cur.top() = i1;
1243                 if (i1.idx() == i2.idx()) {
1244                         i1.cell().erase(i1.pos(), i2.pos());
1245                         // We may have deleted i1.cell(cur.pos()).
1246                         // Make sure that pos is valid.
1247                         if (cur.pos() > cur.lastpos())
1248                                 cur.pos() = cur.lastpos();
1249                 } else {
1250                         InsetMath * p = i1.asInsetMath();
1251                         Inset::row_type r1, r2;
1252                         Inset::col_type c1, c2;
1253                         region(i1, i2, r1, r2, c1, c2);
1254                         for (Inset::row_type row = r1; row <= r2; ++row)
1255                                 for (Inset::col_type col = c1; col <= c2; ++col)
1256                                         p->cell(p->index(row, col)).clear();
1257                         // We've deleted the whole cell. Only pos 0 is valid.
1258                         cur.pos() = 0;
1259                 }
1260                 // need a valid cursor. (Lgb)
1261                 cur.clearSelection();
1262         } else {
1263                 lyxerr << "can't erase this selection 1" << endl;
1264         }
1265         //lyxerr << "cap::eraseSelection end: " << cur << endl;
1266 }
1267
1268
1269 void selDel(Cursor & cur)
1270 {
1271         //lyxerr << "cap::selDel" << endl;
1272         if (cur.selection())
1273                 eraseSelection(cur);
1274 }
1275
1276
1277 void selClearOrDel(Cursor & cur)
1278 {
1279         //lyxerr << "cap::selClearOrDel" << endl;
1280         if (lyxrc.auto_region_delete)
1281                 selDel(cur);
1282         else
1283                 cur.setSelection(false);
1284 }
1285
1286
1287 docstring grabSelection(Cursor const & cur)
1288 {
1289         if (!cur.selection())
1290                 return docstring();
1291
1292 #if 0
1293         // grab selection by glueing multiple cells together. This is not what
1294         // we want because selections spanning multiple cells will get "&" and "\\"
1295         // seperators.
1296         ostringstream os;
1297         for (DocIterator dit = cur.selectionBegin();
1298              dit != cur.selectionEnd(); dit.forwardPos())
1299                 os << asString(dit.cell());
1300         return os.str();
1301 #endif
1302
1303         CursorSlice i1 = cur.selBegin();
1304         CursorSlice i2 = cur.selEnd();
1305
1306         if (i1.idx() == i2.idx()) {
1307                 if (i1.inset().asInsetMath()) {
1308                         MathData::const_iterator it = i1.cell().begin();
1309                         Buffer * buf = cur.buffer();
1310                         return asString(MathData(buf, it + i1.pos(), it + i2.pos()));
1311                 } else {
1312                         return from_ascii("unknown selection 1");
1313                 }
1314         }
1315
1316         Inset::row_type r1, r2;
1317         Inset::col_type c1, c2;
1318         region(i1, i2, r1, r2, c1, c2);
1319
1320         docstring data;
1321         if (i1.inset().asInsetMath()) {
1322                 for (Inset::row_type row = r1; row <= r2; ++row) {
1323                         if (row > r1)
1324                                 data += "\\\\";
1325                         for (Inset::col_type col = c1; col <= c2; ++col) {
1326                                 if (col > c1)
1327                                         data += '&';
1328                                 data += asString(i1.asInsetMath()->
1329                                         cell(i1.asInsetMath()->index(row, col)));
1330                         }
1331                 }
1332         } else {
1333                 data = from_ascii("unknown selection 2");
1334         }
1335         return data;
1336 }
1337
1338
1339 void dirtyTabularStack(bool b)
1340 {
1341         dirty_tabular_stack_ = b;
1342 }
1343
1344
1345 bool tabularStackDirty()
1346 {
1347         return dirty_tabular_stack_;
1348 }
1349
1350
1351 } // namespace cap
1352 } // namespace lyx