src/Text2.cpp

   1 /**
   2  * \file text2.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Lars Gullik Bjønnes
   8  * \author Alfredo Braunstein
   9  * \author Jean-Marc Lasgouttes
  10  * \author Angus Leeming
  11  * \author John Levon
  12  * \author André Pönitz
  13  * \author Allan Rae
  14  * \author Stefan Schimanski
  15  * \author Dekel Tsur
  16  * \author Jürgen Vigna
  17  *
  18  * Full author contact details are available in file CREDITS.
  19  */
  20
  21 #include <config.h>
  22
  23 #include "Text.h"
  24
  25 #include "Bidi.h"
  26 #include "Buffer.h"
  27 #include "buffer_funcs.h"
  28 #include "BufferList.h"
  29 #include "BufferParams.h"
  30 #include "BufferView.h"
  31 #include "Changes.h"
  32 #include "Cursor.h"
  33 #include "CutAndPaste.h"
  34 #include "DispatchResult.h"
  35 #include "ErrorList.h"
  36 #include "FuncRequest.h"
  37 #include "Language.h"
  38 #include "Layout.h"
  39 #include "Lexer.h"
  40 #include "LyXFunc.h"
  41 #include "LyXRC.h"
  42 #include "Paragraph.h"
  43 #include "paragraph_funcs.h"
  44 #include "ParagraphParameters.h"
  45 #include "TextClass.h"
  46 #include "TextMetrics.h"
  47 #include "VSpace.h"
  48
  49 #include "insets/InsetEnvironment.h"
  50
  51 #include "mathed/InsetMathHull.h"
  52
  53 #include "support/debug.h"
  54 #include "support/gettext.h"
  55 #include "support/textutils.h"
  56
  57 #include <boost/next_prior.hpp>
  58
  59 #include <sstream>
  60
  61 using namespace std;
  62
  63 namespace lyx {
  64
  65 Text::Text()
  66         : autoBreakRows_(false)
  67 {}
  68
  69
  70 bool Text::isMainText(Buffer const & buffer) const
  71 {
  72         return &buffer.text() == this;
  73 }
  74
  75
  76 FontInfo Text::getLayoutFont(Buffer const & buffer, pit_type const pit) const
  77 {
  78         LayoutPtr const & layout = pars_[pit].layout();
  79
  80         if (!pars_[pit].getDepth())  {
  81                 FontInfo lf = layout->resfont;
  82                 // In case the default family has been customized
  83                 if (layout->font.family() == INHERIT_FAMILY)
  84                         lf.setFamily(buffer.params().getFont().fontInfo().family());
  85                 return lf;
  86         }
  87
  88         FontInfo font = layout->font;
  89         // Realize with the fonts of lesser depth.
  90         //font.realize(outerFont(pit, paragraphs()));
  91         font.realize(buffer.params().getFont().fontInfo());
  92
  93         return font;
  94 }
  95
  96
  97 FontInfo Text::getLabelFont(Buffer const & buffer, Paragraph const & par) const
  98 {
  99         LayoutPtr const & layout = par.layout();
 100
 101         if (!par.getDepth()) {
 102                 FontInfo lf = layout->reslabelfont;
 103                 // In case the default family has been customized
 104                 if (layout->labelfont.family() == INHERIT_FAMILY)
 105                         lf.setFamily(buffer.params().getFont().fontInfo().family());
 106                 return lf;
 107         }
 108
 109         FontInfo font = layout->labelfont;
 110         // Realize with the fonts of lesser depth.
 111         font.realize(buffer.params().getFont().fontInfo());
 112
 113         return font;
 114 }
 115
 116
 117 void Text::setCharFont(Buffer const & buffer, pit_type pit,
 118                 pos_type pos, Font const & fnt, Font const & display_font)
 119 {
 120         Font font = fnt;
 121         LayoutPtr const & layout = pars_[pit].layout();
 122
 123         // Get concrete layout font to reduce against
 124         FontInfo layoutfont;
 125
 126         if (pos < pars_[pit].beginOfBody())
 127                 layoutfont = layout->labelfont;
 128         else
 129                 layoutfont = layout->font;
 130
 131         // Realize against environment font information
 132         if (pars_[pit].getDepth()) {
 133                 pit_type tp = pit;
 134                 while (!layoutfont.resolved() &&
 135                        tp != pit_type(paragraphs().size()) &&
 136                        pars_[tp].getDepth()) {
 137                         tp = outerHook(tp, paragraphs());
 138                         if (tp != pit_type(paragraphs().size()))
 139                                 layoutfont.realize(pars_[tp].layout()->font);
 140                 }
 141         }
 142
 143         // Inside inset, apply the inset's font attributes if any
 144         // (charstyle!)
 145         if (!isMainText(buffer))
 146                 layoutfont.realize(display_font.fontInfo());
 147
 148         layoutfont.realize(buffer.params().getFont().fontInfo());
 149
 150         // Now, reduce font against full layout font
 151         font.fontInfo().reduce(layoutfont);
 152
 153         pars_[pit].setFont(pos, font);
 154 }
 155
 156
 157 void Text::setInsetFont(BufferView const & bv, pit_type pit,
 158                 pos_type pos, Font const & font, bool toggleall)
 159 {
 160         Inset * const inset = pars_[pit].getInset(pos);
 161         BOOST_ASSERT(inset && inset->noFontChange());
 162
 163         CursorSlice::idx_type endidx = inset->nargs();
 164         for (CursorSlice cs(*inset); cs.idx() != endidx; ++cs.idx()) {
 165                 Text * text = cs.text();
 166                 if (text) {
 167                         // last position of the cell
 168                         CursorSlice cellend = cs;
 169                         cellend.pit() = cellend.lastpit();
 170                         cellend.pos() = cellend.lastpos();
 171                         text->setFont(bv, cs, cellend, font, toggleall);
 172                 }
 173         }
 174 }
 175
 176
 177 // return past-the-last paragraph influenced by a layout change on pit
 178 pit_type Text::undoSpan(pit_type pit)
 179 {
 180         pit_type end = paragraphs().size();
 181         pit_type nextpit = pit + 1;
 182         if (nextpit == end)
 183                 return nextpit;
 184         //because of parindents
 185         if (!pars_[pit].getDepth())
 186                 return boost::next(nextpit);
 187         //because of depth constrains
 188         for (; nextpit != end; ++pit, ++nextpit) {
 189                 if (!pars_[pit].getDepth())
 190                         break;
 191         }
 192         return nextpit;
 193 }
 194
 195
 196 void Text::setLayout(Buffer const & buffer, pit_type start, pit_type end,
 197                 docstring const & layout)
 198 {
 199         BOOST_ASSERT(start != end);
 200
 201         BufferParams const & bufparams = buffer.params();
 202         LayoutPtr const & lyxlayout = bufparams.textClass()[layout];
 203
 204         for (pit_type pit = start; pit != end; ++pit) {
 205                 Paragraph & par = pars_[pit];
 206                 par.applyLayout(lyxlayout);
 207                 if (lyxlayout->margintype == MARGIN_MANUAL)
 208                         par.setLabelWidthString(par.translateIfPossible(
 209                                 lyxlayout->labelstring(), buffer.params()));
 210         }
 211 }
 212
 213
 214 // set layout over selection and make a total rebreak of those paragraphs
 215 void Text::setLayout(Cursor & cur, docstring const & layout)
 216 {
 217         BOOST_ASSERT(this == cur.text());
 218         // special handling of new environment insets
 219         BufferView & bv = cur.bv();
 220         BufferParams const & params = bv.buffer().params();
 221         LayoutPtr const & lyxlayout = params.textClass()[layout];
 222         if (lyxlayout->is_environment) {
 223                 // move everything in a new environment inset
 224                 LYXERR(Debug::DEBUG, "setting layout " << to_utf8(layout));
 225                 lyx::dispatch(FuncRequest(LFUN_LINE_BEGIN));
 226                 lyx::dispatch(FuncRequest(LFUN_LINE_END_SELECT));
 227                 lyx::dispatch(FuncRequest(LFUN_CUT));
 228                 Inset * inset = new InsetEnvironment(params, layout);
 229                 insertInset(cur, inset);
 230                 //inset->edit(cur, true);
 231                 //lyx::dispatch(FuncRequest(LFUN_PASTE));
 232                 return;
 233         }
 234
 235         pit_type start = cur.selBegin().pit();
 236         pit_type end = cur.selEnd().pit() + 1;
 237         pit_type undopit = undoSpan(end - 1);
 238         recUndo(cur, start, undopit - 1);
 239         setLayout(cur.buffer(), start, end, layout);
 240         updateLabels(cur.buffer());
 241 }
 242
 243
 244 static bool changeDepthAllowed(Text::DEPTH_CHANGE type,
 245                         Paragraph const & par, int max_depth)
 246 {
 247         if (par.layout()->labeltype == LABEL_BIBLIO)
 248                 return false;
 249         int const depth = par.params().depth();
 250         if (type == Text::INC_DEPTH && depth < max_depth)
 251                 return true;
 252         if (type == Text::DEC_DEPTH && depth > 0)
 253                 return true;
 254         return false;
 255 }
 256
 257
 258 bool Text::changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const
 259 {
 260         BOOST_ASSERT(this == cur.text());
 261         // this happens when selecting several cells in tabular (bug 2630)
 262         if (cur.selBegin().idx() != cur.selEnd().idx())
 263                 return false;
 264
 265         pit_type const beg = cur.selBegin().pit();
 266         pit_type const end = cur.selEnd().pit() + 1;
 267         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
 268
 269         for (pit_type pit = beg; pit != end; ++pit) {
 270                 if (lyx::changeDepthAllowed(type, pars_[pit], max_depth))
 271                         return true;
 272                 max_depth = pars_[pit].getMaxDepthAfter();
 273         }
 274         return false;
 275 }
 276
 277
 278 void Text::changeDepth(Cursor & cur, DEPTH_CHANGE type)
 279 {
 280         BOOST_ASSERT(this == cur.text());
 281         pit_type const beg = cur.selBegin().pit();
 282         pit_type const end = cur.selEnd().pit() + 1;
 283         cur.recordUndoSelection();
 284         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
 285
 286         for (pit_type pit = beg; pit != end; ++pit) {
 287                 Paragraph & par = pars_[pit];
 288                 if (lyx::changeDepthAllowed(type, par, max_depth)) {
 289                         int const depth = par.params().depth();
 290                         if (type == INC_DEPTH)
 291                                 par.params().depth(depth + 1);
 292                         else
 293                                 par.params().depth(depth - 1);
 294                 }
 295                 max_depth = par.getMaxDepthAfter();
 296         }
 297         // this handles the counter labels, and also fixes up
 298         // depth values for follow-on (child) paragraphs
 299         updateLabels(cur.buffer());
 300 }
 301
 302
 303 void Text::setFont(Cursor & cur, Font const & font, bool toggleall)
 304 {
 305         BOOST_ASSERT(this == cur.text());
 306         // Set the current_font
 307         // Determine basis font
 308         FontInfo layoutfont;
 309         pit_type pit = cur.pit();
 310         if (cur.pos() < pars_[pit].beginOfBody())
 311                 layoutfont = getLabelFont(cur.buffer(), pars_[pit]);
 312         else
 313                 layoutfont = getLayoutFont(cur.buffer(), pit);
 314
 315         // Update current font
 316         cur.real_current_font.update(font,
 317                                         cur.buffer().params().language,
 318                                         toggleall);
 319
 320         // Reduce to implicit settings
 321         cur.current_font = cur.real_current_font;
 322         cur.current_font.fontInfo().reduce(layoutfont);
 323         // And resolve it completely
 324         cur.real_current_font.fontInfo().realize(layoutfont);
 325
 326         // if there is no selection that's all we need to do
 327         if (!cur.selection())
 328                 return;
 329
 330         // Ok, we have a selection.
 331         cur.recordUndoSelection();
 332
 333         setFont(cur.bv(), cur.selectionBegin().top(),
 334                 cur.selectionEnd().top(), font, toggleall);
 335 }
 336
 337
 338 void Text::setFont(BufferView const & bv, CursorSlice const & begin,
 339                 CursorSlice const & end, Font const & font,
 340                 bool toggleall)
 341 {
 342         Buffer const & buffer = bv.buffer();
 343
 344         // Don't use forwardChar here as ditend might have
 345         // pos() == lastpos() and forwardChar would miss it.
 346         // Can't use forwardPos either as this descends into
 347         // nested insets.
 348         Language const * language = buffer.params().language;
 349         for (CursorSlice dit = begin; dit != end; dit.forwardPos()) {
 350                 if (dit.pos() == dit.lastpos())
 351                         continue;
 352                 pit_type const pit = dit.pit();
 353                 pos_type const pos = dit.pos();
 354                 Inset * inset = pars_[pit].getInset(pos);
 355                 if (inset && inset->noFontChange()) {
 356                         // We need to propagate the font change to all
 357                         // text cells of the inset (bug 1973).
 358                         // FIXME: This should change, see documentation
 359                         // of noFontChange in Inset.h
 360                         setInsetFont(bv, pit, pos, font, toggleall);
 361                 }
 362                 TextMetrics const & tm = bv.textMetrics(this);
 363                 Font f = tm.getDisplayFont(pit, pos);
 364                 f.update(font, language, toggleall);
 365                 setCharFont(buffer, pit, pos, f, tm.font_);
 366         }
 367 }
 368
 369
 370 bool Text::cursorTop(Cursor & cur)
 371 {
 372         BOOST_ASSERT(this == cur.text());
 373         return setCursor(cur, 0, 0);
 374 }
 375
 376
 377 bool Text::cursorBottom(Cursor & cur)
 378 {
 379         BOOST_ASSERT(this == cur.text());
 380         return setCursor(cur, cur.lastpit(), boost::prior(paragraphs().end())->size());
 381 }
 382
 383
 384 void Text::toggleFree(Cursor & cur, Font const & font, bool toggleall)
 385 {
 386         BOOST_ASSERT(this == cur.text());
 387         // If the mask is completely neutral, tell user
 388         if (font.fontInfo() == ignore_font &&
 389                 (font.language() == 0 || font.language() == ignore_language)) {
 390                 // Could only happen with user style
 391                 cur.message(_("No font change defined."));
 392                 return;
 393         }
 394
 395         // Try implicit word selection
 396         // If there is a change in the language the implicit word selection
 397         // is disabled.
 398         CursorSlice resetCursor = cur.top();
 399         bool implicitSelection =
 400                 font.language() == ignore_language
 401                 && font.fontInfo().number() == FONT_IGNORE
 402                 && selectWordWhenUnderCursor(cur, WHOLE_WORD_STRICT);
 403
 404         // Set font
 405         setFont(cur, font, toggleall);
 406
 407         // Implicit selections are cleared afterwards
 408         // and cursor is set to the original position.
 409         if (implicitSelection) {
 410                 cur.clearSelection();
 411                 cur.top() = resetCursor;
 412                 cur.resetAnchor();
 413         }
 414 }
 415
 416
 417 docstring Text::getStringToIndex(Cursor const & cur)
 418 {
 419         BOOST_ASSERT(this == cur.text());
 420
 421         if (cur.selection())
 422                 return cur.selectionAsString(false);
 423
 424         // Try implicit word selection. If there is a change
 425         // in the language the implicit word selection is
 426         // disabled.
 427         Cursor tmpcur = cur;
 428         selectWord(tmpcur, PREVIOUS_WORD);
 429
 430         if (!tmpcur.selection())
 431                 cur.message(_("Nothing to index!"));
 432         else if (tmpcur.selBegin().pit() != tmpcur.selEnd().pit())
 433                 cur.message(_("Cannot index more than one paragraph!"));
 434         else
 435                 return tmpcur.selectionAsString(false);
 436
 437         return docstring();
 438 }
 439
 440
 441 void Text::setParagraphs(Cursor & cur, docstring arg, bool merge)
 442 {
 443         BOOST_ASSERT(cur.text());
 444         // make sure that the depth behind the selection are restored, too
 445         pit_type undopit = undoSpan(cur.selEnd().pit());
 446         recUndo(cur, cur.selBegin().pit(), undopit - 1);
 447
 448         //FIXME UNICODE
 449         string const argument = to_utf8(arg);
 450         for (pit_type pit = cur.selBegin().pit(), end = cur.selEnd().pit();
 451              pit <= end; ++pit) {
 452                 Paragraph & par = pars_[pit];
 453                 ParagraphParameters params = par.params();
 454                 params.read(argument, merge);
 455                 par.params().apply(params, *par.layout());
 456         }
 457 }
 458
 459
 460 //FIXME This is a little redundant now, but it's probably worth keeping,
 461 //especially if we're going to go away from using serialization internally
 462 //quite so much.
 463 void Text::setParagraphs(Cursor & cur, ParagraphParameters const & p)
 464 {
 465         BOOST_ASSERT(cur.text());
 466         // make sure that the depth behind the selection are restored, too
 467         pit_type undopit = undoSpan(cur.selEnd().pit());
 468         recUndo(cur, cur.selBegin().pit(), undopit - 1);
 469
 470         for (pit_type pit = cur.selBegin().pit(), end = cur.selEnd().pit();
 471              pit <= end; ++pit) {
 472                 Paragraph & par = pars_[pit];
 473                 Layout const & layout = *(par.layout());
 474                 par.params().apply(p, layout);
 475         }
 476 }
 477
 478
 479 // this really should just insert the inset and not move the cursor.
 480 void Text::insertInset(Cursor & cur, Inset * inset)
 481 {
 482         BOOST_ASSERT(this == cur.text());
 483         BOOST_ASSERT(inset);
 484         cur.paragraph().insertInset(cur.pos(), inset, cur.current_font,
 485                 Change(cur.buffer().params().trackChanges
 486                 ? Change::INSERTED : Change::UNCHANGED));
 487 }
 488
 489
 490 // needed to insert the selection
 491 void Text::insertStringAsLines(Cursor & cur, docstring const & str)
 492 {
 493         cur.buffer().insertStringAsLines(pars_, cur.pit(), cur.pos(),
 494                 cur.current_font, str, autoBreakRows_);
 495 }
 496
 497
 498 // turn double CR to single CR, others are converted into one
 499 // blank. Then insertStringAsLines is called
 500 void Text::insertStringAsParagraphs(Cursor & cur, docstring const & str)
 501 {
 502         docstring linestr = str;
 503         bool newline_inserted = false;
 504
 505         for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
 506                 if (linestr[i] == '\n') {
 507                         if (newline_inserted) {
 508                                 // we know that \r will be ignored by
 509                                 // insertStringAsLines. Of course, it is a dirty
 510                                 // trick, but it works...
 511                                 linestr[i - 1] = '\r';
 512                                 linestr[i] = '\n';
 513                         } else {
 514                                 linestr[i] = ' ';
 515                                 newline_inserted = true;
 516                         }
 517                 } else if (isPrintable(linestr[i])) {
 518                         newline_inserted = false;
 519                 }
 520         }
 521         insertStringAsLines(cur, linestr);
 522 }
 523
 524
 525 bool Text::setCursor(Cursor & cur, pit_type par, pos_type pos,
 526                         bool setfont, bool boundary)
 527 {
 528         TextMetrics const & tm = cur.bv().textMetrics(this);
 529         bool const update_needed = !tm.has(par);
 530         Cursor old = cur;
 531         setCursorIntern(cur, par, pos, setfont, boundary);
 532         return cur.bv().checkDepm(cur, old) || update_needed;
 533 }
 534
 535
 536 void Text::setCursor(CursorSlice & cur, pit_type par, pos_type pos)
 537 {
 538         BOOST_ASSERT(par != int(paragraphs().size()));
 539         cur.pit() = par;
 540         cur.pos() = pos;
 541
 542         // now some strict checking
 543         Paragraph & para = getPar(par);
 544
 545         // None of these should happen, but we're scaredy-cats
 546         if (pos < 0) {
 547                 lyxerr << "dont like -1" << endl;
 548                 BOOST_ASSERT(false);
 549         }
 550
 551         if (pos > para.size()) {
 552                 lyxerr << "dont like 1, pos: " << pos
 553                        << " size: " << para.size()
 554                        << " par: " << par << endl;
 555                 BOOST_ASSERT(false);
 556         }
 557 }
 558
 559
 560 void Text::setCursorIntern(Cursor & cur,
 561                               pit_type par, pos_type pos, bool setfont, bool boundary)
 562 {
 563         BOOST_ASSERT(this == cur.text());
 564         cur.boundary(boundary);
 565         setCursor(cur.top(), par, pos);
 566         if (setfont)
 567                 cur.setCurrentFont();
 568 }
 569
 570
 571 bool Text::checkAndActivateInset(Cursor & cur, bool front)
 572 {
 573         if (cur.selection())
 574                 return false;
 575         if (front && cur.pos() == cur.lastpos())
 576                 return false;
 577         if (!front && cur.pos() == 0)
 578                 return false;
 579         Inset * inset = front ? cur.nextInset() : cur.prevInset();
 580         if (!inset || inset->editable() != Inset::HIGHLY_EDITABLE)
 581                 return false;
 582         /*
 583          * Apparently, when entering an inset we are expected to be positioned
 584          * *before* it in the containing paragraph, regardless of the direction
 585          * from which we are entering. Otherwise, cursor placement goes awry,
 586          * and when we exit from the beginning, we'll be placed *after* the
 587          * inset.
 588          */
 589         if (!front)
 590                 --cur.pos();
 591         inset->edit(cur, front);
 592         return true;
 593 }
 594
 595
 596 bool Text::checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft)
 597 {
 598         if (cur.selection())
 599                 return false;
 600         if (cur.pos() == -1)
 601                 return false;
 602         if (cur.pos() == cur.lastpos())
 603                 return false;
 604         Paragraph & par = cur.paragraph();
 605         Inset * inset = par.isInset(cur.pos()) ? par.getInset(cur.pos()) : 0;
 606         if (!inset || inset->editable() != Inset::HIGHLY_EDITABLE)
 607                 return false;
 608         inset->edit(cur, movingForward,
 609                 movingLeft ? Inset::ENTRY_DIRECTION_RIGHT : Inset::ENTRY_DIRECTION_LEFT);
 610         return true;
 611 }
 612
 613
 614 bool Text::cursorBackward(Cursor & cur)
 615 {
 616         // Tell BufferView to test for FitCursor in any case!
 617         cur.updateFlags(Update::FitCursor);
 618
 619         // not at paragraph start?
 620         if (cur.pos() > 0) {
 621                 // if on right side of boundary (i.e. not at paragraph end, but line end)
 622                 // -> skip it, i.e. set boundary to true, i.e. go only logically left
 623                 // there are some exceptions to ignore this: lineseps, newlines, spaces
 624 #if 0
 625                 // some effectless debug code to see the values in the debugger
 626                 bool bound = cur.boundary();
 627                 int rowpos = cur.textRow().pos();
 628                 int pos = cur.pos();
 629                 bool sep = cur.paragraph().isSeparator(cur.pos() - 1);
 630                 bool newline = cur.paragraph().isNewline(cur.pos() - 1);
 631                 bool linesep = cur.paragraph().isLineSeparator(cur.pos() - 1);
 632 #endif
 633                 if (!cur.boundary() &&
 634                                 cur.textRow().pos() == cur.pos() &&
 635                                 !cur.paragraph().isLineSeparator(cur.pos() - 1) &&
 636                                 !cur.paragraph().isNewline(cur.pos() - 1) &&
 637                                 !cur.paragraph().isSeparator(cur.pos() - 1)) {
 638                         return setCursor(cur, cur.pit(), cur.pos(), true, true);
 639                 }
 640
 641                 // go left and try to enter inset
 642                 if (checkAndActivateInset(cur, false))
 643                         return false;
 644
 645                 // normal character left
 646                 return setCursor(cur, cur.pit(), cur.pos() - 1, true, false);
 647         }
 648
 649         // move to the previous paragraph or do nothing
 650         if (cur.pit() > 0)
 651                 return setCursor(cur, cur.pit() - 1, getPar(cur.pit() - 1).size(), true, false);
 652         return false;
 653 }
 654
 655
 656 bool Text::cursorVisLeft(Cursor & cur, bool skip_inset)
 657 {
 658         pit_type new_pit = cur.pit(); // the paragraph to which we will move
 659         pos_type new_pos; // the position we will move to
 660         bool new_boundary; // will we move to a boundary position?
 661         pos_type left_pos; // position visually left of current cursor
 662         pos_type right_pos; // position visually right of current cursor
 663         bool new_pos_is_RTL; // is new position we're moving to RTL?
 664
 665         cur.getSurroundingPos(left_pos, right_pos);
 666
 667         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<<cur.pos()<<")");
 668
 669         // Are we at an inset?
 670         Cursor temp_cur = cur;
 671         temp_cur.pos() = left_pos;
 672         temp_cur.boundary(false);
 673         if (!skip_inset &&
 674                 checkAndActivateInsetVisual(temp_cur, left_pos >= cur.pos(), true)) {
 675                 LYXERR(Debug::RTL, "entering inset at: " << temp_cur.pos());
 676                 cur = temp_cur; // set the real cursor to new position inside inset!
 677                 return false;
 678         }
 679
 680         // Are we already at leftmost pos in row?
 681         if (left_pos == -1) {
 682
 683                 Cursor new_cur = cur;
 684                 if (!new_cur.posVisToNewRow(true)) {
 685                         LYXERR(Debug::RTL, "not moving!");
 686                         return false;
 687                 }
 688
 689                 // we actually move the cursor at the end of this function, for now
 690                 // just keep track of the new position...
 691                 new_pit = new_cur.pit();
 692                 new_pos = new_cur.pos();
 693                 new_boundary = new_cur.boundary();
 694
 695                 LYXERR(Debug::RTL, "left edge, moving: " << int(new_pit) << ","
 696                         << int(new_pos) << "," << (new_boundary ? 1 : 0));
 697
 698         }
 699         // normal movement to the left
 700         else {
 701                 // Recall, if the cursor is at position 'x', that means *before*
 702                 // the character at position 'x'. In RTL, "before" means "to the
 703                 // right of", in LTR, "to the left of". So currently our situation
 704                 // is this: the position to our left is 'left_pos' (i.e., we're
 705                 // currently to the right of 'left_pos'). In order to move to the
 706                 // left, it depends whether or not the character at 'left_pos' is RTL.
 707                 new_pos_is_RTL = cur.paragraph().getFontSettings(
 708                         cur.bv().buffer().params(), left_pos).isVisibleRightToLeft();
 709                 // If the character at 'left_pos' *is* RTL, then in order to move to
 710                 // the left of it, we need to be *after* 'left_pos', i.e., move to
 711                 // position 'left_pos' + 1.
 712                 if (new_pos_is_RTL) {
 713                         new_pos = left_pos + 1;
 714                         // if the position *after* left_pos is not RTL, set boundary to
 715                         // true (we want to be *after* left_pos, not before left_pos + 1!)
 716                         new_boundary = !cur.paragraph().getFontSettings(
 717                                 cur.bv().buffer().params(), new_pos).isVisibleRightToLeft();
 718                 }
 719                 // Otherwise (if the character at position 'left_pos' is LTR), then
 720                 // moving to the left of it is as easy as setting the new position
 721                 // to 'left_pos'.
 722                 else {
 723                         new_pos = left_pos;
 724                         new_boundary = false;
 725                 }
 726
 727         }
 728
 729         LYXERR(Debug::RTL, "moving to: " << new_pos
 730                 << (new_boundary ? " (boundary)" : ""));
 731
 732         return setCursor(cur, new_pit, new_pos, true, new_boundary);
 733 }
 734
 735
 736 bool Text::cursorVisRight(Cursor & cur, bool skip_inset)
 737 {
 738         pit_type new_pit = cur.pit(); // the paragraph to which we will move
 739         pos_type new_pos; // the position we will move to
 740         bool new_boundary; // will we move to a boundary position?
 741         pos_type left_pos; // position visually left of current cursor
 742         pos_type right_pos; // position visually right of current cursor
 743         bool new_pos_is_RTL; // is new position we're moving to RTL?
 744
 745         cur.getSurroundingPos(left_pos, right_pos);
 746
 747         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<<cur.pos()<<")");
 748
 749         // Are we at an inset?
 750         Cursor temp_cur = cur;
 751         temp_cur.pos() = right_pos;
 752         temp_cur.boundary(false);
 753         if (!skip_inset &&
 754                 checkAndActivateInsetVisual(temp_cur, right_pos >= cur.pos(), false)) {
 755                 LYXERR(Debug::RTL, "entering inset at: " << temp_cur.pos());
 756                 cur = temp_cur; // set the real cursor to new position inside inset!
 757                 return false;
 758         }
 759
 760         // Are we already at rightmost pos in row?
 761         if (right_pos == -1) {
 762
 763                 Cursor new_cur = cur;
 764                 if (!new_cur.posVisToNewRow(false)) {
 765                         LYXERR(Debug::RTL, "not moving!");
 766                         return false;
 767                 }
 768
 769                 // we actually move the cursor at the end of this function, for now
 770                 // just keep track of the new position...
 771                 new_pit = new_cur.pit();
 772                 new_pos = new_cur.pos();
 773                 new_boundary = new_cur.boundary();
 774
 775                 LYXERR(Debug::RTL, "right edge, moving: " << int(new_pit) << ","
 776                         << int(new_pos) << "," << (new_boundary ? 1 : 0));
 777
 778         }
 779         // normal movement to the right
 780         else {
 781                 // Recall, if the cursor is at position 'x', that means *before*
 782                 // the character at position 'x'. In RTL, "before" means "to the
 783                 // right of", in LTR, "to the left of". So currently our situation
 784                 // is this: the position to our right is 'right_pos' (i.e., we're
 785                 // currently to the left of 'right_pos'). In order to move to the
 786                 // right, it depends whether or not the character at 'right_pos' is RTL.
 787                 new_pos_is_RTL = cur.paragraph().getFontSettings(
 788                         cur.bv().buffer().params(), right_pos).isVisibleRightToLeft();
 789                 // If the character at 'right_pos' *is* LTR, then in order to move to
 790                 // the right of it, we need to be *after* 'right_pos', i.e., move to
 791                 // position 'right_pos' + 1.
 792                 if (!new_pos_is_RTL) {
 793                         new_pos = right_pos + 1;
 794                         // if the position *after* right_pos is RTL, set boundary to
 795                         // true (we want to be *after* right_pos, not before right_pos + 1!)
 796                         new_boundary = cur.paragraph().getFontSettings(
 797                                 cur.bv().buffer().params(), new_pos).isVisibleRightToLeft();
 798                 }
 799                 // Otherwise (if the character at position 'right_pos' is RTL), then
 800                 // moving to the right of it is as easy as setting the new position
 801                 // to 'right_pos'.
 802                 else {
 803                         new_pos = right_pos;
 804                         new_boundary = false;
 805                 }
 806
 807         }
 808
 809         LYXERR(Debug::RTL, "moving to: " << new_pos
 810                 << (new_boundary ? " (boundary)" : ""));
 811
 812         return setCursor(cur, new_pit, new_pos, true, new_boundary);
 813 }
 814
 815
 816 bool Text::cursorForward(Cursor & cur)
 817 {
 818         // Tell BufferView to test for FitCursor in any case!
 819         cur.updateFlags(Update::FitCursor);
 820
 821         // not at paragraph end?
 822         if (cur.pos() != cur.lastpos()) {
 823                 // in front of editable inset, i.e. jump into it?
 824                 if (checkAndActivateInset(cur, true))
 825                         return false;
 826
 827                 TextMetrics const & tm = cur.bv().textMetrics(this);
 828                 // if left of boundary -> just jump to right side
 829                 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
 830                 if (cur.boundary() && !tm.isRTLBoundary(cur.pit(), cur.pos()))
 831                         return setCursor(cur, cur.pit(), cur.pos(), true, false);
 832
 833                 // next position is left of boundary,
 834                 // but go to next line for special cases like space, newline, linesep
 835 #if 0
 836                 // some effectless debug code to see the values in the debugger
 837                 int endpos = cur.textRow().endpos();
 838                 int lastpos = cur.lastpos();
 839                 int pos = cur.pos();
 840                 bool linesep = cur.paragraph().isLineSeparator(cur.pos());
 841                 bool newline = cur.paragraph().isNewline(cur.pos());
 842                 bool sep = cur.paragraph().isSeparator(cur.pos());
 843                 if (cur.pos() != cur.lastpos()) {
 844                         bool linesep2 = cur.paragraph().isLineSeparator(cur.pos()+1);
 845                         bool newline2 = cur.paragraph().isNewline(cur.pos()+1);
 846                         bool sep2 = cur.paragraph().isSeparator(cur.pos()+1);
 847                 }
 848 #endif
 849                 if (cur.textRow().endpos() == cur.pos() + 1 &&
 850                     cur.textRow().endpos() != cur.lastpos() &&
 851                                 !cur.paragraph().isNewline(cur.pos()) &&
 852                                 !cur.paragraph().isLineSeparator(cur.pos()) &&
 853                                 !cur.paragraph().isSeparator(cur.pos())) {
 854                         return setCursor(cur, cur.pit(), cur.pos() + 1, true, true);
 855                 }
 856
 857                 // in front of RTL boundary? Stay on this side of the boundary because:
 858                 //   ab|cDDEEFFghi -> abc|DDEEFFghi
 859                 if (tm.isRTLBoundary(cur.pit(), cur.pos() + 1))
 860                         return setCursor(cur, cur.pit(), cur.pos() + 1, true, true);
 861
 862                 // move right
 863                 return setCursor(cur, cur.pit(), cur.pos() + 1, true, false);
 864         }
 865
 866         // move to next paragraph
 867         if (cur.pit() != cur.lastpit())
 868                 return setCursor(cur, cur.pit() + 1, 0, true, false);
 869         return false;
 870 }
 871
 872
 873 bool Text::cursorUpParagraph(Cursor & cur)
 874 {
 875         bool updated = false;
 876         if (cur.pos() > 0)
 877                 updated = setCursor(cur, cur.pit(), 0);
 878         else if (cur.pit() != 0)
 879                 updated = setCursor(cur, cur.pit() - 1, 0);
 880         return updated;
 881 }
 882
 883
 884 bool Text::cursorDownParagraph(Cursor & cur)
 885 {
 886         bool updated = false;
 887         if (cur.pit() != cur.lastpit())
 888                 updated = setCursor(cur, cur.pit() + 1, 0);
 889         else
 890                 updated = setCursor(cur, cur.pit(), cur.lastpos());
 891         return updated;
 892 }
 893
 894
 895 // fix the cursor `cur' after a characters has been deleted at `where'
 896 // position. Called by deleteEmptyParagraphMechanism
 897 void Text::fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where)
 898 {
 899         // Do nothing if cursor is not in the paragraph where the
 900         // deletion occured,
 901         if (cur.pit() != where.pit())
 902                 return;
 903
 904         // If cursor position is after the deletion place update it
 905         if (cur.pos() > where.pos())
 906                 --cur.pos();
 907
 908         // Check also if we don't want to set the cursor on a spot behind the
 909         // pagragraph because we erased the last character.
 910         if (cur.pos() > cur.lastpos())
 911                 cur.pos() = cur.lastpos();
 912 }
 913
 914
 915 bool Text::deleteEmptyParagraphMechanism(Cursor & cur,
 916                 Cursor & old, bool & need_anchor_change)
 917 {
 918         //LYXERR(Debug::DEBUG, "DEPM: cur:\n" << cur << "old:\n" << old);
 919
 920         Paragraph & oldpar = old.paragraph();
 921
 922         // We allow all kinds of "mumbo-jumbo" when freespacing.
 923         if (oldpar.isFreeSpacing())
 924                 return false;
 925
 926         /* Ok I'll put some comments here about what is missing.
 927            There are still some small problems that can lead to
 928            double spaces stored in the document file or space at
 929            the beginning of paragraphs(). This happens if you have
 930            the cursor between to spaces and then save. Or if you
 931            cut and paste and the selection have a space at the
 932            beginning and then save right after the paste. (Lgb)
 933         */
 934
 935         // If old.pos() == 0 and old.pos()(1) == LineSeparator
 936         // delete the LineSeparator.
 937         // MISSING
 938
 939         // If old.pos() == 1 and old.pos()(0) == LineSeparator
 940         // delete the LineSeparator.
 941         // MISSING
 942
 943         bool const same_inset = &old.inset() == &cur.inset();
 944         bool const same_par = same_inset && old.pit() == cur.pit();
 945         bool const same_par_pos = same_par && old.pos() == cur.pos();
 946
 947         // If the chars around the old cursor were spaces, delete one of them.
 948         if (!same_par_pos) {
 949                 // Only if the cursor has really moved.
 950                 if (old.pos() > 0
 951                     && old.pos() < oldpar.size()
 952                     && oldpar.isLineSeparator(old.pos())
 953                     && oldpar.isLineSeparator(old.pos() - 1)
 954                     && !oldpar.isDeleted(old.pos() - 1)
 955                     && !oldpar.isDeleted(old.pos())) {
 956                         oldpar.eraseChar(old.pos() - 1, cur.buffer().params().trackChanges);
 957 // FIXME: This will not work anymore when we have multiple views of the same buffer
 958 // In this case, we will have to correct also the cursors held by
 959 // other bufferviews. It will probably be easier to do that in a more
 960 // automated way in CursorSlice code. (JMarc 26/09/2001)
 961                         // correct all cursor parts
 962                         if (same_par) {
 963                                 fixCursorAfterDelete(cur.top(), old.top());
 964                                 need_anchor_change = true;
 965                         }
 966                         return true;
 967                 }
 968         }
 969
 970         // only do our magic if we changed paragraph
 971         if (same_par)
 972                 return false;
 973
 974         // don't delete anything if this is the ONLY paragraph!
 975         if (old.lastpit() == 0)
 976                 return false;
 977
 978         // Do not delete empty paragraphs with keepempty set.
 979         if (oldpar.allowEmpty())
 980                 return false;
 981
 982         if (oldpar.empty() || (oldpar.size() == 1 && oldpar.isLineSeparator(0))) {
 983                 // Delete old par.
 984                 old.recordUndo(ATOMIC_UNDO,
 985                            max(old.pit() - 1, pit_type(0)),
 986                            min(old.pit() + 1, old.lastpit()));
 987                 ParagraphList & plist = old.text()->paragraphs();
 988                 bool const soa = oldpar.params().startOfAppendix();
 989                 plist.erase(boost::next(plist.begin(), old.pit()));
 990                 // do not lose start of appendix marker (bug 4212)
 991                 if (soa && old.pit() < pit_type(plist.size()))
 992                         plist[old.pit()].params().startOfAppendix(true);
 993
 994                 // see #warning (FIXME?) above
 995                 if (cur.depth() >= old.depth()) {
 996                         CursorSlice & curslice = cur[old.depth() - 1];
 997                         if (&curslice.inset() == &old.inset()
 998                             && curslice.pit() > old.pit()) {
 999                                 --curslice.pit();
1000                                 // since a paragraph has been deleted, all the
1001                                 // insets after `old' have been copied and
1002                                 // their address has changed. Therefore we
1003                                 // need to `regenerate' cur. (JMarc)
1004                                 cur.updateInsets(&(cur.bottom().inset()));
1005                                 need_anchor_change = true;
1006                         }
1007                 }
1008                 return true;
1009         }
1010
1011         if (oldpar.stripLeadingSpaces(cur.buffer().params().trackChanges)) {
1012                 need_anchor_change = true;
1013                 // We return true here because the Paragraph contents changed and
1014                 // we need a redraw before further action is processed.
1015                 return true;
1016         }
1017
1018         return false;
1019 }
1020
1021
1022 void Text::deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges)
1023 {
1024         BOOST_ASSERT(first >= 0 && first <= last && last < (int) pars_.size());
1025
1026         for (pit_type pit = first; pit <= last; ++pit) {
1027                 Paragraph & par = pars_[pit];
1028
1029                 // We allow all kinds of "mumbo-jumbo" when freespacing.
1030                 if (par.isFreeSpacing())
1031                         continue;
1032
1033                 for (pos_type pos = 1; pos < par.size(); ++pos) {
1034                         if (par.isLineSeparator(pos) && par.isLineSeparator(pos - 1)
1035                             && !par.isDeleted(pos - 1)) {
1036                                 if (par.eraseChar(pos - 1, trackChanges)) {
1037                                         --pos;
1038                                 }
1039                         }
1040                 }
1041
1042                 // don't delete anything if this is the only remaining paragraph within the given range
1043                 // note: Text::acceptOrRejectChanges() sets the cursor to 'first' after calling DEPM
1044                 if (first == last)
1045                         continue;
1046
1047                 // don't delete empty paragraphs with keepempty set
1048                 if (par.allowEmpty())
1049                         continue;
1050
1051                 if (par.empty() || (par.size() == 1 && par.isLineSeparator(0))) {
1052                         pars_.erase(boost::next(pars_.begin(), pit));
1053                         --pit;
1054                         --last;
1055                         continue;
1056                 }
1057
1058                 par.stripLeadingSpaces(trackChanges);
1059         }
1060 }
1061
1062
1063 void Text::recUndo(Cursor & cur, pit_type first, pit_type last) const
1064 {
1065         cur.recordUndo(ATOMIC_UNDO, first, last);
1066 }
1067
1068
1069 void Text::recUndo(Cursor & cur, pit_type par) const
1070 {
1071         cur.recordUndo(ATOMIC_UNDO, par, par);
1072 }
1073
1074 } // namespace lyx