src/text2.C

   1 /**
   2  * \file text2.C
   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 Dekel Tsur
  15  * \author Jürgen Vigna
  16  *
  17  * Full author contact details are available in file CREDITS.
  18  */
  19
  20 #include <config.h>
  21
  22 #include "lyxtext.h"
  23
  24 #include "buffer.h"
  25 #include "buffer_funcs.h"
  26 #include "bufferparams.h"
  27 #include "BufferView.h"
  28 #include "Bullet.h"
  29 #include "coordcache.h"
  30 #include "cursor.h"
  31 #include "CutAndPaste.h"
  32 #include "debug.h"
  33 #include "dispatchresult.h"
  34 #include "errorlist.h"
  35 #include "funcrequest.h"
  36 #include "gettext.h"
  37 #include "language.h"
  38 #include "LColor.h"
  39 #include "lyxrc.h"
  40 #include "lyxrow.h"
  41 #include "lyxrow_funcs.h"
  42 #include "paragraph.h"
  43 #include "paragraph_funcs.h"
  44 #include "ParagraphParameters.h"
  45 #include "pariterator.h"
  46 #include "undo.h"
  47 #include "vspace.h"
  48
  49 #include "frontends/font_metrics.h"
  50 #include "frontends/LyXView.h"
  51
  52 #include "insets/insetenv.h"
  53
  54 #include "support/textutils.h"
  55
  56 #include <sstream>
  57
  58 using lyx::pit_type;
  59 using lyx::pos_type;
  60
  61 using std::endl;
  62 using std::ostringstream;
  63 using std::string;
  64 using std::min;
  65
  66
  67 LyXText::LyXText(BufferView * bv)
  68         : maxwidth_(bv ? bv->workWidth() : 100),
  69           background_color_(LColor::background),
  70           bv_owner(bv),
  71           autoBreakRows_(false)
  72 {}
  73
  74
  75 void LyXText::init(BufferView * bv)
  76 {
  77         BOOST_ASSERT(bv);
  78         bv_owner = bv;
  79         maxwidth_ = bv->workWidth();
  80         dim_.wid = maxwidth_;
  81         dim_.asc = 10;
  82         dim_.des = 10;
  83
  84         pit_type const end = paragraphs().size();
  85         for (pit_type pit = 0; pit != end; ++pit)
  86                 pars_[pit].rows().clear();
  87
  88         current_font = getFont(pars_[0], 0);
  89         updateCounters(*bv->buffer());
  90 }
  91
  92
  93 bool LyXText::isMainText() const
  94 {
  95         return &bv()->buffer()->text() == this;
  96 }
  97
  98
  99 //takes screen x,y coordinates
 100 InsetBase * LyXText::checkInsetHit(int x, int y) const
 101 {
 102         pit_type pit = getPitNearY(y);
 103         BOOST_ASSERT(pit != -1);
 104
 105         Paragraph const & par = pars_[pit];
 106
 107         lyxerr[Debug::DEBUG]
 108                 << BOOST_CURRENT_FUNCTION
 109                 << ": x: " << x
 110                 << " y: " << y
 111                 << "  pit: " << pit
 112                 << endl;
 113         InsetList::const_iterator iit = par.insetlist.begin();
 114         InsetList::const_iterator iend = par.insetlist.end();
 115         for (; iit != iend; ++iit) {
 116                 InsetBase * inset = iit->inset;
 117 #if 1
 118                 lyxerr[Debug::DEBUG]
 119                         << BOOST_CURRENT_FUNCTION
 120                         << ": examining inset " << inset << endl;
 121
 122                 if (theCoords.getInsets().has(inset))
 123                         lyxerr[Debug::DEBUG]
 124                                 << BOOST_CURRENT_FUNCTION
 125                                 << ": xo: " << inset->xo() << "..."
 126                                 << inset->xo() + inset->width()
 127                                 << " yo: " << inset->yo() - inset->ascent()
 128                                 << "..."
 129                                 << inset->yo() + inset->descent()
 130                                 << endl;
 131                 else
 132                         lyxerr[Debug::DEBUG]
 133                                 << BOOST_CURRENT_FUNCTION
 134                                 << ": inset has no cached position" << endl;
 135 #endif
 136                 if (inset->covers(x, y)) {
 137                         lyxerr[Debug::DEBUG]
 138                                 << BOOST_CURRENT_FUNCTION
 139                                 << ": Hit inset: " << inset << endl;
 140                         return inset;
 141                 }
 142         }
 143         lyxerr[Debug::DEBUG]
 144                 << BOOST_CURRENT_FUNCTION
 145                 << ": No inset hit. " << endl;
 146         return 0;
 147 }
 148
 149
 150
 151 // Gets the fully instantiated font at a given position in a paragraph
 152 // Basically the same routine as Paragraph::getFont() in paragraph.C.
 153 // The difference is that this one is used for displaying, and thus we
 154 // are allowed to make cosmetic improvements. For instance make footnotes
 155 // smaller. (Asger)
 156 LyXFont LyXText::getFont(Paragraph const & par, pos_type const pos) const
 157 {
 158         BOOST_ASSERT(pos >= 0);
 159
 160         LyXLayout_ptr const & layout = par.layout();
 161 #ifdef WITH_WARNINGS
 162 #warning broken?
 163 #endif
 164         BufferParams const & params = bv()->buffer()->params();
 165         pos_type const body_pos = par.beginOfBody();
 166
 167         // We specialize the 95% common case:
 168         if (!par.getDepth()) {
 169                 LyXFont f = par.getFontSettings(params, pos);
 170                 if (!isMainText())
 171                         applyOuterFont(f);
 172                 if (layout->labeltype == LABEL_MANUAL && pos < body_pos)
 173                         return f.realize(layout->reslabelfont);
 174                 else
 175                         return f.realize(layout->resfont);
 176         }
 177
 178         // The uncommon case need not be optimized as much
 179         LyXFont layoutfont;
 180         if (pos < body_pos)
 181                 layoutfont = layout->labelfont;
 182         else
 183                 layoutfont = layout->font;
 184
 185         LyXFont font = par.getFontSettings(params, pos);
 186         font.realize(layoutfont);
 187
 188         if (!isMainText())
 189                 applyOuterFont(font);
 190
 191         // Realize with the fonts of lesser depth.
 192         font.realize(defaultfont_);
 193
 194         return font;
 195 }
 196
 197 // There are currently two font mechanisms in LyX:
 198 // 1. The font attributes in a lyxtext, and
 199 // 2. The inset-specific font properties, defined in an inset's
 200 // metrics() and draw() methods and handed down the inset chain through
 201 // the pi/mi parameters, and stored locally in a lyxtext in font_.
 202 // This is where the two are integrated in the final fully realized
 203 // font.
 204 void LyXText::applyOuterFont(LyXFont & font) const {
 205         LyXFont lf(font_);
 206         lf.reduce(defaultfont_);
 207         lf.realize(font);
 208         lf.setLanguage(font.language());
 209         font = lf;
 210 }
 211
 212
 213 LyXFont LyXText::getLayoutFont(pit_type const pit) const
 214 {
 215         LyXLayout_ptr const & layout = pars_[pit].layout();
 216
 217         if (!pars_[pit].getDepth())
 218                 return layout->resfont;
 219
 220         LyXFont font = layout->font;
 221         // Realize with the fonts of lesser depth.
 222         //font.realize(outerFont(pit, paragraphs()));
 223         font.realize(defaultfont_);
 224
 225         return font;
 226 }
 227
 228
 229 LyXFont LyXText::getLabelFont(Paragraph const & par) const
 230 {
 231         LyXLayout_ptr const & layout = par.layout();
 232
 233         if (!par.getDepth())
 234                 return layout->reslabelfont;
 235
 236         LyXFont font = layout->labelfont;
 237         // Realize with the fonts of lesser depth.
 238         font.realize(defaultfont_);
 239
 240         return font;
 241 }
 242
 243
 244 void LyXText::setCharFont(pit_type pit, pos_type pos, LyXFont const & fnt)
 245 {
 246         LyXFont font = fnt;
 247         LyXLayout_ptr const & layout = pars_[pit].layout();
 248
 249         // Get concrete layout font to reduce against
 250         LyXFont layoutfont;
 251
 252         if (pos < pars_[pit].beginOfBody())
 253                 layoutfont = layout->labelfont;
 254         else
 255                 layoutfont = layout->font;
 256
 257         // Realize against environment font information
 258         if (pars_[pit].getDepth()) {
 259                 pit_type tp = pit;
 260                 while (!layoutfont.resolved() &&
 261                        tp != pit_type(paragraphs().size()) &&
 262                        pars_[tp].getDepth()) {
 263                         tp = outerHook(tp, paragraphs());
 264                         if (tp != pit_type(paragraphs().size()))
 265                                 layoutfont.realize(pars_[tp].layout()->font);
 266                 }
 267         }
 268
 269         layoutfont.realize(defaultfont_);
 270
 271         // Now, reduce font against full layout font
 272         font.reduce(layoutfont);
 273
 274         pars_[pit].setFont(pos, font);
 275 }
 276
 277
 278 // used in setLayout
 279 // Asger is not sure we want to do this...
 280 void LyXText::makeFontEntriesLayoutSpecific(BufferParams const & params,
 281                                             Paragraph & par)
 282 {
 283         LyXLayout_ptr const & layout = par.layout();
 284         pos_type const psize = par.size();
 285
 286         LyXFont layoutfont;
 287         for (pos_type pos = 0; pos < psize; ++pos) {
 288                 if (pos < par.beginOfBody())
 289                         layoutfont = layout->labelfont;
 290                 else
 291                         layoutfont = layout->font;
 292
 293                 LyXFont tmpfont = par.getFontSettings(params, pos);
 294                 tmpfont.reduce(layoutfont);
 295                 par.setFont(pos, tmpfont);
 296         }
 297 }
 298
 299
 300 // return past-the-last paragraph influenced by a layout change on pit
 301 pit_type LyXText::undoSpan(pit_type pit)
 302 {
 303         pit_type end = paragraphs().size();
 304         pit_type nextpit = pit + 1;
 305         if (nextpit == end)
 306                 return nextpit;
 307         //because of parindents
 308         if (!pars_[pit].getDepth())
 309                 return boost::next(nextpit);
 310         //because of depth constrains
 311         for (; nextpit != end; ++pit, ++nextpit) {
 312                 if (!pars_[pit].getDepth())
 313                         break;
 314         }
 315         return nextpit;
 316 }
 317
 318
 319 pit_type LyXText::setLayout(pit_type start, pit_type end, string const & layout)
 320 {
 321         BOOST_ASSERT(start != end);
 322         pit_type undopit = undoSpan(end - 1);
 323         recUndo(start, undopit - 1);
 324
 325         BufferParams const & bufparams = bv()->buffer()->params();
 326         LyXLayout_ptr const & lyxlayout = bufparams.getLyXTextClass()[layout];
 327
 328         for (pit_type pit = start; pit != end; ++pit) {
 329                 pars_[pit].applyLayout(lyxlayout);
 330                 makeFontEntriesLayoutSpecific(bufparams, pars_[pit]);
 331                 if (lyxlayout->margintype == MARGIN_MANUAL)
 332                         pars_[pit].setLabelWidthString(lyxlayout->labelstring());
 333         }
 334
 335         return undopit;
 336 }
 337
 338
 339 // set layout over selection and make a total rebreak of those paragraphs
 340 void LyXText::setLayout(LCursor & cur, string const & layout)
 341 {
 342         BOOST_ASSERT(this == cur.text());
 343         // special handling of new environment insets
 344         BufferView & bv = cur.bv();
 345         BufferParams const & params = bv.buffer()->params();
 346         LyXLayout_ptr const & lyxlayout = params.getLyXTextClass()[layout];
 347         if (lyxlayout->is_environment) {
 348                 // move everything in a new environment inset
 349                 lyxerr[Debug::DEBUG] << "setting layout " << layout << endl;
 350                 bv.owner()->dispatch(FuncRequest(LFUN_HOME));
 351                 bv.owner()->dispatch(FuncRequest(LFUN_ENDSEL));
 352                 bv.owner()->dispatch(FuncRequest(LFUN_CUT));
 353                 InsetBase * inset = new InsetEnvironment(params, layout);
 354                 insertInset(cur, inset);
 355                 //inset->edit(cur, true);
 356                 //bv.owner()->dispatch(FuncRequest(LFUN_PASTE));
 357                 return;
 358         }
 359
 360         pit_type start = cur.selBegin().pit();
 361         pit_type end = cur.selEnd().pit() + 1;
 362         setLayout(start, end, layout);
 363         updateCounters(cur.buffer());
 364 }
 365
 366
 367 namespace {
 368
 369
 370 bool changeDepthAllowed(LyXText::DEPTH_CHANGE type,
 371         Paragraph const & par, int max_depth)
 372 {
 373         if (par.layout()->labeltype == LABEL_BIBLIO)
 374                 return false;
 375         int const depth = par.params().depth();
 376         if (type == LyXText::INC_DEPTH && depth < max_depth)
 377                 return true;
 378         if (type == LyXText::DEC_DEPTH && depth > 0)
 379                 return true;
 380         return false;
 381 }
 382
 383
 384 }
 385
 386
 387 bool LyXText::changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const
 388 {
 389         BOOST_ASSERT(this == cur.text());
 390         pit_type const beg = cur.selBegin().pit();
 391         pit_type const end = cur.selEnd().pit() + 1;
 392         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
 393
 394         for (pit_type pit = beg; pit != end; ++pit) {
 395                 if (::changeDepthAllowed(type, pars_[pit], max_depth))
 396                         return true;
 397                 max_depth = pars_[pit].getMaxDepthAfter();
 398         }
 399         return false;
 400 }
 401
 402
 403 void LyXText::changeDepth(LCursor & cur, DEPTH_CHANGE type)
 404 {
 405         BOOST_ASSERT(this == cur.text());
 406         pit_type const beg = cur.selBegin().pit();
 407         pit_type const end = cur.selEnd().pit() + 1;
 408         recordUndoSelection(cur);
 409         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
 410
 411         for (pit_type pit = beg; pit != end; ++pit) {
 412                 Paragraph & par = pars_[pit];
 413                 if (::changeDepthAllowed(type, par, max_depth)) {
 414                         int const depth = par.params().depth();
 415                         if (type == INC_DEPTH)
 416                                 par.params().depth(depth + 1);
 417                         else
 418                                 par.params().depth(depth - 1);
 419                 }
 420                 max_depth = par.getMaxDepthAfter();
 421         }
 422         // this handles the counter labels, and also fixes up
 423         // depth values for follow-on (child) paragraphs
 424         updateCounters(cur.buffer());
 425 }
 426
 427
 428 // set font over selection
 429 void LyXText::setFont(LCursor & cur, LyXFont const & font, bool toggleall)
 430 {
 431         BOOST_ASSERT(this == cur.text());
 432         // if there is no selection just set the current_font
 433         if (!cur.selection()) {
 434                 // Determine basis font
 435                 LyXFont layoutfont;
 436                 pit_type pit = cur.pit();
 437                 if (cur.pos() < pars_[pit].beginOfBody())
 438                         layoutfont = getLabelFont(pars_[pit]);
 439                 else
 440                         layoutfont = getLayoutFont(pit);
 441
 442                 // Update current font
 443                 real_current_font.update(font,
 444                                          cur.buffer().params().language,
 445                                          toggleall);
 446
 447                 // Reduce to implicit settings
 448                 current_font = real_current_font;
 449                 current_font.reduce(layoutfont);
 450                 // And resolve it completely
 451                 real_current_font.realize(layoutfont);
 452
 453                 return;
 454         }
 455
 456         // Ok, we have a selection.
 457         recordUndoSelection(cur);
 458
 459         DocIterator dit = cur.selectionBegin();
 460         DocIterator ditend = cur.selectionEnd();
 461
 462         BufferParams const & params = cur.buffer().params();
 463
 464         // Don't use forwardChar here as ditend might have
 465         // pos() == lastpos() and forwardChar would miss it.
 466         // Can't use forwardPos either as this descends into
 467         // nested insets.
 468         for (; dit != ditend; dit.forwardPosNoDescend()) {
 469                 if (dit.pos() != dit.lastpos()) {
 470                         LyXFont f = getFont(dit.paragraph(), dit.pos());
 471                         f.update(font, params.language, toggleall);
 472                         setCharFont(dit.pit(), dit.pos(), f);
 473                 }
 474         }
 475 }
 476
 477
 478 // the cursor set functions have a special mechanism. When they
 479 // realize you left an empty paragraph, they will delete it.
 480
 481 void LyXText::cursorHome(LCursor & cur)
 482 {
 483         BOOST_ASSERT(this == cur.text());
 484         Row const & row = cur.paragraph().getRow(cur.pos(),cur.boundary());
 485
 486         setCursor(cur, cur.pit(), row.pos());
 487 }
 488
 489
 490 void LyXText::cursorEnd(LCursor & cur)
 491 {
 492         BOOST_ASSERT(this == cur.text());
 493         // if not on the last row of the par, put the cursor before
 494         // the final space exept if I have a spanning inset or one string
 495         // is so long that we force a break.
 496         pos_type end = cur.textRow().endpos();
 497         bool boundary = false;
 498         if (!cur.paragraph().isLineSeparator(end-1) &&
 499             !cur.paragraph().isNewline(end-1))
 500         {
 501                 boundary = true;
 502         } else if (end != cur.lastpos())
 503                 --end;
 504         setCursor(cur, cur.pit(), end, true, boundary);
 505 }
 506
 507
 508 void LyXText::cursorTop(LCursor & cur)
 509 {
 510         BOOST_ASSERT(this == cur.text());
 511         setCursor(cur, 0, 0);
 512 }
 513
 514
 515 void LyXText::cursorBottom(LCursor & cur)
 516 {
 517         BOOST_ASSERT(this == cur.text());
 518         setCursor(cur, cur.lastpit(), boost::prior(paragraphs().end())->size());
 519 }
 520
 521
 522 void LyXText::toggleFree(LCursor & cur, LyXFont const & font, bool toggleall)
 523 {
 524         BOOST_ASSERT(this == cur.text());
 525         // If the mask is completely neutral, tell user
 526         if (font == LyXFont(LyXFont::ALL_IGNORE)) {
 527                 // Could only happen with user style
 528                 cur.message(_("No font change defined. "
 529                         "Use Character under the Layout menu to define font change."));
 530                 return;
 531         }
 532
 533         // Try implicit word selection
 534         // If there is a change in the language the implicit word selection
 535         // is disabled.
 536         CursorSlice resetCursor = cur.top();
 537         bool implicitSelection =
 538                 font.language() == ignore_language
 539                 && font.number() == LyXFont::IGNORE
 540                 && selectWordWhenUnderCursor(cur, lyx::WHOLE_WORD_STRICT);
 541
 542         // Set font
 543         setFont(cur, font, toggleall);
 544
 545         // Implicit selections are cleared afterwards
 546         // and cursor is set to the original position.
 547         if (implicitSelection) {
 548                 cur.clearSelection();
 549                 cur.top() = resetCursor;
 550                 cur.resetAnchor();
 551         }
 552 }
 553
 554
 555 string LyXText::getStringToIndex(LCursor const & cur)
 556 {
 557         BOOST_ASSERT(this == cur.text());
 558
 559         string idxstring;
 560         if (cur.selection()) {
 561                 idxstring = cur.selectionAsString(false);
 562         } else {
 563                 // Try implicit word selection. If there is a change
 564                 // in the language the implicit word selection is
 565                 // disabled.
 566                 LCursor tmpcur = cur;
 567                 selectWord(tmpcur, lyx::PREVIOUS_WORD);
 568
 569                 if (!tmpcur.selection())
 570                         cur.message(_("Nothing to index!"));
 571                 else if (tmpcur.selBegin().pit() != tmpcur.selEnd().pit())
 572                         cur.message(_("Cannot index more than one paragraph!"));
 573                 else
 574                         idxstring = tmpcur.selectionAsString(false);
 575         }
 576
 577         return idxstring;
 578 }
 579
 580
 581 void LyXText::setParagraph(LCursor & cur,
 582         Spacing const & spacing, LyXAlignment align,
 583         string const & labelwidthstring, bool noindent)
 584 {
 585         BOOST_ASSERT(cur.text());
 586         // make sure that the depth behind the selection are restored, too
 587         pit_type undopit = undoSpan(cur.selEnd().pit());
 588         recUndo(cur.selBegin().pit(), undopit - 1);
 589
 590         for (pit_type pit = cur.selBegin().pit(), end = cur.selEnd().pit();
 591                         pit <= end; ++pit) {
 592                 Paragraph & par = pars_[pit];
 593                 ParagraphParameters & params = par.params();
 594                 params.spacing(spacing);
 595
 596                 // does the layout allow the new alignment?
 597                 LyXLayout_ptr const & layout = par.layout();
 598
 599                 if (align == LYX_ALIGN_LAYOUT)
 600                         align = layout->align;
 601                 if (align & layout->alignpossible) {
 602                         if (align == layout->align)
 603                                 params.align(LYX_ALIGN_LAYOUT);
 604                         else
 605                                 params.align(align);
 606                 }
 607                 par.setLabelWidthString(labelwidthstring);
 608                 params.noindent(noindent);
 609         }
 610 }
 611
 612
 613 // this really should just insert the inset and not move the cursor.
 614 void LyXText::insertInset(LCursor & cur, InsetBase * inset)
 615 {
 616         BOOST_ASSERT(this == cur.text());
 617         BOOST_ASSERT(inset);
 618         cur.paragraph().insertInset(cur.pos(), inset);
 619 }
 620
 621
 622 // needed to insert the selection
 623 void LyXText::insertStringAsLines(LCursor & cur, string const & str)
 624 {
 625         cur.buffer().insertStringAsLines(pars_, cur.pit(), cur.pos(),
 626                 current_font, str, autoBreakRows_);
 627 }
 628
 629
 630 // turn double CR to single CR, others are converted into one
 631 // blank. Then insertStringAsLines is called
 632 void LyXText::insertStringAsParagraphs(LCursor & cur, string const & str)
 633 {
 634         string linestr = str;
 635         bool newline_inserted = false;
 636
 637         for (string::size_type i = 0, siz = linestr.size(); i < siz; ++i) {
 638                 if (linestr[i] == '\n') {
 639                         if (newline_inserted) {
 640                                 // we know that \r will be ignored by
 641                                 // insertStringAsLines. Of course, it is a dirty
 642                                 // trick, but it works...
 643                                 linestr[i - 1] = '\r';
 644                                 linestr[i] = '\n';
 645                         } else {
 646                                 linestr[i] = ' ';
 647                                 newline_inserted = true;
 648                         }
 649                 } else if (IsPrintable(linestr[i])) {
 650                         newline_inserted = false;
 651                 }
 652         }
 653         insertStringAsLines(cur, linestr);
 654 }
 655
 656
 657 bool LyXText::setCursor(LCursor & cur, pit_type par, pos_type pos,
 658         bool setfont, bool boundary)
 659 {
 660         LCursor old = cur;
 661         setCursorIntern(cur, par, pos, setfont, boundary);
 662         return deleteEmptyParagraphMechanism(cur, old);
 663 }
 664
 665
 666 void LyXText::setCursor(CursorSlice & cur, pit_type par,
 667         pos_type pos, bool boundary)
 668 {
 669         BOOST_ASSERT(par != int(paragraphs().size()));
 670         cur.pit() = par;
 671         cur.pos() = pos;
 672
 673         // now some strict checking
 674         Paragraph & para = getPar(par);
 675
 676         // None of these should happen, but we're scaredy-cats
 677         if (pos < 0) {
 678                 lyxerr << "dont like -1" << endl;
 679                 BOOST_ASSERT(false);
 680         }
 681
 682         if (pos > para.size()) {
 683                 lyxerr << "dont like 1, pos: " << pos
 684                        << " size: " << para.size()
 685                        << " par: " << par << endl;
 686                 BOOST_ASSERT(false);
 687         }
 688 }
 689
 690
 691 void LyXText::setCursorIntern(LCursor & cur,
 692         pit_type par, pos_type pos, bool setfont, bool boundary)
 693 {
 694         cur.boundary(boundary);
 695         setCursor(cur.top(), par, pos, boundary);
 696         cur.setTargetX();
 697         if (setfont)
 698                 setCurrentFont(cur);
 699 }
 700
 701
 702 void LyXText::setCurrentFont(LCursor & cur)
 703 {
 704         BOOST_ASSERT(this == cur.text());
 705         pos_type pos = cur.pos();
 706         Paragraph & par = cur.paragraph();
 707
 708         if (cur.boundary() && pos > 0)
 709                 --pos;
 710
 711         if (pos > 0) {
 712                 if (pos == cur.lastpos())
 713                         --pos;
 714                 else // potentional bug... BUG (Lgb)
 715                         if (par.isSeparator(pos)) {
 716                                 if (pos > cur.textRow().pos() &&
 717                                     bidi.level(pos) % 2 ==
 718                                     bidi.level(pos - 1) % 2)
 719                                         --pos;
 720                                 else if (pos + 1 < cur.lastpos())
 721                                         ++pos;
 722                         }
 723         }
 724
 725         BufferParams const & bufparams = cur.buffer().params();
 726         current_font = par.getFontSettings(bufparams, pos);
 727         real_current_font = getFont(par, pos);
 728
 729         if (cur.pos() == cur.lastpos()
 730             && bidi.isBoundary(cur.buffer(), par, cur.pos())
 731             && !cur.boundary()) {
 732                 Language const * lang = par.getParLanguage(bufparams);
 733                 current_font.setLanguage(lang);
 734                 current_font.setNumber(LyXFont::OFF);
 735                 real_current_font.setLanguage(lang);
 736                 real_current_font.setNumber(LyXFont::OFF);
 737         }
 738 }
 739
 740
 741 // x is an absolute screen coord
 742 // returns the column near the specified x-coordinate of the row
 743 // x is set to the real beginning of this column
 744 pos_type LyXText::getColumnNearX(pit_type const pit,
 745         Row const & row, int & x, bool & boundary) const
 746 {
 747         int const xo = theCoords.get(this, pit).x_;
 748         x -= xo;
 749         RowMetrics const r = computeRowMetrics(pit, row);
 750         Paragraph const & par = pars_[pit];
 751
 752         pos_type vc = row.pos();
 753         pos_type end = row.endpos();
 754         pos_type c = 0;
 755         LyXLayout_ptr const & layout = par.layout();
 756
 757         bool left_side = false;
 758
 759         pos_type body_pos = par.beginOfBody();
 760
 761         double tmpx = r.x;
 762         double last_tmpx = tmpx;
 763
 764         if (body_pos > 0 &&
 765             (body_pos > end || !par.isLineSeparator(body_pos - 1)))
 766                 body_pos = 0;
 767
 768         // check for empty row
 769         if (vc == end) {
 770                 x = int(tmpx) + xo;
 771                 return 0;
 772         }
 773
 774         while (vc < end && tmpx <= x) {
 775                 c = bidi.vis2log(vc);
 776                 last_tmpx = tmpx;
 777                 if (body_pos > 0 && c == body_pos - 1) {
 778                         tmpx += r.label_hfill +
 779                                 font_metrics::width(layout->labelsep, getLabelFont(par));
 780                         if (par.isLineSeparator(body_pos - 1))
 781                                 tmpx -= singleWidth(par, body_pos - 1);
 782                 }
 783
 784                 if (hfillExpansion(par, row, c)) {
 785                         tmpx += singleWidth(par, c);
 786                         if (c >= body_pos)
 787                                 tmpx += r.hfill;
 788                         else
 789                                 tmpx += r.label_hfill;
 790                 } else if (par.isSeparator(c)) {
 791                         tmpx += singleWidth(par, c);
 792                         if (c >= body_pos)
 793                                 tmpx += r.separator;
 794                 } else {
 795                         tmpx += singleWidth(par, c);
 796                 }
 797                 ++vc;
 798         }
 799
 800         if ((tmpx + last_tmpx) / 2 > x) {
 801                 tmpx = last_tmpx;
 802                 left_side = true;
 803         }
 804
 805         BOOST_ASSERT(vc <= end);  // This shouldn't happen.
 806
 807         boundary = false;
 808         // This (rtl_support test) is not needed, but gives
 809         // some speedup if rtl_support == false
 810         bool const lastrow = lyxrc.rtl_support && row.endpos() == par.size();
 811
 812         // If lastrow is false, we don't need to compute
 813         // the value of rtl.
 814         bool const rtl = lastrow ? isRTL(par) : false;
 815         if (lastrow &&
 816                  ((rtl  &&  left_side && vc == row.pos() && x < tmpx - 5) ||
 817                   (!rtl && !left_side && vc == end  && x > tmpx + 5)))
 818                 c = end;
 819         else if (vc == row.pos()) {
 820                 c = bidi.vis2log(vc);
 821                 if (bidi.level(c) % 2 == 1)
 822                         ++c;
 823         } else {
 824                 c = bidi.vis2log(vc - 1);
 825                 bool const rtl = (bidi.level(c) % 2 == 1);
 826                 if (left_side == rtl) {
 827                         ++c;
 828                         boundary = bidi.isBoundary(*bv()->buffer(), par, c);
 829                 }
 830         }
 831
 832 // I believe this code is not needed anymore (Jug 20050717)
 833 #if 0
 834         // The following code is necessary because the cursor position past
 835         // the last char in a row is logically equivalent to that before
 836         // the first char in the next row. That's why insets causing row
 837         // divisions -- Newline and display-style insets -- must be treated
 838         // specially, so cursor up/down doesn't get stuck in an air gap -- MV
 839         // Newline inset, air gap below:
 840         if (row.pos() < end && c >= end && par.isNewline(end - 1)) {
 841                 if (bidi.level(end -1) % 2 == 0)
 842                         tmpx -= singleWidth(par, end - 1);
 843                 else
 844                         tmpx += singleWidth(par, end - 1);
 845                 c = end - 1;
 846         }
 847
 848         // Air gap above display inset:
 849         if (row.pos() < end && c >= end && end < par.size()
 850             && par.isInset(end) && par.getInset(end)->display()) {
 851                 c = end - 1;
 852         }
 853         // Air gap below display inset:
 854         if (row.pos() < end && c >= end && par.isInset(end - 1)
 855             && par.getInset(end - 1)->display()) {
 856                 c = end - 1;
 857         }
 858 #endif
 859
 860         x = int(tmpx) + xo;
 861         pos_type const col = c - row.pos();
 862
 863         if (!c || end == par.size())
 864                 return col;
 865
 866         if (c==end && !par.isLineSeparator(c-1) && !par.isNewline(c-1)) {
 867                 boundary = true;
 868                 return col;
 869         }
 870
 871         return min(col, end - 1 - row.pos());
 872 }
 873
 874
 875 // y is screen coordinate
 876 pit_type LyXText::getPitNearY(int y) const
 877 {
 878         BOOST_ASSERT(!paragraphs().empty());
 879         BOOST_ASSERT(theCoords.getParPos().find(this) != theCoords.getParPos().end());
 880         CoordCache::InnerParPosCache const & cc = theCoords.getParPos().find(this)->second;
 881         lyxerr[Debug::DEBUG]
 882                 << BOOST_CURRENT_FUNCTION
 883                 << ": y: " << y << " cache size: " << cc.size()
 884                 << endl;
 885
 886         // look for highest numbered paragraph with y coordinate less than given y
 887         pit_type pit = 0;
 888         int yy = -1;
 889         CoordCache::InnerParPosCache::const_iterator it = cc.begin();
 890         CoordCache::InnerParPosCache::const_iterator et = cc.end();
 891         for (; it != et; ++it) {
 892                 lyxerr[Debug::DEBUG]
 893                         << BOOST_CURRENT_FUNCTION
 894                         << "  examining: pit: " << it->first
 895                         << " y: " << it->second.y_
 896                         << endl;
 897
 898                 if (it->first >= pit && int(it->second.y_) - int(pars_[it->first].ascent()) <= y) {
 899                         pit = it->first;
 900                         yy = it->second.y_;
 901                 }
 902         }
 903
 904         lyxerr[Debug::DEBUG]
 905                 << BOOST_CURRENT_FUNCTION
 906                 << ": found best y: " << yy << " for pit: " << pit
 907                 << endl;
 908
 909         return pit;
 910 }
 911
 912
 913 Row const & LyXText::getRowNearY(int y, pit_type pit) const
 914 {
 915         Paragraph const & par = pars_[pit];
 916         int yy = theCoords.get(this, pit).y_ - par.ascent();
 917         BOOST_ASSERT(!par.rows().empty());
 918         RowList::const_iterator rit = par.rows().begin();
 919         RowList::const_iterator const rlast = boost::prior(par.rows().end());
 920         for (; rit != rlast; yy += rit->height(), ++rit)
 921                 if (yy + rit->height() > y)
 922                         break;
 923         return *rit;
 924 }
 925
 926
 927 // x,y are absolute screen coordinates
 928 // sets cursor recursively descending into nested editable insets
 929 InsetBase * LyXText::editXY(LCursor & cur, int x, int y)
 930 {
 931         pit_type pit = getPitNearY(y);
 932         BOOST_ASSERT(pit != -1);
 933         Row const & row = getRowNearY(y, pit);
 934         bool bound = false;
 935
 936         int xx = x; // is modified by getColumnNearX
 937         pos_type const pos = row.pos() + getColumnNearX(pit, row, xx, bound);
 938         cur.pit() = pit;
 939         cur.pos() = pos;
 940         cur.boundary(bound);
 941         cur.x_target() = x;
 942
 943         // try to descend into nested insets
 944         InsetBase * inset = checkInsetHit(x, y);
 945         //lyxerr << "inset " << inset << " hit at x: " << x << " y: " << y << endl;
 946         if (!inset) {
 947                 // Either we deconst editXY or better we move current_font
 948                 // and real_current_font to LCursor
 949                 setCurrentFont(cur);
 950                 return 0;
 951         }
 952
 953         // This should be just before or just behind the
 954         // cursor position set above.
 955         BOOST_ASSERT((pos != 0 && inset == pars_[pit].getInset(pos - 1))
 956                      || inset == pars_[pit].getInset(pos));
 957         // Make sure the cursor points to the position before
 958         // this inset.
 959         if (inset == pars_[pit].getInset(pos - 1))
 960                 --cur.pos();
 961         inset = inset->editXY(cur, x, y);
 962         if (cur.top().text() == this)
 963                 setCurrentFont(cur);
 964         return inset;
 965 }
 966
 967
 968 bool LyXText::checkAndActivateInset(LCursor & cur, bool front)
 969 {
 970         if (cur.selection())
 971                 return false;
 972         if (cur.pos() == cur.lastpos())
 973                 return false;
 974         InsetBase * inset = cur.nextInset();
 975         if (!isHighlyEditableInset(inset))
 976                 return false;
 977         inset->edit(cur, front);
 978         return true;
 979 }
 980
 981
 982 bool LyXText::cursorLeft(LCursor & cur)
 983 {
 984         if (!cur.boundary() && cur.pos() > 0 &&
 985             cur.textRow().pos() == cur.pos() &&
 986             !cur.paragraph().isLineSeparator(cur.pos()-1) &&
 987             !cur.paragraph().isNewline(cur.pos()-1))
 988         {
 989                 return setCursor(cur, cur.pit(), cur.pos(), true, true);
 990         }
 991         if (cur.pos() != 0) {
 992                 bool boundary = cur.boundary();
 993                 bool updateNeeded = setCursor(cur, cur.pit(), cur.pos() - 1, true, false);
 994                 if (!checkAndActivateInset(cur, false)) {
 995                         if (false && !boundary &&
 996                                         bidi.isBoundary(cur.buffer(), cur.paragraph(), cur.pos() + 1))
 997                                 updateNeeded |=
 998                                         setCursor(cur, cur.pit(), cur.pos() + 1, true, true);
 999                 }
1000                 return updateNeeded;
1001         }
1002
1003         if (cur.pit() != 0) {
1004                 // Steps into the paragraph above
1005                 return setCursor(cur, cur.pit() - 1, getPar(cur.pit() - 1).size());
1006         }
1007         return false;
1008 }
1009
1010
1011 bool LyXText::cursorRight(LCursor & cur)
1012 {
1013         if (cur.boundary()) {
1014                 return setCursor(cur, cur.pit(), cur.pos(), true, false);
1015         }
1016
1017         if (cur.pos() != cur.lastpos()) {
1018                 bool updateNeeded = false;
1019                 if (!checkAndActivateInset(cur, true)) {
1020                         if (cur.textRow().endpos() == (cur.pos() + 1) &&
1021                             !cur.paragraph().isLineSeparator(cur.pos()) &&
1022                             !cur.paragraph().isNewline(cur.pos()))
1023                         {
1024                                 cur.boundary(true);
1025                         }
1026                         updateNeeded |= setCursor(cur, cur.pit(), cur.pos() + 1, true, cur.boundary());
1027                         if (false && bidi.isBoundary(cur.buffer(), cur.paragraph(),
1028                                                          cur.pos()))
1029                                 updateNeeded |= setCursor(cur, cur.pit(), cur.pos(), true, true);
1030                 }
1031                 return updateNeeded;
1032         }
1033
1034         if (cur.pit() != cur.lastpit())
1035                 return setCursor(cur, cur.pit() + 1, 0);
1036         return false;
1037 }
1038
1039
1040 bool LyXText::cursorUp(LCursor & cur)
1041 {
1042         Paragraph const & par = cur.paragraph();
1043         int row;
1044         int const x = cur.targetX();
1045
1046         if (cur.pos() && cur.boundary())
1047                 row = par.pos2row(cur.pos()-1);
1048         else
1049                 row = par.pos2row(cur.pos());
1050
1051         if (!cur.selection()) {
1052                 int const y = bv_funcs::getPos(cur, cur.boundary()).y_;
1053                 LCursor old = cur;
1054                 editXY(cur, x, y - par.rows()[row].ascent() - 1);
1055
1056                 // This happens when you move out of an inset.
1057                 // And to give the DEPM the possibility of doing
1058                 // something we must provide it with two different
1059                 // cursors. (Lgb)
1060                 LCursor dummy = cur;
1061                 if (dummy == old)
1062                         ++dummy.pos();
1063
1064                 return deleteEmptyParagraphMechanism(dummy, old);
1065         }
1066
1067         bool updateNeeded = false;
1068
1069         if (row > 0) {
1070                 updateNeeded |= setCursor(cur, cur.pit(),
1071                                           x2pos(cur.pit(), row - 1, x));
1072         } else if (cur.pit() > 0) {
1073                 --cur.pit();
1074                 //cannot use 'par' now
1075                 updateNeeded |= setCursor(cur, cur.pit(),
1076       x2pos(cur.pit(), cur.paragraph().rows().size() - 1, x));
1077         }
1078
1079         cur.x_target() = x;
1080
1081         return updateNeeded;
1082 }
1083
1084
1085 bool LyXText::cursorDown(LCursor & cur)
1086 {
1087         Paragraph const & par = cur.paragraph();
1088         int row;
1089         int const x = cur.targetX();
1090
1091         if (cur.pos() && cur.boundary())
1092                 row = par.pos2row(cur.pos()-1);
1093         else
1094                 row = par.pos2row(cur.pos());
1095
1096         if (!cur.selection()) {
1097                 int const y = bv_funcs::getPos(cur, cur.boundary()).y_;
1098                 LCursor old = cur;
1099                 editXY(cur, x, y + par.rows()[row].descent() + 1);
1100
1101                 // This happens when you move out of an inset.
1102                 // And to give the DEPM the possibility of doing
1103                 // something we must provide it with two different
1104                 // cursors. (Lgb)
1105                 LCursor dummy = cur;
1106                 if (dummy == old)
1107                         ++dummy.pos();
1108
1109                 bool const changed = deleteEmptyParagraphMechanism(dummy, old);
1110
1111                 // Make sure that cur gets back whatever happened to dummy(Lgb)
1112                 if (changed)
1113                         cur = dummy;
1114
1115                 return changed;
1116
1117         }
1118
1119         bool updateNeeded = false;
1120
1121         if (row + 1 < int(par.rows().size())) {
1122                 updateNeeded |= setCursor(cur, cur.pit(),
1123                                           x2pos(cur.pit(), row + 1, x));
1124         } else if (cur.pit() + 1 < int(paragraphs().size())) {
1125                 ++cur.pit();
1126                 updateNeeded |= setCursor(cur, cur.pit(),
1127                                           x2pos(cur.pit(), 0, x));
1128         }
1129
1130         cur.x_target() = x;
1131
1132         return updateNeeded;
1133 }
1134
1135
1136 bool LyXText::cursorUpParagraph(LCursor & cur)
1137 {
1138         bool updated = false;
1139         if (cur.pos() > 0)
1140                 updated = setCursor(cur, cur.pit(), 0);
1141         else if (cur.pit() != 0)
1142                 updated = setCursor(cur, cur.pit() - 1, 0);
1143         return updated;
1144 }
1145
1146
1147 bool LyXText::cursorDownParagraph(LCursor & cur)
1148 {
1149         bool updated = false;
1150         if (cur.pit() != cur.lastpit())
1151                 updated = setCursor(cur, cur.pit() + 1, 0);
1152         else
1153                 updated = setCursor(cur, cur.pit(), cur.lastpos());
1154         return updated;
1155 }
1156
1157
1158 // fix the cursor `cur' after a characters has been deleted at `where'
1159 // position. Called by deleteEmptyParagraphMechanism
1160 void LyXText::fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where)
1161 {
1162         // Do nothing if cursor is not in the paragraph where the
1163         // deletion occured,
1164         if (cur.pit() != where.pit())
1165                 return;
1166
1167         // If cursor position is after the deletion place update it
1168         if (cur.pos() > where.pos())
1169                 --cur.pos();
1170
1171         // Check also if we don't want to set the cursor on a spot behind the
1172         // pagragraph because we erased the last character.
1173         if (cur.pos() > cur.lastpos())
1174                 cur.pos() = cur.lastpos();
1175 }
1176
1177
1178 bool LyXText::deleteEmptyParagraphMechanism(LCursor & cur, LCursor const & old)
1179 {
1180         // Would be wrong to delete anything if we have a selection.
1181         if (cur.selection())
1182                 return false;
1183
1184         //lyxerr[Debug::DEBUG] << "DEPM: cur:\n" << cur << "old:\n" << old << endl;
1185         Paragraph const & oldpar = pars_[old.pit()];
1186
1187         // We allow all kinds of "mumbo-jumbo" when freespacing.
1188         if (oldpar.isFreeSpacing())
1189                 return false;
1190
1191         /* Ok I'll put some comments here about what is missing.
1192            I have fixed BackSpace (and thus Delete) to not delete
1193            double-spaces automagically. I have also changed Cut,
1194            Copy and Paste to hopefully do some sensible things.
1195            There are still some small problems that can lead to
1196            double spaces stored in the document file or space at
1197            the beginning of paragraphs(). This happens if you have
1198            the cursor between to spaces and then save. Or if you
1199            cut and paste and the selection have a space at the
1200            beginning and then save right after the paste. I am
1201            sure none of these are very hard to fix, but I will
1202            put out 1.1.4pre2 with FIX_DOUBLE_SPACE defined so
1203            that I can get some feedback. (Lgb)
1204         */
1205
1206         // If old.pos() == 0 and old.pos()(1) == LineSeparator
1207         // delete the LineSeparator.
1208         // MISSING
1209
1210         // If old.pos() == 1 and old.pos()(0) == LineSeparator
1211         // delete the LineSeparator.
1212         // MISSING
1213
1214         // If the chars around the old cursor were spaces, delete one of them.
1215         if (old.pit() != cur.pit() || old.pos() != cur.pos()) {
1216
1217                 // Only if the cursor has really moved.
1218                 if (old.pos() > 0
1219                     && old.pos() < oldpar.size()
1220                     && oldpar.isLineSeparator(old.pos())
1221                     && oldpar.isLineSeparator(old.pos() - 1)
1222                     && oldpar.lookupChange(old.pos() - 1) != Change::DELETED) {
1223                         // We need to set the text to Change::INSERTED to
1224                         // get it erased properly
1225                         pars_[old.pit()].setChange(old.pos() -1,
1226                                 Change::INSERTED);
1227                         pars_[old.pit()].erase(old.pos() - 1);
1228 #ifdef WITH_WARNINGS
1229 #warning This will not work anymore when we have multiple views of the same buffer
1230 // In this case, we will have to correct also the cursors held by
1231 // other bufferviews. It will probably be easier to do that in a more
1232 // automated way in CursorSlice code. (JMarc 26/09/2001)
1233 #endif
1234                         // correct all cursor parts
1235                         fixCursorAfterDelete(cur.top(), old.top());
1236 #ifdef WITH_WARNINGS
1237 #warning DEPM, look here
1238 #endif
1239                         //fixCursorAfterDelete(cur.anchor(), old.top());
1240                         return true;
1241                 }
1242         }
1243
1244         // only do our magic if we changed paragraph
1245         if (old.pit() == cur.pit())
1246                 return false;
1247
1248         // don't delete anything if this is the ONLY paragraph!
1249         if (pars_.size() == 1)
1250                 return false;
1251
1252         // Do not delete empty paragraphs with keepempty set.
1253         if (oldpar.allowEmpty())
1254                 return false;
1255
1256         // record if we have deleted a paragraph
1257         // we can't possibly have deleted a paragraph before this point
1258         bool deleted = false;
1259
1260         if (oldpar.empty() || (oldpar.size() == 1 && oldpar.isLineSeparator(0))) {
1261                 // ok, we will delete something
1262                 deleted = true;
1263
1264                 bool selection_position_was_oldcursor_position =
1265                         cur.anchor().pit() == old.pit() && cur.anchor().pos() == old.pos();
1266
1267                 // This is a bit of a overkill. We change the old and the cur par
1268                 // at max, certainly not everything in between...
1269                 recUndo(old.pit(), cur.pit());
1270
1271                 // Delete old par.
1272                 pars_.erase(pars_.begin() + old.pit());
1273
1274                 // Update cursor par offset if necessary.
1275                 // Some 'iterator registration' would be nice that takes care of
1276                 // such events. Maybe even signal/slot?
1277                 if (cur.pit() > old.pit())
1278                         --cur.pit();
1279 #ifdef WITH_WARNINGS
1280 #warning DEPM, look here
1281 #endif
1282 //              if (cur.anchor().pit() > old.pit())
1283 //                      --cur.anchor().pit();
1284
1285                 if (selection_position_was_oldcursor_position) {
1286                         // correct selection
1287                         cur.resetAnchor();
1288                 }
1289         }
1290
1291         if (deleted) {
1292                 updateCounters(cur.buffer());
1293                 return true;
1294         }
1295
1296         if (pars_[old.pit()].stripLeadingSpaces())
1297                 cur.resetAnchor();
1298
1299         return false;
1300 }
1301
1302
1303 void LyXText::recUndo(pit_type first, pit_type last) const
1304 {
1305         recordUndo(bv()->cursor(), Undo::ATOMIC, first, last);
1306 }
1307
1308
1309 void LyXText::recUndo(pit_type par) const
1310 {
1311         recordUndo(bv()->cursor(), Undo::ATOMIC, par, par);
1312 }
1313
1314
1315 int defaultRowHeight()
1316 {
1317         return int(font_metrics::maxHeight(LyXFont(LyXFont::ALL_SANE)) *  1.2);
1318 }