]> git.lyx.org Git - features.git/blobdiff - src/graphics/PreviewLoader.C
Replace LString.h with support/std_string.h,
[features.git] / src / graphics / PreviewLoader.C
index eb28055954bff55763beafe8c8335ca558ebd9d7..decb4473691f0c3ef4dc53f5a2c8db6b59c9128b 100644 (file)
@@ -1,29 +1,23 @@
-/*
- *  \file PreviewLoader.C
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+/**
+ * \file PreviewLoader.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author Angus Leeming <leeming@lyx.org>
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "PreviewLoader.h"
 #include "PreviewImage.h"
 
 #include "buffer.h"
-#include "bufferparams.h"
 #include "converter.h"
+#include "format.h"
 #include "debug.h"
 #include "lyxrc.h"
-#include "lyxtextclasslist.h"
-#include "LColor.h"
-
-#include "insets/inset.h"
 
 #include "frontends/lyx_gui.h" // hexname
 
 #include "support/forkedcontr.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
+#include "support/tostr.h"
 
 #include <boost/bind.hpp>
-#include <boost/signals/trackable.hpp>
 
+#include "support/std_sstream.h"
 #include <fstream>
 #include <iomanip>
-#include <list>
-#include <map>
-#include <utility>
-#include <vector>
+
+namespace support = lyx::support;
+
 
 using std::endl;
 using std::find;
@@ -70,9 +64,6 @@ typedef list<string> PendingSnippets;
 // Each item in the vector is a pair<snippet, image file name>.
 typedef vector<StrPair> BitmapFile;
 
-
-double setFontScalingFactor(Buffer &);
-
 string const unique_filename(string const bufferpath);
 
 Converter const * setConverter();
@@ -84,7 +75,7 @@ struct FindFirst {
        FindFirst(string const & comp) : comp_(comp) {}
        bool operator()(StrPair const & sp)
        {
-               return sp.first < comp_;
+               return sp.first == comp_;
        }
 private:
        string const comp_;
@@ -105,19 +96,22 @@ struct InProgress {
        ///
        pid_t pid;
        ///
+       string command;
+       ///
        string metrics_file;
        ///
        BitmapFile snippets;
 };
 
-typedef map<string, InProgress>  InProgressProcesses;
+typedef map<pid_t, InProgress>  InProgressProcesses;
 
 typedef InProgressProcesses::value_type InProgressProcess;
 
 } // namespace anon
 
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 struct PreviewLoader::Impl : public boost::signals::trackable {
        ///
@@ -138,9 +132,11 @@ struct PreviewLoader::Impl : public boost::signals::trackable {
        /// Emit this signal when an image is ready for display.
        boost::signal1<void, PreviewImage const &> imageReady;
 
+       Buffer const & buffer() const { return buffer_; }
+
 private:
        /// Called by the Forkedcall process that generated the bitmap files.
-       void finishedGenerating(string const &, pid_t, int);
+       void finishedGenerating(pid_t, int);
        ///
        void dumpPreamble(ostream &) const;
        ///
@@ -233,7 +229,14 @@ void PreviewLoader::emitSignal(PreviewImage const & pimage) const
        pimpl_->imageReady(pimage);
 }
 
-} // namespace grfx
+
+Buffer const & PreviewLoader::buffer() const
+{
+       return pimpl_->buffer();
+}
+
+} // namespace graphics
+} // namespace lyx
 
 
 // The details of the Impl
@@ -250,11 +253,8 @@ struct IncrementedFileName {
        StrPair const operator()(string const & snippet)
        {
                ostringstream os;
-               os << base_
-                  << setfill('0') << setw(3) << counter_++
-                  << "." << to_format_;
-
-               string const file = os.str().c_str();
+               os << base_ << counter_++ << '.' << to_format_;
+               string const file = STRCONV(os.str());
 
                return make_pair(snippet, file);
        }
@@ -285,28 +285,30 @@ InProgress::InProgress(string const & filename_base,
 void InProgress::stop() const
 {
        if (pid)
-               ForkedcallsController::get().kill(pid, 0);
+               support::ForkedcallsController::get().kill(pid, 0);
 
        if (!metrics_file.empty())
-               lyx::unlink(metrics_file);
+               support::unlink(metrics_file);
 
        BitmapFile::const_iterator vit  = snippets.begin();
        BitmapFile::const_iterator vend = snippets.end();
        for (; vit != vend; ++vit) {
                if (!vit->second.empty())
-                       lyx::unlink(vit->second);
+                       support::unlink(vit->second);
        }
 }
 
 } // namespace anon
 
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
 PreviewLoader::Impl::Impl(PreviewLoader & p, Buffer const & b)
        : parent_(p), buffer_(b), font_scaling_factor_(0.0)
 {
-       font_scaling_factor_ = setFontScalingFactor(const_cast<Buffer &>(b));
+       font_scaling_factor_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
+               lyxrc.preview_scale_factor;
 
        lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
                                << font_scaling_factor_ << endl;
@@ -384,7 +386,13 @@ void PreviewLoader::Impl::add(string const & latex_snippet)
        if (!pconverter_ || status(latex_snippet) != NotFound)
                return;
 
-       pending_.push_back(latex_snippet);
+       string const snippet = support::trim(latex_snippet);
+       if (snippet.empty())
+               return;
+
+       lyxerr[Debug::GRAPHICS] << "adding snippet:\n" << snippet << endl;
+
+       pending_.push_back(snippet);
 }
 
 
@@ -442,7 +450,11 @@ void PreviewLoader::Impl::startLoading()
        lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()" << endl;
 
        // As used by the LaTeX file and by the resulting image files
-       string const filename_base(unique_filename(buffer_.tmppath));
+       string directory = buffer_.tmppath;
+       if (directory.empty())
+               directory = buffer_.filePath();
+
+       string const filename_base(unique_filename(directory));
 
        // Create an InProgress instance to place in the map of all
        // such processes if it starts correctly.
@@ -464,19 +476,18 @@ void PreviewLoader::Impl::startLoading()
 
        // The conversion command.
        ostringstream cs;
-       cs << pconverter_->command << " " << latexfile << " "
-          << int(font_scaling_factor_);
+       cs << pconverter_->command << ' ' << latexfile << ' '
+          << int(font_scaling_factor_) << ' ' << pconverter_->to;
 
-       string const command = LibScriptSearch(cs.str().c_str());
+       string const command = "sh " + support::LibScriptSearch(STRCONV(cs.str()));
 
        // Initiate the conversion from LaTeX to bitmap images files.
-       Forkedcall::SignalTypePtr convert_ptr;
-       convert_ptr.reset(new Forkedcall::SignalType);
-
+       support::Forkedcall::SignalTypePtr
+               convert_ptr(new support::Forkedcall::SignalType);
        convert_ptr->connect(
-               boost::bind(&Impl::finishedGenerating, this, _1, _2, _3));
+               boost::bind(&Impl::finishedGenerating, this, _1, _2));
 
-       Forkedcall call;
+       support::Forkedcall call;
        int ret = call.startscript(command, convert_ptr);
 
        if (ret != 0) {
@@ -488,13 +499,22 @@ void PreviewLoader::Impl::startLoading()
 
        // Store the generation process in a list of all such processes
        inprogress.pid = call.pid();
-       in_progress_[command] = inprogress;
+       inprogress.command = command;
+       in_progress_[inprogress.pid] = inprogress;
 }
 
 
-void PreviewLoader::Impl::finishedGenerating(string const & command,
-                                            pid_t /* pid */, int retval)
+void PreviewLoader::Impl::finishedGenerating(pid_t pid, int retval)
 {
+       // Paranoia check!
+       InProgressProcesses::iterator git = in_progress_.find(pid);
+       if (git == in_progress_.end()) {
+               lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
+                       "data for PID " << pid << endl;
+               return;
+       }
+
+       string const command = git->second.command;
        string const status = retval > 0 ? "failed" : "succeeded";
        lyxerr[Debug::GRAPHICS] << "PreviewLoader::finishedInProgress("
                                << retval << "): processing " << status
@@ -502,15 +522,6 @@ void PreviewLoader::Impl::finishedGenerating(string const & command,
        if (retval > 0)
                return;
 
-       // Paranoia check!
-       InProgressProcesses::iterator git = in_progress_.find(command);
-       if (git == in_progress_.end()) {
-               lyxerr << "PreviewLoader::finishedGenerating(): unable to find "
-                       "data for\n"
-                      << command << "!" << endl;
-               return;
-       }
-
        // Read the metrics file, if it exists
        vector<double> ascent_fractions(git->second.snippets.size());
        setAscentFractions(ascent_fractions, git->second.metrics_file);
@@ -538,8 +549,10 @@ void PreviewLoader::Impl::finishedGenerating(string const & command,
        in_progress_.erase(git);
 
        // Tell the outside world
-       std::list<PreviewImagePtr>::const_iterator nit  = newimages.begin();
-       std::list<PreviewImagePtr>::const_iterator nend = newimages.end();
+       std::list<PreviewImagePtr>::const_reverse_iterator
+               nit  = newimages.rbegin();
+       std::list<PreviewImagePtr>::const_reverse_iterator
+               nend = newimages.rend();
        for (; nit != nend; ++nit) {
                imageReady(*nit->get());
        }
@@ -551,17 +564,33 @@ void PreviewLoader::Impl::dumpPreamble(ostream & os) const
        // Why on earth is Buffer::makeLaTeXFile a non-const method?
        Buffer & tmp = const_cast<Buffer &>(buffer_);
        // Dump the preamble only.
-       tmp.makeLaTeXFile(os, string(), true, false, true);
+       LatexRunParams runparams;
+       runparams.flavor = LatexRunParams::LATEX;
+       runparams.nice = true;
+       runparams.moving_arg = true;
+       runparams.free_spacing = true;
+       tmp.makeLaTeXFile(os, buffer_.filePath(), runparams, true, false);
+
+       // FIXME! This is a HACK! The proper fix is to control the 'true'
+       // passed to WriteStream below:
+       // int InsetFormula::latex(Buffer const &, ostream & os,
+       //                         LatexRunParams const & runparams) const
+       // {
+       //      WriteStream wi(os, runparams.moving_arg, true);
+       //      par_->write(wi);
+       //      return wi.line();
+       // }
+       os << "\n"
+          << "\\def\\lyxlock{}\n"
+          << "\n";
 
        // Loop over the insets in the buffer and dump all the math-macros.
        Buffer::inset_iterator it  = buffer_.inset_const_iterator_begin();
        Buffer::inset_iterator end = buffer_.inset_const_iterator_end();
 
-       for (; it != end; ++it) {
-               if ((*it)->lyxCode() == Inset::MATHMACRO_CODE) {
-                       (*it)->latex(&buffer_, os, true, true);
-               }
-       }
+       for (; it != end; ++it)
+               if (it->lyxCode() == InsetOld::MATHMACRO_CODE)
+                       it->latex(buffer_, os, runparams);
 
        // All equation lables appear as "(#)" + preview.sty's rendering of
        // the label name
@@ -571,7 +600,7 @@ void PreviewLoader::Impl::dumpPreamble(ostream & os) const
        // Use the preview style file to ensure that each snippet appears on a
        // fresh page.
        os << "\n"
-          << "\\usepackage[active,delayed,dvips,tightpage,showlabels]{preview}\n"
+          << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{preview}\n"
           << "\n";
 
        // This piece of PostScript magic ensures that the foreground and
@@ -584,7 +613,7 @@ void PreviewLoader::Impl::dumpPreamble(ostream & os) const
 
        os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
           << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
-          << "<" << fg << bg << ">{255 div}forall setrgbcolor\n"
+          << '<' << fg << bg << ">{255 div}forall setrgbcolor\n"
           << "clippath fill setrgbcolor}bind def end}}}\n";
 }
 
@@ -605,8 +634,8 @@ void PreviewLoader::Impl::dumpData(ostream & os,
        }
 }
 
-} // namespace grfx
-
+} // namespace graphics
+} // namespace lyx
 
 namespace {
 
@@ -614,7 +643,7 @@ string const unique_filename(string const bufferpath)
 {
        static int theCounter = 0;
        string const filename = tostr(theCounter++) + "lyxpreview";
-       return AddName(bufferpath, filename);
+       return support::AddName(bufferpath, filename);
 }
 
 
@@ -648,106 +677,81 @@ Converter const * setConverter()
 }
 
 
-double setFontScalingFactor(Buffer & buffer)
+void setAscentFractions(vector<double> & ascent_fractions,
+                       string const & metrics_file)
 {
-       double scale_factor = 0.01 * lyxrc.dpi * lyxrc.zoom *
-               lyxrc.preview_scale_factor;
+       // If all else fails, then the images will have equal ascents and
+       // descents.
+       vector<double>::iterator it  = ascent_fractions.begin();
+       vector<double>::iterator end = ascent_fractions.end();
+       fill(it, end, 0.5);
 
-       // Has the font size been set explicitly?
-       string const & fontsize = buffer.params.fontsize;
-       lyxerr[Debug::GRAPHICS] << "PreviewLoader::scaleToFitLyXView()\n"
-                               << "font size is " << fontsize << endl;
+       ifstream in(metrics_file.c_str());
+       if (!in.good()) {
+               lyxerr[Debug::GRAPHICS]
+                       << "setAscentFractions(" << metrics_file << ")\n"
+                       << "Unable to open file!" << endl;
+               return;
+       }
 
-       if (isStrUnsignedInt(fontsize))
-               return 10.0 * scale_factor / strToDbl(fontsize);
+       bool error = false;
 
-       // No. We must extract it from the LaTeX class file.
-       LyXTextClass const & tclass = textclasslist[buffer.params.textclass];
-       string const textclass(tclass.latexname() + ".cls");
-       string const classfile(findtexfile(textclass, "cls"));
+       // Tightpage dimensions affect all subsequent dimensions
+       int tp_ascent;
+       int tp_descent;
 
-       lyxerr[Debug::GRAPHICS] << "text class is " << textclass << '\n'
-                               << "class file is " << classfile << endl;
+       int snippet_counter = 0;
+       while (!in.eof()) {
+               // Expecting lines of the form
+               // Preview: Tightpage tp_bl_x tp_bl_y tp_tr_x tp_tr_y
+               // Preview: Snippet id ascent descent width
+               string preview;
+               string type;
+               in >> preview >> type;
 
-       ifstream ifs(classfile.c_str());
-       if (!ifs.good()) {
-               lyxerr[Debug::GRAPHICS] << "Unable to open class file!" << endl;
-               return scale_factor;
-       }
+               if (!in.good())
+                       // eof after all
+                       break;
 
-       string str;
-       double scaling = scale_factor;
+               error = preview != "Preview:"
+                       || (type != "Tightpage" && type != "Snippet");
+               if (error)
+                       break;
 
-       while (ifs.good()) {
-               getline(ifs, str);
-               // To get the default font size, look for a line like
-               // "\ExecuteOptions{letterpaper,10pt,oneside,onecolumn,final}"
-               if (!prefixIs(frontStrip(str), "\\ExecuteOptions"))
-                       continue;
+               if (type == "Tightpage") {
+                       int dummy;
+                       in >> dummy >> tp_descent >> dummy >> tp_ascent;
 
-               // str contains just the options of \ExecuteOptions
-               string const tmp = split(str, '{');
-               split(tmp, str, '}');
-
-               int count = 0;
-               string tok = token(str, ',', count++);
-               while (!isValidLength(tok) && !tok.empty())
-                       tok = token(str, ',', count++);
-
-               if (!tok.empty()) {
-                       lyxerr[Debug::GRAPHICS]
-                               << "Extracted default font size from "
-                               "LaTeX class file successfully!" << endl;
-                       LyXLength fsize(tok);
-                       scaling *= 10.0 / fsize.value();
-                       break;
-               }
-       }
+                       error = !in.good();
+                       if (error)
+                               break;
 
-       return scaling;
-}
+               } else {
+                       int dummy;
+                       int snippet_id;
+                       int ascent;
+                       int descent;
+                       in >> snippet_id >> ascent >> descent >> dummy;
 
+                       error = !in.good() || ++snippet_counter != snippet_id;
+                       if (error)
+                               break;
 
-void setAscentFractions(vector<double> & ascent_fractions,
-                       string const & metrics_file)
-{
-       // If all else fails, then the images will have equal ascents and
-       // descents.
-       vector<double>::iterator it  = ascent_fractions.begin();
-       vector<double>::iterator end = ascent_fractions.end();
-       fill(it, end, 0.5);
+                       double const a = ascent + tp_ascent;
+                       double const d = descent - tp_descent;
 
-       ifstream ifs(metrics_file.c_str());
-       if (!ifs.good()) {
-               lyxerr[Debug::GRAPHICS] << "setAscentFractions("
-                                       << metrics_file << ")\n"
-                                       << "Unable to open file!"
-                                       << endl;
-               return;
-       }
+                       if (!support::float_equal(a + d, 0, 0.1))
+                               *it = a / (a + d);
 
-       for (; it != end; ++it) {
-               string page;
-               string page_id;
-               int dummy;
-               double ascent;
-               double descent;
-
-               ifs >> page >> page_id >> dummy >> dummy >> dummy >> dummy
-                   >> ascent >> descent >> dummy;
-
-               if (!ifs.good() ||
-                   page != "%%Page" ||
-                   !isStrUnsignedInt(strip(page_id, ':'))) {
-                       lyxerr[Debug::GRAPHICS] << "setAscentFractions("
-                                               << metrics_file << ")\n"
-                                               << "Error reading file!"
-                                               << endl;
-                       break;
+                       if (++it == end)
+                               break;
                }
+       }
 
-               if (ascent + descent != 0)
-                       *it = ascent / (ascent + descent);
+       if (error) {
+               lyxerr[Debug::GRAPHICS]
+                       << "setAscentFractions(" << metrics_file << ")\n"
+                       << "Error reading file!\n" << endl;
        }
 }