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 int InsetListings::latex(odocstream & 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)
135 bool const isInline = params().isInline();
136 // get the paragraphs. We can not output them directly to given odocstream
137 // because we can not yet determine the delimiter character of \lstinline
140 ParagraphList::const_iterator par = paragraphs().begin();
141 ParagraphList::const_iterator end = paragraphs().end();
143 bool encoding_switched = false;
144 Encoding const * const save_enc = runparams.encoding;
146 if (!runparams.isFullUnicode()
147 && !runparams.encoding->hasFixedWidth()) {
148 // We need to switch to a singlebyte encoding, since the
149 // listings package cannot deal with multi-byte-encoded
150 // glyphs (not needed with full-unicode aware backends
152 Language const * const outer_language =
153 (runparams.local_font != 0) ?
154 runparams.local_font->language()
155 : buffer().params().language;
156 // We try if there's a singlebyte encoding for the current
157 // language; if not, fall back to latin1.
158 Encoding const * const lstenc =
159 (outer_language->encoding()->hasFixedWidth()) ?
160 outer_language->encoding()
161 : encodings.fromLyXName("iso8859-1");
162 pair<bool, int> const c = switchEncoding(os, buffer().params(),
163 runparams, *lstenc, true);
164 runparams.encoding = lstenc;
165 encoding_switched = true;
169 pos_type siz = par->size();
170 bool captionline = false;
171 for (pos_type i = 0; i < siz; ++i) {
172 if (i == 0 && par->isInset(i) && i + 1 == siz)
174 // ignore all struck out text and (caption) insets
175 if (par->isDeleted(i) || par->isInset(i))
177 char_type c = par->getChar(i);
178 // we can only output characters covered by the current
181 if (runparams.encoding->latexChar(c) == docstring(1, c))
183 else if (runparams.dryrun) {
184 code += "<" + _("LyX Warning: ")
185 + _("uncodable character") + " '";
186 code += docstring(1, c);
190 } catch (EncodingException & /* e */) {
191 if (runparams.dryrun) {
192 code += "<" + _("LyX Warning: ")
193 + _("uncodable character") + " '";
194 code += docstring(1, c);
201 // for the inline case, if there are multiple paragraphs
202 // they are simply joined. Otherwise, expect latex errors.
203 if (par != end && !isInline && !captionline) {
209 char const * delimiter = lstinline_delimiters;
210 for (; delimiter != '\0'; ++delimiter)
211 if (!contains(code, *delimiter))
213 // This code piece contains all possible special character? !!!
214 // Replace ! with a warning message and use ! as delimiter.
215 if (*delimiter == '\0') {
216 docstring delim_error = "<" + _("LyX Warning: ")
217 + _("no more lstline delimiters available") + ">";
218 code = subst(code, from_ascii("!"), delim_error);
219 delimiter = lstinline_delimiters;
220 if (!runparams.dryrun) {
221 // FIXME: warning should be passed to the error dialog
222 frontend::Alert::warning(_("Running out of delimiters"),
223 _("For inline program listings, one character must be reserved\n"
224 "as a delimiter. One of the listings, however, uses all available\n"
225 "characters, so none is left for delimiting purposes.\n"
226 "For the time being, I have replaced '!' by a warning, but you\n"
227 "must investigate!"));
230 if (param_string.empty())
231 os << "\\lstinline" << *delimiter;
233 os << "\\lstinline[" << from_utf8(param_string) << "]" << *delimiter;
237 OutputParams rp = runparams;
238 rp.moving_arg = true;
239 docstring const caption = getCaption(rp);
240 if (param_string.empty() && caption.empty())
241 os << "\n\\begin{lstlisting}\n";
243 os << "\n\\begin{lstlisting}[";
244 if (!caption.empty()) {
245 os << "caption={" << caption << '}';
246 if (!param_string.empty())
249 os << from_utf8(param_string) << "]\n";
252 os << code << "\n\\end{lstlisting}\n";
256 if (encoding_switched){
258 pair<bool, int> const c = switchEncoding(os, buffer().params(),
259 runparams, *save_enc, true);
260 runparams.encoding = save_enc;
263 if (!uncodable.empty()) {
264 // issue a warning about omitted characters
265 // FIXME: should be passed to the error dialog
266 frontend::Alert::warning(_("Uncodable characters in listings inset"),
267 bformat(_("The following characters in one of the program listings are\n"
268 "not representable in the current encoding and have been omitted:\n%1$s."),
276 docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const
278 odocstringstream ods;
279 XHTMLStream out(ods);
281 bool const isInline = params().isInline();
283 out << html::CompTag("br");
285 out << html::StartTag("div", "class='float float-listings'");
286 docstring caption = getCaptionHTML(rp);
287 if (!caption.empty())
288 out << html::StartTag("div", "class='float-caption'")
289 << caption << html::EndTag("div");
292 out << html::StartTag("pre");
293 OutputParams newrp = rp;
294 newrp.html_disable_captions = true;
295 docstring def = InsetText::insetAsXHTML(out, newrp, InsetText::JustText);
296 out << html::EndTag("pre");
299 out << html::CompTag("br");
300 // escaping will already have been done
301 os << XHTMLStream::NextRaw() << ods.str();
303 out << html::EndTag("div");
304 // In this case, this needs to be deferred, but we'll put it
305 // before anything the text itself deferred.
306 def = ods.str() + '\n' + def;
312 docstring InsetListings::contextMenu(BufferView const &, int, int) const
314 return from_ascii("context-listings");
318 void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd)
320 switch (cmd.action()) {
322 case LFUN_INSET_MODIFY: {
323 InsetListings::string2params(to_utf8(cmd.argument()), params());
327 case LFUN_INSET_DIALOG_UPDATE:
328 cur.bv().updateDialog("listings", params2string(params()));
332 InsetCollapsable::doDispatch(cur, cmd);
338 bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd,
339 FuncStatus & status) const
341 switch (cmd.action()) {
342 case LFUN_INSET_MODIFY:
343 case LFUN_INSET_DIALOG_UPDATE:
344 status.setEnabled(true);
346 case LFUN_CAPTION_INSERT:
347 status.setEnabled(!params().isInline());
350 return InsetCollapsable::getStatus(cur, cmd, status);
355 docstring const InsetListings::buttonLabel(BufferView const & bv) const
358 if (decoration() == InsetLayout::CLASSIC)
359 return isOpen(bv) ? _("Listing") : getNewLabel(_("Listing"));
361 return getNewLabel(_("Listing"));
365 void InsetListings::validate(LaTeXFeatures & features) const
367 features.require("listings");
368 string param_string = params().params();
369 if (param_string.find("\\color") != string::npos)
370 features.require("color");
371 InsetCollapsable::validate(features);
375 bool InsetListings::showInsetDialog(BufferView * bv) const
377 bv->showDialog("listings", params2string(params()),
378 const_cast<InsetListings *>(this));
383 docstring InsetListings::getCaption(OutputParams const & runparams) const
385 if (paragraphs().empty())
388 InsetCaption const * ins = getCaptionInset();
392 odocstringstream ods;
393 ins->getOptArg(ods, runparams);
394 ins->getArgument(ods, runparams);
395 // the caption may contain \label{} but the listings
396 // package prefer caption={}, label={}
397 docstring cap = ods.str();
398 if (!contains(to_utf8(cap), "\\label{"))
401 // blah1\label{blah2} blah3
403 // blah1 blah3},label={blah2
405 // caption={blah1 blah3},label={blah2}
407 // NOTE that } is not allowed in blah2.
408 regex const reg("(.*)\\\\label\\{(.*?)\\}(.*)");
409 string const new_cap("\\1\\3},label={\\2");
410 return from_utf8(regex_replace(to_utf8(cap), reg, new_cap));
414 void InsetListings::string2params(string const & in,
415 InsetListingsParams & params)
417 params = InsetListingsParams();
420 istringstream data(in);
423 // discard "listings", which is only used to determine inset
429 string InsetListings::params2string(InsetListingsParams const & params)
432 data << "listings" << ' ';