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"
24 #include "insets/inset.h"
26 #include "frontends/lyx_gui.h" // hexname
28 #include "support/filetools.h"
29 #include "support/forkedcall.h"
30 #include "support/forkedcontr.h"
31 #include "support/lstrings.h"
32 #include "support/lyxlib.h"
34 #include <boost/bind.hpp>
35 #include <boost/signals/trackable.hpp>
63 typedef pair<string, string> StrPair;
65 // A list of alll snippets to be converted to previews
66 typedef list<string> PendingSnippets;
68 // Each item in the vector is a pair<snippet, image file name>.
69 typedef vector<StrPair> BitmapFile;
71 string const unique_filename(string const bufferpath);
73 Converter const * setConverter();
75 void setAscentFractions(vector<double> & ascent_fractions,
76 string const & metrics_file);
79 FindFirst(string const & comp) : comp_(comp) {}
80 bool operator()(StrPair const & sp)
82 return sp.first == comp_;
89 /// Store info on a currently executing, forked process.
92 InProgress() : pid(0) {}
94 InProgress(string const & filename_base,
95 PendingSnippets const & pending,
96 string const & to_format);
97 /// Remove any files left lying around and kill the forked process.
110 typedef map<pid_t, InProgress> InProgressProcesses;
112 typedef InProgressProcesses::value_type InProgressProcess;
119 struct PreviewLoader::Impl : public boost::signals::trackable {
121 Impl(PreviewLoader & p, Buffer const & b);
122 /// Stop any InProgress items still executing.
125 PreviewImage const * preview(string const & latex_snippet) const;
127 PreviewLoader::Status status(string const & latex_snippet) const;
129 void add(string const & latex_snippet);
131 void remove(string const & latex_snippet);
135 /// Emit this signal when an image is ready for display.
136 boost::signal1<void, PreviewImage const &> imageReady;
138 Buffer const & buffer() const { return buffer_; }
141 /// Called by the Forkedcall process that generated the bitmap files.
142 void finishedGenerating(pid_t, int);
144 void dumpPreamble(ostream &) const;
146 void dumpData(ostream &, BitmapFile const &) const;
148 /** cache_ allows easy retrieval of already-generated images
149 * using the LaTeX snippet as the identifier.
151 typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
153 typedef map<string, PreviewImagePtr> Cache;
157 /** pending_ stores the LaTeX snippets in anticipation of them being
158 * sent to the converter.
160 PendingSnippets pending_;
162 /** in_progress_ stores all forked processes so that we can proceed
164 The map uses the conversion commands as its identifiers.
166 InProgressProcesses in_progress_;
169 PreviewLoader & parent_;
171 Buffer const & buffer_;
173 double font_scaling_factor_;
175 /// We don't own this
176 static Converter const * pconverter_;
180 Converter const * PreviewLoader::Impl::pconverter_;
183 // The public interface, defined in PreviewLoader.h
184 // ================================================
185 PreviewLoader::PreviewLoader(Buffer const & b)
186 : pimpl_(new Impl(*this, b))
190 PreviewLoader::~PreviewLoader()
194 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
196 return pimpl_->preview(latex_snippet);
200 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
202 return pimpl_->status(latex_snippet);
206 void PreviewLoader::add(string const & latex_snippet) const
208 pimpl_->add(latex_snippet);
212 void PreviewLoader::remove(string const & latex_snippet) const
214 pimpl_->remove(latex_snippet);
218 void PreviewLoader::startLoading() const
220 pimpl_->startLoading();
224 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
226 return pimpl_->imageReady.connect(slot);
230 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
232 pimpl_->imageReady(pimage);
236 Buffer const & PreviewLoader::buffer() const
238 return pimpl_->buffer();
244 // The details of the Impl
245 // =======================
249 struct IncrementedFileName {
250 IncrementedFileName(string const & to_format,
251 string const & filename_base)
252 : to_format_(to_format), base_(filename_base), counter_(1)
255 StrPair const operator()(string const & snippet)
258 os << base_ << counter_++ << '.' << to_format_;
259 string const file = STRCONV(os.str());
261 return make_pair(snippet, file);
265 string const & to_format_;
266 string const & base_;
271 InProgress::InProgress(string const & filename_base,
272 PendingSnippets const & pending,
273 string const & to_format)
275 metrics_file(filename_base + ".metrics"),
276 snippets(pending.size())
278 PendingSnippets::const_iterator pit = pending.begin();
279 PendingSnippets::const_iterator pend = pending.end();
280 BitmapFile::iterator sit = snippets.begin();
282 std::transform(pit, pend, sit,
283 IncrementedFileName(to_format, filename_base));
287 void InProgress::stop() const
290 ForkedcallsController::get().kill(pid, 0);
292 if (!metrics_file.empty())
293 lyx::unlink(metrics_file);
295 BitmapFile::const_iterator vit = snippets.begin();
296 BitmapFile::const_iterator vend = snippets.end();
297 for (; vit != vend; ++vit) {
298 if (!vit->second.empty())
299 lyx::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 = 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 for (; ipit != ipend; ++ipit) {
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_.tmppath;
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 " + LibScriptSearch(STRCONV(cs.str()));
485 // Initiate the conversion from LaTeX to bitmap images files.
486 Forkedcall::SignalTypePtr convert_ptr(new Forkedcall::SignalType);
487 convert_ptr->connect(
488 boost::bind(&Impl::finishedGenerating, this, _1, _2));
491 int ret = call.startscript(command, convert_ptr);
494 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
495 << "Unable to start process \n"
500 // Store the generation process in a list of all such processes
501 inprogress.pid = call.pid();
502 inprogress.command = command;
503 in_progress_[inprogress.pid] = inprogress;
507 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
510 InProgressProcesses::iterator git = in_progress_.find(pid);
511 if (git == in_progress_.end()) {
512 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
513 "data for PID " << pid << endl;
517 string const command = git->second.command;
518 string const status = retval > 0 ? "failed" : "succeeded";
519 lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
520 << retval << "): processing " << status
521 << " for " << command << endl;
525 // Read the metrics file, if it exists
526 vector<double> ascent_fractions(git->second.snippets.size());
527 setAscentFractions(ascent_fractions, git->second.metrics_file);
529 // Add these newly generated bitmap files to the cache and
530 // start loading them into LyX.
531 BitmapFile::const_iterator it = git->second.snippets.begin();
532 BitmapFile::const_iterator end = git->second.snippets.end();
534 std::list<PreviewImagePtr> newimages;
536 int metrics_counter = 0;
537 for (; it != end; ++it, ++metrics_counter) {
538 string const & snip = it->first;
539 string const & file = it->second;
540 double af = ascent_fractions[metrics_counter];
542 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
545 newimages.push_back(ptr);
548 // Remove the item from the list of still-executing processes.
549 in_progress_.erase(git);
551 // Tell the outside world
552 std::list<PreviewImagePtr>::const_reverse_iterator
553 nit = newimages.rbegin();
554 std::list<PreviewImagePtr>::const_reverse_iterator
555 nend = newimages.rend();
556 for (; nit != nend; ++nit) {
557 imageReady(*nit->get());
562 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
564 // Why on earth is Buffer::makeLaTeXFile a non-const method?
565 Buffer & tmp = const_cast<Buffer &>(buffer_);
566 // Dump the preamble only.
567 tmp.makeLaTeXFile(os, buffer_.filePath(), true, false, true);
569 // FIXME! This is a HACK! The proper fix is to control the 'true'
570 // passed to WriteStream below:
571 // int InsetFormula::latex(Buffer const *, ostream & os,
572 // bool fragile, bool) const
574 // WriteStream wi(os, fragile, true);
579 << "\\def\\lyxlock{}\n"
582 // Loop over the insets in the buffer and dump all the math-macros.
583 Buffer::inset_iterator it = buffer_.inset_const_iterator_begin();
584 Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
586 for (; it != end; ++it)
587 if (it->lyxCode() == Inset::MATHMACRO_CODE)
588 it->latex(&buffer_, os, true, true);
590 // All equation lables appear as "(#)" + preview.sty's rendering of
592 if (lyxrc.preview_hashed_labels)
593 os << "\\renewcommand{\\theequation}{\\#}\n";
595 // Use the preview style file to ensure that each snippet appears on a
598 << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
601 // This piece of PostScript magic ensures that the foreground and
602 // background colors are the same as the LyX screen.
603 string fg = lyx_gui::hexname(LColor::preview);
604 if (fg.empty()) fg = "000000";
606 string bg = lyx_gui::hexname(LColor::background);
607 if (bg.empty()) bg = "ffffff";
609 os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
610 << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
611 << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
612 << "clippath fill setrgbcolor}bind def end}}}\n";
616 void PreviewLoader::Impl::dumpData(ostream & os,
617 BitmapFile const & vec) const
622 BitmapFile::const_iterator it = vec.begin();
623 BitmapFile::const_iterator end = vec.end();
625 for (; it != end; ++it) {
626 os << "\\begin{preview}\n"
628 << "\n\\end{preview}\n\n";
637 string const unique_filename(string const bufferpath)
639 static int theCounter = 0;
640 string const filename = tostr(theCounter++) + "lyxpreview";
641 return AddName(bufferpath, filename);
645 Converter const * setConverter()
647 string const from = "lyxpreview";
649 Formats::FormatList::const_iterator it = formats.begin();
650 Formats::FormatList::const_iterator end = formats.end();
652 for (; it != end; ++it) {
653 string const to = it->name();
657 Converter const * ptr = converters.getConverter(from, to);
662 static bool first = true;
665 lyxerr << "PreviewLoader::startLoading()\n"
666 << "No converter from \"lyxpreview\" format has been "
675 void setAscentFractions(vector<double> & ascent_fractions,
676 string const & metrics_file)
678 // If all else fails, then the images will have equal ascents and
680 vector<double>::iterator it = ascent_fractions.begin();
681 vector<double>::iterator end = ascent_fractions.end();
684 ifstream in(metrics_file.c_str());
686 lyxerr[Debug::GRAPHICS]
687 << "setAscentFractions(" << metrics_file << ")\n"
688 << "Unable to open file!" << endl;
694 // Tightpage dimensions affect all subsequent dimensions
698 int snippet_counter = 0;
700 // Expecting lines of the form
701 // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
702 // Preview: Snippet id ascent descent width
705 in >> preview >> type;
711 error = preview != "Preview:"
712 || (type != "Tightpage" && type != "Snippet");
716 if (type == "Tightpage") {
718 in >> dummy >> tp_descent >> dummy >> tp_ascent;
729 in >> snippet_id >> ascent >> descent >> dummy;
731 error = !in.good() || ++snippet_counter != snippet_id;
735 double const a = ascent + tp_ascent;
736 double const d = descent - tp_descent;
738 if (!lyx::float_equal(a + d, 0, 0.1))
747 lyxerr[Debug::GRAPHICS]
748 << "setAscentFractions(" << metrics_file << ")\n"
749 << "Error reading file!\n" << endl;