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
14 #pragma implementation
17 #include "PreviewLoader.h"
18 #include "PreviewImage.h"
21 #include "converter.h"
26 #include "insets/inset.h"
28 #include "frontends/lyx_gui.h" // hexname
30 #include "support/filetools.h"
31 #include "support/forkedcall.h"
32 #include "support/forkedcontr.h"
33 #include "support/lstrings.h"
34 #include "support/lyxlib.h"
36 #include <boost/bind.hpp>
37 #include <boost/signals/trackable.hpp>
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);
81 FindFirst(string const & comp) : comp_(comp) {}
82 bool operator()(StrPair const & sp)
84 return sp.first < comp_;
91 /// Store info on a currently executing, forked process.
94 InProgress() : pid(0) {}
96 InProgress(string const & filename_base,
97 PendingSnippets const & pending,
98 string const & to_format);
99 /// Remove any files left lying around and kill the forked process.
112 typedef map<pid_t, InProgress> InProgressProcesses;
114 typedef InProgressProcesses::value_type InProgressProcess;
121 struct PreviewLoader::Impl : public boost::signals::trackable {
123 Impl(PreviewLoader & p, Buffer const & b);
124 /// Stop any InProgress items still executing.
127 PreviewImage const * preview(string const & latex_snippet) const;
129 PreviewLoader::Status status(string const & latex_snippet) const;
131 void add(string const & latex_snippet);
133 void remove(string const & latex_snippet);
137 /// Emit this signal when an image is ready for display.
138 boost::signal1<void, PreviewImage const &> imageReady;
140 Buffer const & buffer() const { return buffer_; }
143 /// Called by the Forkedcall process that generated the bitmap files.
144 void finishedGenerating(pid_t, int);
146 void dumpPreamble(ostream &) const;
148 void dumpData(ostream &, BitmapFile const &) const;
150 /** cache_ allows easy retrieval of already-generated images
151 * using the LaTeX snippet as the identifier.
153 typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
155 typedef map<string, PreviewImagePtr> Cache;
159 /** pending_ stores the LaTeX snippets in anticipation of them being
160 * sent to the converter.
162 PendingSnippets pending_;
164 /** in_progress_ stores all forked processes so that we can proceed
166 The map uses the conversion commands as its identifiers.
168 InProgressProcesses in_progress_;
171 PreviewLoader & parent_;
173 Buffer const & buffer_;
175 double font_scaling_factor_;
177 /// We don't own this
178 static Converter const * pconverter_;
182 Converter const * PreviewLoader::Impl::pconverter_;
185 // The public interface, defined in PreviewLoader.h
186 // ================================================
187 PreviewLoader::PreviewLoader(Buffer const & b)
188 : pimpl_(new Impl(*this, b))
192 PreviewLoader::~PreviewLoader()
196 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
198 return pimpl_->preview(latex_snippet);
202 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
204 return pimpl_->status(latex_snippet);
208 void PreviewLoader::add(string const & latex_snippet) const
210 pimpl_->add(latex_snippet);
214 void PreviewLoader::remove(string const & latex_snippet) const
216 pimpl_->remove(latex_snippet);
220 void PreviewLoader::startLoading() const
222 pimpl_->startLoading();
226 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
228 return pimpl_->imageReady.connect(slot);
232 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
234 pimpl_->imageReady(pimage);
238 Buffer const & PreviewLoader::buffer() const
240 return pimpl_->buffer();
246 // The details of the Impl
247 // =======================
251 struct IncrementedFileName {
252 IncrementedFileName(string const & to_format,
253 string const & filename_base)
254 : to_format_(to_format), base_(filename_base), counter_(1)
257 StrPair const operator()(string const & snippet)
260 os << base_ << counter_++ << '.' << to_format_;
261 string const file = STRCONV(os.str());
263 return make_pair(snippet, file);
267 string const & to_format_;
268 string const & base_;
273 InProgress::InProgress(string const & filename_base,
274 PendingSnippets const & pending,
275 string const & to_format)
277 metrics_file(filename_base + ".metrics"),
278 snippets(pending.size())
280 PendingSnippets::const_iterator pit = pending.begin();
281 PendingSnippets::const_iterator pend = pending.end();
282 BitmapFile::iterator sit = snippets.begin();
284 std::transform(pit, pend, sit,
285 IncrementedFileName(to_format, filename_base));
289 void InProgress::stop() const
292 ForkedcallsController::get().kill(pid, 0);
294 if (!metrics_file.empty())
295 lyx::unlink(metrics_file);
297 BitmapFile::const_iterator vit = snippets.begin();
298 BitmapFile::const_iterator vend = snippets.end();
299 for (; vit != vend; ++vit) {
300 if (!vit->second.empty())
301 lyx::unlink(vit->second);
310 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
311 : parent_(p), buffer_(b), font_scaling_factor_(0.0)
313 font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
314 lyxrc.preview_scale_factor;
316 lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
317 << font_scaling_factor_ << endl;
320 pconverter_ = setConverter();
324 PreviewLoader::Impl::~Impl()
326 InProgressProcesses::iterator ipit = in_progress_.begin();
327 InProgressProcesses::iterator ipend = in_progress_.end();
329 for (; ipit != ipend; ++ipit) {
336 PreviewLoader::Impl::preview(string const & latex_snippet) const
338 Cache::const_iterator it = cache_.find(latex_snippet);
339 return (it == cache_.end()) ? 0 : it->second.get();
346 FindSnippet(string const & s) : snippet_(s) {}
347 bool operator()(InProgressProcess const & process)
349 BitmapFile const & snippets = process.second.snippets;
350 BitmapFile::const_iterator it = snippets.begin();
351 BitmapFile::const_iterator end = snippets.end();
352 it = find_if(it, end, FindFirst(snippet_));
357 string const & snippet_;
362 PreviewLoader::Status
363 PreviewLoader::Impl::status(string const & latex_snippet) const
365 Cache::const_iterator cit = cache_.find(latex_snippet);
366 if (cit != cache_.end())
369 PendingSnippets::const_iterator pit = pending_.begin();
370 PendingSnippets::const_iterator pend = pending_.end();
372 pit = find(pit, pend, latex_snippet);
376 InProgressProcesses::const_iterator ipit = in_progress_.begin();
377 InProgressProcesses::const_iterator ipend = in_progress_.end();
379 ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
387 void PreviewLoader::Impl::add(string const & latex_snippet)
389 if (!pconverter_ || status(latex_snippet) != NotFound)
392 string const snippet = trim(latex_snippet);
396 lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
398 pending_.push_back(snippet);
404 struct EraseSnippet {
405 EraseSnippet(string const & s) : snippet_(s) {}
406 void operator()(InProgressProcess & process)
408 BitmapFile & snippets = process.second.snippets;
409 BitmapFile::iterator it = snippets.begin();
410 BitmapFile::iterator end = snippets.end();
412 it = find_if(it, end, FindFirst(snippet_));
414 snippets.erase(it, it+1);
418 string const & snippet_;
424 void PreviewLoader::Impl::remove(string const & latex_snippet)
426 Cache::iterator cit = cache_.find(latex_snippet);
427 if (cit != cache_.end())
430 PendingSnippets::iterator pit = pending_.begin();
431 PendingSnippets::iterator pend = pending_.end();
433 pending_.erase(std::remove(pit, pend, latex_snippet), pend);
435 InProgressProcesses::iterator ipit = in_progress_.begin();
436 InProgressProcesses::iterator ipend = in_progress_.end();
438 std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
440 for (; ipit != ipend; ++ipit) {
441 InProgressProcesses::iterator curr = ipit++;
442 if (curr->second.snippets.empty())
443 in_progress_.erase(curr);
448 void PreviewLoader::Impl::startLoading()
450 if (pending_.empty() || !pconverter_)
453 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
455 // As used by the LaTeX file and by the resulting image files
456 string const filename_base(unique_filename(buffer_.tmppath));
458 // Create an InProgress instance to place in the map of all
459 // such processes if it starts correctly.
460 InProgress inprogress(filename_base, pending_, pconverter_->to);
462 // clear pending_, so we're ready to start afresh.
465 // Output the LaTeX file.
466 string const latexfile = filename_base + ".tex";
468 ofstream of(latexfile.c_str());
469 of << "\\batchmode\n";
471 of << "\n\\begin{document}\n";
472 dumpData(of, inprogress.snippets);
473 of << "\n\\end{document}\n";
476 // The conversion command.
478 cs << pconverter_->command << ' ' << latexfile << ' '
479 << int(font_scaling_factor_) << ' ' << pconverter_->to;
481 string const command = "sh " + LibScriptSearch(STRCONV(cs.str()));
483 // Initiate the conversion from LaTeX to bitmap images files.
484 Forkedcall::SignalTypePtr convert_ptr(new Forkedcall::SignalType);
485 convert_ptr->connect(
486 boost::bind(&Impl::finishedGenerating, this, _1, _2));
489 int ret = call.startscript(command, convert_ptr);
492 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
493 << "Unable to start process \n"
498 // Store the generation process in a list of all such processes
499 inprogress.pid = call.pid();
500 inprogress.command = command;
501 in_progress_[inprogress.pid] = inprogress;
505 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
508 InProgressProcesses::iterator git = in_progress_.find(pid);
509 if (git == in_progress_.end()) {
510 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
511 "data for PID " << pid << endl;
515 string const command = git->second.command;
516 string const status = retval > 0 ? "failed" : "succeeded";
517 lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
518 << retval << "): processing " << status
519 << " for " << command << endl;
523 // Read the metrics file, if it exists
524 vector<double> ascent_fractions(git->second.snippets.size());
525 setAscentFractions(ascent_fractions, git->second.metrics_file);
527 // Add these newly generated bitmap files to the cache and
528 // start loading them into LyX.
529 BitmapFile::const_iterator it = git->second.snippets.begin();
530 BitmapFile::const_iterator end = git->second.snippets.end();
532 std::list<PreviewImagePtr> newimages;
534 int metrics_counter = 0;
535 for (; it != end; ++it, ++metrics_counter) {
536 string const & snip = it->first;
537 string const & file = it->second;
538 double af = ascent_fractions[metrics_counter];
540 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
543 newimages.push_back(ptr);
546 // Remove the item from the list of still-executing processes.
547 in_progress_.erase(git);
549 // Tell the outside world
550 std::list<PreviewImagePtr>::const_iterator nit = newimages.begin();
551 std::list<PreviewImagePtr>::const_iterator nend = newimages.end();
552 for (; nit != nend; ++nit) {
553 imageReady(*nit->get());
558 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
560 // Why on earth is Buffer::makeLaTeXFile a non-const method?
561 Buffer & tmp = const_cast<Buffer &>(buffer_);
562 // Dump the preamble only.
563 tmp.makeLaTeXFile(os, buffer_.filePath(), true, false, true);
565 // Loop over the insets in the buffer and dump all the math-macros.
566 Buffer::inset_iterator it = buffer_.inset_const_iterator_begin();
567 Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
569 for (; it != end; ++it)
570 if (it->lyxCode() == Inset::MATHMACRO_CODE)
571 it->latex(&buffer_, os, true, true);
573 // All equation lables appear as "(#)" + preview.sty's rendering of
575 if (lyxrc.preview_hashed_labels)
576 os << "\\renewcommand{\\theequation}{\\#}\n";
578 // Use the preview style file to ensure that each snippet appears on a
581 << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
584 // This piece of PostScript magic ensures that the foreground and
585 // background colors are the same as the LyX screen.
586 string fg = lyx_gui::hexname(LColor::preview);
587 if (fg.empty()) fg = "000000";
589 string bg = lyx_gui::hexname(LColor::background);
590 if (bg.empty()) bg = "ffffff";
592 os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
593 << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
594 << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
595 << "clippath fill setrgbcolor}bind def end}}}\n";
599 void PreviewLoader::Impl::dumpData(ostream & os,
600 BitmapFile const & vec) const
605 BitmapFile::const_iterator it = vec.begin();
606 BitmapFile::const_iterator end = vec.end();
608 for (; it != end; ++it) {
609 os << "\\begin{preview}\n"
611 << "\n\\end{preview}\n\n";
620 string const unique_filename(string const bufferpath)
622 static int theCounter = 0;
623 string const filename = tostr(theCounter++) + "lyxpreview";
624 return AddName(bufferpath, filename);
628 Converter const * setConverter()
630 string const from = "lyxpreview";
632 Formats::FormatList::const_iterator it = formats.begin();
633 Formats::FormatList::const_iterator end = formats.end();
635 for (; it != end; ++it) {
636 string const to = it->name();
640 Converter const * ptr = converters.getConverter(from, to);
645 static bool first = true;
648 lyxerr << "PreviewLoader::startLoading()\n"
649 << "No converter from \"lyxpreview\" format has been "
658 void setAscentFractions(vector<double> & ascent_fractions,
659 string const & metrics_file)
661 // If all else fails, then the images will have equal ascents and
663 vector<double>::iterator it = ascent_fractions.begin();
664 vector<double>::iterator end = ascent_fractions.end();
667 ifstream in(metrics_file.c_str());
669 lyxerr[Debug::GRAPHICS]
670 << "setAscentFractions(" << metrics_file << ")\n"
671 << "Unable to open file!" << endl;
677 // Tightpage dimensions affect all subsequent dimensions
681 int snippet_counter = 0;
683 // Expecting lines of the form
684 // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
685 // Preview: Snippet id ascent descent width
688 in >> preview >> type;
694 error = preview != "Preview:"
695 || (type != "Tightpage" && type != "Snippet");
699 if (type == "Tightpage") {
701 in >> dummy >> tp_descent >> dummy >> tp_ascent;
712 in >> snippet_id >> ascent >> descent >> dummy;
714 error = !in.good() || ++snippet_counter != snippet_id;
718 double const a = ascent + tp_ascent;
719 double const d = descent - tp_descent;
721 if (!lyx::float_equal(a + d, 0, 0.1))
730 lyxerr[Debug::GRAPHICS]
731 << "setAscentFractions(" << metrics_file << ")\n"
732 << "Error reading file!\n" << endl;