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