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 "debug.h"
  19 #include "format.h"
  20 #include "latexrunparams.h"
  21 #include "LColor.h"
  22 #include "lyxrc.h"
  23
  24 #include "frontends/lyx_gui.h" // hexname
  25
  26 #include "insets/inset.h"
  27
  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"
  33 #include "support/tostr.h"
  34
  35 #include <boost/bind.hpp>
  36
  37 #include "support/std_sstream.h"
  38 #include <fstream>
  39 #include <iomanip>
  40
  41 namespace support = lyx::support;
  42
  43 using std::endl;
  44 using std::find;
  45 using std::fill;
  46 using std::find_if;
  47 using std::make_pair;
  48
  49 using std::ifstream;
  50 using std::list;
  51 using std::map;
  52 using std::ofstream;
  53 using std::ostream;
  54 using std::ostringstream;
  55 using std::pair;
  56 using std::vector;
  57 using std::string;
  58
  59
  60 namespace {
  61
  62 typedef pair<string, string> StrPair;
  63
  64 // A list of alll snippets to be converted to previews
  65 typedef list<string> PendingSnippets;
  66
  67 // Each item in the vector is a pair<snippet, image file name>.
  68 typedef vector<StrPair> BitmapFile;
  69
  70 string const unique_filename(string const bufferpath);
  71
  72 Converter const * setConverter();
  73
  74 void setAscentFractions(vector<double> & ascent_fractions,
  75                         string const & metrics_file);
  76
  77 struct FindFirst {
  78         FindFirst(string const & comp) : comp_(comp) {}
  79         bool operator()(StrPair const & sp)
  80         {
  81                 return sp.first == comp_;
  82         }
  83 private:
  84         string const comp_;
  85 };
  86
  87
  88 /// Store info on a currently executing, forked process.
  89 struct InProgress {
  90         ///
  91         InProgress() : pid(0) {}
  92         ///
  93         InProgress(string const & filename_base,
  94                    PendingSnippets const & pending,
  95                    string const & to_format);
  96         /// Remove any files left lying around and kill the forked process.
  97         void stop() const;
  98
  99         ///
 100         pid_t pid;
 101         ///
 102         string command;
 103         ///
 104         string metrics_file;
 105         ///
 106         BitmapFile snippets;
 107 };
 108
 109 typedef map<pid_t, InProgress>  InProgressProcesses;
 110
 111 typedef InProgressProcesses::value_type InProgressProcess;
 112
 113 } // namespace anon
 114
 115
 116 namespace lyx {
 117 namespace graphics {
 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(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 graphics
 242 } // namespace lyx
 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 = 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                 support::ForkedcallsController::get().kill(pid, 0);
 292
 293         if (!metrics_file.empty())
 294                 support::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                         support::unlink(vit->second);
 301         }
 302 }
 303
 304 } // namespace anon
 305
 306
 307 namespace lyx {
 308 namespace graphics {
 309
 310 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
 311         : parent_(p), buffer_(b), font_scaling_factor_(0.0)
 312 {
 313         font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
 314                 lyxrc.preview_scale_factor;
 315
 316         lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
 317                                 << font_scaling_factor_ << endl;
 318
 319         if (!pconverter_)
 320                 pconverter_ = setConverter();
 321 }
 322
 323
 324 PreviewLoader::Impl::~Impl()
 325 {
 326         InProgressProcesses::iterator ipit  = in_progress_.begin();
 327         InProgressProcesses::iterator ipend = in_progress_.end();
 328
 329         for (; ipit != ipend; ++ipit) {
 330                 ipit->second.stop();
 331         }
 332 }
 333
 334
 335 PreviewImage const *
 336 PreviewLoader::Impl::preview(string const & latex_snippet) const
 337 {
 338         Cache::const_iterator it = cache_.find(latex_snippet);
 339         return (it == cache_.end()) ? 0 : it->second.get();
 340 }
 341
 342
 343 namespace {
 344
 345 struct FindSnippet {
 346         FindSnippet(string const & s) : snippet_(s) {}
 347         bool operator()(InProgressProcess const & process)
 348         {
 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_));
 353                 return it != end;
 354         }
 355
 356 private:
 357         string const & snippet_;
 358 };
 359
 360 } // namespace anon
 361
 362 PreviewLoader::Status
 363 PreviewLoader::Impl::status(string const & latex_snippet) const
 364 {
 365         Cache::const_iterator cit = cache_.find(latex_snippet);
 366         if (cit != cache_.end())
 367                 return Ready;
 368
 369         PendingSnippets::const_iterator pit  = pending_.begin();
 370         PendingSnippets::const_iterator pend = pending_.end();
 371
 372         pit = find(pit, pend, latex_snippet);
 373         if (pit != pend)
 374                 return InQueue;
 375
 376         InProgressProcesses::const_iterator ipit  = in_progress_.begin();
 377         InProgressProcesses::const_iterator ipend = in_progress_.end();
 378
 379         ipit = find_if(ipit, ipend, FindSnippet(latex_snippet));
 380         if (ipit != ipend)
 381                 return Processing;
 382
 383         return NotFound;
 384 }
 385
 386
 387 void PreviewLoader::Impl::add(string const & latex_snippet)
 388 {
 389         if (!pconverter_ || status(latex_snippet) != NotFound)
 390                 return;
 391
 392         string const snippet = support::trim(latex_snippet);
 393         if (snippet.empty())
 394                 return;
 395
 396         lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
 397
 398         pending_.push_back(snippet);
 399 }
 400
 401
 402 namespace {
 403
 404 struct EraseSnippet {
 405         EraseSnippet(string const & s) : snippet_(s) {}
 406         void operator()(InProgressProcess & process)
 407         {
 408                 BitmapFile & snippets = process.second.snippets;
 409                 BitmapFile::iterator it  = snippets.begin();
 410                 BitmapFile::iterator end = snippets.end();
 411
 412                 it = find_if(it, end, FindFirst(snippet_));
 413                 if (it != end)
 414                         snippets.erase(it, it+1);
 415         }
 416
 417 private:
 418         string const & snippet_;
 419 };
 420
 421 } // namespace anon
 422
 423
 424 void PreviewLoader::Impl::remove(string const & latex_snippet)
 425 {
 426         Cache::iterator cit = cache_.find(latex_snippet);
 427         if (cit != cache_.end())
 428                 cache_.erase(cit);
 429
 430         PendingSnippets::iterator pit  = pending_.begin();
 431         PendingSnippets::iterator pend = pending_.end();
 432
 433         pending_.erase(std::remove(pit, pend, latex_snippet), pend);
 434
 435         InProgressProcesses::iterator ipit  = in_progress_.begin();
 436         InProgressProcesses::iterator ipend = in_progress_.end();
 437
 438         std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
 439
 440         while (ipit != ipend) {
 441                 InProgressProcesses::iterator curr = ipit++;
 442                 if (curr->second.snippets.empty())
 443                         in_progress_.erase(curr);
 444         }
 445 }
 446
 447
 448 void PreviewLoader::Impl::startLoading()
 449 {
 450         if (pending_.empty() || !pconverter_)
 451                 return;
 452
 453         // Only start the process off after the buffer is loaded from file.
 454         if (!buffer_.fully_loaded())
 455                 return;
 456
 457         lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
 458
 459         // As used by the LaTeX file and by the resulting image files
 460         string const directory = buffer_.temppath().empty() ?
 461                 buffer_.filePath() : buffer_.temppath();
 462
 463         string const filename_base(unique_filename(directory));
 464
 465         // Create an InProgress instance to place in the map of all
 466         // such processes if it starts correctly.
 467         InProgress inprogress(filename_base, pending_, pconverter_->to);
 468
 469         // clear pending_, so we're ready to start afresh.
 470         pending_.clear();
 471
 472         // Output the LaTeX file.
 473         string const latexfile = filename_base + ".tex";
 474
 475         ofstream of(latexfile.c_str());
 476         of << "\\batchmode\n";
 477         dumpPreamble(of);
 478         of << "\n\\begin{document}\n";
 479         dumpData(of, inprogress.snippets);
 480         of << "\n\\end{document}\n";
 481         of.close();
 482
 483         // The conversion command.
 484         ostringstream cs;
 485         cs << pconverter_->command << ' ' << latexfile << ' '
 486            << int(font_scaling_factor_) << ' ' << pconverter_->to;
 487
 488         string const command = "sh " + support::LibScriptSearch(cs.str());
 489
 490         // Initiate the conversion from LaTeX to bitmap images files.
 491         support::Forkedcall::SignalTypePtr
 492                 convert_ptr(new support::Forkedcall::SignalType);
 493         convert_ptr->connect(
 494                 boost::bind(&Impl::finishedGenerating, this, _1, _2));
 495
 496         support::Forkedcall call;
 497         int ret = call.startscript(command, convert_ptr);
 498
 499         if (ret != 0) {
 500                 lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
 501                                         << "Unable to start process \n"
 502                                         << command << endl;
 503                 return;
 504         }
 505
 506         // Store the generation process in a list of all such processes
 507         inprogress.pid = call.pid();
 508         inprogress.command = command;
 509         in_progress_[inprogress.pid] = inprogress;
 510 }
 511
 512
 513 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
 514 {
 515         // Paranoia check!
 516         InProgressProcesses::iterator git = in_progress_.find(pid);
 517         if (git == in_progress_.end()) {
 518                 lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
 519                         "data for PID " << pid << endl;
 520                 return;
 521         }
 522
 523         string const command = git->second.command;
 524         string const status = retval > 0 ? "failed" : "succeeded";
 525         lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
 526                                 << retval << "): processing " << status
 527                                 << " for " << command << endl;
 528         if (retval > 0)
 529                 return;
 530
 531         // Read the metrics file, if it exists
 532         vector<double> ascent_fractions(git->second.snippets.size());
 533         setAscentFractions(ascent_fractions, git->second.metrics_file);
 534
 535         // Add these newly generated bitmap files to the cache and
 536         // start loading them into LyX.
 537         BitmapFile::const_iterator it  = git->second.snippets.begin();
 538         BitmapFile::const_iterator end = git->second.snippets.end();
 539
 540         std::list<PreviewImagePtr> newimages;
 541
 542         int metrics_counter = 0;
 543         for (; it != end; ++it, ++metrics_counter) {
 544                 string const & snip = it->first;
 545                 string const & file = it->second;
 546                 double af = ascent_fractions[metrics_counter];
 547
 548                 PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
 549                 cache_[snip] = ptr;
 550
 551                 newimages.push_back(ptr);
 552         }
 553
 554         // Remove the item from the list of still-executing processes.
 555         in_progress_.erase(git);
 556
 557         // Tell the outside world
 558         std::list<PreviewImagePtr>::const_reverse_iterator
 559                 nit  = newimages.rbegin();
 560         std::list<PreviewImagePtr>::const_reverse_iterator
 561                 nend = newimages.rend();
 562         for (; nit != nend; ++nit) {
 563                 imageReady(*nit->get());
 564         }
 565 }
 566
 567
 568 void PreviewLoader::Impl::dumpPreamble(ostream & os) const
 569 {
 570         // Why on earth is Buffer::makeLaTeXFile a non-const method?
 571         Buffer & tmp = const_cast<Buffer &>(buffer_);
 572         // Dump the preamble only.
 573         LatexRunParams runparams;
 574         runparams.flavor = LatexRunParams::LATEX;
 575         runparams.nice = true;
 576         runparams.moving_arg = true;
 577         runparams.free_spacing = true;
 578         tmp.makeLaTeXFile(os, buffer_.filePath(), runparams, true, false);
 579
 580         // FIXME! This is a HACK! The proper fix is to control the 'true'
 581         // passed to WriteStream below:
 582         // int InsetFormula::latex(Buffer const &, ostream & os,
 583         //                         LatexRunParams const & runparams) const
 584         // {
 585         //      WriteStream wi(os, runparams.moving_arg, true);
 586         //      par_->write(wi);
 587         //      return wi.line();
 588         // }
 589         os << "\n"
 590            << "\\def\\lyxlock{}\n"
 591            << "\n";
 592
 593         // Loop over the insets in the buffer and dump all the math-macros.
 594         Buffer::inset_iterator it  = buffer_.inset_const_iterator_begin();
 595         Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
 596
 597         for (; it != end; ++it)
 598                 if (it->lyxCode() == InsetOld::MATHMACRO_CODE)
 599                         it->latex(buffer_, os, runparams);
 600
 601         // All equation lables appear as "(#)" + preview.sty's rendering of
 602         // the label name
 603         if (lyxrc.preview_hashed_labels)
 604                 os << "\\renewcommand{\\theequation}{\\#}\n";
 605
 606         // Use the preview style file to ensure that each snippet appears on a
 607         // fresh page.
 608         os << "\n"
 609            << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
 610            << "\n";
 611
 612         // This piece of PostScript magic ensures that the foreground and
 613         // background colors are the same as the LyX screen.
 614         string fg = lyx_gui::hexname(LColor::preview);
 615         if (fg.empty()) fg = "000000";
 616
 617         string bg = lyx_gui::hexname(LColor::background);
 618         if (bg.empty()) bg = "ffffff";
 619
 620         os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
 621            << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
 622            << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
 623            << "clippath fill setrgbcolor}bind def end}}}\n";
 624 }
 625
 626
 627 void PreviewLoader::Impl::dumpData(ostream & os,
 628                                    BitmapFile const & vec) const
 629 {
 630         if (vec.empty())
 631                 return;
 632
 633         BitmapFile::const_iterator it  = vec.begin();
 634         BitmapFile::const_iterator end = vec.end();
 635
 636         for (; it != end; ++it) {
 637                 os << "\\begin{preview}\n"
 638                    << it->first
 639                    << "\n\\end{preview}\n\n";
 640         }
 641 }
 642
 643 } // namespace graphics
 644 } // namespace lyx
 645
 646 namespace {
 647
 648 string const unique_filename(string const bufferpath)
 649 {
 650         static int theCounter = 0;
 651         string const filename = tostr(theCounter++) + "lyxpreview";
 652         return support::AddName(bufferpath, filename);
 653 }
 654
 655
 656 Converter const * setConverter()
 657 {
 658         string const from = "lyxpreview";
 659
 660         Formats::FormatList::const_iterator it  = formats.begin();
 661         Formats::FormatList::const_iterator end = formats.end();
 662
 663         for (; it != end; ++it) {
 664                 string const to = it->name();
 665                 if (from == to)
 666                         continue;
 667
 668                 Converter const * ptr = converters.getConverter(from, to);
 669                 if (ptr)
 670                         return ptr;
 671         }
 672
 673         static bool first = true;
 674         if (first) {
 675                 first = false;
 676                 lyxerr << "PreviewLoader::startLoading()\n"
 677                        << "No converter from \"lyxpreview\" format has been "
 678                         "defined."
 679                        << endl;
 680         }
 681
 682         return 0;
 683 }
 684
 685
 686 void setAscentFractions(vector<double> & ascent_fractions,
 687                         string const & metrics_file)
 688 {
 689         // If all else fails, then the images will have equal ascents and
 690         // descents.
 691         vector<double>::iterator it  = ascent_fractions.begin();
 692         vector<double>::iterator end = ascent_fractions.end();
 693         fill(it, end, 0.5);
 694
 695         ifstream in(metrics_file.c_str());
 696         if (!in.good()) {
 697                 lyxerr[Debug::GRAPHICS]
 698                         << "setAscentFractions(" << metrics_file << ")\n"
 699                         << "Unable to open file!" << endl;
 700                 return;
 701         }
 702
 703         bool error = false;
 704
 705         // Tightpage dimensions affect all subsequent dimensions
 706         int tp_ascent;
 707         int tp_descent;
 708
 709         int snippet_counter = 0;
 710         while (!in.eof()) {
 711                 // Expecting lines of the form
 712                 // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
 713                 // Preview: Snippet id ascent descent width
 714                 string preview;
 715                 string type;
 716                 in >> preview >> type;
 717
 718                 if (!in.good())
 719                         // eof after all
 720                         break;
 721
 722                 error = preview != "Preview:"
 723                         || (type != "Tightpage" && type != "Snippet");
 724                 if (error)
 725                         break;
 726
 727                 if (type == "Tightpage") {
 728                         int dummy;
 729                         in >> dummy >> tp_descent >> dummy >> tp_ascent;
 730
 731                         error = !in.good();
 732                         if (error)
 733                                 break;
 734
 735                 } else {
 736                         int dummy;
 737                         int snippet_id;
 738                         int ascent;
 739                         int descent;
 740                         in >> snippet_id >> ascent >> descent >> dummy;
 741
 742                         error = !in.good() || ++snippet_counter != snippet_id;
 743                         if (error)
 744                                 break;
 745
 746                         double const a = ascent + tp_ascent;
 747                         double const d = descent - tp_descent;
 748
 749                         if (!support::float_equal(a + d, 0, 0.1))
 750                                 *it = a / (a + d);
 751
 752                         if (++it == end)
 753                                 break;
 754                 }
 755         }
 756
 757         if (error) {
 758                 lyxerr[Debug::GRAPHICS]
 759                         << "setAscentFractions(" << metrics_file << ")\n"
 760                         << "Error reading file!\n" << endl;
 761         }
 762 }
 763
 764 } // namespace anon