src/graphics/PreviewLoader.C

   1 /**
   2  *  \file PreviewLoader.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 #include <config.h>
  12
  13 #ifdef __GNUG__
  14 #pragma implementation
  15 #endif
  16
  17 #include "PreviewLoader.h"
  18 #include "PreviewImage.h"
  19
  20 #include "buffer.h"
  21 #include "converter.h"
  22 #include "debug.h"
  23 #include "lyxrc.h"
  24 #include "LColor.h"
  25
  26 #include "insets/inset.h"
  27
  28 #include "frontends/lyx_gui.h" // hexname
  29
  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"
  35
  36 #include <boost/bind.hpp>
  37 #include <boost/signals/trackable.hpp>
  38
  39 #include <fstream>
  40 #include <iomanip>
  41 #include <list>
  42 #include <map>
  43 #include <utility>
  44 #include <vector>
  45
  46 using std::endl;
  47 using std::find;
  48 using std::fill;
  49 using std::find_if;
  50 using std::getline;
  51 using std::make_pair;
  52 using std::setfill;
  53 using std::setw;
  54
  55 using std::list;
  56 using std::map;
  57 using std::ifstream;
  58 using std::ofstream;
  59 using std::ostream;
  60 using std::pair;
  61 using std::vector;
  62
  63 namespace {
  64
  65 typedef pair<string, string> StrPair;
  66
  67 // A list of alll snippets to be converted to previews
  68 typedef list<string> PendingSnippets;
  69
  70 // Each item in the vector is a pair<snippet, image file name>.
  71 typedef vector<StrPair> BitmapFile;
  72
  73 string const unique_filename(string const bufferpath);
  74
  75 Converter const * setConverter();
  76
  77 void setAscentFractions(vector<double> & ascent_fractions,
  78                         string const & metrics_file);
  79
  80 struct FindFirst {
  81         FindFirst(string const & comp) : comp_(comp) {}
  82         bool operator()(StrPair const & sp)
  83         {
  84                 return sp.first < comp_;
  85         }
  86 private:
  87         string const comp_;
  88 };
  89
  90
  91 /// Store info on a currently executing, forked process.
  92 struct InProgress {
  93         ///
  94         InProgress() : pid(0) {}
  95         ///
  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.
 100         void stop() const;
 101
 102         ///
 103         pid_t pid;
 104         ///
 105         string metrics_file;
 106         ///
 107         BitmapFile snippets;
 108 };
 109
 110 typedef map<string, InProgress>  InProgressProcesses;
 111
 112 typedef InProgressProcesses::value_type InProgressProcess;
 113
 114 } // namespace anon
 115
 116
 117 namespace grfx {
 118
 119 struct PreviewLoader::Impl : public boost::signals::trackable {
 120         ///
 121         Impl(PreviewLoader & p, Buffer const & b);
 122         /// Stop any InProgress items still executing.
 123         ~Impl();
 124         ///
 125         PreviewImage const * preview(string const & latex_snippet) const;
 126         ///
 127         PreviewLoader::Status status(string const & latex_snippet) const;
 128         ///
 129         void add(string const & latex_snippet);
 130         ///
 131         void remove(string const & latex_snippet);
 132         ///
 133         void startLoading();
 134
 135         /// Emit this signal when an image is ready for display.
 136         boost::signal1<void, PreviewImage const &> imageReady;
 137
 138         Buffer const & buffer() const { return buffer_; }
 139
 140 private:
 141         /// Called by the Forkedcall process that generated the bitmap files.
 142         void finishedGenerating(string const &, pid_t, int);
 143         ///
 144         void dumpPreamble(ostream &) const;
 145         ///
 146         void dumpData(ostream &, BitmapFile const &) const;
 147
 148         /** cache_ allows easy retrieval of already-generated images
 149          *  using the LaTeX snippet as the identifier.
 150          */
 151         typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
 152         ///
 153         typedef map<string, PreviewImagePtr> Cache;
 154         ///
 155         Cache cache_;
 156
 157         /** pending_ stores the LaTeX snippets in anticipation of them being
 158          *  sent to the converter.
 159          */
 160         PendingSnippets pending_;
 161
 162         /** in_progress_ stores all forked processes so that we can proceed
 163          *  thereafter.
 164             The map uses the conversion commands as its identifiers.
 165          */
 166         InProgressProcesses in_progress_;
 167
 168         ///
 169         PreviewLoader & parent_;
 170         ///
 171         Buffer const & buffer_;
 172         ///
 173         double font_scaling_factor_;
 174
 175         /// We don't own this
 176         static Converter const * pconverter_;
 177 };
 178
 179
 180 Converter const * PreviewLoader::Impl::pconverter_;
 181
 182
 183 // The public interface, defined in PreviewLoader.h
 184 // ================================================
 185 PreviewLoader::PreviewLoader(Buffer const & b)
 186         : pimpl_(new Impl(*this, b))
 187 {}
 188
 189
 190 PreviewLoader::~PreviewLoader()
 191 {}
 192
 193
 194 PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const
 195 {
 196         return pimpl_->preview(latex_snippet);
 197 }
 198
 199
 200 PreviewLoader::Status PreviewLoader::status(string const & latex_snippet) const
 201 {
 202         return pimpl_->status(latex_snippet);
 203 }
 204
 205
 206 void PreviewLoader::add(string const & latex_snippet) const
 207 {
 208         pimpl_->add(latex_snippet);
 209 }
 210
 211
 212 void PreviewLoader::remove(string const & latex_snippet) const
 213 {
 214         pimpl_->remove(latex_snippet);
 215 }
 216
 217
 218 void PreviewLoader::startLoading() const
 219 {
 220         pimpl_->startLoading();
 221 }
 222
 223
 224 boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
 225 {
 226         return pimpl_->imageReady.connect(slot);
 227 }
 228
 229
 230 void PreviewLoader::emitSignal(PreviewImage const & pimage) const
 231 {
 232         pimpl_->imageReady(pimage);
 233 }
 234
 235
 236 Buffer const & PreviewLoader::buffer() const
 237 {
 238         return pimpl_->buffer();
 239 }
 240
 241 } // namespace grfx
 242
 243
 244 // The details of the Impl
 245 // =======================
 246
 247 namespace {
 248
 249 struct IncrementedFileName {
 250         IncrementedFileName(string const & to_format,
 251                             string const & filename_base)
 252                 : to_format_(to_format), base_(filename_base), counter_(1)
 253         {}
 254
 255         StrPair const operator()(string const & snippet)
 256         {
 257                 ostringstream os;
 258                 os << base_ << counter_++ << "." << to_format_;
 259                 string const file = os.str().c_str();
 260
 261                 return make_pair(snippet, file);
 262         }
 263
 264 private:
 265         string const & to_format_;
 266         string const & base_;
 267         int counter_;
 268 };
 269
 270
 271 InProgress::InProgress(string const & filename_base,
 272                        PendingSnippets const & pending,
 273                        string const & to_format)
 274         : pid(0),
 275           metrics_file(filename_base + ".metrics"),
 276           snippets(pending.size())
 277 {
 278         PendingSnippets::const_iterator pit  = pending.begin();
 279         PendingSnippets::const_iterator pend = pending.end();
 280         BitmapFile::iterator sit = snippets.begin();
 281
 282         std::transform(pit, pend, sit,
 283                        IncrementedFileName(to_format, filename_base));
 284 }
 285
 286
 287 void InProgress::stop() const
 288 {
 289         if (pid)
 290                 ForkedcallsController::get().kill(pid, 0);
 291
 292         if (!metrics_file.empty())
 293                 lyx::unlink(metrics_file);
 294
 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);
 300         }
 301 }
 302
 303 } // namespace anon
 304
 305
 306 namespace grfx {
 307
 308 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
 309         : parent_(p), buffer_(b), font_scaling_factor_(0.0)
 310 {
 311         font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
 312                 lyxrc.preview_scale_factor;
 313
 314         lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
 315                                 << font_scaling_factor_ << endl;
 316
 317         if (!pconverter_)
 318                 pconverter_ = setConverter();
 319 }
 320
 321
 322 PreviewLoader::Impl::~Impl()
 323 {
 324         InProgressProcesses::iterator ipit  = in_progress_.begin();
 325         InProgressProcesses::iterator ipend = in_progress_.end();
 326
 327         for (; ipit != ipend; ++ipit) {
 328                 ipit->second.stop();
 329         }
 330 }
 331
 332
 333 PreviewImage const *
 334 PreviewLoader::Impl::preview(string const & latex_snippet) const
 335 {
 336         Cache::const_iterator it = cache_.find(latex_snippet);
 337         return (it == cache_.end()) ? 0 : it->second.get();
 338 }
 339
 340
 341 namespace {
 342
 343 struct FindSnippet {
 344         FindSnippet(string const & s) : snippet_(s) {}
 345         bool operator()(InProgressProcess const & process)
 346         {
 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_));
 351                 return it != end;
 352         }
 353
 354 private:
 355         string const & snippet_;
 356 };
 357
 358 } // namespace anon
 359
 360 PreviewLoader::Status
 361 PreviewLoader::Impl::status(string const & latex_snippet) const
 362 {
 363         Cache::const_iterator cit = cache_.find(latex_snippet);
 364         if (cit != cache_.end())
 365                 return Ready;
 366
 367         PendingSnippets::const_iterator pit  = pending_.begin();
 368         PendingSnippets::const_iterator pend = pending_.end();
 369
 370         pit = find(pit, pend, latex_snippet);
 371         if (pit != pend)
 372                 return InQueue;
 373
 374         InProgressProcesses::const_iterator ipit  = in_progress_.begin();
 375         InProgressProcesses::const_iterator ipend = in_progress_.end();
 376
 377         ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
 378         if (ipit != ipend)
 379                 return Processing;
 380
 381         return NotFound;
 382 }
 383
 384
 385 void PreviewLoader::Impl::add(string const & latex_snippet)
 386 {
 387         if (!pconverter_ || status(latex_snippet) != NotFound)
 388                 return;
 389
 390         string const snippet = trim(latex_snippet);
 391         if (snippet.empty())
 392                 return;
 393
 394         lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
 395
 396         pending_.push_back(snippet);
 397 }
 398
 399
 400 namespace {
 401
 402 struct EraseSnippet {
 403         EraseSnippet(string const & s) : snippet_(s) {}
 404         void operator()(InProgressProcess & process)
 405         {
 406                 BitmapFile & snippets = process.second.snippets;
 407                 BitmapFile::iterator it  = snippets.begin();
 408                 BitmapFile::iterator end = snippets.end();
 409
 410                 it = find_if(it, end, FindFirst(snippet_));
 411                 if (it != end)
 412                         snippets.erase(it, it+1);
 413         }
 414
 415 private:
 416         string const & snippet_;
 417 };
 418
 419 } // namespace anon
 420
 421
 422 void PreviewLoader::Impl::remove(string const & latex_snippet)
 423 {
 424         Cache::iterator cit = cache_.find(latex_snippet);
 425         if (cit != cache_.end())
 426                 cache_.erase(cit);
 427
 428         PendingSnippets::iterator pit  = pending_.begin();
 429         PendingSnippets::iterator pend = pending_.end();
 430
 431         pending_.erase(std::remove(pit, pend, latex_snippet), pend);
 432
 433         InProgressProcesses::iterator ipit  = in_progress_.begin();
 434         InProgressProcesses::iterator ipend = in_progress_.end();
 435
 436         std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
 437
 438         for (; ipit != ipend; ++ipit) {
 439                 InProgressProcesses::iterator curr = ipit++;
 440                 if (curr->second.snippets.empty())
 441                         in_progress_.erase(curr);
 442         }
 443 }
 444
 445
 446 void PreviewLoader::Impl::startLoading()
 447 {
 448         if (pending_.empty() || !pconverter_)
 449                 return;
 450
 451         lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
 452
 453         // As used by the LaTeX file and by the resulting image files
 454         string const filename_base(unique_filename(buffer_.tmppath));
 455
 456         // Create an InProgress instance to place in the map of all
 457         // such processes if it starts correctly.
 458         InProgress inprogress(filename_base, pending_, pconverter_->to);
 459
 460         // clear pending_, so we're ready to start afresh.
 461         pending_.clear();
 462
 463         // Output the LaTeX file.
 464         string const latexfile = filename_base + ".tex";
 465
 466         ofstream of(latexfile.c_str());
 467         of << "\\batchmode\n";
 468         dumpPreamble(of);
 469         of << "\n\\begin{document}\n";
 470         dumpData(of, inprogress.snippets);
 471         of << "\n\\end{document}\n";
 472         of.close();
 473
 474         // The conversion command.
 475         ostringstream cs;
 476         cs << pconverter_->command << " " << latexfile << " "
 477            << int(font_scaling_factor_) << " " << pconverter_->to;
 478
 479         string const command = "sh " + LibScriptSearch(cs.str().c_str());
 480
 481         // Initiate the conversion from LaTeX to bitmap images files.
 482         Forkedcall::SignalTypePtr convert_ptr;
 483         convert_ptr.reset(new Forkedcall::SignalType);
 484
 485         convert_ptr->connect(
 486                 boost::bind(&Impl::finishedGenerating, this, _1, _2, _3));
 487
 488         Forkedcall call;
 489         int ret = call.startscript(command, convert_ptr);
 490
 491         if (ret != 0) {
 492                 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
 493                                         << "Unable to start process \n"
 494                                         << command << endl;
 495                 return;
 496         }
 497
 498         // Store the generation process in a list of all such processes
 499         inprogress.pid = call.pid();
 500         in_progress_[command] = inprogress;
 501 }
 502
 503
 504 void PreviewLoader::Impl::finishedGenerating(string const & command,
 505                                              pid_t /* pid */, int retval)
 506 {
 507         string const status = retval > 0 ? "failed" : "succeeded";
 508         lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
 509                                 << retval << "): processing " << status
 510                                 << " for " << command << endl;
 511         if (retval > 0)
 512                 return;
 513
 514         // Paranoia check!
 515         InProgressProcesses::iterator git = in_progress_.find(command);
 516         if (git == in_progress_.end()) {
 517                 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
 518                         "data for\n"
 519                        << command << "!" << endl;
 520                 return;
 521         }
 522
 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);
 526
 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();
 531
 532         std::list<PreviewImagePtr> newimages;
 533
 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];
 539
 540                 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
 541                 cache_[snip] = ptr;
 542
 543                 newimages.push_back(ptr);
 544         }
 545
 546         // Remove the item from the list of still-executing processes.
 547         in_progress_.erase(git);
 548
 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());
 554         }
 555 }
 556
 557
 558 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
 559 {
 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);
 564
 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();
 568
 569         for (; it != end; ++it)
 570                 if (it->lyxCode() == Inset::MATHMACRO_CODE)
 571                         it->latex(&buffer_, os, true, true);
 572
 573         // All equation lables appear as "(#)" + preview.sty's rendering of
 574         // the label name
 575         if (lyxrc.preview_hashed_labels)
 576                 os << "\\renewcommand{\\theequation}{\\#}\n";
 577
 578         // Use the preview style file to ensure that each snippet appears on a
 579         // fresh page.
 580         os << "\n"
 581            << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
 582            << "\n";
 583
 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";
 588
 589         string bg = lyx_gui::hexname(LColor::background);
 590         if (bg.empty()) bg = "ffffff";
 591
 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";
 596 }
 597
 598
 599 void PreviewLoader::Impl::dumpData(ostream & os,
 600                                    BitmapFile const & vec) const
 601 {
 602         if (vec.empty())
 603                 return;
 604
 605         BitmapFile::const_iterator it  = vec.begin();
 606         BitmapFile::const_iterator end = vec.end();
 607
 608         for (; it != end; ++it) {
 609                 os << "\\begin{preview}\n"
 610                    << it->first
 611                    << "\n\\end{preview}\n\n";
 612         }
 613 }
 614
 615 } // namespace grfx
 616
 617
 618 namespace {
 619
 620 string const unique_filename(string const bufferpath)
 621 {
 622         static int theCounter = 0;
 623         string const filename = tostr(theCounter++) + "lyxpreview";
 624         return AddName(bufferpath, filename);
 625 }
 626
 627
 628 Converter const * setConverter()
 629 {
 630         string const from = "lyxpreview";
 631
 632         Formats::FormatList::const_iterator it  = formats.begin();
 633         Formats::FormatList::const_iterator end = formats.end();
 634
 635         for (; it != end; ++it) {
 636                 string const to = it->name();
 637                 if (from == to)
 638                         continue;
 639
 640                 Converter const * ptr = converters.getConverter(from, to);
 641                 if (ptr)
 642                         return ptr;
 643         }
 644
 645         static bool first = true;
 646         if (first) {
 647                 first = false;
 648                 lyxerr << "PreviewLoader::startLoading()\n"
 649                        << "No converter from \"lyxpreview\" format has been "
 650                         "defined."
 651                        << endl;
 652         }
 653
 654         return 0;
 655 }
 656
 657
 658 void setAscentFractions(vector<double> & ascent_fractions,
 659                         string const & metrics_file)
 660 {
 661         // If all else fails, then the images will have equal ascents and
 662         // descents.
 663         vector<double>::iterator it  = ascent_fractions.begin();
 664         vector<double>::iterator end = ascent_fractions.end();
 665         fill(it, end, 0.5);
 666
 667         ifstream in(metrics_file.c_str());
 668         if (!in.good()) {
 669                 lyxerr[Debug::GRAPHICS]
 670                         << "setAscentFractions(" << metrics_file << ")\n"
 671                         << "Unable to open file!" << endl;
 672                 return;
 673         }
 674
 675         bool error = false;
 676
 677         // Tightpage dimensions affect all subsequent dimensions
 678         int tp_ascent;
 679         int tp_descent;
 680
 681         int snippet_counter = 0;
 682         while (!in.eof()) {
 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
 686                 string preview;
 687                 string type;
 688                 in >> preview >> type;
 689
 690                 if (!in.good())
 691                         // eof after all
 692                         break;
 693
 694                 error = preview != "Preview:"
 695                         || (type != "Tightpage" && type != "Snippet");
 696                 if (error)
 697                         break;
 698
 699                 if (type == "Tightpage") {
 700                         int dummy;
 701                         in >> dummy >> tp_descent >> dummy >> tp_ascent;
 702
 703                         error = !in.good();
 704                         if (error)
 705                                 break;
 706
 707                 } else {
 708                         int dummy;
 709                         int snippet_id;
 710                         int ascent;
 711                         int descent;
 712                         in >> snippet_id >> ascent >> descent >> dummy;
 713
 714                         error = !in.good() || ++snippet_counter != snippet_id;
 715                         if (error)
 716                                 break;
 717
 718                         double const a = ascent + tp_ascent;
 719                         double const d = descent - tp_descent;
 720
 721                         if (!lyx::float_equal(a + d, 0, 0.1))
 722                                 *it = a / (a + d);
 723
 724                         if (++it == end)
 725                                 break;
 726                 }
 727         }
 728
 729         if (error) {
 730                 lyxerr[Debug::GRAPHICS]
 731                         << "setAscentFractions(" << metrics_file << ")\n"
 732                         << "Error reading file!\n" << endl;
 733         }
 734 }
 735
 736 } // namespace anon