]> git.lyx.org Git - lyx.git/blob - src/Converter.cpp
EmbeddedObjects.lyx: add hint how to force a rotation direction for rotated floats
[lyx.git] / src / Converter.cpp
1 /**
2  * \file Converter.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Dekel Tsur
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "Converter.h"
14
15 #include "ConverterCache.h"
16 #include "Buffer.h"
17 #include "buffer_funcs.h"
18 #include "BufferParams.h"
19 #include "debug.h"
20 #include "ErrorList.h"
21 #include "Format.h"
22 #include "gettext.h"
23 #include "Language.h"
24 #include "LaTeX.h"
25 #include "Mover.h"
26
27 #include "frontends/alert.h"
28
29 #include "support/filetools.h"
30 #include "support/lyxlib.h"
31 #include "support/os.h"
32 #include "support/Path.h"
33 #include "support/Systemcall.h"
34
35
36 namespace lyx {
37
38 using support::addName;
39 using support::bformat;
40 using support::changeExtension;
41 using support::compare_ascii_no_case;
42 using support::contains;
43 using support::dirList;
44 using support::FileName;
45 using support::getExtension;
46 using support::isFileReadable;
47 using support::libFileSearch;
48 using support::libScriptSearch;
49 using support::makeAbsPath;
50 using support::makeRelPath;
51 using support::onlyFilename;
52 using support::onlyPath;
53 using support::prefixIs;
54 using support::quoteName;
55 using support::removeExtension;
56 using support::split;
57 using support::subst;
58 using support::Systemcall;
59
60 using std::endl;
61 using std::find_if;
62 using std::string;
63 using std::vector;
64 using std::distance;
65
66 namespace Alert = lyx::frontend::Alert;
67
68
69 namespace {
70
71 string const token_from("$$i");
72 string const token_base("$$b");
73 string const token_to("$$o");
74 string const token_path("$$p");
75
76
77
78 string const add_options(string const & command, string const & options)
79 {
80         string head;
81         string const tail = split(command, head, ' ');
82         return head + ' ' + options + ' ' + tail;
83 }
84
85
86 string const dvipdfm_options(BufferParams const & bp)
87 {
88         string result;
89
90         if (bp.papersize != PAPER_CUSTOM) {
91                 string const paper_size = bp.paperSizeName();
92                 if (paper_size != "b5" && paper_size != "foolscap")
93                         result = "-p "+ paper_size;
94
95                 if (bp.orientation == ORIENTATION_LANDSCAPE)
96                         result += " -l";
97         }
98
99         return result;
100 }
101
102
103 class ConverterEqual : public std::binary_function<string, string, bool> {
104 public:
105         ConverterEqual(string const & from, string const & to)
106                 : from_(from), to_(to) {}
107         bool operator()(Converter const & c) const {
108                 return c.from == from_ && c.to == to_;
109         }
110 private:
111         string const from_;
112         string const to_;
113 };
114
115 } // namespace anon
116
117
118 Converter::Converter(string const & f, string const & t,
119                      string const & c, string const & l)
120         : from(f), to(t), command(c), flags(l),
121           From(0), To(0), latex(false), xml(false),
122           original_dir(false), need_aux(false)
123 {}
124
125
126 void Converter::readFlags()
127 {
128         string flag_list(flags);
129         while (!flag_list.empty()) {
130                 string flag_name, flag_value;
131                 flag_list = split(flag_list, flag_value, ',');
132                 flag_value = split(flag_value, flag_name, '=');
133                 if (flag_name == "latex")
134                         latex = true;
135                 else if (flag_name == "xml")
136                         xml = true;
137                 else if (flag_name == "originaldir")
138                         original_dir = true;
139                 else if (flag_name == "needaux")
140                         need_aux = true;
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;
148         }
149         if (!result_dir.empty() && result_file.empty())
150                 result_file = "index." + formats.extension(to);
151         //if (!contains(command, token_from))
152         //      latex = true;
153 }
154
155
156 bool operator<(Converter const & a, Converter const & b)
157 {
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());
163         if (i == 0)
164                 return compare_ascii_no_case(a.To->prettyname(),
165                                              b.To->prettyname()) < 0;
166         else
167                 return i < 0;
168 }
169
170
171 Converter const * Converters::getConverter(string const & from,
172                                             string const & to) const
173 {
174         ConverterList::const_iterator const cit =
175                 find_if(converterlist_.begin(), converterlist_.end(),
176                         ConverterEqual(from, to));
177         if (cit != converterlist_.end())
178                 return &(*cit);
179         else
180                 return 0;
181 }
182
183
184 int Converters::getNumber(string const & from, string const & to) const
185 {
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);
191         else
192                 return -1;
193 }
194
195
196 void Converters::add(string const & from, string const & to,
197                      string const & command, string const & flags)
198 {
199         formats.add(from);
200         formats.add(to);
201         ConverterList::iterator it = find_if(converterlist_.begin(),
202                                              converterlist_.end(),
203                                              ConverterEqual(from , to));
204
205         Converter converter(from, to, command, flags);
206         if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
207                 converter = *it;
208                 converter.command = command;
209                 converter.flags = flags;
210         }
211         converter.readFlags();
212
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.
218
219         if (it == converterlist_.end()) {
220                 converterlist_.push_back(converter);
221         } else {
222                 converter.From = it->From;
223                 converter.To = it->To;
224                 *it = converter;
225         }
226 }
227
228
229 void Converters::erase(string const & from, string const & to)
230 {
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);
237 }
238
239
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)
248 {
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);
254         }
255 }
256
257
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)
261 {
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);
266         }
267 }
268
269
270 void Converters::sort()
271 {
272         std::sort(converterlist_.begin(), converterlist_.end());
273 }
274
275
276 OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
277 {
278         for (Graph::EdgePath::const_iterator cit = path.begin();
279              cit != path.end(); ++cit) {
280                 Converter const & conv = converterlist_[*cit];
281                 if (conv.latex)
282                         if (contains(conv.to, "pdf"))
283                                 return OutputParams::PDFLATEX;
284                 if (conv.xml)
285                         return OutputParams::XML;
286         }
287         return OutputParams::LATEX;
288 }
289
290
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)
296 {
297         if (from_format == to_format)
298                 return move(from_format, from_file, to_file, false);
299
300         if ((conversionflags & try_cache) &&
301             ConverterCache::get().inCache(orig_from, to_format))
302                 return ConverterCache::get().copy(orig_from, to_format, to_file);
303
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()) +
316                                 ' ' +
317                                 quoteName(from_ext + ':' + from_file.toFilesystemEncoding()) +
318                                 ' ' +
319                                 quoteName(to_ext + ':' + to_file.toFilesystemEncoding());
320                         LYXERR(Debug::FILES)
321                                 << "No converter defined! "
322                                    "I use convertDefault.py:\n\t"
323                                 << command << endl;
324                         Systemcall one;
325                         one.startscript(Systemcall::Wait, command);
326                         if (isFileReadable(to_file)) {
327                                 if (conversionflags & try_cache)
328                                         ConverterCache::get().add(orig_from,
329                                                         to_format, to_file);
330                                 return true;
331                         }
332                 }
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)));
338                 return false;
339         }
340
341         // buffer is only invalid for importing, and then runparams is not
342         // used anyway.
343         OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
344         runparams.flavor = getFlavor(edgepath);
345
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
353         FileName pp(path);
354         support::Path p(pp);
355
356         // empty the error list before any new conversion takes place.
357         errorList.clear();
358
359         bool run_latex = false;
360         string from_base = changeExtension(from_file.absFilename(), "");
361         string to_base = changeExtension(to_file.absFilename(), "");
362         FileName infile;
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";
368                 if (!dummy)
369                         LYXERR(Debug::FILES) << "Converting from  "
370                                << conv.from << " to " << conv.to << endl;
371                 infile = outfile;
372                 outfile = FileName(conv.result_dir.empty()
373                         ? changeExtension(from_file.absFilename(), conv.To->extension())
374                         : addName(subst(conv.result_dir,
375                                         token_base, from_base),
376                                   subst(conv.result_file,
377                                         token_base, onlyFilename(from_base))));
378
379                 // if input and output files are equal, we use a
380                 // temporary file as intermediary (JMarc)
381                 FileName real_outfile;
382                 if (outfile == infile) {
383                         real_outfile = infile;
384                         outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
385                 }
386
387                 if (conv.latex) {
388                         run_latex = true;
389                         string const command = subst(conv.command, token_from, "");
390                         LYXERR(Debug::FILES) << "Running " << command << endl;
391                         if (!runLaTeX(*buffer, command, runparams, errorList))
392                                 return false;
393                 } else {
394                         if (conv.need_aux && !run_latex
395                             && !latex_command_.empty()) {
396                                 LYXERR(Debug::FILES)
397                                         << "Running " << latex_command_
398                                         << " to update aux file"<<  endl;
399                                 runLaTeX(*buffer, latex_command_, runparams, errorList);
400                         }
401
402                         // FIXME UNICODE
403                         string const infile2 = (conv.original_dir)
404                                 ? infile.absFilename() : to_utf8(makeRelPath(from_utf8(infile.absFilename()),
405                                                                              from_utf8(path)));
406                         string const outfile2 = (conv.original_dir)
407                                 ? outfile.absFilename() : to_utf8(makeRelPath(from_utf8(outfile.absFilename()),
408                                                                               from_utf8(path)));
409
410                         string command = conv.command;
411                         command = subst(command, token_from, quoteName(infile2));
412                         command = subst(command, token_base, quoteName(from_base));
413                         command = subst(command, token_to, quoteName(outfile2));
414                         command = libScriptSearch(command);
415
416                         if (!conv.parselog.empty())
417                                 command += " 2> " + quoteName(infile2 + ".out");
418
419                         if (conv.from == "dvi" && conv.to == "ps")
420                                 command = add_options(command,
421                                                       buffer->params().dvips_options());
422                         else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
423                                 command = add_options(command,
424                                                       dvipdfm_options(buffer->params()));
425
426                         LYXERR(Debug::FILES) << "Calling " << command << endl;
427                         if (buffer)
428                                 buffer->message(_("Executing command: ")
429                                 + from_utf8(command));
430
431                         Systemcall::Starttype const type = (dummy)
432                                 ? Systemcall::DontWait : Systemcall::Wait;
433                         Systemcall one;
434                         int res;
435                         if (conv.original_dir) {
436                                 FileName path(buffer->filePath());
437                                 support::Path p(path);
438                                 res = one.startscript(type,
439                                         to_filesystem8bit(from_utf8(command)));
440                         } else
441                                 res = one.startscript(type,
442                                         to_filesystem8bit(from_utf8(command)));
443
444                         if (!real_outfile.empty()) {
445                                 Mover const & mover = getMover(conv.to);
446                                 if (!mover.rename(outfile, real_outfile))
447                                         res = -1;
448                                 else
449                                         LYXERR(Debug::FILES)
450                                                 << "renaming file " << outfile
451                                                 << " to " << real_outfile
452                                                 << endl;
453                                 // Finally, don't forget to tell any future
454                                 // converters to use the renamed file...
455                                 outfile = real_outfile;
456                         }
457
458                         if (!conv.parselog.empty()) {
459                                 string const logfile =  infile2 + ".log";
460                                 string const script = libScriptSearch(conv.parselog);
461                                 string const command2 = script +
462                                         " < " + quoteName(infile2 + ".out") +
463                                         " > " + quoteName(logfile);
464                                 one.startscript(Systemcall::Wait,
465                                         to_filesystem8bit(from_utf8(command2)));
466                                 if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
467                                         return false;
468                         }
469
470                         if (res) {
471                                 if (conv.to == "program") {
472                                         Alert::error(_("Build errors"),
473                                                 _("There were errors during the build process."));
474                                 } else {
475 // FIXME: this should go out of here. For example, here we cannot say if
476 // it is a document (.lyx) or something else. Same goes for elsewhere.
477                                         Alert::error(_("Cannot convert file"),
478                                                 bformat(_("An error occurred whilst running %1$s"),
479                                                 from_utf8(command.substr(0, 50))));
480                                 }
481                                 return false;
482                         }
483                 }
484         }
485
486         Converter const & conv = converterlist_[edgepath.back()];
487         if (conv.To->dummy())
488                 return true;
489
490         if (!conv.result_dir.empty()) {
491                 // The converter has put the file(s) in a directory.
492                 // In this case we ignore the given to_file.
493                 if (from_base != to_base) {
494                         string const from = subst(conv.result_dir,
495                                             token_base, from_base);
496                         string const to = subst(conv.result_dir,
497                                           token_base, to_base);
498                         Mover const & mover = getMover(conv.from);
499                         if (!mover.rename(FileName(from), FileName(to))) {
500                                 Alert::error(_("Cannot convert file"),
501                                         bformat(_("Could not move a temporary directory from %1$s to %2$s."),
502                                                 from_utf8(from), from_utf8(to)));
503                                 return false;
504                         }
505                 }
506                 return true;
507         } else {
508                 if (conversionflags & try_cache)
509                         ConverterCache::get().add(orig_from, to_format, outfile);
510                 return move(conv.to, outfile, to_file, conv.latex);
511         }
512 }
513
514
515 bool Converters::move(string const & fmt,
516                       FileName const & from, FileName const & to, bool copy)
517 {
518         if (from == to)
519                 return true;
520
521         bool no_errors = true;
522         string const path = onlyPath(from.absFilename());
523         string const base = onlyFilename(removeExtension(from.absFilename()));
524         string const to_base = removeExtension(to.absFilename());
525         string const to_extension = getExtension(to.absFilename());
526
527         vector<FileName> const files = dirList(FileName(path),
528                         getExtension(from.absFilename()));
529         for (vector<FileName>::const_iterator it = files.begin();
530              it != files.end(); ++it) {
531                 string const from2 = it->absFilename();
532                 string const file2 = onlyFilename(from2);
533                 if (prefixIs(file2, base)) {
534                         string const to2 = changeExtension(
535                                 to_base + file2.substr(base.length()),
536                                 to_extension);
537                         LYXERR(Debug::FILES) << "moving " << from2
538                                              << " to " << to2 << endl;
539
540                         Mover const & mover = getMover(fmt);
541                         bool const moved = copy
542                                 ? mover.copy(*it, FileName(to2))
543                                 : mover.rename(*it, FileName(to2));
544                         if (!moved && no_errors) {
545                                 Alert::error(_("Cannot convert file"),
546                                         bformat(copy ?
547                                                 _("Could not copy a temporary file from %1$s to %2$s.") :
548                                                 _("Could not move a temporary file from %1$s to %2$s."),
549                                                 from_utf8(from2), from_utf8(to2)));
550                                 no_errors = false;
551                         }
552                 }
553         }
554         return no_errors;
555 }
556
557
558 bool Converters::formatIsUsed(string const & format)
559 {
560         ConverterList::const_iterator cit = converterlist_.begin();
561         ConverterList::const_iterator end = converterlist_.end();
562         for (; cit != end; ++cit) {
563                 if (cit->from == format || cit->to == format)
564                         return true;
565         }
566         return false;
567 }
568
569
570 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
571                          FileName const & filename, ErrorList & errorList)
572 {
573         OutputParams runparams(0);
574         runparams.flavor = OutputParams::LATEX;
575         LaTeX latex("", runparams, filename);
576         TeXErrors terr;
577         int const result = latex.scanLogFile(terr);
578
579         if (result & LaTeX::ERRORS)
580                 bufferErrors(buffer, terr, errorList);
581
582         return true;
583 }
584
585
586 namespace {
587
588 class showMessage : public std::unary_function<docstring, void>, public boost::signals::trackable {
589 public:
590         showMessage(Buffer const & b) : buffer_(b) {};
591         void operator()(docstring const & m) const
592         {
593                 buffer_.message(m);
594         }
595 private:
596         Buffer const & buffer_;
597 };
598
599 }
600
601
602 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
603                           OutputParams const & runparams, ErrorList & errorList)
604 {
605         buffer.busy(true);
606         buffer.message(_("Running LaTeX..."));
607
608         runparams.document_language = buffer.params().language->babel();
609
610         // do the LaTeX run(s)
611         string const name = buffer.getLatexName();
612         LaTeX latex(command, runparams, FileName(makeAbsPath(name)));
613         TeXErrors terr;
614         showMessage show(buffer);
615         latex.message.connect(show);
616         int const result = latex.run(terr);
617
618         if (result & LaTeX::ERRORS)
619                 bufferErrors(buffer, terr, errorList);
620
621         // check return value from latex.run().
622         if ((result & LaTeX::NO_LOGFILE)) {
623                 docstring const str =
624                         bformat(_("LaTeX did not run successfully. "
625                                                "Additionally, LyX could not locate "
626                                                "the LaTeX log %1$s."), from_utf8(name));
627                 Alert::error(_("LaTeX failed"), str);
628         } else if (result & LaTeX::NO_OUTPUT) {
629                 Alert::warning(_("Output is empty"),
630                                _("An empty output file was generated."));
631         }
632
633
634         buffer.busy(false);
635
636         int const ERROR_MASK =
637                         LaTeX::NO_LOGFILE |
638                         LaTeX::ERRORS |
639                         LaTeX::NO_OUTPUT;
640
641         return (result & ERROR_MASK) == 0;
642
643 }
644
645
646
647 void Converters::buildGraph()
648 {
649         G_.init(formats.size());
650         ConverterList::iterator beg = converterlist_.begin();
651         ConverterList::iterator const end = converterlist_.end();
652         for (ConverterList::iterator it = beg; it != end ; ++it) {
653                 int const s = formats.getNumber(it->from);
654                 int const t = formats.getNumber(it->to);
655                 G_.addEdge(s,t);
656         }
657 }
658
659
660 std::vector<Format const *> const
661 Converters::intToFormat(std::vector<int> const & input)
662 {
663         vector<Format const *> result(input.size());
664
665         vector<int>::const_iterator it = input.begin();
666         vector<int>::const_iterator const end = input.end();
667         vector<Format const *>::iterator rit = result.begin();
668         for ( ; it != end; ++it, ++rit) {
669                 *rit = &formats.get(*it);
670         }
671         return result;
672 }
673
674
675 vector<Format const *> const
676 Converters::getReachableTo(string const & target, bool const clear_visited)
677 {
678         vector<int> const & reachablesto =
679                 G_.getReachableTo(formats.getNumber(target), clear_visited);
680
681         return intToFormat(reachablesto);
682 }
683
684
685 vector<Format const *> const
686 Converters::getReachable(string const & from, bool const only_viewable,
687                          bool const clear_visited)
688 {
689         vector<int> const & reachables =
690                 G_.getReachable(formats.getNumber(from),
691                                 only_viewable,
692                                 clear_visited);
693
694         return intToFormat(reachables);
695 }
696
697
698 bool Converters::isReachable(string const & from, string const & to)
699 {
700         return G_.isReachable(formats.getNumber(from),
701                               formats.getNumber(to));
702 }
703
704
705 Graph::EdgePath const
706 Converters::getPath(string const & from, string const & to)
707 {
708         return G_.getPath(formats.getNumber(from),
709                           formats.getNumber(to));
710 }
711
712 } // namespace lyx