]> git.lyx.org Git - lyx.git/blobdiff - src/output_latex.cpp
Back to development
[lyx.git] / src / output_latex.cpp
index f23fbda293470375ff479d9f01c5da10a806293a..4589b3795b1368a10c90d8f92e4b8abf0e90fcae 100644 (file)
@@ -19,8 +19,6 @@
 #include "Font.h"
 #include "InsetList.h"
 #include "Language.h"
-#include "LaTeXFeatures.h"
-#include "Layout.h"
 #include "LyXRC.h"
 #include "OutputParams.h"
 #include "Paragraph.h"
@@ -37,7 +35,6 @@
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/lstrings.h"
-#include "support/lyxalgo.h"
 #include "support/textutils.h"
 #include "support/gettext.h"
 
@@ -63,16 +60,16 @@ enum OpenEncoding {
 
 struct OutputState
 {
-       OutputState() : open_encoding_(none), cjk_inherited_(0),
-               prev_env_language_(nullptr), nest_level_(0)
+       OutputState() : prev_env_language_(nullptr), open_encoding_(none),
+               cjk_inherited_(0), nest_level_(0)
        {
        }
-       OpenEncoding open_encoding_;
-       int cjk_inherited_;
        Language const * prev_env_language_;
-       int nest_level_;
        stack<int> lang_switch_depth_;          // Both are always empty when
        stack<string> open_polyglossia_lang_;   // not using polyglossia
+       OpenEncoding open_encoding_;
+       int cjk_inherited_;
+       int nest_level_;
 };
 
 
@@ -109,7 +106,7 @@ bool atSameLastLangSwitchDepth(OutputState const * state)
        // commands. Instead, return always true when using babel with
        // only a begin command.
 
-       return state->lang_switch_depth_.size() == 0
+       return state->lang_switch_depth_.empty()
                        ? true
                        : abs(state->lang_switch_depth_.top()) == state->nest_level_;
 }
@@ -119,7 +116,7 @@ bool isLocalSwitch(OutputState const * state)
 {
        // Return true if the language was opened by a local command switch.
 
-       return state->lang_switch_depth_.size()
+       return !state->lang_switch_depth_.empty()
                && state->lang_switch_depth_.top() < 0;
 }
 
@@ -128,7 +125,7 @@ bool langOpenedAtThisLevel(OutputState const * state)
 {
        // Return true if the language was opened at the current nesting level.
 
-       return state->lang_switch_depth_.size()
+       return !state->lang_switch_depth_.empty()
                && abs(state->lang_switch_depth_.top()) == state->nest_level_;
 }
 
@@ -164,10 +161,10 @@ string const getPolyglossiaBegin(string const & lang_begin_command,
 
 struct TeXEnvironmentData
 {
-       bool cjk_nested;
        Layout const * style;
        Language const * par_language;
        Encoding const * prev_encoding;
+       bool cjk_nested;
        bool leftindent_open;
 };
 
@@ -241,7 +238,7 @@ static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
                // polyglossia or begin/end commands, then the current
                // language is the document language.
                string const & cur_lang = using_begin_end
-                                         && state->lang_switch_depth_.size()
+                                         && !state->lang_switch_depth_.empty()
                                                  ? openLanguageName(state)
                                                  : doc_lang;
 
@@ -352,6 +349,11 @@ static void finishEnvironment(otexstream & os, OutputParams const & runparams,
                                popLanguageName();
                        }
                }
+               if (data.style->latextype == LATEX_BIB_ENVIRONMENT)
+                       // bibliography needs a blank line after
+                       // each item for backref to function properly
+                       // (see #12041)
+                       os << '\n';
                state->nest_level_ -= 1;
                string const & name = data.style->latexname();
                if (!name.empty())
@@ -436,15 +438,20 @@ void TeXEnvironment(Buffer const & buf, Text const & text,
 
                // Do not output empty environments if the whole paragraph has
                // been deleted with ct and changes are not output.
+               bool output_changes;
+               if (runparams.for_searchAdv == OutputParams::NoSearch)
+                       output_changes = buf.params().output_changes;
+               else
+                       output_changes = (runparams.for_searchAdv == OutputParams::SearchWithDeleted);
                if (size_t(pit + 1) < paragraphs.size()) {
                        ParagraphList::const_iterator nextpar = paragraphs.iterator_at(pit + 1);
                        Paragraph const & cpar = paragraphs.at(pit);
                        if ((par->layout() != nextpar->layout()
                             || par->params().depth() == nextpar->params().depth()
                             || par->params().leftIndent() == nextpar->params().leftIndent())
-                           && !runparams.for_search && cpar.size() > 0
-                           && cpar.isDeleted(0, cpar.size()) && !buf.params().output_changes) {
-                               if (!buf.params().output_changes && !cpar.parEndChange().deleted())
+                           && !cpar.empty()
+                           && cpar.isDeleted(0, cpar.size()) && !output_changes) {
+                               if (!output_changes && !cpar.parEndChange().deleted())
                                        os << '\n' << '\n';
                                continue;
                        }
@@ -464,9 +471,9 @@ void TeXEnvironment(Buffer const & buf, Text const & text,
 
 
 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
-                 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
+                 map<size_t, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
 {
-       unsigned int const argnr = latexargs.size();
+       size_t const argnr = latexargs.size();
        if (argnr == 0)
                return;
 
@@ -480,16 +487,16 @@ void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeX
                        }
        }
 
-       for (unsigned int i = 1; i <= argnr; ++i) {
-               map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
+       for (size_t i = 1; i <= argnr; ++i) {
+               map<size_t, InsetArgument const *>::const_iterator lit = ilist.find(i);
                bool inserted = false;
                if (lit != ilist.end()) {
-                       InsetArgument const * ins = (*lit).second;
+                       InsetArgument const * ins = lit->second;
                        if (ins) {
                                Layout::LaTeXArgMap::const_iterator const lait =
                                                latexargs.find(ins->name());
                                if (lait != latexargs.end()) {
-                                       Layout::latexarg arg = (*lait).second;
+                                       Layout::latexarg arg = lait->second;
                                        docstring ldelim;
                                        docstring rdelim;
                                        if (!arg.nodelims) {
@@ -547,7 +554,7 @@ void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeX
                        }
                }
        }
-       if (runparams.for_search) {
+       if ((runparams.for_searchAdv != OutputParams::NoSearch) && argnr > 1) {
                // Mark end of arguments for findadv() only
                os << "\\endarguments{}";
        }
@@ -588,7 +595,7 @@ namespace {
 
 void addArgInsets(Paragraph const & par, string const & prefix,
                  Layout::LaTeXArgMap const & latexargs,
-                 map<int, InsetArgument const *> & ilist,
+                 map<size_t, InsetArgument const *> & ilist,
                  vector<string> & required)
 {
        for (auto const & table : par.insetList()) {
@@ -601,10 +608,8 @@ void addArgInsets(Paragraph const & par, string const & prefix,
                }
                string const name = prefix.empty() ?
                        arg->name() : split(arg->name(), ':');
-               // why converting into an integer?
-               unsigned int const nr = convert<unsigned int>(name);
-               if (ilist.find(nr) == ilist.end())
-                       ilist[nr] = arg;
+               size_t const nr = convert<size_t>(name);
+               ilist.insert({nr, arg});
                Layout::LaTeXArgMap::const_iterator const lit =
                        latexargs.find(arg->name());
                if (lit != latexargs.end()) {
@@ -623,7 +628,7 @@ void latexArgInsets(Paragraph const & par, otexstream & os,
                     Layout::LaTeXArgMap const & latexargs,
                     string const & prefix)
 {
-       map<int, InsetArgument const *> ilist;
+       map<size_t, InsetArgument const *> ilist;
        vector<string> required;
        addArgInsets(par, prefix, latexargs, ilist, required);
        getArgInsets(os, runparams, latexargs, ilist, required, prefix);
@@ -636,7 +641,7 @@ void latexArgInsets(ParagraphList const & pars,
                     Layout::LaTeXArgMap const & latexargs,
                     string const & prefix)
 {
-       map<int, InsetArgument const *> ilist;
+       map<size_t, InsetArgument const *> ilist;
        vector<string> required;
 
        depth_type const current_depth = pit->params().depth();
@@ -656,7 +661,6 @@ void latexArgInsets(ParagraphList const & pars,
        }
 
        ParagraphList::const_iterator spit = prev(pit, offset);
-
        for (; spit != pars.end(); ++spit) {
                if (spit->layout() != current_layout ||
                    spit->params().depth() < current_depth)
@@ -674,7 +678,7 @@ void latexArgInsetsForParent(ParagraphList const & pars, otexstream & os,
                              Layout::LaTeXArgMap const & latexargs,
                              string const & prefix)
 {
-       map<int, InsetArgument const *> ilist;
+       map<size_t, InsetArgument const *> ilist;
        vector<string> required;
 
        for (Paragraph const & par : pars) {
@@ -710,7 +714,7 @@ void parStartCommand(Paragraph const & par, otexstream & os,
                break;
        case LATEX_ITEM_ENVIRONMENT:
        case LATEX_LIST_ENVIRONMENT:
-               if (runparams.for_search) {
+               if (runparams.for_searchAdv != OutputParams::NoSearch) {
                        os << "\\" + style.itemcommand() << "{" << style.latexname() << "}";
                }
                else {
@@ -722,7 +726,7 @@ void parStartCommand(Paragraph const & par, otexstream & os,
                }
                break;
        case LATEX_ENVIRONMENT:
-               if (runparams.for_search) {
+               if (runparams.for_searchAdv != OutputParams::NoSearch) {
                        os << "\\latexenvironment{" << style.latexname() << "}{";
                }
                break;
@@ -760,8 +764,8 @@ void TeXOnePar(Buffer const & buf,
 
        // Do not output empty commands if the whole paragraph has
        // been deleted with ct and changes are not output.
-       if (!runparams_in.for_search && style.latextype != LATEX_ENVIRONMENT
-           && par.size() > 0 && par.isDeleted(0, par.size()) && !bparams.output_changes)
+       if ((runparams_in.for_searchAdv != OutputParams::SearchWithDeleted) && style.latextype != LATEX_ENVIRONMENT
+           && !par.empty() && par.isDeleted(0, par.size()) && !bparams.output_changes)
                return;
 
        LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
@@ -898,7 +902,7 @@ void TeXOnePar(Buffer const & buf,
                }
        }
        Language const * const prev_language =
-               runparams_in.for_search 
+               runparams_in.for_searchAdv != OutputParams::NoSearch
                        ? languages.getLanguage("ignore")
                        : (prior_nontitle_par && !prior_nontitle_par->isPassThru())
                                ? (use_prev_env_language 
@@ -948,7 +952,7 @@ void TeXOnePar(Buffer const & buf,
                && outer_language->rightToLeft()
                && !par_language->rightToLeft();
        bool const localswitch =
-                       (runparams_in.for_search
+                       (runparams_in.for_searchAdv != OutputParams::NoSearch
                        || text.inset().forceLocalFontSwitch()
                        || (using_begin_end && text.inset().forcePlainLayout())
                        || in_polyglossia_rtl_env)
@@ -963,7 +967,7 @@ void TeXOnePar(Buffer const & buf,
        bool const localswitch_needed = localswitch && par_lang != outer_lang;
 
        // localswitches need to be closed and reopened at each par
-       if (runparams_in.for_search || ((par_lang != prev_lang || localswitch_needed)
+       if ((runparams_in.for_searchAdv != OutputParams::NoSearch) || ((par_lang != prev_lang || localswitch_needed)
             // check if we already put language command in TeXEnvironment()
             && !(style.isEnvironment()
                  && (pit == 0 || (priorpar->layout() != par.layout()
@@ -1031,7 +1035,7 @@ void TeXOnePar(Buffer const & buf,
                        // With CJK, the CJK tag has to be closed first (see below)
                        if ((runparams.encoding->package() != Encoding::CJK
                                 || bparams.useNonTeXFonts
-                                || runparams.for_search)
+                                || (runparams.for_searchAdv != OutputParams::NoSearch))
                            && (par_lang != openLanguageName(state) || localswitch || intitle_command)
                            && !par_lang.empty()) {
                                string bc = use_polyglossia ?
@@ -1272,7 +1276,7 @@ void TeXOnePar(Buffer const & buf,
                // when the paragraph uses CJK, the language has to be closed earlier
                if ((font.language()->encoding()->package() != Encoding::CJK)
                        || bparams.useNonTeXFonts
-                       || runparams_in.for_search) {
+                       || (runparams_in.for_searchAdv != OutputParams::NoSearch)) {
                        if (lang_end_command.empty()) {
                                // If this is a child, we should restore the
                                // master language after the last paragraph.
@@ -1312,7 +1316,7 @@ void TeXOnePar(Buffer const & buf,
                                                && nextpar
                                                && style != nextpar->layout())))
                                    || (atSameLastLangSwitchDepth(state)
-                                       && state->lang_switch_depth_.size()
+                                       && !state->lang_switch_depth_.empty()
                                        && cur_lang != par_lang)
                                    || in_polyglossia_rtl_env)
                                {
@@ -1355,7 +1359,7 @@ void TeXOnePar(Buffer const & buf,
        }
 
        bool const last_was_separator =
-               par.size() > 0 && par.isEnvSeparator(par.size() - 1);
+               !par.empty() && par.isEnvSeparator(par.size() - 1);
 
        // Signify added/deleted par break in output if show changes in output
        if (nextpar && !os.afterParbreak() && !last_was_separator
@@ -1442,18 +1446,21 @@ void TeXOnePar(Buffer const & buf,
 
        // Also pass the post_macros upstream
        runparams_in.post_macro = runparams.post_macro;
+       // These need to be passed upstream as well
+       runparams_in.need_maketitle = runparams.need_maketitle;
+       runparams_in.have_maketitle = runparams.have_maketitle;
 
 
        // we don't need a newline for the last paragraph!!!
        // Note from JMarc: we will re-add a \n explicitly in
        // TeXEnvironment, because it is needed in this case
        if (nextpar && !os.afterParbreak() && !last_was_separator) {
-               Layout const & next_layout = nextpar->layout();
                if (!text.inset().getLayout().parbreakIgnored() && !merged_par)
                        // Make sure to start a new line
                        os << breakln;
                // A newline '\n' is always output before a command,
                // so avoid doubling it.
+               Layout const & next_layout = nextpar->layout();
                if (!next_layout.isCommand()) {
                        // Here we now try to avoid spurious empty lines by
                        // outputting a paragraph break only if: (case 1) the
@@ -1495,8 +1502,15 @@ void TeXOnePar(Buffer const & buf,
                                && tclass.isDefaultLayout(next_layout))) {
                                // and omit paragraph break if it has been deleted with ct
                                // and changes are not shown in output
-                               if (!merged_par)
-                                       os << '\n';
+                               if (!merged_par) {
+                                       if (runparams.isNonLong)
+                                               // This is to allow parbreak in multirow
+                                               // It could also be used for other non-long
+                                               // contexts
+                                               os << "\\endgraf\n";
+                                       else
+                                               os << '\n';
+                               }
                        }
                }
        }
@@ -1586,15 +1600,12 @@ void latexParagraphs(Buffer const & buf,
                // The full doc will be exported but it is easier to just rely on
                // runparams range parameters that will be passed TeXEnvironment.
                runparams.par_begin = 0;
-               runparams.par_end = paragraphs.size();
+               runparams.par_end = static_cast<int>(paragraphs.size());
        }
 
        pit_type pit = runparams.par_begin;
        // lastpit is for the language check after the loop.
        pit_type lastpit = pit;
-       // variables used in the loop:
-       bool was_title = false;
-       bool already_title = false;
        DocumentClass const & tclass = bparams.documentClass();
 
        // Did we already warn about inTitle layout mixing? (we only warn once)
@@ -1609,7 +1620,7 @@ void latexParagraphs(Buffer const & buf,
                                tclass.plainLayout() : par->layout();
 
                if (layout.intitle) {
-                       if (already_title) {
+                       if (runparams.have_maketitle) {
                                if (!gave_layout_warning && !runparams.dryrun) {
                                        gave_layout_warning = true;
                                        frontend::Alert::warning(_("Error in latexParagraphs"),
@@ -1619,15 +1630,16 @@ void latexParagraphs(Buffer const & buf,
                                                          "could lead to missing or incorrect output."
                                                          ), layout.name()));
                                }
-                       } else if (!was_title) {
-                               was_title = true;
+                       } else if (!runparams.need_maketitle) {
+                               runparams.need_maketitle = true;
                                if (tclass.titletype() == TITLE_ENVIRONMENT) {
                                        os << "\\begin{"
                                                        << from_ascii(tclass.titlename())
                                                        << "}\n";
                                }
                        }
-               } else if (was_title && !already_title && !layout.inpreamble) {
+               } else if (runparams.need_maketitle && !runparams.have_maketitle
+                          && !layout.inpreamble && !text.inset().isInTitle()) {
                        if (tclass.titletype() == TITLE_ENVIRONMENT) {
                                os << "\\end{" << from_ascii(tclass.titlename())
                                                << "}\n";
@@ -1636,8 +1648,8 @@ void latexParagraphs(Buffer const & buf,
                                os << "\\" << from_ascii(tclass.titlename())
                                                << "\n";
                        }
-                       already_title = true;
-                       was_title = false;
+                       runparams.have_maketitle = true;
+                       runparams.need_maketitle = false;
                }
 
                if (layout.isCommand() && !layout.latexname().empty()
@@ -1659,15 +1671,29 @@ void latexParagraphs(Buffer const & buf,
 
                // Do not output empty environments if the whole paragraph has
                // been deleted with ct and changes are not output.
+               bool output_changes;
+               if (runparams.for_searchAdv == OutputParams::NoSearch)
+                       output_changes = bparams.output_changes;
+               else
+                       output_changes = (runparams.for_searchAdv == OutputParams::SearchWithDeleted);
                if (size_t(pit + 1) < paragraphs.size()) {
                        ParagraphList::const_iterator nextpar = paragraphs.iterator_at(pit + 1);
                        Paragraph const & cpar = paragraphs.at(pit);
                        if ((par->layout() != nextpar->layout()
                             || par->params().depth() == nextpar->params().depth()
                             || par->params().leftIndent() == nextpar->params().leftIndent())
-                           && !runparams.for_search && cpar.size() > 0
-                           && cpar.isDeleted(0, cpar.size()) && !bparams.output_changes) {
-                               if (!bparams.output_changes && !cpar.parEndChange().deleted())
+                           && !cpar.empty()
+                           && cpar.isDeleted(0, cpar.size()) && !output_changes) {
+                               if (!cpar.parEndChange().deleted())
+                                       os << '\n' << '\n';
+                               continue;
+                       }
+               } else {
+                       // This is the last par
+                       Paragraph const & cpar = paragraphs.at(pit);
+                       if ( !cpar.empty()
+                           && cpar.isDeleted(0, cpar.size()) && !output_changes) {
+                               if (!cpar.parEndChange().deleted())
                                        os << '\n' << '\n';
                                continue;
                        }
@@ -1689,10 +1715,10 @@ void latexParagraphs(Buffer const & buf,
        }
 
        // It might be that we only have a title in this document.
-       // But if we're in a branch, this is not the end of
+       // But if we're in an inset, this is not the end of
        // the document. (There may be some other checks of this
        // kind that are needed.)
-       if (was_title && !already_title && !runparams.inbranch) {
+       if (runparams.need_maketitle && !runparams.have_maketitle && maintext) {
                if (tclass.titletype() == TITLE_ENVIRONMENT) {
                        os << "\\end{" << from_ascii(tclass.titlename())
                           << "}\n";
@@ -1791,7 +1817,7 @@ pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
                || oldEnc.package() == Encoding::japanese
                || oldEnc.package() == Encoding::none
                || newEnc.package() == Encoding::none
-               || runparams.for_search)
+               || (runparams.for_searchAdv != OutputParams::NoSearch))
                return make_pair(false, 0);
        // FIXME We ignore encoding switches from/to encodings that do
        // neither support the inputenc package nor the CJK package here.
@@ -1814,7 +1840,7 @@ pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
                        // shouldn't ever reach here (see above) but avoids warning.
                        return make_pair(true, 0);
                case Encoding::inputenc: {
-                       int count = inputenc_arg.length();
+                       size_t count = inputenc_arg.length();
                        if (oldEnc.package() == Encoding::CJK &&
                            state->open_encoding_ == CJK) {
                                os << "\\end{CJK}";
@@ -1842,7 +1868,7 @@ pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
                        return make_pair(true, count + 16);
                }
                case Encoding::CJK: {
-                       int count = inputenc_arg.length();
+                       size_t count = inputenc_arg.length();
                        if (oldEnc.package() == Encoding::CJK &&
                            state->open_encoding_ == CJK) {
                                os << "\\end{CJK}";