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