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");
56 string const add_options(string const & command, string const & options)
59 string const tail = split(command, head, ' ');
60 return head + ' ' + options + ' ' + tail;
64 string const dvipdfm_options(BufferParams const & bp)
68 if (bp.papersize != PAPER_CUSTOM) {
69 string const paper_size = bp.paperSizeName(BufferParams::DVIPDFM);
70 if (!paper_size.empty())
71 result = "-p "+ paper_size;
73 if (bp.orientation == ORIENTATION_LANDSCAPE)
81 class ConverterEqual {
83 ConverterEqual(string const & from, string const & to)
84 : from_(from), to_(to) {}
85 bool operator()(Converter const & c) const {
86 return c.from == from_ && c.to == to_;
96 Converter::Converter(string const & f, string const & t,
97 string const & c, string const & l)
98 : from(f), to(t), command(c), flags(l),
99 From(0), To(0), latex(false), xml(false),
104 void Converter::readFlags()
106 string flag_list(flags);
107 while (!flag_list.empty()) {
108 string flag_name, flag_value;
109 flag_list = split(flag_list, flag_value, ',');
110 flag_value = split(flag_value, flag_name, '=');
111 if (flag_name == "latex") {
113 latex_flavor = flag_value.empty() ?
114 "latex" : flag_value;
115 } else if (flag_name == "xml")
117 else if (flag_name == "needaux")
119 else if (flag_name == "resultdir")
120 result_dir = (flag_value.empty())
121 ? token_base : flag_value;
122 else if (flag_name == "resultfile")
123 result_file = flag_value;
124 else if (flag_name == "parselog")
125 parselog = flag_value;
127 if (!result_dir.empty() && result_file.empty())
128 result_file = "index." + formats.extension(to);
129 //if (!contains(command, token_from))
134 bool operator<(Converter const & a, Converter const & b)
136 // use the compare_ascii_no_case instead of compare_no_case,
137 // because in turkish, 'i' is not the lowercase version of 'I',
138 // and thus turkish locale breaks parsing of tags.
139 int const i = compare_ascii_no_case(a.From->prettyname(),
140 b.From->prettyname());
142 return compare_ascii_no_case(a.To->prettyname(),
143 b.To->prettyname()) < 0;
149 Converter const * Converters::getConverter(string const & from,
150 string const & to) const
152 ConverterList::const_iterator const cit =
153 find_if(converterlist_.begin(), converterlist_.end(),
154 ConverterEqual(from, to));
155 if (cit != converterlist_.end())
162 int Converters::getNumber(string const & from, string const & to) const
164 ConverterList::const_iterator const cit =
165 find_if(converterlist_.begin(), converterlist_.end(),
166 ConverterEqual(from, to));
167 if (cit != converterlist_.end())
168 return distance(converterlist_.begin(), cit);
174 void Converters::add(string const & from, string const & to,
175 string const & command, string const & flags)
179 ConverterList::iterator it = find_if(converterlist_.begin(),
180 converterlist_.end(),
181 ConverterEqual(from , to));
183 Converter converter(from, to, command, flags);
184 if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
186 converter.command = command;
187 converter.flags = flags;
189 converter.readFlags();
191 // If we have both latex & pdflatex, we set latex_command to latex.
192 // The latex_command is used to update the .aux file when running
193 // a converter that uses it.
195 && (latex_command_.empty() || converter.latex_flavor == "latex"))
196 latex_command_ = subst(command, token_from, "");
197 // Similarly, set xelatex_command to xelatex.
199 && (xelatex_command_.empty() || converter.latex_flavor == "xelatex"))
200 xelatex_command_ = subst(command, token_from, "");
202 if (it == converterlist_.end()) {
203 converterlist_.push_back(converter);
205 converter.From = it->From;
206 converter.To = it->To;
212 void Converters::erase(string const & from, string const & to)
214 ConverterList::iterator const it =
215 find_if(converterlist_.begin(),
216 converterlist_.end(),
217 ConverterEqual(from, to));
218 if (it != converterlist_.end())
219 converterlist_.erase(it);
223 // This method updates the pointers From and To in all the converters.
224 // The code is not very efficient, but it doesn't matter as the number
225 // of formats and converters is small.
226 // Furthermore, this method is called only on startup, or after
227 // adding/deleting a format in FormPreferences (the latter calls can be
228 // eliminated if the formats in the Formats class are stored using a map or
229 // a list (instead of a vector), but this will cause other problems).
230 void Converters::update(Formats const & formats)
232 ConverterList::iterator it = converterlist_.begin();
233 ConverterList::iterator end = converterlist_.end();
234 for (; it != end; ++it) {
235 it->From = formats.getFormat(it->from);
236 it->To = formats.getFormat(it->to);
241 // This method updates the pointers From and To in the last converter.
242 // It is called when adding a new converter in FormPreferences
243 void Converters::updateLast(Formats const & formats)
245 if (converterlist_.begin() != converterlist_.end()) {
246 ConverterList::iterator it = converterlist_.end() - 1;
247 it->From = formats.getFormat(it->from);
248 it->To = formats.getFormat(it->to);
253 void Converters::sort()
255 std::sort(converterlist_.begin(), converterlist_.end());
259 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
261 for (Graph::EdgePath::const_iterator cit = path.begin();
262 cit != path.end(); ++cit) {
263 Converter const & conv = converterlist_[*cit];
265 if (conv.latex_flavor == "xelatex")
266 return OutputParams::XETEX;
267 if (conv.latex_flavor == "lualatex")
268 return OutputParams::LUATEX;
269 if (conv.latex_flavor == "pdflatex")
270 return OutputParams::PDFLATEX;
272 return OutputParams::XML;
274 return OutputParams::LATEX;
278 bool Converters::convert(Buffer const * buffer,
279 FileName const & from_file, FileName const & to_file,
280 FileName const & orig_from,
281 string const & from_format, string const & to_format,
282 ErrorList & errorList, int conversionflags)
284 if (from_format == to_format)
285 return move(from_format, from_file, to_file, false);
287 if ((conversionflags & try_cache) &&
288 ConverterCache::get().inCache(orig_from, to_format))
289 return ConverterCache::get().copy(orig_from, to_format, to_file);
291 Graph::EdgePath edgepath = getPath(from_format, to_format);
292 if (edgepath.empty()) {
293 if (conversionflags & try_default) {
294 // if no special converter defined, then we take the
295 // default one from ImageMagic.
296 string const from_ext = from_format.empty() ?
297 getExtension(from_file.absFileName()) :
298 formats.extension(from_format);
299 string const to_ext = formats.extension(to_format);
300 string const command =
302 quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) +
304 quoteName(from_ext + ':' + from_file.toFilesystemEncoding()) +
306 quoteName(to_ext + ':' + to_file.toFilesystemEncoding());
307 LYXERR(Debug::FILES, "No converter defined! "
308 "I use convertDefault.py:\n\t" << command);
310 one.startscript(Systemcall::Wait, command);
311 if (to_file.isReadableFile()) {
312 if (conversionflags & try_cache)
313 ConverterCache::get().add(orig_from,
319 // only warn once per session and per file type
320 static std::map<string, string> warned;
321 if (warned.find(from_format) != warned.end() && warned.find(from_format)->second == to_format) {
324 warned.insert(make_pair(from_format, to_format));
326 Alert::error(_("Cannot convert file"),
327 bformat(_("No information for converting %1$s "
328 "format files to %2$s.\n"
329 "Define a converter in the preferences."),
330 from_ascii(from_format), from_ascii(to_format)));
334 // buffer is only invalid for importing, and then runparams is not
336 OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
337 runparams.flavor = getFlavor(edgepath);
340 runparams.use_japanese = buffer->bufferFormat() == "platex";
341 runparams.use_indices = buffer->params().use_indices;
342 runparams.bibtex_command = (buffer->params().bibtex_command == "default") ?
343 string() : buffer->params().bibtex_command;
344 runparams.index_command = (buffer->params().index_command == "default") ?
345 string() : buffer->params().index_command;
348 // Some converters (e.g. lilypond) can only output files to the
349 // current directory, so we need to change the current directory.
350 // This has the added benefit that all other files that may be
351 // generated by the converter are deleted when LyX closes and do not
352 // clutter the real working directory.
353 string const path(onlyPath(from_file.absFileName()));
354 // Prevent the compiler from optimizing away p
358 // empty the error list before any new conversion takes place.
361 bool run_latex = false;
362 string from_base = changeExtension(from_file.absFileName(), "");
363 string to_base = changeExtension(to_file.absFileName(), "");
365 FileName outfile = from_file;
366 for (Graph::EdgePath::const_iterator cit = edgepath.begin();
367 cit != edgepath.end(); ++cit) {
368 Converter const & conv = converterlist_[*cit];
369 bool dummy = conv.To->dummy() && conv.to != "program";
371 LYXERR(Debug::FILES, "Converting from "
372 << conv.from << " to " << conv.to);
375 outfile = FileName(conv.result_dir.empty()
376 ? changeExtension(from_file.absFileName(), conv.To->extension())
377 : addName(subst(conv.result_dir,
378 token_base, from_base),
379 subst(conv.result_file,
380 token_base, onlyFileName(from_base))));
382 // if input and output files are equal, we use a
383 // temporary file as intermediary (JMarc)
384 FileName real_outfile;
385 if (outfile == infile) {
386 real_outfile = infile;
387 // when importing, a buffer does not necessarily exist
389 outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
391 outfile = FileName(addName(package().temp_dir().absFileName(),
397 string const command = subst(conv.command, token_from, "");
398 LYXERR(Debug::FILES, "Running " << command);
399 if (!runLaTeX(*buffer, command, runparams, errorList))
402 if (conv.need_aux && !run_latex
403 && !latex_command_.empty()) {
404 string const command = (buffer && buffer->params().useNonTeXFonts) ?
405 xelatex_command_ : latex_command_;
406 LYXERR(Debug::FILES, "Running " << command
407 << " to update aux file");
408 if (!runLaTeX(*buffer, command, runparams, errorList))
413 string const infile2 =
414 to_utf8(makeRelPath(from_utf8(infile.absFileName()), from_utf8(path)));
415 string const outfile2 =
416 to_utf8(makeRelPath(from_utf8(outfile.absFileName()), from_utf8(path)));
418 string command = conv.command;
419 command = subst(command, token_from, quoteName(infile2));
420 command = subst(command, token_base, quoteName(from_base));
421 command = subst(command, token_to, quoteName(outfile2));
422 command = subst(command, token_path, quoteName(onlyPath(infile.absFileName())));
423 command = subst(command, token_orig_path, quoteName(onlyPath(orig_from.absFileName())));
424 command = subst(command, token_encoding, buffer ? buffer->params().encoding().iconvName() : string());
425 command = libScriptSearch(command);
427 if (!conv.parselog.empty())
428 command += " 2> " + quoteName(infile2 + ".out");
430 if (conv.from == "dvi" && conv.to == "ps")
431 command = add_options(command,
432 buffer->params().dvips_options());
433 else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
434 command = add_options(command,
435 dvipdfm_options(buffer->params()));
437 LYXERR(Debug::FILES, "Calling " << command);
439 buffer->message(_("Executing command: ")
440 + from_utf8(command));
445 res = one.startscript(Systemcall::DontWait,
446 to_filesystem8bit(from_utf8(command)));
447 // We're not waiting for the result, so we can't do anything
450 res = one.startscript(Systemcall::Wait,
451 to_filesystem8bit(from_utf8(command)));
452 if (!real_outfile.empty()) {
453 Mover const & mover = getMover(conv.to);
454 if (!mover.rename(outfile, real_outfile))
457 LYXERR(Debug::FILES, "renaming file " << outfile
458 << " to " << real_outfile);
459 // Finally, don't forget to tell any future
460 // converters to use the renamed file...
461 outfile = real_outfile;
464 if (!conv.parselog.empty()) {
465 string const logfile = infile2 + ".log";
466 string const script = libScriptSearch(conv.parselog);
467 string const command2 = script +
468 " < " + quoteName(infile2 + ".out") +
469 " > " + quoteName(logfile);
470 one.startscript(Systemcall::Wait,
471 to_filesystem8bit(from_utf8(command2)));
472 if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
478 if (conv.to == "program") {
479 Alert::error(_("Build errors"),
480 _("There were errors during the build process."));
482 // FIXME: this should go out of here. For example, here we cannot say if
483 // it is a document (.lyx) or something else. Same goes for elsewhere.
484 Alert::error(_("Cannot convert file"),
485 bformat(_("An error occurred while running:\n%1$s"),
486 wrapParas(from_utf8(command))));
493 Converter const & conv = converterlist_[edgepath.back()];
494 if (conv.To->dummy())
497 if (!conv.result_dir.empty()) {
498 // The converter has put the file(s) in a directory.
499 // In this case we ignore the given to_file.
500 if (from_base != to_base) {
501 string const from = subst(conv.result_dir,
502 token_base, from_base);
503 string const to = subst(conv.result_dir,
504 token_base, to_base);
505 Mover const & mover = getMover(conv.from);
506 if (!mover.rename(FileName(from), FileName(to))) {
507 Alert::error(_("Cannot convert file"),
508 bformat(_("Could not move a temporary directory from %1$s to %2$s."),
509 from_utf8(from), from_utf8(to)));
515 if (conversionflags & try_cache)
516 ConverterCache::get().add(orig_from, to_format, outfile);
517 return move(conv.to, outfile, to_file, conv.latex);
522 bool Converters::move(string const & fmt,
523 FileName const & from, FileName const & to, bool copy)
528 bool no_errors = true;
529 string const path = onlyPath(from.absFileName());
530 string const base = onlyFileName(removeExtension(from.absFileName()));
531 string const to_base = removeExtension(to.absFileName());
532 string const to_extension = getExtension(to.absFileName());
534 support::FileNameList const files = FileName(path).dirList(getExtension(from.absFileName()));
535 for (support::FileNameList::const_iterator it = files.begin();
536 it != files.end(); ++it) {
537 string const from2 = it->absFileName();
538 string const file2 = onlyFileName(from2);
539 if (prefixIs(file2, base)) {
540 string const to2 = changeExtension(
541 to_base + file2.substr(base.length()),
543 LYXERR(Debug::FILES, "moving " << from2 << " to " << to2);
545 Mover const & mover = getMover(fmt);
546 bool const moved = copy
547 ? mover.copy(*it, FileName(to2))
548 : mover.rename(*it, FileName(to2));
549 if (!moved && no_errors) {
550 Alert::error(_("Cannot convert file"),
552 _("Could not copy a temporary file from %1$s to %2$s.") :
553 _("Could not move a temporary file from %1$s to %2$s."),
554 from_utf8(from2), from_utf8(to2)));
563 bool Converters::formatIsUsed(string const & format)
565 ConverterList::const_iterator cit = converterlist_.begin();
566 ConverterList::const_iterator end = converterlist_.end();
567 for (; cit != end; ++cit) {
568 if (cit->from == format || cit->to == format)
575 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
576 FileName const & filename, ErrorList & errorList)
578 OutputParams runparams(0);
579 runparams.flavor = OutputParams::LATEX;
580 LaTeX latex("", runparams, filename);
582 int const result = latex.scanLogFile(terr);
584 if (result & LaTeX::ERRORS)
585 buffer.bufferErrors(terr, errorList);
594 : public boost::signals::trackable {
596 ShowMessage(Buffer const & b) : buffer_(b) {}
597 void operator()(docstring const & msg) const { buffer_.message(msg); }
599 Buffer const & buffer_;
605 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
606 OutputParams const & runparams, ErrorList & errorList)
608 buffer.setBusy(true);
609 buffer.message(_("Running LaTeX..."));
611 runparams.document_language = buffer.params().language->babel();
613 // do the LaTeX run(s)
614 string const name = buffer.latexName();
615 LaTeX latex(command, runparams, FileName(makeAbsPath(name)));
617 ShowMessage show(buffer);
618 latex.message.connect(show);
619 int const result = latex.run(terr);
621 if (result & LaTeX::ERRORS)
622 buffer.bufferErrors(terr, errorList);
624 // check return value from latex.run().
625 if ((result & LaTeX::NO_LOGFILE) && !buffer.isClone()) {
626 docstring const str =
627 bformat(_("LaTeX did not run successfully. "
628 "Additionally, LyX could not locate "
629 "the LaTeX log %1$s."), from_utf8(name));
630 Alert::error(_("LaTeX failed"), str);
631 } else if ((result & LaTeX::NO_OUTPUT) && !buffer.isClone()) {
632 Alert::warning(_("Output is empty"),
633 _("An empty output file was generated."));
637 buffer.setBusy(false);
639 int const ERROR_MASK =
644 return (result & ERROR_MASK) == 0;
650 void Converters::buildGraph()
652 // clear graph's data structures
653 G_.init(formats.size());
654 // each of the converters knows how to convert one format to another
655 // so, for each of them, we create an arrow on the graph, going from
656 // the one to the other
657 ConverterList::iterator it = converterlist_.begin();
658 ConverterList::iterator const end = converterlist_.end();
659 for (; it != end ; ++it) {
660 int const from = formats.getNumber(it->from);
661 int const to = formats.getNumber(it->to);
662 G_.addEdge(from, to);
667 vector<Format const *> const
668 Converters::intToFormat(vector<int> const & input)
670 vector<Format const *> result(input.size());
672 vector<int>::const_iterator it = input.begin();
673 vector<int>::const_iterator const end = input.end();
674 vector<Format const *>::iterator rit = result.begin();
675 for ( ; it != end; ++it, ++rit) {
676 *rit = &formats.get(*it);
682 vector<Format const *> const
683 Converters::getReachableTo(string const & target, bool const clear_visited)
685 vector<int> const & reachablesto =
686 G_.getReachableTo(formats.getNumber(target), clear_visited);
688 return intToFormat(reachablesto);
692 vector<Format const *> const
693 Converters::getReachable(string const & from, bool const only_viewable,
694 bool const clear_visited, set<string> const & excludes)
696 set<int> excluded_numbers;;
698 set<string>::const_iterator sit = excludes.begin();
699 set<string>::const_iterator const end = excludes.end();
700 for (; sit != end; ++sit)
701 excluded_numbers.insert(formats.getNumber(*sit));
703 vector<int> const & reachables =
704 G_.getReachable(formats.getNumber(from),
709 return intToFormat(reachables);
713 bool Converters::isReachable(string const & from, string const & to)
715 return G_.isReachable(formats.getNumber(from),
716 formats.getNumber(to));
720 Graph::EdgePath Converters::getPath(string const & from, string const & to)
722 return G_.getPath(formats.getNumber(from),
723 formats.getNumber(to));
727 vector<Format const *> Converters::importableFormats()
729 vector<string> l = loaders();
730 vector<Format const *> result = getReachableTo(l[0], true);
731 vector<string>::const_iterator it = l.begin() + 1;
732 vector<string>::const_iterator en = l.end();
733 for (; it != en; ++it) {
734 vector<Format const *> r = getReachableTo(*it, false);
735 result.insert(result.end(), r.begin(), r.end());
741 vector<Format const *> Converters::exportableFormats(bool only_viewable)
743 vector<string> s = savers();
744 vector<Format const *> result = getReachable(s[0], only_viewable, true);
745 vector<string>::const_iterator it = s.begin() + 1;
746 vector<string>::const_iterator en = s.end();
747 for (; it != en; ++it) {
748 vector<Format const *> r =
749 getReachable(*it, only_viewable, false);
750 result.insert(result.end(), r.begin(), r.end());
756 vector<string> Converters::loaders() const
761 v.push_back("textparagraph");
766 vector<string> Converters::savers() const
769 v.push_back("docbook");
770 v.push_back("latex");
771 v.push_back("literate");
772 v.push_back("luatex");
774 v.push_back("xhtml");
775 v.push_back("pdflatex");
776 v.push_back("platex");
778 v.push_back("xetex");