]> git.lyx.org Git - lyx.git/blobdiff - src/Paragraph.cpp
Consistent output of breakable/non-breakable dashes on all TeX engines.
[lyx.git] / src / Paragraph.cpp
index 77b5e902a8d110ca275aeca38f5a9ad9b1e65de3..a6c72c310e0b22a07b1251132133a1d02899041a 100644 (file)
@@ -52,6 +52,7 @@
 #include "insets/InsetBibitem.h"
 #include "insets/InsetLabel.h"
 #include "insets/InsetSpecialChar.h"
+#include "insets/InsetText.h"
 
 #include "mathed/InsetMathHull.h"
 
 using namespace std;
 using namespace lyx::support;
 
+// OSX clang, gcc < 4.8.0, and msvc < 2015 do not support C++11 thread_local
+#if defined(__APPLE__) || (defined(__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ < 8)
+#define THREAD_LOCAL_STATIC static __thread
+#elif defined(_MSC_VER) && (_MSC_VER < 1900)
+#define THREAD_LOCAL_STATIC static __declspec(thread)
+#else
+#define THREAD_LOCAL_STATIC thread_local static
+#endif
+
 namespace lyx {
 
 namespace {
@@ -77,7 +87,7 @@ namespace {
 /// Inset identifier (above 0x10ffff, for ucs-4)
 char_type const META_INSET = 0x200001;
 
-}
+} // namespace
 
 
 /////////////////////////////////////////////////////////////////////
@@ -387,7 +397,7 @@ public:
        typedef SkipPositions::const_iterator SkipPositionsIterator;
 
        void appendSkipPosition(SkipPositions & skips, pos_type const pos) const;
-       
+
        Language * getSpellLanguage(pos_type const from) const;
 
        Language * locateSpellRange(pos_type & from, pos_type & to,
@@ -402,7 +412,7 @@ public:
        }
 
        bool ignoreWord(docstring const & word) const ;
-       
+
        void setMisspelled(pos_type from, pos_type to, SpellChecker::Result state)
        {
                pos_type textsize = owner_->size();
@@ -1044,9 +1054,10 @@ void Paragraph::Private::latexInset(BufferParams const & bparams,
                        os << '\n';
                } else {
                        if (open_font) {
+                               bool needPar = false;
                                column += running_font.latexWriteEndChanges(
                                        os, bparams, runparams,
-                                       basefont, basefont);
+                                       basefont, basefont, needPar);
                                open_font = false;
                        }
 
@@ -1104,10 +1115,12 @@ void Paragraph::Private::latexInset(BufferParams const & bparams,
        bool arabtex = basefont.language()->lang() == "arabic_arabtex"
                || running_font.language()->lang() == "arabic_arabtex";
        if (open_font && !inset->inheritFont()) {
+               bool needPar = false;
                bool closeLanguage = arabtex
                        || basefont.isRightToLeft() == running_font.isRightToLeft();
                unsigned int count = running_font.latexWriteEndChanges(os,
-                       bparams, runparams, basefont, basefont, closeLanguage);
+                                       bparams, runparams, basefont, basefont,
+                                       needPar, closeLanguage);
                column += count;
                // if any font properties were closed, update the running_font,
                // making sure, however, to leave the language as it was
@@ -1234,8 +1247,8 @@ void Paragraph::Private::latexSpecialChar(otexstream & os,
                }
                break;
        case '\"':
-               os << "\\char34" << termcmd;
-               column += 9;
+               os << "\\textquotedbl" << termcmd;
+               column += 14;
                break;
 
        case '$': case '&':
@@ -1276,7 +1289,10 @@ void Paragraph::Private::latexSpecialChar(otexstream & os,
 
        case 0x2013:
        case 0x2014:
-               if (bparams.use_dash_ligatures && !bparams.useNonTeXFonts) {
+               // XeTeX's dash behaviour is determined via a global setting
+               if (bparams.use_dash_ligatures
+                   && owner_->getFontSettings(bparams, i).fontInfo().family() != TYPEWRITER_FAMILY
+                   && (!bparams.useNonTeXFonts || runparams.flavor != OutputParams::XETEX)) {
                        if (c == 0x2013) {
                                // en-dash
                                os << "--";
@@ -1404,6 +1420,14 @@ bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
                os << "\\textvertline" << termcmd;
                column += 14;
                return true;
+       case 0x2013:
+               os << "\\textendash" << termcmd;
+               column += 12;
+               return true;
+       case 0x2014:
+               os << "\\textemdash" << termcmd;
+               column += 12;
+               return true;
        default:
                return false;
        }
@@ -1412,11 +1436,11 @@ bool Paragraph::Private::latexSpecialT3(char_type const c, otexstream & os,
 
 void Paragraph::Private::validate(LaTeXFeatures & features) const
 {
+       Buffer const & buf = inset_owner_->buffer();
+       BufferParams const & bp = features.runparams().is_child
+               ? buf.masterParams() : buf.params();
        if (layout_->inpreamble && inset_owner_) {
                bool const is_command = layout_->latextype == LATEX_COMMAND;
-               Buffer const & buf = inset_owner_->buffer();
-               BufferParams const & bp = features.runparams().is_child
-                       ? buf.masterParams() : buf.params();
                Font f;
                // Using a string stream here circumvents the encoding
                // switching machinery of odocstream. Therefore the
@@ -1477,6 +1501,16 @@ void Paragraph::Private::validate(LaTeXFeatures & features) const
        for (; icit != iend; ++icit) {
                if (icit->inset) {
                        features.inDeletedInset(owner_->isDeleted(icit->pos));
+                       if (icit->inset->lyxCode() == FOOT_CODE) {
+                               // FIXME: an item inset would make things much easier.
+                               if ((layout_->latextype == LATEX_LIST_ENVIRONMENT
+                                    || (layout_->latextype == LATEX_ITEM_ENVIRONMENT
+                                        && layout_->margintype == MARGIN_FIRST_DYNAMIC))
+                                   && (icit->pos < begin_of_body_
+                                       || (icit->pos == begin_of_body_
+                                           && (icit->pos == 0 || text_[icit->pos - 1] != ' '))))
+                                       features.saveNoteEnv("description");
+                       }
                        icit->inset->validate(features);
                        features.inDeletedInset(false);
                        if (layout_->needprotect &&
@@ -1487,7 +1521,21 @@ void Paragraph::Private::validate(LaTeXFeatures & features) const
 
        // then the contents
        for (pos_type i = 0; i < int(text_.size()) ; ++i) {
-               BufferEncodings::validate(text_[i], features);
+               char_type c = text_[i];
+               if (c == 0x0022) {
+                       if (features.runparams().isFullUnicode() && bp.useNonTeXFonts)
+                               features.require("textquotedblp");
+                       else if (bp.main_font_encoding() != "T1"
+                                || ((&owner_->getFontSettings(bp, i))->language()->internalFontEncoding()))
+                               features.require("textquotedbl");
+               }
+               if (!bp.use_dash_ligatures
+                   && (c == 0x2013 || c == 0x2014)
+                   && bp.useNonTeXFonts
+                   && features.runparams().flavor == OutputParams::XETEX)
+                       // XeTeX's dash behaviour is determined via a global setting
+                       features.require("xetexdashbreakstate");
+               BufferEncodings::validate(c, features);
        }
 }
 
@@ -1556,7 +1604,7 @@ void flushString(ostream & os, docstring & s)
        s.erase();
 }
 
-}
+} // namespace
 
 
 void Paragraph::write(ostream & os, BufferParams const & bparams,
@@ -2187,7 +2235,7 @@ bool corrected_env(otexstream & os, string const & suffix, string const & env,
        return true;
 }
 
-} // namespace anon
+} // namespace
 
 
 int Paragraph::Private::startTeXParParams(BufferParams const & bparams,
@@ -2388,14 +2436,19 @@ void Paragraph::latex(BufferParams const & bparams,
                        column += d->startTeXParParams(bparams, os, runparams);
        }
 
+       // Whether a \par can be issued for insets typeset inline with text.
+       // Yes if greater than 0. This has to be static.
+       THREAD_LOCAL_STATIC int parInline = 0;
+
        for (pos_type i = 0; i < size(); ++i) {
                // First char in paragraph or after label?
                if (i == body_pos) {
                        if (body_pos > 0) {
                                if (open_font) {
+                                       bool needPar = false;
                                        column += running_font.latexWriteEndChanges(
                                                os, bparams, runparams,
-                                               basefont, basefont);
+                                               basefont, basefont, needPar);
                                        open_font = false;
                                }
                                basefont = getLayoutFont(bparams, outerfont);
@@ -2427,6 +2480,8 @@ void Paragraph::latex(BufferParams const & bparams,
                runparams.wasDisplayMath = runparams.inDisplayMath;
                runparams.inDisplayMath = false;
                bool deleted_display_math = false;
+               Change const & change = runparams.inDeletedInset
+                       ? runparams.changeOfDeletedInset : lookupChange(i);
 
                // Check whether a display math inset follows
                if (d->text_[i] == META_INSET
@@ -2441,15 +2496,34 @@ void Paragraph::latex(BufferParams const & bparams,
                                // cannot set it here because it is a counter.
                                deleted_display_math = isDeleted(i);
                        }
+                       if (bparams.output_changes && deleted_display_math
+                           && runningChange == change
+                           && change.type == Change::DELETED
+                           && !os.afterParbreak()) {
+                               // A display math in the same paragraph follows.
+                               // We have to close and then reopen \lyxdeleted,
+                               // otherwise the math will be shifted up.
+                               OutputParams rp = runparams;
+                               if (open_font) {
+                                       bool needPar = false;
+                                       column += running_font.latexWriteEndChanges(
+                                               os, bparams, rp, basefont,
+                                               basefont, needPar);
+                                       open_font = false;
+                               }
+                               basefont = getLayoutFont(bparams, outerfont);
+                               running_font = basefont;
+                               column += Changes::latexMarkChange(os, bparams,
+                                       Change(Change::INSERTED), change, rp);
+                       }
                }
 
-               Change const & change = runparams.inDeletedInset
-                       ? runparams.changeOfDeletedInset : lookupChange(i);
-
                if (bparams.output_changes && runningChange != change) {
                        if (open_font) {
+                               bool needPar = false;
                                column += running_font.latexWriteEndChanges(
-                                               os, bparams, runparams, basefont, basefont);
+                                               os, bparams, runparams,
+                                               basefont, basefont, needPar);
                                open_font = false;
                        }
                        basefont = getLayoutFont(bparams, outerfont);
@@ -2477,9 +2551,11 @@ void Paragraph::latex(BufferParams const & bparams,
                    (current_font != running_font ||
                     current_font.language() != running_font.language()))
                {
+                       bool needPar = false;
                        column += running_font.latexWriteEndChanges(
-                                       os, bparams, runparams, basefont,
-                                       (i == body_pos-1) ? basefont : current_font);
+                                   os, bparams, runparams, basefont,
+                                   (i == body_pos-1) ? basefont : current_font,
+                                   needPar);
                        running_font = basefont;
                        open_font = false;
                }
@@ -2489,15 +2565,18 @@ void Paragraph::latex(BufferParams const & bparams,
                // close babel's font environment before opening CJK.
                string const lang_end_command = runparams.use_polyglossia ?
                        "\\end{$$lang}" : lyxrc.language_command_end;
+               bool const using_begin_end = runparams.use_polyglossia ||
+                                               !lang_end_command.empty();
                if (!running_lang.empty() &&
+                   (!using_begin_end || running_lang == openLanguageName()) &&
                    current_font.language()->encoding()->package() == Encoding::CJK) {
                                string end_tag = subst(lang_end_command,
                                                        "$$lang",
                                                        running_lang);
                                os << from_ascii(end_tag);
                                column += end_tag.length();
-                               if (runparams.use_polyglossia)
-                                       popPolyglossiaLang();
+                               if (using_begin_end)
+                                       popLanguageName();
                }
 
                // Switch file encoding if necessary (and allowed)
@@ -2516,7 +2595,7 @@ void Paragraph::latex(BufferParams const & bparams,
                char_type const c = d->text_[i];
 
                // A display math inset inside an ulem command will be output
-               // as a box of width \columnwidth, so we have to either disable
+               // as a box of width \linewidth, so we have to either disable
                // indentation if the inset starts a paragraph, or start a new
                // line to accommodate such box. This has to be done before
                // writing any font changing commands.
@@ -2593,9 +2672,40 @@ void Paragraph::latex(BufferParams const & bparams,
                // and then split to handle the two modes separately.
                if (c == META_INSET) {
                        if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
+                               // Greyedout notes and, in general, all insets
+                               // with InsetLayout::isDisplay() == false,
+                               // are typeset inline with the text. So, we
+                               // can add a \par to the last paragraph of
+                               // such insets only if nothing else follows.
+                               bool incremented = false;
+                               Inset const * inset = getInset(i);
+                               InsetText const * textinset = inset
+                                                       ? inset->asInsetText()
+                                                       : 0;
+                               if (i + 1 == size() && textinset
+                                   && !inset->getLayout().isDisplay()) {
+                                       ParagraphList const & pars =
+                                               textinset->text().paragraphs();
+                                       pit_type const pit = pars.size() - 1;
+                                       Font const last_font =
+                                               pit < 0 || pars[pit].empty()
+                                               ? pars[pit].getLayoutFont(
+                                                               bparams,
+                                                               outerfont)
+                                               : pars[pit].getFont(bparams,
+                                                       pars[pit].size() - 1,
+                                                       outerfont);
+                                       if (last_font.fontInfo().size() !=
+                                           basefont.fontInfo().size()) {
+                                               ++parInline;
+                                               incremented = true;
+                                       }
+                               }
                                d->latexInset(bparams, os, rp, running_font,
                                                basefont, outerfont, open_font,
                                                runningChange, style, i, column);
+                               if (incremented)
+                                       --parInline;
                        }
                } else if (i >= start_pos && (end_pos == -1 || i < end_pos)) {
                        try {
@@ -2629,22 +2739,62 @@ void Paragraph::latex(BufferParams const & bparams,
 
        // If we have an open font definition, we have to close it
        if (open_font) {
+               // Make sure that \\par is done with the font of the last
+               // character if this has another size as the default.
+               // This is necessary because LaTeX (and LyX on the screen)
+               // calculates the space between the baselines according
+               // to this font. (Matthias)
+               //
+               // We must not change the font for the last paragraph
+               // of non-multipar insets, tabular cells or commands,
+               // since this produces unwanted whitespace.
+
+               Font const font = empty()
+                       ? getLayoutFont(bparams, outerfont)
+                       : getFont(bparams, size() - 1, outerfont);
+
+               InsetText const * textinset = inInset().asInsetText();
+
+               bool const maintext = textinset
+                       ? textinset->text().isMainText()
+                       : false;
+
+               size_t const numpars = textinset
+                       ? textinset->text().paragraphs().size()
+                       : 0;
+
+               bool needPar = false;
+
+               if (style.resfont.size() != font.fontInfo().size()
+                   && (!runparams.isLastPar || maintext
+                       || (numpars > 1 && d->ownerCode() != CELL_CODE
+                           && (inInset().getLayout().isDisplay()
+                               || parInline)))
+                   && !style.isCommand()) {
+                       needPar = true;
+               }
 #ifdef FIXED_LANGUAGE_END_DETECTION
                if (next_) {
                        running_font.latexWriteEndChanges(os, bparams,
                                        runparams, basefont,
-                                       next_->getFont(bparams, 0, outerfont));
+                                       next_->getFont(bparams, 0, outerfont),
+                                                      needPar);
                } else {
                        running_font.latexWriteEndChanges(os, bparams,
-                                       runparams, basefont, basefont);
+                                       runparams, basefont, basefont, needPar);
                }
 #else
 //FIXME: For now we ALWAYS have to close the foreign font settings if they are
 //FIXME: there as we start another \selectlanguage with the next paragraph if
 //FIXME: we are in need of this. This should be fixed sometime (Jug)
                running_font.latexWriteEndChanges(os, bparams, runparams,
-                               basefont, basefont);
+                               basefont, basefont, needPar);
 #endif
+               if (needPar) {
+                       // The \par could not be inserted at the same nesting
+                       // level of the font size change, so do it now.
+                       os << "{\\" << font.latexSize() << "\\par}";
+               }
        }
 
        column += Changes::latexMarkChange(os, bparams, runningChange,
@@ -2833,7 +2983,7 @@ void doFontSwitch(vector<html::FontTag> & tagsToOpen,
                flag = false;
        }
 }
-}
+} // namespace
 
 
 docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
@@ -2872,13 +3022,13 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
        FontShape  curr_fs   = INHERIT_SHAPE;
        FontFamily curr_fam  = INHERIT_FAMILY;
        FontSize   curr_size = FONT_SIZE_INHERIT;
-       
-       string const default_family = 
-               buf.masterBuffer()->params().fonts_default_family;              
+
+       string const default_family =
+               buf.masterBuffer()->params().fonts_default_family;
 
        vector<html::FontTag> tagsToOpen;
        vector<html::EndFontTag> tagsToClose;
-       
+
        // parsing main loop
        for (pos_type i = initial; i < size(); ++i) {
                // let's not show deleted material in the output
@@ -2901,7 +3051,7 @@ docstring Paragraph::simpleLyXHTMLOnePar(Buffer const & buf,
                curstate = font.fontInfo().underbar();
                if (font_old.underbar() != curstate)
                        doFontSwitch(tagsToOpen, tagsToClose, ubar_flag, curstate, html::FT_UBAR);
-       
+
                // strikeout
                curstate = font.fontInfo().strikeout();
                if (font_old.strikeout() != curstate)
@@ -3532,7 +3682,7 @@ int Paragraph::fixBiblio(Buffer const & buffer)
                                         InsetCommandParams(BIBITEM_CODE));
 
        Font font(inherit_font, buffer.params().language);
-       insertInset(0, inset, font, Change(track_changes ? Change::INSERTED 
+       insertInset(0, inset, font, Change(track_changes ? Change::INSERTED
                                                   : Change::UNCHANGED));
 
        return 1;
@@ -3569,7 +3719,7 @@ InsetList const & Paragraph::insetList() const
 }
 
 
-void Paragraph::setBuffer(Buffer & b)
+void Paragraph::setInsetBuffers(Buffer & b)
 {
        d->insetlist_.setBuffer(b);
 }
@@ -3767,13 +3917,13 @@ void Paragraph::locateWord(pos_type & from, pos_type & to,
                        to = from;
                        return;
                }
-               // no break here, we go to the next
+               // fall through
 
        case WHOLE_WORD:
                // If we are already at the beginning of a word, do nothing
                if (!from || isWordSeparator(from - 1))
                        break;
-               // no break here, we go to the next
+               // fall through
 
        case PREVIOUS_WORD:
                // always move the cursor to the beginning of previous word