-/*
- * \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 "converter.h"
#include "debug.h"
-#include "lyxrc.h"
+#include "format.h"
+#include "insetiterator.h"
#include "LColor.h"
+#include "lyxrc.h"
+#include "outputparams.h"
+#include "paragraph.h"
-#include "insets/inset.h"
+#include "frontends/Application.h" // hexName
-#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>
+
+using lyx::support::FileName;
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 {
-typedef pair<string, string> StrPair;
+typedef pair<string, FileName> SnippetPair;
// A list of alll snippets to be converted to previews
typedef list<string> PendingSnippets;
// Each item in the vector is a pair<snippet, image file name>.
-typedef vector<StrPair> BitmapFile;
+typedef vector<SnippetPair> BitmapFile;
-string const unique_filename(string const bufferpath);
-Converter const * setConverter();
+string const unique_filename(string const & bufferpath)
+{
+ static int theCounter = 0;
+ string const filename = lyx::convert<string>(theCounter++) + "lyxpreview";
+ return lyx::support::addName(bufferpath, filename);
+}
+
+
+lyx::Converter const * setConverter()
+{
+ string const from = "lyxpreview";
+
+ 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;
+ }
+
+ static bool first = true;
+ if (first) {
+ first = false;
+ lyx::lyxerr << "PreviewLoader::startLoading()\n"
+ << "No converter from \"lyxpreview\" format has been "
+ "defined."
+ << endl;
+ }
+ return 0;
+}
+
void setAscentFractions(vector<double> & ascent_fractions,
- string const & metrics_file);
+ FileName 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);
-struct FindFirst {
+ ifstream in(metrics_file.toFilesystemEncoding().c_str());
+ if (!in.good()) {
+ lyx::lyxerr[lyx::Debug::GRAPHICS]
+ << "setAscentFractions(" << metrics_file << ")\n"
+ << "Unable to open file!" << endl;
+ return;
+ }
+
+ 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;
+
+ error = id != snippet_counter;
+ if (error)
+ break;
+
+ *it = ascent_fraction;
+
+ ++snippet_counter;
+ ++it;
+ }
+
+ if (error) {
+ lyx::lyxerr[lyx::Debug::GRAPHICS]
+ << "setAscentFractions(" << metrics_file << ")\n"
+ << "Error reading file!\n" << endl;
+ }
+}
+
+
+class FindFirst : public std::unary_function<SnippetPair, bool> {
+public:
FindFirst(string const & comp) : comp_(comp) {}
- bool operator()(StrPair const & sp)
+ bool operator()(SnippetPair const & sp) const
{
- return sp.first < comp_;
+ return sp.first == comp_;
}
private:
string const comp_;
/// Store info on a currently executing, forked process.
-struct InProgress {
+class InProgress {
+public:
///
InProgress() : pid(0) {}
///
///
pid_t pid;
///
- string metrics_file;
+ string command;
+ ///
+ FileName metrics_file;
///
BitmapFile snippets;
};
-typedef map<string, InProgress> InProgressProcesses;
+typedef map<pid_t, InProgress> InProgressProcesses;
typedef InProgressProcesses::value_type InProgressProcess;
} // namespace anon
-namespace grfx {
-struct PreviewLoader::Impl : public boost::signals::trackable {
+namespace lyx {
+
+namespace graphics {
+
+class PreviewLoader::Impl : public boost::signals::trackable {
+public:
///
Impl(PreviewLoader & p, Buffer const & b);
/// Stop any InProgress items still executing.
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;
+ void dumpPreamble(odocstream &) const;
///
- void dumpData(ostream &, BitmapFile const &) const;
+ void dumpData(odocstream &, BitmapFile const &) const;
/** cache_ allows easy retrieval of already-generated images
* using the LaTeX snippet as the identifier.
Converter const * PreviewLoader::Impl::pconverter_;
+//
// The public interface, defined in PreviewLoader.h
-// ================================================
+//
+
PreviewLoader::PreviewLoader(Buffer const & b)
: pimpl_(new Impl(*this, b))
{}
return pimpl_->buffer();
}
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
// The details of the Impl
namespace {
-struct IncrementedFileName {
+class IncrementedFileName {
+public:
IncrementedFileName(string const & to_format,
string const & filename_base)
: to_format_(to_format), base_(filename_base), counter_(1)
{}
- StrPair const operator()(string const & snippet)
+ SnippetPair const operator()(string const & snippet)
{
ostringstream os;
- os << base_ << 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);
+ return make_pair(snippet, FileName(file));
}
private:
PendingSnippets const & pending,
string const & to_format)
: pid(0),
- metrics_file(filename_base + ".metrics"),
+ metrics_file(FileName(filename_base + ".metrics")),
snippets(pending.size())
{
PendingSnippets::const_iterator pit = pending.begin();
PendingSnippets::const_iterator pend = pending.end();
BitmapFile::iterator sit = snippets.begin();
- std::transform(pit, pend, sit,
+ std::transform(pit, pend, sit,
IncrementedFileName(to_format, filename_base));
}
void InProgress::stop() const
{
if (pid)
- ForkedcallsController::get().kill(pid, 0);
+ lyx::support::ForkedcallsController::get().kill(pid, 0);
if (!metrics_file.empty())
- lyx::unlink(metrics_file);
+ lyx::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);
+ lyx::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_ = 0.01 * lyxrc.dpi * lyxrc.zoom *
- lyxrc.preview_scale_factor;
+ convert<double>(lyxrc.preview_scale_factor);
lyxerr[Debug::GRAPHICS] << "The font scaling factor is "
<< font_scaling_factor_ << endl;
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
if (!pconverter_ || status(latex_snippet) != NotFound)
return;
- string const snippet = trim(latex_snippet);
+ string const snippet = support::trim(latex_snippet);
if (snippet.empty())
return;
namespace {
-struct EraseSnippet {
+class EraseSnippet {
+public:
EraseSnippet(string const & s) : snippet_(s) {}
void operator()(InProgressProcess & process)
{
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);
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.
pending_.clear();
// Output the LaTeX file.
- string const latexfile = filename_base + ".tex";
+ FileName const latexfile(filename_base + ".tex");
- ofstream of(latexfile.c_str());
+ // FIXME UNICODE
+ // This creates an utf8 encoded file, but the proper inputenc
+ // command is missing.
+ odocfstream of(latexfile.toFilesystemEncoding().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";
// The conversion command.
ostringstream cs;
- cs << pconverter_->command << " " << latexfile << " "
- << int(font_scaling_factor_);
+ cs << pconverter_->command << ' ' << pconverter_->to << ' '
+ << support::quoteName(latexfile.toFilesystemEncoding()) << ' '
+ << int(font_scaling_factor_) << ' '
+ << theApp()->hexName(LColor::preview) << ' '
+ << theApp()->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);
+ support::Forkedcall::SignalTypePtr
+ convert_ptr(new support::Forkedcall::SignalType);
+ convert_ptr->connect(bind(&Impl::finishedGenerating, this, _1, _2));
- convert_ptr->connect(
- boost::bind(&Impl::finishedGenerating, this, _1, _2, _3));
-
- 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
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);
int metrics_counter = 0;
for (; it != end; ++it, ++metrics_counter) {
string const & snip = it->first;
- string const & file = it->second;
+ FileName const & file = it->second;
double af = ascent_fractions[metrics_counter];
PreviewImagePtr ptr(new PreviewImage(parent_, snip, file, af));
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());
}
}
-void PreviewLoader::Impl::dumpPreamble(ostream & os) const
+void PreviewLoader::Impl::dumpPreamble(odocstream & 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, buffer_.filePath(), 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 &, odocstream & 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);
+ if (it->lyxCode() == InsetBase::MATHMACRO_CODE)
+ it->latex(buffer_, os, runparams);
// All equation lables appear as "(#)" + preview.sty's rendering of
// the label name
// Use the preview style file to ensure that each snippet appears on a
// fresh page.
os << "\n"
- << "\\usepackage[active,delayed,dvips,tightpage,showlabels,lyx]{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";
}
-void PreviewLoader::Impl::dumpData(ostream & os,
+void PreviewLoader::Impl::dumpData(odocstream & os,
BitmapFile const & vec) const
{
if (vec.empty())
BitmapFile::const_iterator end = vec.end();
for (; it != end; ++it) {
+ // FIXME UNICODE
os << "\\begin{preview}\n"
- << it->first
+ << from_utf8(it->first)
<< "\n\\end{preview}\n\n";
}
}
-} // namespace grfx
-
-
-namespace {
-
-string const unique_filename(string const bufferpath)
-{
- static int theCounter = 0;
- string const filename = tostr(theCounter++) + "lyxpreview";
- return AddName(bufferpath, filename);
-}
-
-
-Converter const * setConverter()
-{
- string const from = "lyxpreview";
-
- Formats::FormatList::const_iterator it = formats.begin();
- Formats::FormatList::const_iterator end = formats.end();
-
- for (; it != end; ++it) {
- string const to = it->name();
- if (from == to)
- continue;
-
- Converter const * ptr = converters.getConverter(from, to);
- if (ptr)
- return ptr;
- }
-
- static bool first = true;
- if (first) {
- first = false;
- lyxerr << "PreviewLoader::startLoading()\n"
- << "No converter from \"lyxpreview\" format has been "
- "defined."
- << endl;
- }
-
- return 0;
-}
-
-
-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);
-
- ifstream in(metrics_file.c_str());
- if (!in.good()) {
- lyxerr[Debug::GRAPHICS]
- << "setAscentFractions(" << metrics_file << ")\n"
- << "Unable to open file!" << endl;
- return;
- }
-
- bool error = false;
-
- // Tightpage dimensions affect all subsequent dimensions
- int tp_ascent;
- int tp_descent;
-
- 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;
+} // namespace graphics
+} // namespace lyx
- if (!in.good())
- // eof after all
- break;
-
- error = preview != "Preview:"
- || (type != "Tightpage" && type != "Snippet");
- if (error)
- break;
-
- if (type == "Tightpage") {
- int dummy;
- in >> dummy >> tp_descent >> dummy >> tp_ascent;
-
- error = !in.good();
- if (error)
- break;
-
- } 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;
-
- double const a = ascent + tp_ascent;
- double const d = descent - tp_descent;
-
- if (!lyx::float_equal(a + d, 0, 0.1))
- *it = a / (a + d);
-
- if (++it == end)
- break;
- }
- }
-
- if (error) {
- lyxerr[Debug::GRAPHICS]
- << "setAscentFractions(" << metrics_file << ")\n"
- << "Error reading file!\n" << endl;
- }
-}
-
-} // namespace anon
projects / lyx.git / blobdiff