1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
13 #include "paragraph_pimpl.h"
14 #include "LaTeXFeatures.h"
17 #include "bufferparams.h"
22 #include "support/LAssert.h"
27 using std::upper_bound;
28 using std::lower_bound;
30 // Initialize static member.
31 ShareContainer<LyXFont> Paragraph::Pimpl::FontTable::container;
32 // Initialization of the counter for the paragraph id's,
33 unsigned int Paragraph::Pimpl::paragraph_id = 0;
37 struct special_phrase {
43 special_phrase special_phrases[] = {
44 { "LyX", "\\LyX{}", false },
45 { "TeX", "\\TeX{}", true },
46 { "LaTeX2e", "\\LaTeXe{}", true },
47 { "LaTeX", "\\LaTeX{}", true },
50 size_t const phrases_nr = sizeof(special_phrases)/sizeof(special_phrase);
55 Paragraph::Pimpl::Pimpl(Paragraph * owner)
63 Paragraph::Pimpl::Pimpl(Pimpl const & p, Paragraph * owner, bool same_ids)
64 : params(p.params), owner_(owner)
66 inset_owner = p.inset_owner;
68 fontlist = p.fontlist;
75 changes_.reset(new Changes(*p.changes_.get()));
79 void Paragraph::Pimpl::clear()
86 void Paragraph::Pimpl::setContentsFromPar(Paragraph const * par)
89 text = par->pimpl_->text;
90 if (par->pimpl_->tracking()) {
91 changes_.reset(new Changes(*(par->pimpl_->changes_.get())));
96 void Paragraph::Pimpl::trackChanges(Change::Type type)
99 lyxerr[Debug::CHANGES] << "already tracking for par " << id_ << endl;
103 lyxerr[Debug::CHANGES] << "track changes for par "
104 << id_ << " type " << type << endl;
105 changes_.reset(new Changes(type));
106 changes_->set(type, 0, size());
110 void Paragraph::Pimpl::untrackChanges()
116 void Paragraph::Pimpl::cleanChanges()
118 // if we're not tracking, we don't want to reset...
122 changes_.reset(new Changes(Change::INSERTED));
123 changes_->set(Change::INSERTED, 0, size());
127 bool Paragraph::Pimpl::isChanged(pos_type start, pos_type end) const
132 return changes_->isChange(start, end);
136 bool Paragraph::Pimpl::isChangeEdited(pos_type start, pos_type end) const
141 return changes_->isChangeEdited(start, end);
145 void Paragraph::Pimpl::setChange(pos_type pos, Change::Type type)
150 changes_->set(type, pos);
154 Change::Type Paragraph::Pimpl::lookupChange(pos_type pos) const
157 return Change::UNCHANGED;
159 return changes_->lookup(pos);
163 Change const Paragraph::Pimpl::lookupChangeFull(pos_type pos) const
166 return Change(Change::UNCHANGED);
168 return changes_->lookupFull(pos);
172 void Paragraph::Pimpl::markErased()
174 lyx::Assert(tracking());
176 // FIXME: we should actually remove INSERTED chars.
177 // difficult because owning insettexts/tabulars need
178 // to update themselves when rows etc. change
179 changes_->set(Change::DELETED, 0, size());
180 changes_->reset(Change::DELETED);
184 void Paragraph::Pimpl::acceptChange(pos_type start, pos_type end)
190 changes_.reset(new Changes(Change::UNCHANGED));
194 lyxerr << "acceptchange" << endl;
197 for (; i < end; ++i) {
198 switch (lookupChange(i)) {
199 case Change::UNCHANGED:
202 case Change::INSERTED:
203 changes_->set(Change::UNCHANGED, i);
206 case Change::DELETED:
215 lyxerr << "endacceptchange" << endl;
216 changes_->reset(Change::UNCHANGED);
220 void Paragraph::Pimpl::rejectChange(pos_type start, pos_type end)
226 changes_.reset(new Changes(Change::UNCHANGED));
232 for (; i < end; ++i) {
233 switch (lookupChange(i)) {
234 case Change::UNCHANGED:
237 case Change::INSERTED:
244 case Change::DELETED:
245 changes_->set(Change::UNCHANGED, i);
249 changes_->reset(Change::UNCHANGED);
253 Paragraph::value_type Paragraph::Pimpl::getChar(pos_type pos) const
255 lyx::Assert(pos <= size());
257 // This is stronger, and I belive that this is the assertion
258 // that we should really use. (Lgb)
259 // Rationale - getChar() is really text[]. getInset(getChar(size()))
260 // makes no sense (crashes). The fact we return '\0' should be
261 // evidence enough - jbl
262 //lyx::Assert(pos < size());
264 if (lyxerr.debugging(Debug::LYXVC))
265 lyx::Assert(pos < size());
267 // This is in the critical path for loading!
268 pos_type const siz = size();
271 lyxerr << "getChar() on pos " << pos << " in par id "
272 << owner_->id() << " of size " << siz
273 << " is a bit silly !" << endl;
281 void Paragraph::Pimpl::setChar(pos_type pos, value_type c)
288 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c,
289 LyXFont const & font, Change change)
291 lyx::Assert(pos <= size());
294 changes_->record(change, pos);
297 // This is actually very common when parsing buffers (and
298 // maybe inserting ascii text)
300 // when appending characters, no need to update tables
302 owner_->setFont(pos, font);
306 text.insert(text.begin() + pos, c);
308 // Update the font table.
309 FontTable search_font(pos, LyXFont());
310 for (FontList::iterator it = lower_bound(fontlist.begin(),
312 search_font, matchFT());
313 it != fontlist.end(); ++it)
315 it->pos(it->pos() + 1);
319 owner_->insetlist.increasePosAfterPos(pos);
321 owner_->setFont(pos, font);
325 void Paragraph::Pimpl::insertInset(pos_type pos,
326 Inset * inset, LyXFont const & font, Change change)
329 lyx::Assert(pos <= size());
331 insertChar(pos, META_INSET, font, change);
332 lyx::Assert(text[pos] == META_INSET);
334 // Add a new entry in the insetlist.
335 owner_->insetlist.insert(inset, pos);
336 inset->parOwner(owner_);
339 inset->setOwner(inset_owner);
343 bool Paragraph::Pimpl::erasePos(pos_type pos)
345 lyx::Assert(pos < size());
348 Change::Type changetype(changes_->lookup(pos));
349 changes_->record(Change(Change::DELETED), pos);
351 // only allow the actual removal if it was /new/ text
352 if (changetype != Change::INSERTED) {
353 if (text[pos] == Paragraph::META_INSET) {
354 Inset * i(owner_->getInset(pos));
366 void Paragraph::Pimpl::eraseIntern(pos_type pos)
368 // if it is an inset, delete the inset entry
369 if (text[pos] == Paragraph::META_INSET) {
370 owner_->insetlist.erase(pos);
373 text.erase(text.begin() + pos);
375 // Erase entries in the tables.
376 FontTable search_font(pos, LyXFont());
378 FontList::iterator it =
379 lower_bound(fontlist.begin(),
381 search_font, matchFT());
382 if (it != fontlist.end() && it->pos() == pos &&
384 (it != fontlist.begin()
385 && boost::prior(it)->pos() == pos - 1))) {
386 // If it is a multi-character font
387 // entry, we just make it smaller
388 // (see update below), otherwise we
390 unsigned int const i = it - fontlist.begin();
391 fontlist.erase(fontlist.begin() + i);
392 it = fontlist.begin() + i;
393 if (i > 0 && i < fontlist.size() &&
394 fontlist[i - 1].font() == fontlist[i].font()) {
395 fontlist.erase(fontlist.begin() + i - 1);
396 it = fontlist.begin() + i - 1;
400 // Update all other entries.
401 FontList::iterator fend = fontlist.end();
402 for (; it != fend; ++it)
403 it->pos(it->pos() - 1);
405 // Update the insetlist.
406 owner_->insetlist.decreasePosAfterPos(pos);
410 void Paragraph::Pimpl::erase(pos_type pos)
416 bool Paragraph::Pimpl::erase(pos_type start, pos_type end)
419 pos_type count = end - start;
420 bool any_erased = false;
434 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
436 unsigned int & column,
437 LyXFont const & font,
438 LyXLayout const & style)
443 if (column > lyxrc.ascii_linelen
445 && getChar(i - 1) != ' '
447 // same in FreeSpacing mode
448 && !style.free_spacing
449 && !owner_->isFreeSpacing()
450 // In typewriter mode, we want to avoid
451 // ! . ? : at the end of a line
452 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
453 && (getChar(i - 1) == '.'
454 || getChar(i - 1) == '?'
455 || getChar(i - 1) == ':'
456 || getChar(i - 1) == '!'))) {
459 texrow.start(owner_, i + 1);
461 } else if (style.free_spacing) {
469 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
471 pos_type const len = str.length();
473 // is the paragraph large enough?
474 if (pos + len > size())
477 // does the wanted text start at point?
478 for (string::size_type i = 0; i < str.length(); ++i) {
479 if (str[i] != text[pos + i])
483 // is there a font change in middle of the word?
484 FontList::const_iterator cit = fontlist.begin();
485 FontList::const_iterator end = fontlist.end();
486 for (; cit != end; ++cit) {
487 if (cit->pos() >= pos)
490 if (cit != end && pos + len - 1 > cit->pos())
497 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
498 BufferParams const & bparams,
503 LyXFont & running_font,
506 Change::Type & running_change,
507 LyXLayout const & style,
509 unsigned int & column,
512 if (style.pass_thru) {
513 if (c != Paragraph::META_INSET) {
517 Inset const * inset = owner_->getInset(i);
518 inset->ascii(buf, os, 0);
523 // Two major modes: LaTeX or plain
524 // Handle here those cases common to both modes
525 // and then split to handle the two modes separately.
527 case Paragraph::META_INSET: {
528 Inset * inset = owner_->getInset(i);
530 // FIXME: remove this check
534 // FIXME: move this to InsetNewline::latex
535 if (inset->lyxCode() == Inset::NEWLINE_CODE) {
536 // newlines are handled differently here than
537 // the default in simpleTeXSpecialChars().
538 if (!style.newline_allowed) {
542 column += running_font.latexWriteEndChanges(os, basefont, basefont);
545 basefont = owner_->getLayoutFont(bparams);
546 running_font = basefont;
548 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
557 texrow.start(owner_, i + 1);
562 if (inset->isTextInset()) {
563 column += Changes::latexMarkChange(os, running_change,
565 running_change = Change::UNCHANGED;
569 int const len = os.tellp();
570 //ostream::pos_type const len = os.tellp();
571 if ((inset->lyxCode() == Inset::GRAPHICS_CODE
572 || inset->lyxCode() == Inset::MATH_CODE
573 || inset->lyxCode() == Inset::URL_CODE)
574 && running_font.isRightToLeft()) {
580 #warning Bug: we can have an empty font change here!
581 // if there has just been a font change, we are going to close it
582 // right now, which means stupid latex code like \textsf{}. AFAIK,
583 // this does not harm dvi output. A minor bug, thus (JMarc)
585 // some insets cannot be inside a font change command
586 if (open_font && inset->noFontChange()) {
587 column +=running_font.
588 latexWriteEndChanges(os,
592 basefont = owner_->getLayoutFont(bparams);
593 running_font = basefont;
596 int tmp = inset->latex(buf, os, moving_arg,
603 for (int j = 0; j < tmp; ++j) {
606 texrow.start(owner_, i + 1);
609 column += int(os.tellp()) - len;
615 // And now for the special cases within each mode
619 os << "\\textbackslash{}";
623 case '±': case '²': case '³':
624 case '×': case '÷': case '¹':
626 if ((bparams.inputenc == "latin1" ||
627 bparams.inputenc == "latin9") ||
628 (bparams.inputenc == "auto" &&
629 (font.language()->encoding()->LatexName()
631 font.language()->encoding()->LatexName()
633 os << "\\ensuremath{"
642 case '|': case '<': case '>':
643 // In T1 encoding, these characters exist
644 if (lyxrc.fontenc == "T1") {
646 //... but we should avoid ligatures
647 if ((c == '>' || c == '<')
649 && getChar(i + 1) == c) {
650 //os << "\\textcompwordmark{}";
651 // Jean-Marc, have a look at
652 // this. I think this works
660 // Typewriter font also has them
661 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
665 // Otherwise, we use what LaTeX
669 os << "\\textless{}";
673 os << "\\textgreater{}";
683 case '-': // "--" in Typewriter mode -> "-{}-"
685 && getChar(i + 1) == '-'
686 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
695 os << "\\char`\\\"{}";
700 if (bparams.inputenc == "default") {
709 case '%': case '#': case '{':
716 os << "\\textasciitilde{}";
721 os << "\\textasciicircum{}";
725 case '*': case '[': case ']':
726 // avoid being mistaken for optional arguments
727 os << '{' << c << '}';
732 // Blanks are printed before font switching.
733 // Sure? I am not! (try nice-latex)
734 // I am sure it's correct. LyX might be smarter
735 // in the future, but for now, nothing wrong is
741 // I assume this is hack treating typewriter as verbatim
742 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
751 // FIXME: if we have "LaTeX" with a font
752 // change in the middle (before the 'T', then
753 // the "TeX" part is still special cased.
754 // Really we should only operate this on
755 // "words" for some definition of word
759 for (; pnr < phrases_nr; ++pnr) {
760 if (isTextAt(special_phrases[pnr].phrase, i)) {
761 os << special_phrases[pnr].macro;
762 i += special_phrases[pnr].phrase.length() - 1;
763 column += special_phrases[pnr].macro.length() - 1;
768 if (pnr == phrases_nr && c != '\0') {
777 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
778 LyXLayout const & layout) const
780 BufferParams const & bparams = features.bufferParams();
783 if (params.lineTop() || params.lineBottom())
784 features.require("lyxline");
785 if (!params.spacing().isDefault())
786 features.require("setspace");
789 features.useLayout(layout.name());
792 Language const * doc_language = bparams.language;
794 FontList::const_iterator fcit = fontlist.begin();
795 FontList::const_iterator fend = fontlist.end();
796 for (; fcit != fend; ++fcit) {
797 if (fcit->font().noun() == LyXFont::ON) {
798 lyxerr[Debug::LATEX] << "font.noun: "
799 << fcit->font().noun()
801 features.require("noun");
802 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
803 << fcit->font().stateText(0)
806 switch (fcit->font().color()) {
808 case LColor::inherit:
810 // probably we should put here all interface colors used for
811 // font displaying! For now I just add this ones I know of (Jug)
816 features.require("color");
817 lyxerr[Debug::LATEX] << "Color enabled. Font: "
818 << fcit->font().stateText(0)
822 Language const * language = fcit->font().language();
823 if (language->babel() != doc_language->babel() &&
824 language != ignore_language &&
825 language != latex_language)
827 features.useLanguage(language);
828 lyxerr[Debug::LATEX] << "Found language "
829 << language->babel() << endl;
833 if (!params.leftIndent().zero())
834 features.require("ParagraphLeftIndent");
837 InsetList::iterator icit = owner_->insetlist.begin();
838 InsetList::iterator iend = owner_->insetlist.end();
839 for (; icit != iend; ++icit) {
840 if (icit.getInset()) {
841 icit.getInset()->validate(features);
842 if (layout.needprotect &&
843 icit.getInset()->lyxCode() == Inset::FOOT_CODE)
844 features.require("NeedLyXFootnoteCode");
849 for (pos_type i = 0; i < size() ; ++i) {
850 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
851 if (!special_phrases[pnr].builtin
852 && isTextAt(special_phrases[pnr].phrase, i)) {
853 features.require(special_phrases[pnr].phrase);
861 LyXFont const Paragraph::Pimpl::realizeFont(LyXFont const & font,
862 BufferParams const & bparams) const
864 LyXFont tmpfont(font);
866 // check for environment font information
867 char par_depth = owner_->getDepth();
868 Paragraph const * par = owner_;
869 LyXTextClass const & tclass = bparams.getLyXTextClass();
871 while (par && par->getDepth() && !tmpfont.resolved()) {
872 par = par->outerHook();
874 tmpfont.realize(par->layout()->font);
875 par_depth = par->getDepth();
879 tmpfont.realize(tclass.defaultfont());