X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetListings.cpp;h=b847131f57acb95002b3e707dc73fea573e045f3;hb=62b06c64ed624d51cce785e083d59cab18b36b69;hp=c10c54bdd1455f0a886faffb6ed0832b5d75bcd5;hpb=1ef605f6254ef3f3b8cec5440a2e67e6f23a707b;p=lyx.git diff --git a/src/insets/InsetListings.cpp b/src/insets/InsetListings.cpp index c10c54bdd1..b847131f57 100644 --- a/src/insets/InsetListings.cpp +++ b/src/insets/InsetListings.cpp @@ -30,6 +30,8 @@ #include "output_xhtml.h" #include "OutputParams.h" #include "TextClass.h" +#include "TexRow.h" +#include "texstream.h" #include "support/debug.h" #include "support/docstream.h" @@ -50,12 +52,10 @@ using namespace lyx::support; namespace lyx { -char const lstinline_delimiters[] = - "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm"; - InsetListings::InsetListings(Buffer * buf, InsetListingsParams const & par) - : InsetCollapsable(buf) + : InsetCaptionable(buf,"listing") { + params_.setMinted(buffer().params().use_minted); status_ = par.status(); } @@ -72,19 +72,12 @@ Inset::DisplayType InsetListings::display() const } -void InsetListings::updateBuffer(ParIterator const & it, UpdateType utype) +docstring InsetListings::layoutName() const { - Counters & cnts = - buffer().masterBuffer()->params().documentClass().counters(); - string const saveflt = cnts.current_float(); - - // Tell to captions what the current float is - cnts.current_float("listing"); - - InsetCollapsable::updateBuffer(it, utype); - - //reset afterwards - cnts.current_float(saveflt); + if (buffer().params().use_minted) + return from_ascii("MintedListings"); + else + return from_ascii("Listings"); } @@ -100,7 +93,7 @@ void InsetListings::write(ostream & os) const os << "inline true\n"; else os << "inline false\n"; - InsetCollapsable::write(os); + InsetCaptionable::write(os); } @@ -122,17 +115,42 @@ void InsetListings::read(Lexer & lex) break; } } - InsetCollapsable::read(lex); + InsetCaptionable::read(lex); } -int InsetListings::latex(otexstream & os, OutputParams const & runparams) const +void InsetListings::latex(otexstream & os, OutputParams const & runparams) const { string param_string = params().params(); // NOTE: I use {} to quote text, which is an experimental feature // of the listings package (see page 25 of the manual) - int lines = 0; bool const isInline = params().isInline(); + bool const use_minted = buffer().params().use_minted; + string minted_language; + string float_placement; + bool const isfloat = params().isFloat(); + if (use_minted && (isfloat || contains(param_string, "language="))) { + // Get float placement and/or language of the code, + // then remove the relative options. + vector opts = + getVectorFromString(param_string, ",", false); + for (size_t i = 0; i < opts.size(); ++i) { + if (prefixIs(opts[i], "float")) { + if (prefixIs(opts[i], "float=")) + float_placement = opts[i].substr(6); + opts.erase(opts.begin() + i--); + } + else if (prefixIs(opts[i], "language=")) { + minted_language = opts[i].substr(9); + opts.erase(opts.begin() + i--); + } + } + param_string = getStringFromVector(opts, ","); + } + // Minted needs a language specification + if (minted_language.empty()) + minted_language = "TeX"; + // get the paragraphs. We can not output them directly to given odocstream // because we can not yet determine the delimiter character of \lstinline docstring code; @@ -142,13 +160,18 @@ int InsetListings::latex(otexstream & os, OutputParams const & runparams) const bool encoding_switched = false; Encoding const * const save_enc = runparams.encoding; - - if (!runparams.isFullUnicode() - && !runparams.encoding->hasFixedWidth()) { - // We need to switch to a singlebyte encoding, since the - // listings package cannot deal with multi-byte-encoded - // glyphs (not needed with full-unicode aware backends - // such as XeTeX). + // The listings package cannot deal with multi-byte-encoded + // glyphs, except if full-unicode aware backends + // such as XeTeX or LuaTeX are used, and with pLaTeX. + bool const multibyte_possible = use_minted || runparams.isFullUnicode() + || (buffer().params().encoding().package() == Encoding::japanese + && runparams.encoding->package() == Encoding::japanese); + + if (!multibyte_possible && !runparams.encoding->hasFixedWidth()) { + // We need to switch to a singlebyte encoding, due to + // the restrictions of the listings package (see above). + // This needs to be consistent with + // LaTeXFeatures::getTClassI18nPreamble(). Language const * const outer_language = (runparams.local_font != 0) ? runparams.local_font->language() @@ -157,14 +180,16 @@ int InsetListings::latex(otexstream & os, OutputParams const & runparams) const // language; if not, fall back to latin1. Encoding const * const lstenc = (outer_language->encoding()->hasFixedWidth()) ? - outer_language->encoding() + outer_language->encoding() : encodings.fromLyXName("iso8859-1"); - pair const c = switchEncoding(os.os(), - buffer().params(), runparams, *lstenc, true); + switchEncoding(os.os(), buffer().params(), runparams, *lstenc, true); runparams.encoding = lstenc; encoding_switched = true; } + bool const captionfirst = !isfloat && par->isInset(0) + && par->getInset(0)->lyxCode() == CAPTION_CODE; + while (par != end) { pos_type siz = par->size(); bool captionline = false; @@ -172,52 +197,63 @@ int InsetListings::latex(otexstream & os, OutputParams const & runparams) const if (i == 0 && par->isInset(i) && i + 1 == siz) captionline = true; // ignore all struck out text and (caption) insets - if (par->isDeleted(i) || par->isInset(i)) + if (par->isDeleted(i) + || (par->isInset(i) && par->getInset(i)->lyxCode() == CAPTION_CODE)) continue; + if (par->isInset(i)) { + // Currently, this can only be a quote inset + // that is output as plain quote here, but + // we use more generic code anyway. + otexstringstream ots; + OutputParams rp = runparams; + rp.pass_thru = true; + par->getInset(i)->latex(ots, rp); + code += ots.str(); + continue; + } char_type c = par->getChar(i); // we can only output characters covered by the current // encoding! try { - if (runparams.encoding->latexChar(c) == docstring(1, c)) + if (runparams.encoding->encodable(c)) code += c; else if (runparams.dryrun) { code += "<" + _("LyX Warning: ") + _("uncodable character") + " '"; code += docstring(1, c); code += "'>"; - } else + } else uncodable += c; } catch (EncodingException & /* e */) { - if (runparams.dryrun) { + if (runparams.dryrun) { code += "<" + _("LyX Warning: ") + _("uncodable character") + " '"; code += docstring(1, c); code += "'>"; - } else + } else uncodable += c; } } ++par; // for the inline case, if there are multiple paragraphs // they are simply joined. Otherwise, expect latex errors. - if (par != end && !isInline && !captionline) { + if (par != end && !isInline && !captionline) code += "\n"; - ++lines; - } } if (isInline) { - char const * delimiter = lstinline_delimiters; - for (; delimiter != '\0'; ++delimiter) - if (!contains(code, *delimiter)) - break; + static const docstring delimiters = + from_utf8("!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm"); + + size_t pos = delimiters.find_first_not_of(code); + // This code piece contains all possible special character? !!! // Replace ! with a warning message and use ! as delimiter. - if (*delimiter == '\0') { + if (pos == string::npos) { docstring delim_error = "<" + _("LyX Warning: ") + _("no more lstline delimiters available") + ">"; code = subst(code, from_ascii("!"), delim_error); - delimiter = lstinline_delimiters; - if (!runparams.dryrun) { + pos = 0; + if (!runparams.dryrun && !runparams.silent) { // FIXME: warning should be passed to the error dialog frontend::Alert::warning(_("Running out of delimiters"), _("For inline program listings, one character must be reserved\n" @@ -227,50 +263,92 @@ int InsetListings::latex(otexstream & os, OutputParams const & runparams) const "must investigate!")); } } - if (param_string.empty()) - os << "\\lstinline" << *delimiter; - else - os << "\\lstinline[" << from_utf8(param_string) << "]" << *delimiter; - os << code - << *delimiter; + docstring const delim(1, delimiters[pos]); + if (use_minted) { + os << "\\mintinline"; + if (!param_string.empty()) + os << "[" << from_utf8(param_string) << "]"; + os << "{" << minted_language << "}"; + } else { + os << "\\lstinline"; + if (!param_string.empty()) + os << "[" << from_utf8(param_string) << "]"; + else if (pos >= delimiters.find('Q')) + // We need to terminate the command before + // the delimiter + os << " "; + } + os << delim << code << delim; + } else if (use_minted) { + OutputParams rp = runparams; + rp.moving_arg = true; + TexString caption = getCaption(rp); + if (isfloat) { + os << breakln << "\\begin{listing}"; + if (!float_placement.empty()) + os << '[' << float_placement << "]"; + } else if (captionfirst && !caption.str.empty()) { + os << breakln << "\\lyxmintcaption[t]{" + << move(caption) << "}\n"; + } + os << breakln << "\\begin{minted}"; + if (!param_string.empty()) + os << "[" << param_string << "]"; + os << "{" << minted_language << "}\n" + << code << breakln << "\\end{minted}\n"; + if (isfloat) { + if (!caption.str.empty()) + os << "\\caption{" << move(caption) << "}\n"; + os << "\\end{listing}\n"; + } else if (!captionfirst && !caption.str.empty()) { + os << breakln << "\\lyxmintcaption[b]{" + << move(caption) << "}"; + } } else { OutputParams rp = runparams; rp.moving_arg = true; - docstring const caption = getCaption(rp); - // clear counter - os.countLines(); - if (param_string.empty() && caption.empty()) - os << breakln << "\\begin{lstlisting}\n"; + TexString caption = getCaption(rp); + os << breakln << "\\begin{lstlisting}"; + if (param_string.empty() && caption.str.empty()) + os << "\n"; else { - os << breakln << "\\begin{lstlisting}["; - if (!caption.empty()) { - os << "caption={" << caption << '}'; + if (!runparams.nice) + os << safebreakln; + os << "["; + if (!caption.str.empty()) { + os << "caption={" << move(caption) << '}'; if (!param_string.empty()) os << ','; } os << from_utf8(param_string) << "]\n"; } os << code << breakln << "\\end{lstlisting}\n"; - lines += os.countLines(); } if (encoding_switched){ // Switch back - pair const c = switchEncoding(os.os(), - buffer().params(), runparams, *save_enc, true); + switchEncoding(os.os(), buffer().params(), runparams, *save_enc, true); runparams.encoding = save_enc; } - if (!uncodable.empty()) { + if (!uncodable.empty() && !runparams.silent) { // issue a warning about omitted characters // FIXME: should be passed to the error dialog - frontend::Alert::warning(_("Uncodable characters in listings inset"), - bformat(_("The following characters in one of the program listings are\n" - "not representable in the current encoding and have been omitted:\n%1$s."), - uncodable)); + if (!multibyte_possible && !runparams.encoding->hasFixedWidth()) + frontend::Alert::warning(_("Uncodable characters in listings inset"), + bformat(_("The following characters in one of the program listings are\n" + "not representable in the current encoding and have been omitted:\n%1$s.\n" + "This is due to a restriction of the listings package, which does\n" + "not support your encoding '%2$s'.\n" + "Toggling 'Use non-TeX fonts' in Document > Settings...\n" + "might help."), + uncodable, _(runparams.encoding->guiName()))); + else + frontend::Alert::warning(_("Uncodable characters in listings inset"), + bformat(_("The following characters in one of the program listings are\n" + "not representable in the current encoding and have been omitted:\n%1$s."), + uncodable)); } - - return lines; } @@ -280,21 +358,32 @@ docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const XHTMLStream out(ods); bool const isInline = params().isInline(); - if (isInline) + if (isInline) out << html::CompTag("br"); else { - out << html::StartTag("div", "class='float float-listings'"); + out << html::StartTag("div", "class='float-listings'"); docstring caption = getCaptionHTML(rp); if (!caption.empty()) - out << html::StartTag("div", "class='float-caption'") + out << html::StartTag("div", "class='listings-caption'") + << XHTMLStream::ESCAPE_NONE << caption << html::EndTag("div"); } - out << html::StartTag("pre"); + InsetLayout const & il = getLayout(); + string const & tag = il.htmltag(); + string attr = "class ='listings"; + string const lang = params().getParamValue("language"); + if (!lang.empty()) + attr += " " + lang; + attr += "'"; + out << html::StartTag(tag, attr); OutputParams newrp = rp; newrp.html_disable_captions = true; + // We don't want to convert dashes here. That's the only conversion we + // do for XHTML, so this is safe. + newrp.pass_thru = true; docstring def = InsetText::insetAsXHTML(out, newrp, InsetText::JustText); - out << html::EndTag("pre"); + out << html::EndTag(tag); if (isInline) { out << html::CompTag("br"); @@ -310,9 +399,9 @@ docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const } -docstring InsetListings::contextMenuName() const +string InsetListings::contextMenuName() const { - return from_ascii("context-listings"); + return "context-listings"; } @@ -321,7 +410,7 @@ void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd) switch (cmd.action()) { case LFUN_INSET_MODIFY: { - cur.recordUndoInset(ATOMIC_UNDO, this); + cur.recordUndoInset(this); InsetListings::string2params(to_utf8(cmd.argument()), params()); break; } @@ -331,7 +420,7 @@ void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd) break; default: - InsetCollapsable::doDispatch(cur, cmd); + InsetCaptionable::doDispatch(cur, cmd); break; } } @@ -345,11 +434,15 @@ bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd, case LFUN_INSET_DIALOG_UPDATE: status.setEnabled(true); return true; - case LFUN_CAPTION_INSERT: - status.setEnabled(!params().isInline()); - return true; + case LFUN_CAPTION_INSERT: { + // the inset outputs at most one caption + if (params().isInline() || getCaptionInset()) { + status.setEnabled(false); + return true; + } + } default: - return InsetCollapsable::getStatus(cur, cmd, status); + return InsetCaptionable::getStatus(cur, cmd, status); } } @@ -366,11 +459,19 @@ docstring const InsetListings::buttonLabel(BufferView const & bv) const void InsetListings::validate(LaTeXFeatures & features) const { - features.require("listings"); + features.useInsetLayout(getLayout()); string param_string = params().params(); - if (param_string.find("\\color") != string::npos) - features.require("color"); - InsetCollapsable::validate(features); + if (buffer().params().use_minted) { + features.require("minted"); + OutputParams rp = features.runparams(); + if (!params().isFloat() && !getCaption(rp).str.empty()) + features.require("lyxmintcaption"); + } else { + features.require("listings"); + if (contains(param_string, "\\color")) + features.require("color"); + } + InsetCaptionable::validate(features); } @@ -382,23 +483,24 @@ bool InsetListings::showInsetDialog(BufferView * bv) const } -docstring InsetListings::getCaption(OutputParams const & runparams) const +TexString InsetListings::getCaption(OutputParams const & runparams) const { - if (paragraphs().empty()) - return docstring(); - InsetCaption const * ins = getCaptionInset(); if (ins == 0) - return docstring(); + return TexString(); - odocstringstream ods; - otexstream os(ods); - ins->getOptArg(os, runparams); + otexstringstream os; + ins->getArgs(os, runparams); ins->getArgument(os, runparams); + + // TODO: The code below should be moved to support, and then the test + // in ../tests should be moved there as well. + // the caption may contain \label{} but the listings // package prefer caption={}, label={} - docstring cap = ods.str(); - if (!contains(to_utf8(cap), "\\label{")) + TexString cap = os.release(); + if (buffer().params().use_minted + || !contains(cap.str, from_ascii("\\label{"))) return cap; // convert from // blah1\label{blah2} blah3 @@ -409,8 +511,12 @@ docstring InsetListings::getCaption(OutputParams const & runparams) const // // NOTE that } is not allowed in blah2. regex const reg("(.*)\\\\label\\{(.*?)\\}(.*)"); - string const new_cap("\\1\\3},label={\\2"); - return from_utf8(regex_replace(to_utf8(cap), reg, new_cap)); + string const new_cap("$1$3},label={$2"); + // TexString validity: the substitution preserves the number of newlines. + // Moreover we assume that $2 does not contain newlines, so that the texrow + // information remains accurate. + cap.str = from_utf8(regex_replace(to_utf8(cap.str), reg, new_cap)); + return cap; }