2 * \file PreviewLoader.C
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"
17 #include "converter.h"
22 #include "outputparams.h"
23 #include "paragraph.h"
25 #include "frontends/lyx_gui.h" // hexname
27 #include "insets/inset.h"
29 #include "support/filetools.h"
30 #include "support/forkedcall.h"
31 #include "support/forkedcontr.h"
32 #include "support/lstrings.h"
33 #include "support/lyxlib.h"
34 #include "support/tostr.h"
36 #include <boost/bind.hpp>
38 #include "support/std_sstream.h"
42 namespace support = lyx::support;
57 using std::ostringstream;
65 typedef pair<string, string> StrPair;
67 // A list of alll snippets to be converted to previews
68 typedef list<string> PendingSnippets;
70 // Each item in the vector is a pair<snippet, image file name>.
71 typedef vector<StrPair> BitmapFile;
73 string const unique_filename(string const bufferpath);
75 Converter const * setConverter();
77 void setAscentFractions(vector<double> & ascent_fractions,
78 string const & metrics_file);
80 class FindFirst : public std::unary_function<StrPair, bool> {
82 FindFirst(string const & comp) : comp_(comp) {}
83 bool operator()(StrPair const & sp) const
85 return sp.first == comp_;
92 /// Store info on a currently executing, forked process.
95 InProgress() : pid(0) {}
97 InProgress(string const & filename_base,
98 PendingSnippets const & pending,
99 string const & to_format);
100 /// Remove any files left lying around and kill the forked process.
113 typedef map<pid_t, InProgress> InProgressProcesses;
115 typedef InProgressProcesses::value_type InProgressProcess;
123 struct PreviewLoader::Impl : public boost::signals::trackable {
125 Impl(PreviewLoader & p, Buffer const & b);
126 /// Stop any InProgress items still executing.
129 PreviewImage const * preview(string const & latex_snippet) const;
131 PreviewLoader::Status status(string const & latex_snippet) const;
133 void add(string const & latex_snippet);
135 void remove(string const & latex_snippet);
139 /// Emit this signal when an image is ready for display.
140 boost::signal1<void, PreviewImage const &> imageReady;
142 Buffer const & buffer() const { return buffer_; }
145 /// Called by the Forkedcall process that generated the bitmap files.
146 void finishedGenerating(pid_t, int);
148 void dumpPreamble(ostream &) const;
150 void dumpData(ostream &, BitmapFile const &) const;
152 /** cache_ allows easy retrieval of already-generated images
153 * using the LaTeX snippet as the identifier.
155 typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
157 typedef map<string, PreviewImagePtr> Cache;
161 /** pending_ stores the LaTeX snippets in anticipation of them being
162 * sent to the converter.
164 PendingSnippets pending_;
166 /** in_progress_ stores all forked processes so that we can proceed
168 The map uses the conversion commands as its identifiers.
170 InProgressProcesses in_progress_;
173 PreviewLoader & parent_;
175 Buffer const & buffer_;
177 double font_scaling_factor_;
179 /// We don't own this
180 static Converter const * pconverter_;
184 Converter const * PreviewLoader::Impl::pconverter_;
187 // The public interface, defined in PreviewLoader.h
188 // ================================================
189 PreviewLoader::PreviewLoader(Buffer const & b)
190 : pimpl_(new Impl(*this, b))
194 PreviewLoader::~PreviewLoader()
198 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
200 return pimpl_->preview(latex_snippet);
204 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
206 return pimpl_->status(latex_snippet);
210 void PreviewLoader::add(string const & latex_snippet) const
212 pimpl_->add(latex_snippet);
216 void PreviewLoader::remove(string const & latex_snippet) const
218 pimpl_->remove(latex_snippet);
222 void PreviewLoader::startLoading() const
224 pimpl_->startLoading();
228 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
230 return pimpl_->imageReady.connect(slot);
234 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
236 pimpl_->imageReady(pimage);
240 Buffer const & PreviewLoader::buffer() const
242 return pimpl_->buffer();
245 } // namespace graphics
249 // The details of the Impl
250 // =======================
254 struct IncrementedFileName {
255 IncrementedFileName(string const & to_format,
256 string const & filename_base)
257 : to_format_(to_format), base_(filename_base), counter_(1)
260 StrPair const operator()(string const & snippet)
263 os << base_ << counter_++ << '.' << to_format_;
264 string const file = os.str();
266 return make_pair(snippet, file);
270 string const & to_format_;
271 string const & base_;
276 InProgress::InProgress(string const & filename_base,
277 PendingSnippets const & pending,
278 string const & to_format)
280 metrics_file(filename_base + ".metrics"),
281 snippets(pending.size())
283 PendingSnippets::const_iterator pit = pending.begin();
284 PendingSnippets::const_iterator pend = pending.end();
285 BitmapFile::iterator sit = snippets.begin();
287 std::transform(pit, pend, sit,
288 IncrementedFileName(to_format, filename_base));
292 void InProgress::stop() const
295 support::ForkedcallsController::get().kill(pid, 0);
297 if (!metrics_file.empty())
298 support::unlink(metrics_file);
300 BitmapFile::const_iterator vit = snippets.begin();
301 BitmapFile::const_iterator vend = snippets.end();
302 for (; vit != vend; ++vit) {
303 if (!vit->second.empty())
304 support::unlink(vit->second);
314 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
315 : parent_(p), buffer_(b), font_scaling_factor_(0.0)
317 font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
318 lyxrc.preview_scale_factor;
320 lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
321 << font_scaling_factor_ << endl;
324 pconverter_ = setConverter();
328 PreviewLoader::Impl::~Impl()
330 InProgressProcesses::iterator ipit = in_progress_.begin();
331 InProgressProcesses::iterator ipend = in_progress_.end();
333 for (; ipit != ipend; ++ipit) {
340 PreviewLoader::Impl::preview(string const & latex_snippet) const
342 Cache::const_iterator it = cache_.find(latex_snippet);
343 return (it == cache_.end()) ? 0 : it->second.get();
349 class FindSnippet : public std::unary_function<InProgressProcess, bool> {
351 FindSnippet(string const & s) : snippet_(s) {}
352 bool operator()(InProgressProcess const & process) const
354 BitmapFile const & snippets = process.second.snippets;
355 BitmapFile::const_iterator beg = snippets.begin();
356 BitmapFile::const_iterator end = snippets.end();
357 return find_if(beg, end, FindFirst(snippet_)) != end;
361 string const snippet_;
366 PreviewLoader::Status
367 PreviewLoader::Impl::status(string const & latex_snippet) const
369 Cache::const_iterator cit = cache_.find(latex_snippet);
370 if (cit != cache_.end())
373 PendingSnippets::const_iterator pit = pending_.begin();
374 PendingSnippets::const_iterator pend = pending_.end();
376 pit = find(pit, pend, latex_snippet);
380 InProgressProcesses::const_iterator ipit = in_progress_.begin();
381 InProgressProcesses::const_iterator ipend = in_progress_.end();
383 ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
391 void PreviewLoader::Impl::add(string const & latex_snippet)
393 if (!pconverter_ || status(latex_snippet) != NotFound)
396 string const snippet = support::trim(latex_snippet);
400 lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
402 pending_.push_back(snippet);
408 struct EraseSnippet {
409 EraseSnippet(string const & s) : snippet_(s) {}
410 void operator()(InProgressProcess & process)
412 BitmapFile & snippets = process.second.snippets;
413 BitmapFile::iterator it = snippets.begin();
414 BitmapFile::iterator end = snippets.end();
416 it = find_if(it, end, FindFirst(snippet_));
418 snippets.erase(it, it+1);
422 string const & snippet_;
428 void PreviewLoader::Impl::remove(string const & latex_snippet)
430 Cache::iterator cit = cache_.find(latex_snippet);
431 if (cit != cache_.end())
434 PendingSnippets::iterator pit = pending_.begin();
435 PendingSnippets::iterator pend = pending_.end();
437 pending_.erase(std::remove(pit, pend, latex_snippet), pend);
439 InProgressProcesses::iterator ipit = in_progress_.begin();
440 InProgressProcesses::iterator ipend = in_progress_.end();
442 std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
444 while (ipit != ipend) {
445 InProgressProcesses::iterator curr = ipit++;
446 if (curr->second.snippets.empty())
447 in_progress_.erase(curr);
452 void PreviewLoader::Impl::startLoading()
454 if (pending_.empty() || !pconverter_)
457 // Only start the process off after the buffer is loaded from file.
458 if (!buffer_.fully_loaded())
461 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
463 // As used by the LaTeX file and by the resulting image files
464 string const directory = buffer_.temppath();
466 string const filename_base(unique_filename(directory));
468 // Create an InProgress instance to place in the map of all
469 // such processes if it starts correctly.
470 InProgress inprogress(filename_base, pending_, pconverter_->to);
472 // clear pending_, so we're ready to start afresh.
475 // Output the LaTeX file.
476 string const latexfile = filename_base + ".tex";
478 ofstream of(latexfile.c_str());
480 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
481 << "Unable to create LaTeX file\n"
482 << latexfile << endl;
485 of << "\\batchmode\n";
487 of << "\n\\begin{document}\n";
488 dumpData(of, inprogress.snippets);
489 of << "\n\\end{document}\n";
492 // The conversion command.
494 cs << pconverter_->command << ' ' << latexfile << ' '
495 << int(font_scaling_factor_) << ' ' << pconverter_->to;
497 string const command = "sh " + support::LibScriptSearch(cs.str());
499 // Initiate the conversion from LaTeX to bitmap images files.
500 support::Forkedcall::SignalTypePtr
501 convert_ptr(new support::Forkedcall::SignalType);
502 convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
504 support::Forkedcall call;
505 int ret = call.startscript(command, convert_ptr);
508 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
509 << "Unable to start process \n"
514 // Store the generation process in a list of all such processes
515 inprogress.pid = call.pid();
516 inprogress.command = command;
517 in_progress_[inprogress.pid] = inprogress;
521 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
524 InProgressProcesses::iterator git = in_progress_.find(pid);
525 if (git == in_progress_.end()) {
526 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
527 "data for PID " << pid << endl;
531 string const command = git->second.command;
532 string const status = retval > 0 ? "failed" : "succeeded";
533 lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
534 << retval << "): processing " << status
535 << " for " << command << endl;
539 // Read the metrics file, if it exists
540 vector<double> ascent_fractions(git->second.snippets.size());
541 setAscentFractions(ascent_fractions, git->second.metrics_file);
543 // Add these newly generated bitmap files to the cache and
544 // start loading them into LyX.
545 BitmapFile::const_iterator it = git->second.snippets.begin();
546 BitmapFile::const_iterator end = git->second.snippets.end();
548 std::list<PreviewImagePtr> newimages;
550 int metrics_counter = 0;
551 for (; it != end; ++it, ++metrics_counter) {
552 string const & snip = it->first;
553 string const & file = it->second;
554 double af = ascent_fractions[metrics_counter];
556 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
559 newimages.push_back(ptr);
562 // Remove the item from the list of still-executing processes.
563 in_progress_.erase(git);
565 // Tell the outside world
566 std::list<PreviewImagePtr>::const_reverse_iterator
567 nit = newimages.rbegin();
568 std::list<PreviewImagePtr>::const_reverse_iterator
569 nend = newimages.rend();
570 for (; nit != nend; ++nit) {
571 imageReady(*nit->get());
576 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
578 // Why on earth is Buffer::makeLaTeXFile a non-const method?
579 Buffer & tmp = const_cast<Buffer &>(buffer_);
580 // Dump the preamble only.
581 OutputParams runparams;
582 runparams.flavor = OutputParams::LATEX;
583 runparams.nice = true;
584 runparams.moving_arg = true;
585 runparams.free_spacing = true;
586 tmp.makeLaTeXFile(os, buffer_.filePath(), runparams, true, false);
588 // FIXME! This is a HACK! The proper fix is to control the 'true'
589 // passed to WriteStream below:
590 // int InsetFormula::latex(Buffer const &, ostream & os,
591 // OutputParams const & runparams) const
593 // WriteStream wi(os, runparams.moving_arg, true);
598 << "\\def\\lyxlock{}\n"
601 // Loop over the insets in the buffer and dump all the math-macros.
602 Buffer::inset_iterator it = buffer_.inset_const_iterator_begin();
603 Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
605 for (; it != end; ++it)
606 if (it->lyxCode() == InsetOld::MATHMACRO_CODE)
607 it->latex(buffer_, os, runparams);
609 // All equation lables appear as "(#)" + preview.sty's rendering of
611 if (lyxrc.preview_hashed_labels)
612 os << "\\renewcommand{\\theequation}{\\#}\n";
614 // Use the preview style file to ensure that each snippet appears on a
617 << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
620 // This piece of PostScript magic ensures that the foreground and
621 // background colors are the same as the LyX screen.
622 string fg = lyx_gui::hexname(LColor::preview);
623 if (fg.empty()) fg = "000000";
625 string bg = lyx_gui::hexname(LColor::background);
626 if (bg.empty()) bg = "ffffff";
628 os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
629 << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
630 << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
631 << "clippath fill setrgbcolor}bind def end}}}\n";
635 void PreviewLoader::Impl::dumpData(ostream & os,
636 BitmapFile const & vec) const
641 BitmapFile::const_iterator it = vec.begin();
642 BitmapFile::const_iterator end = vec.end();
644 for (; it != end; ++it) {
645 os << "\\begin{preview}\n"
647 << "\n\\end{preview}\n\n";
651 } // namespace graphics
656 string const unique_filename(string const bufferpath)
658 static int theCounter = 0;
659 string const filename = tostr(theCounter++) + "lyxpreview";
660 return support::AddName(bufferpath, filename);
664 Converter const * setConverter()
666 string const from = "lyxpreview";
668 Formats::FormatList::const_iterator it = formats.begin();
669 Formats::FormatList::const_iterator end = formats.end();
671 for (; it != end; ++it) {
672 string const to = it->name();
676 Converter const * ptr = converters.getConverter(from, to);
681 static bool first = true;
684 lyxerr << "PreviewLoader::startLoading()\n"
685 << "No converter from \"lyxpreview\" format has been "
694 void setAscentFractions(vector<double> & ascent_fractions,
695 string const & metrics_file)
697 // If all else fails, then the images will have equal ascents and
699 vector<double>::iterator it = ascent_fractions.begin();
700 vector<double>::iterator end = ascent_fractions.end();
703 ifstream in(metrics_file.c_str());
705 lyxerr[Debug::GRAPHICS]
706 << "setAscentFractions(" << metrics_file << ")\n"
707 << "Unable to open file!" << endl;
713 // Tightpage dimensions affect all subsequent dimensions
717 int snippet_counter = 0;
719 // Expecting lines of the form
720 // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
721 // Preview: Snippet id ascent descent width
724 in >> preview >> type;
730 error = preview != "Preview:"
731 || (type != "Tightpage" && type != "Snippet");
735 if (type == "Tightpage") {
737 in >> dummy >> tp_descent >> dummy >> tp_ascent;
748 in >> snippet_id >> ascent >> descent >> dummy;
750 error = !in.good() || ++snippet_counter != snippet_id;
754 double const a = ascent + tp_ascent;
755 double const d = descent - tp_descent;
757 if (!support::float_equal(a + d, 0, 0.1))
766 lyxerr[Debug::GRAPHICS]
767 << "setAscentFractions(" << metrics_file << ")\n"
768 << "Error reading file!\n" << endl;