X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fgraphics%2FPreviewLoader.cpp;h=dc944b1929e36198e2fdd11b5da0cc0ee8654ded;hb=b3fe9cb7049daaacbcf357ba5e4ece479f7b1be4;hp=6e392e5f36af0ef3f8f3ecf6e81b081828a6ffdc;hpb=f9bff2d9b1e34a82e77e7f1041755b71045c7006;p=lyx.git diff --git a/src/graphics/PreviewLoader.cpp b/src/graphics/PreviewLoader.cpp index 6e392e5f36..dc944b1929 100644 --- a/src/graphics/PreviewLoader.cpp +++ b/src/graphics/PreviewLoader.cpp @@ -19,30 +19,32 @@ #include "Converter.h" #include "Encoding.h" #include "Format.h" -#include "InsetIterator.h" -#include "LaTeXFeatures.h" #include "LyXRC.h" #include "output.h" #include "OutputParams.h" #include "TexRow.h" +#include "texstream.h" #include "frontends/Application.h" // hexName -#include "insets/Inset.h" - #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 "support/os.h" -#include "support/bind.h" #include "support/TempFile.h" -#include +#include #include #include +#include +#include +#include + +#include using namespace std; using namespace lyx::support; @@ -68,35 +70,6 @@ FileName const unique_tex_filename(FileName const & bufferpath) } -lyx::Converter const * setConverter(string const & from) -{ - typedef vector 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 & ascent_fractions, FileName const & metrics_file) { @@ -148,14 +121,10 @@ void setAscentFractions(vector & ascent_fractions, } -class FindFirst +std::function FindFirst(string const & comp) { -public: - FindFirst(string const & comp) : comp_(comp) {} - bool operator()(SnippetPair const & sp) const { return sp.first == comp_; } -private: - string const comp_; -}; + return [&comp](SnippetPair const & sp) { return sp.first == comp; }; +} /// Store info on a currently executing, forked process. @@ -170,28 +139,27 @@ public: /// Remove any files left lying around and kill the forked process. void stop() const; - /// - pid_t pid; /// string command; /// FileName metrics_file; /// BitmapFile snippets; + /// + pid_t pid; }; typedef map 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 +176,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 imageReady; + signal 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 &, 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 PreviewImagePtr; + typedef std::shared_ptr PreviewImagePtr; /// typedef map Cache; /// @@ -238,7 +210,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 +217,20 @@ 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_; + }; @@ -260,16 +242,10 @@ lyx::Converter const * PreviewLoader::Impl::pconverter_; // PreviewLoader::PreviewLoader(Buffer const & b) - : pimpl_(new Impl(*this, b)) + : pimpl_(make_shared(*this, b)) {} -PreviewLoader::~PreviewLoader() -{ - delete pimpl_; -} - - PreviewImage const * PreviewLoader::preview(string const & latex_snippet) const { return pimpl_->preview(latex_snippet); @@ -300,7 +276,13 @@ void PreviewLoader::startLoading(bool wait) const } -boost::signals::connection PreviewLoader::connect(slot_type const & slot) const +void PreviewLoader::refreshPreviews() +{ + pimpl_->refreshPreviews(); +} + + +connection PreviewLoader::connect(slot const & slot) const { return pimpl_->imageReady.connect(slot); } @@ -337,9 +319,8 @@ public: { ostringstream os; os << base_ << counter_++ << '.' << to_format_; - string const file = os.str(); - - return make_pair(snippet, FileName(file)); + string const file_name = os.str(); + return make_pair(snippet, FileName(file_name)); } private: @@ -352,9 +333,8 @@ private: InProgress::InProgress(string const & filename_base, PendingSnippets const & pending, string const & to_format) - : pid(0), - metrics_file(filename_base + ".metrics"), - snippets(pending.size()) + : metrics_file(filename_base + ".metrics"), + snippets(pending.size()), pid(0) { PendingSnippets::const_iterator pit = pending.begin(); PendingSnippets::const_iterator pend = pending.end(); @@ -381,22 +361,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_ = convert(theApp()->hexName(foregroundColor()), 16); + bg_color_ = convert(theApp()->hexName(backgroundColor()), 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 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,29 +432,60 @@ 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 = convert(theApp()->hexName(foregroundColor()), 16); + bg = convert(theApp()->hexName(backgroundColor()), 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 nullptr; + Cache::const_iterator it = cache_.find(latex_snippet); - return (it == cache_.end()) ? 0 : it->second.get(); + return (it == cache_.end()) ? nullptr : 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 { -public: - FindSnippet(string const & s) : snippet_(s) {} - bool operator()(InProgressProcess const & process) const - { +std::function FindSnippet(string const & s) +{ + return [&s](InProgressProcess const & process) { BitmapFile const & snippets = process.second.snippets; BitmapFile::const_iterator beg = snippets.begin(); BitmapFile::const_iterator end = snippets.end(); - return find_if(beg, end, FindFirst(snippet_)) != end; - } - -private: - string const snippet_; -}; + return find_if(beg, end, FindFirst(s)) != end; + }; +} -} // namespace anon +} // namespace PreviewLoader::Status PreviewLoader::Impl::status(string const & latex_snippet) const @@ -474,25 +529,20 @@ void PreviewLoader::Impl::add(string const & latex_snippet) namespace { -class EraseSnippet { -public: - EraseSnippet(string const & s) : snippet_(s) {} - void operator()(InProgressProcess & process) - { +std::function EraseSnippet(string const & s) +{ + return [&s](InProgressProcess & process) { BitmapFile & snippets = process.second.snippets; BitmapFile::iterator it = snippets.begin(); BitmapFile::iterator end = snippets.end(); - it = find_if(it, end, FindFirst(snippet_)); + it = find_if(it, end, FindFirst(s)); if (it != end) snippets.erase(it, it+1); - } - -private: - string const & snippet_; -}; + }; +} -} // namespace anon +} // namespace void PreviewLoader::Impl::remove(string const & latex_snippet) @@ -538,7 +588,7 @@ void PreviewLoader::Impl::startLoading(bool wait) // 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(); @@ -554,11 +604,7 @@ void PreviewLoader::Impl::startLoading(bool wait) return; } - TexRow texrow; - otexstream os(of, texrow); - OutputParams runparams(&enc); - LaTeXFeatures features(buffer_, buffer_.params(), runparams); - + otexstream os(of); if (!openFileWrite(of, latexfile)) return; @@ -568,9 +614,50 @@ void PreviewLoader::Impl::startLoading(bool wait) return; } of << "\\batchmode\n"; - dumpPreamble(os); + + LYXERR(Debug::OUTFILE, "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). + Flavor flavor = docformat + ? buffer_.params().getOutputFlavor() + : Flavor::LaTeX; + if (buffer_.params().encoding().package() == Encoding::japanese) { + latexparam = " --latex=platex"; + flavor = Flavor::LaTeX; + } + else if (buffer_.params().useNonTeXFonts) { + if (flavor == Flavor::LuaTeX) + latexparam = " --latex=lualatex"; + else { + flavor = Flavor::XeTeX; + latexparam = " --latex=xelatex"; + } + } + else { + switch (flavor) { + case Flavor::PdfLaTeX: + latexparam = " --latex=pdflatex"; + break; + case Flavor::XeTeX: + latexparam = " --latex=xelatex"; + break; + case Flavor::LuaTeX: + latexparam = " --latex=lualatex"; + break; + case Flavor::DviLuaTeX: + latexparam = " --latex=dvilualatex"; + break; + default: + flavor = Flavor::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 +668,33 @@ void PreviewLoader::Impl::startLoading(bool wait) return; } - double const font_scaling_factor = buffer_.fontScalingFactor(); - // The conversion command. ostringstream cs; - cs << pconverter_->command + cs << subst(pconverter_->command(), "$${python}", os::python()) << " " << 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 +704,13 @@ 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(); + weak_ptr this_ = parent_.pimpl_; + convert_ptr->connect([this_](pid_t pid, int retval){ + if (auto p = this_.lock()) { + p->finishedGenerating(pid, retval); + } + }); ForkedCall call(buffer_.filePath()); int ret = call.startScript(command, convert_ptr); @@ -660,6 +740,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 +749,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 ascent_fractions(git->second.snippets.size()); @@ -682,14 +766,15 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval) list newimages; - int metrics_counter = 0; + size_t metrics_counter = 0; for (; it != end; ++it, ++metrics_counter) { string const & snip = it->first; FileName const & file = it->second; 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,29 +794,30 @@ void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval) for (; nit != nend; ++nit) { imageReady(*nit->get()); } + finished_generating_ = true; + buffer_.scheduleRedrawWorkAreas(); } -void PreviewLoader::Impl::dumpPreamble(otexstream & os) const +void PreviewLoader::Impl::dumpPreamble(otexstream & os, Flavor flavor) const { // Dump the preamble only. + LYXERR(Debug::OUTFILE, "dumpPreamble, flavor == " << static_cast(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; runparams.is_child = buffer_.parent(); + runparams.for_preview = true; 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: + // passed to TeXMathStream below: // int InsetMathNest::latex(Buffer const &, odocstream & os, // OutputParams const & runparams) const // { - // WriteStream wi(os, runparams.moving_arg, true); + // TeXMathStream wi(os, runparams.moving_arg, true); // par_->write(wi); // return wi.line(); // } @@ -763,13 +849,34 @@ void PreviewLoader::Impl::dumpData(odocstream & os, BitmapFile::const_iterator it = vec.begin(); BitmapFile::const_iterator end = vec.end(); + Encoding const & enc = buffer_.params().encoding(); + for (; it != end; ++it) { + docstring res; + bool uncodable_content = false; + // check whether the content is encodable + // FIXME: the preview loader should be able + // to handle multiple encodings + // or we should generally use utf8 + for (char_type n : from_utf8(it->first)) { + if (!enc.encodable(n)) { + LYXERR0("Uncodable character '" + << docstring(1, n) + << "' in preview snippet!"); + uncodable_content = true; + } else + res += n; + } // FIXME UNICODE - os << "\\begin{preview}\n" - << from_utf8(it->first) - << "\n\\end{preview}\n\n"; + os << "\\begin{preview}\n"; + // do not show incomplete preview + if (!uncodable_content) + os << res; + os << "\n\\end{preview}\n\n"; } } } // namespace graphics } // namespace lyx + +#include "moc_PreviewLoader.cpp"