]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/PreviewLoader.cpp
Fix typo (from Thibaut)
[lyx.git] / src / graphics / PreviewLoader.cpp
index 91834d2de4d5a84fdd01d8a53b8604ec6d0bf1cd..7d72c1d1dd9466f67ee7e3a9e3b96c62a9b4be76 100644 (file)
@@ -25,6 +25,7 @@
 #include "output.h"
 #include "OutputParams.h"
 #include "TexRow.h"
+#include "texstream.h"
 
 #include "frontends/Application.h" // hexName
 
 #include "support/ForkedCalls.h"
 #include "support/lstrings.h"
 
-#include "support/bind.h"
 #include "support/TempFile.h"
 
-#include <sstream>
+#include <atomic>
 #include <fstream>
 #include <iomanip>
+#include <memory>
+#include <mutex>
+#include <sstream>
+
+#include <QTimer>
 
 using namespace std;
 using namespace lyx::support;
@@ -68,35 +73,6 @@ FileName const unique_tex_filename(FileName const & bufferpath)
 }
 
 
-lyx::Converter const * setConverter(string const & from)
-{
-       typedef vector<string> FmtList;
-       typedef lyx::graphics::Cache GCache;
-       FmtList const & loadableFormats = GCache::get().loadableFormats();
-       FmtList::const_iterator it = loadableFormats.begin();
-       FmtList::const_iterator const end = loadableFormats.end();
-
-       for (; it != end; ++it) {
-               string const to = *it;
-               if (from == to)
-                       continue;
-
-               lyx::Converter const * ptr = lyx::theConverters().getConverter(from, to);
-               if (ptr)
-                       return ptr;
-       }
-
-       // FIXME THREAD
-       static bool first = true;
-       if (first) {
-               first = false;
-               LYXERR0("PreviewLoader::startLoading()\n"
-                       << "No converter from \"" << from << "\" format has been defined.");
-       }
-       return 0;
-}
-
-
 void setAscentFractions(vector<double> & ascent_fractions,
                        FileName const & metrics_file)
 {
@@ -184,14 +160,13 @@ typedef map<pid_t, InProgress>  InProgressProcesses;
 
 typedef InProgressProcesses::value_type InProgressProcess;
 
-} // namespace anon
-
+} // namespace
 
 
 namespace lyx {
 namespace graphics {
 
-class PreviewLoader::Impl : public boost::signals::trackable {
+class PreviewLoader::Impl {
 public:
        ///
        Impl(PreviewLoader & p, Buffer const & b);
@@ -208,24 +183,28 @@ public:
        /// \p wait whether to wait for the process to complete or, instead,
        /// to do it in the background.
        void startLoading(bool wait = false);
+       ///
+       void refreshPreviews();
 
        /// Emit this signal when an image is ready for display.
-       boost::signal<void(PreviewImage const &)> imageReady;
+       signals2::signal<void(PreviewImage const &)> imageReady;
 
        Buffer const & buffer() const { return buffer_; }
 
+       lyx::Converter const * setConverter(string const & from);
+
 private:
        /// Called by the ForkedCall process that generated the bitmap files.
        void finishedGenerating(pid_t, int);
        ///
-       void dumpPreamble(otexstream &) 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 shared_ptr<PreviewImage> PreviewImagePtr;
+       typedef std::shared_ptr<PreviewImage> PreviewImagePtr;
        ///
        typedef map<string, PreviewImagePtr> Cache;
        ///
@@ -238,7 +217,6 @@ private:
 
        /** in_progress_ stores all forked processes so that we can proceed
         *  thereafter.
-           The map uses the conversion commands as its identifiers.
         */
        InProgressProcesses in_progress_;
 
@@ -246,9 +224,21 @@ private:
        PreviewLoader & parent_;
        ///
        Buffer const & buffer_;
+       ///
+       mutable int font_scaling_factor_;
+       ///
+       mutable int fg_color_;
+       ///
+       mutable int bg_color_;
+       ///
+       QTimer * delay_refresh_;
+       ///
+       bool finished_generating_;
 
        /// We don't own this
        static lyx::Converter const * pconverter_;
+
+       Trackable trackable_;
 };
 
 
@@ -300,7 +290,13 @@ void PreviewLoader::startLoading(bool wait) const
 }
 
 
-boost::signals::connection PreviewLoader::connect(slot_type const & slot) const
+void PreviewLoader::refreshPreviews()
+{
+       pimpl_->refreshPreviews();
+}
+
+
+signals2::connection PreviewLoader::connect(slot const & slot) const
 {
        return pimpl_->imageReady.connect(slot);
 }
@@ -381,22 +377,66 @@ void InProgress::stop() const
        }
 }
 
-} // namespace anon
+} // namespace
 
 
 namespace lyx {
 namespace graphics {
 
 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
-       : parent_(p), buffer_(b)
+       : parent_(p), buffer_(b), finished_generating_(true)
 {
+       font_scaling_factor_ = int(buffer_.fontScalingFactor());
+       if (theApp()) {
+               fg_color_ = strtol(theApp()->hexName(foregroundColor()).c_str(), 0, 16);
+               bg_color_ = strtol(theApp()->hexName(backgroundColor()).c_str(), 0, 16);
+       } else {
+               fg_color_ = 0x0;
+               bg_color_ = 0xffffff;
+       }
        if (!pconverter_)
                pconverter_ = setConverter("lyxpreview");
+
+       delay_refresh_ = new QTimer(&parent_);
+       delay_refresh_->setSingleShot(true);
+       QObject::connect(delay_refresh_, SIGNAL(timeout()),
+                        &parent_, SLOT(refreshPreviews()));
+}
+
+
+lyx::Converter const * PreviewLoader::Impl::setConverter(string const & from)
+{
+       typedef vector<string> FmtList;
+       FmtList const & loadableFormats = graphics::Cache::get().loadableFormats();
+       FmtList::const_iterator it = loadableFormats.begin();
+       FmtList::const_iterator const end = loadableFormats.end();
+
+       for (; it != end; ++it) {
+               string const to = *it;
+               if (from == to)
+                       continue;
+
+               lyx::Converter const * ptr = lyx::theConverters().getConverter(from, to);
+               if (ptr)
+                       return ptr;
+       }
+
+       // Show the error only once. This is thread-safe.
+       static nullptr_t no_conv = [&]{
+               LYXERR0("PreviewLoader::startLoading()\n"
+                       << "No converter from \"" << from
+                       << "\" format has been defined.");
+               return nullptr;
+       } ();
+
+       return no_conv;
 }
 
 
 PreviewLoader::Impl::~Impl()
 {
+       delete delay_refresh_;
+
        InProgressProcesses::iterator ipit  = in_progress_.begin();
        InProgressProcesses::iterator ipend = in_progress_.end();
 
@@ -408,11 +448,46 @@ PreviewLoader::Impl::~Impl()
 PreviewImage const *
 PreviewLoader::Impl::preview(string const & latex_snippet) const
 {
+       int fs = int(buffer_.fontScalingFactor());
+       int fg = 0x0;
+       int bg = 0xffffff;
+       if (theApp()) {
+               fg = strtol(theApp()->hexName(foregroundColor()).c_str(), 0, 16);
+               bg = strtol(theApp()->hexName(backgroundColor()).c_str(), 0, 16);
+       }
+       if (font_scaling_factor_ != fs || fg_color_ != fg || bg_color_ != bg) {
+               // Schedule refresh of all previews on zoom or color changes.
+               // The previews are regenerated only after the zoom factor
+               // has not been changed for about 1 second.
+               fg_color_ = fg;
+               bg_color_ = bg;
+               delay_refresh_->start(1000);
+       }
+       // Don't try to access the cache until we are done.
+       if (delay_refresh_->isActive() || !finished_generating_)
+               return 0;
        Cache::const_iterator it = cache_.find(latex_snippet);
        return (it == cache_.end()) ? 0 : it->second.get();
 }
 
 
+void PreviewLoader::Impl::refreshPreviews()
+{
+       font_scaling_factor_ = int(buffer_.fontScalingFactor());
+       // Reschedule refresh until the previous process completed.
+       if (!finished_generating_) {
+               delay_refresh_->start(1000);
+               return;
+       }
+       Cache::const_iterator cit = cache_.begin();
+       Cache::const_iterator cend = cache_.end();
+       while (cit != cend)
+               parent_.remove((cit++)->first);
+       finished_generating_ = false;
+       buffer_.updatePreviews();
+}
+
+
 namespace {
 
 class FindSnippet {
@@ -430,7 +505,7 @@ private:
        string const snippet_;
 };
 
-} // namespace anon
+} // namespace
 
 PreviewLoader::Status
 PreviewLoader::Impl::status(string const & latex_snippet) const
@@ -492,7 +567,7 @@ private:
        string const & snippet_;
 };
 
-} // namespace anon
+} // namespace
 
 
 void PreviewLoader::Impl::remove(string const & latex_snippet)
@@ -554,8 +629,7 @@ void PreviewLoader::Impl::startLoading(bool wait)
                return;
        }
 
-       TexRow texrow;
-       otexstream os(of, texrow);
+       otexstream os(of);
        OutputParams runparams(&enc);
        LaTeXFeatures features(buffer_, buffer_.params(), runparams);
 
@@ -568,9 +642,55 @@ void PreviewLoader::Impl::startLoading(bool wait)
                return;
        }
        of << "\\batchmode\n";
-       dumpPreamble(os);
+
+       // Set \jobname of previews to the document name (see bug 9627)
+       of << "\\def\\jobname{"
+          << from_utf8(changeExtension(buffer_.latexName(true), ""))
+          << "}\n";
+
+       LYXERR(Debug::LATEX, "Format = " << buffer_.params().getDefaultOutputFormat());
+       string latexparam = "";
+       bool docformat = !buffer_.params().default_output_format.empty()
+                       && buffer_.params().default_output_format != "default";
+       // Use LATEX flavor if the document does not specify a specific
+       // output format (see bug 9371).
+       OutputParams::FLAVOR flavor = docformat
+                                       ? buffer_.params().getOutputFlavor()
+                                       : OutputParams::LATEX;
+       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(os, features);
+       // I think this is already handled by dumpPreamble(): Kornel
+       // buffer_.params().writeEncodingPreamble(os, features);
        of << "\n\\begin{document}\n";
        dumpData(of, inprogress.snippets);
        of << "\n\\end{document}\n";
@@ -581,44 +701,33 @@ void PreviewLoader::Impl::startLoading(bool wait)
                return;
        }
 
-       double const font_scaling_factor = buffer_.fontScalingFactor();
-       
        // The conversion command.
        ostringstream cs;
        cs << pconverter_->command()
           << " " << quoteName(latexfile.toFilesystemEncoding())
-          << " --dpi " << int(font_scaling_factor);
+          << " --dpi " << font_scaling_factor_;
 
-       // FIXME XHTML 
+       // 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) 
+               cs << " --fg " << theApp()->hexName(fg)
                   << " --bg " << theApp()->hexName(bg);
        }
 
-       // FIXME what about LuaTeX?
-       if (buffer_.params().useNonTeXFonts)
-               cs << " --latex=xelatex";
-       if (buffer_.params().encoding().package() == Encoding::japanese)
-               cs << " --latex=platex";
-       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);
+       cs << latexparam;
+       cs << " --bibtex=" << quoteName(buffer_.params().bibtexCommand());
        if (buffer_.params().bufferFormat() == "lilypond-book")
                cs << " --lilypond";
 
        string const command = cs.str();
 
        if (wait) {
-               ForkedCall call(buffer_.filePath());
+               ForkedCall call(buffer_.filePath(), buffer_.layoutPos());
                int ret = call.startScript(ForkedProcess::Wait, command);
-               // FIXME THREAD
-               static int fake = (2^20) + 1;
+               // PID_MAX_LIMIT is 2^22 so we start one after that
+               static atomic_int fake((1 << 22) + 1);
                int pid = fake++;
                inprogress.pid = pid;
                inprogress.command = command;
@@ -628,9 +737,10 @@ void PreviewLoader::Impl::startLoading(bool wait)
        }
 
        // 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::sigPtr convert_ptr = make_shared<ForkedCall::sig>();
+       convert_ptr->connect(ForkedProcess::slot([this](pid_t pid, int retval){
+                               finishedGenerating(pid, retval);
+                       }).track_foreign(trackable_.p()));
 
        ForkedCall call(buffer_.filePath());
        int ret = call.startScript(command, convert_ptr);
@@ -660,6 +770,7 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
        if (git == in_progress_.end()) {
                lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
                        "data for PID " << pid << endl;
+               finished_generating_ = true;
                return;
        }
 
@@ -668,8 +779,11 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
        LYXERR(Debug::GRAPHICS, "PreviewLoader::finishedInProgress("
                                << retval << "): processing " << status
                                << " for " << command);
-       if (retval > 0)
+       if (retval > 0) {
+               in_progress_.erase(git);
+               finished_generating_ = true;
                return;
+       }
 
        // Read the metrics file, if it exists
        vector<double> ascent_fractions(git->second.snippets.size());
@@ -689,7 +803,8 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
                double af = ascent_fractions[metrics_counter];
 
                // Add the image to the cache only if it's actually present
-               if (file.isReadableFile()) {
+               // and not empty (an empty image is signaled by af < 0)
+               if (af >= 0 && file.isReadableFile()) {
                        PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
                        cache_[snip] = ptr;
 
@@ -709,17 +824,16 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
        for (; nit != nend; ++nit) {
                imageReady(*nit->get());
        }
+       finished_generating_ = true;
 }
 
 
-void PreviewLoader::Impl::dumpPreamble(otexstream & os) const
+void PreviewLoader::Impl::dumpPreamble(otexstream & os, OutputParams::FLAVOR flavor) const
 {
        // Dump the preamble only.
+       LYXERR(Debug::LATEX, "dumpPreamble, flavor == " << flavor);
        OutputParams runparams(&buffer_.params().encoding());
-       if (buffer_.params().useNonTeXFonts)
-               runparams.flavor = OutputParams::XETEX;
-       else
-               runparams.flavor = OutputParams::LATEX;
+       runparams.flavor = flavor;
        runparams.nice = true;
        runparams.moving_arg = true;
        runparams.free_spacing = true;
@@ -773,3 +887,5 @@ void PreviewLoader::Impl::dumpData(odocstream & os,
 
 } // namespace graphics
 } // namespace lyx
+
+#include "moc_PreviewLoader.cpp"