]> git.lyx.org Git - lyx.git/blob - src/Text2.cpp
avoid float-conversion warning and simplify size computation
[lyx.git] / 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 "Language.h"
37 #include "Layout.h"
38 #include "Lexer.h"
39 #include "LyX.h"
40 #include "LyXRC.h"
41 #include "Paragraph.h"
42 #include "ParagraphParameters.h"
43 #include "TextClass.h"
44 #include "TextMetrics.h"
45
46 #include "insets/InsetCollapsable.h"
47
48 #include "mathed/InsetMathHull.h"
49
50 #include "support/lassert.h"
51 #include "support/debug.h"
52 #include "support/gettext.h"
53 #include "support/lyxalgo.h"
54 #include "support/textutils.h"
55
56 #include <sstream>
57
58 using namespace std;
59
60 namespace lyx {
61
62 bool Text::isMainText() const
63 {
64         return &owner_->buffer().text() == this;
65 }
66
67
68 // Note that this is supposed to return a fully realized font.
69 FontInfo Text::layoutFont(pit_type const pit) const
70 {
71         Layout const & layout = pars_[pit].layout();
72
73         if (!pars_[pit].getDepth())  {
74                 FontInfo lf = layout.resfont;
75                 // In case the default family has been customized
76                 if (layout.font.family() == INHERIT_FAMILY)
77                         lf.setFamily(owner_->buffer().params().getFont().fontInfo().family());
78                 FontInfo icf = owner_->getLayout().font();
79                 icf.realize(lf);
80                 return icf;
81         }
82
83         FontInfo font = layout.font;
84         // Realize with the fonts of lesser depth.
85         //font.realize(outerFont(pit));
86         font.realize(owner_->buffer().params().getFont().fontInfo());
87
88         return font;
89 }
90
91
92 // Note that this is supposed to return a fully realized font.
93 FontInfo Text::labelFont(Paragraph const & par) const
94 {
95         Buffer const & buffer = owner_->buffer();
96         Layout const & layout = par.layout();
97
98         if (!par.getDepth()) {
99                 FontInfo lf = layout.reslabelfont;
100                 // In case the default family has been customized
101                 if (layout.labelfont.family() == INHERIT_FAMILY)
102                         lf.setFamily(buffer.params().getFont().fontInfo().family());
103                 return lf;
104         }
105
106         FontInfo font = layout.labelfont;
107         // Realize with the fonts of lesser depth.
108         font.realize(buffer.params().getFont().fontInfo());
109
110         return font;
111 }
112
113
114 void Text::setCharFont(pit_type pit,
115                 pos_type pos, Font const & fnt, Font const & display_font)
116 {
117         Buffer const & buffer = owner_->buffer();
118         Font font = fnt;
119         Layout const & layout = pars_[pit].layout();
120
121         // Get concrete layout font to reduce against
122         FontInfo layoutfont;
123
124         if (pos < pars_[pit].beginOfBody())
125                 layoutfont = layout.labelfont;
126         else
127                 layoutfont = layout.font;
128
129         // Realize against environment font information
130         if (pars_[pit].getDepth()) {
131                 pit_type tp = pit;
132                 while (!layoutfont.resolved() &&
133                        tp != pit_type(paragraphs().size()) &&
134                        pars_[tp].getDepth()) {
135                         tp = outerHook(tp);
136                         if (tp != pit_type(paragraphs().size()))
137                                 layoutfont.realize(pars_[tp].layout().font);
138                 }
139         }
140
141         // Inside inset, apply the inset's font attributes if any
142         // (charstyle!)
143         if (!isMainText())
144                 layoutfont.realize(display_font.fontInfo());
145
146         layoutfont.realize(buffer.params().getFont().fontInfo());
147
148         // Now, reduce font against full layout font
149         font.fontInfo().reduce(layoutfont);
150
151         pars_[pit].setFont(pos, font);
152 }
153
154
155 void Text::setInsetFont(BufferView const & bv, pit_type pit,
156                 pos_type pos, Font const & font)
157 {
158         Inset * const inset = pars_[pit].getInset(pos);
159         LASSERT(inset && inset->resetFontEdit(), return);
160
161         CursorSlice::idx_type endidx = inset->nargs();
162         for (CursorSlice cs(*inset); cs.idx() != endidx; ++cs.idx()) {
163                 Text * text = cs.text();
164                 if (text) {
165                         // last position of the cell
166                         CursorSlice cellend = cs;
167                         cellend.pit() = cellend.lastpit();
168                         cellend.pos() = cellend.lastpos();
169                         text->setFont(bv, cs, cellend, font);
170                 }
171         }
172 }
173
174
175 void Text::setLayout(pit_type start, pit_type end,
176                      docstring const & layout)
177 {
178         LASSERT(start != end, return);
179
180         Buffer const & buffer = owner_->buffer();
181         BufferParams const & bp = buffer.params();
182         Layout const & lyxlayout = bp.documentClass()[layout];
183
184         for (pit_type pit = start; pit != end; ++pit) {
185                 Paragraph & par = pars_[pit];
186                 par.applyLayout(lyxlayout);
187                 if (lyxlayout.margintype == MARGIN_MANUAL)
188                         par.setLabelWidthString(par.expandLabel(lyxlayout, bp));
189         }
190 }
191
192
193 // set layout over selection and make a total rebreak of those paragraphs
194 void Text::setLayout(Cursor & cur, docstring const & layout)
195 {
196         LBUFERR(this == cur.text());
197
198         pit_type start = cur.selBegin().pit();
199         pit_type end = cur.selEnd().pit() + 1;
200         cur.recordUndoSelection();
201         setLayout(start, end, layout);
202         cur.forceBufferUpdate();
203 }
204
205
206 static bool changeDepthAllowed(Text::DEPTH_CHANGE type,
207                         Paragraph const & par, int max_depth)
208 {
209         int const depth = par.params().depth();
210         if (type == Text::INC_DEPTH && depth < max_depth)
211                 return true;
212         if (type == Text::DEC_DEPTH && depth > 0)
213                 return true;
214         return false;
215 }
216
217
218 bool Text::changeDepthAllowed(Cursor & cur, DEPTH_CHANGE type) const
219 {
220         LBUFERR(this == cur.text());
221         // this happens when selecting several cells in tabular (bug 2630)
222         if (cur.selBegin().idx() != cur.selEnd().idx())
223                 return false;
224
225         pit_type const beg = cur.selBegin().pit();
226         pit_type const end = cur.selEnd().pit() + 1;
227         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
228
229         for (pit_type pit = beg; pit != end; ++pit) {
230                 if (lyx::changeDepthAllowed(type, pars_[pit], max_depth))
231                         return true;
232                 max_depth = pars_[pit].getMaxDepthAfter();
233         }
234         return false;
235 }
236
237
238 void Text::changeDepth(Cursor & cur, DEPTH_CHANGE type)
239 {
240         LBUFERR(this == cur.text());
241         pit_type const beg = cur.selBegin().pit();
242         pit_type const end = cur.selEnd().pit() + 1;
243         cur.recordUndoSelection();
244         int max_depth = (beg != 0 ? pars_[beg - 1].getMaxDepthAfter() : 0);
245
246         for (pit_type pit = beg; pit != end; ++pit) {
247                 Paragraph & par = pars_[pit];
248                 if (lyx::changeDepthAllowed(type, par, max_depth)) {
249                         int const depth = par.params().depth();
250                         if (type == INC_DEPTH)
251                                 par.params().depth(depth + 1);
252                         else
253                                 par.params().depth(depth - 1);
254                 }
255                 max_depth = par.getMaxDepthAfter();
256         }
257         // this handles the counter labels, and also fixes up
258         // depth values for follow-on (child) paragraphs
259         cur.forceBufferUpdate();
260 }
261
262
263 void Text::setFont(Cursor & cur, Font const & font, bool toggleall)
264 {
265         LASSERT(this == cur.text(), return);
266
267         // If there is a selection, record undo before the cursor font is changed.
268         if (cur.selection())
269                 cur.recordUndoSelection();
270
271         // Set the current_font
272         // Determine basis font
273         FontInfo layoutfont;
274         pit_type pit = cur.pit();
275         if (cur.pos() < pars_[pit].beginOfBody())
276                 layoutfont = labelFont(pars_[pit]);
277         else
278                 layoutfont = layoutFont(pit);
279
280         // Update current font
281         cur.real_current_font.update(font,
282                                         cur.buffer()->params().language,
283                                         toggleall);
284
285         // Reduce to implicit settings
286         cur.current_font = cur.real_current_font;
287         cur.current_font.fontInfo().reduce(layoutfont);
288         // And resolve it completely
289         cur.real_current_font.fontInfo().realize(layoutfont);
290
291         // if there is no selection that's all we need to do
292         if (!cur.selection())
293                 return;
294
295         // Ok, we have a selection.
296         Font newfont = font;
297
298         if (toggleall) {        
299                 // Toggling behaves as follows: We check the first character of the
300                 // selection. If it's (say) got EMPH on, then we set to off; if off,
301                 // then to on. With families and the like, we set it to INHERIT, if
302                 // we already have it.
303                 CursorSlice const & sl = cur.selBegin();
304                 Text const & text = *sl.text();
305                 Paragraph const & par = text.getPar(sl.pit());
306         
307                 // get font at the position
308                 Font oldfont = par.getFont(cur.bv().buffer().params(), sl.pos(),
309                         text.outerFont(sl.pit()));
310                 FontInfo const & oldfi = oldfont.fontInfo();
311         
312                 FontInfo & newfi = newfont.fontInfo();
313         
314                 FontFamily newfam = newfi.family();
315                 if (newfam !=   INHERIT_FAMILY && newfam != IGNORE_FAMILY &&
316                                 newfam == oldfi.family())
317                         newfi.setFamily(INHERIT_FAMILY);
318                 
319                 FontSeries newser = newfi.series();
320                 if (newser == BOLD_SERIES && oldfi.series() == BOLD_SERIES)
321                         newfi.setSeries(INHERIT_SERIES);
322         
323                 FontShape newshp = newfi.shape();
324                 if (newshp != INHERIT_SHAPE && newshp != IGNORE_SHAPE &&
325                                 newshp == oldfi.shape())
326                         newfi.setShape(INHERIT_SHAPE);
327
328                 ColorCode newcol = newfi.color();
329                 if (newcol != Color_none && newcol != Color_inherit 
330                     && newcol != Color_ignore && newcol == oldfi.color())
331                         newfi.setColor(Color_none);
332
333                 // ON/OFF ones
334                 if (newfi.emph() == FONT_TOGGLE)
335                         newfi.setEmph(oldfi.emph() == FONT_OFF ? FONT_ON : FONT_OFF);
336                 if (newfi.underbar() == FONT_TOGGLE)
337                         newfi.setUnderbar(oldfi.underbar() == FONT_OFF ? FONT_ON : FONT_OFF);
338                 if (newfi.strikeout() == FONT_TOGGLE)
339                         newfi.setStrikeout(oldfi.strikeout() == FONT_OFF ? FONT_ON : FONT_OFF);
340                 if (newfi.uuline() == FONT_TOGGLE)
341                         newfi.setUuline(oldfi.uuline() == FONT_OFF ? FONT_ON : FONT_OFF);
342                 if (newfi.uwave() == FONT_TOGGLE)
343                         newfi.setUwave(oldfi.uwave() == FONT_OFF ? FONT_ON : FONT_OFF);
344                 if (newfi.noun() == FONT_TOGGLE)
345                         newfi.setNoun(oldfi.noun() == FONT_OFF ? FONT_ON : FONT_OFF);
346                 if (newfi.number() == FONT_TOGGLE)
347                         newfi.setNumber(oldfi.number() == FONT_OFF ? FONT_ON : FONT_OFF);
348         }
349
350         setFont(cur.bv(), cur.selectionBegin().top(), 
351                 cur.selectionEnd().top(), newfont);
352 }
353
354
355 void Text::setFont(BufferView const & bv, CursorSlice const & begin,
356                 CursorSlice const & end, Font const & font)
357 {
358         Buffer const & buffer = bv.buffer();
359
360         // Don't use forwardChar here as ditend might have
361         // pos() == lastpos() and forwardChar would miss it.
362         // Can't use forwardPos either as this descends into
363         // nested insets.
364         Language const * language = buffer.params().language;
365         for (CursorSlice dit = begin; dit != end; dit.forwardPos()) {
366                 if (dit.pos() == dit.lastpos())
367                         continue;
368                 pit_type const pit = dit.pit();
369                 pos_type const pos = dit.pos();
370                 Inset * inset = pars_[pit].getInset(pos);
371                 if (inset && inset->resetFontEdit()) {
372                         // We need to propagate the font change to all
373                         // text cells of the inset (bugs 1973, 6919).
374                         setInsetFont(bv, pit, pos, font);
375                 }
376                 TextMetrics const & tm = bv.textMetrics(this);
377                 Font f = tm.displayFont(pit, pos);
378                 f.update(font, language);
379                 setCharFont(pit, pos, f, tm.font_);
380                 // font change may change language... 
381                 // spell checker has to know that
382                 pars_[pit].requestSpellCheck(pos);
383         }
384 }
385
386
387 bool Text::cursorTop(Cursor & cur)
388 {
389         LBUFERR(this == cur.text());
390         return setCursor(cur, 0, 0);
391 }
392
393
394 bool Text::cursorBottom(Cursor & cur)
395 {
396         LBUFERR(this == cur.text());
397         return setCursor(cur, cur.lastpit(), prev(paragraphs().end(), 1)->size());
398 }
399
400
401 void Text::toggleFree(Cursor & cur, Font const & font, bool toggleall)
402 {
403         LBUFERR(this == cur.text());
404         // If the mask is completely neutral, tell user
405         if (font.fontInfo() == ignore_font && font.language() == ignore_language) {
406                 // Could only happen with user style
407                 cur.message(_("No font change defined."));
408                 return;
409         }
410
411         // Try implicit word selection
412         // If there is a change in the language the implicit word selection
413         // is disabled.
414         CursorSlice const resetCursor = cur.top();
415         bool const implicitSelection =
416                 font.language() == ignore_language
417                 && font.fontInfo().number() == FONT_IGNORE
418                 && selectWordWhenUnderCursor(cur, WHOLE_WORD_STRICT);
419
420         // Set font
421         setFont(cur, font, toggleall);
422
423         // Implicit selections are cleared afterwards
424         // and cursor is set to the original position.
425         if (implicitSelection) {
426                 cur.clearSelection();
427                 cur.top() = resetCursor;
428                 cur.resetAnchor();
429         }
430 }
431
432
433 docstring Text::getStringToIndex(Cursor const & cur)
434 {
435         LBUFERR(this == cur.text());
436
437         if (cur.selection())
438                 return cur.selectionAsString(false);
439
440         // Try implicit word selection. If there is a change
441         // in the language the implicit word selection is
442         // disabled.
443         Cursor tmpcur = cur;
444         selectWord(tmpcur, PREVIOUS_WORD);
445
446         if (!tmpcur.selection())
447                 cur.message(_("Nothing to index!"));
448         else if (tmpcur.selBegin().pit() != tmpcur.selEnd().pit())
449                 cur.message(_("Cannot index more than one paragraph!"));
450         else
451                 return tmpcur.selectionAsString(false);
452         
453         return docstring();
454 }
455
456
457 void Text::setLabelWidthStringToSequence(Cursor const & cur,
458                 docstring const & s)
459 {
460         Cursor c = cur;
461         // Find first of same layout in sequence
462         while (!isFirstInSequence(c.pit())) {
463                 c.pit() = depthHook(c.pit(), c.paragraph().getDepth());
464         }
465
466         // now apply label width string to every par
467         // in sequence
468         depth_type const depth = c.paragraph().getDepth();
469         Layout const & layout = c.paragraph().layout();
470         for ( ; c.pit() <= c.lastpit() ; ++c.pit()) {
471                 while (c.paragraph().getDepth() > depth) {
472                         ++c.pit();
473                         if (c.pit() > c.lastpit())
474                                 return;
475                 }
476                 if (c.paragraph().getDepth() < depth)
477                         return;
478                 if (c.paragraph().layout() != layout)
479                         return;
480                 c.recordUndo();
481                 c.paragraph().setLabelWidthString(s);
482         }
483 }
484
485
486 void Text::setParagraphs(Cursor & cur, docstring arg, bool merge)
487 {
488         LBUFERR(cur.text());
489
490         //FIXME UNICODE
491         string const argument = to_utf8(arg);
492         depth_type priordepth = -1;
493         Layout priorlayout;
494         Cursor c(cur.bv());
495         c.setCursor(cur.selectionBegin());
496         for ( ; c <= cur.selectionEnd() ; ++c.pit()) {
497                 Paragraph & par = c.paragraph();
498                 ParagraphParameters params = par.params();
499                 params.read(argument, merge);
500                 // Changes to label width string apply to all paragraphs
501                 // with same layout in a sequence.
502                 // Do this only once for a selected range of paragraphs
503                 // of the same layout and depth.
504                 c.recordUndo();
505                 par.params().apply(params, par.layout());
506                 if (par.getDepth() != priordepth || par.layout() != priorlayout)
507                         setLabelWidthStringToSequence(c, params.labelWidthString());
508                 priordepth = par.getDepth();
509                 priorlayout = par.layout();
510         }
511 }
512
513
514 void Text::setParagraphs(Cursor & cur, ParagraphParameters const & p)
515 {
516         LBUFERR(cur.text());
517
518         depth_type priordepth = -1;
519         Layout priorlayout;
520         Cursor c(cur.bv());
521         c.setCursor(cur.selectionBegin());
522         for ( ; c < cur.selectionEnd() ; ++c.pit()) {
523                 Paragraph & par = c.paragraph();
524                 // Changes to label width string apply to all paragraphs
525                 // with same layout in a sequence.
526                 // Do this only once for a selected range of paragraphs
527                 // of the same layout and depth.
528                 cur.recordUndo();
529                 par.params().apply(p, par.layout());
530                 if (par.getDepth() != priordepth || par.layout() != priorlayout)
531                         setLabelWidthStringToSequence(c,
532                                 par.params().labelWidthString());
533                 priordepth = par.getDepth();
534                 priorlayout = par.layout();
535         }
536 }
537
538
539 // this really should just insert the inset and not move the cursor.
540 void Text::insertInset(Cursor & cur, Inset * inset)
541 {
542         LBUFERR(this == cur.text());
543         LBUFERR(inset);
544         cur.paragraph().insertInset(cur.pos(), inset, cur.current_font,
545                 Change(cur.buffer()->params().track_changes
546                 ? Change::INSERTED : Change::UNCHANGED));
547 }
548
549
550 bool Text::setCursor(Cursor & cur, pit_type par, pos_type pos,
551                         bool setfont, bool boundary)
552 {
553         TextMetrics const & tm = cur.bv().textMetrics(this);
554         bool const update_needed = !tm.contains(par);
555         Cursor old = cur;
556         setCursorIntern(cur, par, pos, setfont, boundary);
557         return cur.bv().checkDepm(cur, old) || update_needed;
558 }
559
560
561 void Text::setCursor(CursorSlice & cur, pit_type par, pos_type pos)
562 {
563         LASSERT(par != int(paragraphs().size()), return);
564         cur.pit() = par;
565         cur.pos() = pos;
566
567         // now some strict checking
568         Paragraph & para = getPar(par);
569
570         // None of these should happen, but we're scaredy-cats
571         if (pos < 0) {
572                 LYXERR0("Don't like -1!");
573                 LATTEST(false);
574         }
575
576         if (pos > para.size()) {
577                 LYXERR0("Don't like 1, pos: " << pos
578                        << " size: " << para.size()
579                        << " par: " << par);
580                 LATTEST(false);
581         }
582 }
583
584
585 void Text::setCursorIntern(Cursor & cur,
586                               pit_type par, pos_type pos, bool setfont, bool boundary)
587 {
588         LBUFERR(this == cur.text());
589         cur.boundary(boundary);
590         setCursor(cur.top(), par, pos);
591         if (setfont)
592                 cur.setCurrentFont();
593 }
594
595
596 bool Text::checkAndActivateInset(Cursor & cur, bool front)
597 {
598         if (front && cur.pos() == cur.lastpos())
599                 return false;
600         if (!front && cur.pos() == 0)
601                 return false;
602         Inset * inset = front ? cur.nextInset() : cur.prevInset();
603         if (!inset || !inset->editable())
604                 return false;
605         if (cur.selection() && cur.realAnchor().find(inset) == -1)
606                 return false;
607         /*
608          * Apparently, when entering an inset we are expected to be positioned
609          * *before* it in the containing paragraph, regardless of the direction
610          * from which we are entering. Otherwise, cursor placement goes awry,
611          * and when we exit from the beginning, we'll be placed *after* the
612          * inset.
613          */
614         if (!front)
615                 --cur.pos();
616         inset->edit(cur, front);
617         return true;
618 }
619
620
621 bool Text::checkAndActivateInsetVisual(Cursor & cur, bool movingForward, bool movingLeft)
622 {
623         if (cur.pos() == -1)
624                 return false;
625         if (cur.pos() == cur.lastpos())
626                 return false;
627         Paragraph & par = cur.paragraph();
628         Inset * inset = par.isInset(cur.pos()) ? par.getInset(cur.pos()) : 0;
629         if (!inset || !inset->editable())
630                 return false;
631         if (cur.selection() && cur.realAnchor().find(inset) == -1)
632                 return false;
633         inset->edit(cur, movingForward, 
634                 movingLeft ? Inset::ENTRY_DIRECTION_RIGHT : Inset::ENTRY_DIRECTION_LEFT);
635         return true;
636 }
637
638
639 bool Text::cursorBackward(Cursor & cur)
640 {
641         // Tell BufferView to test for FitCursor in any case!
642         cur.screenUpdateFlags(Update::FitCursor);
643
644         // not at paragraph start?
645         if (cur.pos() > 0) {
646                 // if on right side of boundary (i.e. not at paragraph end, but line end)
647                 // -> skip it, i.e. set boundary to true, i.e. go only logically left
648                 // there are some exceptions to ignore this: lineseps, newlines, spaces
649 #if 0
650                 // some effectless debug code to see the values in the debugger
651                 bool bound = cur.boundary();
652                 int rowpos = cur.textRow().pos();
653                 int pos = cur.pos();
654                 bool sep = cur.paragraph().isSeparator(cur.pos() - 1);
655                 bool newline = cur.paragraph().isNewline(cur.pos() - 1);
656                 bool linesep = cur.paragraph().isLineSeparator(cur.pos() - 1);
657 #endif
658                 if (!cur.boundary() &&
659                                 cur.textRow().pos() == cur.pos() &&
660                                 !cur.paragraph().isLineSeparator(cur.pos() - 1) &&
661                                 !cur.paragraph().isNewline(cur.pos() - 1) &&
662                                 !cur.paragraph().isEnvSeparator(cur.pos() - 1) &&
663                                 !cur.paragraph().isSeparator(cur.pos() - 1)) {
664                         return setCursor(cur, cur.pit(), cur.pos(), true, true);
665                 }
666                 
667                 // go left and try to enter inset
668                 if (checkAndActivateInset(cur, false))
669                         return false;
670                 
671                 // normal character left
672                 return setCursor(cur, cur.pit(), cur.pos() - 1, true, false);
673         }
674
675         // move to the previous paragraph or do nothing
676         if (cur.pit() > 0) {
677                 Paragraph & par = getPar(cur.pit() - 1);
678                 pos_type lastpos = par.size();
679                 if (lastpos > 0 && par.isEnvSeparator(lastpos - 1))
680                         return setCursor(cur, cur.pit() - 1, lastpos - 1, true, false);
681                 else
682                         return setCursor(cur, cur.pit() - 1, lastpos, true, false);
683         }
684         return false;
685 }
686
687
688 bool Text::cursorVisLeft(Cursor & cur, bool skip_inset)
689 {
690         Cursor temp_cur = cur;
691         temp_cur.posVisLeft(skip_inset);
692         if (temp_cur.depth() > cur.depth()) {
693                 cur = temp_cur;
694                 return false;
695         }
696         return setCursor(cur, temp_cur.pit(), temp_cur.pos(), 
697                 true, temp_cur.boundary());
698 }
699
700
701 bool Text::cursorVisRight(Cursor & cur, bool skip_inset)
702 {
703         Cursor temp_cur = cur;
704         temp_cur.posVisRight(skip_inset);
705         if (temp_cur.depth() > cur.depth()) {
706                 cur = temp_cur;
707                 return false;
708         }
709         return setCursor(cur, temp_cur.pit(), temp_cur.pos(),
710                 true, temp_cur.boundary());
711 }
712
713
714 bool Text::cursorForward(Cursor & cur)
715 {
716         // Tell BufferView to test for FitCursor in any case!
717         cur.screenUpdateFlags(Update::FitCursor);
718
719         // not at paragraph end?
720         if (cur.pos() != cur.lastpos()) {
721                 // in front of editable inset, i.e. jump into it?
722                 if (checkAndActivateInset(cur, true))
723                         return false;
724
725                 TextMetrics const & tm = cur.bv().textMetrics(this);
726                 // if left of boundary -> just jump to right side
727                 // but for RTL boundaries don't, because: abc|DDEEFFghi -> abcDDEEF|Fghi
728                 if (cur.boundary() && !tm.isRTLBoundary(cur.pit(), cur.pos()))
729                         return setCursor(cur, cur.pit(), cur.pos(), true, false);
730
731                 // next position is left of boundary, 
732                 // but go to next line for special cases like space, newline, linesep
733 #if 0
734                 // some effectless debug code to see the values in the debugger
735                 int endpos = cur.textRow().endpos();
736                 int lastpos = cur.lastpos();
737                 int pos = cur.pos();
738                 bool linesep = cur.paragraph().isLineSeparator(cur.pos());
739                 bool newline = cur.paragraph().isNewline(cur.pos());
740                 bool sep = cur.paragraph().isSeparator(cur.pos());
741                 if (cur.pos() != cur.lastpos()) {
742                         bool linesep2 = cur.paragraph().isLineSeparator(cur.pos()+1);
743                         bool newline2 = cur.paragraph().isNewline(cur.pos()+1);
744                         bool sep2 = cur.paragraph().isSeparator(cur.pos()+1);
745                 }
746 #endif
747                 if (cur.textRow().endpos() == cur.pos() + 1) {
748                         if (cur.paragraph().isEnvSeparator(cur.pos()) &&
749                             cur.pos() + 1 == cur.lastpos() &&
750                             cur.pit() != cur.lastpit()) {
751                                 // move to next paragraph
752                                 return setCursor(cur, cur.pit() + 1, 0, true, false);
753                         } else if (cur.textRow().endpos() != cur.lastpos() &&
754                                    !cur.paragraph().isNewline(cur.pos()) &&
755                                    !cur.paragraph().isEnvSeparator(cur.pos()) &&
756                                    !cur.paragraph().isLineSeparator(cur.pos()) &&
757                                    !cur.paragraph().isSeparator(cur.pos())) {
758                                 return setCursor(cur, cur.pit(), cur.pos() + 1, true, true);
759                         }
760                 }
761                 
762                 // in front of RTL boundary? Stay on this side of the boundary because:
763                 //   ab|cDDEEFFghi -> abc|DDEEFFghi
764                 if (tm.isRTLBoundary(cur.pit(), cur.pos() + 1))
765                         return setCursor(cur, cur.pit(), cur.pos() + 1, true, true);
766                 
767                 // move right
768                 return setCursor(cur, cur.pit(), cur.pos() + 1, true, false);
769         }
770
771         // move to next paragraph
772         if (cur.pit() != cur.lastpit())
773                 return setCursor(cur, cur.pit() + 1, 0, true, false);
774         return false;
775 }
776
777
778 bool Text::cursorUpParagraph(Cursor & cur)
779 {
780         bool updated = false;
781         if (cur.pos() > 0)
782                 updated = setCursor(cur, cur.pit(), 0);
783         else if (cur.pit() != 0)
784                 updated = setCursor(cur, cur.pit() - 1, 0);
785         return updated;
786 }
787
788
789 bool Text::cursorDownParagraph(Cursor & cur)
790 {
791         bool updated = false;
792         if (cur.pit() != cur.lastpit())
793                 if (lyxrc.mac_like_cursor_movement)
794                         if (cur.pos() == cur.lastpos())
795                                 updated = setCursor(cur, cur.pit() + 1, getPar(cur.pit() + 1).size());
796                         else
797                                 updated = setCursor(cur, cur.pit(), cur.lastpos());
798                 else
799                         updated = setCursor(cur, cur.pit() + 1, 0);
800         else
801                 updated = setCursor(cur, cur.pit(), cur.lastpos());
802         return updated;
803 }
804
805
806 // fix the cursor `cur' after a characters has been deleted at `where'
807 // position. Called by deleteEmptyParagraphMechanism
808 void Text::fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where)
809 {
810         // Do nothing if cursor is not in the paragraph where the
811         // deletion occurred,
812         if (cur.pit() != where.pit())
813                 return;
814
815         // If cursor position is after the deletion place update it
816         if (cur.pos() > where.pos())
817                 --cur.pos();
818
819         // Check also if we don't want to set the cursor on a spot behind the
820         // pagragraph because we erased the last character.
821         if (cur.pos() > cur.lastpos())
822                 cur.pos() = cur.lastpos();
823 }
824
825
826 bool Text::deleteEmptyParagraphMechanism(Cursor & cur,
827                 Cursor & old, bool & need_anchor_change)
828 {
829         //LYXERR(Debug::DEBUG, "DEPM: cur:\n" << cur << "old:\n" << old);
830
831         Paragraph & oldpar = old.paragraph();
832
833         // We allow all kinds of "mumbo-jumbo" when freespacing.
834         if (oldpar.isFreeSpacing())
835                 return false;
836
837         /* Ok I'll put some comments here about what is missing.
838            There are still some small problems that can lead to
839            double spaces stored in the document file or space at
840            the beginning of paragraphs(). This happens if you have
841            the cursor between to spaces and then save. Or if you
842            cut and paste and the selection have a space at the
843            beginning and then save right after the paste. (Lgb)
844         */
845
846         // If old.pos() == 0 and old.pos()(1) == LineSeparator
847         // delete the LineSeparator.
848         // MISSING
849
850         // If old.pos() == 1 and old.pos()(0) == LineSeparator
851         // delete the LineSeparator.
852         // MISSING
853
854         // Find a common inset and the corresponding depth.
855         size_t depth = 0;
856         for (; depth < cur.depth(); ++depth)
857                 if (&old.inset() == &cur[depth].inset())
858                         break;
859
860         // Whether a common inset is found and whether the cursor is still in 
861         // the same paragraph (possibly nested).
862         bool const same_par = depth < cur.depth() && old.pit() == cur[depth].pit();
863         bool const same_par_pos = depth == cur.depth() - 1 && same_par 
864                 && old.pos() == cur[depth].pos();
865         
866         // If the chars around the old cursor were spaces, delete one of them.
867         if (!same_par_pos) {
868                 // Only if the cursor has really moved.
869                 if (old.pos() > 0
870                     && old.pos() < oldpar.size()
871                     && oldpar.isLineSeparator(old.pos())
872                     && oldpar.isLineSeparator(old.pos() - 1)
873                     && !oldpar.isDeleted(old.pos() - 1)
874                     && !oldpar.isDeleted(old.pos())) {
875                         oldpar.eraseChar(old.pos() - 1, cur.buffer()->params().track_changes);
876 // FIXME: This will not work anymore when we have multiple views of the same buffer
877 // In this case, we will have to correct also the cursors held by
878 // other bufferviews. It will probably be easier to do that in a more
879 // automated way in CursorSlice code. (JMarc 26/09/2001)
880                         // correct all cursor parts
881                         if (same_par) {
882                                 fixCursorAfterDelete(cur[depth], old.top());
883                                 need_anchor_change = true;
884                         }
885                         return true;
886                 }
887         }
888
889         // only do our magic if we changed paragraph
890         if (same_par)
891                 return false;
892
893         // don't delete anything if this is the ONLY paragraph!
894         if (old.lastpit() == 0)
895                 return false;
896
897         // Do not delete empty paragraphs with keepempty set.
898         if (oldpar.allowEmpty())
899                 return false;
900
901         if (oldpar.empty() || (oldpar.size() == 1 && oldpar.isLineSeparator(0))) {
902                 // Delete old par.
903                 old.recordUndo(max(old.pit() - 1, pit_type(0)),
904                                min(old.pit() + 1, old.lastpit()));
905                 ParagraphList & plist = old.text()->paragraphs();
906                 bool const soa = oldpar.params().startOfAppendix();
907                 plist.erase(next(plist.begin(), old.pit()));
908                 // do not lose start of appendix marker (bug 4212)
909                 if (soa && old.pit() < pit_type(plist.size()))
910                         plist[old.pit()].params().startOfAppendix(true);
911
912                 // see #warning (FIXME?) above 
913                 if (cur.depth() >= old.depth()) {
914                         CursorSlice & curslice = cur[old.depth() - 1];
915                         if (&curslice.inset() == &old.inset()
916                             && curslice.pit() > old.pit()) {
917                                 --curslice.pit();
918                                 // since a paragraph has been deleted, all the
919                                 // insets after `old' have been copied and
920                                 // their address has changed. Therefore we
921                                 // need to `regenerate' cur. (JMarc)
922                                 cur.updateInsets(&(cur.bottom().inset()));
923                                 need_anchor_change = true;
924                         }
925                 }
926                 return true;
927         }
928
929         if (oldpar.stripLeadingSpaces(cur.buffer()->params().track_changes)) {
930                 need_anchor_change = true;
931                 // We return true here because the Paragraph contents changed and
932                 // we need a redraw before further action is processed.
933                 return true;
934         }
935
936         return false;
937 }
938
939
940 void Text::deleteEmptyParagraphMechanism(pit_type first, pit_type last, bool trackChanges)
941 {
942         LASSERT(first >= 0 && first <= last && last < (int) pars_.size(), return);
943
944         for (pit_type pit = first; pit <= last; ++pit) {
945                 Paragraph & par = pars_[pit];
946
947                 // We allow all kinds of "mumbo-jumbo" when freespacing.
948                 if (par.isFreeSpacing())
949                         continue;
950
951                 for (pos_type pos = 1; pos < par.size(); ++pos) {
952                         if (par.isLineSeparator(pos) && par.isLineSeparator(pos - 1)
953                             && !par.isDeleted(pos - 1)) {
954                                 if (par.eraseChar(pos - 1, trackChanges)) {
955                                         --pos;
956                                 }
957                         }
958                 }
959
960                 // don't delete anything if this is the only remaining paragraph
961                 // within the given range. Note: Text::acceptOrRejectChanges()
962                 // sets the cursor to 'first' after calling DEPM
963                 if (first == last)
964                         continue;
965
966                 // don't delete empty paragraphs with keepempty set
967                 if (par.allowEmpty())
968                         continue;
969
970                 if (par.empty() || (par.size() == 1 && par.isLineSeparator(0))) {
971                         pars_.erase(next(pars_.begin(), pit));
972                         --pit;
973                         --last;
974                         continue;
975                 }
976
977                 par.stripLeadingSpaces(trackChanges);
978         }
979 }
980
981
982 } // namespace lyx