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"
15 #include "ConverterCache.h"
17 #include "buffer_funcs.h"
18 #include "BufferParams.h"
20 #include "ErrorList.h"
27 #include "frontends/alert.h"
29 #include "support/filetools.h"
30 #include "support/lyxlib.h"
31 #include "support/os.h"
32 #include "support/Package.h"
33 #include "support/Path.h"
34 #include "support/Systemcall.h"
45 using support::addName;
46 using support::bformat;
47 using support::changeExtension;
48 using support::compare_ascii_no_case;
49 using support::contains;
50 using support::dirList;
51 using support::FileName;
52 using support::getExtension;
53 using support::isFileReadable;
54 using support::libFileSearch;
55 using support::libScriptSearch;
56 using support::makeAbsPath;
57 using support::makeRelPath;
58 using support::onlyFilename;
59 using support::onlyPath;
60 using support::package;
61 using support::prefixIs;
62 using support::quoteName;
63 using support::removeExtension;
66 using support::Systemcall;
68 namespace Alert = lyx::frontend::Alert;
73 string const token_from("$$i");
74 string const token_base("$$b");
75 string const token_to("$$o");
76 string const token_path("$$p");
80 string const add_options(string const & command, string const & options)
83 string const tail = split(command, head, ' ');
84 return head + ' ' + options + ' ' + tail;
88 string const dvipdfm_options(BufferParams const & bp)
92 if (bp.papersize != PAPER_CUSTOM) {
93 string const paper_size = bp.paperSizeName();
94 if (paper_size != "b5" && paper_size != "foolscap")
95 result = "-p "+ paper_size;
97 if (bp.orientation == ORIENTATION_LANDSCAPE)
105 class ConverterEqual : public std::binary_function<string, string, bool> {
107 ConverterEqual(string const & from, string const & to)
108 : from_(from), to_(to) {}
109 bool operator()(Converter const & c) const {
110 return c.from == from_ && c.to == to_;
120 Converter::Converter(string const & f, string const & t,
121 string const & c, string const & l)
122 : from(f), to(t), command(c), flags(l),
123 From(0), To(0), latex(false), xml(false),
128 void Converter::readFlags()
130 string flag_list(flags);
131 while (!flag_list.empty()) {
132 string flag_name, flag_value;
133 flag_list = split(flag_list, flag_value, ',');
134 flag_value = split(flag_value, flag_name, '=');
135 if (flag_name == "latex")
137 else if (flag_name == "xml")
139 else if (flag_name == "needaux")
141 else if (flag_name == "resultdir")
142 result_dir = (flag_value.empty())
143 ? token_base : flag_value;
144 else if (flag_name == "resultfile")
145 result_file = flag_value;
146 else if (flag_name == "parselog")
147 parselog = flag_value;
149 if (!result_dir.empty() && result_file.empty())
150 result_file = "index." + formats.extension(to);
151 //if (!contains(command, token_from))
156 bool operator<(Converter const & a, Converter const & b)
158 // use the compare_ascii_no_case instead of compare_no_case,
159 // because in turkish, 'i' is not the lowercase version of 'I',
160 // and thus turkish locale breaks parsing of tags.
161 int const i = compare_ascii_no_case(a.From->prettyname(),
162 b.From->prettyname());
164 return compare_ascii_no_case(a.To->prettyname(),
165 b.To->prettyname()) < 0;
171 Converter const * Converters::getConverter(string const & from,
172 string const & to) const
174 ConverterList::const_iterator const cit =
175 find_if(converterlist_.begin(), converterlist_.end(),
176 ConverterEqual(from, to));
177 if (cit != converterlist_.end())
184 int Converters::getNumber(string const & from, string const & to) const
186 ConverterList::const_iterator const cit =
187 find_if(converterlist_.begin(), converterlist_.end(),
188 ConverterEqual(from, to));
189 if (cit != converterlist_.end())
190 return distance(converterlist_.begin(), cit);
196 void Converters::add(string const & from, string const & to,
197 string const & command, string const & flags)
201 ConverterList::iterator it = find_if(converterlist_.begin(),
202 converterlist_.end(),
203 ConverterEqual(from , to));
205 Converter converter(from, to, command, flags);
206 if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
208 converter.command = command;
209 converter.flags = flags;
211 converter.readFlags();
213 if (converter.latex && (latex_command_.empty() || to == "dvi"))
214 latex_command_ = subst(command, token_from, "");
215 // If we have both latex & pdflatex, we set latex_command to latex.
216 // The latex_command is used to update the .aux file when running
217 // a converter that uses it.
219 if (it == converterlist_.end()) {
220 converterlist_.push_back(converter);
222 converter.From = it->From;
223 converter.To = it->To;
229 void Converters::erase(string const & from, string const & to)
231 ConverterList::iterator const it =
232 find_if(converterlist_.begin(),
233 converterlist_.end(),
234 ConverterEqual(from, to));
235 if (it != converterlist_.end())
236 converterlist_.erase(it);
240 // This method updates the pointers From and To in all the converters.
241 // The code is not very efficient, but it doesn't matter as the number
242 // of formats and converters is small.
243 // Furthermore, this method is called only on startup, or after
244 // adding/deleting a format in FormPreferences (the latter calls can be
245 // eliminated if the formats in the Formats class are stored using a map or
246 // a list (instead of a vector), but this will cause other problems).
247 void Converters::update(Formats const & formats)
249 ConverterList::iterator it = converterlist_.begin();
250 ConverterList::iterator end = converterlist_.end();
251 for (; it != end; ++it) {
252 it->From = formats.getFormat(it->from);
253 it->To = formats.getFormat(it->to);
258 // This method updates the pointers From and To in the last converter.
259 // It is called when adding a new converter in FormPreferences
260 void Converters::updateLast(Formats const & formats)
262 if (converterlist_.begin() != converterlist_.end()) {
263 ConverterList::iterator it = converterlist_.end() - 1;
264 it->From = formats.getFormat(it->from);
265 it->To = formats.getFormat(it->to);
270 void Converters::sort()
272 std::sort(converterlist_.begin(), converterlist_.end());
276 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
278 for (Graph::EdgePath::const_iterator cit = path.begin();
279 cit != path.end(); ++cit) {
280 Converter const & conv = converterlist_[*cit];
282 if (contains(conv.to, "pdf"))
283 return OutputParams::PDFLATEX;
285 return OutputParams::XML;
287 return OutputParams::LATEX;
291 bool Converters::convert(Buffer const * buffer,
292 FileName const & from_file, FileName const & to_file,
293 FileName const & orig_from,
294 string const & from_format, string const & to_format,
295 ErrorList & errorList, int conversionflags)
297 if (from_format == to_format)
298 return move(from_format, from_file, to_file, false);
300 if ((conversionflags & try_cache) &&
301 ConverterCache::get().inCache(orig_from, to_format))
302 return ConverterCache::get().copy(orig_from, to_format, to_file);
304 Graph::EdgePath edgepath = getPath(from_format, to_format);
305 if (edgepath.empty()) {
306 if (conversionflags & try_default) {
307 // if no special converter defined, then we take the
308 // default one from ImageMagic.
309 string const from_ext = from_format.empty() ?
310 getExtension(from_file.absFilename()) :
311 formats.extension(from_format);
312 string const to_ext = formats.extension(to_format);
313 string const command =
314 support::os::python() + ' ' +
315 quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) +
317 quoteName(from_ext + ':' + from_file.toFilesystemEncoding()) +
319 quoteName(to_ext + ':' + to_file.toFilesystemEncoding());
321 << "No converter defined! "
322 "I use convertDefault.py:\n\t"
325 one.startscript(Systemcall::Wait, command);
326 if (isFileReadable(to_file)) {
327 if (conversionflags & try_cache)
328 ConverterCache::get().add(orig_from,
333 Alert::error(_("Cannot convert file"),
334 bformat(_("No information for converting %1$s "
335 "format files to %2$s.\n"
336 "Define a converter in the preferences."),
337 from_ascii(from_format), from_ascii(to_format)));
341 // buffer is only invalid for importing, and then runparams is not
343 OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
344 runparams.flavor = getFlavor(edgepath);
346 // Some converters (e.g. lilypond) can only output files to the
347 // current directory, so we need to change the current directory.
348 // This has the added benefit that all other files that may be
349 // generated by the converter are deleted when LyX closes and do not
350 // clutter the real working directory.
351 string const path(onlyPath(from_file.absFilename()));
352 // Prevent the compiler from optimizing away p
356 // empty the error list before any new conversion takes place.
359 bool run_latex = false;
360 string from_base = changeExtension(from_file.absFilename(), "");
361 string to_base = changeExtension(to_file.absFilename(), "");
363 FileName outfile = from_file;
364 for (Graph::EdgePath::const_iterator cit = edgepath.begin();
365 cit != edgepath.end(); ++cit) {
366 Converter const & conv = converterlist_[*cit];
367 bool dummy = conv.To->dummy() && conv.to != "program";
369 LYXERR(Debug::FILES) << "Converting from "
370 << conv.from << " to " << conv.to << endl;
373 outfile = FileName(conv.result_dir.empty()
374 ? changeExtension(from_file.absFilename(), conv.To->extension())
375 : addName(subst(conv.result_dir,
376 token_base, from_base),
377 subst(conv.result_file,
378 token_base, onlyFilename(from_base))));
380 // if input and output files are equal, we use a
381 // temporary file as intermediary (JMarc)
382 FileName real_outfile;
383 if (outfile == infile) {
384 real_outfile = infile;
385 // when importing, a buffer does not necessarily exist
387 outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
389 outfile = FileName(addName(package().temp_dir().absFilename(),
395 string const command = subst(conv.command, token_from, "");
396 LYXERR(Debug::FILES) << "Running " << command << endl;
397 if (!runLaTeX(*buffer, command, runparams, errorList))
400 if (conv.need_aux && !run_latex
401 && !latex_command_.empty()) {
403 << "Running " << latex_command_
404 << " to update aux file"<< endl;
405 runLaTeX(*buffer, latex_command_, runparams, errorList);
409 string const infile2 =
410 to_utf8(makeRelPath(from_utf8(infile.absFilename()), from_utf8(path)));
411 string const outfile2 =
412 to_utf8(makeRelPath(from_utf8(outfile.absFilename()), from_utf8(path)));
414 string command = conv.command;
415 command = subst(command, token_from, quoteName(infile2));
416 command = subst(command, token_base, quoteName(from_base));
417 command = subst(command, token_to, quoteName(outfile2));
418 command = libScriptSearch(command);
420 if (!conv.parselog.empty())
421 command += " 2> " + quoteName(infile2 + ".out");
423 if (conv.from == "dvi" && conv.to == "ps")
424 command = add_options(command,
425 buffer->params().dvips_options());
426 else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
427 command = add_options(command,
428 dvipdfm_options(buffer->params()));
430 LYXERR(Debug::FILES) << "Calling " << command << endl;
432 buffer->message(_("Executing command: ")
433 + from_utf8(command));
438 res = one.startscript(Systemcall::DontWait,
439 to_filesystem8bit(from_utf8(command)));
440 // We're not waiting for the result, so we can't do anything
443 res = one.startscript(Systemcall::Wait,
444 to_filesystem8bit(from_utf8(command)));
445 if (!real_outfile.empty()) {
446 Mover const & mover = getMover(conv.to);
447 if (!mover.rename(outfile, real_outfile))
451 << "renaming file " << outfile
452 << " to " << real_outfile
454 // Finally, don't forget to tell any future
455 // converters to use the renamed file...
456 outfile = real_outfile;
459 if (!conv.parselog.empty()) {
460 string const logfile = infile2 + ".log";
461 string const script = libScriptSearch(conv.parselog);
462 string const command2 = script +
463 " < " + quoteName(infile2 + ".out") +
464 " > " + quoteName(logfile);
465 one.startscript(Systemcall::Wait,
466 to_filesystem8bit(from_utf8(command2)));
467 if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
473 if (conv.to == "program") {
474 Alert::error(_("Build errors"),
475 _("There were errors during the build process."));
477 // FIXME: this should go out of here. For example, here we cannot say if
478 // it is a document (.lyx) or something else. Same goes for elsewhere.
479 Alert::error(_("Cannot convert file"),
480 bformat(_("An error occurred whilst running %1$s"),
481 from_utf8(command.substr(0, 50))));
488 Converter const & conv = converterlist_[edgepath.back()];
489 if (conv.To->dummy())
492 if (!conv.result_dir.empty()) {
493 // The converter has put the file(s) in a directory.
494 // In this case we ignore the given to_file.
495 if (from_base != to_base) {
496 string const from = subst(conv.result_dir,
497 token_base, from_base);
498 string const to = subst(conv.result_dir,
499 token_base, to_base);
500 Mover const & mover = getMover(conv.from);
501 if (!mover.rename(FileName(from), FileName(to))) {
502 Alert::error(_("Cannot convert file"),
503 bformat(_("Could not move a temporary directory from %1$s to %2$s."),
504 from_utf8(from), from_utf8(to)));
510 if (conversionflags & try_cache)
511 ConverterCache::get().add(orig_from, to_format, outfile);
512 return move(conv.to, outfile, to_file, conv.latex);
517 bool Converters::move(string const & fmt,
518 FileName const & from, FileName const & to, bool copy)
523 bool no_errors = true;
524 string const path = onlyPath(from.absFilename());
525 string const base = onlyFilename(removeExtension(from.absFilename()));
526 string const to_base = removeExtension(to.absFilename());
527 string const to_extension = getExtension(to.absFilename());
529 vector<FileName> const files = dirList(FileName(path),
530 getExtension(from.absFilename()));
531 for (vector<FileName>::const_iterator it = files.begin();
532 it != files.end(); ++it) {
533 string const from2 = it->absFilename();
534 string const file2 = onlyFilename(from2);
535 if (prefixIs(file2, base)) {
536 string const to2 = changeExtension(
537 to_base + file2.substr(base.length()),
539 LYXERR(Debug::FILES) << "moving " << from2
540 << " to " << to2 << endl;
542 Mover const & mover = getMover(fmt);
543 bool const moved = copy
544 ? mover.copy(*it, FileName(to2))
545 : mover.rename(*it, FileName(to2));
546 if (!moved && no_errors) {
547 Alert::error(_("Cannot convert file"),
549 _("Could not copy a temporary file from %1$s to %2$s.") :
550 _("Could not move a temporary file from %1$s to %2$s."),
551 from_utf8(from2), from_utf8(to2)));
560 bool Converters::formatIsUsed(string const & format)
562 ConverterList::const_iterator cit = converterlist_.begin();
563 ConverterList::const_iterator end = converterlist_.end();
564 for (; cit != end; ++cit) {
565 if (cit->from == format || cit->to == format)
572 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
573 FileName const & filename, ErrorList & errorList)
575 OutputParams runparams(0);
576 runparams.flavor = OutputParams::LATEX;
577 LaTeX latex("", runparams, filename);
579 int const result = latex.scanLogFile(terr);
581 if (result & LaTeX::ERRORS)
582 bufferErrors(buffer, terr, errorList);
590 class showMessage : public std::unary_function<docstring, void>, public boost::signals::trackable {
592 showMessage(Buffer const & b) : buffer_(b) {};
593 void operator()(docstring const & m) const
598 Buffer const & buffer_;
604 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
605 OutputParams const & runparams, ErrorList & errorList)
608 buffer.message(_("Running LaTeX..."));
610 runparams.document_language = buffer.params().language->babel();
612 // do the LaTeX run(s)
613 string const name = buffer.getLatexName();
614 LaTeX latex(command, runparams, FileName(makeAbsPath(name)));
616 showMessage show(buffer);
617 latex.message.connect(show);
618 int const result = latex.run(terr);
620 if (result & LaTeX::ERRORS)
621 bufferErrors(buffer, terr, errorList);
623 // check return value from latex.run().
624 if ((result & LaTeX::NO_LOGFILE)) {
625 docstring const str =
626 bformat(_("LaTeX did not run successfully. "
627 "Additionally, LyX could not locate "
628 "the LaTeX log %1$s."), from_utf8(name));
629 Alert::error(_("LaTeX failed"), str);
630 } else if (result & LaTeX::NO_OUTPUT) {
631 Alert::warning(_("Output is empty"),
632 _("An empty output file was generated."));
638 int const ERROR_MASK =
643 return (result & ERROR_MASK) == 0;
649 void Converters::buildGraph()
651 G_.init(formats.size());
652 ConverterList::iterator beg = converterlist_.begin();
653 ConverterList::iterator const end = converterlist_.end();
654 for (ConverterList::iterator it = beg; it != end ; ++it) {
655 int const s = formats.getNumber(it->from);
656 int const t = formats.getNumber(it->to);
662 std::vector<Format const *> const
663 Converters::intToFormat(std::vector<int> const & input)
665 vector<Format const *> result(input.size());
667 vector<int>::const_iterator it = input.begin();
668 vector<int>::const_iterator const end = input.end();
669 vector<Format const *>::iterator rit = result.begin();
670 for ( ; it != end; ++it, ++rit) {
671 *rit = &formats.get(*it);
677 vector<Format const *> const
678 Converters::getReachableTo(string const & target, bool const clear_visited)
680 vector<int> const & reachablesto =
681 G_.getReachableTo(formats.getNumber(target), clear_visited);
683 return intToFormat(reachablesto);
687 vector<Format const *> const
688 Converters::getReachable(string const & from, bool const only_viewable,
689 bool const clear_visited)
691 vector<int> const & reachables =
692 G_.getReachable(formats.getNumber(from),
696 return intToFormat(reachables);
700 bool Converters::isReachable(string const & from, string const & to)
702 return G_.isReachable(formats.getNumber(from),
703 formats.getNumber(to));
707 Graph::EdgePath const
708 Converters::getPath(string const & from, string const & to)
710 return G_.getPath(formats.getNumber(from),
711 formats.getNumber(to));