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());
265 // This is in the critical path for loading!
266 pos_type const siz = size();
269 lyxerr << "getChar() on pos " << pos << " in par id "
270 << owner_->id() << " of size " << siz
271 << " is a bit silly !" << endl;
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 lyx::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 Inset * inset, LyXFont const & font, Change change)
327 lyx::Assert(pos <= size());
329 insertChar(pos, META_INSET, font, change);
330 lyx::Assert(text[pos] == META_INSET);
332 // Add a new entry in the insetlist.
333 owner_->insetlist.insert(inset, pos);
334 inset->parOwner(owner_);
337 inset->setOwner(inset_owner);
341 bool Paragraph::Pimpl::erasePos(pos_type pos)
343 lyx::Assert(pos < size());
346 Change::Type changetype(changes_->lookup(pos));
347 changes_->record(Change(Change::DELETED), pos);
349 // only allow the actual removal if it was /new/ text
350 if (changetype != Change::INSERTED) {
351 if (text[pos] == Paragraph::META_INSET) {
352 Inset * i(owner_->getInset(pos));
364 void Paragraph::Pimpl::eraseIntern(pos_type pos)
366 // if it is an inset, delete the inset entry
367 if (text[pos] == Paragraph::META_INSET) {
368 owner_->insetlist.erase(pos);
371 text.erase(text.begin() + pos);
373 // Erase entries in the tables.
374 FontTable search_font(pos, LyXFont());
376 FontList::iterator it =
377 lower_bound(fontlist.begin(),
379 search_font, matchFT());
380 if (it != fontlist.end() && it->pos() == pos &&
382 (it != fontlist.begin()
383 && boost::prior(it)->pos() == pos - 1))) {
384 // If it is a multi-character font
385 // entry, we just make it smaller
386 // (see update below), otherwise we
388 unsigned int const i = it - fontlist.begin();
389 fontlist.erase(fontlist.begin() + i);
390 it = fontlist.begin() + i;
391 if (i > 0 && i < fontlist.size() &&
392 fontlist[i - 1].font() == fontlist[i].font()) {
393 fontlist.erase(fontlist.begin() + i - 1);
394 it = fontlist.begin() + i - 1;
398 // Update all other entries.
399 FontList::iterator fend = fontlist.end();
400 for (; it != fend; ++it)
401 it->pos(it->pos() - 1);
403 // Update the insetlist.
404 owner_->insetlist.decreasePosAfterPos(pos);
408 void Paragraph::Pimpl::erase(pos_type pos)
414 bool Paragraph::Pimpl::erase(pos_type start, pos_type end)
417 pos_type count = end - start;
418 bool any_erased = false;
432 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
434 unsigned int & column,
435 LyXFont const & font,
436 LyXLayout const & style)
438 if (style.pass_thru) return;
439 if (column > lyxrc.ascii_linelen
441 && getChar(i - 1) != ' '
443 // same in FreeSpacing mode
444 && !style.free_spacing
445 && !owner_->isFreeSpacing()
446 // In typewriter mode, we want to avoid
447 // ! . ? : at the end of a line
448 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
449 && (getChar(i - 1) == '.'
450 || getChar(i - 1) == '?'
451 || getChar(i - 1) == ':'
452 || getChar(i - 1) == '!'))) {
455 texrow.start(owner_, i + 1);
457 } else if (style.free_spacing) {
465 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
467 pos_type const len = str.length();
469 // is the paragraph large enough?
470 if (pos + len > size())
473 // does the wanted text start at point?
474 for (string::size_type i = 0; i < str.length(); ++i) {
475 if (str[i] != text[pos + i])
479 // is there a font change in middle of the word?
480 FontList::const_iterator cit = fontlist.begin();
481 FontList::const_iterator end = fontlist.end();
482 for (; cit != end; ++cit) {
483 if (cit->pos() >= pos)
486 if (cit != end && pos + len - 1 > cit->pos())
493 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
494 BufferParams const & bparams,
499 LyXFont & running_font,
502 Change::Type & running_change,
503 LyXLayout const & style,
505 unsigned int & column,
508 if (style.pass_thru) {
514 // Two major modes: LaTeX or plain
515 // Handle here those cases common to both modes
516 // and then split to handle the two modes separately.
518 case Paragraph::META_INSET: {
519 Inset * inset = owner_->getInset(i);
521 // FIXME: remove this check
525 // FIXME: move this to InsetNewline::latex
526 if (inset->lyxCode() == Inset::NEWLINE_CODE) {
527 // newlines are handled differently here than
528 // the default in simpleTeXSpecialChars().
529 if (!style.newline_allowed) {
533 column += running_font.latexWriteEndChanges(os, basefont, basefont);
536 basefont = owner_->getLayoutFont(bparams);
537 running_font = basefont;
539 if (font.family() == LyXFont::TYPEWRITER_FAMILY)
548 texrow.start(owner_, i + 1);
553 if (inset->isTextInset()) {
554 column += Changes::latexMarkChange(os, running_change,
556 running_change = Change::UNCHANGED;
560 int const len = os.tellp();
561 //ostream::pos_type const len = os.tellp();
562 if ((inset->lyxCode() == Inset::GRAPHICS_CODE
563 || inset->lyxCode() == Inset::MATH_CODE
564 || inset->lyxCode() == Inset::URL_CODE)
565 && running_font.isRightToLeft()) {
571 #warning Bug: we can have an empty font change here!
572 // if there has just been a font change, we are going to close it
573 // right now, which means stupid latex code like \textsf{}. AFAIK,
574 // this does not harm dvi output. A minor bug, thus (JMarc)
576 // some insets cannot be inside a font change command
577 if (open_font && inset->noFontChange()) {
578 column +=running_font.
579 latexWriteEndChanges(os,
583 basefont = owner_->getLayoutFont(bparams);
584 running_font = basefont;
587 int tmp = inset->latex(buf, os, moving_arg,
594 for (int j = 0; j < tmp; ++j) {
597 texrow.start(owner_, i + 1);
600 column += int(os.tellp()) - len;
606 // And now for the special cases within each mode
610 os << "\\textbackslash{}";
614 case '±': case '²': case '³':
615 case '×': case '÷': case '¹':
617 if ((bparams.inputenc == "latin1" ||
618 bparams.inputenc == "latin9") ||
619 (bparams.inputenc == "auto" &&
620 (font.language()->encoding()->LatexName()
622 font.language()->encoding()->LatexName()
624 os << "\\ensuremath{"
633 case '|': case '<': case '>':
634 // In T1 encoding, these characters exist
635 if (lyxrc.fontenc == "T1") {
637 //... but we should avoid ligatures
638 if ((c == '>' || c == '<')
640 && getChar(i + 1) == c) {
641 //os << "\\textcompwordmark{}";
642 // Jean-Marc, have a look at
643 // this. I think this works
651 // Typewriter font also has them
652 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
656 // Otherwise, we use what LaTeX
660 os << "\\textless{}";
664 os << "\\textgreater{}";
674 case '-': // "--" in Typewriter mode -> "-{}-"
676 && getChar(i + 1) == '-'
677 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
686 os << "\\char`\\\"{}";
691 if (bparams.inputenc == "default") {
700 case '%': case '#': case '{':
707 os << "\\textasciitilde{}";
712 os << "\\textasciicircum{}";
716 case '*': case '[': case ']':
717 // avoid being mistaken for optional arguments
718 os << '{' << c << '}';
723 // Blanks are printed before font switching.
724 // Sure? I am not! (try nice-latex)
725 // I am sure it's correct. LyX might be smarter
726 // in the future, but for now, nothing wrong is
732 // I assume this is hack treating typewriter as verbatim
733 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
742 // FIXME: if we have "LaTeX" with a font
743 // change in the middle (before the 'T', then
744 // the "TeX" part is still special cased.
745 // Really we should only operate this on
746 // "words" for some definition of word
750 for (; pnr < phrases_nr; ++pnr) {
751 if (isTextAt(special_phrases[pnr].phrase, i)) {
752 os << special_phrases[pnr].macro;
753 i += special_phrases[pnr].phrase.length() - 1;
754 column += special_phrases[pnr].macro.length() - 1;
759 if (pnr == phrases_nr && c != '\0') {
768 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
769 LyXLayout const & layout) const
771 BufferParams const & bparams = features.bufferParams();
774 if (params.lineTop() || params.lineBottom())
775 features.require("lyxline");
776 if (!params.spacing().isDefault())
777 features.require("setspace");
780 features.useLayout(layout.name());
783 Language const * doc_language = bparams.language;
785 FontList::const_iterator fcit = fontlist.begin();
786 FontList::const_iterator fend = fontlist.end();
787 for (; fcit != fend; ++fcit) {
788 if (fcit->font().noun() == LyXFont::ON) {
789 lyxerr[Debug::LATEX] << "font.noun: "
790 << fcit->font().noun()
792 features.require("noun");
793 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
794 << fcit->font().stateText(0)
797 switch (fcit->font().color()) {
799 case LColor::inherit:
801 // probably we should put here all interface colors used for
802 // font displaying! For now I just add this ones I know of (Jug)
807 features.require("color");
808 lyxerr[Debug::LATEX] << "Color enabled. Font: "
809 << fcit->font().stateText(0)
813 Language const * language = fcit->font().language();
814 if (language->babel() != doc_language->babel() &&
815 language != ignore_language &&
816 language != latex_language)
818 features.useLanguage(language);
819 lyxerr[Debug::LATEX] << "Found language "
820 << language->babel() << endl;
824 if (!params.leftIndent().zero())
825 features.require("ParagraphLeftIndent");
828 InsetList::iterator icit = owner_->insetlist.begin();
829 InsetList::iterator iend = owner_->insetlist.end();
830 for (; icit != iend; ++icit) {
831 if (icit.getInset()) {
832 icit.getInset()->validate(features);
833 if (layout.needprotect &&
834 icit.getInset()->lyxCode() == Inset::FOOT_CODE)
835 features.require("NeedLyXFootnoteCode");
840 for (pos_type i = 0; i < size() ; ++i) {
841 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
842 if (!special_phrases[pnr].builtin
843 && isTextAt(special_phrases[pnr].phrase, i)) {
844 features.require(special_phrases[pnr].phrase);
852 LyXFont const Paragraph::Pimpl::realizeFont(LyXFont const & font,
853 BufferParams const & bparams) const
855 LyXFont tmpfont(font);
857 // check for environment font information
858 char par_depth = owner_->getDepth();
859 Paragraph const * par = owner_;
860 LyXTextClass const & tclass = bparams.getLyXTextClass();
862 while (par && par->getDepth() && !tmpfont.resolved()) {
863 par = par->outerHook();
865 tmpfont.realize(par->layout()->font);
866 par_depth = par->getDepth();
870 tmpfont.realize(tclass.defaultfont());