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
31 #include "insets/Inset.h"
33 #include "support/convert.h"
34 #include "support/debug.h"
35 #include "support/FileName.h"
36 #include "support/filetools.h"
37 #include "support/ForkedCalls.h"
38 #include "support/lstrings.h"
40 #include "support/bind.h"
41 #include "support/TempFile.h"
48 using namespace lyx::support;
54 typedef pair<string, FileName> SnippetPair;
56 // A list of all snippets to be converted to previews
57 typedef list<string> PendingSnippets;
59 // Each item in the vector is a pair<snippet, image file name>.
60 typedef vector<SnippetPair> BitmapFile;
63 FileName const unique_tex_filename(FileName const & bufferpath)
65 TempFile tempfile(bufferpath, "lyxpreviewXXXXXX.tex");
66 tempfile.setAutoRemove(false);
67 return tempfile.name();
71 lyx::Converter const * setConverter(string const & from)
73 typedef vector<string> FmtList;
74 typedef lyx::graphics::Cache GCache;
75 FmtList const & loadableFormats = GCache::get().loadableFormats();
76 FmtList::const_iterator it = loadableFormats.begin();
77 FmtList::const_iterator const end = loadableFormats.end();
79 for (; it != end; ++it) {
80 string const to = *it;
84 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 &, OutputParams::FLAVOR) 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 mutable int font_scaling_factor_;
252 /// We don't own this
253 static lyx::Converter const * pconverter_;
257 lyx::Converter const * PreviewLoader::Impl::pconverter_;
261 // The public interface, defined in PreviewLoader.h
264 PreviewLoader::PreviewLoader(Buffer const & b)
265 : pimpl_(new Impl(*this, b))
269 PreviewLoader::~PreviewLoader()
275 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
277 return pimpl_->preview(latex_snippet);
281 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
283 return pimpl_->status(latex_snippet);
287 void PreviewLoader::add(string const & latex_snippet) const
289 pimpl_->add(latex_snippet);
293 void PreviewLoader::remove(string const & latex_snippet) const
295 pimpl_->remove(latex_snippet);
299 void PreviewLoader::startLoading(bool wait) const
301 pimpl_->startLoading(wait);
305 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
307 return pimpl_->imageReady.connect(slot);
311 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
313 pimpl_->imageReady(pimage);
317 Buffer const & PreviewLoader::buffer() const
319 return pimpl_->buffer();
322 } // namespace graphics
326 // The details of the Impl
327 // =======================
331 class IncrementedFileName {
333 IncrementedFileName(string const & to_format,
334 string const & filename_base)
335 : to_format_(to_format), base_(filename_base), counter_(1)
338 SnippetPair const operator()(string const & snippet)
341 os << base_ << counter_++ << '.' << to_format_;
342 string const file = os.str();
344 return make_pair(snippet, FileName(file));
348 string const & to_format_;
349 string const & base_;
354 InProgress::InProgress(string const & filename_base,
355 PendingSnippets const & pending,
356 string const & to_format)
358 metrics_file(filename_base + ".metrics"),
359 snippets(pending.size())
361 PendingSnippets::const_iterator pit = pending.begin();
362 PendingSnippets::const_iterator pend = pending.end();
363 BitmapFile::iterator sit = snippets.begin();
365 transform(pit, pend, sit,
366 IncrementedFileName(to_format, filename_base));
370 void InProgress::stop() const
373 ForkedCallsController::kill(pid, 0);
375 if (!metrics_file.empty())
376 metrics_file.removeFile();
378 BitmapFile::const_iterator vit = snippets.begin();
379 BitmapFile::const_iterator vend = snippets.end();
380 for (; vit != vend; ++vit) {
381 if (!vit->second.empty())
382 vit->second.removeFile();
392 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
393 : parent_(p), buffer_(b)
395 font_scaling_factor_ = int(buffer_.fontScalingFactor());
397 pconverter_ = setConverter("lyxpreview");
401 PreviewLoader::Impl::~Impl()
403 InProgressProcesses::iterator ipit = in_progress_.begin();
404 InProgressProcesses::iterator ipend = in_progress_.end();
406 for (; ipit != ipend; ++ipit)
412 PreviewLoader::Impl::preview(string const & latex_snippet) const
414 int fs = int(buffer_.fontScalingFactor());
415 if (font_scaling_factor_ != fs) {
416 // Refresh all previews on zoom changes
417 font_scaling_factor_ = fs;
418 Cache::const_iterator cit = cache_.begin();
419 Cache::const_iterator cend = cache_.end();
421 parent_.remove((cit++)->first);
422 buffer_.updatePreviews();
424 Cache::const_iterator it = cache_.find(latex_snippet);
425 return (it == cache_.end()) ? 0 : it->second.get();
433 FindSnippet(string const & s) : snippet_(s) {}
434 bool operator()(InProgressProcess const & process) const
436 BitmapFile const & snippets = process.second.snippets;
437 BitmapFile::const_iterator beg = snippets.begin();
438 BitmapFile::const_iterator end = snippets.end();
439 return find_if(beg, end, FindFirst(snippet_)) != end;
443 string const snippet_;
448 PreviewLoader::Status
449 PreviewLoader::Impl::status(string const & latex_snippet) const
451 Cache::const_iterator cit = cache_.find(latex_snippet);
452 if (cit != cache_.end())
455 PendingSnippets::const_iterator pit = pending_.begin();
456 PendingSnippets::const_iterator pend = pending_.end();
458 pit = find(pit, pend, latex_snippet);
462 InProgressProcesses::const_iterator ipit = in_progress_.begin();
463 InProgressProcesses::const_iterator ipend = in_progress_.end();
465 ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
473 void PreviewLoader::Impl::add(string const & latex_snippet)
475 if (!pconverter_ || status(latex_snippet) != NotFound)
478 string const snippet = trim(latex_snippet);
482 LYXERR(Debug::GRAPHICS, "adding snippet:\n" << snippet);
484 pending_.push_back(snippet);
492 EraseSnippet(string const & s) : snippet_(s) {}
493 void operator()(InProgressProcess & process)
495 BitmapFile & snippets = process.second.snippets;
496 BitmapFile::iterator it = snippets.begin();
497 BitmapFile::iterator end = snippets.end();
499 it = find_if(it, end, FindFirst(snippet_));
501 snippets.erase(it, it+1);
505 string const & snippet_;
511 void PreviewLoader::Impl::remove(string const & latex_snippet)
513 Cache::iterator cit = cache_.find(latex_snippet);
514 if (cit != cache_.end())
517 PendingSnippets::iterator pit = pending_.begin();
518 PendingSnippets::iterator pend = pending_.end();
520 pending_.erase(std::remove(pit, pend, latex_snippet), pend);
522 InProgressProcesses::iterator ipit = in_progress_.begin();
523 InProgressProcesses::iterator ipend = in_progress_.end();
525 for_each(ipit, ipend, EraseSnippet(latex_snippet));
527 while (ipit != ipend) {
528 InProgressProcesses::iterator curr = ipit++;
529 if (curr->second.snippets.empty())
530 in_progress_.erase(curr);
535 void PreviewLoader::Impl::startLoading(bool wait)
537 if (pending_.empty() || !pconverter_)
540 // Only start the process off after the buffer is loaded from file.
541 if (!buffer_.isFullyLoaded())
544 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()");
546 // As used by the LaTeX file and by the resulting image files
547 FileName const directory(buffer_.temppath());
549 FileName const latexfile = unique_tex_filename(directory);
550 string const filename_base = removeExtension(latexfile.absFileName());
552 // Create an InProgress instance to place in the map of all
553 // such processes if it starts correctly.
554 InProgress inprogress(filename_base, pending_, pconverter_->to());
556 // clear pending_, so we're ready to start afresh.
559 // Output the LaTeX file.
560 // we use the encoding of the buffer
561 Encoding const & enc = buffer_.params().encoding();
563 try { of.reset(enc.iconvName()); }
564 catch (iconv_codecvt_facet_exception const & e) {
565 LYXERR0("Caught iconv exception: " << e.what()
566 << "\nUnable to create LaTeX file: " << latexfile);
571 otexstream os(of, texrow);
572 OutputParams runparams(&enc);
573 LaTeXFeatures features(buffer_, buffer_.params(), runparams);
575 if (!openFileWrite(of, latexfile))
579 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
580 << "Unable to create LaTeX file\n" << latexfile);
583 of << "\\batchmode\n";
585 LYXERR(Debug::LATEX, "Format = " << buffer_.params().getDefaultOutputFormat());
586 string latexparam = "";
587 bool docformat = !buffer_.params().default_output_format.empty()
588 && buffer_.params().default_output_format != "default";
589 // Use LATEX flavor if the document does not specify a specific
590 // output format (see bug 9371).
591 OutputParams::FLAVOR flavor = docformat
592 ? buffer_.params().getOutputFlavor()
593 : OutputParams::LATEX;
594 if (buffer_.params().encoding().package() == Encoding::japanese) {
595 latexparam = " --latex=platex";
596 flavor = OutputParams::LATEX;
598 else if (buffer_.params().useNonTeXFonts) {
599 if (flavor == OutputParams::LUATEX)
600 latexparam = " --latex=lualatex";
602 flavor = OutputParams::XETEX;
603 latexparam = " --latex=xelatex";
608 case OutputParams::PDFLATEX:
609 latexparam = " --latex=pdflatex";
611 case OutputParams::XETEX:
612 latexparam = " --latex=xelatex";
614 case OutputParams::LUATEX:
615 latexparam = " --latex=lualatex";
617 case OutputParams::DVILUATEX:
618 latexparam = " --latex=dvilualatex";
621 flavor = OutputParams::LATEX;
624 dumpPreamble(os, flavor);
625 // handle inputenc etc.
626 // I think, this is already hadled by dumpPreamble(): Kornel
627 // buffer_.params().writeEncodingPreamble(os, features);
628 of << "\n\\begin{document}\n";
629 dumpData(of, inprogress.snippets);
630 of << "\n\\end{document}\n";
633 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
634 << "File was not closed properly.");
638 // The conversion command.
640 cs << pconverter_->command()
641 << " " << quoteName(latexfile.toFilesystemEncoding())
642 << " --dpi " << font_scaling_factor_;
645 // The colors should be customizable.
646 if (!buffer_.isExporting()) {
647 ColorCode const fg = PreviewLoader::foregroundColor();
648 ColorCode const bg = PreviewLoader::backgroundColor();
649 cs << " --fg " << theApp()->hexName(fg)
650 << " --bg " << theApp()->hexName(bg);
654 if (buffer_.params().bibtex_command != "default")
655 cs << " --bibtex=" << quoteName(buffer_.params().bibtex_command);
656 else if (buffer_.params().encoding().package() == Encoding::japanese)
657 cs << " --bibtex=" << quoteName(lyxrc.jbibtex_command);
659 cs << " --bibtex=" << quoteName(lyxrc.bibtex_command);
660 if (buffer_.params().bufferFormat() == "lilypond-book")
663 string const command = cs.str();
666 ForkedCall call(buffer_.filePath());
667 int ret = call.startScript(ForkedProcess::Wait, command);
669 static int fake = (2^20) + 1;
671 inprogress.pid = pid;
672 inprogress.command = command;
673 in_progress_[pid] = inprogress;
674 finishedGenerating(pid, ret);
678 // Initiate the conversion from LaTeX to bitmap images files.
679 ForkedCall::SignalTypePtr
680 convert_ptr(new ForkedCall::SignalType);
681 convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
683 ForkedCall call(buffer_.filePath());
684 int ret = call.startScript(command, convert_ptr);
687 LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()\n"
688 << "Unable to start process\n" << command);
692 // Store the generation process in a list of all such processes
693 inprogress.pid = call.pid();
694 inprogress.command = command;
695 in_progress_[inprogress.pid] = inprogress;
699 double PreviewLoader::displayPixelRatio() const
701 return buffer().params().display_pixel_ratio;
704 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
707 InProgressProcesses::iterator git = in_progress_.find(pid);
708 if (git == in_progress_.end()) {
709 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
710 "data for PID " << pid << endl;
714 string const command = git->second.command;
715 string const status = retval > 0 ? "failed" : "succeeded";
716 LYXERR(Debug::GRAPHICS, "PreviewLoader::finishedInProgress("
717 << retval << "): processing " << status
718 << " for " << command);
722 // Read the metrics file, if it exists
723 vector<double> ascent_fractions(git->second.snippets.size());
724 setAscentFractions(ascent_fractions, git->second.metrics_file);
726 // Add these newly generated bitmap files to the cache and
727 // start loading them into LyX.
728 BitmapFile::const_iterator it = git->second.snippets.begin();
729 BitmapFile::const_iterator end = git->second.snippets.end();
731 list<PreviewImagePtr> newimages;
733 int metrics_counter = 0;
734 for (; it != end; ++it, ++metrics_counter) {
735 string const & snip = it->first;
736 FileName const & file = it->second;
737 double af = ascent_fractions[metrics_counter];
739 // Add the image to the cache only if it's actually present
740 // and not empty (an empty image is signaled by af < 0)
741 if (af >= 0 && file.isReadableFile()) {
742 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
745 newimages.push_back(ptr);
750 // Remove the item from the list of still-executing processes.
751 in_progress_.erase(git);
753 // Tell the outside world
754 list<PreviewImagePtr>::const_reverse_iterator
755 nit = newimages.rbegin();
756 list<PreviewImagePtr>::const_reverse_iterator
757 nend = newimages.rend();
758 for (; nit != nend; ++nit) {
759 imageReady(*nit->get());
764 void PreviewLoader::Impl::dumpPreamble(otexstream & os, OutputParams::FLAVOR flavor) const
766 // Dump the preamble only.
767 LYXERR(Debug::LATEX, "dumpPreamble, flavor == " << flavor);
768 OutputParams runparams(&buffer_.params().encoding());
769 runparams.flavor = flavor;
770 runparams.nice = true;
771 runparams.moving_arg = true;
772 runparams.free_spacing = true;
773 runparams.is_child = buffer_.parent();
774 buffer_.writeLaTeXSource(os, buffer_.filePath(), runparams, Buffer::OnlyPreamble);
776 // FIXME! This is a HACK! The proper fix is to control the 'true'
777 // passed to WriteStream below:
778 // int InsetMathNest::latex(Buffer const &, odocstream & os,
779 // OutputParams const & runparams) const
781 // WriteStream wi(os, runparams.moving_arg, true);
786 << "\\def\\lyxlock{}\n"
789 // All equation labels appear as "(#)" + preview.sty's rendering of
791 if (lyxrc.preview_hashed_labels)
792 os << "\\renewcommand{\\theequation}{\\#}\n";
794 // Use the preview style file to ensure that each snippet appears on a
796 // Also support PDF output (automatically generated e.g. when
797 // \usepackage[pdftex]{hyperref} is used and XeTeX.
799 << "\\usepackage[active,delayed,showlabels,lyx]{preview}\n"
804 void PreviewLoader::Impl::dumpData(odocstream & os,
805 BitmapFile const & vec) const
810 BitmapFile::const_iterator it = vec.begin();
811 BitmapFile::const_iterator end = vec.end();
813 for (; it != end; ++it) {
815 os << "\\begin{preview}\n"
816 << from_utf8(it->first)
817 << "\n\\end{preview}\n\n";
821 } // namespace graphics