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
256 // This is in the critical path for loading!
257 pos_type const siz = size();
259 lyx::Assert(pos <= siz);
262 lyxerr << "getChar() on pos " << pos << " in par id "
263 << owner_->id() << " of size " << siz
264 << " is a bit silly !" << endl;
270 lyx::Assert(pos < size());
276 void Paragraph::Pimpl::setChar(pos_type pos, value_type c)
283 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c,
284 LyXFont const & font, Change change)
286 lyx::Assert(pos <= size());
289 changes_->record(change, pos);
292 // This is actually very common when parsing buffers (and
293 // maybe inserting ascii text)
295 // when appending characters, no need to update tables
297 owner_->setFont(pos, font);
301 text.insert(text.begin() + pos, c);
303 // Update the font table.
304 FontTable search_font(pos, LyXFont());
305 for (FontList::iterator it = lower_bound(fontlist.begin(),
307 search_font, matchFT());
308 it != fontlist.end(); ++it)
310 it->pos(it->pos() + 1);
314 owner_->insetlist.increasePosAfterPos(pos);
316 owner_->setFont(pos, font);
320 void Paragraph::Pimpl::insertInset(pos_type pos,
321 Inset * inset, LyXFont const & font, Change change)
324 lyx::Assert(pos <= size());
326 insertChar(pos, META_INSET, font, change);
327 lyx::Assert(text[pos] == META_INSET);
329 // Add a new entry in the insetlist.
330 owner_->insetlist.insert(inset, pos);
331 inset->parOwner(owner_);
334 inset->setOwner(inset_owner);
338 bool Paragraph::Pimpl::erasePos(pos_type pos)
340 lyx::Assert(pos < size());
343 Change::Type changetype(changes_->lookup(pos));
344 changes_->record(Change(Change::DELETED), pos);
346 // only allow the actual removal if it was /new/ text
347 if (changetype != Change::INSERTED) {
348 if (text[pos] == Paragraph::META_INSET) {
349 Inset * i(owner_->getInset(pos));
361 void Paragraph::Pimpl::eraseIntern(pos_type pos)
363 // if it is an inset, delete the inset entry
364 if (text[pos] == Paragraph::META_INSET) {
365 owner_->insetlist.erase(pos);
368 text.erase(text.begin() + pos);
370 // Erase entries in the tables.
371 FontTable search_font(pos, LyXFont());
373 FontList::iterator it =
374 lower_bound(fontlist.begin(),
376 search_font, matchFT());
377 if (it != fontlist.end() && it->pos() == pos &&
379 (it != fontlist.begin()
380 && boost::prior(it)->pos() == pos - 1))) {
381 // If it is a multi-character font
382 // entry, we just make it smaller
383 // (see update below), otherwise we
385 unsigned int const i = it - fontlist.begin();
386 fontlist.erase(fontlist.begin() + i);
387 it = fontlist.begin() + i;
388 if (i > 0 && i < fontlist.size() &&
389 fontlist[i - 1].font() == fontlist[i].font()) {
390 fontlist.erase(fontlist.begin() + i - 1);
391 it = fontlist.begin() + i - 1;
395 // Update all other entries.
396 FontList::iterator fend = fontlist.end();
397 for (; it != fend; ++it)
398 it->pos(it->pos() - 1);
400 // Update the insetlist.
401 owner_->insetlist.decreasePosAfterPos(pos);
405 void Paragraph::Pimpl::erase(pos_type pos)
411 bool Paragraph::Pimpl::erase(pos_type start, pos_type end)
414 pos_type count = end - start;
415 bool any_erased = false;
429 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
431 unsigned int & column,
432 LyXFont const & font,
433 LyXLayout const & style)
438 if (column > lyxrc.ascii_linelen
440 && getChar(i - 1) != ' '
442 // same in FreeSpacing mode
443 && !style.free_spacing
444 && !owner_->isFreeSpacing()
445 // In typewriter mode, we want to avoid
446 // ! . ? : at the end of a line
447 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
448 && (getChar(i - 1) == '.'
449 || getChar(i - 1) == '?'
450 || getChar(i - 1) == ':'
451 || getChar(i - 1) == '!'))) {
454 texrow.start(owner_, i + 1);
456 } else if (style.free_spacing) {
464 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
466 pos_type const len = str.length();
468 // is the paragraph large enough?
469 if (pos + len > size())
472 // does the wanted text start at point?
473 for (string::size_type i = 0; i < str.length(); ++i) {
474 if (str[i] != text[pos + i])
478 // is there a font change in middle of the word?
479 FontList::const_iterator cit = fontlist.begin();
480 FontList::const_iterator end = fontlist.end();
481 for (; cit != end; ++cit) {
482 if (cit->pos() >= pos)
485 if (cit != end && pos + len - 1 > cit->pos())
492 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
493 BufferParams const & bparams,
498 LyXFont & running_font,
501 Change::Type & running_change,
502 LyXLayout const & style,
504 unsigned int & column,
507 if (style.pass_thru) {
508 if (c != Paragraph::META_INSET) {
512 Inset const * inset = owner_->getInset(i);
513 inset->ascii(buf, os, 0);
518 // Two major modes: LaTeX or plain
519 // Handle here those cases common to both modes
520 // and then split to handle the two modes separately.
522 case Paragraph::META_INSET: {
523 Inset * inset = owner_->getInset(i);
525 // FIXME: remove this check
529 // FIXME: move this to InsetNewline::latex
530 if (inset->lyxCode() == Inset::NEWLINE_CODE) {
531 // newlines are handled differently here than
532 // the default in simpleTeXSpecialChars().
533 if (!style.newline_allowed) {
537 column += running_font.latexWriteEndChanges(os, basefont, basefont);
540 basefont = owner_->getLayoutFont(bparams);
541 running_font = basefont;
543 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
552 texrow.start(owner_, i + 1);
557 if (inset->isTextInset()) {
558 column += Changes::latexMarkChange(os, running_change,
560 running_change = Change::UNCHANGED;
564 int const len = os.tellp();
565 //ostream::pos_type const len = os.tellp();
566 if ((inset->lyxCode() == Inset::GRAPHICS_CODE
567 || inset->lyxCode() == Inset::MATH_CODE
568 || inset->lyxCode() == Inset::URL_CODE)
569 && running_font.isRightToLeft()) {
575 #warning Bug: we can have an empty font change here!
576 // if there has just been a font change, we are going to close it
577 // right now, which means stupid latex code like \textsf{}. AFAIK,
578 // this does not harm dvi output. A minor bug, thus (JMarc)
580 // some insets cannot be inside a font change command
581 if (open_font && inset->noFontChange()) {
582 column +=running_font.
583 latexWriteEndChanges(os,
587 basefont = owner_->getLayoutFont(bparams);
588 running_font = basefont;
591 int tmp = inset->latex(buf, os, moving_arg,
598 for (int j = 0; j < tmp; ++j) {
601 texrow.start(owner_, i + 1);
604 column += int(os.tellp()) - len;
610 // And now for the special cases within each mode
614 os << "\\textbackslash{}";
618 case '±': case '²': case '³':
619 case '×': case '÷': case '¹':
621 if ((bparams.inputenc == "latin1" ||
622 bparams.inputenc == "latin9") ||
623 (bparams.inputenc == "auto" &&
624 (font.language()->encoding()->LatexName()
626 font.language()->encoding()->LatexName()
628 os << "\\ensuremath{"
637 case '|': case '<': case '>':
638 // In T1 encoding, these characters exist
639 if (lyxrc.fontenc == "T1") {
641 //... but we should avoid ligatures
642 if ((c == '>' || c == '<')
644 && getChar(i + 1) == c) {
645 //os << "\\textcompwordmark{}";
646 // Jean-Marc, have a look at
647 // this. I think this works
655 // Typewriter font also has them
656 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
660 // Otherwise, we use what LaTeX
664 os << "\\textless{}";
668 os << "\\textgreater{}";
678 case '-': // "--" in Typewriter mode -> "-{}-"
680 && getChar(i + 1) == '-'
681 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
690 os << "\\char`\\\"{}";
695 if (bparams.inputenc == "default") {
704 case '%': case '#': case '{':
711 os << "\\textasciitilde{}";
716 os << "\\textasciicircum{}";
720 case '*': case '[': case ']':
721 // avoid being mistaken for optional arguments
722 os << '{' << c << '}';
727 // Blanks are printed before font switching.
728 // Sure? I am not! (try nice-latex)
729 // I am sure it's correct. LyX might be smarter
730 // in the future, but for now, nothing wrong is
736 // I assume this is hack treating typewriter as verbatim
737 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
746 // FIXME: if we have "LaTeX" with a font
747 // change in the middle (before the 'T', then
748 // the "TeX" part is still special cased.
749 // Really we should only operate this on
750 // "words" for some definition of word
754 for (; pnr < phrases_nr; ++pnr) {
755 if (isTextAt(special_phrases[pnr].phrase, i)) {
756 os << special_phrases[pnr].macro;
757 i += special_phrases[pnr].phrase.length() - 1;
758 column += special_phrases[pnr].macro.length() - 1;
763 if (pnr == phrases_nr && c != '\0') {
772 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
773 LyXLayout const & layout) const
775 BufferParams const & bparams = features.bufferParams();
778 if (params.lineTop() || params.lineBottom())
779 features.require("lyxline");
780 if (!params.spacing().isDefault())
781 features.require("setspace");
784 features.useLayout(layout.name());
787 Language const * doc_language = bparams.language;
789 FontList::const_iterator fcit = fontlist.begin();
790 FontList::const_iterator fend = fontlist.end();
791 for (; fcit != fend; ++fcit) {
792 if (fcit->font().noun() == LyXFont::ON) {
793 lyxerr[Debug::LATEX] << "font.noun: "
794 << fcit->font().noun()
796 features.require("noun");
797 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
798 << fcit->font().stateText(0)
801 switch (fcit->font().color()) {
803 case LColor::inherit:
805 // probably we should put here all interface colors used for
806 // font displaying! For now I just add this ones I know of (Jug)
811 features.require("color");
812 lyxerr[Debug::LATEX] << "Color enabled. Font: "
813 << fcit->font().stateText(0)
817 Language const * language = fcit->font().language();
818 if (language->babel() != doc_language->babel() &&
819 language != ignore_language &&
820 language != latex_language)
822 features.useLanguage(language);
823 lyxerr[Debug::LATEX] << "Found language "
824 << language->babel() << endl;
828 if (!params.leftIndent().zero())
829 features.require("ParagraphLeftIndent");
832 InsetList::iterator icit = owner_->insetlist.begin();
833 InsetList::iterator iend = owner_->insetlist.end();
834 for (; icit != iend; ++icit) {
835 if (icit.getInset()) {
836 icit.getInset()->validate(features);
837 if (layout.needprotect &&
838 icit.getInset()->lyxCode() == Inset::FOOT_CODE)
839 features.require("NeedLyXFootnoteCode");
844 for (pos_type i = 0; i < size() ; ++i) {
845 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
846 if (!special_phrases[pnr].builtin
847 && isTextAt(special_phrases[pnr].phrase, i)) {
848 features.require(special_phrases[pnr].phrase);
856 LyXFont const Paragraph::Pimpl::realizeFont(LyXFont const & font,
857 BufferParams const & bparams) const
859 LyXFont tmpfont(font);
861 // check for environment font information
862 char par_depth = owner_->getDepth();
863 Paragraph const * par = owner_;
864 LyXTextClass const & tclass = bparams.getLyXTextClass();
866 while (par && par->getDepth() && !tmpfont.resolved()) {
867 par = par->outerHook();
869 tmpfont.realize(par->layout()->font);
870 par_depth = par->getDepth();
874 tmpfont.realize(tclass.defaultfont());