]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetListings.cpp
Merge branch 'master' into biblatex2
[lyx.git] / src / insets / InsetListings.cpp
index 4baaff0d470cf4e8c28c4785ace2513f036e698c..bec33b12cb44ee86ce28d927a1757a21a34cb99d 100644 (file)
@@ -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,11 +52,8 @@ using namespace lyx::support;
 namespace lyx {
 
 
-char const lstinline_delimiters[] =
-       "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm";
-
 InsetListings::InsetListings(Buffer * buf, InsetListingsParams const & par)
-       : InsetCollapsable(buf)
+       : InsetCaptionable(buf,"listing")
 {
        status_ = par.status();
 }
@@ -72,22 +71,6 @@ Inset::DisplayType InsetListings::display() const
 }
 
 
-void InsetListings::updateBuffer(ParIterator const & it, UpdateType utype)
-{
-       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);
-}
-
-
 void InsetListings::write(ostream & os) const
 {
        os << "listings" << "\n";
@@ -100,7 +83,7 @@ void InsetListings::write(ostream & os) const
                os << "inline true\n";
        else
                os << "inline false\n";
-       InsetCollapsable::write(os);
+       InsetCaptionable::write(os);
 }
 
 
@@ -122,7 +105,7 @@ void InsetListings::read(Lexer & lex)
                        break;
                }
        }
-       InsetCollapsable::read(lex);
+       InsetCaptionable::read(lex);
 }
 
 
@@ -141,13 +124,18 @@ void 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 = 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()
@@ -156,7 +144,7 @@ void 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");
                switchEncoding(os.os(), buffer().params(), runparams, *lstenc, true);
                runparams.encoding = lstenc;
@@ -170,8 +158,20 @@ void 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!
@@ -183,15 +183,15 @@ void InsetListings::latex(otexstream & os, OutputParams const & runparams) const
                                           + _("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;
                        }
                }
@@ -202,18 +202,19 @@ void InsetListings::latex(otexstream & os, OutputParams const & runparams) const
                        code += "\n";
        }
        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"
@@ -223,22 +224,27 @@ void 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]);
+               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 {
                OutputParams rp = runparams;
                rp.moving_arg = true;
-               docstring const caption = getCaption(rp);
-               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 << ',';
                        }
@@ -253,13 +259,23 @@ void InsetListings::latex(otexstream & os, OutputParams const & runparams) const
                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));
        }
 }
 
@@ -270,18 +286,19 @@ 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");
        }
 
        InsetLayout const & il = getLayout();
-       string const tag = il.htmltag();
+       string const tag = il.htmltag();
        string attr = "class ='listings";
        string const lang = params().getParamValue("language");
        if (!lang.empty())
@@ -290,6 +307,9 @@ docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const
        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(tag);
 
@@ -318,7 +338,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;
        }
@@ -328,7 +348,7 @@ void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
 
        default:
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCaptionable::doDispatch(cur, cmd);
                break;
        }
 }
@@ -343,13 +363,14 @@ bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.setEnabled(true);
                        return true;
                case LFUN_CAPTION_INSERT: {
-                       if (params().isInline()) {
+                       // 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);
        }
 }
 
@@ -367,10 +388,11 @@ 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);
+       InsetCaptionable::validate(features);
 }
 
 
@@ -382,24 +404,23 @@ 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();
 
-       TexRow texrow;
-       odocstringstream ods;
-       otexstream os(ods, texrow);
+       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 (!contains(cap.str, from_ascii("\\label{")))
                return cap;
        // convert from
        //     blah1\label{blah2} blah3
@@ -410,8 +431,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;
 }