src/graphics/PreviewLoader.C

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