2 * \file paragraph_pimpl.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
11 * Full author contact details are available in file CREDITS.
16 #include "paragraph_pimpl.h"
18 #include "bufferparams.h"
22 #include "LaTeXFeatures.h"
24 #include "lyxlength.h"
26 #include "outputparams.h"
33 using std::upper_bound;
34 using std::lower_bound;
39 // Initialize static member.
40 ShareContainer<LyXFont> Paragraph::Pimpl::FontTable::container;
41 // Initialization of the counter for the paragraph id's,
42 unsigned int Paragraph::Pimpl::paragraph_id = 0;
46 struct special_phrase {
52 special_phrase special_phrases[] = {
53 { "LyX", "\\LyX{}", false },
54 { "TeX", "\\TeX{}", true },
55 { "LaTeX2e", "\\LaTeXe{}", true },
56 { "LaTeX", "\\LaTeX{}", true },
59 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
64 Paragraph::Pimpl::Pimpl(Paragraph * owner)
72 Paragraph::Pimpl::Pimpl(Pimpl const & p, Paragraph * owner)
73 : params(p.params), owner_(owner)
75 inset_owner = p.inset_owner;
76 fontlist = p.fontlist;
80 changes_.reset(new Changes(*p.changes_.get()));
84 void Paragraph::Pimpl::setContentsFromPar(Paragraph const & par)
86 owner_->text_ = par.text_;
87 if (par.pimpl_->tracking()) {
88 changes_.reset(new Changes(*(par.pimpl_->changes_.get())));
93 void Paragraph::Pimpl::trackChanges(Change::Type type)
96 lyxerr[Debug::CHANGES] << "already tracking for par " << id_ << endl;
100 lyxerr[Debug::CHANGES] << "track changes for par "
101 << id_ << " type " << type << endl;
102 changes_.reset(new Changes(type));
103 changes_->set(type, 0, size());
107 void Paragraph::Pimpl::untrackChanges()
113 void Paragraph::Pimpl::cleanChanges()
115 // if we're not tracking, we don't want to reset...
119 changes_.reset(new Changes(Change::INSERTED));
120 changes_->set(Change::INSERTED, 0, size());
124 bool Paragraph::Pimpl::isChanged(pos_type start, pos_type end) const
129 return changes_->isChange(start, end);
133 bool Paragraph::Pimpl::isChangeEdited(pos_type start, pos_type end) const
138 return changes_->isChangeEdited(start, end);
142 void Paragraph::Pimpl::setChange(pos_type pos, Change::Type type)
147 changes_->set(type, pos);
151 Change::Type Paragraph::Pimpl::lookupChange(pos_type pos) const
154 return Change::UNCHANGED;
156 return changes_->lookup(pos);
160 Change const Paragraph::Pimpl::lookupChangeFull(pos_type pos) const
163 return Change(Change::UNCHANGED);
165 return changes_->lookupFull(pos);
169 void Paragraph::Pimpl::markErased()
171 BOOST_ASSERT(tracking());
173 // FIXME: we should actually remove INSERTED chars.
174 // difficult because owning insettexts/tabulars need
175 // to update themselves when rows etc. change
176 changes_->set(Change::DELETED, 0, size());
177 changes_->reset(Change::DELETED);
181 void Paragraph::Pimpl::acceptChange(pos_type start, pos_type end)
187 changes_.reset(new Changes(Change::UNCHANGED));
191 lyxerr << "acceptchange" << endl;
194 for (; i < end; ++i) {
195 switch (lookupChange(i)) {
196 case Change::UNCHANGED:
199 case Change::INSERTED:
200 changes_->set(Change::UNCHANGED, i);
203 case Change::DELETED:
212 lyxerr << "endacceptchange" << endl;
213 changes_->reset(Change::UNCHANGED);
217 void Paragraph::Pimpl::rejectChange(pos_type start, pos_type end)
223 changes_.reset(new Changes(Change::UNCHANGED));
229 for (; i < end; ++i) {
230 switch (lookupChange(i)) {
231 case Change::UNCHANGED:
234 case Change::INSERTED:
241 case Change::DELETED:
242 changes_->set(Change::UNCHANGED, i);
246 changes_->reset(Change::UNCHANGED);
250 Paragraph::value_type Paragraph::Pimpl::getChar(pos_type pos) const
252 return owner_->getChar(pos);
256 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c, Change change)
258 BOOST_ASSERT(pos <= size());
261 changes_->record(change, pos);
264 // This is actually very common when parsing buffers (and
265 // maybe inserting ascii text)
267 // when appending characters, no need to update tables
268 owner_->text_.push_back(c);
272 owner_->text_.insert(owner_->text_.begin() + pos, c);
274 // Update the font table.
275 FontTable search_font(pos, LyXFont());
276 for (FontList::iterator it = lower_bound(fontlist.begin(),
278 search_font, matchFT());
279 it != fontlist.end(); ++it)
281 it->pos(it->pos() + 1);
285 owner_->insetlist.increasePosAfterPos(pos);
289 void Paragraph::Pimpl::insertInset(pos_type pos,
290 InsetBase * inset, Change change)
293 BOOST_ASSERT(pos <= size());
295 insertChar(pos, META_INSET, change);
296 BOOST_ASSERT(owner_->text_[pos] == META_INSET);
298 // Add a new entry in the insetlist.
299 owner_->insetlist.insert(inset, pos);
303 void Paragraph::Pimpl::eraseIntern(pos_type pos)
305 // if it is an inset, delete the inset entry
306 if (owner_->text_[pos] == Paragraph::META_INSET) {
307 owner_->insetlist.erase(pos);
310 owner_->text_.erase(owner_->text_.begin() + pos);
312 // Erase entries in the tables.
313 FontTable search_font(pos, LyXFont());
315 FontList::iterator it =
316 lower_bound(fontlist.begin(),
318 search_font, matchFT());
319 if (it != fontlist.end() && it->pos() == pos &&
321 (it != fontlist.begin()
322 && boost::prior(it)->pos() == pos - 1))) {
323 // If it is a multi-character font
324 // entry, we just make it smaller
325 // (see update below), otherwise we
327 unsigned int const i = it - fontlist.begin();
328 fontlist.erase(fontlist.begin() + i);
329 it = fontlist.begin() + i;
330 if (i > 0 && i < fontlist.size() &&
331 fontlist[i - 1].font() == fontlist[i].font()) {
332 fontlist.erase(fontlist.begin() + i - 1);
333 it = fontlist.begin() + i - 1;
337 // Update all other entries.
338 FontList::iterator fend = fontlist.end();
339 for (; it != fend; ++it)
340 it->pos(it->pos() - 1);
342 // Update the insetlist.
343 owner_->insetlist.decreasePosAfterPos(pos);
347 bool Paragraph::Pimpl::erase(pos_type pos)
349 BOOST_ASSERT(pos < size());
352 Change::Type changetype(changes_->lookup(pos));
353 changes_->record(Change(Change::DELETED), pos);
355 // only allow the actual removal if it was /new/ text
356 if (changetype != Change::INSERTED) {
357 if (owner_->text_[pos] == Paragraph::META_INSET) {
358 owner_->getInset(pos)->markErased();
369 int Paragraph::Pimpl::erase(pos_type start, pos_type end)
372 for (pos_type count = end - start; count; --count) {
380 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
382 unsigned int & column,
383 LyXFont const & font,
384 LyXLayout const & style)
389 if (column > lyxrc.ascii_linelen
391 && getChar(i - 1) != ' '
393 // same in FreeSpacing mode
394 && !owner_->isFreeSpacing()
395 // In typewriter mode, we want to avoid
396 // ! . ? : at the end of a line
397 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
398 && (getChar(i - 1) == '.'
399 || getChar(i - 1) == '?'
400 || getChar(i - 1) == ':'
401 || getChar(i - 1) == '!'))) {
404 texrow.start(owner_->id(), i + 1);
406 } else if (style.free_spacing) {
414 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
416 pos_type const len = str.length();
418 // is the paragraph large enough?
419 if (pos + len > size())
422 // does the wanted text start at point?
423 for (string::size_type i = 0; i < str.length(); ++i) {
424 if (str[i] != owner_->text_[pos + i])
428 // is there a font change in middle of the word?
429 FontList::const_iterator cit = fontlist.begin();
430 FontList::const_iterator end = fontlist.end();
431 for (; cit != end; ++cit) {
432 if (cit->pos() >= pos)
435 if (cit != end && pos + len - 1 > cit->pos())
442 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const & buf,
443 BufferParams const & bparams,
446 OutputParams const & runparams,
448 LyXFont & running_font,
450 LyXFont const & outerfont,
452 Change::Type & running_change,
453 LyXLayout const & style,
455 unsigned int & column,
458 if (style.pass_thru) {
459 if (c != Paragraph::META_INSET) {
463 owner_->getInset(i)->plaintext(buf, os, runparams);
468 // Two major modes: LaTeX or plain
469 // Handle here those cases common to both modes
470 // and then split to handle the two modes separately.
472 case Paragraph::META_INSET: {
473 InsetBase * inset = owner_->getInset(i);
475 // FIXME: remove this check
479 // FIXME: move this to InsetNewline::latex
480 if (inset->lyxCode() == InsetBase::NEWLINE_CODE) {
481 // newlines are handled differently here than
482 // the default in simpleTeXSpecialChars().
483 if (!style.newline_allowed) {
487 column += running_font.latexWriteEndChanges(os, basefont, basefont);
490 basefont = owner_->getLayoutFont(bparams, outerfont);
491 running_font = basefont;
493 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
496 if (runparams.moving_arg)
502 texrow.start(owner_->id(), i + 1);
507 if (inset->isTextInset()) {
508 column += Changes::latexMarkChange(os, running_change,
510 running_change = Change::UNCHANGED;
514 ostream::pos_type const len = os.tellp();
516 if ((inset->lyxCode() == InsetBase::GRAPHICS_CODE
517 || inset->lyxCode() == InsetBase::MATH_CODE
518 || inset->lyxCode() == InsetBase::URL_CODE)
519 && running_font.isRightToLeft()) {
525 #warning Bug: we can have an empty font change here!
526 // if there has just been a font change, we are going to close it
527 // right now, which means stupid latex code like \textsf{}. AFAIK,
528 // this does not harm dvi output. A minor bug, thus (JMarc)
530 // some insets cannot be inside a font change command
531 if (open_font && inset->noFontChange()) {
532 column +=running_font.
533 latexWriteEndChanges(os,
537 basefont = owner_->getLayoutFont(bparams, outerfont);
538 running_font = basefont;
541 int tmp = inset->latex(buf, os, runparams);
547 for (int j = 0; j < tmp; ++j) {
550 texrow.start(owner_->id(), i + 1);
553 column += os.tellp() - len;
559 // And now for the special cases within each mode
563 os << "\\textbackslash{}";
567 case '±': case '²': case '³':
568 case '×': case '÷': case '¹':
570 if ((bparams.inputenc == "latin1" ||
571 bparams.inputenc == "latin9") ||
572 (bparams.inputenc == "auto" &&
573 (font.language()->encoding()->LatexName()
575 font.language()->encoding()->LatexName()
577 os << "\\ensuremath{"
586 case '|': case '<': case '>':
587 // In T1 encoding, these characters exist
588 if (lyxrc.fontenc == "T1") {
590 //... but we should avoid ligatures
591 if ((c == '>' || c == '<')
593 && getChar(i + 1) == c) {
594 //os << "\\textcompwordmark{}";
595 // Jean-Marc, have a look at
596 // this. I think this works
604 // Typewriter font also has them
605 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
609 // Otherwise, we use what LaTeX
613 os << "\\textless{}";
617 os << "\\textgreater{}";
627 case '-': // "--" in Typewriter mode -> "-{}-"
629 && getChar(i + 1) == '-'
630 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
639 os << "\\char`\\\"{}";
644 if (bparams.inputenc == "default") {
653 case '%': case '#': case '{':
660 os << "\\textasciitilde{}";
665 os << "\\textasciicircum{}";
670 // avoid being mistaken for optional arguments
671 os << '{' << c << '}';
676 // Blanks are printed before font switching.
677 // Sure? I am not! (try nice-latex)
678 // I am sure it's correct. LyX might be smarter
679 // in the future, but for now, nothing wrong is
685 // I assume this is hack treating typewriter as verbatim
686 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
695 // FIXME: if we have "LaTeX" with a font
696 // change in the middle (before the 'T', then
697 // the "TeX" part is still special cased.
698 // Really we should only operate this on
699 // "words" for some definition of word
703 for (; pnr < phrases_nr; ++pnr) {
704 if (isTextAt(special_phrases[pnr].phrase, i)) {
705 os << special_phrases[pnr].macro;
706 i += special_phrases[pnr].phrase.length() - 1;
707 column += special_phrases[pnr].macro.length() - 1;
712 if (pnr == phrases_nr && c != '\0') {
721 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
722 LyXLayout const & layout) const
724 BufferParams const & bparams = features.bufferParams();
727 if (!params.spacing().isDefault())
728 features.require("setspace");
731 features.useLayout(layout.name());
734 Language const * doc_language = bparams.language;
736 FontList::const_iterator fcit = fontlist.begin();
737 FontList::const_iterator fend = fontlist.end();
738 for (; fcit != fend; ++fcit) {
739 if (fcit->font().noun() == LyXFont::ON) {
740 lyxerr[Debug::LATEX] << "font.noun: "
741 << fcit->font().noun()
743 features.require("noun");
744 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
745 << fcit->font().stateText(0)
748 switch (fcit->font().color()) {
750 case LColor::inherit:
752 // probably we should put here all interface colors used for
753 // font displaying! For now I just add this ones I know of (Jug)
758 features.require("color");
759 lyxerr[Debug::LATEX] << "Color enabled. Font: "
760 << fcit->font().stateText(0)
764 Language const * language = fcit->font().language();
765 if (language->babel() != doc_language->babel() &&
766 language != ignore_language &&
767 language != latex_language)
769 features.useLanguage(language);
770 lyxerr[Debug::LATEX] << "Found language "
771 << language->babel() << endl;
775 if (!params.leftIndent().zero())
776 features.require("ParagraphLeftIndent");
779 InsetList::const_iterator icit = owner_->insetlist.begin();
780 InsetList::const_iterator iend = owner_->insetlist.end();
781 for (; icit != iend; ++icit) {
783 icit->inset->validate(features);
784 if (layout.needprotect &&
785 icit->inset->lyxCode() == InsetBase::FOOT_CODE)
786 features.require("NeedLyXFootnoteCode");
791 for (pos_type i = 0; i < size() ; ++i) {
792 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
793 if (!special_phrases[pnr].builtin
794 && isTextAt(special_phrases[pnr].phrase, i)) {
795 features.require(special_phrases[pnr].phrase);