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"
20 #include "latexrunparams.h"
23 #include "frontends/lyx_gui.h" // hexname
25 #include "insets/inset.h"
27 #include "support/filetools.h"
28 #include "support/forkedcall.h"
29 #include "support/forkedcontr.h"
30 #include "support/lstrings.h"
31 #include "support/lyxlib.h"
32 #include "support/tostr.h"
34 #include <boost/bind.hpp>
36 #include "support/std_sstream.h"
40 namespace support = lyx::support;
53 using std::ostringstream;
60 typedef pair<string, string> StrPair;
62 // A list of alll snippets to be converted to previews
63 typedef list<string> PendingSnippets;
65 // Each item in the vector is a pair<snippet, image file name>.
66 typedef vector<StrPair> BitmapFile;
68 string const unique_filename(string const bufferpath);
70 Converter const * setConverter();
72 void setAscentFractions(vector<double> & ascent_fractions,
73 string const & metrics_file);
76 FindFirst(string const & comp) : comp_(comp) {}
77 bool operator()(StrPair const & sp)
79 return sp.first == comp_;
86 /// Store info on a currently executing, forked process.
89 InProgress() : pid(0) {}
91 InProgress(string const & filename_base,
92 PendingSnippets const & pending,
93 string const & to_format);
94 /// Remove any files left lying around and kill the forked process.
107 typedef map<pid_t, InProgress> InProgressProcesses;
109 typedef InProgressProcesses::value_type InProgressProcess;
117 struct PreviewLoader::Impl : public boost::signals::trackable {
119 Impl(PreviewLoader & p, Buffer const & b);
120 /// Stop any InProgress items still executing.
123 PreviewImage const * preview(string const & latex_snippet) const;
125 PreviewLoader::Status status(string const & latex_snippet) const;
127 void add(string const & latex_snippet);
129 void remove(string const & latex_snippet);
133 /// Emit this signal when an image is ready for display.
134 boost::signal1<void, PreviewImage const &> imageReady;
136 Buffer const & buffer() const { return buffer_; }
139 /// Called by the Forkedcall process that generated the bitmap files.
140 void finishedGenerating(pid_t, int);
142 void dumpPreamble(ostream &) const;
144 void dumpData(ostream &, BitmapFile const &) const;
146 /** cache_ allows easy retrieval of already-generated images
147 * using the LaTeX snippet as the identifier.
149 typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
151 typedef map<string, PreviewImagePtr> Cache;
155 /** pending_ stores the LaTeX snippets in anticipation of them being
156 * sent to the converter.
158 PendingSnippets pending_;
160 /** in_progress_ stores all forked processes so that we can proceed
162 The map uses the conversion commands as its identifiers.
164 InProgressProcesses in_progress_;
167 PreviewLoader & parent_;
169 Buffer const & buffer_;
171 double font_scaling_factor_;
173 /// We don't own this
174 static Converter const * pconverter_;
178 Converter const * PreviewLoader::Impl::pconverter_;
181 // The public interface, defined in PreviewLoader.h
182 // ================================================
183 PreviewLoader::PreviewLoader(Buffer const & b)
184 : pimpl_(new Impl(*this, b))
188 PreviewLoader::~PreviewLoader()
192 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
194 return pimpl_->preview(latex_snippet);
198 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
200 return pimpl_->status(latex_snippet);
204 void PreviewLoader::add(string const & latex_snippet) const
206 pimpl_->add(latex_snippet);
210 void PreviewLoader::remove(string const & latex_snippet) const
212 pimpl_->remove(latex_snippet);
216 void PreviewLoader::startLoading() const
218 pimpl_->startLoading();
222 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
224 return pimpl_->imageReady.connect(slot);
228 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
230 pimpl_->imageReady(pimage);
234 Buffer const & PreviewLoader::buffer() const
236 return pimpl_->buffer();
239 } // namespace graphics
243 // The details of the Impl
244 // =======================
248 struct IncrementedFileName {
249 IncrementedFileName(string const & to_format,
250 string const & filename_base)
251 : to_format_(to_format), base_(filename_base), counter_(1)
254 StrPair const operator()(string const & snippet)
257 os << base_ << counter_++ << '.' << to_format_;
258 string const file = STRCONV(os.str());
260 return make_pair(snippet, file);
264 string const & to_format_;
265 string const & base_;
270 InProgress::InProgress(string const & filename_base,
271 PendingSnippets const & pending,
272 string const & to_format)
274 metrics_file(filename_base + ".metrics"),
275 snippets(pending.size())
277 PendingSnippets::const_iterator pit = pending.begin();
278 PendingSnippets::const_iterator pend = pending.end();
279 BitmapFile::iterator sit = snippets.begin();
281 std::transform(pit, pend, sit,
282 IncrementedFileName(to_format, filename_base));
286 void InProgress::stop() const
289 support::ForkedcallsController::get().kill(pid, 0);
291 if (!metrics_file.empty())
292 support::unlink(metrics_file);
294 BitmapFile::const_iterator vit = snippets.begin();
295 BitmapFile::const_iterator vend = snippets.end();
296 for (; vit != vend; ++vit) {
297 if (!vit->second.empty())
298 support::unlink(vit->second);
308 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
309 : parent_(p), buffer_(b), font_scaling_factor_(0.0)
311 font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
312 lyxrc.preview_scale_factor;
314 lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
315 << font_scaling_factor_ << endl;
318 pconverter_ = setConverter();
322 PreviewLoader::Impl::~Impl()
324 InProgressProcesses::iterator ipit = in_progress_.begin();
325 InProgressProcesses::iterator ipend = in_progress_.end();
327 for (; ipit != ipend; ++ipit) {
334 PreviewLoader::Impl::preview(string const & latex_snippet) const
336 Cache::const_iterator it = cache_.find(latex_snippet);
337 return (it == cache_.end()) ? 0 : it->second.get();
344 FindSnippet(string const & s) : snippet_(s) {}
345 bool operator()(InProgressProcess const & process)
347 BitmapFile const & snippets = process.second.snippets;
348 BitmapFile::const_iterator it = snippets.begin();
349 BitmapFile::const_iterator end = snippets.end();
350 it = find_if(it, end, FindFirst(snippet_));
355 string const & snippet_;
360 PreviewLoader::Status
361 PreviewLoader::Impl::status(string const & latex_snippet) const
363 Cache::const_iterator cit = cache_.find(latex_snippet);
364 if (cit != cache_.end())
367 PendingSnippets::const_iterator pit = pending_.begin();
368 PendingSnippets::const_iterator pend = pending_.end();
370 pit = find(pit, pend, latex_snippet);
374 InProgressProcesses::const_iterator ipit = in_progress_.begin();
375 InProgressProcesses::const_iterator ipend = in_progress_.end();
377 ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
385 void PreviewLoader::Impl::add(string const & latex_snippet)
387 if (!pconverter_ || status(latex_snippet) != NotFound)
390 string const snippet = support::trim(latex_snippet);
394 lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
396 pending_.push_back(snippet);
402 struct EraseSnippet {
403 EraseSnippet(string const & s) : snippet_(s) {}
404 void operator()(InProgressProcess & process)
406 BitmapFile & snippets = process.second.snippets;
407 BitmapFile::iterator it = snippets.begin();
408 BitmapFile::iterator end = snippets.end();
410 it = find_if(it, end, FindFirst(snippet_));
412 snippets.erase(it, it+1);
416 string const & snippet_;
422 void PreviewLoader::Impl::remove(string const & latex_snippet)
424 Cache::iterator cit = cache_.find(latex_snippet);
425 if (cit != cache_.end())
428 PendingSnippets::iterator pit = pending_.begin();
429 PendingSnippets::iterator pend = pending_.end();
431 pending_.erase(std::remove(pit, pend, latex_snippet), pend);
433 InProgressProcesses::iterator ipit = in_progress_.begin();
434 InProgressProcesses::iterator ipend = in_progress_.end();
436 std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
438 while (ipit != ipend) {
439 InProgressProcesses::iterator curr = ipit++;
440 if (curr->second.snippets.empty())
441 in_progress_.erase(curr);
446 void PreviewLoader::Impl::startLoading()
448 if (pending_.empty() || !pconverter_)
451 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
453 // As used by the LaTeX file and by the resulting image files
454 string directory = buffer_.temppath();
455 if (directory.empty())
456 directory = buffer_.filePath();
458 string const filename_base(unique_filename(directory));
460 // Create an InProgress instance to place in the map of all
461 // such processes if it starts correctly.
462 InProgress inprogress(filename_base, pending_, pconverter_->to);
464 // clear pending_, so we're ready to start afresh.
467 // Output the LaTeX file.
468 string const latexfile = filename_base + ".tex";
470 ofstream of(latexfile.c_str());
471 of << "\\batchmode\n";
473 of << "\n\\begin{document}\n";
474 dumpData(of, inprogress.snippets);
475 of << "\n\\end{document}\n";
478 // The conversion command.
480 cs << pconverter_->command << ' ' << latexfile << ' '
481 << int(font_scaling_factor_) << ' ' << pconverter_->to;
483 string const command = "sh " + support::LibScriptSearch(STRCONV(cs.str()));
485 // Initiate the conversion from LaTeX to bitmap images files.
486 support::Forkedcall::SignalTypePtr
487 convert_ptr(new support::Forkedcall::SignalType);
488 convert_ptr->connect(
489 boost::bind(&Impl::finishedGenerating, this, _1, _2));
491 support::Forkedcall call;
492 int ret = call.startscript(command, convert_ptr);
495 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
496 << "Unable to start process \n"
501 // Store the generation process in a list of all such processes
502 inprogress.pid = call.pid();
503 inprogress.command = command;
504 in_progress_[inprogress.pid] = inprogress;
508 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
511 InProgressProcesses::iterator git = in_progress_.find(pid);
512 if (git == in_progress_.end()) {
513 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
514 "data for PID " << pid << endl;
518 string const command = git->second.command;
519 string const status = retval > 0 ? "failed" : "succeeded";
520 lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
521 << retval << "): processing " << status
522 << " for " << command << endl;
526 // Read the metrics file, if it exists
527 vector<double> ascent_fractions(git->second.snippets.size());
528 setAscentFractions(ascent_fractions, git->second.metrics_file);
530 // Add these newly generated bitmap files to the cache and
531 // start loading them into LyX.
532 BitmapFile::const_iterator it = git->second.snippets.begin();
533 BitmapFile::const_iterator end = git->second.snippets.end();
535 std::list<PreviewImagePtr> newimages;
537 int metrics_counter = 0;
538 for (; it != end; ++it, ++metrics_counter) {
539 string const & snip = it->first;
540 string const & file = it->second;
541 double af = ascent_fractions[metrics_counter];
543 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
546 newimages.push_back(ptr);
549 // Remove the item from the list of still-executing processes.
550 in_progress_.erase(git);
552 // Tell the outside world
553 std::list<PreviewImagePtr>::const_reverse_iterator
554 nit = newimages.rbegin();
555 std::list<PreviewImagePtr>::const_reverse_iterator
556 nend = newimages.rend();
557 for (; nit != nend; ++nit) {
558 imageReady(*nit->get());
563 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
565 // Why on earth is Buffer::makeLaTeXFile a non-const method?
566 Buffer & tmp = const_cast<Buffer &>(buffer_);
567 // Dump the preamble only.
568 LatexRunParams runparams;
569 runparams.flavor = LatexRunParams::LATEX;
570 runparams.nice = true;
571 runparams.moving_arg = true;
572 runparams.free_spacing = true;
573 tmp.makeLaTeXFile(os, buffer_.filePath(), runparams, true, false);
575 // FIXME! This is a HACK! The proper fix is to control the 'true'
576 // passed to WriteStream below:
577 // int InsetFormula::latex(Buffer const &, ostream & os,
578 // LatexRunParams const & runparams) const
580 // WriteStream wi(os, runparams.moving_arg, true);
585 << "\\def\\lyxlock{}\n"
588 // Loop over the insets in the buffer and dump all the math-macros.
589 Buffer::inset_iterator it = buffer_.inset_const_iterator_begin();
590 Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
592 for (; it != end; ++it)
593 if (it->lyxCode() == InsetOld::MATHMACRO_CODE)
594 it->latex(buffer_, os, runparams);
596 // All equation lables appear as "(#)" + preview.sty's rendering of
598 if (lyxrc.preview_hashed_labels)
599 os << "\\renewcommand{\\theequation}{\\#}\n";
601 // Use the preview style file to ensure that each snippet appears on a
604 << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
607 // This piece of PostScript magic ensures that the foreground and
608 // background colors are the same as the LyX screen.
609 string fg = lyx_gui::hexname(LColor::preview);
610 if (fg.empty()) fg = "000000";
612 string bg = lyx_gui::hexname(LColor::background);
613 if (bg.empty()) bg = "ffffff";
615 os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
616 << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
617 << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
618 << "clippath fill setrgbcolor}bind def end}}}\n";
622 void PreviewLoader::Impl::dumpData(ostream & os,
623 BitmapFile const & vec) const
628 BitmapFile::const_iterator it = vec.begin();
629 BitmapFile::const_iterator end = vec.end();
631 for (; it != end; ++it) {
632 os << "\\begin{preview}\n"
634 << "\n\\end{preview}\n\n";
638 } // namespace graphics
643 string const unique_filename(string const bufferpath)
645 static int theCounter = 0;
646 string const filename = tostr(theCounter++) + "lyxpreview";
647 return support::AddName(bufferpath, filename);
651 Converter const * setConverter()
653 string const from = "lyxpreview";
655 Formats::FormatList::const_iterator it = formats.begin();
656 Formats::FormatList::const_iterator end = formats.end();
658 for (; it != end; ++it) {
659 string const to = it->name();
663 Converter const * ptr = converters.getConverter(from, to);
668 static bool first = true;
671 lyxerr << "PreviewLoader::startLoading()\n"
672 << "No converter from \"lyxpreview\" format has been "
681 void setAscentFractions(vector<double> & ascent_fractions,
682 string const & metrics_file)
684 // If all else fails, then the images will have equal ascents and
686 vector<double>::iterator it = ascent_fractions.begin();
687 vector<double>::iterator end = ascent_fractions.end();
690 ifstream in(metrics_file.c_str());
692 lyxerr[Debug::GRAPHICS]
693 << "setAscentFractions(" << metrics_file << ")\n"
694 << "Unable to open file!" << endl;
700 // Tightpage dimensions affect all subsequent dimensions
704 int snippet_counter = 0;
706 // Expecting lines of the form
707 // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
708 // Preview: Snippet id ascent descent width
711 in >> preview >> type;
717 error = preview != "Preview:"
718 || (type != "Tightpage" && type != "Snippet");
722 if (type == "Tightpage") {
724 in >> dummy >> tp_descent >> dummy >> tp_ascent;
735 in >> snippet_id >> ascent >> descent >> dummy;
737 error = !in.good() || ++snippet_counter != snippet_id;
741 double const a = ascent + tp_ascent;
742 double const d = descent - tp_descent;
744 if (!support::float_equal(a + d, 0, 0.1))
753 lyxerr[Debug::GRAPHICS]
754 << "setAscentFractions(" << metrics_file << ")\n"
755 << "Error reading file!\n" << endl;