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"
23 #include "latexrunparams.h"
25 #include "paragraph_funcs.h"
28 #include "support/LAssert.h"
30 using namespace lyx::support;
34 using std::upper_bound;
35 using std::lower_bound;
37 // Initialize static member.
38 ShareContainer<LyXFont> Paragraph::Pimpl::FontTable::container;
39 // Initialization of the counter for the paragraph id's,
40 unsigned int Paragraph::Pimpl::paragraph_id = 0;
44 struct special_phrase {
50 special_phrase special_phrases[] = {
51 { "LyX", "\\LyX{}", false },
52 { "TeX", "\\TeX{}", true },
53 { "LaTeX2e", "\\LaTeXe{}", true },
54 { "LaTeX", "\\LaTeX{}", true },
57 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
62 Paragraph::Pimpl::Pimpl(Paragraph * owner)
70 Paragraph::Pimpl::Pimpl(Pimpl const & p, Paragraph * owner)
71 : params(p.params), owner_(owner)
73 inset_owner = p.inset_owner;
75 fontlist = p.fontlist;
79 changes_.reset(new Changes(*p.changes_.get()));
83 void Paragraph::Pimpl::clear()
90 void Paragraph::Pimpl::setContentsFromPar(Paragraph const & par)
92 text = par.pimpl_->text;
93 if (par.pimpl_->tracking()) {
94 changes_.reset(new Changes(*(par.pimpl_->changes_.get())));
99 void Paragraph::Pimpl::trackChanges(Change::Type type)
102 lyxerr[Debug::CHANGES] << "already tracking for par " << id_ << endl;
106 lyxerr[Debug::CHANGES] << "track changes for par "
107 << id_ << " type " << type << endl;
108 changes_.reset(new Changes(type));
109 changes_->set(type, 0, size());
113 void Paragraph::Pimpl::untrackChanges()
119 void Paragraph::Pimpl::cleanChanges()
121 // if we're not tracking, we don't want to reset...
125 changes_.reset(new Changes(Change::INSERTED));
126 changes_->set(Change::INSERTED, 0, size());
130 bool Paragraph::Pimpl::isChanged(pos_type start, pos_type end) const
135 return changes_->isChange(start, end);
139 bool Paragraph::Pimpl::isChangeEdited(pos_type start, pos_type end) const
144 return changes_->isChangeEdited(start, end);
148 void Paragraph::Pimpl::setChange(pos_type pos, Change::Type type)
153 changes_->set(type, pos);
157 Change::Type Paragraph::Pimpl::lookupChange(pos_type pos) const
160 return Change::UNCHANGED;
162 return changes_->lookup(pos);
166 Change const Paragraph::Pimpl::lookupChangeFull(pos_type pos) const
169 return Change(Change::UNCHANGED);
171 return changes_->lookupFull(pos);
175 void Paragraph::Pimpl::markErased()
179 // FIXME: we should actually remove INSERTED chars.
180 // difficult because owning insettexts/tabulars need
181 // to update themselves when rows etc. change
182 changes_->set(Change::DELETED, 0, size());
183 changes_->reset(Change::DELETED);
187 void Paragraph::Pimpl::acceptChange(pos_type start, pos_type end)
193 changes_.reset(new Changes(Change::UNCHANGED));
197 lyxerr << "acceptchange" << endl;
200 for (; i < end; ++i) {
201 switch (lookupChange(i)) {
202 case Change::UNCHANGED:
205 case Change::INSERTED:
206 changes_->set(Change::UNCHANGED, i);
209 case Change::DELETED:
218 lyxerr << "endacceptchange" << endl;
219 changes_->reset(Change::UNCHANGED);
223 void Paragraph::Pimpl::rejectChange(pos_type start, pos_type end)
229 changes_.reset(new Changes(Change::UNCHANGED));
235 for (; i < end; ++i) {
236 switch (lookupChange(i)) {
237 case Change::UNCHANGED:
240 case Change::INSERTED:
247 case Change::DELETED:
248 changes_->set(Change::UNCHANGED, i);
252 changes_->reset(Change::UNCHANGED);
256 Paragraph::value_type Paragraph::Pimpl::getChar(pos_type pos) const
259 // This is in the critical path for loading!
260 pos_type const siz = size();
265 lyxerr << "getChar() on pos " << pos << " in par id "
266 << owner_->id() << " of size " << siz
267 << " is a bit silly !" << endl;
273 Assert(pos < size());
279 void Paragraph::Pimpl::setChar(pos_type pos, value_type c)
286 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c,
287 LyXFont const & font, Change change)
289 Assert(pos <= size());
292 changes_->record(change, pos);
295 // This is actually very common when parsing buffers (and
296 // maybe inserting ascii text)
298 // when appending characters, no need to update tables
300 owner_->setFont(pos, font);
304 text.insert(text.begin() + pos, c);
306 // Update the font table.
307 FontTable search_font(pos, LyXFont());
308 for (FontList::iterator it = lower_bound(fontlist.begin(),
310 search_font, matchFT());
311 it != fontlist.end(); ++it)
313 it->pos(it->pos() + 1);
317 owner_->insetlist.increasePosAfterPos(pos);
319 owner_->setFont(pos, font);
323 void Paragraph::Pimpl::insertInset(pos_type pos,
324 InsetOld * inset, LyXFont const & font, Change change)
327 Assert(pos <= size());
329 insertChar(pos, META_INSET, font, change);
330 Assert(text[pos] == META_INSET);
332 // Add a new entry in the insetlist.
333 owner_->insetlist.insert(inset, pos);
336 inset->setOwner(inset_owner);
340 void Paragraph::Pimpl::eraseIntern(pos_type pos)
342 // if it is an inset, delete the inset entry
343 if (text[pos] == Paragraph::META_INSET) {
344 owner_->insetlist.erase(pos);
347 text.erase(text.begin() + pos);
349 // Erase entries in the tables.
350 FontTable search_font(pos, LyXFont());
352 FontList::iterator it =
353 lower_bound(fontlist.begin(),
355 search_font, matchFT());
356 if (it != fontlist.end() && it->pos() == pos &&
358 (it != fontlist.begin()
359 && boost::prior(it)->pos() == pos - 1))) {
360 // If it is a multi-character font
361 // entry, we just make it smaller
362 // (see update below), otherwise we
364 unsigned int const i = it - fontlist.begin();
365 fontlist.erase(fontlist.begin() + i);
366 it = fontlist.begin() + i;
367 if (i > 0 && i < fontlist.size() &&
368 fontlist[i - 1].font() == fontlist[i].font()) {
369 fontlist.erase(fontlist.begin() + i - 1);
370 it = fontlist.begin() + i - 1;
374 // Update all other entries.
375 FontList::iterator fend = fontlist.end();
376 for (; it != fend; ++it)
377 it->pos(it->pos() - 1);
379 // Update the insetlist.
380 owner_->insetlist.decreasePosAfterPos(pos);
384 bool Paragraph::Pimpl::erase(pos_type pos)
386 Assert(pos < size());
389 Change::Type changetype(changes_->lookup(pos));
390 changes_->record(Change(Change::DELETED), pos);
392 // only allow the actual removal if it was /new/ text
393 if (changetype != Change::INSERTED) {
394 if (text[pos] == Paragraph::META_INSET) {
395 InsetOld * i(owner_->getInset(pos));
407 int Paragraph::Pimpl::erase(pos_type start, pos_type end)
410 pos_type count = end - start;
421 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
423 unsigned int & column,
424 LyXFont const & font,
425 LyXLayout const & style)
430 if (column > lyxrc.ascii_linelen
432 && getChar(i - 1) != ' '
434 // same in FreeSpacing mode
435 && !owner_->isFreeSpacing()
436 // In typewriter mode, we want to avoid
437 // ! . ? : at the end of a line
438 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
439 && (getChar(i - 1) == '.'
440 || getChar(i - 1) == '?'
441 || getChar(i - 1) == ':'
442 || getChar(i - 1) == '!'))) {
445 texrow.start(owner_->id(), i + 1);
447 } else if (style.free_spacing) {
455 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
457 pos_type const len = str.length();
459 // is the paragraph large enough?
460 if (pos + len > size())
463 // does the wanted text start at point?
464 for (string::size_type i = 0; i < str.length(); ++i) {
465 if (str[i] != text[pos + i])
469 // is there a font change in middle of the word?
470 FontList::const_iterator cit = fontlist.begin();
471 FontList::const_iterator end = fontlist.end();
472 for (; cit != end; ++cit) {
473 if (cit->pos() >= pos)
476 if (cit != end && pos + len - 1 > cit->pos())
483 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
484 BufferParams const & bparams,
487 LatexRunParams const & runparams,
489 LyXFont & running_font,
491 LyXFont const & outerfont,
493 Change::Type & running_change,
494 LyXLayout const & style,
496 unsigned int & column,
499 if (style.pass_thru) {
500 if (c != Paragraph::META_INSET) {
504 InsetOld const * inset = owner_->getInset(i);
505 inset->ascii(buf, os, 0);
510 // Two major modes: LaTeX or plain
511 // Handle here those cases common to both modes
512 // and then split to handle the two modes separately.
514 case Paragraph::META_INSET: {
515 InsetOld * inset = owner_->getInset(i);
517 // FIXME: remove this check
521 // FIXME: move this to InsetNewline::latex
522 if (inset->lyxCode() == InsetOld::NEWLINE_CODE) {
523 // newlines are handled differently here than
524 // the default in simpleTeXSpecialChars().
525 if (!style.newline_allowed) {
529 column += running_font.latexWriteEndChanges(os, basefont, basefont);
532 basefont = owner_->getLayoutFont(bparams, outerfont);
533 running_font = basefont;
535 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
538 if (runparams.moving_arg)
544 texrow.start(owner_->id(), i + 1);
549 if (inset->isTextInset()) {
550 column += Changes::latexMarkChange(os, running_change,
552 running_change = Change::UNCHANGED;
556 int const len = os.tellp();
557 //ostream::pos_type const len = os.tellp();
558 if ((inset->lyxCode() == InsetOld::GRAPHICS_CODE
559 || inset->lyxCode() == InsetOld::MATH_CODE
560 || inset->lyxCode() == InsetOld::URL_CODE)
561 && running_font.isRightToLeft()) {
567 #warning Bug: we can have an empty font change here!
568 // if there has just been a font change, we are going to close it
569 // right now, which means stupid latex code like \textsf{}. AFAIK,
570 // this does not harm dvi output. A minor bug, thus (JMarc)
572 // some insets cannot be inside a font change command
573 if (open_font && inset->noFontChange()) {
574 column +=running_font.
575 latexWriteEndChanges(os,
579 basefont = owner_->getLayoutFont(bparams, outerfont);
580 running_font = basefont;
583 int tmp = inset->latex(buf, os, runparams);
589 for (int j = 0; j < tmp; ++j) {
592 texrow.start(owner_->id(), i + 1);
595 column += int(os.tellp()) - len;
601 // And now for the special cases within each mode
605 os << "\\textbackslash{}";
609 case '±': case '²': case '³':
610 case '×': case '÷': case '¹':
612 if ((bparams.inputenc == "latin1" ||
613 bparams.inputenc == "latin9") ||
614 (bparams.inputenc == "auto" &&
615 (font.language()->encoding()->LatexName()
617 font.language()->encoding()->LatexName()
619 os << "\\ensuremath{"
628 case '|': case '<': case '>':
629 // In T1 encoding, these characters exist
630 if (lyxrc.fontenc == "T1") {
632 //... but we should avoid ligatures
633 if ((c == '>' || c == '<')
635 && getChar(i + 1) == c) {
636 //os << "\\textcompwordmark{}";
637 // Jean-Marc, have a look at
638 // this. I think this works
646 // Typewriter font also has them
647 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
651 // Otherwise, we use what LaTeX
655 os << "\\textless{}";
659 os << "\\textgreater{}";
669 case '-': // "--" in Typewriter mode -> "-{}-"
671 && getChar(i + 1) == '-'
672 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
681 os << "\\char`\\\"{}";
686 if (bparams.inputenc == "default") {
695 case '%': case '#': case '{':
702 os << "\\textasciitilde{}";
707 os << "\\textasciicircum{}";
711 case '*': case '[': case ']':
712 // avoid being mistaken for optional arguments
713 os << '{' << c << '}';
718 // Blanks are printed before font switching.
719 // Sure? I am not! (try nice-latex)
720 // I am sure it's correct. LyX might be smarter
721 // in the future, but for now, nothing wrong is
727 // I assume this is hack treating typewriter as verbatim
728 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
737 // FIXME: if we have "LaTeX" with a font
738 // change in the middle (before the 'T', then
739 // the "TeX" part is still special cased.
740 // Really we should only operate this on
741 // "words" for some definition of word
745 for (; pnr < phrases_nr; ++pnr) {
746 if (isTextAt(special_phrases[pnr].phrase, i)) {
747 os << special_phrases[pnr].macro;
748 i += special_phrases[pnr].phrase.length() - 1;
749 column += special_phrases[pnr].macro.length() - 1;
754 if (pnr == phrases_nr && c != '\0') {
763 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
764 LyXLayout const & layout) const
766 BufferParams const & bparams = features.bufferParams();
769 if (params.lineTop() || params.lineBottom())
770 features.require("lyxline");
771 if (!params.spacing().isDefault())
772 features.require("setspace");
775 features.useLayout(layout.name());
778 Language const * doc_language = bparams.language;
780 FontList::const_iterator fcit = fontlist.begin();
781 FontList::const_iterator fend = fontlist.end();
782 for (; fcit != fend; ++fcit) {
783 if (fcit->font().noun() == LyXFont::ON) {
784 lyxerr[Debug::LATEX] << "font.noun: "
785 << fcit->font().noun()
787 features.require("noun");
788 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
789 << fcit->font().stateText(0)
792 switch (fcit->font().color()) {
794 case LColor::inherit:
796 // probably we should put here all interface colors used for
797 // font displaying! For now I just add this ones I know of (Jug)
802 features.require("color");
803 lyxerr[Debug::LATEX] << "Color enabled. Font: "
804 << fcit->font().stateText(0)
808 Language const * language = fcit->font().language();
809 if (language->babel() != doc_language->babel() &&
810 language != ignore_language &&
811 language != latex_language)
813 features.useLanguage(language);
814 lyxerr[Debug::LATEX] << "Found language "
815 << language->babel() << endl;
819 if (!params.leftIndent().zero())
820 features.require("ParagraphLeftIndent");
823 InsetList::iterator icit = owner_->insetlist.begin();
824 InsetList::iterator iend = owner_->insetlist.end();
825 for (; icit != iend; ++icit) {
827 icit->inset->validate(features);
828 if (layout.needprotect &&
829 icit->inset->lyxCode() == InsetOld::FOOT_CODE)
830 features.require("NeedLyXFootnoteCode");
835 for (pos_type i = 0; i < size() ; ++i) {
836 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
837 if (!special_phrases[pnr].builtin
838 && isTextAt(special_phrases[pnr].phrase, i)) {
839 features.require(special_phrases[pnr].phrase);