* 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 "Language.h"
-#include "gettext.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 "Cursor.h"
+#include "InsetCaption.h"
+#include "Language.h"
+#include "MetricsInfo.h"
+#include "output_latex.h"
+#include "output_xhtml.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 <sstream>
+#include "frontends/alert.h"
+#include "frontends/Application.h"
-namespace lyx {
+#include <boost/regex.hpp>
-using support::token;
+#include <sstream>
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-using std::string;
+using namespace std;
+using namespace lyx::support;
+namespace lyx {
-void InsetListings::init()
-{
- setButtonLabel();
- // FIXME: define Color::listing?
- Font font(Font::ALL_SANE);
- font.decSize();
- font.decSize();
- font.setColor(Color::foreground);
- setLabelFont(font);
- // FIXME: english_language?
- text_.current_font.setLanguage(english_language);
- text_.real_current_font.setLanguage(english_language);
- // FIXME: why I can not make text of source code black with the following two lines?
- text_.current_font.setColor(Color::foreground);
- text_.real_current_font.setColor(Color::foreground);
-}
+using boost::regex;
+char const lstinline_delimiters[] =
+ "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm";
-InsetListings::InsetListings(BufferParams const & bp, InsetListingsParams const & par)
- : InsetERT(bp, par.status())
+InsetListings::InsetListings(Buffer * buf, InsetListingsParams const & par)
+ : InsetCollapsable(buf)
{
- init();
+ status_ = par.status();
}
-InsetListings::InsetListings(InsetListings const & in)
- : InsetERT(in), params_(in.params_)
+InsetListings::~InsetListings()
{
- init();
+ hideDialogs("listings", this);
}
-auto_ptr<Inset> InsetListings::doClone() const
+Inset::DisplayType InsetListings::display() const
{
- return auto_ptr<Inset>(new InsetListings(*this));
+ return params().isInline() || params().isFloat() ? Inline : AlignLeft;
}
-InsetListings::~InsetListings()
+void InsetListings::updateLabels(ParIterator const & it, bool out)
{
- InsetListingsMailer(*this).hideDialog();
-}
+ 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");
-Inset::DisplayType InsetListings::display() const
-{
- return params().isInline() ? Inline : AlignLeft;
+ InsetCollapsable::updateLabels(it, out);
+
+ //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();
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();
break;
}
}
- InsetCollapsable::read(buf, lex);
-}
-
-
-docstring const InsetListings::editMessage() const
-{
- return _("Opened Listings Inset");
+ InsetCollapsable::read(lex);
}
-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().encodedString();
+ 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 lstinline = params().isInline();
- if (lstinline) {
- if (param_string.empty())
- os << "\\lstinline{";
- else
- os << "\\lstinline[" << from_ascii(param_string) << "]{";
- } else {
- docstring const caption = getCaption(buf, runparams);
- if (param_string.empty() && caption.empty())
- os << "\n\\begingroup\n\\inputencoding{latin1}\n\\begin{lstlisting}\n";
- else {
- os << "\n\\begingroup\n\\inputencoding{latin1}\n\\begin{lstlisting}[";
- if (!caption.empty()) {
- os << "caption={" << caption << '}';
- if (!param_string.empty())
- os << ',';
- }
- os << from_ascii(param_string) << "]\n";
- }
- lines += 4;
- }
+ 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;
// ignore all struck out text and (caption) insets
if (par->isDeleted(i) || par->isInset(i))
continue;
- os.put(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
// they are simply joined. Otherwise, expect latex errors.
- if (par != end && !lstinline && !captionline) {
- os << "\n";
+ if (par != end && !isInline && !captionline) {
+ code += "\n";
++lines;
}
}
- if (lstinline)
- os << "}";
- else {
- os << "\n\\end{lstlisting}\n\\endgroup\n";
- lines += 3;
+ if (isInline) {
+ 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') {
+ 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_utf8(param_string) << "]" << *delimiter;
+ os << code
+ << *delimiter;
+ } else {
+ OutputParams rp = runparams;
+ rp.moving_arg = true;
+ docstring const caption = getCaption(rp);
+ if (param_string.empty() && caption.empty())
+ os << "\n\\begin{lstlisting}\n";
+ else {
+ os << "\n\\begin{lstlisting}[";
+ if (!caption.empty()) {
+ os << "caption={" << caption << '}';
+ if (!param_string.empty())
+ os << ',';
+ }
+ os << from_utf8(param_string) << "]\n";
+ }
+ 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(XHTMLStream & os, OutputParams const & rp) const
+{
+ odocstringstream ods;
+ XHTMLStream out(ods);
+
+ bool const isInline = params().isInline();
+ if (isInline)
+ out << CompTag("br");
+ else {
+ out << StartTag("div", "class='float float-listings'");
+ docstring caption = getCaptionHTML(rp);
+ if (!caption.empty())
+ out << StartTag("div", "class='float-caption'")
+ << caption << EndTag("div");
+ }
+
+ out << StartTag("pre");
+ OutputParams newrp = rp;
+ newrp.html_disable_captions = true;
+ docstring def = InsetText::xhtml(out, newrp);
+ out << EndTag("pre");
+
+ if (isInline) {
+ out << CompTag("br");
+ // escaping will already have been done
+ os << XHTMLStream::NextRaw() << ods.str();
+ } else {
+ out << EndTag("div");
+ // In this case, this needs to be deferred, but we'll put it
+ // before anything the text itself deferred.
+ def = ods.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());
- break;
- case LFUN_MOUSE_RELEASE: {
- if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
- InsetListingsMailer(*this).showDialog(&cur.bv());
- break;
- }
- InsetERT::doDispatch(cur, cmd);
+ cur.bv().updateDialog("listings", params2string(params()));
break;
- }
+
default:
- InsetERT::doDispatch(cur, cmd);
+ InsetCollapsable::doDispatch(cur, cmd);
break;
}
}
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;
default:
- return InsetERT::getStatus(cur, cmd, status);
+ return InsetCollapsable::getStatus(cur, cmd, status);
}
}
-void InsetListings::setButtonLabel()
+docstring const InsetListings::buttonLabel(BufferView const & bv) const
{
// FIXME UNICODE
- setLabel(isOpen() ? _("Listings") : getNewLabel(_("Listings")));
+ if (decoration() == InsetLayout::CLASSIC)
+ return isOpen(bv) ? _("Listing") : getNewLabel(_("Listing"));
+ else
+ return getNewLabel(_("Listing"));
}
void InsetListings::validate(LaTeXFeatures & features) const
{
features.require("listings");
- InsetERT::validate(features);
+ 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;
}
-void InsetListings::getDrawFont(Font & font) const
-{
- font = Font(Font::ALL_INHERIT, english_language);
- font.setFamily(Font::TYPEWRITER_FAMILY);
- font.setColor(Color::foreground);
-}
-
-
-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() == Inset::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();
}
-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();
}