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 // This is in the critical path for loading!
256 pos_type const siz = size();
257 lyx::Assert(pos <= siz);
258 // This is stronger, and I belive that this is the assertion
259 // that we should really use. (Lgb)
260 //Assert(pos < size());
262 // Then this has no meaning. (Lgb)
263 if (!siz || pos == siz) {
264 lyxerr << "getChar() on pos " << pos << " in par id "
265 << owner_->id() << " of size " << siz
266 << " is a bit silly !" << endl;
274 void Paragraph::Pimpl::setChar(pos_type pos, value_type c)
281 void Paragraph::Pimpl::insertChar(pos_type pos, value_type c,
282 LyXFont const & font, Change change)
284 lyx::Assert(pos <= size());
287 changes_->record(change, pos);
290 // This is actually very common when parsing buffers (and
291 // maybe inserting ascii text)
293 // when appending characters, no need to update tables
295 owner_->setFont(pos, font);
299 text.insert(text.begin() + pos, c);
301 // Update the font table.
302 FontTable search_font(pos, LyXFont());
303 for (FontList::iterator it = lower_bound(fontlist.begin(),
305 search_font, matchFT());
306 it != fontlist.end(); ++it)
308 it->pos(it->pos() + 1);
312 owner_->insetlist.increasePosAfterPos(pos);
314 owner_->setFont(pos, font);
318 void Paragraph::Pimpl::insertInset(pos_type pos,
319 Inset * inset, LyXFont const & font, Change change)
322 lyx::Assert(pos <= size());
324 insertChar(pos, META_INSET, font, change);
325 lyx::Assert(text[pos] == META_INSET);
327 // Add a new entry in the insetlist.
328 owner_->insetlist.insert(inset, pos);
329 inset->parOwner(owner_);
332 inset->setOwner(inset_owner);
336 bool Paragraph::Pimpl::erasePos(pos_type pos)
338 lyx::Assert(pos < size());
341 Change::Type changetype(changes_->lookup(pos));
342 changes_->record(Change(Change::DELETED), pos);
344 // only allow the actual removal if it was /new/ text
345 if (changetype != Change::INSERTED) {
346 if (text[pos] == Paragraph::META_INSET) {
347 Inset * i(owner_->getInset(pos));
359 void Paragraph::Pimpl::eraseIntern(pos_type pos)
361 // if it is an inset, delete the inset entry
362 if (text[pos] == Paragraph::META_INSET) {
363 owner_->insetlist.erase(pos);
366 text.erase(text.begin() + pos);
368 // Erase entries in the tables.
369 FontTable search_font(pos, LyXFont());
371 FontList::iterator it =
372 lower_bound(fontlist.begin(),
374 search_font, matchFT());
375 if (it != fontlist.end() && it->pos() == pos &&
377 (it != fontlist.begin()
378 && boost::prior(it)->pos() == pos - 1))) {
379 // If it is a multi-character font
380 // entry, we just make it smaller
381 // (see update below), otherwise we
383 unsigned int const i = it - fontlist.begin();
384 fontlist.erase(fontlist.begin() + i);
385 it = fontlist.begin() + i;
386 if (i > 0 && i < fontlist.size() &&
387 fontlist[i - 1].font() == fontlist[i].font()) {
388 fontlist.erase(fontlist.begin() + i - 1);
389 it = fontlist.begin() + i - 1;
393 // Update all other entries.
394 FontList::iterator fend = fontlist.end();
395 for (; it != fend; ++it)
396 it->pos(it->pos() - 1);
398 // Update the insetlist.
399 owner_->insetlist.decreasePosAfterPos(pos);
403 void Paragraph::Pimpl::erase(pos_type pos)
409 bool Paragraph::Pimpl::erase(pos_type start, pos_type end)
412 pos_type count = end - start;
413 bool any_erased = false;
427 void Paragraph::Pimpl::simpleTeXBlanks(ostream & os, TexRow & texrow,
429 unsigned int & column,
430 LyXFont const & font,
431 LyXLayout const & style)
433 if (style.pass_thru) return;
434 if (column > lyxrc.ascii_linelen
436 && getChar(i - 1) != ' '
438 // same in FreeSpacing mode
439 && !style.free_spacing
440 && !owner_->isFreeSpacing()
441 // In typewriter mode, we want to avoid
442 // ! . ? : at the end of a line
443 && !(font.family() == LyXFont::TYPEWRITER_FAMILY
444 && (getChar(i - 1) == '.'
445 || getChar(i - 1) == '?'
446 || getChar(i - 1) == ':'
447 || getChar(i - 1) == '!'))) {
450 texrow.start(owner_, i + 1);
452 } else if (style.free_spacing) {
460 bool Paragraph::Pimpl::isTextAt(string const & str, pos_type pos) const
462 pos_type const len = str.length();
464 // is the paragraph large enough?
465 if (pos + len > size())
468 // does the wanted text start at point?
469 for (string::size_type i = 0; i < str.length(); ++i) {
470 if (str[i] != text[pos + i])
474 // is there a font change in middle of the word?
475 FontList::const_iterator cit = fontlist.begin();
476 FontList::const_iterator end = fontlist.end();
477 for (; cit != end; ++cit) {
478 if (cit->pos() >= pos)
481 if (cit != end && pos + len - 1 > cit->pos())
488 void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
489 BufferParams const & bparams,
494 LyXFont & running_font,
497 Change::Type & running_change,
498 LyXLayout const & style,
500 unsigned int & column,
503 if (style.pass_thru) {
509 // Two major modes: LaTeX or plain
510 // Handle here those cases common to both modes
511 // and then split to handle the two modes separately.
513 case Paragraph::META_INSET: {
514 Inset * inset = owner_->getInset(i);
516 // FIXME: remove this check
520 if (inset->isTextInset()) {
521 column += Changes::latexMarkChange(os, running_change,
523 running_change = Change::UNCHANGED;
527 int const len = os.tellp();
528 //ostream::pos_type const len = os.tellp();
529 if ((inset->lyxCode() == Inset::GRAPHICS_CODE
530 || inset->lyxCode() == Inset::MATH_CODE
531 || inset->lyxCode() == Inset::URL_CODE)
532 && running_font.isRightToLeft()) {
538 #warning Bug: we can have an empty font change here!
539 // if there has just been a font change, we are going to close it
540 // right now, which means stupid latex code like \textsf{}. AFAIK,
541 // this does not harm dvi output. A minor bug, thus (JMarc)
543 // some insets cannot be inside a font change command
544 if (open_font && inset->noFontChange()) {
545 column +=running_font.
546 latexWriteEndChanges(os,
550 basefont = owner_->getLayoutFont(bparams);
551 running_font = basefont;
554 int tmp = inset->latex(buf, os, moving_arg,
561 for (int j = 0; j < tmp; ++j) {
564 texrow.start(owner_, i + 1);
567 column += int(os.tellp()) - len;
572 case Paragraph::META_NEWLINE:
574 column += running_font.latexWriteEndChanges(os,
579 basefont = owner_->getLayoutFont(bparams);
580 running_font = basefont;
584 // And now for the special cases within each mode
588 os << "\\textbackslash{}";
592 case '±': case '²': case '³':
593 case '×': case '÷': case '¹':
595 if ((bparams.inputenc == "latin1" ||
596 bparams.inputenc == "latin9") ||
597 (bparams.inputenc == "auto" &&
598 (font.language()->encoding()->LatexName()
600 font.language()->encoding()->LatexName()
602 os << "\\ensuremath{"
611 case '|': case '<': case '>':
612 // In T1 encoding, these characters exist
613 if (lyxrc.fontenc == "T1") {
615 //... but we should avoid ligatures
616 if ((c == '>' || c == '<')
618 && getChar(i + 1) == c) {
619 //os << "\\textcompwordmark{}";
620 // Jean-Marc, have a look at
621 // this. I think this works
629 // Typewriter font also has them
630 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
634 // Otherwise, we use what LaTeX
638 os << "\\textless{}";
642 os << "\\textgreater{}";
652 case '-': // "--" in Typewriter mode -> "-{}-"
654 && getChar(i + 1) == '-'
655 && font.family() == LyXFont::TYPEWRITER_FAMILY) {
664 os << "\\char`\\\"{}";
669 if (bparams.inputenc == "default") {
678 case '%': case '#': case '{':
685 os << "\\textasciitilde{}";
690 os << "\\textasciicircum{}";
694 case '*': case '[': case ']':
695 // avoid being mistaken for optional arguments
696 os << '{' << c << '}';
701 // Blanks are printed before font switching.
702 // Sure? I am not! (try nice-latex)
703 // I am sure it's correct. LyX might be smarter
704 // in the future, but for now, nothing wrong is
710 // I assume this is hack treating typewriter as verbatim
711 if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
720 // FIXME: if we have "LaTeX" with a font
721 // change in the middle (before the 'T', then
722 // the "TeX" part is still special cased.
723 // Really we should only operate this on
724 // "words" for some definition of word
728 for (; pnr < phrases_nr; ++pnr) {
729 if (isTextAt(special_phrases[pnr].phrase, i)) {
730 os << special_phrases[pnr].macro;
731 i += special_phrases[pnr].phrase.length() - 1;
732 column += special_phrases[pnr].macro.length() - 1;
737 if (pnr == phrases_nr && c != '\0') {
746 void Paragraph::Pimpl::validate(LaTeXFeatures & features,
747 LyXLayout const & layout) const
749 BufferParams const & bparams = features.bufferParams();
752 if (params.lineTop() || params.lineBottom())
753 features.require("lyxline");
754 if (!params.spacing().isDefault())
755 features.require("setspace");
758 features.useLayout(layout.name());
761 Language const * doc_language = bparams.language;
763 FontList::const_iterator fcit = fontlist.begin();
764 FontList::const_iterator fend = fontlist.end();
765 for (; fcit != fend; ++fcit) {
766 if (fcit->font().noun() == LyXFont::ON) {
767 lyxerr[Debug::LATEX] << "font.noun: "
768 << fcit->font().noun()
770 features.require("noun");
771 lyxerr[Debug::LATEX] << "Noun enabled. Font: "
772 << fcit->font().stateText(0)
775 switch (fcit->font().color()) {
777 case LColor::inherit:
779 // probably we should put here all interface colors used for
780 // font displaying! For now I just add this ones I know of (Jug)
785 features.require("color");
786 lyxerr[Debug::LATEX] << "Color enabled. Font: "
787 << fcit->font().stateText(0)
791 Language const * language = fcit->font().language();
792 if (language->babel() != doc_language->babel() &&
793 language != ignore_language &&
794 language != latex_language)
796 features.useLanguage(language);
797 lyxerr[Debug::LATEX] << "Found language "
798 << language->babel() << endl;
802 if (!params.leftIndent().zero())
803 features.require("ParagraphLeftIndent");
806 InsetList::iterator icit = owner_->insetlist.begin();
807 InsetList::iterator iend = owner_->insetlist.end();
808 for (; icit != iend; ++icit) {
809 if (icit.getInset()) {
810 icit.getInset()->validate(features);
811 if (layout.needprotect &&
812 icit.getInset()->lyxCode() == Inset::FOOT_CODE)
813 features.require("NeedLyXFootnoteCode");
818 for (pos_type i = 0; i < size() ; ++i) {
819 for (size_t pnr = 0; pnr < phrases_nr; ++pnr) {
820 if (!special_phrases[pnr].builtin
821 && isTextAt(special_phrases[pnr].phrase, i)) {
822 features.require(special_phrases[pnr].phrase);
830 LyXFont const Paragraph::Pimpl::realizeFont(LyXFont const & font,
831 BufferParams const & bparams) const
833 LyXFont tmpfont(font);
835 // check for environment font information
836 char par_depth = owner_->getDepth();
837 Paragraph const * par = owner_;
838 LyXTextClass const & tclass = bparams.getLyXTextClass();
840 while (par && par->getDepth() && !tmpfont.resolved()) {
841 par = par->outerHook();
843 tmpfont.realize(par->layout()->font);
844 par_depth = par->getDepth();
848 tmpfont.realize(tclass.defaultfont());