2 * \file PreviewLoader.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
13 #include "PreviewLoader.h"
14 #include "PreviewImage.h"
15 #include "GraphicsCache.h"
18 #include "BufferParams.h"
19 #include "Converter.h"
22 #include "InsetIterator.h"
23 #include "LaTeXFeatures.h"
26 #include "OutputParams.h"
29 #include "frontends/Application.h" // hexName
30 #include "frontends/qt4/ColorCache.h"
32 #include "insets/Inset.h"
34 #include "support/convert.h"
35 #include "support/debug.h"
36 #include "support/FileName.h"
37 #include "support/filetools.h"
38 #include "support/ForkedCalls.h"
39 #include "support/lstrings.h"
40 #include "support/qstring_helpers.h"
42 #include "support/bind.h"
49 using namespace lyx::support;
55 typedef pair<string, FileName> SnippetPair;
57 // A list of all snippets to be converted to previews
58 typedef list<string> PendingSnippets;
60 // Each item in the vector is a pair<snippet, image file name>.
61 typedef vector<SnippetPair> BitmapFile;
64 string const unique_filename(string const & bufferpath)
66 static int theCounter = 0;
67 string const filename = lyx::convert<string>(theCounter++) + "lyxpreview";
68 return addName(bufferpath, filename);
72 lyx::Converter const * setConverter(string const from)
74 typedef vector<string> FmtList;
75 typedef lyx::graphics::Cache GCache;
76 FmtList const & loadableFormats = GCache::get().loadableFormats();
77 FmtList::const_iterator it = loadableFormats.begin();
78 FmtList::const_iterator const end = loadableFormats.end();
80 for (; it != end; ++it) {
81 string const to = *it;
85 lyx::Converter const * ptr = lyx::theConverters().getConverter(from, to);
90 static bool first = true;
93 LYXERR0("PreviewLoader::startLoading()\n"
94 << "No converter from \"" << from << "\" format has been defined.");
100 void setAscentFractions(vector<double> & ascent_fractions,
101 FileName const & metrics_file)
103 // If all else fails, then the images will have equal ascents and
105 vector<double>::iterator it = ascent_fractions.begin();
106 vector<double>::iterator end = ascent_fractions.end();
109 ifstream in(metrics_file.toFilesystemEncoding().c_str());
111 LYXERR(lyx::Debug::GRAPHICS, "setAscentFractions(" << metrics_file << ")\n"
112 << "Unable to open file!");
118 int snippet_counter = 1;
119 while (!in.eof() && it != end) {
122 double ascent_fraction;
124 in >> snippet >> id >> ascent_fraction;
130 error = snippet != "Snippet";
134 error = id != snippet_counter;
138 *it = ascent_fraction;
145 LYXERR(lyx::Debug::GRAPHICS, "setAscentFractions(" << metrics_file << ")\n"
146 << "Error reading file!\n");
154 FindFirst(string const & comp) : comp_(comp) {}
155 bool operator()(SnippetPair const & sp) const { return sp.first == comp_; }
161 /// Store info on a currently executing, forked process.
165 InProgress() : pid(0) {}
167 InProgress(string const & filename_base,
168 PendingSnippets const & pending,
169 string const & to_format);
170 /// Remove any files left lying around and kill the forked process.
178 FileName metrics_file;
183 typedef map<pid_t, InProgress> InProgressProcesses;
185 typedef InProgressProcesses::value_type InProgressProcess;
194 class PreviewLoader::Impl : public boost::signals::trackable {
197 Impl(PreviewLoader & p, Buffer const & b);
198 /// Stop any InProgress items still executing.
201 PreviewImage const * preview(string const & latex_snippet) const;
203 PreviewLoader::Status status(string const & latex_snippet) const;
205 void add(string const & latex_snippet);
207 void remove(string const & latex_snippet);
208 /// \p wait whether to wait for the process to complete or, instead,
209 /// to do it in the background.
210 void startLoading(bool wait = false);
212 /// Emit this signal when an image is ready for display.
213 boost::signal<void(PreviewImage const &)> imageReady;
215 Buffer const & buffer() const { return buffer_; }
218 /// Called by the ForkedCall process that generated the bitmap files.
219 void finishedGenerating(pid_t, int);
221 void dumpPreamble(otexstream &) const;
223 void dumpData(odocstream &, BitmapFile const &) const;
225 /** cache_ allows easy retrieval of already-generated images
226 * using the LaTeX snippet as the identifier.
228 typedef shared_ptr<PreviewImage> PreviewImagePtr;
230 typedef map<string, PreviewImagePtr> Cache;
234 /** pending_ stores the LaTeX snippets in anticipation of them being
235 * sent to the converter.
237 PendingSnippets pending_;
239 /** in_progress_ stores all forked processes so that we can proceed
241 The map uses the conversion commands as its identifiers.
243 InProgressProcesses in_progress_;
246 PreviewLoader & parent_;
248 Buffer const & buffer_;
250 /// We don't own this
251 static lyx::Converter const * pconverter_;
255 lyx::Converter const * PreviewLoader::Impl::pconverter_;
259 // The public interface, defined in PreviewLoader.h
262 PreviewLoader::PreviewLoader(Buffer const & b)
263 : pimpl_(new Impl(*this, b))
267 PreviewLoader::~PreviewLoader()
273 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
275 return pimpl_->preview(latex_snippet);
279 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
281 return pimpl_->status(latex_snippet);
285 void PreviewLoader::add(string const & latex_snippet) const
287 pimpl_->add(latex_snippet);
291 void PreviewLoader::remove(string const & latex_snippet) const
293 pimpl_->remove(latex_snippet);
297 void PreviewLoader::startLoading(bool wait) const
299 pimpl_->startLoading(wait);
303 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
305 return pimpl_->imageReady.connect(slot);
309 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
311 pimpl_->imageReady(pimage);
315 Buffer const & PreviewLoader::buffer() const
317 return pimpl_->buffer();
320 } // namespace graphics
324 // The details of the Impl
325 // =======================
329 class IncrementedFileName {
331 IncrementedFileName(string const & to_format,
332 string const & filename_base)
333 : to_format_(to_format), base_(filename_base), counter_(1)
336 SnippetPair const operator()(string const & snippet)
339 os << base_ << counter_++ << '.' << to_format_;
340 string const file = os.str();
342 return make_pair(snippet, FileName(file));
346 string const & to_format_;
347 string const & base_;
352 InProgress::InProgress(string const & filename_base,
353 PendingSnippets const & pending,
354 string const & to_format)
356 metrics_file(filename_base + ".metrics"),
357 snippets(pending.size())
359 PendingSnippets::const_iterator pit = pending.begin();
360 PendingSnippets::const_iterator pend = pending.end();
361 BitmapFile::iterator sit = snippets.begin();
363 transform(pit, pend, sit,
364 IncrementedFileName(to_format, filename_base));
368 void InProgress::stop() const
371 ForkedCallsController::kill(pid, 0);
373 if (!metrics_file.empty())
374 metrics_file.removeFile();
376 BitmapFile::const_iterator vit = snippets.begin();
377 BitmapFile::const_iterator vend = snippets.end();
378 for (; vit != vend; ++vit) {
379 if (!vit->second.empty())
380 vit->second.removeFile();
390 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
391 : parent_(p), buffer_(b)
394 pconverter_ = setConverter("lyxpreview");
398 PreviewLoader::Impl::~Impl()
400 InProgressProcesses::iterator ipit = in_progress_.begin();
401 InProgressProcesses::iterator ipend = in_progress_.end();
403 for (; ipit != ipend; ++ipit)
409 PreviewLoader::Impl::preview(string const & latex_snippet) const
411 Cache::const_iterator it = cache_.find(latex_snippet);
412 return (it == cache_.end()) ? 0 : it->second.get();
420 FindSnippet(string const & s) : snippet_(s) {}
421 bool operator()(InProgressProcess const & process) const
423 BitmapFile const & snippets = process.second.snippets;
424 BitmapFile::const_iterator beg = snippets.begin();
425 BitmapFile::const_iterator end = snippets.end();
426 return find_if(beg, end, FindFirst(snippet_)) != end;
430 string const snippet_;
435 PreviewLoader::Status
436 PreviewLoader::Impl::status(string const & latex_snippet) const
438 Cache::const_iterator cit = cache_.find(latex_snippet);
439 if (cit != cache_.end())
442 PendingSnippets::const_iterator pit = pending_.begin();
443 PendingSnippets::const_iterator pend = pending_.end();
445 pit = find(pit, pend, latex_snippet);
449 InProgressProcesses::const_iterator ipit = in_progress_.begin();
450 InProgressProcesses::const_iterator ipend = in_progress_.end();
452 ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
460 void PreviewLoader::Impl::add(string const & latex_snippet)
462 if (!pconverter_ || status(latex_snippet) != NotFound)
465 string const snippet = trim(latex_snippet);
469 LYXERR(Debug::GRAPHICS, "adding snippet:\n" << snippet);
471 pending_.push_back(snippet);
479 EraseSnippet(string const & s) : snippet_(s) {}
480 void operator()(InProgressProcess & process)
482 BitmapFile & snippets = process.second.snippets;
483 BitmapFile::iterator it = snippets.begin();
484 BitmapFile::iterator end = snippets.end();
486 it = find_if(it, end, FindFirst(snippet_));
488 snippets.erase(it, it+1);
492 string const & snippet_;
498 void PreviewLoader::Impl::remove(string const & latex_snippet)
500 Cache::iterator cit = cache_.find(latex_snippet);
501 if (cit != cache_.end())
504 PendingSnippets::iterator pit = pending_.begin();
505 PendingSnippets::iterator pend = pending_.end();
507 pending_.erase(std::remove(pit, pend, latex_snippet), pend);
509 InProgressProcesses::iterator ipit = in_progress_.begin();
510 InProgressProcesses::iterator ipend = in_progress_.end();
512 for_each(ipit, ipend, EraseSnippet(latex_snippet));
514 while (ipit != ipend) {
515 InProgressProcesses::iterator curr = ipit++;
516 if (curr->second.snippets.empty())
517 in_progress_.erase(curr);
522 void PreviewLoader::Impl::startLoading(bool wait)
524 if (pending_.empty() || !pconverter_)
527 // Only start the process off after the buffer is loaded from file.
528 if (!buffer_.isFullyLoaded())
531 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()");
533 // As used by the LaTeX file and by the resulting image files
534 string const directory = buffer_.temppath();
536 string const filename_base = unique_filename(directory);
538 // Create an InProgress instance to place in the map of all
539 // such processes if it starts correctly.
540 InProgress inprogress(filename_base, pending_, pconverter_->to);
542 // clear pending_, so we're ready to start afresh.
545 // Output the LaTeX file.
546 FileName const latexfile(filename_base + ".tex");
548 // we use the encoding of the buffer
549 Encoding const & enc = buffer_.params().encoding();
551 try { of.reset(enc.iconvName()); }
552 catch (iconv_codecvt_facet_exception const & e) {
553 LYXERR0("Caught iconv exception: " << e.what()
554 << "\nUnable to create LaTeX file: " << latexfile);
559 otexstream os(of, texrow);
560 OutputParams runparams(&enc);
561 LaTeXFeatures features(buffer_, buffer_.params(), runparams);
563 if (!openFileWrite(of, latexfile))
567 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
568 << "Unable to create LaTeX file\n" << latexfile);
571 of << "\\batchmode\n";
573 // handle inputenc etc.
574 buffer_.params().writeEncodingPreamble(os, features);
575 of << "\n\\begin{document}\n";
576 dumpData(of, inprogress.snippets);
577 of << "\n\\end{document}\n";
580 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
581 << "File was not closed properly.");
585 double const font_scaling_factor =
586 buffer_.isExporting() ? 75.0 * buffer_.params().html_math_img_scale
587 : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor;
590 // The colors should be customizable.
591 ColorCode const bg = buffer_.isExporting()
592 ? Color_white : PreviewLoader::backgroundColor();
593 ColorCode const fg = buffer_.isExporting()
594 ? Color_black : PreviewLoader::foregroundColor();
595 std::string bg_name, fg_name;
597 fg_name = theApp()->hexName(fg);
598 bg_name = theApp()->hexName(bg);
601 fg_name = ltrim(fromqstr(cc.get(fg).name()), "#");
602 bg_name = ltrim(fromqstr(cc.get(bg).name()), "#");
605 // The conversion command.
607 cs << pconverter_->command
608 << " " << quoteName(latexfile.toFilesystemEncoding())
609 << " --dpi " << int(font_scaling_factor)
610 << " --fg " << fg_name
611 << " --bg " << bg_name;
612 // FIXME what about LuaTeX?
613 if (buffer_.params().useNonTeXFonts)
614 cs << " --latex=xelatex";
615 if (buffer_.params().encoding().package() == Encoding::japanese)
616 cs << " --latex=platex";
617 if (buffer_.params().bibtex_command != "default")
618 cs << " --bibtex=" << quoteName(buffer_.params().bibtex_command);
619 else if (buffer_.params().encoding().package() == Encoding::japanese)
620 cs << " --bibtex=" << quoteName(lyxrc.jbibtex_command);
622 cs << " --bibtex=" << quoteName(lyxrc.bibtex_command);
623 if (buffer_.params().bufferFormat() == "lilypond-book")
626 string const command = libScriptSearch(cs.str());
629 ForkedCall call(buffer_.filePath());
630 int ret = call.startScript(ForkedProcess::Wait, command);
631 static int fake = (2^20) + 1;
633 inprogress.pid = pid;
634 inprogress.command = command;
635 in_progress_[pid] = inprogress;
636 finishedGenerating(pid, ret);
640 // Initiate the conversion from LaTeX to bitmap images files.
641 ForkedCall::SignalTypePtr
642 convert_ptr(new ForkedCall::SignalType);
643 convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
645 ForkedCall call(buffer_.filePath());
646 int ret = call.startScript(command, convert_ptr);
649 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
650 << "Unable to start process\n" << command);
654 // Store the generation process in a list of all such processes
655 inprogress.pid = call.pid();
656 inprogress.command = command;
657 in_progress_[inprogress.pid] = inprogress;
661 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
664 InProgressProcesses::iterator git = in_progress_.find(pid);
665 if (git == in_progress_.end()) {
666 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
667 "data for PID " << pid << endl;
671 string const command = git->second.command;
672 string const status = retval > 0 ? "failed" : "succeeded";
673 LYXERR(Debug::GRAPHICS, "PreviewLoader::finishedInProgress("
674 << retval << "): processing " << status
675 << " for " << command);
679 // Read the metrics file, if it exists
680 vector<double> ascent_fractions(git->second.snippets.size());
681 setAscentFractions(ascent_fractions, git->second.metrics_file);
683 // Add these newly generated bitmap files to the cache and
684 // start loading them into LyX.
685 BitmapFile::const_iterator it = git->second.snippets.begin();
686 BitmapFile::const_iterator end = git->second.snippets.end();
688 list<PreviewImagePtr> newimages;
690 int metrics_counter = 0;
691 for (; it != end; ++it, ++metrics_counter) {
692 string const & snip = it->first;
693 FileName const & file = it->second;
694 double af = ascent_fractions[metrics_counter];
696 // Add the image to the cache only if it's actually present
697 if (file.isReadableFile()) {
698 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
701 newimages.push_back(ptr);
706 // Remove the item from the list of still-executing processes.
707 in_progress_.erase(git);
709 // Tell the outside world
710 list<PreviewImagePtr>::const_reverse_iterator
711 nit = newimages.rbegin();
712 list<PreviewImagePtr>::const_reverse_iterator
713 nend = newimages.rend();
714 for (; nit != nend; ++nit) {
715 imageReady(*nit->get());
720 void PreviewLoader::Impl::dumpPreamble(otexstream & os) const
722 // Dump the preamble only.
723 OutputParams runparams(&buffer_.params().encoding());
724 if (buffer_.params().useNonTeXFonts)
725 runparams.flavor = OutputParams::XETEX;
727 runparams.flavor = OutputParams::LATEX;
728 runparams.nice = true;
729 runparams.moving_arg = true;
730 runparams.free_spacing = true;
731 buffer_.writeLaTeXSource(os, buffer_.filePath(), runparams, Buffer::OnlyPreamble);
733 // FIXME! This is a HACK! The proper fix is to control the 'true'
734 // passed to WriteStream below:
735 // int InsetMathNest::latex(Buffer const &, odocstream & os,
736 // OutputParams const & runparams) const
738 // WriteStream wi(os, runparams.moving_arg, true);
743 << "\\def\\lyxlock{}\n"
746 // All equation labels appear as "(#)" + preview.sty's rendering of
748 if (lyxrc.preview_hashed_labels)
749 os << "\\renewcommand{\\theequation}{\\#}\n";
751 // Use the preview style file to ensure that each snippet appears on a
753 // Also support PDF output (automatically generated e.g. when
754 // \usepackage[pdftex]{hyperref} is used and XeTeX.
756 << "\\usepackage[active,delayed,showlabels,lyx]{preview}\n"
761 void PreviewLoader::Impl::dumpData(odocstream & os,
762 BitmapFile const & vec) const
767 BitmapFile::const_iterator it = vec.begin();
768 BitmapFile::const_iterator end = vec.end();
770 for (; it != end; ++it) {
772 os << "\\begin{preview}\n"
773 << from_utf8(it->first)
774 << "\n\\end{preview}\n\n";
778 } // namespace graphics