2 * \file InsetListings.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Jürgen Spitzmüller
9 * Full author contact details are available in file CREDITS.
14 #include "InsetListings.h"
17 #include "BufferView.h"
18 #include "BufferParams.h"
21 #include "DispatchResult.h"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
25 #include "InsetCaption.h"
27 #include "LaTeXFeatures.h"
29 #include "output_latex.h"
30 #include "output_xhtml.h"
31 #include "OutputParams.h"
32 #include "TextClass.h"
34 #include "support/debug.h"
35 #include "support/docstream.h"
36 #include "support/gettext.h"
37 #include "support/lstrings.h"
38 #include "support/lassert.h"
40 #include "frontends/alert.h"
41 #include "frontends/Application.h"
43 #include "support/regex.h"
48 using namespace lyx::support;
53 char const lstinline_delimiters[] =
54 "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm";
56 InsetListings::InsetListings(Buffer * buf, InsetListingsParams const & par)
57 : InsetCollapsable(buf)
59 status_ = par.status();
63 InsetListings::~InsetListings()
65 hideDialogs("listings", this);
69 Inset::DisplayType InsetListings::display() const
71 return params().isInline() || params().isFloat() ? Inline : AlignLeft;
75 void InsetListings::updateBuffer(ParIterator const & it, UpdateType utype)
78 buffer().masterBuffer()->params().documentClass().counters();
79 string const saveflt = cnts.current_float();
81 // Tell to captions what the current float is
82 cnts.current_float("listing");
84 InsetCollapsable::updateBuffer(it, utype);
87 cnts.current_float(saveflt);
91 void InsetListings::write(ostream & os) const
93 os << "listings" << "\n";
94 InsetListingsParams const & par = params();
95 // parameter string is encoded to be a valid lyx token.
96 string opt = par.encodedString();
98 os << "lstparams \"" << opt << "\"\n";
100 os << "inline true\n";
102 os << "inline false\n";
103 InsetCollapsable::write(os);
107 void InsetListings::read(Lexer & lex)
111 string token = lex.getString();
112 if (token == "lstparams") {
114 string const value = lex.getString();
115 params().fromEncodedString(value);
116 } else if (token == "inline") {
118 params().setInline(lex.getBool());
120 // no special option, push back 'status' etc
121 lex.pushToken(token);
125 InsetCollapsable::read(lex);
129 void InsetListings::latex(otexstream & os, OutputParams const & runparams) const
131 string param_string = params().params();
132 // NOTE: I use {} to quote text, which is an experimental feature
133 // of the listings package (see page 25 of the manual)
134 bool const isInline = params().isInline();
135 // get the paragraphs. We can not output them directly to given odocstream
136 // because we can not yet determine the delimiter character of \lstinline
139 ParagraphList::const_iterator par = paragraphs().begin();
140 ParagraphList::const_iterator end = paragraphs().end();
142 bool encoding_switched = false;
143 Encoding const * const save_enc = runparams.encoding;
145 if (!runparams.isFullUnicode()
146 && !runparams.encoding->hasFixedWidth()) {
147 // We need to switch to a singlebyte encoding, since the
148 // listings package cannot deal with multi-byte-encoded
149 // glyphs (not needed with full-unicode aware backends
151 Language const * const outer_language =
152 (runparams.local_font != 0) ?
153 runparams.local_font->language()
154 : buffer().params().language;
155 // We try if there's a singlebyte encoding for the current
156 // language; if not, fall back to latin1.
157 Encoding const * const lstenc =
158 (outer_language->encoding()->hasFixedWidth()) ?
159 outer_language->encoding()
160 : encodings.fromLyXName("iso8859-1");
161 switchEncoding(os.os(), buffer().params(), runparams, *lstenc, true);
162 runparams.encoding = lstenc;
163 encoding_switched = true;
167 pos_type siz = par->size();
168 bool captionline = false;
169 for (pos_type i = 0; i < siz; ++i) {
170 if (i == 0 && par->isInset(i) && i + 1 == siz)
172 // ignore all struck out text and (caption) insets
173 if (par->isDeleted(i) || par->isInset(i))
175 char_type c = par->getChar(i);
176 // we can only output characters covered by the current
179 if (runparams.encoding->encodable(c))
181 else if (runparams.dryrun) {
182 code += "<" + _("LyX Warning: ")
183 + _("uncodable character") + " '";
184 code += docstring(1, c);
188 } catch (EncodingException & /* e */) {
189 if (runparams.dryrun) {
190 code += "<" + _("LyX Warning: ")
191 + _("uncodable character") + " '";
192 code += docstring(1, c);
199 // for the inline case, if there are multiple paragraphs
200 // they are simply joined. Otherwise, expect latex errors.
201 if (par != end && !isInline && !captionline)
205 char const * delimiter = lstinline_delimiters;
206 for (; delimiter != '\0'; ++delimiter)
207 if (!contains(code, *delimiter))
209 // This code piece contains all possible special character? !!!
210 // Replace ! with a warning message and use ! as delimiter.
211 if (*delimiter == '\0') {
212 docstring delim_error = "<" + _("LyX Warning: ")
213 + _("no more lstline delimiters available") + ">";
214 code = subst(code, from_ascii("!"), delim_error);
215 delimiter = lstinline_delimiters;
216 if (!runparams.dryrun) {
217 // FIXME: warning should be passed to the error dialog
218 frontend::Alert::warning(_("Running out of delimiters"),
219 _("For inline program listings, one character must be reserved\n"
220 "as a delimiter. One of the listings, however, uses all available\n"
221 "characters, so none is left for delimiting purposes.\n"
222 "For the time being, I have replaced '!' by a warning, but you\n"
223 "must investigate!"));
226 if (param_string.empty())
227 os << "\\lstinline" << *delimiter;
229 os << "\\lstinline[" << from_utf8(param_string) << "]" << *delimiter;
233 OutputParams rp = runparams;
234 rp.moving_arg = true;
235 docstring const caption = getCaption(rp);
236 if (param_string.empty() && caption.empty())
237 os << breakln << "\\begin{lstlisting}\n";
239 os << breakln << "\\begin{lstlisting}[";
240 if (!caption.empty()) {
241 os << "caption={" << caption << '}';
242 if (!param_string.empty())
245 os << from_utf8(param_string) << "]\n";
247 os << code << breakln << "\\end{lstlisting}\n";
250 if (encoding_switched){
252 switchEncoding(os.os(), buffer().params(), runparams, *save_enc, true);
253 runparams.encoding = save_enc;
256 if (!uncodable.empty()) {
257 // issue a warning about omitted characters
258 // FIXME: should be passed to the error dialog
259 frontend::Alert::warning(_("Uncodable characters in listings inset"),
260 bformat(_("The following characters in one of the program listings are\n"
261 "not representable in the current encoding and have been omitted:\n%1$s."),
267 docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const
269 odocstringstream ods;
270 XHTMLStream out(ods);
272 bool const isInline = params().isInline();
274 out << html::CompTag("br");
276 out << html::StartTag("div", "class='float float-listings'");
277 docstring caption = getCaptionHTML(rp);
278 if (!caption.empty())
279 out << html::StartTag("div", "class='float-caption'")
280 << caption << html::EndTag("div");
283 InsetLayout const & il = getLayout();
284 string const tag = il.htmltag();
285 string attr = "class ='listings";
286 string const lang = params().getParamValue("language");
290 out << html::StartTag(tag, attr);
291 OutputParams newrp = rp;
292 newrp.html_disable_captions = true;
293 // We don't want to convert dashes here. That's the only conversion we
294 // do for XHTML, so this is safe.
295 newrp.pass_thru = true;
296 docstring def = InsetText::insetAsXHTML(out, newrp, InsetText::JustText);
297 out << html::EndTag(tag);
300 out << html::CompTag("br");
301 // escaping will already have been done
302 os << XHTMLStream::ESCAPE_NONE << ods.str();
304 out << html::EndTag("div");
305 // In this case, this needs to be deferred, but we'll put it
306 // before anything the text itself deferred.
307 def = ods.str() + '\n' + def;
313 string InsetListings::contextMenuName() const
315 return "context-listings";
319 void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd)
321 switch (cmd.action()) {
323 case LFUN_INSET_MODIFY: {
324 cur.recordUndoInset(ATOMIC_UNDO, this);
325 InsetListings::string2params(to_utf8(cmd.argument()), params());
329 case LFUN_INSET_DIALOG_UPDATE:
330 cur.bv().updateDialog("listings", params2string(params()));
334 InsetCollapsable::doDispatch(cur, cmd);
340 bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd,
341 FuncStatus & status) const
343 switch (cmd.action()) {
344 case LFUN_INSET_MODIFY:
345 case LFUN_INSET_DIALOG_UPDATE:
346 status.setEnabled(true);
348 case LFUN_CAPTION_INSERT: {
349 if (params().isInline()) {
350 status.setEnabled(false);
355 return InsetCollapsable::getStatus(cur, cmd, status);
360 docstring const InsetListings::buttonLabel(BufferView const & bv) const
363 if (decoration() == InsetLayout::CLASSIC)
364 return isOpen(bv) ? _("Listing") : getNewLabel(_("Listing"));
366 return getNewLabel(_("Listing"));
370 void InsetListings::validate(LaTeXFeatures & features) const
372 features.require("listings");
373 string param_string = params().params();
374 if (param_string.find("\\color") != string::npos)
375 features.require("color");
376 InsetCollapsable::validate(features);
380 bool InsetListings::showInsetDialog(BufferView * bv) const
382 bv->showDialog("listings", params2string(params()),
383 const_cast<InsetListings *>(this));
388 docstring InsetListings::getCaption(OutputParams const & runparams) const
390 if (paragraphs().empty())
393 InsetCaption const * ins = getCaptionInset();
398 odocstringstream ods;
399 otexstream os(ods, texrow);
400 ins->getArgs(os, runparams);
401 ins->getArgument(os, runparams);
402 // the caption may contain \label{} but the listings
403 // package prefer caption={}, label={}
404 docstring cap = ods.str();
405 if (!contains(to_utf8(cap), "\\label{"))
408 // blah1\label{blah2} blah3
410 // blah1 blah3},label={blah2
412 // caption={blah1 blah3},label={blah2}
414 // NOTE that } is not allowed in blah2.
415 regex const reg("(.*)\\\\label\\{(.*?)\\}(.*)");
416 string const new_cap("\\1\\3},label={\\2");
417 return from_utf8(regex_replace(to_utf8(cap), reg, new_cap));
421 void InsetListings::string2params(string const & in,
422 InsetListingsParams & params)
424 params = InsetListingsParams();
427 istringstream data(in);
430 // discard "listings", which is only used to determine inset
436 string InsetListings::params2string(InsetListingsParams const & params)
439 data << "listings" << ' ';