3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "Converter.h"
16 #include "buffer_funcs.h"
17 #include "BufferParams.h"
18 #include "ConverterCache.h"
20 #include "ErrorList.h"
26 #include "frontends/alert.h"
28 #include "support/debug.h"
29 #include "support/FileNameList.h"
30 #include "support/filetools.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
33 #include "support/os.h"
34 #include "support/Package.h"
35 #include "support/Path.h"
36 #include "support/Systemcall.h"
39 using namespace lyx::support;
43 namespace Alert = lyx::frontend::Alert;
48 string const token_from("$$i");
49 string const token_base("$$b");
50 string const token_to("$$o");
51 string const token_path("$$p");
52 string const token_orig_path("$$r");
53 string const token_encoding("$$e");
54 string const token_latex_encoding("$$E");
57 string const add_options(string const & command, string const & options)
60 string const tail = split(command, head, ' ');
61 return head + ' ' + options + ' ' + tail;
65 string const dvipdfm_options(BufferParams const & bp)
69 if (bp.papersize != PAPER_CUSTOM) {
70 string const paper_size = bp.paperSizeName(BufferParams::DVIPDFM);
71 if (!paper_size.empty())
72 result = "-p "+ paper_size;
74 if (bp.orientation == ORIENTATION_LANDSCAPE)
82 class ConverterEqual {
84 ConverterEqual(string const & from, string const & to)
85 : from_(from), to_(to) {}
86 bool operator()(Converter const & c) const {
87 return c.from == from_ && c.to == to_;
97 Converter::Converter(string const & f, string const & t,
98 string const & c, string const & l)
99 : from(f), to(t), command(c), flags(l),
100 From(0), To(0), latex(false), xml(false),
105 void Converter::readFlags()
107 string flag_list(flags);
108 while (!flag_list.empty()) {
109 string flag_name, flag_value;
110 flag_list = split(flag_list, flag_value, ',');
111 flag_value = split(flag_value, flag_name, '=');
112 if (flag_name == "latex") {
114 latex_flavor = flag_value.empty() ?
115 "latex" : flag_value;
116 } else if (flag_name == "xml")
118 else if (flag_name == "needaux")
120 else if (flag_name == "resultdir")
121 result_dir = (flag_value.empty())
122 ? token_base : flag_value;
123 else if (flag_name == "resultfile")
124 result_file = flag_value;
125 else if (flag_name == "parselog")
126 parselog = flag_value;
128 if (!result_dir.empty() && result_file.empty())
129 result_file = "index." + formats.extension(to);
130 //if (!contains(command, token_from))
135 Converter const * Converters::getConverter(string const & from,
136 string const & to) const
138 ConverterList::const_iterator const cit =
139 find_if(converterlist_.begin(), converterlist_.end(),
140 ConverterEqual(from, to));
141 if (cit != converterlist_.end())
148 int Converters::getNumber(string const & from, string const & to) const
150 ConverterList::const_iterator const cit =
151 find_if(converterlist_.begin(), converterlist_.end(),
152 ConverterEqual(from, to));
153 if (cit != converterlist_.end())
154 return distance(converterlist_.begin(), cit);
160 void Converters::add(string const & from, string const & to,
161 string const & command, string const & flags)
165 ConverterList::iterator it = find_if(converterlist_.begin(),
166 converterlist_.end(),
167 ConverterEqual(from , to));
169 Converter converter(from, to, command, flags);
170 if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
172 converter.command = command;
173 converter.flags = flags;
175 converter.readFlags();
177 // If we have both latex & pdflatex, we set latex_command to latex.
178 // The latex_command is used to update the .aux file when running
179 // a converter that uses it.
181 && (latex_command_.empty() || converter.latex_flavor == "latex"))
182 latex_command_ = subst(command, token_from, "");
183 // Similarly, set xelatex_command to xelatex.
185 && (xelatex_command_.empty() || converter.latex_flavor == "xelatex"))
186 xelatex_command_ = subst(command, token_from, "");
188 if (it == converterlist_.end()) {
189 converterlist_.push_back(converter);
191 converter.From = it->From;
192 converter.To = it->To;
198 void Converters::erase(string const & from, string const & to)
200 ConverterList::iterator const it =
201 find_if(converterlist_.begin(),
202 converterlist_.end(),
203 ConverterEqual(from, to));
204 if (it != converterlist_.end())
205 converterlist_.erase(it);
209 // This method updates the pointers From and To in all the converters.
210 // The code is not very efficient, but it doesn't matter as the number
211 // of formats and converters is small.
212 // Furthermore, this method is called only on startup, or after
213 // adding/deleting a format in FormPreferences (the latter calls can be
214 // eliminated if the formats in the Formats class are stored using a map or
215 // a list (instead of a vector), but this will cause other problems).
216 void Converters::update(Formats const & formats)
218 ConverterList::iterator it = converterlist_.begin();
219 ConverterList::iterator end = converterlist_.end();
220 for (; it != end; ++it) {
221 it->From = formats.getFormat(it->from);
222 it->To = formats.getFormat(it->to);
227 // This method updates the pointers From and To in the last converter.
228 // It is called when adding a new converter in FormPreferences
229 void Converters::updateLast(Formats const & formats)
231 if (converterlist_.begin() != converterlist_.end()) {
232 ConverterList::iterator it = converterlist_.end() - 1;
233 it->From = formats.getFormat(it->from);
234 it->To = formats.getFormat(it->to);
239 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
241 for (Graph::EdgePath::const_iterator cit = path.begin();
242 cit != path.end(); ++cit) {
243 Converter const & conv = converterlist_[*cit];
245 if (conv.latex_flavor == "xelatex")
246 return OutputParams::XETEX;
247 if (conv.latex_flavor == "lualatex")
248 return OutputParams::LUATEX;
249 if (conv.latex_flavor == "dvilualatex")
250 return OutputParams::DVILUATEX;
251 if (conv.latex_flavor == "pdflatex")
252 return OutputParams::PDFLATEX;
254 return OutputParams::XML;
256 return OutputParams::LATEX;
260 bool Converters::convert(Buffer const * buffer,
261 FileName const & from_file, FileName const & to_file,
262 FileName const & orig_from,
263 string const & from_format, string const & to_format,
264 ErrorList & errorList, int conversionflags)
266 if (from_format == to_format)
267 return move(from_format, from_file, to_file, false);
269 if ((conversionflags & try_cache) &&
270 ConverterCache::get().inCache(orig_from, to_format))
271 return ConverterCache::get().copy(orig_from, to_format, to_file);
273 Graph::EdgePath edgepath = getPath(from_format, to_format);
274 if (edgepath.empty()) {
275 if (conversionflags & try_default) {
276 // if no special converter defined, then we take the
277 // default one from ImageMagic.
278 string const from_ext = from_format.empty() ?
279 getExtension(from_file.absFileName()) :
280 formats.extension(from_format);
281 string const to_ext = formats.extension(to_format);
282 string const command =
284 quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) +
286 quoteName(from_ext + ':' + from_file.toFilesystemEncoding()) +
288 quoteName(to_ext + ':' + to_file.toFilesystemEncoding());
289 LYXERR(Debug::FILES, "No converter defined! "
290 "I use convertDefault.py:\n\t" << command);
292 one.startscript(Systemcall::Wait, command, buffer ?
293 buffer->filePath() : string());
294 if (to_file.isReadableFile()) {
295 if (conversionflags & try_cache)
296 ConverterCache::get().add(orig_from,
302 // only warn once per session and per file type
303 static std::map<string, string> warned;
304 if (warned.find(from_format) != warned.end() && warned.find(from_format)->second == to_format) {
307 warned.insert(make_pair(from_format, to_format));
309 Alert::error(_("Cannot convert file"),
310 bformat(_("No information for converting %1$s "
311 "format files to %2$s.\n"
312 "Define a converter in the preferences."),
313 from_ascii(from_format), from_ascii(to_format)));
317 // buffer is only invalid for importing, and then runparams is not
319 OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
320 runparams.flavor = getFlavor(edgepath);
323 runparams.use_japanese = buffer->params().bufferFormat() == "platex";
324 runparams.use_indices = buffer->params().use_indices;
325 runparams.bibtex_command = (buffer->params().bibtex_command == "default") ?
326 string() : buffer->params().bibtex_command;
327 runparams.index_command = (buffer->params().index_command == "default") ?
328 string() : buffer->params().index_command;
331 // Some converters (e.g. lilypond) can only output files to the
332 // current directory, so we need to change the current directory.
333 // This has the added benefit that all other files that may be
334 // generated by the converter are deleted when LyX closes and do not
335 // clutter the real working directory.
336 string const path(onlyPath(from_file.absFileName()));
337 // Prevent the compiler from optimizing away p
341 // empty the error list before any new conversion takes place.
344 bool run_latex = false;
345 string from_base = changeExtension(from_file.absFileName(), "");
346 string to_base = changeExtension(to_file.absFileName(), "");
348 FileName outfile = from_file;
349 for (Graph::EdgePath::const_iterator cit = edgepath.begin();
350 cit != edgepath.end(); ++cit) {
351 Converter const & conv = converterlist_[*cit];
352 bool dummy = conv.To->dummy() && conv.to != "program";
354 LYXERR(Debug::FILES, "Converting from "
355 << conv.from << " to " << conv.to);
358 outfile = FileName(conv.result_dir.empty()
359 ? changeExtension(from_file.absFileName(), conv.To->extension())
360 : addName(subst(conv.result_dir,
361 token_base, from_base),
362 subst(conv.result_file,
363 token_base, onlyFileName(from_base))));
365 // if input and output files are equal, we use a
366 // temporary file as intermediary (JMarc)
367 FileName real_outfile;
368 if (outfile == infile) {
369 real_outfile = infile;
370 // when importing, a buffer does not necessarily exist
372 outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
374 outfile = FileName(addName(package().temp_dir().absFileName(),
380 string command = conv.command;
381 command = subst(command, token_from, "");
382 command = subst(command, token_latex_encoding, buffer ?
383 buffer->params().encoding().latexName() : string());
384 LYXERR(Debug::FILES, "Running " << command);
385 if (!runLaTeX(*buffer, command, runparams, errorList))
388 if (conv.need_aux && !run_latex
389 && !latex_command_.empty()) {
390 string const command = (buffer && buffer->params().useNonTeXFonts) ?
391 xelatex_command_ : latex_command_;
392 LYXERR(Debug::FILES, "Running " << command
393 << " to update aux file");
394 if (!runLaTeX(*buffer, command, runparams, errorList))
399 string const infile2 =
400 to_utf8(makeRelPath(from_utf8(infile.absFileName()), from_utf8(path)));
401 string const outfile2 =
402 to_utf8(makeRelPath(from_utf8(outfile.absFileName()), from_utf8(path)));
404 string command = conv.command;
405 command = subst(command, token_from, quoteName(infile2));
406 command = subst(command, token_base, quoteName(from_base));
407 command = subst(command, token_to, quoteName(outfile2));
408 command = subst(command, token_path, quoteName(onlyPath(infile.absFileName())));
409 command = subst(command, token_orig_path, quoteName(onlyPath(orig_from.absFileName())));
410 command = subst(command, token_encoding, buffer ? buffer->params().encoding().iconvName() : string());
411 command = libScriptSearch(command);
413 if (!conv.parselog.empty())
414 command += " 2> " + quoteName(infile2 + ".out");
416 if (conv.from == "dvi" && conv.to == "ps")
417 command = add_options(command,
418 buffer->params().dvips_options());
419 else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
420 command = add_options(command,
421 dvipdfm_options(buffer->params()));
423 LYXERR(Debug::FILES, "Calling " << command);
425 buffer->message(_("Executing command: ")
426 + from_utf8(command));
431 res = one.startscript(Systemcall::DontWait,
432 to_filesystem8bit(from_utf8(command)),
433 buffer ? buffer->filePath() : string());
434 // We're not waiting for the result, so we can't do anything
437 res = one.startscript(Systemcall::Wait,
438 to_filesystem8bit(from_utf8(command)),
439 buffer ? buffer->filePath()
441 if (!real_outfile.empty()) {
442 Mover const & mover = getMover(conv.to);
443 if (!mover.rename(outfile, real_outfile))
446 LYXERR(Debug::FILES, "renaming file " << outfile
447 << " to " << real_outfile);
448 // Finally, don't forget to tell any future
449 // converters to use the renamed file...
450 outfile = real_outfile;
453 if (!conv.parselog.empty()) {
454 string const logfile = infile2 + ".log";
455 string const script = libScriptSearch(conv.parselog);
456 string const command2 = script +
457 " < " + quoteName(infile2 + ".out") +
458 " > " + quoteName(logfile);
459 one.startscript(Systemcall::Wait,
460 to_filesystem8bit(from_utf8(command2)),
462 if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
468 if (conv.to == "program") {
469 Alert::error(_("Build errors"),
470 _("There were errors during the build process."));
472 // FIXME: this should go out of here. For example, here we cannot say if
473 // it is a document (.lyx) or something else. Same goes for elsewhere.
474 Alert::error(_("Cannot convert file"),
475 bformat(_("An error occurred while running:\n%1$s"),
476 wrapParas(from_utf8(command))));
483 Converter const & conv = converterlist_[edgepath.back()];
484 if (conv.To->dummy())
487 if (!conv.result_dir.empty()) {
488 // The converter has put the file(s) in a directory.
489 // In this case we ignore the given to_file.
490 if (from_base != to_base) {
491 string const from = subst(conv.result_dir,
492 token_base, from_base);
493 string const to = subst(conv.result_dir,
494 token_base, to_base);
495 Mover const & mover = getMover(conv.from);
496 if (!mover.rename(FileName(from), FileName(to))) {
497 Alert::error(_("Cannot convert file"),
498 bformat(_("Could not move a temporary directory from %1$s to %2$s."),
499 from_utf8(from), from_utf8(to)));
505 if (conversionflags & try_cache)
506 ConverterCache::get().add(orig_from, to_format, outfile);
507 return move(conv.to, outfile, to_file, conv.latex);
512 bool Converters::move(string const & fmt,
513 FileName const & from, FileName const & to, bool copy)
518 bool no_errors = true;
519 string const path = onlyPath(from.absFileName());
520 string const base = onlyFileName(removeExtension(from.absFileName()));
521 string const to_base = removeExtension(to.absFileName());
522 string const to_extension = getExtension(to.absFileName());
524 support::FileNameList const files = FileName(path).dirList(getExtension(from.absFileName()));
525 for (support::FileNameList::const_iterator it = files.begin();
526 it != files.end(); ++it) {
527 string const from2 = it->absFileName();
528 string const file2 = onlyFileName(from2);
529 if (prefixIs(file2, base)) {
530 string const to2 = changeExtension(
531 to_base + file2.substr(base.length()),
533 LYXERR(Debug::FILES, "moving " << from2 << " to " << to2);
535 Mover const & mover = getMover(fmt);
536 bool const moved = copy
537 ? mover.copy(*it, FileName(to2))
538 : mover.rename(*it, FileName(to2));
539 if (!moved && no_errors) {
540 Alert::error(_("Cannot convert file"),
542 _("Could not copy a temporary file from %1$s to %2$s.") :
543 _("Could not move a temporary file from %1$s to %2$s."),
544 from_utf8(from2), from_utf8(to2)));
553 bool Converters::formatIsUsed(string const & format)
555 ConverterList::const_iterator cit = converterlist_.begin();
556 ConverterList::const_iterator end = converterlist_.end();
557 for (; cit != end; ++cit) {
558 if (cit->from == format || cit->to == format)
565 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
566 FileName const & filename, ErrorList & errorList)
568 OutputParams runparams(0);
569 runparams.flavor = OutputParams::LATEX;
570 LaTeX latex("", runparams, filename);
572 int const result = latex.scanLogFile(terr);
574 if (result & LaTeX::ERRORS)
575 buffer.bufferErrors(terr, errorList);
584 : public boost::signals::trackable {
586 ShowMessage(Buffer const & b) : buffer_(b) {}
587 void operator()(docstring const & msg) const { buffer_.message(msg); }
589 Buffer const & buffer_;
595 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
596 OutputParams const & runparams, ErrorList & errorList)
598 buffer.setBusy(true);
599 buffer.message(_("Running LaTeX..."));
601 runparams.document_language = buffer.params().language->babel();
603 // do the LaTeX run(s)
604 string const name = buffer.latexName();
605 LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
608 ShowMessage show(buffer);
609 latex.message.connect(show);
610 int const result = latex.run(terr);
612 if (result & LaTeX::ERRORS)
613 buffer.bufferErrors(terr, errorList);
615 // check return value from latex.run().
616 if ((result & LaTeX::NO_LOGFILE) && !buffer.isClone()) {
617 docstring const str =
618 bformat(_("LaTeX did not run successfully. "
619 "Additionally, LyX could not locate "
620 "the LaTeX log %1$s."), from_utf8(name));
621 Alert::error(_("LaTeX failed"), str);
622 } else if ((result & LaTeX::NO_OUTPUT) && !buffer.isClone()) {
623 Alert::warning(_("Output is empty"),
624 _("An empty output file was generated."));
628 buffer.setBusy(false);
630 int const ERROR_MASK =
635 return (result & ERROR_MASK) == 0;
641 void Converters::buildGraph()
643 // clear graph's data structures
644 G_.init(formats.size());
645 // each of the converters knows how to convert one format to another
646 // so, for each of them, we create an arrow on the graph, going from
647 // the one to the other
648 ConverterList::iterator it = converterlist_.begin();
649 ConverterList::iterator const end = converterlist_.end();
650 for (; it != end ; ++it) {
651 int const from = formats.getNumber(it->from);
652 int const to = formats.getNumber(it->to);
653 G_.addEdge(from, to);
658 vector<Format const *> const
659 Converters::intToFormat(vector<int> const & input)
661 vector<Format const *> result(input.size());
663 vector<int>::const_iterator it = input.begin();
664 vector<int>::const_iterator const end = input.end();
665 vector<Format const *>::iterator rit = result.begin();
666 for ( ; it != end; ++it, ++rit) {
667 *rit = &formats.get(*it);
673 vector<Format const *> const
674 Converters::getReachableTo(string const & target, bool const clear_visited)
676 vector<int> const & reachablesto =
677 G_.getReachableTo(formats.getNumber(target), clear_visited);
679 return intToFormat(reachablesto);
683 vector<Format const *> const
684 Converters::getReachable(string const & from, bool const only_viewable,
685 bool const clear_visited, set<string> const & excludes)
687 set<int> excluded_numbers;;
689 set<string>::const_iterator sit = excludes.begin();
690 set<string>::const_iterator const end = excludes.end();
691 for (; sit != end; ++sit)
692 excluded_numbers.insert(formats.getNumber(*sit));
694 vector<int> const & reachables =
695 G_.getReachable(formats.getNumber(from),
700 return intToFormat(reachables);
704 bool Converters::isReachable(string const & from, string const & to)
706 return G_.isReachable(formats.getNumber(from),
707 formats.getNumber(to));
711 Graph::EdgePath Converters::getPath(string const & from, string const & to)
713 return G_.getPath(formats.getNumber(from),
714 formats.getNumber(to));
718 vector<Format const *> Converters::importableFormats()
720 vector<string> l = loaders();
721 vector<Format const *> result = getReachableTo(l[0], true);
722 vector<string>::const_iterator it = l.begin() + 1;
723 vector<string>::const_iterator en = l.end();
724 for (; it != en; ++it) {
725 vector<Format const *> r = getReachableTo(*it, false);
726 result.insert(result.end(), r.begin(), r.end());
732 vector<Format const *> Converters::exportableFormats(bool only_viewable)
734 vector<string> s = savers();
735 vector<Format const *> result = getReachable(s[0], only_viewable, true);
736 vector<string>::const_iterator it = s.begin() + 1;
737 vector<string>::const_iterator en = s.end();
738 for (; it != en; ++it) {
739 vector<Format const *> r =
740 getReachable(*it, only_viewable, false);
741 result.insert(result.end(), r.begin(), r.end());
747 vector<string> Converters::loaders() const
752 v.push_back("textparagraph");
757 vector<string> Converters::savers() const
760 v.push_back("docbook");
761 v.push_back("latex");
762 v.push_back("literate");
763 v.push_back("luatex");
764 v.push_back("dviluatex");
766 v.push_back("xhtml");
767 v.push_back("pdflatex");
768 v.push_back("platex");
770 v.push_back("xetex");