]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetListings.cpp
XHTML output for InsetListings.
[lyx.git] / src / insets / InsetListings.cpp
index c225446038acd43c006520cfbb5884eb0e50c271..b54b4106fd537bc4517e1c8538dd880d6ba4be49 100644 (file)
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Bo Peng
- * \author Jürgen Spitzmüller
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
 #include <config.h>
 
 #include "InsetListings.h"
-#include "InsetCaption.h"
 
 #include "Buffer.h"
+#include "BufferView.h"
 #include "BufferParams.h"
 #include "Counters.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
+#include "Encoding.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "support/gettext.h"
-#include "InsetList.h"
+#include "InsetCaption.h"
 #include "Language.h"
 #include "MetricsInfo.h"
+#include "output_latex.h"
 #include "TextClass.h"
 
+#include "support/debug.h"
 #include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
+#include "support/lassert.h"
+
+#include "frontends/alert.h"
+#include "frontends/Application.h"
+
+#include <boost/regex.hpp>
 
 #include <sstream>
 
@@ -37,29 +46,21 @@ using namespace lyx::support;
 
 namespace lyx {
 
+using boost::regex;
 
 char const lstinline_delimiters[] =
        "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm";
 
-InsetListings::InsetListings(BufferParams const & bp, InsetListingsParams const & par)
-       : InsetCollapsable(bp, par.status())
-{}
-
-
-InsetListings::InsetListings(InsetListings const & in)
-       : InsetCollapsable(in), params_(in.params_)
-{}
-
-
-Inset * InsetListings::clone() const
+InsetListings::InsetListings(Buffer const & buf, InsetListingsParams const & par)
+       : InsetCollapsable(buf)
 {
-       return new InsetListings(*this);
+       status_ = par.status();
 }
 
 
 InsetListings::~InsetListings()
 {
-       InsetListingsMailer(*this).hideDialog();
+       hideDialogs("listings", this);
 }
 
 
@@ -69,22 +70,22 @@ Inset::DisplayType InsetListings::display() const
 }
 
 
-void InsetListings::updateLabels(Buffer const & buf, ParIterator const & it)
+void InsetListings::updateLabels(ParIterator const & it)
 {
-       Counters & cnts = buf.params().getTextClass().counters();
+       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::updateLabels(buf, it);
+       InsetCollapsable::updateLabels(it);
 
        //reset afterwards
        cnts.current_float(saveflt);
 }
 
 
-void InsetListings::write(Buffer const & buf, ostream & os) const
+void InsetListings::write(ostream & os) const
 {
        os << "listings" << "\n";
        InsetListingsParams const & par = params();
@@ -96,15 +97,15 @@ void InsetListings::write(Buffer const & buf, ostream & os) const
                os << "inline true\n";
        else
                os << "inline false\n";
-       InsetCollapsable::write(buf, os);
+       InsetCollapsable::write(os);
 }
 
 
-void InsetListings::read(Buffer const & buf, Lexer & lex)
+void InsetListings::read(Lexer & lex)
 {
        while (lex.isOK()) {
                lex.next();
-               string const token = lex.getString();
+               string token = lex.getString();
                if (token == "lstparams") {
                        lex.next();
                        string const value = lex.getString();
@@ -118,30 +119,52 @@ void InsetListings::read(Buffer const & buf, Lexer & lex)
                        break;
                }
        }
-       InsetCollapsable::read(buf, lex);
+       InsetCollapsable::read(lex);
 }
 
 
-docstring const InsetListings::editMessage() const
+docstring InsetListings::editMessage() const
 {
        return _("Opened Listing Inset");
 }
 
 
-int InsetListings::latex(Buffer const & buf, odocstream & os,
-                   OutputParams const & runparams) const
+int InsetListings::latex(odocstream & 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 isInline = params().isInline();
+       bool const isInline = params().isInline();
        // 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;
+       docstring uncodable;
        ParagraphList::const_iterator par = paragraphs().begin();
        ParagraphList::const_iterator end = paragraphs().end();
 
+       bool encoding_switched = false;
+       Encoding const * const save_enc = runparams.encoding;
+
+       if (!runparams.encoding->hasFixedWidth()) {
+               // We need to switch to a singlebyte encoding, since the listings
+               // package cannot deal with multiple-byte-encoded glyphs
+               Language const * const outer_language =
+                       (runparams.local_font != 0) ?
+                               runparams.local_font->language()
+                               : buffer().params().language;
+               // We try if there's a singlebyte encoding for the current
+               // language; if not, fall back to latin1.
+               Encoding const * const lstenc =
+                       (outer_language->encoding()->hasFixedWidth()) ?
+                               outer_language->encoding() 
+                               : encodings.fromLyXName("iso8859-1");
+               pair<bool, int> const c = switchEncoding(os, buffer().params(),
+                               runparams, *lstenc, true);
+               runparams.encoding = lstenc;
+               encoding_switched = true;
+       }
+
        while (par != end) {
                pos_type siz = par->size();
                bool captionline = false;
@@ -151,7 +174,28 @@ int InsetListings::latex(Buffer const & buf, odocstream & os,
                        // ignore all struck out text and (caption) insets
                        if (par->isDeleted(i) || par->isInset(i))
                                continue;
-                       code += par->getChar(i);
+                       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))
+                                       code += c;
+                               else if (runparams.dryrun) {
+                                       code += "<" + _("LyX Warning: ")
+                                          + _("uncodable character") + " '";
+                                       code += docstring(1, c);
+                                       code += "'>";
+                               } else
+                                       uncodable += c;
+                       } catch (EncodingException & /* e */) {
+                               if (runparams.dryrun) {
+                                       code += "<" + _("LyX Warning: ")
+                                          + _("uncodable character") + " '";
+                                       code += docstring(1, c);
+                                       code += "'>";
+                               } else
+                                       uncodable += c;
+                       }
                }
                ++par;
                // for the inline case, if there are multiple paragraphs
@@ -162,34 +206,41 @@ int InsetListings::latex(Buffer const & buf, odocstream & os,
                }
        }
        if (isInline) {
-                char const * delimiter = lstinline_delimiters;
+               char const * delimiter = lstinline_delimiters;
                for (; delimiter != '\0'; ++delimiter)
                        if (!contains(code, *delimiter))
                                break;
                // This code piece contains all possible special character? !!!
                // Replace ! with a warning message and use ! as delimiter.
                if (*delimiter == '\0') {
-                       code = subst(code, from_ascii("!"), from_ascii(" WARNING: no lstline delimiter can be used "));
+                       docstring delim_error = "<" + _("LyX Warning: ")
+                               + _("no more lstline delimiters available") + ">";
+                       code = subst(code, from_ascii("!"), delim_error);
                        delimiter = lstinline_delimiters;
+                       if (!runparams.dryrun) {
+                               // 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"
+                                 "as a delimiter. One of the listings, however, uses all available\n"
+                                 "characters, so none is left for delimiting purposes.\n"
+                                 "For the time being, I have replaced '!' by a warning, but you\n"
+                                 "must investigate!"));
+                       }
                }
                if (param_string.empty())
                        os << "\\lstinline" << *delimiter;
                else
-                       os << "\\lstinline[" << from_ascii(param_string) << "]" << *delimiter;
+                       os << "\\lstinline[" << from_utf8(param_string) << "]" << *delimiter;
                 os << code
                    << *delimiter;
        } else {
                OutputParams rp = runparams;
-               // FIXME: the line below would fix bug 4182,
-               // but real_current_font moved to cursor.
-               //rp.local_font = &text_.real_current_font;
                rp.moving_arg = true;
-               docstring const caption = getCaption(buf, rp);
-               runparams.encoding = rp.encoding;
+               docstring const caption = getCaption(rp);
                if (param_string.empty() && caption.empty())
-                       os << "\n\\begingroup\n\\inputencoding{latin1}\n\\begin{lstlisting}\n";
+                       os << "\n\\begin{lstlisting}\n";
                else {
-                       os << "\n\\begingroup\n\\inputencoding{latin1}\n\\begin{lstlisting}[";
+                       os << "\n\\begin{lstlisting}[";
                        if (!caption.empty()) {
                                os << "caption={" << caption << '}';
                                if (!param_string.empty())
@@ -197,34 +248,161 @@ int InsetListings::latex(Buffer const & buf, odocstream & os,
                        }
                        os << from_utf8(param_string) << "]\n";
                }
-               lines += 4;
-               os << code << "\n\\end{lstlisting}\n\\endgroup\n";
-               lines += 3;
+               lines += 2;
+               os << code << "\n\\end{lstlisting}\n";
+               lines += 2;
+       }
+
+       if (encoding_switched){
+               // Switch back
+               pair<bool, int> const c = switchEncoding(os, buffer().params(),
+                               runparams, *save_enc, true);
+               runparams.encoding = save_enc;
+       }
+
+       if (!uncodable.empty()) {
+               // 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));
        }
 
        return lines;
 }
 
 
+docstring InsetListings::xhtml(odocstream & os, OutputParams const & rp) const
+{
+       odocstringstream out;
+
+       bool const isInline = params().isInline();
+       if (isInline) 
+               out << "<br />\n";
+       else {
+               out << "<div class='float float-listings'>\n";
+               docstring caption = getCaptionHTML(rp);
+               if (!caption.empty())
+                       out << "<div class='float-caption'>" << caption << "</div>\n";
+       }
+
+       out << "<pre>\n";
+       docstring def = InsetText::xhtml(out, rp);
+       out << "\n</pre>\n";
+
+       if (isInline) {
+               out << "<br />\n";
+               os << out.str();
+       } else {
+               out <<  "</div>";
+               // In this case, this needs to be deferred, but we'll put it
+               // before anything the text itself deferred.
+               def = out.str() + '\n' + def;
+       }
+       return def;
+}
+
+
+docstring InsetListings::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-listings");
+}
+
+
 void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY: {
-               InsetListingsMailer::string2params(to_utf8(cmd.argument()), params());
+               InsetListings::string2params(to_utf8(cmd.argument()), params());
                break;
        }
+
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetListingsMailer(*this).updateDialog(&cur.bv());
+               cur.bv().updateDialog("listings", params2string(params()));
                break;
-       case LFUN_MOUSE_RELEASE: {
-               if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
-                       InsetListingsMailer(*this).showDialog(&cur.bv());
-                       break;
+
+       case LFUN_TAB_INSERT: {
+               bool const multi_par_selection = cur.selection() &&
+                       cur.selBegin().pit() != cur.selEnd().pit();
+               if (multi_par_selection) {
+                       // If there is a multi-paragraph selection, a tab is inserted
+                       // at the beginning of each paragraph.
+                       cur.recordUndoSelection();
+                       pit_type const pit_end = cur.selEnd().pit();
+                       for (pit_type pit = cur.selBegin().pit(); pit <= pit_end; pit++) {
+                               paragraphs()[pit].insertChar(0, '\t', 
+                                       buffer().params().trackChanges);
+                               // Update the selection pos to make sure the selection does not
+                               // change as the inserted tab will increase the logical pos.
+                               if (cur.anchor_.pit() == pit)
+                                       cur.anchor_.forwardPos();
+                               if (cur.pit() == pit)
+                                       cur.forwardPos();
+                       }
+                       cur.finishUndo();
+               } else {
+                       // Maybe we shouldn't allow tabs within a line, because they
+                       // are not (yet) aligned as one might do expect.
+                       FuncRequest cmd(LFUN_SELF_INSERT, from_ascii("\t"));
+                       dispatch(cur, cmd);     
                }
-               InsetCollapsable::doDispatch(cur, cmd);
                break;
        }
+
+       case LFUN_TAB_DELETE:
+               if (cur.selection()) {
+                       // If there is a selection, a tab (if present) is removed from
+                       // the beginning of each paragraph.
+                       cur.recordUndoSelection();
+                       pit_type const pit_end = cur.selEnd().pit();
+                       for (pit_type pit = cur.selBegin().pit(); pit <= pit_end; pit++) {
+                               Paragraph & par = paragraphs()[pit];
+                               if (par.getChar(0) == '\t') {
+                                       if (cur.pit() == pit)
+                                               cur.posBackward();
+                                       if (cur.anchor_.pit() == pit && cur.anchor_.pos() > 0 )
+                                               cur.anchor_.backwardPos();
+
+                                       par.eraseChar(0, buffer().params().trackChanges);
+                               } else 
+                                       // If no tab was present, try to remove up to four spaces.
+                                       for (int n_spaces = 0;
+                                               par.getChar(0) == ' ' && n_spaces < 4; ++n_spaces) {
+                                                       if (cur.pit() == pit)
+                                                               cur.posBackward();
+                                                       if (cur.anchor_.pit() == pit && cur.anchor_.pos() > 0 )
+                                                               cur.anchor_.backwardPos();
+
+                                                       par.eraseChar(0, buffer().params().trackChanges);
+                                       }
+                       }
+                       cur.finishUndo();
+               } else {
+                       // If there is no selection, try to remove a tab or some spaces 
+                       // before the position of the cursor.
+                       Paragraph & par = paragraphs()[cur.pit()];
+                       pos_type const pos = cur.pos();
+
+                       if (pos == 0)
+                               break;
+
+                       char_type const c = par.getChar(pos - 1);
+                       cur.recordUndo();
+                       if (c == '\t') {
+                               cur.posBackward();
+                               par.eraseChar(cur.pos(), buffer().params().trackChanges);
+                       } else
+                               for (int n_spaces = 0; cur.pos() > 0
+                                       && par.getChar(cur.pos() - 1) == ' ' && n_spaces < 4;
+                                       ++n_spaces) {
+                                               cur.posBackward();
+                                               par.eraseChar(cur.pos(), buffer().params().trackChanges);
+                               }
+                               cur.finishUndo();
+               }
+               break;
        default:
                InsetCollapsable::doDispatch(cur, cmd);
                break;
@@ -236,88 +414,90 @@ bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd,
        FuncStatus & status) const
 {
        switch (cmd.action) {
+               case LFUN_INSET_MODIFY:
                case LFUN_INSET_DIALOG_UPDATE:
-                       status.enabled(true);
+                       status.setEnabled(true);
                        return true;
                case LFUN_CAPTION_INSERT:
-                       status.enabled(!params().isInline());
+                       status.setEnabled(!params().isInline());
                        return true;
+                       case LFUN_TAB_INSERT:
+                       case LFUN_TAB_DELETE:
+                               status.setEnabled(true);
+                               return true;
                default:
                        return InsetCollapsable::getStatus(cur, cmd, status);
        }
 }
 
 
-void InsetListings::setButtonLabel()
+docstring const InsetListings::buttonLabel(BufferView const & bv) const
 {
        // FIXME UNICODE
-       if (decoration() == Classic)
-               setLabel(isOpen() ?  _("Listing") : getNewLabel(_("Listing")));
+       if (decoration() == InsetLayout::CLASSIC)
+               return isOpen(bv) ? _("Listing") : getNewLabel(_("Listing"));
        else
-               setLabel(getNewLabel(_("Listing")));
+               return getNewLabel(_("Listing"));
 }
 
 
 void InsetListings::validate(LaTeXFeatures & features) const
 {
        features.require("listings");
+       string param_string = params().params();
+       if (param_string.find("\\color") != string::npos)
+               features.require("color");
        InsetCollapsable::validate(features);
 }
 
 
 bool InsetListings::showInsetDialog(BufferView * bv) const
 {
-       InsetListingsMailer(const_cast<InsetListings &>(*this)).showDialog(bv);
+       bv->showDialog("listings", params2string(params()),
+               const_cast<InsetListings *>(this));
        return true;
 }
 
 
-docstring InsetListings::getCaption(Buffer const & buf,
-       OutputParams const & runparams) const
+docstring InsetListings::getCaption(OutputParams const & runparams) const
 {
        if (paragraphs().empty())
                return docstring();
 
-       ParagraphList::const_iterator pit = paragraphs().begin();
-       for (; pit != paragraphs().end(); ++pit) {
-               InsetList::const_iterator it = pit->insetList().begin();
-               for (; it != pit->insetList().end(); ++it) {
-                       Inset & inset = *it->inset;
-                       if (inset.lyxCode() == CAPTION_CODE) {
-                               odocstringstream ods;
-                               InsetCaption * ins =
-                                       static_cast<InsetCaption *>(it->inset);
-                               ins->getOptArg(buf, ods, runparams);
-                               ins->getArgument(buf, ods, runparams);
-                               return ods.str();
-                       }
-               }
-       }
-       return docstring();
-}
-
-
-string const InsetListingsMailer::name_("listings");
-
-InsetListingsMailer::InsetListingsMailer(InsetListings & inset)
-       : inset_(inset)
-{}
-
+       InsetCaption const * ins = getCaptionInset();
+       if (ins == 0)
+               return docstring();
 
-string const InsetListingsMailer::inset2string(Buffer const &) const
-{
-       return params2string(inset_.params());
+       odocstringstream ods;
+       ins->getOptArg(ods, runparams);
+       ins->getArgument(ods, runparams);
+       // the caption may contain \label{} but the listings
+       // package prefer caption={}, label={}
+       docstring cap = ods.str();
+       if (!contains(to_utf8(cap), "\\label{"))
+               return cap;
+       // convert from
+       //     blah1\label{blah2} blah3
+       // to
+       //     blah1 blah3},label={blah2
+       // to form options
+       //     caption={blah1 blah3},label={blah2}
+       //
+       // 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));
 }
 
 
-void InsetListingsMailer::string2params(string const & in,
+void InsetListings::string2params(string const & in,
                                   InsetListingsParams & params)
 {
        params = InsetListingsParams();
        if (in.empty())
                return;
        istringstream data(in);
-       Lexer lex(0, 0);
+       Lexer lex;
        lex.setStream(data);
        // discard "listings", which is only used to determine inset
        lex.next();
@@ -325,11 +505,10 @@ void InsetListingsMailer::string2params(string const & in,
 }
 
 
-string const
-InsetListingsMailer::params2string(InsetListingsParams const & params)
+string InsetListings::params2string(InsetListingsParams const & params)
 {
        ostringstream data;
-       data << name_ << " ";
+       data << "listings" << ' ';
        params.write(data);
        return data.str();
 }