]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/PreviewLoader.cpp
Update previews after doing a find/replace (#7242)
[lyx.git] / src / graphics / PreviewLoader.cpp
index a10b2c9f8dc5b6c11e284acad0cd5900f4af4e30..addc6af224497a454f057f2af799c876746ed004 100644 (file)
 
 #include "support/convert.h"
 #include "support/debug.h"
+#include "support/FileName.h"
 #include "support/filetools.h"
 #include "support/ForkedCalls.h"
 #include "support/lstrings.h"
 
-#include <boost/bind.hpp>
+#include "support/bind.h"
+#include "support/TempFile.h"
 
 #include <sstream>
 #include <fstream>
@@ -45,7 +47,7 @@
 using namespace std;
 using namespace lyx::support;
 
-using boost::bind;
+
 
 namespace {
 
@@ -58,21 +60,19 @@ typedef list<string> PendingSnippets;
 typedef vector<SnippetPair> BitmapFile;
 
 
-string const unique_filename(string const & bufferpath)
+FileName const unique_tex_filename(FileName const & bufferpath)
 {
-       static int theCounter = 0;
-       string const filename = lyx::convert<string>(theCounter++) + "lyxpreview";
-       return addName(bufferpath, filename);
+       TempFile tempfile(bufferpath, "lyxpreviewXXXXXX.tex");
+       tempfile.setAutoRemove(false);
+       return tempfile.name();
 }
 
 
-lyx::Converter const * setConverter()
+lyx::Converter const * setConverter(string const & from)
 {
-       string const from = "lyxpreview";
-
        typedef vector<string> FmtList;
        typedef lyx::graphics::Cache GCache;
-       FmtList const loadableFormats = GCache::get().loadableFormats();
+       FmtList const loadableFormats = GCache::get().loadableFormats();
        FmtList::const_iterator it = loadableFormats.begin();
        FmtList::const_iterator const end = loadableFormats.end();
 
@@ -86,11 +86,12 @@ lyx::Converter const * setConverter()
                        return ptr;
        }
 
+       // FIXME THREAD
        static bool first = true;
        if (first) {
                first = false;
                LYXERR0("PreviewLoader::startLoading()\n"
-                 << "No converter from \"lyxpreview\" format has been defined.");
+                       << "No converter from \"" << from << "\" format has been defined.");
        }
        return 0;
 }
@@ -204,8 +205,9 @@ public:
        void add(string const & latex_snippet);
        ///
        void remove(string const & latex_snippet);
-       ///
-       void startLoading();
+       /// \p wait whether to wait for the process to complete or, instead,
+       /// to do it in the background.
+       void startLoading(bool wait = false);
 
        /// Emit this signal when an image is ready for display.
        boost::signal<void(PreviewImage const &)> imageReady;
@@ -216,14 +218,14 @@ private:
        /// Called by the ForkedCall process that generated the bitmap files.
        void finishedGenerating(pid_t, int);
        ///
-       void dumpPreamble(odocstream &) const;
+       void dumpPreamble(otexstream &, OutputParams::FLAVOR) const;
        ///
        void dumpData(odocstream &, BitmapFile const &) const;
 
        /** cache_ allows easy retrieval of already-generated images
         *  using the LaTeX snippet as the identifier.
         */
-       typedef boost::shared_ptr<PreviewImage> PreviewImagePtr;
+       typedef shared_ptr<PreviewImage> PreviewImagePtr;
        ///
        typedef map<string, PreviewImagePtr> Cache;
        ///
@@ -244,8 +246,6 @@ private:
        PreviewLoader & parent_;
        ///
        Buffer const & buffer_;
-       ///
-       double font_scaling_factor_;
 
        /// We don't own this
        static lyx::Converter const * pconverter_;
@@ -294,9 +294,9 @@ void PreviewLoader::remove(string const & latex_snippet) const
 }
 
 
-void PreviewLoader::startLoading() const
+void PreviewLoader::startLoading(bool wait) const
 {
-       pimpl_->startLoading();
+       pimpl_->startLoading(wait);
 }
 
 
@@ -353,7 +353,7 @@ InProgress::InProgress(string const & filename_base,
                       PendingSnippets const & pending,
                       string const & to_format)
        : pid(0),
-         metrics_file(FileName(filename_base + ".metrics")),
+         metrics_file(filename_base + ".metrics"),
          snippets(pending.size())
 {
        PendingSnippets::const_iterator pit  = pending.begin();
@@ -388,16 +388,10 @@ namespace lyx {
 namespace graphics {
 
 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
-       : parent_(p), buffer_(b), font_scaling_factor_(0.0)
+       : parent_(p), buffer_(b)
 {
-       font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
-               convert<double>(lyxrc.preview_scale_factor);
-
-       LYXERR(Debug::GRAPHICS, "The font scaling factor is "
-                               << font_scaling_factor_);
-
        if (!pconverter_)
-               pconverter_ = setConverter();
+               pconverter_ = setConverter("lyxpreview");
 }
 
 
@@ -525,7 +519,7 @@ void PreviewLoader::Impl::remove(string const & latex_snippet)
 }
 
 
-void PreviewLoader::Impl::startLoading()
+void PreviewLoader::Impl::startLoading(bool wait)
 {
        if (pending_.empty() || !pconverter_)
                return;
@@ -537,24 +531,31 @@ void PreviewLoader::Impl::startLoading()
        LYXERR(Debug::GRAPHICS, "PreviewLoader::startLoading()");
 
        // As used by the LaTeX file and by the resulting image files
-       string const directory = buffer_.temppath();
+       FileName const directory(buffer_.temppath());
 
-       string const filename_base = unique_filename(directory);
+       FileName const latexfile = unique_tex_filename(directory);
+       string const filename_base = removeExtension(latexfile.absFileName());
 
        // Create an InProgress instance to place in the map of all
        // such processes if it starts correctly.
-       InProgress inprogress(filename_base, pending_, pconverter_->to);
+       InProgress inprogress(filename_base, pending_, pconverter_->to());
 
        // clear pending_, so we're ready to start afresh.
        pending_.clear();
 
        // Output the LaTeX file.
-       FileName const latexfile(filename_base + ".tex");
-
        // we use the encoding of the buffer
        Encoding const & enc = buffer_.params().encoding();
-       odocfstream of(enc.iconvName());
+       ofdocstream of;
+       try { of.reset(enc.iconvName()); }
+       catch (iconv_codecvt_facet_exception const & e) {
+               LYXERR0("Caught iconv exception: " << e.what()
+                       << "\nUnable to create LaTeX file: " << latexfile);
+               return;
+       }
+
        TexRow texrow;
+       otexstream os(of, texrow);
        OutputParams runparams(&enc);
        LaTeXFeatures features(buffer_, buffer_.params(), runparams);
 
@@ -567,9 +568,44 @@ void PreviewLoader::Impl::startLoading()
                return;
        }
        of << "\\batchmode\n";
-       dumpPreamble(of);
+
+       LYXERR(Debug::LATEX, "Format = " << buffer_.params().getDefaultOutputFormat());
+       string latexparam = "";
+       OutputParams::FLAVOR flavor = buffer_.params().getOutputFlavor();
+       if (buffer_.params().encoding().package() == Encoding::japanese) {
+               latexparam = " --latex=platex";
+               flavor = OutputParams::LATEX;
+       }
+       else if (buffer_.params().useNonTeXFonts) {
+               if (flavor == OutputParams::LUATEX)
+                       latexparam = " --latex=lualatex";
+               else {
+                       flavor = OutputParams::XETEX;
+                       latexparam = " --latex=xelatex";
+               }
+       }
+       else {
+               switch (flavor) {
+                       case OutputParams::PDFLATEX:
+                               latexparam = " --latex=pdflatex";
+                               break;
+                       case OutputParams::XETEX:
+                               latexparam = " --latex=xelatex";
+                               break;
+                       case OutputParams::LUATEX:
+                               latexparam = " --latex=lualatex";
+                               break;
+                       case OutputParams::DVILUATEX:
+                               latexparam = " --latex=dvilualatex";
+                               break;
+                       default:
+                               flavor = OutputParams::LATEX;
+               }
+       }
+       dumpPreamble(os, flavor);
        // handle inputenc etc.
-       buffer_.params().writeEncodingPreamble(of, features, texrow);
+       // I think, this is already hadled by dumpPreamble(): Kornel
+       // buffer_.params().writeEncodingPreamble(os, features);
        of << "\n\\begin{document}\n";
        dumpData(of, inprogress.snippets);
        of << "\n\\end{document}\n";
@@ -580,22 +616,54 @@ void PreviewLoader::Impl::startLoading()
                return;
        }
 
+       double const font_scaling_factor = buffer_.fontScalingFactor();
+
        // The conversion command.
        ostringstream cs;
-       cs << pconverter_->command << ' ' << pconverter_->to << ' '
-          << quoteName(latexfile.toFilesystemEncoding()) << ' '
-          << int(font_scaling_factor_) << ' '
-          << theApp()->hexName(Color_preview) << ' '
-          << theApp()->hexName(Color_background);
+       cs << pconverter_->command()
+          << " " << quoteName(latexfile.toFilesystemEncoding())
+          << " --dpi " << int(font_scaling_factor);
+
+       // FIXME XHTML 
+       // The colors should be customizable.
+       if (!buffer_.isExporting()) {
+               ColorCode const fg = PreviewLoader::foregroundColor();
+               ColorCode const bg = PreviewLoader::backgroundColor();
+               cs << " --fg " << theApp()->hexName(fg) 
+                  << " --bg " << theApp()->hexName(bg);
+       }
 
-       string const command = libScriptSearch(cs.str());
+       cs << latexparam;
+       if (buffer_.params().bibtex_command != "default")
+               cs << " --bibtex=" << quoteName(buffer_.params().bibtex_command);
+       else if (buffer_.params().encoding().package() == Encoding::japanese)
+               cs << " --bibtex=" << quoteName(lyxrc.jbibtex_command);
+       else
+               cs << " --bibtex=" << quoteName(lyxrc.bibtex_command);
+       if (buffer_.params().bufferFormat() == "lilypond-book")
+               cs << " --lilypond";
+
+       string const command = cs.str();
+
+       if (wait) {
+               ForkedCall call(buffer_.filePath());
+               int ret = call.startScript(ForkedProcess::Wait, command);
+               // FIXME THREAD
+               static int fake = (2^20) + 1;
+               int pid = fake++;
+               inprogress.pid = pid;
+               inprogress.command = command;
+               in_progress_[pid] = inprogress;
+               finishedGenerating(pid, ret);
+               return;
+       }
 
        // Initiate the conversion from LaTeX to bitmap images files.
        ForkedCall::SignalTypePtr
                convert_ptr(new ForkedCall::SignalType);
        convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
 
-       ForkedCall call;
+       ForkedCall call(buffer_.filePath());
        int ret = call.startScript(command, convert_ptr);
 
        if (ret != 0) {
@@ -611,6 +679,11 @@ void PreviewLoader::Impl::startLoading()
 }
 
 
+double PreviewLoader::displayPixelRatio() const
+{
+       return buffer().params().display_pixel_ratio;
+}
+
 void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
 {
        // Paranoia check!
@@ -646,10 +719,14 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
                FileName const & file = it->second;
                double af = ascent_fractions[metrics_counter];
 
-               PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
-               cache_[snip] = ptr;
+               // Add the image to the cache only if it's actually present
+               if (file.isReadableFile()) {
+                       PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
+                       cache_[snip] = ptr;
+
+                       newimages.push_back(ptr);
+               }
 
-               newimages.push_back(ptr);
        }
 
        // Remove the item from the list of still-executing processes.
@@ -666,19 +743,17 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
 }
 
 
-void PreviewLoader::Impl::dumpPreamble(odocstream & os) const
+void PreviewLoader::Impl::dumpPreamble(otexstream & os, OutputParams::FLAVOR flavor) const
 {
-       // Why on earth is Buffer::makeLaTeXFile a non-const method?
-       Buffer & tmp = const_cast<Buffer &>(buffer_);
        // Dump the preamble only.
-       // We don't need an encoding for runparams since it is not used by
-       // the preamble.
-       OutputParams runparams(0);
-       runparams.flavor = OutputParams::LATEX;
+       LYXERR(Debug::LATEX, "dumpPreamble, flavor == " << flavor);
+       OutputParams runparams(&buffer_.params().encoding());
+       runparams.flavor = flavor;
        runparams.nice = true;
        runparams.moving_arg = true;
        runparams.free_spacing = true;
-       tmp.writeLaTeXSource(os, buffer_.filePath(), runparams, true, false);
+       runparams.is_child = buffer_.parent();
+       buffer_.writeLaTeXSource(os, buffer_.filePath(), runparams, Buffer::OnlyPreamble);
 
        // FIXME! This is a HACK! The proper fix is to control the 'true'
        // passed to WriteStream below:
@@ -693,15 +768,6 @@ void PreviewLoader::Impl::dumpPreamble(odocstream & os) const
           << "\\def\\lyxlock{}\n"
           << "\n";
 
-       // Loop over the insets in the buffer and dump all the math-macros.
-       Inset & inset = buffer_.inset();
-       InsetIterator it = inset_iterator_begin(inset);
-       InsetIterator const end = inset_iterator_end(inset);
-
-       for (; it != end; ++it)
-               if (it->lyxCode() == MATHMACRO_CODE)
-                       it->latex(buffer_, os, runparams);
-
        // All equation labels appear as "(#)" + preview.sty's rendering of
        // the label name
        if (lyxrc.preview_hashed_labels)
@@ -709,8 +775,10 @@ void PreviewLoader::Impl::dumpPreamble(odocstream & os) const
 
        // Use the preview style file to ensure that each snippet appears on a
        // fresh page.
+       // Also support PDF output (automatically generated e.g. when
+       // \usepackage[pdftex]{hyperref} is used and XeTeX.
        os << "\n"
-          << "\\usepackage[active,delayed,dvips,showlabels,lyx]{preview}\n"
+          << "\\usepackage[active,delayed,showlabels,lyx]{preview}\n"
           << "\n";
 }