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 "Buffer.h"
  19 #include "buffer_funcs.h"
  20 #include "BufferList.h"
  21 #include "BufferParams.h"
  22 #include "BufferView.h"
  23 #include "Changes.h"
  24 #include "Cursor.h"
  25 #include "ErrorList.h"
  26 #include "FuncCode.h"
  27 #include "FuncRequest.h"
  28 #include "InsetIterator.h"
  29 #include "InsetList.h"
  30 #include "Language.h"
  31 #include "LyXFunc.h"
  32 #include "LyXRC.h"
  33 #include "Text.h"
  34 #include "Paragraph.h"
  35 #include "paragraph_funcs.h"
  36 #include "ParagraphParameters.h"
  37 #include "ParIterator.h"
  38 #include "Undo.h"
  39
  40 #include "insets/InsetFlex.h"
  41 #include "insets/InsetCommand.h"
  42 #include "insets/InsetGraphics.h"
  43 #include "insets/InsetGraphicsParams.h"
  44 #include "insets/InsetInclude.h"
  45 #include "insets/InsetTabular.h"
  46
  47 #include "mathed/MathData.h"
  48 #include "mathed/InsetMath.h"
  49 #include "mathed/MathSupport.h"
  50
  51 #include "support/debug.h"
  52 #include "support/docstream.h"
  53 #include "support/gettext.h"
  54 #include "support/limited_stack.h"
  55 #include "support/lstrings.h"
  56
  57 #include "frontends/Clipboard.h"
  58 #include "frontends/Selection.h"
  59
  60 #include <boost/tuple/tuple.hpp>
  61 #include <boost/next_prior.hpp>
  62
  63 #include <string>
  64
  65 using namespace std;
  66 using namespace lyx::support;
  67 using lyx::frontend::Clipboard;
  68
  69 namespace lyx {
  70
  71 namespace {
  72
  73 typedef pair<pit_type, int> PitPosPair;
  74
  75 typedef limited_stack<pair<ParagraphList, DocumentClass const *> > CutStack;
  76
  77 CutStack theCuts(10);
  78 // persistent selection, cleared until the next selection
  79 CutStack selectionBuffer(1);
  80
  81 // store whether the tabular stack is newer than the normal copy stack
  82 // FIXME: this is a workaround for bug 1919. Should be removed for 1.5,
  83 // when we (hopefully) have a one-for-all paste mechanism.
  84 bool dirty_tabular_stack_ = false;
  85
  86
  87 bool checkPastePossible(int index)
  88 {
  89         return size_t(index) < theCuts.size() && !theCuts[index].first.empty();
  90 }
  91
  92
  93 pair<PitPosPair, pit_type>
  94 pasteSelectionHelper(Cursor & cur, ParagraphList const & parlist,
  95                      DocumentClass const * const oldDocClass, ErrorList & errorlist)
  96 {
  97         Buffer const & buffer = *cur.buffer();
  98         pit_type pit = cur.pit();
  99         pos_type pos = cur.pos();
 100         InsetText * target_inset = cur.inset().asInsetText();
 101         if (!target_inset) {
 102                 InsetTabular * it = cur.inset().asInsetTabular();
 103                 target_inset = it? it->cell(cur.idx())->asInsetText() : 0;
 104         }
 105         LASSERT(target_inset, return make_pair(PitPosPair(pit, pos), pit));
 106         ParagraphList & pars = target_inset->paragraphs();
 107
 108         if (parlist.empty())
 109                 return make_pair(PitPosPair(pit, pos), pit);
 110
 111         BOOST_ASSERT (pos <= pars[pit].size());
 112
 113         // Make a copy of the CaP paragraphs.
 114         ParagraphList insertion = parlist;
 115         DocumentClass const * const newDocClass =
 116                 buffer.params().documentClassPtr();
 117
 118         // Now remove all out of the pars which is NOT allowed in the
 119         // new environment and set also another font if that is required.
 120
 121         // Convert newline to paragraph break in ERT inset.
 122         // This should not be here!
 123         InsetCode const code = target_inset->lyxCode();
 124         if (code == ERT_CODE || code == LISTINGS_CODE) {
 125                 for (size_t i = 0; i != insertion.size(); ++i) {
 126                         for (pos_type j = 0; j != insertion[i].size(); ++j) {
 127                                 if (insertion[i].isNewline(j)) {
 128                                         // do not track deletion of newline
 129                                         insertion[i].eraseChar(j, false);
 130                                         insertion[i].setInsetOwner(target_inset);
 131                                         breakParagraphConservative(
 132                                                         buffer.params(),
 133                                                         insertion, i, j);
 134                                         break;
 135                                 }
 136                         }
 137                 }
 138         }
 139
 140         // set the paragraphs to plain layout if necessary
 141         if (cur.inset().usePlainLayout()) {
 142                 bool forcePlainLayout = cur.inset().forcePlainLayout();
 143                 Layout const & plainLayout = newDocClass->plainLayout();
 144                 Layout const & defaultLayout = newDocClass->defaultLayout();
 145                 ParagraphList::iterator const end = insertion.end();
 146                 ParagraphList::iterator par = insertion.begin();
 147                 for (; par != end; ++par) {
 148                         Layout const & parLayout = par->layout();
 149                         if (forcePlainLayout || parLayout == defaultLayout)
 150                                 par->setLayout(plainLayout);
 151                 }
 152         } else { // check if we need to reset from plain layout
 153                 Layout const & defaultLayout = newDocClass->defaultLayout();
 154                 Layout const & plainLayout = newDocClass->plainLayout();
 155                 ParagraphList::iterator const end = insertion.end();
 156                 ParagraphList::iterator par = insertion.begin();
 157                 for (; par != end; ++par) {
 158                         Layout const & parLayout = par->layout();
 159                         if (parLayout == plainLayout)
 160                                 par->setLayout(defaultLayout);
 161                 }
 162         }
 163
 164         InsetText in(buffer);
 165         // Make sure there is no class difference.
 166         in.paragraphs().clear();
 167         // This works without copying any paragraph data because we have
 168         // a specialized swap method for ParagraphList. This is important
 169         // since we store pointers to insets at some places and we don't
 170         // want to invalidate them.
 171         insertion.swap(in.paragraphs());
 172         cap::switchBetweenClasses(oldDocClass, newDocClass, in, errorlist);
 173         insertion.swap(in.paragraphs());
 174
 175         ParagraphList::iterator tmpbuf = insertion.begin();
 176         int depth_delta = pars[pit].params().depth() - tmpbuf->params().depth();
 177
 178         depth_type max_depth = pars[pit].getMaxDepthAfter();
 179
 180         for (; tmpbuf != insertion.end(); ++tmpbuf) {
 181                 // If we have a negative jump so that the depth would
 182                 // go below 0 depth then we have to redo the delta to
 183                 // this new max depth level so that subsequent
 184                 // paragraphs are aligned correctly to this paragraph
 185                 // at level 0.
 186                 if (int(tmpbuf->params().depth()) + depth_delta < 0)
 187                         depth_delta = 0;
 188
 189                 // Set the right depth so that we are not too deep or shallow.
 190                 tmpbuf->params().depth(tmpbuf->params().depth() + depth_delta);
 191                 if (tmpbuf->params().depth() > max_depth)
 192                         tmpbuf->params().depth(max_depth);
 193
 194                 // Only set this from the 2nd on as the 2nd depends
 195                 // for maxDepth still on pit.
 196                 if (tmpbuf != insertion.begin())
 197                         max_depth = tmpbuf->getMaxDepthAfter();
 198
 199                 // Set the inset owner of this paragraph.
 200                 tmpbuf->setInsetOwner(target_inset);
 201                 for (pos_type i = 0; i < tmpbuf->size(); ++i) {
 202                         // do not track deletion of invalid insets
 203                         if (Inset * inset = tmpbuf->getInset(i))
 204                                 if (!target_inset->insetAllowed(inset->lyxCode()))
 205                                         tmpbuf->eraseChar(i--, false);
 206                 }
 207
 208                 tmpbuf->setChange(Change(buffer.params().trackChanges ?
 209                                          Change::INSERTED : Change::UNCHANGED));
 210         }
 211
 212         bool const empty = pars[pit].empty();
 213         if (!empty) {
 214                 // Make the buf exactly the same layout as the cursor
 215                 // paragraph.
 216                 insertion.begin()->makeSameLayout(pars[pit]);
 217         }
 218
 219         // Prepare the paragraphs and insets for insertion.
 220         insertion.swap(in.paragraphs());
 221
 222         InsetIterator const i_end = inset_iterator_end(in);
 223         for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
 224                 // Even though this will also be done later, it has to be done here
 225                 // since, e.g., InsetLabel::updateCommand() is going to try to access
 226                 // the buffer() member.
 227                 it->setBuffer(const_cast<Buffer &>(buffer));
 228                 switch (it->lyxCode()) {
 229
 230                 case LABEL_CODE: {
 231                         // check for duplicates
 232                         InsetCommand & lab = static_cast<InsetCommand &>(*it);
 233                         docstring const oldname = lab.getParam("name");
 234                         lab.updateCommand(oldname, false);
 235                         docstring const newname = lab.getParam("name");
 236                         if (oldname != newname) {
 237                                 // adapt the references
 238                                 for (InsetIterator itt = inset_iterator_begin(in); itt != i_end; ++itt) {
 239                                         if (itt->lyxCode() == REF_CODE) {
 240                                                 InsetCommand & ref = dynamic_cast<InsetCommand &>(*itt);
 241                                                 if (ref.getParam("reference") == oldname)
 242                                                         ref.setParam("reference", newname);
 243                                         }
 244                                 }
 245                         }
 246                         break;
 247                 }
 248
 249                 case INCLUDE_CODE: {
 250                         InsetInclude & inc = static_cast<InsetInclude &>(*it);
 251                         inc.updateCommand();
 252                         break;
 253                 }
 254
 255                 case BIBITEM_CODE: {
 256                         // check for duplicates
 257                         InsetCommand & bib = static_cast<InsetCommand &>(*it);
 258                         docstring const oldkey = bib.getParam("key");
 259                         bib.updateCommand(oldkey, false);
 260                         docstring const newkey = bib.getParam("key");
 261                         if (oldkey != newkey) {
 262                                 // adapt the references
 263                                 for (InsetIterator itt = inset_iterator_begin(in); itt != i_end; ++itt) {
 264                                         if (itt->lyxCode() == CITE_CODE) {
 265                                                 InsetCommand & ref = dynamic_cast<InsetCommand &>(*itt);
 266                                                 if (ref.getParam("key") == oldkey)
 267                                                         ref.setParam("key", newkey);
 268                                         }
 269                                 }
 270                         }
 271                         break;
 272                 }
 273
 274                 default:
 275                         break; // nothing
 276                 }
 277         }
 278         insertion.swap(in.paragraphs());
 279
 280         // Split the paragraph for inserting the buf if necessary.
 281         if (!empty)
 282                 breakParagraphConservative(buffer.params(), pars, pit, pos);
 283
 284         // Paste it!
 285         if (empty) {
 286                 pars.insert(boost::next(pars.begin(), pit),
 287                             insertion.begin(),
 288                             insertion.end());
 289
 290                 // merge the empty par with the last par of the insertion
 291                 mergeParagraph(buffer.params(), pars,
 292                                pit + insertion.size() - 1);
 293         } else {
 294                 pars.insert(boost::next(pars.begin(), pit + 1),
 295                             insertion.begin(),
 296                             insertion.end());
 297
 298                 // merge the first par of the insertion with the current par
 299                 mergeParagraph(buffer.params(), pars, pit);
 300         }
 301
 302         // Store the new cursor position.
 303         pit_type last_paste = pit + insertion.size() - 1;
 304         pit_type startpit = pit;
 305         pit = last_paste;
 306         pos = pars[last_paste].size();
 307
 308         // FIXME Should we do it here, or should we let updateLabels() do it?
 309         // Set paragraph buffers. It's important to do this right away
 310         // before something calls Inset::buffer() and causes a crash.
 311         for (pit_type p = startpit; p <= pit; ++p)
 312                 pars[p].setBuffer(const_cast<Buffer &>(buffer));
 313
 314         // Join (conditionally) last pasted paragraph with next one, i.e.,
 315         // the tail of the spliced document paragraph
 316         if (!empty && last_paste + 1 != pit_type(pars.size())) {
 317                 if (pars[last_paste + 1].hasSameLayout(pars[last_paste])) {
 318                         mergeParagraph(buffer.params(), pars, last_paste);
 319                 } else if (pars[last_paste + 1].empty()) {
 320                         pars[last_paste + 1].makeSameLayout(pars[last_paste]);
 321                         mergeParagraph(buffer.params(), pars, last_paste);
 322                 } else if (pars[last_paste].empty()) {
 323                         pars[last_paste].makeSameLayout(pars[last_paste + 1]);
 324                         mergeParagraph(buffer.params(), pars, last_paste);
 325                 } else {
 326                         pars[last_paste + 1].stripLeadingSpaces(buffer.params().trackChanges);
 327                         ++last_paste;
 328                 }
 329         }
 330
 331         return make_pair(PitPosPair(pit, pos), last_paste + 1);
 332 }
 333
 334
 335 PitPosPair eraseSelectionHelper(BufferParams const & params,
 336         ParagraphList & pars,
 337         pit_type startpit, pit_type endpit,
 338         int startpos, int endpos)
 339 {
 340         // Start of selection is really invalid.
 341         if (startpit == pit_type(pars.size()) ||
 342             (startpos > pars[startpit].size()))
 343                 return PitPosPair(endpit, endpos);
 344
 345         // Start and end is inside same paragraph
 346         if (endpit == pit_type(pars.size()) || startpit == endpit) {
 347                 endpos -= pars[startpit].eraseChars(startpos, endpos, params.trackChanges);
 348                 return PitPosPair(endpit, endpos);
 349         }
 350
 351         for (pit_type pit = startpit; pit != endpit + 1;) {
 352                 pos_type const left  = (pit == startpit ? startpos : 0);
 353                 pos_type right = (pit == endpit ? endpos : pars[pit].size() + 1);
 354                 bool const merge = pars[pit].isMergedOnEndOfParDeletion(params.trackChanges);
 355
 356                 // Logically erase only, including the end-of-paragraph character
 357                 pars[pit].eraseChars(left, right, params.trackChanges);
 358
 359                 // Separate handling of paragraph break:
 360                 if (merge && pit != endpit &&
 361                     (pit + 1 != endpit
 362                      || pars[pit].hasSameLayout(pars[endpit])
 363                      || pars[endpit].size() == endpos)) {
 364                         if (pit + 1 == endpit)
 365                                 endpos += pars[pit].size();
 366                         mergeParagraph(params, pars, pit);
 367                         --endpit;
 368                 } else
 369                         ++pit;
 370         }
 371
 372         // Ensure legal cursor pos:
 373         endpit = startpit;
 374         endpos = startpos;
 375         return PitPosPair(endpit, endpos);
 376 }
 377
 378
 379 void putClipboard(ParagraphList const & paragraphs,
 380         DocumentClass const * const docclass, docstring const & plaintext)
 381 {
 382         // For some strange reason gcc 3.2 and 3.3 do not accept
 383         // Buffer buffer(string(), false);
 384         // This needs to be static to avoid a memory leak. When a Buffer is
 385         // constructed, it constructs a BufferParams, which in turn constructs
 386         // a DocumentClass, via new, that is never deleted. If we were to go to
 387         // some kind of garbage collection there, or a shared_ptr, then this
 388         // would not be needed.
 389         static Buffer * buffer = theBufferList().newBuffer(
 390                 FileName::tempName().absFilename() + "_clipboard.internal");
 391         buffer->setUnnamed(true);
 392         buffer->paragraphs() = paragraphs;
 393         buffer->inset().setBuffer(*buffer);
 394         buffer->params().setDocumentClass(docclass);
 395         ostringstream lyx;
 396         if (buffer->write(lyx))
 397                 theClipboard().put(lyx.str(), plaintext);
 398         else
 399                 theClipboard().put(string(), plaintext);
 400         // Save that memory
 401         buffer->paragraphs().clear();
 402 }
 403
 404
 405 void copySelectionHelper(Buffer const & buf, ParagraphList const & pars,
 406         pit_type startpit, pit_type endpit,
 407         int start, int end, DocumentClass const * const dc, CutStack & cutstack)
 408 {
 409         LASSERT(0 <= start && start <= pars[startpit].size(), /**/);
 410         LASSERT(0 <= end && end <= pars[endpit].size(), /**/);
 411         LASSERT(startpit != endpit || start <= end, /**/);
 412
 413         // Clone the paragraphs within the selection.
 414         ParagraphList copy_pars(boost::next(pars.begin(), startpit),
 415                                 boost::next(pars.begin(), endpit + 1));
 416
 417         // Remove the end of the last paragraph; afterwards, remove the
 418         // beginning of the first paragraph. Keep this order - there may only
 419         // be one paragraph!  Do not track deletions here; this is an internal
 420         // action not visible to the user
 421
 422         Paragraph & back = copy_pars.back();
 423         back.eraseChars(end, back.size(), false);
 424         Paragraph & front = copy_pars.front();
 425         front.eraseChars(0, start, false);
 426
 427         ParagraphList::iterator it = copy_pars.begin();
 428         ParagraphList::iterator it_end = copy_pars.end();
 429
 430         for (; it != it_end; it++) {
 431                 // ERT paragraphs have the Language latex_language.
 432                 // This is invalid outside of ERT, so we need to change it
 433                 // to the buffer language.
 434                 if (it->ownerCode() == ERT_CODE || it->ownerCode() == LISTINGS_CODE)
 435                         it->changeLanguage(buf.params(), latex_language, buf.language());
 436
 437                 it->setInsetOwner(0);
 438         }
 439
 440         // do not copy text (also nested in insets) which is marked as deleted,
 441         // unless the whole selection was deleted
 442         if (!isFullyDeleted(copy_pars))
 443                 acceptChanges(copy_pars, buf.params());
 444
 445         DocumentClass * d = const_cast<DocumentClass *>(dc);
 446         cutstack.push(make_pair(copy_pars, d));
 447 }
 448
 449 } // namespace anon
 450
 451
 452
 453
 454 namespace cap {
 455
 456 void region(CursorSlice const & i1, CursorSlice const & i2,
 457             Inset::row_type & r1, Inset::row_type & r2,
 458             Inset::col_type & c1, Inset::col_type & c2)
 459 {
 460         Inset & p = i1.inset();
 461         c1 = p.col(i1.idx());
 462         c2 = p.col(i2.idx());
 463         if (c1 > c2)
 464                 swap(c1, c2);
 465         r1 = p.row(i1.idx());
 466         r2 = p.row(i2.idx());
 467         if (r1 > r2)
 468                 swap(r1, r2);
 469 }
 470
 471
 472 docstring grabAndEraseSelection(Cursor & cur)
 473 {
 474         if (!cur.selection())
 475                 return docstring();
 476         docstring res = grabSelection(cur);
 477         eraseSelection(cur);
 478         return res;
 479 }
 480
 481
 482 bool reduceSelectionToOneCell(Cursor & cur)
 483 {
 484         if (!cur.selection() || !cur.inMathed())
 485                 return false;
 486
 487         CursorSlice i1 = cur.selBegin();
 488         CursorSlice i2 = cur.selEnd();
 489         if (!i1.inset().asInsetMath())
 490                 return false;
 491
 492         // the easy case: do nothing if only one cell is selected
 493         if (i1.idx() == i2.idx())
 494                 return true;
 495
 496         cur.top().pos() = 0;
 497         cur.resetAnchor();
 498         cur.top().pos() = cur.top().lastpos();
 499
 500         return true;
 501 }
 502
 503
 504 bool multipleCellsSelected(Cursor const & cur)
 505 {
 506         if (!cur.selection() || !cur.inMathed())
 507                 return false;
 508
 509         CursorSlice i1 = cur.selBegin();
 510         CursorSlice i2 = cur.selEnd();
 511         if (!i1.inset().asInsetMath())
 512                 return false;
 513
 514         if (i1.idx() == i2.idx())
 515                 return false;
 516
 517         return true;
 518 }
 519
 520
 521 void switchBetweenClasses(DocumentClass const * const oldone,
 522                 DocumentClass const * const newone, InsetText & in, ErrorList & errorlist)
 523 {
 524         errorlist.clear();
 525
 526         LASSERT(!in.paragraphs().empty(), /**/);
 527         if (oldone == newone)
 528                 return;
 529
 530         DocumentClass const & oldtc = *oldone;
 531         DocumentClass const & newtc = *newone;
 532
 533         // layouts
 534         ParIterator end = par_iterator_end(in);
 535         for (ParIterator it = par_iterator_begin(in); it != end; ++it) {
 536                 docstring const name = it->layout().name();
 537
 538                 // the pasted text will keep their own layout name. If this layout does
 539                 // not exist in the new document, it will behave like a standard layout.
 540                 newtc.addLayoutIfNeeded(name);
 541
 542                 if (in.usePlainLayout())
 543                         it->setLayout(newtc.plainLayout());
 544                 else
 545                         it->setLayout(newtc[name]);
 546         }
 547
 548         // character styles
 549         InsetIterator const i_end = inset_iterator_end(in);
 550         for (InsetIterator it = inset_iterator_begin(in); it != i_end; ++it) {
 551                 InsetCollapsable * inset = it->asInsetCollapsable();
 552                 if (!inset)
 553                         continue;
 554                 if (inset->lyxCode() != FLEX_CODE)
 555                         // FIXME: Should we verify all InsetCollapsable?
 556                         continue;
 557                 inset->setLayout(newone);
 558                 if (!inset->undefined())
 559                         continue;
 560                 // The flex inset is undefined in newtc
 561                 docstring const s = bformat(_(
 562                         "Flex inset %1$s is "
 563                         "undefined because of class "
 564                         "conversion from\n%2$s to %3$s"),
 565                         inset->name(), from_utf8(oldtc.name()),
 566                         from_utf8(newtc.name()));
 567                 // To warn the user that something had to be done.
 568                 errorlist.push_back(ErrorItem(
 569                                 _("Undefined flex inset"),
 570                                 s, it.paragraph().id(), it.pos(), it.pos() + 1));
 571         }
 572 }
 573
 574
 575 vector<docstring> availableSelections(Buffer const * buf)
 576 {
 577         vector<docstring> selList;
 578         if (!buf)
 579                 return selList;
 580
 581         CutStack::const_iterator cit = theCuts.begin();
 582         CutStack::const_iterator end = theCuts.end();
 583         for (; cit != end; ++cit) {
 584                 // we do not use cit-> here because gcc 2.9x does not
 585                 // like it (JMarc)
 586                 ParagraphList const & pars = (*cit).first;
 587                 docstring asciiSel;
 588                 ParagraphList::const_iterator pit = pars.begin();
 589                 ParagraphList::const_iterator pend = pars.end();
 590                 for (; pit != pend; ++pit) {
 591                         Paragraph par(*pit, 0, 26);
 592                         // adapt paragraph to current buffer.
 593                         par.setBuffer(const_cast<Buffer &>(*buf));
 594                         asciiSel += par.asString(AS_STR_INSETS);
 595                         if (asciiSel.size() > 25) {
 596                                 asciiSel.replace(22, docstring::npos,
 597                                                  from_ascii("..."));
 598                                 break;
 599                         }
 600                 }
 601
 602                 selList.push_back(asciiSel);
 603         }
 604
 605         return selList;
 606 }
 607
 608
 609 size_type numberOfSelections()
 610 {
 611         return theCuts.size();
 612 }
 613
 614
 615 void cutSelection(Cursor & cur, bool doclear, bool realcut)
 616 {
 617         // This doesn't make sense, if there is no selection
 618         if (!cur.selection())
 619                 return;
 620
 621         // OK, we have a selection. This is always between cur.selBegin()
 622         // and cur.selEnd()
 623
 624         if (cur.inTexted()) {
 625                 Text * text = cur.text();
 626                 LASSERT(text, /**/);
 627
 628                 saveSelection(cur);
 629
 630                 // make sure that the depth behind the selection are restored, too
 631                 cur.recordUndoSelection();
 632                 pit_type begpit = cur.selBegin().pit();
 633                 pit_type endpit = cur.selEnd().pit();
 634
 635                 int endpos = cur.selEnd().pos();
 636
 637                 BufferParams const & bp = cur.buffer()->params();
 638                 if (realcut) {
 639                         copySelectionHelper(*cur.buffer(),
 640                                 text->paragraphs(),
 641                                 begpit, endpit,
 642                                 cur.selBegin().pos(), endpos,
 643                                 bp.documentClassPtr(), theCuts);
 644                         // Stuff what we got on the clipboard.
 645                         // Even if there is no selection.
 646                         putClipboard(theCuts[0].first, theCuts[0].second,
 647                                 cur.selectionAsString(true));
 648                 }
 649
 650                 if (begpit != endpit)
 651                         cur.updateFlags(Update::Force | Update::FitCursor);
 652
 653                 boost::tie(endpit, endpos) =
 654                         eraseSelectionHelper(bp,
 655                                 text->paragraphs(),
 656                                 begpit, endpit,
 657                                 cur.selBegin().pos(), endpos);
 658
 659                 // cutSelection can invalidate the cursor so we need to set
 660                 // it anew. (Lgb)
 661                 // we prefer the end for when tracking changes
 662                 cur.pos() = endpos;
 663                 cur.pit() = endpit;
 664
 665                 // sometimes necessary
 666                 if (doclear
 667                         && text->paragraphs()[begpit].stripLeadingSpaces(bp.trackChanges))
 668                         cur.fixIfBroken();
 669
 670                 // need a valid cursor. (Lgb)
 671                 cur.clearSelection();
 672                 cur.buffer()->updateLabels();
 673
 674                 // tell tabular that a recent copy happened
 675                 dirtyTabularStack(false);
 676         }
 677
 678         if (cur.inMathed()) {
 679                 if (cur.selBegin().idx() != cur.selEnd().idx()) {
 680                         // The current selection spans more than one cell.
 681                         // Record all cells
 682                         cur.recordUndoInset();
 683                 } else {
 684                         // Record only the current cell to avoid a jumping
 685                         // cursor after undo
 686                         cur.recordUndo();
 687                 }
 688                 if (realcut)
 689                         copySelection(cur);
 690                 eraseSelection(cur);
 691         }
 692 }
 693
 694
 695 void copySelection(Cursor const & cur)
 696 {
 697         copySelection(cur, cur.selectionAsString(true));
 698 }
 699
 700
 701 void copyInset(Cursor const & cur, Inset * inset, docstring const & plaintext)
 702 {
 703         ParagraphList pars;
 704         Paragraph par;
 705         BufferParams const & bp = cur.buffer()->params();
 706         par.setLayout(bp.documentClass().plainLayout());
 707         par.insertInset(0, inset, Change(Change::UNCHANGED));
 708         pars.push_back(par);
 709         theCuts.push(make_pair(pars, bp.documentClassPtr()));
 710
 711         // stuff the selection onto the X clipboard, from an explicit copy request
 712         putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
 713 }
 714
 715 namespace {
 716
 717 void copySelectionToStack(Cursor const & cur, CutStack & cutstack)
 718 {
 719         // this doesn't make sense, if there is no selection
 720         if (!cur.selection())
 721                 return;
 722
 723         // copySelection can not yet handle the case of cross idx selection
 724         if (cur.selBegin().idx() != cur.selEnd().idx())
 725                 return;
 726
 727         if (cur.inTexted()) {
 728                 Text * text = cur.text();
 729                 LASSERT(text, /**/);
 730                 // ok we have a selection. This is always between cur.selBegin()
 731                 // and sel_end cursor
 732
 733                 // copy behind a space if there is one
 734                 ParagraphList & pars = text->paragraphs();
 735                 pos_type pos = cur.selBegin().pos();
 736                 pit_type par = cur.selBegin().pit();
 737                 while (pos < pars[par].size() &&
 738                        pars[par].isLineSeparator(pos) &&
 739                        (par != cur.selEnd().pit() || pos < cur.selEnd().pos()))
 740                         ++pos;
 741
 742                 copySelectionHelper(*cur.buffer(), pars, par, cur.selEnd().pit(),
 743                         pos, cur.selEnd().pos(),
 744                         cur.buffer()->params().documentClassPtr(), cutstack);
 745
 746                 // Reset the dirty_tabular_stack_ flag only when something
 747                 // is copied to the clipboard (not to the selectionBuffer).
 748                 if (&cutstack == &theCuts)
 749                         dirtyTabularStack(false);
 750         }
 751
 752         if (cur.inMathed()) {
 753                 //lyxerr << "copySelection in mathed" << endl;
 754                 ParagraphList pars;
 755                 Paragraph par;
 756                 BufferParams const & bp = cur.buffer()->params();
 757                 // FIXME This should be the plain layout...right?
 758                 par.setLayout(bp.documentClass().plainLayout());
 759                 par.insert(0, grabSelection(cur), Font(), Change(Change::UNCHANGED));
 760                 pars.push_back(par);
 761                 cutstack.push(make_pair(pars, bp.documentClassPtr()));
 762         }
 763 }
 764
 765 }
 766
 767
 768 void copySelectionToStack()
 769 {
 770         if (!selectionBuffer.empty())
 771                 theCuts.push(selectionBuffer[0]);
 772 }
 773
 774
 775 void copySelection(Cursor const & cur, docstring const & plaintext)
 776 {
 777         // In tablemode, because copy and paste actually use special table stack
 778         // we do not attempt to get selected paragraphs under cursor. Instead, a
 779         // paragraph with the plain text version is generated so that table cells
 780         // can be pasted as pure text somewhere else.
 781         if (cur.selBegin().idx() != cur.selEnd().idx()) {
 782                 ParagraphList pars;
 783                 Paragraph par;
 784                 BufferParams const & bp = cur.buffer()->params();
 785                 par.setLayout(bp.documentClass().plainLayout());
 786                 par.insert(0, plaintext, Font(), Change(Change::UNCHANGED));
 787                 pars.push_back(par);
 788                 theCuts.push(make_pair(pars, bp.documentClassPtr()));
 789         } else {
 790                 copySelectionToStack(cur, theCuts);
 791         }
 792
 793         // stuff the selection onto the X clipboard, from an explicit copy request
 794         putClipboard(theCuts[0].first, theCuts[0].second, plaintext);
 795 }
 796
 797
 798 void saveSelection(Cursor const & cur)
 799 {
 800         // This function is called, not when a selection is formed, but when
 801         // a selection is cleared. Therefore, multiple keyboard selection
 802         // will not repeatively trigger this function (bug 3877).
 803         if (cur.selection()
 804             && cur.selBegin() == cur.bv().cursor().selBegin()
 805             && cur.selEnd() == cur.bv().cursor().selEnd()) {
 806                 LYXERR(Debug::SELECTION, "saveSelection: '" << cur.selectionAsString(true) << "'");
 807                 copySelectionToStack(cur, selectionBuffer);
 808         }
 809 }
 810
 811
 812 bool selection()
 813 {
 814         return !selectionBuffer.empty();
 815 }
 816
 817
 818 void clearSelection()
 819 {
 820         selectionBuffer.clear();
 821 }
 822
 823
 824 void clearCutStack()
 825 {
 826         theCuts.clear();
 827 }
 828
 829
 830 docstring selection(size_t sel_index)
 831 {
 832         return sel_index < theCuts.size()
 833                 ? theCuts[sel_index].first.back().asString(AS_STR_INSETS | AS_STR_NEWLINES)
 834                 : docstring();
 835 }
 836
 837
 838 void pasteParagraphList(Cursor & cur, ParagraphList const & parlist,
 839                         DocumentClass const * const docclass, ErrorList & errorList)
 840 {
 841         if (cur.inTexted()) {
 842                 Text * text = cur.text();
 843                 LASSERT(text, /**/);
 844
 845                 pit_type endpit;
 846                 PitPosPair ppp;
 847
 848                 boost::tie(ppp, endpit) =
 849                         pasteSelectionHelper(cur, parlist, docclass, errorList);
 850                 cur.buffer()->updateLabels();
 851                 cur.clearSelection();
 852                 text->setCursor(cur, ppp.first, ppp.second);
 853         }
 854
 855         // mathed is handled in InsetMathNest/InsetMathGrid
 856         LASSERT(!cur.inMathed(), /**/);
 857 }
 858
 859
 860 void pasteFromStack(Cursor & cur, ErrorList & errorList, size_t sel_index)
 861 {
 862         // this does not make sense, if there is nothing to paste
 863         if (!checkPastePossible(sel_index))
 864                 return;
 865
 866         cur.recordUndo();
 867         pasteParagraphList(cur, theCuts[sel_index].first,
 868                            theCuts[sel_index].second, errorList);
 869         cur.setSelection();
 870 }
 871
 872
 873 void pasteClipboardText(Cursor & cur, ErrorList & errorList, bool asParagraphs)
 874 {
 875         // Use internal clipboard if it is the most recent one
 876         if (theClipboard().isInternal()) {
 877                 pasteFromStack(cur, errorList, 0);
 878                 return;
 879         }
 880
 881         // First try LyX format
 882         if (theClipboard().hasLyXContents()) {
 883                 string lyx = theClipboard().getAsLyX();
 884                 if (!lyx.empty()) {
 885                         // For some strange reason gcc 3.2 and 3.3 do not accept
 886                         // Buffer buffer(string(), false);
 887                         Buffer buffer("", false);
 888                         buffer.setUnnamed(true);
 889                         if (buffer.readString(lyx)) {
 890                                 cur.recordUndo();
 891                                 pasteParagraphList(cur, buffer.paragraphs(),
 892                                         buffer.params().documentClassPtr(), errorList);
 893                                 cur.setSelection();
 894                                 return;
 895                         }
 896                 }
 897         }
 898
 899         // Then try plain text
 900         docstring const text = theClipboard().getAsText();
 901         if (text.empty())
 902                 return;
 903         cur.recordUndo();
 904         if (asParagraphs)
 905                 cur.text()->insertStringAsParagraphs(cur, text);
 906         else
 907                 cur.text()->insertStringAsLines(cur, text);
 908 }
 909
 910
 911 void pasteClipboardGraphics(Cursor & cur, ErrorList & /* errorList */,
 912                             Clipboard::GraphicsType preferedType)
 913 {
 914         LASSERT(theClipboard().hasGraphicsContents(preferedType), /**/);
 915
 916         // get picture from clipboard
 917         FileName filename = theClipboard().getAsGraphics(cur, preferedType);
 918         if (filename.empty())
 919                 return;
 920
 921         // create inset for graphic
 922         InsetGraphics * inset = new InsetGraphics(*cur.buffer());
 923         InsetGraphicsParams params;
 924         params.filename = support::DocFileName(filename.absFilename());
 925         inset->setParams(params);
 926         cur.recordUndo();
 927         cur.insert(inset);
 928 }
 929
 930
 931 void pasteSelection(Cursor & cur, ErrorList & errorList)
 932 {
 933         if (selectionBuffer.empty())
 934                 return;
 935         cur.recordUndo();
 936         pasteParagraphList(cur, selectionBuffer[0].first,
 937                            selectionBuffer[0].second, errorList);
 938 }
 939
 940
 941 void replaceSelectionWithString(Cursor & cur, docstring const & str, bool backwards)
 942 {
 943         cur.recordUndo();
 944         DocIterator selbeg = cur.selectionBegin();
 945
 946         // Get font setting before we cut, we need a copy here, not a bare reference.
 947         Font const font =
 948                 selbeg.paragraph().getFontSettings(cur.buffer()->params(), selbeg.pos());
 949
 950         // Insert the new string
 951         pos_type pos = cur.selEnd().pos();
 952         Paragraph & par = cur.selEnd().paragraph();
 953         docstring::const_iterator cit = str.begin();
 954         docstring::const_iterator end = str.end();
 955         for (; cit != end; ++cit, ++pos)
 956                 par.insertChar(pos, *cit, font, cur.buffer()->params().trackChanges);
 957
 958         // Cut the selection
 959         cutSelection(cur, true, false);
 960
 961         // select the replacement
 962         if (backwards) {
 963                 selbeg.pos() += str.length();
 964                 cur.setSelection(selbeg, -int(str.length()));
 965         } else
 966                 cur.setSelection(selbeg, str.length());
 967 }
 968
 969
 970 void replaceSelection(Cursor & cur)
 971 {
 972         if (cur.selection())
 973                 cutSelection(cur, true, false);
 974 }
 975
 976
 977 void eraseSelection(Cursor & cur)
 978 {
 979         //lyxerr << "cap::eraseSelection begin: " << cur << endl;
 980         CursorSlice const & i1 = cur.selBegin();
 981         CursorSlice const & i2 = cur.selEnd();
 982         if (i1.inset().asInsetMath()) {
 983                 saveSelection(cur);
 984                 cur.top() = i1;
 985                 if (i1.idx() == i2.idx()) {
 986                         i1.cell().erase(i1.pos(), i2.pos());
 987                         // We may have deleted i1.cell(cur.pos()).
 988                         // Make sure that pos is valid.
 989                         if (cur.pos() > cur.lastpos())
 990                                 cur.pos() = cur.lastpos();
 991                 } else {
 992                         InsetMath * p = i1.asInsetMath();
 993                         Inset::row_type r1, r2;
 994                         Inset::col_type c1, c2;
 995                         region(i1, i2, r1, r2, c1, c2);
 996                         for (Inset::row_type row = r1; row <= r2; ++row)
 997                                 for (Inset::col_type col = c1; col <= c2; ++col)
 998                                         p->cell(p->index(row, col)).clear();
 999                         // We've deleted the whole cell. Only pos 0 is valid.
1000                         cur.pos() = 0;
1001                 }
1002                 // need a valid cursor. (Lgb)
1003                 cur.clearSelection();
1004         } else {
1005                 lyxerr << "can't erase this selection 1" << endl;
1006         }
1007         //lyxerr << "cap::eraseSelection end: " << cur << endl;
1008 }
1009
1010
1011 void selDel(Cursor & cur)
1012 {
1013         //lyxerr << "cap::selDel" << endl;
1014         if (cur.selection())
1015                 eraseSelection(cur);
1016 }
1017
1018
1019 void selClearOrDel(Cursor & cur)
1020 {
1021         //lyxerr << "cap::selClearOrDel" << endl;
1022         if (lyxrc.auto_region_delete)
1023                 selDel(cur);
1024         else
1025                 cur.setSelection(false);
1026 }
1027
1028
1029 docstring grabSelection(Cursor const & cur)
1030 {
1031         if (!cur.selection())
1032                 return docstring();
1033
1034 #if 0
1035         // grab selection by glueing multiple cells together. This is not what
1036         // we want because selections spanning multiple cells will get "&" and "\\"
1037         // seperators.
1038         ostringstream os;
1039         for (DocIterator dit = cur.selectionBegin();
1040              dit != cur.selectionEnd(); dit.forwardPos())
1041                 os << asString(dit.cell());
1042         return os.str();
1043 #endif
1044
1045         CursorSlice i1 = cur.selBegin();
1046         CursorSlice i2 = cur.selEnd();
1047
1048         if (i1.idx() == i2.idx()) {
1049                 if (i1.inset().asInsetMath()) {
1050                         MathData::const_iterator it = i1.cell().begin();
1051                         return asString(MathData(it + i1.pos(), it + i2.pos()));
1052                 } else {
1053                         return from_ascii("unknown selection 1");
1054                 }
1055         }
1056
1057         Inset::row_type r1, r2;
1058         Inset::col_type c1, c2;
1059         region(i1, i2, r1, r2, c1, c2);
1060
1061         docstring data;
1062         if (i1.inset().asInsetMath()) {
1063                 for (Inset::row_type row = r1; row <= r2; ++row) {
1064                         if (row > r1)
1065                                 data += "\\\\";
1066                         for (Inset::col_type col = c1; col <= c2; ++col) {
1067                                 if (col > c1)
1068                                         data += '&';
1069                                 data += asString(i1.asInsetMath()->
1070                                         cell(i1.asInsetMath()->index(row, col)));
1071                         }
1072                 }
1073         } else {
1074                 data = from_ascii("unknown selection 2");
1075         }
1076         return data;
1077 }
1078
1079
1080 void dirtyTabularStack(bool b)
1081 {
1082         dirty_tabular_stack_ = b;
1083 }
1084
1085
1086 bool tabularStackDirty()
1087 {
1088         return dirty_tabular_stack_;
1089 }
1090
1091
1092 } // namespace cap
1093 } // namespace lyx