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,
257 LyXFont const & font, Change change)
259 BOOST_ASSERT(pos <= size());
262 changes_->record(change, pos);
265 // This is actually very common when parsing buffers (and
266 // maybe inserting ascii text)
268 // when appending characters, no need to update tables
269 owner_->text_.push_back(c);
270 owner_->setFont(pos, font);
274 owner_->text_.insert(owner_->text_.begin() + pos, c);
276 // Update the font table.
277 FontTable search_font(pos, LyXFont());
278 for (FontList::iterator it = lower_bound(fontlist.begin(),
280 search_font, matchFT());
281 it != fontlist.end(); ++it)
283 it->pos(it->pos() + 1);
287 owner_->insetlist.increasePosAfterPos(pos);
289 owner_->setFont(pos, font);
293 void Paragraph::Pimpl::insertInset(pos_type pos,
294 InsetBase * inset, LyXFont const & font, Change change)
297 BOOST_ASSERT(pos <= size());
299 insertChar(pos, META_INSET, font, change);
300 BOOST_ASSERT(owner_->text_[pos] == META_INSET);
302 // Add a new entry in the insetlist.
303 owner_->insetlist.insert(inset, pos);
307 void Paragraph::Pimpl::eraseIntern(pos_type pos)
309 // if it is an inset, delete the inset entry
310 if (owner_->text_[pos] == Paragraph::META_INSET) {
311 owner_->insetlist.erase(pos);
314 owner_->text_.erase(owner_->text_.begin() + pos);
316 // Erase entries in the tables.
317 FontTable search_font(pos, LyXFont());
319 FontList::iterator it =
320 lower_bound(fontlist.begin(),
322 search_font, matchFT());
323 if (it != fontlist.end() && it->pos() == pos &&
325 (it != fontlist.begin()
326 && boost::prior(it)->pos() == pos - 1))) {
327 // If it is a multi-character font
328 // entry, we just make it smaller
329 // (see update below), otherwise we
331 unsigned int const i = it - fontlist.begin();
332 fontlist.erase(fontlist.begin() + i);
333 it = fontlist.begin() + i;
334 if (i > 0 && i < fontlist.size() &&
335 fontlist[i - 1].font() == fontlist[i].font()) {
336 fontlist.erase(fontlist.begin() + i - 1);
337 it = fontlist.begin() + i - 1;
341 // Update all other entries.
342 FontList::iterator fend = fontlist.end();
343 for (; it != fend; ++it)
344 it->pos(it->pos() - 1);
346 // Update the insetlist.
347 owner_->insetlist.decreasePosAfterPos(pos);
351 bool Paragraph::Pimpl::erase(pos_type pos)
353 BOOST_ASSERT(pos < size());
356 Change::Type changetype(changes_->lookup(pos));
357 changes_->record(Change(Change::DELETED), pos);
359 // only allow the actual removal if it was /new/ text
360 if (changetype != Change::INSERTED) {
361 if (owner_->text_[pos] == Paragraph::META_INSET) {
362 owner_->getInset(pos)->markErased();
373 int Paragraph::Pimpl::erase(pos_type start, pos_type end)
376 for (pos_type count = end - start; count; --count) {
384 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
386 unsigned int & column,
387 LyXFont const & font,
388 LyXLayout const & style)
393 if (column > lyxrc.ascii_linelen
395 && getChar(i - 1) != ' '
397 // same in FreeSpacing mode
398 && !owner_->isFreeSpacing()
399 // In typewriter mode, we want to avoid
400 // ! . ? : at the end of a line
401 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
402 && (getChar(i - 1) == '.'
403 || getChar(i - 1) == '?'
404 || getChar(i - 1) == ':'
405 || getChar(i - 1) == '!'))) {
408 texrow.start(owner_->id(), i + 1);
410 } else if (style.free_spacing) {
418 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
420 pos_type const len = str.length();
422 // is the paragraph large enough?
423 if (pos + len > size())
426 // does the wanted text start at point?
427 for (string::size_type i = 0; i < str.length(); ++i) {
428 if (str[i] != owner_->text_[pos + i])
432 // is there a font change in middle of the word?
433 FontList::const_iterator cit = fontlist.begin();
434 FontList::const_iterator end = fontlist.end();
435 for (; cit != end; ++cit) {
436 if (cit->pos() >= pos)
439 if (cit != end && pos + len - 1 > cit->pos())
446 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const & buf,
447 BufferParams const & bparams,
450 OutputParams const & runparams,
452 LyXFont & running_font,
454 LyXFont const & outerfont,
456 Change::Type & running_change,
457 LyXLayout const & style,
459 unsigned int & column,
462 if (style.pass_thru) {
463 if (c != Paragraph::META_INSET) {
467 owner_->getInset(i)->plaintext(buf, os, runparams);
472 // Two major modes: LaTeX or plain
473 // Handle here those cases common to both modes
474 // and then split to handle the two modes separately.
476 case Paragraph::META_INSET: {
477 InsetBase * inset = owner_->getInset(i);
479 // FIXME: remove this check
483 // FIXME: move this to InsetNewline::latex
484 if (inset->lyxCode() == InsetBase::NEWLINE_CODE) {
485 // newlines are handled differently here than
486 // the default in simpleTeXSpecialChars().
487 if (!style.newline_allowed) {
491 column += running_font.latexWriteEndChanges(os, basefont, basefont);
494 basefont = owner_->getLayoutFont(bparams, outerfont);
495 running_font = basefont;
497 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
500 if (runparams.moving_arg)
506 texrow.start(owner_->id(), i + 1);
511 if (inset->isTextInset()) {
512 column += Changes::latexMarkChange(os, running_change,
514 running_change = Change::UNCHANGED;
518 ostream::pos_type const len = os.tellp();
520 if ((inset->lyxCode() == InsetBase::GRAPHICS_CODE
521 || inset->lyxCode() == InsetBase::MATH_CODE
522 || inset->lyxCode() == InsetBase::URL_CODE)
523 && running_font.isRightToLeft()) {
529 #warning Bug: we can have an empty font change here!
530 // if there has just been a font change, we are going to close it
531 // right now, which means stupid latex code like \textsf{}. AFAIK,
532 // this does not harm dvi output. A minor bug, thus (JMarc)
534 // some insets cannot be inside a font change command
535 if (open_font && inset->noFontChange()) {
536 column +=running_font.
537 latexWriteEndChanges(os,
541 basefont = owner_->getLayoutFont(bparams, outerfont);
542 running_font = basefont;
545 int tmp = inset->latex(buf, os, runparams);
551 for (int j = 0; j < tmp; ++j) {
554 texrow.start(owner_->id(), i + 1);
557 column += os.tellp() - len;
563 // And now for the special cases within each mode
567 os << "\\textbackslash{}";
571 case '±': case '²': case '³':
572 case '×': case '÷': case '¹':
574 if ((bparams.inputenc == "latin1" ||
575 bparams.inputenc == "latin9") ||
576 (bparams.inputenc == "auto" &&
577 (font.language()->encoding()->LatexName()
579 font.language()->encoding()->LatexName()
581 os << "\\ensuremath{"
590 case '|': case '<': case '>':
591 // In T1 encoding, these characters exist
592 if (lyxrc.fontenc == "T1") {
594 //... but we should avoid ligatures
595 if ((c == '>' || c == '<')
597 && getChar(i + 1) == c) {
598 //os << "\\textcompwordmark{}";
599 // Jean-Marc, have a look at
600 // this. I think this works
608 // Typewriter font also has them
609 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
613 // Otherwise, we use what LaTeX
617 os << "\\textless{}";
621 os << "\\textgreater{}";
631 case '-': // "--" in Typewriter mode -> "-{}-"
633 && getChar(i + 1) == '-'
634 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
643 os << "\\char`\\\"{}";
648 if (bparams.inputenc == "default") {
657 case '%': case '#': case '{':
664 os << "\\textasciitilde{}";
669 os << "\\textasciicircum{}";
673 case '*': case '[': case ']':
674 // avoid being mistaken for optional arguments
675 os << '{' << c << '}';
680 // Blanks are printed before font switching.
681 // Sure? I am not! (try nice-latex)
682 // I am sure it's correct. LyX might be smarter
683 // in the future, but for now, nothing wrong is
689 // I assume this is hack treating typewriter as verbatim
690 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
699 // FIXME: if we have "LaTeX" with a font
700 // change in the middle (before the 'T', then
701 // the "TeX" part is still special cased.
702 // Really we should only operate this on
703 // "words" for some definition of word
707 for (; pnr < phrases_nr; ++pnr) {
708 if (isTextAt(special_phrases[pnr].phrase, i)) {
709 os << special_phrases[pnr].macro;
710 i += special_phrases[pnr].phrase.length() - 1;
711 column += special_phrases[pnr].macro.length() - 1;
716 if (pnr == phrases_nr && c != '\0') {
725 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
726 LyXLayout const & layout) const
728 BufferParams const & bparams = features.bufferParams();
731 if (!params.spacing().isDefault())
732 features.require("setspace");
735 features.useLayout(layout.name());
738 Language const * doc_language = bparams.language;
740 FontList::const_iterator fcit = fontlist.begin();
741 FontList::const_iterator fend = fontlist.end();
742 for (; fcit != fend; ++fcit) {
743 if (fcit->font().noun() == LyXFont::ON) {
744 lyxerr[Debug::LATEX] << "font.noun: "
745 << fcit->font().noun()
747 features.require("noun");
748 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
749 << fcit->font().stateText(0)
752 switch (fcit->font().color()) {
754 case LColor::inherit:
756 // probably we should put here all interface colors used for
757 // font displaying! For now I just add this ones I know of (Jug)
762 features.require("color");
763 lyxerr[Debug::LATEX] << "Color enabled. Font: "
764 << fcit->font().stateText(0)
768 Language const * language = fcit->font().language();
769 if (language->babel() != doc_language->babel() &&
770 language != ignore_language &&
771 language != latex_language)
773 features.useLanguage(language);
774 lyxerr[Debug::LATEX] << "Found language "
775 << language->babel() << endl;
779 if (!params.leftIndent().zero())
780 features.require("ParagraphLeftIndent");
783 InsetList::iterator icit = owner_->insetlist.begin();
784 InsetList::iterator iend = owner_->insetlist.end();
785 for (; icit != iend; ++icit) {
787 icit->inset->validate(features);
788 if (layout.needprotect &&
789 icit->inset->lyxCode() == InsetBase::FOOT_CODE)
790 features.require("NeedLyXFootnoteCode");
795 for (pos_type i = 0; i < size() ; ++i) {
796 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
797 if (!special_phrases[pnr].builtin
798 && isTextAt(special_phrases[pnr].phrase, i)) {
799 features.require(special_phrases[pnr].phrase);