src/insets/InsetListings.cpp

   1 /**
   2  * \file InsetListings.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Bo Peng
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetListings.h"
  15
  16 #include "Buffer.h"
  17 #include "BufferView.h"
  18 #include "BufferParams.h"
  19 #include "Counters.h"
  20 #include "Cursor.h"
  21 #include "DispatchResult.h"
  22 #include "Encoding.h"
  23 #include "FuncRequest.h"
  24 #include "FuncStatus.h"
  25 #include "InsetCaption.h"
  26 #include "Language.h"
  27 #include "LaTeXFeatures.h"
  28 #include "Lexer.h"
  29 #include "output_latex.h"
  30 #include "output_xhtml.h"
  31 #include "OutputParams.h"
  32 #include "TextClass.h"
  33
  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"
  39
  40 #include "frontends/alert.h"
  41 #include "frontends/Application.h"
  42
  43 #include "support/regex.h"
  44
  45 #include <sstream>
  46
  47 using namespace std;
  48 using namespace lyx::support;
  49
  50 namespace lyx {
  51
  52
  53 char const lstinline_delimiters[] =
  54         "!*()-=+|;:'\"`,<.>/?QWERTYUIOPASDFGHJKLZXCVBNMqwertyuiopasdfghjklzxcvbnm";
  55
  56 InsetListings::InsetListings(Buffer * buf, InsetListingsParams const & par)
  57         : InsetCollapsable(buf)
  58 {
  59         status_ = par.status();
  60 }
  61
  62
  63 InsetListings::~InsetListings()
  64 {
  65         hideDialogs("listings", this);
  66 }
  67
  68
  69 Inset::DisplayType InsetListings::display() const
  70 {
  71         return params().isInline() || params().isFloat() ? Inline : AlignLeft;
  72 }
  73
  74
  75 void InsetListings::updateBuffer(ParIterator const & it, UpdateType utype)
  76 {
  77         Counters & cnts =
  78                 buffer().masterBuffer()->params().documentClass().counters();
  79         string const saveflt = cnts.current_float();
  80
  81         // Tell to captions what the current float is
  82         cnts.current_float("listing");
  83
  84         InsetCollapsable::updateBuffer(it, utype);
  85
  86         //reset afterwards
  87         cnts.current_float(saveflt);
  88 }
  89
  90
  91 void InsetListings::write(ostream & os) const
  92 {
  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();
  97         if (!opt.empty())
  98                 os << "lstparams \"" << opt << "\"\n";
  99         if (par.isInline())
 100                 os << "inline true\n";
 101         else
 102                 os << "inline false\n";
 103         InsetCollapsable::write(os);
 104 }
 105
 106
 107 void InsetListings::read(Lexer & lex)
 108 {
 109         while (lex.isOK()) {
 110                 lex.next();
 111                 string token = lex.getString();
 112                 if (token == "lstparams") {
 113                         lex.next();
 114                         string const value = lex.getString();
 115                         params().fromEncodedString(value);
 116                 } else if (token == "inline") {
 117                         lex.next();
 118                         params().setInline(lex.getBool());
 119                 } else {
 120                         // no special option, push back 'status' etc
 121                         lex.pushToken(token);
 122                         break;
 123                 }
 124         }
 125         InsetCollapsable::read(lex);
 126 }
 127
 128
 129 void InsetListings::latex(otexstream & os, OutputParams const & runparams) const
 130 {
 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
 137         docstring code;
 138         docstring uncodable;
 139         ParagraphList::const_iterator par = paragraphs().begin();
 140         ParagraphList::const_iterator end = paragraphs().end();
 141
 142         bool encoding_switched = false;
 143         Encoding const * const save_enc = runparams.encoding;
 144
 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
 150                 // such as XeTeX).
 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;
 164         }
 165
 166         while (par != end) {
 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)
 171                                 captionline = true;
 172                         // ignore all struck out text and (caption) insets
 173                         if (par->isDeleted(i) || par->isInset(i))
 174                                 continue;
 175                         char_type c = par->getChar(i);
 176                         // we can only output characters covered by the current
 177                         // encoding!
 178                         try {
 179                                 if (runparams.encoding->encodable(c))
 180                                         code += c;
 181                                 else if (runparams.dryrun) {
 182                                         code += "<" + _("LyX Warning: ")
 183                                            + _("uncodable character") + " '";
 184                                         code += docstring(1, c);
 185                                         code += "'>";
 186                                 } else
 187                                         uncodable += c;
 188                         } catch (EncodingException & /* e */) {
 189                                 if (runparams.dryrun) {
 190                                         code += "<" + _("LyX Warning: ")
 191                                            + _("uncodable character") + " '";
 192                                         code += docstring(1, c);
 193                                         code += "'>";
 194                                 } else
 195                                         uncodable += c;
 196                         }
 197                 }
 198                 ++par;
 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)
 202                         code += "\n";
 203         }
 204         if (isInline) {
 205                 char const * delimiter = lstinline_delimiters;
 206                 for (; delimiter != '\0'; ++delimiter)
 207                         if (!contains(code, *delimiter))
 208                                 break;
 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!"));
 224                         }
 225                 }
 226                 if (param_string.empty())
 227                         os << "\\lstinline" << *delimiter;
 228                 else
 229                         os << "\\lstinline[" << from_utf8(param_string) << "]" << *delimiter;
 230                 os << code
 231                    << *delimiter;
 232         } else {
 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";
 238                 else {
 239                         os << breakln << "\\begin{lstlisting}[";
 240                         if (!caption.empty()) {
 241                                 os << "caption={" << caption << '}';
 242                                 if (!param_string.empty())
 243                                         os << ',';
 244                         }
 245                         os << from_utf8(param_string) << "]\n";
 246                 }
 247                 os << code << breakln << "\\end{lstlisting}\n";
 248         }
 249
 250         if (encoding_switched){
 251                 // Switch back
 252                 switchEncoding(os.os(), buffer().params(), runparams, *save_enc, true);
 253                 runparams.encoding = save_enc;
 254         }
 255
 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."),
 262                         uncodable));
 263         }
 264 }
 265
 266
 267 docstring InsetListings::xhtml(XHTMLStream & os, OutputParams const & rp) const
 268 {
 269         odocstringstream ods;
 270         XHTMLStream out(ods);
 271
 272         bool const isInline = params().isInline();
 273         if (isInline)
 274                 out << html::CompTag("br");
 275         else {
 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");
 281         }
 282
 283         out << html::StartTag("pre");
 284         OutputParams newrp = rp;
 285         newrp.html_disable_captions = true;
 286         docstring def = InsetText::insetAsXHTML(out, newrp, InsetText::JustText);
 287         out << html::EndTag("pre");
 288
 289         if (isInline) {
 290                 out << html::CompTag("br");
 291                 // escaping will already have been done
 292                 os << XHTMLStream::ESCAPE_NONE << ods.str();
 293         } else {
 294                 out << html::EndTag("div");
 295                 // In this case, this needs to be deferred, but we'll put it
 296                 // before anything the text itself deferred.
 297                 def = ods.str() + '\n' + def;
 298         }
 299         return def;
 300 }
 301
 302
 303 string InsetListings::contextMenuName() const
 304 {
 305         return "context-listings";
 306 }
 307
 308
 309 void InsetListings::doDispatch(Cursor & cur, FuncRequest & cmd)
 310 {
 311         switch (cmd.action()) {
 312
 313         case LFUN_INSET_MODIFY: {
 314                 cur.recordUndoInset(ATOMIC_UNDO, this);
 315                 InsetListings::string2params(to_utf8(cmd.argument()), params());
 316                 break;
 317         }
 318
 319         case LFUN_INSET_DIALOG_UPDATE:
 320                 cur.bv().updateDialog("listings", params2string(params()));
 321                 break;
 322
 323         default:
 324                 InsetCollapsable::doDispatch(cur, cmd);
 325                 break;
 326         }
 327 }
 328
 329
 330 bool InsetListings::getStatus(Cursor & cur, FuncRequest const & cmd,
 331         FuncStatus & status) const
 332 {
 333         switch (cmd.action()) {
 334                 case LFUN_INSET_MODIFY:
 335                 case LFUN_INSET_DIALOG_UPDATE:
 336                         status.setEnabled(true);
 337                         return true;
 338                 case LFUN_CAPTION_INSERT:
 339                         status.setEnabled(!params().isInline());
 340                         return true;
 341                 default:
 342                         return InsetCollapsable::getStatus(cur, cmd, status);
 343         }
 344 }
 345
 346
 347 docstring const InsetListings::buttonLabel(BufferView const & bv) const
 348 {
 349         // FIXME UNICODE
 350         if (decoration() == InsetLayout::CLASSIC)
 351                 return isOpen(bv) ? _("Listing") : getNewLabel(_("Listing"));
 352         else
 353                 return getNewLabel(_("Listing"));
 354 }
 355
 356
 357 void InsetListings::validate(LaTeXFeatures & features) const
 358 {
 359         features.require("listings");
 360         string param_string = params().params();
 361         if (param_string.find("\\color") != string::npos)
 362                 features.require("color");
 363         InsetCollapsable::validate(features);
 364 }
 365
 366
 367 bool InsetListings::showInsetDialog(BufferView * bv) const
 368 {
 369         bv->showDialog("listings", params2string(params()),
 370                 const_cast<InsetListings *>(this));
 371         return true;
 372 }
 373
 374
 375 docstring InsetListings::getCaption(OutputParams const & runparams) const
 376 {
 377         if (paragraphs().empty())
 378                 return docstring();
 379
 380         InsetCaption const * ins = getCaptionInset();
 381         if (ins == 0)
 382                 return docstring();
 383
 384         TexRow texrow;
 385         odocstringstream ods;
 386         otexstream os(ods, texrow);
 387         ins->getArgs(os, runparams);
 388         ins->getArgument(os, runparams);
 389         // the caption may contain \label{} but the listings
 390         // package prefer caption={}, label={}
 391         docstring cap = ods.str();
 392         if (!contains(to_utf8(cap), "\\label{"))
 393                 return cap;
 394         // convert from
 395         //     blah1\label{blah2} blah3
 396         // to
 397         //     blah1 blah3},label={blah2
 398         // to form options
 399         //     caption={blah1 blah3},label={blah2}
 400         //
 401         // NOTE that } is not allowed in blah2.
 402         regex const reg("(.*)\\\\label\\{(.*?)\\}(.*)");
 403         string const new_cap("\\1\\3},label={\\2");
 404         return from_utf8(regex_replace(to_utf8(cap), reg, new_cap));
 405 }
 406
 407
 408 void InsetListings::string2params(string const & in,
 409                                    InsetListingsParams & params)
 410 {
 411         params = InsetListingsParams();
 412         if (in.empty())
 413                 return;
 414         istringstream data(in);
 415         Lexer lex;
 416         lex.setStream(data);
 417         // discard "listings", which is only used to determine inset
 418         lex.next();
 419         params.read(lex);
 420 }
 421
 422
 423 string InsetListings::params2string(InsetListingsParams const & params)
 424 {
 425         ostringstream data;
 426         data << "listings" << ' ';
 427         params.write(data);
 428         return data.str();
 429 }
 430
 431
 432 } // namespace lyx