]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/PreviewLoader.C
Add more controls to the view-source dialog.
[lyx.git] / src / graphics / PreviewLoader.C
index 14eb559e3dcac30603e30fe0eaf5d93cb27c59b3..0ed2ef8c0b5693b3af927f3685d0b78d0b9c3255 100644 (file)
@@ -1,63 +1,66 @@
-/*
- *  \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 "GraphicsCache.h"
 
 #include "buffer.h"
-#include "bufferparams.h"
 #include "converter.h"
 #include "debug.h"
-#include "lyxrc.h"
+#include "format.h"
+#include "insetiterator.h"
 #include "LColor.h"
-
-#include "insets/inset.h"
+#include "lyxrc.h"
+#include "outputparams.h"
+#include "paragraph.h"
 
 #include "frontends/lyx_gui.h" // hexname
 
+#include "insets/inset.h"
+
 #include "support/filetools.h"
 #include "support/forkedcall.h"
 #include "support/forkedcontr.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
+#include "support/convert.h"
 
 #include <boost/bind.hpp>
-#include <boost/signals/trackable.hpp>
 
+#include <sstream>
 #include <fstream>
 #include <iomanip>
-#include <list>
-#include <map>
-#include <utility>
-#include <vector>
+
+namespace support = lyx::support;
 
 using std::endl;
 using std::find;
 using std::fill;
 using std::find_if;
-using std::getline;
 using std::make_pair;
-using std::setfill;
-using std::setw;
 
+using boost::bind;
+
+using std::ifstream;
 using std::list;
 using std::map;
-using std::ifstream;
 using std::ofstream;
 using std::ostream;
+using std::ostringstream;
 using std::pair;
 using std::vector;
+using std::string;
+
 
 namespace {
 
@@ -69,9 +72,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();
@@ -79,11 +79,12 @@ Converter const * setConverter();
 void setAscentFractions(vector<double> & ascent_fractions,
                        string const & metrics_file);
 
-struct FindFirst {
+class FindFirst : public std::unary_function<StrPair, bool> {
+public:
        FindFirst(string const & comp) : comp_(comp) {}
-       bool operator()(StrPair const & sp)
+       bool operator()(StrPair const & sp) const
        {
-               return sp.first < comp_;
+               return sp.first == comp_;
        }
 private:
        string const comp_;
@@ -91,7 +92,8 @@ private:
 
 
 /// Store info on a currently executing, forked process.
-struct InProgress {
+class InProgress {
+public:
        ///
        InProgress() : pid(0) {}
        ///
@@ -104,21 +106,25 @@ 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 {
+class PreviewLoader::Impl : public boost::signals::trackable {
+public:
        ///
        Impl(PreviewLoader & p, Buffer const & b);
        /// Stop any InProgress items still executing.
@@ -135,11 +141,13 @@ struct PreviewLoader::Impl : public boost::signals::trackable {
        void startLoading();
 
        /// Emit this signal when an image is ready for display.
-       boost::signal1<void, PreviewImage const &> imageReady;
+       boost::signal<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;
        ///
@@ -232,7 +240,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
@@ -240,7 +255,8 @@ void PreviewLoader::emitSignal(PreviewImage const & pimage) const
 
 namespace {
 
-struct IncrementedFileName {
+class IncrementedFileName {
+public:
        IncrementedFileName(string const & to_format,
                            string const & filename_base)
                : to_format_(to_format), base_(filename_base), counter_(1)
@@ -249,11 +265,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 = os.str();
 
                return make_pair(snippet, file);
        }
@@ -284,28 +297,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 *
+               convert<double>(lyxrc.preview_scale_factor);
 
        lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
                                << font_scaling_factor_ << endl;
@@ -336,19 +351,19 @@ PreviewLoader::Impl::preview(string const & latex_snippet) const
 
 namespace {
 
-struct FindSnippet {
+class FindSnippet : public std::unary_function<InProgressProcess, bool> {
+public:
        FindSnippet(string const & s) : snippet_(s) {}
-       bool operator()(InProgressProcess const & process)
+       bool operator()(InProgressProcess const & process) const
        {
                BitmapFile const & snippets = process.second.snippets;
-               BitmapFile::const_iterator it  = snippets.begin();
+               BitmapFile::const_iterator beg  = snippets.begin();
                BitmapFile::const_iterator end = snippets.end();
-               it = find_if(it, end, FindFirst(snippet_));
-               return it != end;
+               return find_if(beg, end, FindFirst(snippet_)) != end;
        }
 
 private:
-       string const snippet_;
+       string const snippet_;
 };
 
 } // namespace anon
@@ -383,13 +398,20 @@ 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);
 }
 
 
 namespace {
 
-struct EraseSnippet {
+class EraseSnippet {
+public:
        EraseSnippet(string const & s) : snippet_(s) {}
        void operator()(InProgressProcess & process)
        {
@@ -425,7 +447,7 @@ void PreviewLoader::Impl::remove(string const & latex_snippet)
 
        std::for_each(ipit, ipend, EraseSnippet(latex_snippet));
 
-       for (; ipit != ipend; ++ipit) {
+       while (ipit != ipend) {
                InProgressProcesses::iterator curr = ipit++;
                if (curr->second.snippets.empty())
                        in_progress_.erase(curr);
@@ -438,10 +460,16 @@ void PreviewLoader::Impl::startLoading()
        if (pending_.empty() || !pconverter_)
                return;
 
+       // Only start the process off after the buffer is loaded from file.
+       if (!buffer_.fully_loaded())
+               return;
+
        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 const directory = buffer_.temppath();
+
+       string const filename_base(unique_filename(directory));
 
        // Create an InProgress instance to place in the map of all
        // such processes if it starts correctly.
@@ -454,6 +482,12 @@ void PreviewLoader::Impl::startLoading()
        string const latexfile = filename_base + ".tex";
 
        ofstream of(latexfile.c_str());
+       if (!of) {
+               lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
+                                       << "Unable to create LaTeX file\n"
+                                       << latexfile << endl;
+               return;
+       }
        of << "\\batchmode\n";
        dumpPreamble(of);
        of << "\n\\begin{document}\n";
@@ -463,37 +497,47 @@ void PreviewLoader::Impl::startLoading()
 
        // The conversion command.
        ostringstream cs;
-       cs << pconverter_->command << " " << latexfile << " "
-          << int(font_scaling_factor_);
+       cs << pconverter_->command << ' ' << pconverter_->to << ' '
+          << support::quoteName(latexfile) << ' '
+          << int(font_scaling_factor_) << ' '
+          << lyx_gui::hexname(LColor::preview) << ' '
+          << lyx_gui::hexname(LColor::background);
 
-       string const command = LibScriptSearch(cs.str().c_str());
+       string const command = support::libScriptSearch(cs.str());
 
        // Initiate the conversion from LaTeX to bitmap images files.
-       Forkedcall::SignalTypePtr convert_ptr;
-       convert_ptr.reset(new Forkedcall::SignalType);
-
-       convert_ptr->connect(
-               boost::bind(&Impl::finishedGenerating, this, _1, _2, _3));
+       support::Forkedcall::SignalTypePtr
+               convert_ptr(new support::Forkedcall::SignalType);
+       convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
 
-       Forkedcall call;
+       support::Forkedcall call;
        int ret = call.startscript(command, convert_ptr);
 
        if (ret != 0) {
                lyxerr[Debug::GRAPHICS] << "PreviewLoader::startLoading()\n"
-                                       << "Unable to start process \n"
+                                       << "Unable to start process\n"
                                        << command << endl;
                return;
        }
 
        // 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
@@ -501,15 +545,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);
@@ -537,8 +572,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());
        }
@@ -550,17 +587,34 @@ 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);
+       OutputParams runparams;
+       runparams.flavor = OutputParams::LATEX;
+       runparams.nice = true;
+       runparams.moving_arg = true;
+       runparams.free_spacing = true;
+       tmp.writeLaTeXSource(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,
+       //                         OutputParams 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();
+       InsetBase & inset = buffer_.inset();
+       InsetIterator it = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
 
-       for (; it != end; ++it) {
-               if ((*it)->lyxCode() == Inset::MATHMACRO_CODE) {
-                       (*it)->latex(&buffer_, os, true, true);
-               }
-       }
+       for (; it != end; ++it)
+               if (it->lyxCode() == InsetBase::MATHMACRO_CODE)
+                       it->latex(buffer_, os, runparams);
 
        // All equation lables appear as "(#)" + preview.sty's rendering of
        // the label name
@@ -570,21 +624,8 @@ 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,showlabels,lyx]{preview}\n"
           << "\n";
-
-       // This piece of PostScript magic ensures that the foreground and
-       // background colors are the same as the LyX screen.
-       string fg = lyx_gui::hexname(LColor::preview);
-       if (fg.empty()) fg = "000000";
-
-       string bg = lyx_gui::hexname(LColor::background);
-       if (bg.empty()) bg = "ffffff";
-
-       os << "\\AtBeginDocument{\\AtBeginDvi{%\n"
-          << "\\special{!userdict begin/bop-hook{//bop-hook exec\n"
-          << "<" << fg << bg << ">{255 div}forall setrgbcolor\n"
-          << "clippath fill setrgbcolor}bind def end}}}\n";
 }
 
 
@@ -604,16 +645,16 @@ void PreviewLoader::Impl::dumpData(ostream & os,
        }
 }
 
-} // namespace grfx
-
+} // namespace graphics
+} // namespace lyx
 
 namespace {
 
 string const unique_filename(string const bufferpath)
 {
        static int theCounter = 0;
-       string const filename = tostr(theCounter++) + "lyxpreview";
-       return AddName(bufferpath, filename);
+       string const filename = convert<string>(theCounter++) + "lyxpreview";
+       return support::addName(bufferpath, filename);
 }
 
 
@@ -621,11 +662,14 @@ Converter const * setConverter()
 {
        string const from = "lyxpreview";
 
-       Formats::FormatList::const_iterator it  = formats.begin();
-       Formats::FormatList::const_iterator end = formats.end();
+       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->name();
+               string const to = *it;
                if (from == to)
                        continue;
 
@@ -647,66 +691,6 @@ Converter const * setConverter()
 }
 
 
-double setFontScalingFactor(Buffer & buffer)
-{
-       double scale_factor = 0.01 * lyxrc.dpi * lyxrc.zoom *
-               lyxrc.preview_scale_factor;
-
-       // Has the font size been set explicitly?
-       string const & fontsize = buffer.params.fontsize;
-       lyxerr[Debug::GRAPHICS] << "PreviewLoader::scaleToFitLyXView()\n"
-                               << "font size is " << fontsize << endl;
-
-       if (isStrUnsignedInt(fontsize))
-               return 10.0 * scale_factor / strToDbl(fontsize);
-
-       // No. We must extract it from the LaTeX class file.
-       LyXTextClass const & tclass = buffer.params.getLyXTextClass();
-       string const textclass(tclass.latexname() + ".cls");
-       string const classfile(findtexfile(textclass, "cls"));
-
-       lyxerr[Debug::GRAPHICS] << "text class is " << textclass << '\n'
-                               << "class file is " << classfile << endl;
-
-       ifstream ifs(classfile.c_str());
-       if (!ifs.good()) {
-               lyxerr[Debug::GRAPHICS] << "Unable to open class file!" << endl;
-               return scale_factor;
-       }
-
-       string str;
-       double scaling = scale_factor;
-
-       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;
-
-               // 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;
-               }
-       }
-
-       return scaling;
-}
-
-
 void setAscentFractions(vector<double> & ascent_fractions,
                        string const & metrics_file)
 {
@@ -716,37 +700,46 @@ void setAscentFractions(vector<double> & ascent_fractions,
        vector<double>::iterator end = ascent_fractions.end();
        fill(it, end, 0.5);
 
-       ifstream ifs(metrics_file.c_str());
-       if (!ifs.good()) {
-               lyxerr[Debug::GRAPHICS] << "setAscentFractions("
-                                       << metrics_file << ")\n"
-                                       << "Unable to open file!"
-                                       << endl;
+       ifstream in(metrics_file.c_str());
+       if (!in.good()) {
+               lyxerr[Debug::GRAPHICS]
+                       << "setAscentFractions(" << metrics_file << ")\n"
+                       << "Unable to open file!" << endl;
                return;
        }
 
-       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;
+       bool error = false;
+
+       int snippet_counter = 1;
+       while (!in.eof() && it != end) {
+               string snippet;
+               int id;
+               double ascent_fraction;
+
+               in >> snippet >> id >> ascent_fraction;
+
+               if (!in.good())
+                       // eof after all
+                       break;
+
+               error = snippet != "Snippet";
+               if (error)
                        break;
-               }
 
-               if (ascent + descent != 0)
-                       *it = ascent / (ascent + descent);
+               error = id != snippet_counter;
+               if (error)
+                       break;
+
+               *it = ascent_fraction;
+
+               ++snippet_counter;
+               ++it;
+       }
+
+       if (error) {
+               lyxerr[Debug::GRAPHICS]
+                       << "setAscentFractions(" << metrics_file << ")\n"
+                       << "Error reading file!\n" << endl;
        }
 }