3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Dov Feldstern
9 * \author Jean-Marc Lasgouttes
11 * \author André Pönitz
12 * \author Stefan Schimanski
14 * \author Jürgen Vigna
16 * Full author contact details are available in file CREDITS.
25 #include "buffer_funcs.h"
26 #include "BufferParams.h"
27 #include "BufferView.h"
30 #include "ParIterator.h"
31 #include "CutAndPaste.h"
33 #include "DispatchResult.h"
35 #include "ErrorList.h"
36 #include "FuncRequest.h"
38 #include "FontIterator.h"
45 #include "Paragraph.h"
46 #include "paragraph_funcs.h"
47 #include "ParagraphParameters.h"
48 #include "TextMetrics.h"
50 #include "WordLangTuple.h"
52 #include "frontends/FontMetrics.h"
53 #include "frontends/Painter.h"
55 #include "insets/InsetText.h"
56 #include "insets/InsetBibitem.h"
57 #include "insets/InsetCaption.h"
58 #include "insets/InsetHFill.h"
59 #include "insets/InsetLine.h"
60 #include "insets/InsetNewline.h"
61 #include "insets/InsetPagebreak.h"
62 #include "insets/InsetOptArg.h"
63 #include "insets/InsetSpace.h"
64 #include "insets/InsetSpecialChar.h"
65 #include "insets/InsetTabular.h"
67 #include "support/lstrings.h"
68 #include "support/textutils.h"
69 #include "support/convert.h"
71 #include <boost/current_function.hpp>
72 #include <boost/next_prior.hpp>
86 using support::bformat;
87 using support::contains;
88 using support::lowercase;
90 using support::uppercase;
92 using cap::cutSelection;
93 using cap::pasteParagraphList;
95 using frontend::FontMetrics;
99 void readParToken(Buffer const & buf, Paragraph & par, Lexer & lex,
100 string const & token, Font & font, Change & change, ErrorList & errorList)
102 BufferParams const & bp = buf.params();
104 if (token[0] != '\\') {
105 docstring dstr = lex.getDocString();
106 par.appendString(dstr, font, change);
108 } else if (token == "\\begin_layout") {
110 docstring layoutname = lex.getDocString();
112 font = Font(Font::ALL_INHERIT, bp.language);
113 change = Change(Change::UNCHANGED);
115 TextClass const & tclass = bp.getTextClass();
117 if (layoutname.empty()) {
118 layoutname = tclass.defaultLayoutName();
121 bool hasLayout = tclass.hasLayout(layoutname);
124 errorList.push_back(ErrorItem(_("Unknown layout"),
125 bformat(_("Layout '%1$s' does not exist in textclass '%2$s'\nTrying to use the default instead.\n"),
126 layoutname, from_utf8(tclass.name())), par.id(), 0, par.size()));
127 layoutname = tclass.defaultLayoutName();
130 par.layout(bp.getTextClass()[layoutname]);
132 // Test whether the layout is obsolete.
133 LayoutPtr const & layout = par.layout();
134 if (!layout->obsoleted_by().empty())
135 par.layout(bp.getTextClass()[layout->obsoleted_by()]);
137 par.params().read(lex);
139 } else if (token == "\\end_layout") {
140 lyxerr << BOOST_CURRENT_FUNCTION
141 << ": Solitary \\end_layout in line "
142 << lex.getLineNo() << "\n"
143 << "Missing \\begin_layout?.\n";
144 } else if (token == "\\end_inset") {
145 lyxerr << BOOST_CURRENT_FUNCTION
146 << ": Solitary \\end_inset in line "
147 << lex.getLineNo() << "\n"
148 << "Missing \\begin_inset?.\n";
149 } else if (token == "\\begin_inset") {
150 Inset * inset = readInset(lex, buf);
152 par.insertInset(par.size(), inset, font, change);
155 docstring line = lex.getDocString();
156 errorList.push_back(ErrorItem(_("Unknown Inset"), line,
157 par.id(), 0, par.size()));
159 } else if (token == "\\family") {
161 font.setLyXFamily(lex.getString());
162 } else if (token == "\\series") {
164 font.setLyXSeries(lex.getString());
165 } else if (token == "\\shape") {
167 font.setLyXShape(lex.getString());
168 } else if (token == "\\size") {
170 font.setLyXSize(lex.getString());
171 } else if (token == "\\lang") {
173 string const tok = lex.getString();
174 Language const * lang = languages.getLanguage(tok);
176 font.setLanguage(lang);
178 font.setLanguage(bp.language);
179 lex.printError("Unknown language `$$Token'");
181 } else if (token == "\\numeric") {
183 font.setNumber(font.setLyXMisc(lex.getString()));
184 } else if (token == "\\emph") {
186 font.setEmph(font.setLyXMisc(lex.getString()));
187 } else if (token == "\\bar") {
189 string const tok = lex.getString();
192 font.setUnderbar(Font::ON);
193 else if (tok == "no")
194 font.setUnderbar(Font::OFF);
195 else if (tok == "default")
196 font.setUnderbar(Font::INHERIT);
198 lex.printError("Unknown bar font flag "
200 } else if (token == "\\noun") {
202 font.setNoun(font.setLyXMisc(lex.getString()));
203 } else if (token == "\\color") {
205 font.setLyXColor(lex.getString());
206 } else if (token == "\\InsetSpace" || token == "\\SpecialChar") {
208 // Insets don't make sense in a free-spacing context! ---Kayvan
209 if (par.isFreeSpacing()) {
210 if (token == "\\InsetSpace")
211 par.appendChar(' ', font, change);
212 else if (lex.isOK()) {
214 string const next_token = lex.getString();
215 if (next_token == "\\-")
216 par.appendChar('-', font, change);
218 lex.printError("Token `$$Token' "
220 "paragraph layout!");
224 auto_ptr<Inset> inset;
225 if (token == "\\SpecialChar" )
226 inset.reset(new InsetSpecialChar);
228 inset.reset(new InsetSpace);
229 inset->read(buf, lex);
230 par.insertInset(par.size(), inset.release(),
233 } else if (token == "\\backslash") {
234 par.appendChar('\\', font, change);
235 } else if (token == "\\newline") {
236 auto_ptr<Inset> inset(new InsetNewline);
237 inset->read(buf, lex);
238 par.insertInset(par.size(), inset.release(), font, change);
239 } else if (token == "\\LyXTable") {
240 auto_ptr<Inset> inset(new InsetTabular(buf));
241 inset->read(buf, lex);
242 par.insertInset(par.size(), inset.release(), font, change);
243 } else if (token == "\\hfill") {
244 par.insertInset(par.size(), new InsetHFill, font, change);
245 } else if (token == "\\lyxline") {
246 par.insertInset(par.size(), new InsetLine, font, change);
247 } else if (token == "\\newpage") {
248 par.insertInset(par.size(), new InsetPagebreak, font, change);
249 } else if (token == "\\clearpage") {
250 par.insertInset(par.size(), new InsetClearPage, font, change);
251 } else if (token == "\\cleardoublepage") {
252 par.insertInset(par.size(), new InsetClearDoublePage, font, change);
253 } else if (token == "\\change_unchanged") {
254 change = Change(Change::UNCHANGED);
255 } else if (token == "\\change_inserted") {
257 std::istringstream is(lex.getString());
261 if (aid >= bp.author_map.size()) {
262 errorList.push_back(ErrorItem(_("Change tracking error"),
263 bformat(_("Unknown author index for insertion: %1$d\n"), aid),
264 par.id(), 0, par.size()));
265 change = Change(Change::UNCHANGED);
267 change = Change(Change::INSERTED, bp.author_map[aid], ct);
268 } else if (token == "\\change_deleted") {
270 std::istringstream is(lex.getString());
274 if (aid >= bp.author_map.size()) {
275 errorList.push_back(ErrorItem(_("Change tracking error"),
276 bformat(_("Unknown author index for deletion: %1$d\n"), aid),
277 par.id(), 0, par.size()));
278 change = Change(Change::UNCHANGED);
280 change = Change(Change::DELETED, bp.author_map[aid], ct);
283 errorList.push_back(ErrorItem(_("Unknown token"),
284 bformat(_("Unknown token: %1$s %2$s\n"), from_utf8(token),
286 par.id(), 0, par.size()));
291 void readParagraph(Buffer const & buf, Paragraph & par, Lexer & lex,
292 ErrorList & errorList)
295 string token = lex.getString();
297 Change change(Change::UNCHANGED);
300 readParToken(buf, par, lex, token, font, change, errorList);
303 token = lex.getString();
308 if (token == "\\end_layout") {
309 //Ok, paragraph finished
313 LYXERR(Debug::PARSER) << "Handling paragraph token: `"
314 << token << '\'' << endl;
315 if (token == "\\begin_layout" || token == "\\end_document"
316 || token == "\\end_inset" || token == "\\begin_deeper"
317 || token == "\\end_deeper") {
318 lex.pushToken(token);
319 lyxerr << "Paragraph ended in line "
320 << lex.getLineNo() << "\n"
321 << "Missing \\end_layout.\n";
325 // Final change goes to paragraph break:
326 par.setChange(par.size(), change);
328 // Initialize begin_of_body_ on load; redoParagraph maintains
329 par.setBeginOfBody();
336 bool Text::empty() const
338 return pars_.empty() || (pars_.size() == 1 && pars_[0].empty()
339 // FIXME: Should we consider the labeled type as empty too?
340 && pars_[0].layout()->labeltype == LABEL_NO_LABEL);
344 double Text::spacing(Buffer const & buffer,
345 Paragraph const & par) const
347 if (par.params().spacing().isDefault())
348 return buffer.params().spacing().getValue();
349 return par.params().spacing().getValue();
353 void Text::breakParagraph(Cursor & cur, bool inverse_logic)
355 BOOST_ASSERT(this == cur.text());
357 Paragraph & cpar = cur.paragraph();
358 pit_type cpit = cur.pit();
360 TextClass const & tclass = cur.buffer().params().getTextClass();
361 LayoutPtr const & layout = cpar.layout();
363 // this is only allowed, if the current paragraph is not empty
364 // or caption and if it has not the keepempty flag active
365 if (cur.lastpos() == 0 && !cpar.allowEmpty() &&
366 layout->labeltype != LABEL_SENSITIVE)
369 // a layout change may affect also the following paragraph
370 recUndo(cur, cur.pit(), undoSpan(cur.pit()) - 1);
372 // Always break behind a space
373 // It is better to erase the space (Dekel)
374 if (cur.pos() != cur.lastpos() && cpar.isLineSeparator(cur.pos()))
375 cpar.eraseChar(cur.pos(), cur.buffer().params().trackChanges);
377 // What should the layout for the new paragraph be?
378 bool keep_layout = inverse_logic ?
379 !layout->isEnvironment()
380 : layout->isEnvironment();
382 // We need to remember this before we break the paragraph, because
383 // that invalidates the layout variable
384 bool sensitive = layout->labeltype == LABEL_SENSITIVE;
386 // we need to set this before we insert the paragraph.
387 bool const isempty = cpar.allowEmpty() && cpar.empty();
389 lyx::breakParagraph(cur.buffer().params(), paragraphs(), cpit,
390 cur.pos(), keep_layout);
392 // After this, neither paragraph contains any rows!
395 pit_type next_par = cpit + 1;
397 // well this is the caption hack since one caption is really enough
400 // set to standard-layout
401 pars_[cpit].applyLayout(tclass.defaultLayout());
403 // set to standard-layout
404 pars_[next_par].applyLayout(tclass.defaultLayout());
407 while (!pars_[next_par].empty() && pars_[next_par].isNewline(0)) {
408 if (!pars_[next_par].eraseChar(0, cur.buffer().params().trackChanges))
409 break; // the character couldn't be deleted physically due to change tracking
412 updateLabels(cur.buffer());
414 // A singlePar update is not enough in this case.
415 cur.updateFlags(Update::Force);
417 // This check is necessary. Otherwise the new empty paragraph will
418 // be deleted automatically. And it is more friendly for the user!
419 if (cur.pos() != 0 || isempty)
420 setCursor(cur, cur.pit() + 1, 0);
422 setCursor(cur, cur.pit(), 0);
426 // insert a character, moves all the following breaks in the
427 // same Paragraph one to the right and make a rebreak
428 void Text::insertChar(Cursor & cur, char_type c)
430 BOOST_ASSERT(this == cur.text());
432 cur.recordUndo(INSERT_UNDO);
434 TextMetrics const & tm = cur.bv().textMetrics(this);
435 Buffer const & buffer = cur.buffer();
436 Paragraph & par = cur.paragraph();
437 // try to remove this
438 pit_type const pit = cur.pit();
440 bool const freeSpacing = par.layout()->free_spacing ||
443 if (lyxrc.auto_number) {
444 static docstring const number_operators = from_ascii("+-/*");
445 static docstring const number_unary_operators = from_ascii("+-");
446 static docstring const number_seperators = from_ascii(".,:");
448 if (cur.current_font.number() == Font::ON) {
449 if (!isDigit(c) && !contains(number_operators, c) &&
450 !(contains(number_seperators, c) &&
452 cur.pos() != cur.lastpos() &&
453 tm.getDisplayFont(pit, cur.pos()).number() == Font::ON &&
454 tm.getDisplayFont(pit, cur.pos() - 1).number() == Font::ON)
456 number(cur); // Set current_font.number to OFF
457 } else if (isDigit(c) &&
458 cur.real_current_font.isVisibleRightToLeft()) {
459 number(cur); // Set current_font.number to ON
461 if (cur.pos() != 0) {
462 char_type const c = par.getChar(cur.pos() - 1);
463 if (contains(number_unary_operators, c) &&
465 || par.isSeparator(cur.pos() - 2)
466 || par.isNewline(cur.pos() - 2))
468 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
470 } else if (contains(number_seperators, c)
472 && tm.getDisplayFont(pit, cur.pos() - 2).number() == Font::ON) {
473 setCharFont(buffer, pit, cur.pos() - 1, cur.current_font,
480 // In Bidi text, we want spaces to be treated in a special way: spaces
481 // which are between words in different languages should get the
482 // paragraph's language; otherwise, spaces should keep the language
483 // they were originally typed in. This is only in effect while typing;
484 // after the text is already typed in, the user can always go back and
485 // explicitly set the language of a space as desired. But 99.9% of the
486 // time, what we're doing here is what the user actually meant.
488 // The following cases are the ones in which the language of the space
489 // should be changed to match that of the containing paragraph. In the
490 // depictions, lowercase is LTR, uppercase is RTL, underscore (_)
491 // represents a space, pipe (|) represents the cursor position (so the
492 // character before it is the one just typed in). The different cases
493 // are depicted logically (not visually), from left to right:
498 // Theoretically, there are other situations that we should, perhaps, deal
499 // with (e.g.: a|_A, A|_a). In practice, though, there really isn't any
500 // point (to understand why, just try to create this situation...).
502 if ((cur.pos() >= 2) && (par.isLineSeparator(cur.pos() - 1))) {
503 // get font in front and behind the space in question. But do NOT
504 // use getFont(cur.pos()) because the character c is not inserted yet
505 Font const & pre_space_font = tm.getDisplayFont(cur.pit(), cur.pos() - 2);
506 Font const & post_space_font = cur.real_current_font;
507 bool pre_space_rtl = pre_space_font.isVisibleRightToLeft();
508 bool post_space_rtl = post_space_font.isVisibleRightToLeft();
510 if (pre_space_rtl != post_space_rtl) {
511 // Set the space's language to match the language of the
512 // adjacent character whose direction is the paragraph's
513 // direction; don't touch other properties of the font
514 Language const * lang =
515 (pre_space_rtl == par.isRTL(buffer.params())) ?
516 pre_space_font.language() : post_space_font.language();
518 Font space_font = tm.getDisplayFont(cur.pit(), cur.pos() - 1);
519 space_font.setLanguage(lang);
520 par.setFont(cur.pos() - 1, space_font);
524 // Next check, if there will be two blanks together or a blank at
525 // the beginning of a paragraph.
526 // I decided to handle blanks like normal characters, the main
527 // difference are the special checks when calculating the row.fill
528 // (blank does not count at the end of a row) and the check here
530 // When the free-spacing option is set for the current layout,
531 // disable the double-space checking
532 if (!freeSpacing && isLineSeparatorChar(c)) {
533 if (cur.pos() == 0) {
534 static bool sent_space_message = false;
535 if (!sent_space_message) {
536 cur.message(_("You cannot insert a space at the "
537 "beginning of a paragraph. Please read the Tutorial."));
538 sent_space_message = true;
542 BOOST_ASSERT(cur.pos() > 0);
543 if ((par.isLineSeparator(cur.pos() - 1) || par.isNewline(cur.pos() - 1))
544 && !par.isDeleted(cur.pos() - 1)) {
545 static bool sent_space_message = false;
546 if (!sent_space_message) {
547 cur.message(_("You cannot type two spaces this way. "
548 "Please read the Tutorial."));
549 sent_space_message = true;
555 par.insertChar(cur.pos(), c, cur.current_font, cur.buffer().params().trackChanges);
556 checkBufferStructure(cur.buffer(), cur);
558 // cur.updateFlags(Update::Force);
559 setCursor(cur.top(), cur.pit(), cur.pos() + 1);
564 void Text::charInserted(Cursor & cur)
566 // Here we call finishUndo for every 20 characters inserted.
567 // This is from my experience how emacs does it. (Lgb)
568 static unsigned int counter;
578 // the cursor set functions have a special mechanism. When they
579 // realize, that you left an empty paragraph, they will delete it.
581 bool Text::cursorRightOneWord(Cursor & cur)
583 BOOST_ASSERT(this == cur.text());
587 if (old.pos() == old.lastpos() && old.pit() != old.lastpit()) {
591 // Advance through word.
592 while (old.pos() != old.lastpos() && old.paragraph().isLetter(old.pos()))
594 // Skip through trailing nonword stuff.
595 while (old.pos() != old.lastpos() && !old.paragraph().isLetter(old.pos()))
598 return setCursor(cur, old.pit(), old.pos());
602 bool Text::cursorLeftOneWord(Cursor & cur)
604 BOOST_ASSERT(this == cur.text());
608 if (old.pos() == 0 && old.pit() != 0) {
610 old.pos() = old.lastpos();
612 // Skip through initial nonword stuff.
613 while (old.pos() != 0 && !old.paragraph().isLetter(old.pos() - 1))
615 // Advance through word.
616 while (old.pos() != 0 && old.paragraph().isLetter(old.pos() - 1))
619 return setCursor(cur, old.pit(), old.pos());
623 void Text::selectWord(Cursor & cur, word_location loc)
625 BOOST_ASSERT(this == cur.text());
626 CursorSlice from = cur.top();
627 CursorSlice to = cur.top();
628 getWord(from, to, loc);
629 if (cur.top() != from)
630 setCursor(cur, from.pit(), from.pos());
634 setCursor(cur, to.pit(), to.pos());
639 // Select the word currently under the cursor when no
640 // selection is currently set
641 bool Text::selectWordWhenUnderCursor(Cursor & cur, word_location loc)
643 BOOST_ASSERT(this == cur.text());
646 selectWord(cur, loc);
647 return cur.selection();
651 void Text::acceptOrRejectChanges(Cursor & cur, ChangeOp op)
653 BOOST_ASSERT(this == cur.text());
655 if (!cur.selection())
658 cur.recordUndoSelection();
660 pit_type begPit = cur.selectionBegin().pit();
661 pit_type endPit = cur.selectionEnd().pit();
663 pos_type begPos = cur.selectionBegin().pos();
664 pos_type endPos = cur.selectionEnd().pos();
666 // keep selection info, because endPos becomes invalid after the first loop
667 bool endsBeforeEndOfPar = (endPos < pars_[endPit].size());
669 // first, accept/reject changes within each individual paragraph (do not consider end-of-par)
671 for (pit_type pit = begPit; pit <= endPit; ++pit) {
672 pos_type parSize = pars_[pit].size();
674 // ignore empty paragraphs; otherwise, an assertion will fail for
675 // acceptChanges(bparams, 0, 0) or rejectChanges(bparams, 0, 0)
679 // do not consider first paragraph if the cursor starts at pos size()
680 if (pit == begPit && begPos == parSize)
683 // do not consider last paragraph if the cursor ends at pos 0
684 if (pit == endPit && endPos == 0)
685 break; // last iteration anyway
687 pos_type left = (pit == begPit ? begPos : 0);
688 pos_type right = (pit == endPit ? endPos : parSize);
691 pars_[pit].acceptChanges(cur.buffer().params(), left, right);
693 pars_[pit].rejectChanges(cur.buffer().params(), left, right);
697 // next, accept/reject imaginary end-of-par characters
699 for (pit_type pit = begPit; pit <= endPit; ++pit) {
700 pos_type pos = pars_[pit].size();
702 // skip if the selection ends before the end-of-par
703 if (pit == endPit && endsBeforeEndOfPar)
704 break; // last iteration anyway
706 // skip if this is not the last paragraph of the document
707 // note: the user should be able to accept/reject the par break of the last par!
708 if (pit == endPit && pit + 1 != int(pars_.size()))
709 break; // last iteration anway
712 if (pars_[pit].isInserted(pos)) {
713 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
714 } else if (pars_[pit].isDeleted(pos)) {
715 if (pit + 1 == int(pars_.size())) {
716 // we cannot remove a par break at the end of the last paragraph;
717 // instead, we mark it unchanged
718 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
720 mergeParagraph(cur.buffer().params(), pars_, pit);
726 if (pars_[pit].isDeleted(pos)) {
727 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
728 } else if (pars_[pit].isInserted(pos)) {
729 if (pit + 1 == int(pars_.size())) {
730 // we mark the par break at the end of the last paragraph unchanged
731 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
733 mergeParagraph(cur.buffer().params(), pars_, pit);
741 // finally, invoke the DEPM
743 deleteEmptyParagraphMechanism(begPit, endPit, cur.buffer().params().trackChanges);
748 cur.clearSelection();
749 setCursorIntern(cur, begPit, begPos);
750 cur.updateFlags(Update::Force);
751 updateLabels(cur.buffer());
755 void Text::acceptChanges(BufferParams const & bparams)
757 lyx::acceptChanges(pars_, bparams);
758 deleteEmptyParagraphMechanism(0, pars_.size() - 1, bparams.trackChanges);
762 void Text::rejectChanges(BufferParams const & bparams)
764 pit_type pars_size = static_cast<pit_type>(pars_.size());
766 // first, reject changes within each individual paragraph
767 // (do not consider end-of-par)
768 for (pit_type pit = 0; pit < pars_size; ++pit) {
769 if (!pars_[pit].empty()) // prevent assertion failure
770 pars_[pit].rejectChanges(bparams, 0, pars_[pit].size());
773 // next, reject imaginary end-of-par characters
774 for (pit_type pit = 0; pit < pars_size; ++pit) {
775 pos_type pos = pars_[pit].size();
777 if (pars_[pit].isDeleted(pos)) {
778 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
779 } else if (pars_[pit].isInserted(pos)) {
780 if (pit == pars_size - 1) {
781 // we mark the par break at the end of the last
782 // paragraph unchanged
783 pars_[pit].setChange(pos, Change(Change::UNCHANGED));
785 mergeParagraph(bparams, pars_, pit);
792 // finally, invoke the DEPM
793 deleteEmptyParagraphMechanism(0, pars_size - 1, bparams.trackChanges);
797 void Text::deleteWordForward(Cursor & cur)
799 BOOST_ASSERT(this == cur.text());
800 if (cur.lastpos() == 0)
804 cur.selection() = true;
805 cursorRightOneWord(cur);
807 cutSelection(cur, true, false);
808 checkBufferStructure(cur.buffer(), cur);
813 void Text::deleteWordBackward(Cursor & cur)
815 BOOST_ASSERT(this == cur.text());
816 if (cur.lastpos() == 0)
820 cur.selection() = true;
821 cursorLeftOneWord(cur);
823 cutSelection(cur, true, false);
824 checkBufferStructure(cur.buffer(), cur);
829 // Kill to end of line.
830 void Text::changeCase(Cursor & cur, Text::TextCase action)
832 BOOST_ASSERT(this == cur.text());
836 if (cur.selection()) {
837 from = cur.selBegin();
841 getWord(from, to, PARTIAL_WORD);
842 cursorRightOneWord(cur);
845 cur.recordUndoSelection();
847 pit_type begPit = from.pit();
848 pit_type endPit = to.pit();
850 pos_type begPos = from.pos();
851 pos_type endPos = to.pos();
853 bool const trackChanges = cur.buffer().params().trackChanges;
855 pos_type right = 0; // needed after the for loop
857 for (pit_type pit = begPit; pit <= endPit; ++pit) {
858 pos_type parSize = pars_[pit].size();
860 pos_type pos = (pit == begPit ? begPos : 0);
861 right = (pit == endPit ? endPos : parSize);
863 // process sequences of modified characters; in change
864 // tracking mode, this approach results in much better
865 // usability than changing case on a char-by-char basis
868 bool capitalize = true;
870 for (; pos < right; ++pos) {
871 char_type oldChar = pars_[pit].getChar(pos);
872 char_type newChar = oldChar;
874 // ignore insets and don't play with deleted text!
875 if (pars_[pit].isInset(pos) && !pars_[pit].isDeleted(pos)) {
878 newChar = lowercase(oldChar);
880 case text_capitalization:
882 newChar = uppercase(oldChar);
887 newChar = uppercase(oldChar);
892 if (!pars_[pit].isLetter(pos) || pars_[pit].isDeleted(pos)) {
893 capitalize = true; // permit capitalization again
896 if (oldChar != newChar) {
900 if (oldChar == newChar || pos == right - 1) {
901 if (oldChar != newChar) {
902 pos++; // step behind the changing area
904 int erasePos = pos - changes.size();
905 for (size_t i = 0; i < changes.size(); i++) {
906 pars_[pit].insertChar(pos, changes[i],
907 pars_[pit].getFontSettings(cur.buffer().params(),
910 if (!pars_[pit].eraseChar(erasePos, trackChanges)) {
913 ++right; // expand selection
921 // the selection may have changed due to logically-only deleted chars
922 setCursor(cur, begPit, begPos);
924 setCursor(cur, endPit, right);
927 checkBufferStructure(cur.buffer(), cur);
931 bool Text::handleBibitems(Cursor & cur)
933 if (cur.paragraph().layout()->labeltype != LABEL_BIBLIO)
935 // if a bibitem is deleted, merge with previous paragraph
936 // if this is a bibliography item as well
937 if (cur.pos() == 0) {
938 BufferParams const & bufparams = cur.buffer().params();
939 Paragraph const & par = cur.paragraph();
940 Cursor prevcur = cur;
943 prevcur.pos() = prevcur.lastpos();
945 Paragraph const & prevpar = prevcur.paragraph();
946 if (cur.pit() > 0 && par.layout() == prevpar.layout()) {
947 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
948 mergeParagraph(bufparams, cur.text()->paragraphs(),
950 updateLabels(cur.buffer());
951 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
952 cur.updateFlags(Update::Force);
953 // if not, reset the paragraph to default
955 cur.paragraph().layout(
956 bufparams.getTextClass().defaultLayout());
963 bool Text::erase(Cursor & cur)
965 BOOST_ASSERT(this == cur.text());
966 bool needsUpdate = false;
967 Paragraph & par = cur.paragraph();
969 if (cur.pos() != cur.lastpos()) {
970 // this is the code for a normal delete, not pasting
972 cur.recordUndo(DELETE_UNDO);
973 if(!par.eraseChar(cur.pos(), cur.buffer().params().trackChanges)) {
974 // the character has been logically deleted only => skip it
975 cur.top().forwardPos();
977 checkBufferStructure(cur.buffer(), cur);
980 if (cur.pit() == cur.lastpit())
981 return dissolveInset(cur);
983 if (!par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
984 par.setChange(cur.pos(), Change(Change::DELETED));
988 setCursorIntern(cur, cur.pit() + 1, 0);
989 needsUpdate = backspacePos0(cur);
993 needsUpdate |= handleBibitems(cur);
996 // Make sure the cursor is correct. Is this really needed?
997 // No, not really... at least not here!
998 cur.text()->setCursor(cur.top(), cur.pit(), cur.pos());
999 checkBufferStructure(cur.buffer(), cur);
1006 bool Text::backspacePos0(Cursor & cur)
1008 BOOST_ASSERT(this == cur.text());
1012 bool needsUpdate = false;
1014 BufferParams const & bufparams = cur.buffer().params();
1015 TextClass const & tclass = bufparams.getTextClass();
1016 ParagraphList & plist = cur.text()->paragraphs();
1017 Paragraph const & par = cur.paragraph();
1018 Cursor prevcur = cur;
1020 prevcur.pos() = prevcur.lastpos();
1021 Paragraph const & prevpar = prevcur.paragraph();
1023 // is it an empty paragraph?
1024 if (cur.lastpos() == 0
1025 || (cur.lastpos() == 1 && par.isSeparator(0))) {
1026 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1027 plist.erase(boost::next(plist.begin(), cur.pit()));
1030 // is previous par empty?
1031 else if (prevcur.lastpos() == 0
1032 || (prevcur.lastpos() == 1 && prevpar.isSeparator(0))) {
1033 cur.recordUndo(ATOMIC_UNDO, prevcur.pit(), cur.pit());
1034 plist.erase(boost::next(plist.begin(), prevcur.pit()));
1037 // Pasting is not allowed, if the paragraphs have different
1038 // layouts. I think it is a real bug of all other
1039 // word processors to allow it. It confuses the user.
1040 // Correction: Pasting is always allowed with standard-layout
1041 else if (par.layout() == prevpar.layout()
1042 || par.layout() == tclass.defaultLayout()) {
1043 cur.recordUndo(ATOMIC_UNDO, prevcur.pit());
1044 mergeParagraph(bufparams, plist, prevcur.pit());
1049 updateLabels(cur.buffer());
1050 setCursorIntern(cur, prevcur.pit(), prevcur.pos());
1057 bool Text::backspace(Cursor & cur)
1059 BOOST_ASSERT(this == cur.text());
1060 bool needsUpdate = false;
1061 if (cur.pos() == 0) {
1063 return dissolveInset(cur);
1065 Paragraph & prev_par = pars_[cur.pit() - 1];
1067 if (!prev_par.isMergedOnEndOfParDeletion(cur.buffer().params().trackChanges)) {
1068 prev_par.setChange(prev_par.size(), Change(Change::DELETED));
1069 setCursorIntern(cur, cur.pit() - 1, prev_par.size());
1072 // The cursor is at the beginning of a paragraph, so
1073 // the backspace will collapse two paragraphs into one.
1074 needsUpdate = backspacePos0(cur);
1077 // this is the code for a normal backspace, not pasting
1079 cur.recordUndo(DELETE_UNDO);
1080 // We used to do cursorBackwardIntern() here, but it is
1081 // not a good idea since it triggers the auto-delete
1082 // mechanism. So we do a cursorBackwardIntern()-lite,
1083 // without the dreaded mechanism. (JMarc)
1084 setCursorIntern(cur, cur.pit(), cur.pos() - 1,
1085 false, cur.boundary());
1086 cur.paragraph().eraseChar(cur.pos(), cur.buffer().params().trackChanges);
1087 checkBufferStructure(cur.buffer(), cur);
1090 if (cur.pos() == cur.lastpos())
1091 cur.setCurrentFont();
1093 needsUpdate |= handleBibitems(cur);
1095 // A singlePar update is not enough in this case.
1096 // cur.updateFlags(Update::Force);
1097 setCursor(cur.top(), cur.pit(), cur.pos());
1103 bool Text::dissolveInset(Cursor & cur) {
1104 BOOST_ASSERT(this == cur.text());
1106 if (isMainText(cur.bv().buffer()) || cur.inset().nargs() != 1)
1109 cur.recordUndoInset();
1110 cur.selHandle(false);
1112 pos_type spos = cur.pos();
1113 pit_type spit = cur.pit();
1114 ParagraphList plist;
1115 if (cur.lastpit() != 0 || cur.lastpos() != 0)
1116 plist = paragraphs();
1118 // store cursor offset
1122 Buffer & b = cur.buffer();
1123 cur.paragraph().eraseChar(cur.pos(), b.params().trackChanges);
1124 if (!plist.empty()) {
1125 // ERT paragraphs have the Language latex_language.
1126 // This is invalid outside of ERT, so we need to
1127 // change it to the buffer language.
1128 ParagraphList::iterator it = plist.begin();
1129 ParagraphList::iterator it_end = plist.end();
1130 for (; it != it_end; it++)
1131 it->changeLanguage(b.params(), latex_language, b.language());
1133 pasteParagraphList(cur, plist, b.params().getTextClassPtr(),
1134 b.errorList("Paste"));
1136 cur.pit() = std::min(cur.lastpit(), spit);
1137 cur.pos() = std::min(cur.lastpos(), spos);
1139 cur.clearSelection();
1145 void Text::getWord(CursorSlice & from, CursorSlice & to,
1146 word_location const loc)
1148 Paragraph const & from_par = pars_[from.pit()];
1150 case WHOLE_WORD_STRICT:
1151 if (from.pos() == 0 || from.pos() == from_par.size()
1152 || !from_par.isLetter(from.pos())
1153 || !from_par.isLetter(from.pos() - 1)) {
1157 // no break here, we go to the next
1160 // If we are already at the beginning of a word, do nothing
1161 if (!from.pos() || !from_par.isLetter(from.pos() - 1))
1163 // no break here, we go to the next
1166 // always move the cursor to the beginning of previous word
1167 while (from.pos() && from_par.isLetter(from.pos() - 1))
1171 lyxerr << "Text::getWord: NEXT_WORD not implemented yet"
1175 // no need to move the 'from' cursor
1179 Paragraph & to_par = pars_[to.pit()];
1180 while (to.pos() < to_par.size() && to_par.isLetter(to.pos()))
1185 void Text::write(Buffer const & buf, std::ostream & os) const
1187 ParagraphList::const_iterator pit = paragraphs().begin();
1188 ParagraphList::const_iterator end = paragraphs().end();
1190 for (; pit != end; ++pit)
1191 pit->write(buf, os, buf.params(), dth);
1193 // Close begin_deeper
1194 for(; dth > 0; --dth)
1195 os << "\n\\end_deeper";
1199 bool Text::read(Buffer const & buf, Lexer & lex, ErrorList & errorList)
1201 depth_type depth = 0;
1203 while (lex.isOK()) {
1205 string const token = lex.getString();
1210 if (token == "\\end_inset")
1213 if (token == "\\end_body")
1216 if (token == "\\begin_body")
1219 if (token == "\\end_document")
1222 if (token == "\\begin_layout") {
1223 lex.pushToken(token);
1226 par.params().depth(depth);
1227 par.setFont(0, Font(Font::ALL_INHERIT, buf.params().language));
1228 pars_.push_back(par);
1230 // FIXME: goddamn InsetTabular makes us pass a Buffer
1232 lyx::readParagraph(buf, pars_.back(), lex, errorList);
1234 } else if (token == "\\begin_deeper") {
1236 } else if (token == "\\end_deeper") {
1238 lex.printError("\\end_deeper: " "depth is already null");
1243 lyxerr << "Handling unknown body token: `"
1244 << token << '\'' << endl;
1250 // Returns the current font and depth as a message.
1251 docstring Text::currentState(Cursor & cur)
1253 BOOST_ASSERT(this == cur.text());
1254 Buffer & buf = cur.buffer();
1255 Paragraph const & par = cur.paragraph();
1256 odocstringstream os;
1258 if (buf.params().trackChanges)
1259 os << _("[Change Tracking] ");
1261 Change change = par.lookupChange(cur.pos());
1263 if (change.type != Change::UNCHANGED) {
1264 Author const & a = buf.params().authors().get(change.author);
1265 os << _("Change: ") << a.name();
1266 if (!a.email().empty())
1267 os << " (" << a.email() << ")";
1268 // FIXME ctime is english, we should translate that
1269 os << _(" at ") << ctime(&change.changetime);
1273 // I think we should only show changes from the default
1275 // No, from the document font (MV)
1276 Font font = cur.real_current_font;
1277 font.reduce(buf.params().getFont());
1279 os << bformat(_("Font: %1$s"), font.stateText(&buf.params()));
1281 // The paragraph depth
1282 int depth = cur.paragraph().getDepth();
1284 os << bformat(_(", Depth: %1$d"), depth);
1286 // The paragraph spacing, but only if different from
1288 Spacing const & spacing = par.params().spacing();
1289 if (!spacing.isDefault()) {
1290 os << _(", Spacing: ");
1291 switch (spacing.getSpace()) {
1292 case Spacing::Single:
1295 case Spacing::Onehalf:
1298 case Spacing::Double:
1301 case Spacing::Other:
1302 os << _("Other (") << from_ascii(spacing.getValueAsString()) << ')';
1304 case Spacing::Default:
1305 // should never happen, do nothing
1310 #ifdef DEVEL_VERSION
1311 os << _(", Inset: ") << &cur.inset();
1312 os << _(", Paragraph: ") << cur.pit();
1313 os << _(", Id: ") << par.id();
1314 os << _(", Position: ") << cur.pos();
1315 // FIXME: Why is the check for par.size() needed?
1316 // We are called with cur.pos() == par.size() quite often.
1317 if (!par.empty() && cur.pos() < par.size()) {
1318 // Force output of code point, not character
1319 size_t const c = par.getChar(cur.pos());
1320 os << _(", Char: 0x") << std::hex << c;
1322 os << _(", Boundary: ") << cur.boundary();
1323 // Row & row = cur.textRow();
1324 // os << bformat(_(", Row b:%1$d e:%2$d"), row.pos(), row.endpos());
1330 docstring Text::getPossibleLabel(Cursor & cur) const
1332 pit_type pit = cur.pit();
1334 LayoutPtr layout = pars_[pit].layout();
1337 docstring par_text = pars_[pit].asString(cur.buffer(), false);
1338 for (int i = 0; i < lyxrc.label_init_length; ++i) {
1339 if (par_text.empty())
1342 par_text = split(par_text, head, ' ');
1343 // Is it legal to use spaces in labels ?
1349 // No need for a prefix if the user said so.
1350 if (lyxrc.label_init_length <= 0)
1353 // Will contain the label type.
1356 // For section, subsection, etc...
1357 if (layout->latextype == LATEX_PARAGRAPH && pit != 0) {
1358 LayoutPtr const & layout2 = pars_[pit - 1].layout();
1359 if (layout2->latextype != LATEX_PARAGRAPH) {
1364 if (layout->latextype != LATEX_PARAGRAPH)
1365 name = from_ascii(layout->latexname());
1367 // for captions, we just take the caption type
1368 Inset * caption_inset = cur.innerInsetOfType(CAPTION_CODE);
1370 name = from_ascii(static_cast<InsetCaption *>(caption_inset)->type());
1372 // If none of the above worked, we'll see if we're inside various
1373 // types of insets and take our abbreviation from them.
1375 InsetCode const codes[] = {
1380 for (unsigned int i = 0; i < (sizeof codes / sizeof codes[0]); ++i) {
1381 Inset * float_inset = cur.innerInsetOfType(codes[i]);
1383 name = float_inset->name();
1389 // Create a correct prefix for prettyref
1390 if (name == "theorem")
1391 name = from_ascii("thm");
1392 else if (name == "Foot")
1393 name = from_ascii("fn");
1394 else if (name == "listing")
1395 name = from_ascii("lst");
1398 text = name.substr(0, 3) + ':' + text;
1404 void Text::charsTranspose(Cursor & cur)
1406 BOOST_ASSERT(this == cur.text());
1408 pos_type pos = cur.pos();
1410 // If cursor is at beginning or end of paragraph, do nothing.
1411 if (pos == cur.lastpos() || pos == 0)
1414 Paragraph & par = cur.paragraph();
1416 // Get the positions of the characters to be transposed.
1417 pos_type pos1 = pos - 1;
1418 pos_type pos2 = pos;
1420 // In change tracking mode, ignore deleted characters.
1421 while (pos2 < cur.lastpos() && par.isDeleted(pos2))
1423 if (pos2 == cur.lastpos())
1426 while (pos1 >= 0 && par.isDeleted(pos1))
1431 // Don't do anything if one of the "characters" is not regular text.
1432 if (par.isInset(pos1) || par.isInset(pos2))
1435 // Store the characters to be transposed (including font information).
1436 char_type char1 = par.getChar(pos1);
1438 par.getFontSettings(cur.buffer().params(), pos1);
1440 char_type char2 = par.getChar(pos2);
1442 par.getFontSettings(cur.buffer().params(), pos2);
1444 // And finally, we are ready to perform the transposition.
1445 // Track the changes if Change Tracking is enabled.
1446 bool const trackChanges = cur.buffer().params().trackChanges;
1450 par.eraseChar(pos2, trackChanges);
1451 par.eraseChar(pos1, trackChanges);
1452 par.insertChar(pos1, char2, font2, trackChanges);
1453 par.insertChar(pos2, char1, font1, trackChanges);
1455 checkBufferStructure(cur.buffer(), cur);
1457 // After the transposition, move cursor to after the transposition.
1458 setCursor(cur, cur.pit(), pos2);