-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995-2002 the LyX Team.
- *
+/**
+ * \file insetgraphics.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
* \author Baruch Even
- * \author Herbert Voss <voss@lyx.org>
- * ====================================================== */
+ * \author Herbert Voss
+ *
+ * Full author contact details are available in file CREDITS
+ */
/*
-Known BUGS:
-
- * If the image is from the clipart, and the document is moved to another
- directory, the user is screwed. Need a way to handle it.
- This amounts to a problem of when to use relative or absolute file paths
- We should probably use what the user asks to use... but when he chooses
- by the file dialog we normally get an absolute path and this may not be
- what the user meant.
- [Note that browseRelFile in helper_funcs.* provides a file name
- which is relative if it is at reference path (here puffer path)
- level or below, and an absolute path if the file name is not a
- `natural' relative file name. In any case,
- MakeAbsPath(filename, buf->filePath())
- is guaranteed to provide the correct absolute path. This is what is
- done know for include insets. Feel free to ask me -- JMarc
- 14/01/2002]
-
- * If we are trying to create a file in a read-only directory and there
- are graphics that need converting, the converting will fail because
- it is done in-place, into the same directory as the original image.
- This needs to be fixed in the src/converter.C file
- [ This is presumed to be fixed, needs testing.]
-
- * We do not dither or resize the image in a WYSIWYM way, we load it at
- its original size and color, resizing is done in the final output,
- but not in the LyX window.
-
-TODO Before initial production release:
- * Replace insetfig everywhere
- * Search for comments of the form
- // INSET_GRAPHICS: remove this when InsetFig is thrown.
- And act upon them. Make sure not to remove InsetFig code for the
- 1.2.0 release, only afterwards, after deployment shows InsetGraphics
- to be ok.
- * What advanced features the users want to do?
- Implement them in a non latex dependent way, but a logical way.
- LyX should translate it to latex or any other fitting format.
+TODO
+
+ * What advanced features the users want to do?
+ Implement them in a non latex dependent way, but a logical way.
+ LyX should translate it to latex or any other fitting format.
* Add a way to roll the image file into the file format.
* When loading, if the image is not found in the expected place, try
- to find it in the clipart, or in the same directory with the image.
- * Keep a tab on the image file, if it changes, update the lyx view.
- * The image choosing dialog could show thumbnails of the image formats
- it knows of, thus selection based on the image instead of based on
- filename.
- * Add support for the 'picins' package.
- * Add support for the 'picinpar' package.
- * Improve support for 'subfigure' - Allow to set the various options
- that are possible.
- */
+ to find it in the clipart, or in the same directory with the image.
+ * The image choosing dialog could show thumbnails of the image formats
+ it knows of, thus selection based on the image instead of based on
+ filename.
+ * Add support for the 'picins' package.
+ * Add support for the 'picinpar' package.
+ * Improve support for 'subfigure' - Allow to set the various options
+ that are possible.
+*/
/* NOTES:
* Fileformat:
* and when reading one should change the version check and the error message.
* The filename is kept in the lyx file in a relative way, so as to allow
* moving the document file and its images with no problem.
- *
+ *
*
* Conversions:
* Postscript output means EPS figures.
*
* PDF output is best done with PDF figures if it's a direct conversion
* or PNG figures otherwise.
- * Image format
- * from to
- * EPS epstopdf
- * PS ps2pdf
- * JPG/PNG direct
- * PDF direct
- * others PNG
+ * Image format
+ * from to
+ * EPS epstopdf
+ * PS ps2pdf
+ * JPG/PNG direct
+ * PDF direct
+ * others PNG
*/
-#include <config.h>
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
+#include <config.h>
#include "insets/insetgraphics.h"
#include "insets/insetgraphicsParams.h"
-#include "graphics/GraphicsCache.h"
-#include "graphics/GraphicsCacheItem.h"
+
+#include "graphics/GraphicsLoader.h"
#include "graphics/GraphicsImage.h"
+#include "graphics/GraphicsParams.h"
-#include "frontends/Dialogs.h"
-#include "frontends/Alert.h"
-#include "LyXView.h"
+#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
-#include "Painter.h"
-#include "lyx_gui_misc.h"
-#include "support/FileInfo.h"
-#include "support/filetools.h"
-#include "frontends/controllers/helper_funcs.h"
-#include "support/lyxlib.h"
-#include "lyxtext.h"
-#include "lyxrc.h"
-#include "font.h" // For the lyxfont class.
-#include "fstream" // for ifstream in isEPS
-#include <algorithm> // For the std::max
-#include "support/lyxmanip.h"
#include "debug.h"
+#include "format.h"
+#include "funcrequest.h"
#include "gettext.h"
+#include "LaTeXFeatures.h"
+#include "Lsstream.h"
+#include "lyxlex.h"
+#include "lyxrc.h"
+#include "Lsstream.h"
+
+#include "frontends/lyx_gui.h"
+#include "frontends/Alert.h"
+#include "frontends/Dialogs.h"
+#include "frontends/font_metrics.h"
+#include "frontends/LyXView.h"
+#include "frontends/Painter.h"
+
+#include "support/LAssert.h"
+#include "support/filetools.h"
+#include "support/lyxalgo.h" // lyx::count
+#include "support/lyxlib.h" // float_equal
+#include "support/path.h"
+#include "support/tostr.h"
+#include "support/systemcall.h"
+#include "support/os.h"
+
+#include <boost/weak_ptr.hpp>
+#include <boost/bind.hpp>
+#include <boost/signals/trackable.hpp>
+#include "support/BoostFormat.h"
+
+#include <algorithm> // For the std::max
extern string system_tempdir;
+// set by Exporters
+extern bool pdf_mode;
-using std::ifstream;
using std::ostream;
using std::endl;
+
+namespace {
+
///////////////////////////////////////////////////////////////////////////
int const VersionNumber = 1;
///////////////////////////////////////////////////////////////////////////
}
+string const uniqueID()
+{
+ static unsigned int seed = 1000;
+ return "graph" + tostr(++seed);
+}
+
+
+string findTargetFormat(string const & suffix)
+{
+ // pdf_mode means:
+ // Are we creating a PDF or a PS file?
+ // (Should actually mean, are we using latex or pdflatex).
+ if (pdf_mode) {
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
+ if (contains(suffix, "ps") || suffix == "pdf")
+ return "pdf";
+ if (suffix == "jpg") // pdflatex can use jpeg
+ return suffix;
+ return "png"; // and also png
+ }
+ // If it's postscript, we always do eps.
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
+ if (suffix != "ps") // any other than ps
+ return "eps"; // is changed to eps
+ return suffix; // let ps untouched
+}
+
+} // namespace anon
+
+
+struct InsetGraphics::Cache : boost::signals::trackable
+{
+ ///
+ Cache(InsetGraphics &);
+ ///
+ void update(string const & file_with_path);
+
+ ///
+ int old_ascent;
+ ///
+ grfx::Loader loader;
+ ///
+ unsigned long checksum;
+ ///
+ boost::weak_ptr<BufferView> view;
+
+private:
+ ///
+ InsetGraphics & parent_;
+};
+
+
+InsetGraphics::Cache::Cache(InsetGraphics & p)
+ : old_ascent(0), checksum(0), parent_(p)
+{
+ loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
+}
+
+
+void InsetGraphics::Cache::update(string const & file_with_path)
+{
+ lyx::Assert(!file_with_path.empty());
+
+ string const path = OnlyPath(file_with_path);
+ loader.reset(file_with_path, parent_.params().as_grfxParams(path));
+}
+
+
InsetGraphics::InsetGraphics()
+ : graphic_label(uniqueID()),
+ cache_(new Cache(*this))
{}
-InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
+InsetGraphics::InsetGraphics(InsetGraphics const & ig,
+ string const & filepath,
+ bool same_id)
+ : Inset(ig, same_id),
+ graphic_label(uniqueID()),
+ cache_(new Cache(*this))
{
- setParams(ig.getParams());
- if (same_id)
- id_ = ig.id_;
+ setParams(ig.params(), filepath);
+}
+
+
+Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
+{
+ return new InsetGraphics(*this, buffer.filePath(), same_id);
}
InsetGraphics::~InsetGraphics()
{
- grfx::GCache & gc = grfx::GCache::get();
- gc.remove(*this);
+ InsetGraphicsMailer mailer(*this);
+ mailer.hideDialog();
+}
+
+
+dispatch_result InsetGraphics::localDispatch(FuncRequest const & cmd)
+{
+ switch (cmd.action) {
+ case LFUN_INSET_MODIFY: {
+ InsetGraphicsParams p;
+ InsetGraphicsMailer::string2params(cmd.argument, p);
+ if (!p.filename.empty()) {
+ string const filepath = cmd.view()->buffer()->filePath();
+ setParams(p, filepath);
+ cmd.view()->updateInset(this);
+ }
+ return DISPATCHED;
+ }
+
+ case LFUN_INSET_DIALOG_UPDATE:
+ InsetGraphicsMailer(*this).updateDialog(cmd.view());
+ return DISPATCHED;
+
+ case LFUN_INSET_EDIT:
+ case LFUN_MOUSE_RELEASE:
+ InsetGraphicsMailer(*this).showDialog(cmd.view());
+ return DISPATCHED;
- // Emits the hide signal to the dialog connected (if any)
- hideDialog();
+ default:
+ return Inset::localDispatch(cmd);
+ }
}
string const InsetGraphics::statusMessage() const
{
- string msg;
- grfx::GCache const & gc = grfx::GCache::get();
- grfx::ImageStatus const status = gc.status(*this);
-
- switch (status) {
- case grfx::WaitingToLoad:
- msg = _("Waiting for draw request to start loading...");
- break;
- case grfx::Loading:
- msg = _("Loading...");
- break;
- case grfx::Converting:
- msg = _("Converting to loadable format...");
- break;
- case grfx::ScalingEtc:
- msg = _("Loaded. Scaling etc...");
- break;
- case grfx::ErrorLoading:
- msg = _("Error loading");
- break;
- case grfx::ErrorConverting:
- msg = _("Error converting to loadable format");
- break;
- case grfx::ErrorScalingEtc:
- msg = _("Error scaling etc");
- break;
- case grfx::ErrorUnknown:
- msg = _("No image associated with this inset is in the cache!");
- break;
- case grfx::Loaded:
- msg = _("Loaded");
- break;
+ using namespace grfx;
+
+ switch (cache_->loader.status()) {
+ case WaitingToLoad:
+ return _("Not shown.");
+ case Loading:
+ return _("Loading...");
+ case Converting:
+ return _("Converting to loadable format...");
+ case Loaded:
+ return _("Loaded into memory. Must now generate pixmap.");
+ case ScalingEtc:
+ return _("Scaling etc...");
+ case Ready:
+ return _("Ready to display");
+ case ErrorNoFile:
+ return _("No file found!");
+ case ErrorConverting:
+ return _("Error converting to loadable format");
+ case ErrorLoading:
+ return _("Error loading file into memory");
+ case ErrorGeneratingPixmap:
+ return _("Error generating the pixmap");
+ case ErrorUnknown:
+ return _("No image");
}
+ return string();
+}
+
+
+bool InsetGraphics::imageIsDrawable() const
+{
+ if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
+ return false;
- return msg;
+ return cache_->loader.image()->isDrawable();
}
int InsetGraphics::ascent(BufferView *, LyXFont const &) const
{
- grfx::GCache const & gc = grfx::GCache::get();
- grfx::ImagePtr const image_ptr = gc.image(*this);
-
- if (image_ptr.get() && image_ptr->getPixmap())
- return image_ptr->getHeight();
- else
- return 50;
+ cache_->old_ascent = 50;
+ if (imageIsDrawable())
+ cache_->old_ascent = cache_->loader.image()->getHeight();
+ return cache_->old_ascent;
}
int InsetGraphics::descent(BufferView *, LyXFont const &) const
{
- // this is not true if viewport is used and clip is not.
return 0;
}
int InsetGraphics::width(BufferView *, LyXFont const & font) const
{
- grfx::GCache const & gc = grfx::GCache::get();
- grfx::ImagePtr const image_ptr = gc.image(*this);
+ if (imageIsDrawable())
+ return cache_->loader.image()->getWidth() + 2 * TEXT_TO_INSET_OFFSET;
- if (image_ptr.get() && image_ptr->getPixmap())
- return image_ptr->getWidth();
- else {
- int font_width = 0;
+ int font_width = 0;
- LyXFont msgFont(font);
- msgFont.setFamily(LyXFont::SANS_FAMILY);
+ LyXFont msgFont(font);
+ msgFont.setFamily(LyXFont::SANS_FAMILY);
- string const justname = OnlyFilename (params.filename);
- if (!justname.empty()) {
- msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- font_width = lyxfont::width(justname, msgFont);
- }
+ string const justname = OnlyFilename (params().filename);
+ if (!justname.empty()) {
+ msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
+ font_width = font_metrics::width(justname, msgFont);
+ }
- string const msg = statusMessage();
- if (!msg.empty()) {
- msgFont.setSize(LyXFont::SIZE_TINY);
- int const msg_width = lyxfont::width(msg, msgFont);
- font_width = std::max(font_width, msg_width);
- }
-
- return std::max(50, font_width + 15);
+ string const msg = statusMessage();
+ if (!msg.empty()) {
+ msgFont.setSize(LyXFont::SIZE_TINY);
+ int const msg_width = font_metrics::width(msg, msgFont);
+ font_width = std::max(font_width, msg_width);
}
+
+ return std::max(50, font_width + 15);
+}
+
+
+BufferView * InsetGraphics::view() const
+{
+ return cache_->view.lock().get();
}
void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
- int baseline, float & x, bool) const
+ int baseline, float & x) const
{
- Painter & paint = bv->painter();
- grfx::GCache & gc = grfx::GCache::get();
- grfx::ImageStatus const status = gc.status(*this);
+ // MakeAbsPath returns params().filename unchanged if it absolute
+ // already.
+ string const file_with_path =
+ MakeAbsPath(params().filename, bv->buffer()->filePath());
+
+ // A 'paste' operation creates a new inset with the correct filepath,
+ // but then the 'old' inset stored in the 'copy' operation is actually
+ // added to the buffer.
+ // Thus, we should ensure that the filepath is correct.
+ if (file_with_path != cache_->loader.filename())
+ cache_->update(file_with_path);
- // Better to be paranoid and safe!
- grfx::ImagePtr i_ptr = gc.image(*this);
- Pixmap const pixmap = (status == grfx::Loaded && i_ptr.get()) ?
- i_ptr->getPixmap() : 0;
+ cache_->view = bv->owner()->view();
+ int oasc = cache_->old_ascent;
int ldescent = descent(bv, font);
int lascent = ascent(bv, font);
int lwidth = width(bv, font);
- Pixmap const check_pixmap = (status == grfx::Loaded && i_ptr.get()) ?
- i_ptr->getPixmap() : 0;
-
- if (pixmap != check_pixmap) {
- // Tell BufferView we need to be updated!
- bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
- }
+ // we may have changed while someone other was drawing us so better
+ // to not draw anything as we surely call to redraw ourself soon.
+ // This is not a nice thing to do and should be fixed properly somehow.
+ // But I still don't know the best way to go. So let's do this like this
+ // for now (Jug 20020311)
+ if (lascent != oasc)
+ return;
- // Make sure x is updated upon exit from this routine
+ // Make sure now that x is updated upon exit from this routine
int old_x = int(x);
x += lwidth;
- // Initiate the loading of the graphics file
- if (status == grfx::WaitingToLoad) {
- gc.startLoading(*this);
- }
+ grfx::Params const & gparams = params().as_grfxParams();
+
+ if (gparams.display != grfx::NoDisplay &&
+ cache_->loader.status() == grfx::WaitingToLoad)
+ cache_->loader.startLoading();
+
+ if (!cache_->loader.monitoring())
+ cache_->loader.startMonitoring();
// This will draw the graphics. If the graphics has not been loaded yet,
// we draw just a rectangle.
+ Painter & paint = bv->painter();
- if (pixmap != 0) {
-
- paint.image(old_x + 2, baseline - lascent,
- lwidth - 4, lascent + ldescent, i_ptr);
+ if (imageIsDrawable()) {
+ paint.image(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
+ lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent,
+ *cache_->loader.image());
- } else {
+ } else {
- paint.rectangle(old_x + 2, baseline - lascent,
- lwidth - 4,
- lascent + ldescent);
+ paint.rectangle(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
+ lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent);
// Print the file name.
LyXFont msgFont(font);
msgFont.setFamily(LyXFont::SANS_FAMILY);
- string const justname = OnlyFilename (params.filename);
+ string const justname = OnlyFilename (params().filename);
if (!justname.empty()) {
msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- paint.text(old_x + 8,
- baseline - lyxfont::maxAscent(msgFont) - 4,
+ paint.text(old_x + TEXT_TO_INSET_OFFSET + 6,
+ baseline - font_metrics::maxAscent(msgFont) - 4,
justname, msgFont);
}
string const msg = statusMessage();
if (!msg.empty()) {
msgFont.setSize(LyXFont::SIZE_TINY);
- paint.text(old_x + 8, baseline - 4, msg, msgFont);
+ paint.text(old_x + TEXT_TO_INSET_OFFSET + 6, baseline - 4, msg, msgFont);
}
}
}
-// Update the inset after parameters changed (read from file or changed in
-// dialog. The grfx::GCache makes the decisions about whether or not to draw
-// (interogates lyxrc, ascertains whether file exists etc)
-void InsetGraphics::updateInset() const
-{
- grfx::GCache & gc = grfx::GCache::get();
- gc.update(*this);
-}
-
-
-void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
-{
- bv->owner()->getDialogs()->showGraphics(this);
-}
-
-
-void InsetGraphics::edit(BufferView * bv, bool)
-{
- edit(bv, 0, 0, 0);
-}
-
-
Inset::EDITABLE InsetGraphics::editable() const
{
return IS_EDITABLE;
}
-void InsetGraphics::write(Buffer const * buf, ostream & os) const
+void InsetGraphics::write(Buffer const *, ostream & os) const
{
- os << "Graphics FormatVersion " << VersionNumber << '\n';
- params.Write(buf, os);
+ os << "Graphics\n";
+ params().Write(os);
}
string const token = lex.getString();
if (token == "Graphics")
- readInsetGraphics(buf, lex);
- else if (token == "Figure") // Compatibility reading of FigInset figures.
- readFigInset(buf, lex);
+ readInsetGraphics(lex);
else
- lyxerr[Debug::INFO] << "Not a Graphics or Figure inset!\n";
+ lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
- updateInset();
+ cache_->update(MakeAbsPath(params().filename, buf->filePath()));
}
-void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
+
+void InsetGraphics::readInsetGraphics(LyXLex & lex)
{
bool finished = false;
lex.next();
string const token = lex.getString();
- lyxerr[Debug::INFO] << "Token: '" << token << '\''
+ lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
<< std::endl;
if (token.empty()) {
// TODO: Possibly open up a dialog?
}
else {
- if (! params.Read(buf, lex, token))
- lyxerr << "Unknown token, " << token << ", skipping."
+ if (! params_.Read(lex, token))
+ lyxerr << "Unknown token, " << token << ", skipping."
<< std::endl;
}
}
}
-// FormatVersion < 1.0 (LyX < 1.2)
-void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
-{
- std::vector<string> const oldUnits =
- getVectorFromString("pt,cm,in,p%,c%");
- bool finished = false;
- // set the display default
- if (lyxrc.display_graphics == "mono")
- params.display = InsetGraphicsParams::MONOCHROME;
- else if (lyxrc.display_graphics == "gray")
- params.display = InsetGraphicsParams::GRAYSCALE;
- else if (lyxrc.display_graphics == "color")
- params.display = InsetGraphicsParams::COLOR;
- else
- params.display = InsetGraphicsParams::NONE;
- while (lex.isOK() && !finished) {
- lex.next();
-
- string const token = lex.getString();
- lyxerr[Debug::INFO] << "Token: " << token << endl;
-
- if (token.empty())
- continue;
- else if (token == "\\end_inset") {
- finished = true;
- } else if (token == "file") {
- if (lex.next()) {
- string const name = lex.getString();
- string const path = buf->filePath();
- params.filename = MakeAbsPath(name, path);
- }
- } else if (token == "extra") {
- if (lex.next());
- // kept for backwards compability. Delete in 0.13.x
- } else if (token == "subcaption") {
- if (lex.eatLine())
- params.subcaptionText = lex.getString();
- params.subcaption = true;
- } else if (token == "label") {
- if (lex.next());
- // kept for backwards compability. Delete in 0.13.x
- } else if (token == "angle") {
- if (lex.next())
- params.rotate = true;
- params.rotateAngle = lex.getFloat();
- } else if (token == "size") {
- if (lex.next())
- params.lyxwidth = LyXLength(lex.getString()+"pt");
- if (lex.next())
- params.lyxheight = LyXLength(lex.getString()+"pt");
- } else if (token == "flags") {
- if (lex.next())
- switch (lex.getInteger()) {
- case 1: params.display = InsetGraphicsParams::MONOCHROME;
- break;
- case 2: params.display = InsetGraphicsParams::GRAYSCALE;
- break;
- case 3: params.display = InsetGraphicsParams::COLOR;
- break;
- }
- } else if (token == "subfigure") {
- params.subcaption = true;
- } else if (token == "width") {
- if (lex.next()) {
- int i = lex.getInteger();
- if (lex.next()) {
- if (i == 5) {
- params.scale = lex.getInteger();
- params.size_type = InsetGraphicsParams::SCALE;
- } else {
- params.width = LyXLength(lex.getString()+oldUnits[i]);
- params.size_type = InsetGraphicsParams::WH;
- }
- }
- }
- } else if (token == "height") {
- if (lex.next()) {
- int i = lex.getInteger();
- if (lex.next()) {
- params.height = LyXLength(lex.getString()+oldUnits[i]);
- params.size_type = InsetGraphicsParams::WH;
- }
- }
- }
- }
-}
string const InsetGraphics::createLatexOptions() const
{
// stream since we might have a trailing comma that we would like to remove
// before writing it to the output stream.
ostringstream options;
- if (!params.bb.empty())
- options << " bb=" << strip(params.bb) << ",\n";
- if (params.draft)
+ if (!params().bb.empty())
+ options << " bb=" << rtrim(params().bb) << ",\n";
+ if (params().draft)
options << " draft,\n";
- if (params.clip)
+ if (params().clip)
options << " clip,\n";
- if (params.size_type == InsetGraphicsParams::WH) {
- if (!params.width.zero())
- options << " width=" << params.width.asLatexString() << ",\n";
- if (!params.height.zero())
- options << " height=" << params.height.asLatexString() << ",\n";
- } else if (params.size_type == InsetGraphicsParams::SCALE) {
- if (params.scale > 0)
- options << " scale=" << double(params.scale)/100.0 << ",\n";
+ if (!lyx::float_equal(params().scale, 0.0, 0.05)) {
+ if (!lyx::float_equal(params().scale, 100.0, 0.05))
+ options << " scale=" << params().scale / 100.0
+ << ",\n";
+ } else {
+ if (!params().width.zero())
+ options << " width=" << params().width.asLatexString() << ",\n";
+ if (!params().height.zero())
+ options << " height=" << params().height.asLatexString() << ",\n";
+ if (params().keepAspectRatio)
+ options << " keepaspectratio,\n";
}
- if (params.keepAspectRatio)
- options << " keepaspectratio,\n";
- // Make sure it's not very close to zero, a float can be effectively
- // zero but not exactly zero.
- if (!lyx::float_equal(params.rotateAngle, 0, 0.001) && params.rotate) {
- options << " angle=" << params.rotateAngle << ",\n";
- if (!params.rotateOrigin.empty()) {
- options << " origin=" << params.rotateOrigin[0];
- if (contains(params.rotateOrigin,"Top"))
+
+ // Make sure rotation angle is not very close to zero;
+ // a float can be effectively zero but not exactly zero.
+ if (!lyx::float_equal(params().rotateAngle, 0, 0.001)) {
+ options << " angle=" << params().rotateAngle << ",\n";
+ if (!params().rotateOrigin.empty()) {
+ options << " origin=" << params().rotateOrigin[0];
+ if (contains(params().rotateOrigin,"Top"))
options << 't';
- else if (contains(params.rotateOrigin,"Bottom"))
+ else if (contains(params().rotateOrigin,"Bottom"))
options << 'b';
- else if (contains(params.rotateOrigin,"Baseline"))
+ else if (contains(params().rotateOrigin,"Baseline"))
options << 'B';
options << ",\n";
}
}
- if (!params.special.empty())
- options << params.special << ",\n";
- string opts = options.str().c_str();
- return opts.substr(0,opts.size()-2); // delete last ",\n"
+
+ if (!params().special.empty())
+ options << params().special << ",\n";
+
+ string opts = STRCONV(options.str());
+ // delete last ",\n"
+ return opts.substr(0, opts.size() - 2);
}
-namespace {
-string decideOutputImageFormat(string const & suffix)
+
+string const InsetGraphics::prepareFile(Buffer const * buf) const
{
- // lyxrc.pdf_mode means:
- // Are we creating a PDF or a PS file?
- // (Should actually mean, are we using latex or pdflatex).
- lyxerr << "decideOutput::lyxrc.pdf_mode = " << lyxrc.pdf_mode << "\n";
- if (lyxrc.pdf_mode) {
- if (contains(suffix,"ps") || suffix == "pdf")
- return "pdf";
- else if (suffix == "jpg")
- return suffix;
- else
- return "png";
+ // LaTeX can cope if the graphics file doesn't exist, so just return the
+ // filename.
+ string const orig_file = params().filename;
+ string orig_file_with_path =
+ MakeAbsPath(orig_file, buf->filePath());
+ lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
+ << orig_file << "\n\twith path: "
+ << orig_file_with_path << endl;
+
+ if (!IsFileReadable(orig_file_with_path))
+ return orig_file;
+
+ bool const zipped = zippedFile(orig_file_with_path);
+
+ // If the file is compressed and we have specified that it
+ // should not be uncompressed, then just return its name and
+ // let LaTeX do the rest!
+ if (zipped && params().noUnzip) {
+ lyxerr[Debug::GRAPHICS]
+ << "\tpass zipped file to LaTeX but with full path.\n";
+ // LaTeX needs an absolue path, otherwise the
+ // coresponding *.eps.bb file isn't found
+ return orig_file_with_path;
}
- // If it's postscript, we always do eps.
- lyxerr << "decideOutput: we have PostScript mode\n";
- if (suffix != "ps")
- return "eps";
- else
- return "ps";
-}
-
-} // Anon. namespace
-
-string const InsetGraphics::prepareFile(Buffer const *buf) const
-{
- // do_convert = Do we need to convert the file?
- // nice = Do we create a nice version?
- // This is used when exporting the latex file only.
- // if (!do_convert)
- // return original filename
- // if (!nice)
- // convert_place = temp directory
- // return new filename in temp directory
- // else
- // convert_place = original file directory
- // return original filename without the extension
- //
- // first check if file is viewed in LyX. First local
- // than global
- // if it's a zipped one, than let LaTeX do the rest!!!
- if ((zippedFile(params.filename) && params.noUnzip) || buf->niceFile) {
- lyxerr << "don't unzip file or export latex"
- << params.filename << endl;
- return params.filename;
+
+ // Ascertain whether the file has changed.
+ unsigned long const new_checksum = cache_->loader.checksum();
+ bool const file_has_changed = cache_->checksum != new_checksum;
+ if (file_has_changed)
+ cache_->checksum = new_checksum;
+
+ // temp_file will contain the file for LaTeX to act on if, for example,
+ // we move it to a temp dir or uncompress it.
+ string temp_file = orig_file;
+
+ if (zipped) {
+ // Uncompress the file if necessary.
+ // If it has been uncompressed in a previous call to
+ // prepareFile, do nothing.
+ temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
+ lyxerr[Debug::GRAPHICS]
+ << "\ttemp_file: " << temp_file << endl;
+ if (file_has_changed || !IsFileReadable(temp_file)) {
+ bool const success = lyx::copy(orig_file_with_path,
+ temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tCopying zipped file from "
+ << orig_file_with_path << " to " << temp_file
+ << (success ? " succeeded\n" : " failed\n");
+ } else
+ lyxerr[Debug::GRAPHICS]
+ << "\tzipped file " << temp_file
+ << " exists! Maybe no tempdir ...\n";
+ orig_file_with_path = unzipFile(temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tunzipped to " << orig_file_with_path << endl;
+ }
+
+ string const from = getExtFromContents(orig_file_with_path);
+ string const to = findTargetFormat(from);
+ lyxerr[Debug::GRAPHICS]
+ << "\t we have: from " << from << " to " << to << '\n';
+
+ if (from == to && !lyxrc.use_tempdir) {
+ // No conversion is needed. LaTeX can handle the
+ // graphic file as is.
+ // This is true even if the orig_file is compressed.
+ if (formats.getFormat(to)->extension() == GetExtension(orig_file))
+ return RemoveExtension(orig_file_with_path);
+ return orig_file_with_path;
}
- string filename_ = params.filename;
- if (zippedFile(filename_))
- filename_ = unzipFile(filename_);
- // now we have unzipped files
- // Get the extension (format) of the original file.
- // we handle it like a virtual one, so we can have
- // different extensions with the same type.
- string const extension = getExtFromContents(filename_);
- // are we usind latex ((e)ps) or pdflatex (pdf,jpg,png)
- string const image_target = decideOutputImageFormat(extension);
- if (extension == image_target) // :-)
- return filename_;
- if (!IsFileReadable(filename_)) { // :-(
- Alert::alert(_("File") + params.filename,
- _("isn't readable or doesn't exists!"));
- return filename_;
+
+ // We're going to be running the exported buffer through the LaTeX
+ // compiler, so must ensure that LaTeX can cope with the graphics
+ // file format.
+
+ // Perform all these manipulations on a temporary file if possible.
+ // If we are not using a temp dir, then temp_file contains the
+ // original file.
+ // to allow files with the same name in different dirs
+ // we manipulate the original file "any.dir/file.ext"
+ // to "any_dir_file.ext"! changing the dots in the
+ // dirname is important for the use of ChangeExtension
+ lyxerr[Debug::GRAPHICS]
+ << "\tthe orig file is: " << orig_file_with_path << endl;
+
+ if (lyxrc.use_tempdir) {
+ string const ext_tmp = GetExtension(orig_file_with_path);
+ // without ext and /
+ temp_file = subst(
+ ChangeExtension(orig_file_with_path, string()), "/", "_");
+ // without dots and again with ext
+ temp_file = ChangeExtension(
+ subst(temp_file, ".", "_"), ext_tmp);
+ // now we have any_dir_file.ext
+ temp_file = MakeAbsPath(temp_file, buf->tmppath);
+ lyxerr[Debug::GRAPHICS]
+ << "\tchanged to: " << temp_file << endl;
+
+ // if the file doen't exists, copy it into the tempdir
+ if (file_has_changed || !IsFileReadable(temp_file)) {
+ bool const success = lyx::copy(orig_file_with_path, temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tcopying from " << orig_file_with_path << " to "
+ << temp_file
+ << (success ? " succeeded\n" : " failed\n");
+ if (!success) {
+#if USE_BOOST_FORMAT
+ boost::format fmt(_("Could not copy the file\n%1$s\ninto the temporary directory."));
+ fmt % orig_file_with_path;
+ string str = fmt.str();
+#else
+ string str = _("Could not copy the file\n");
+ str += orig_file_with_path;
+ str += _("\ninto the temporary directory.");
+#endif
+ Alert::error(_("Graphics display failed"), str);
+ return orig_file;
+ }
+ }
+
+ if (from == to) {
+ // No conversion is needed. LaTeX can handle the
+ // graphic file as is.
+ if (formats.getFormat(to)->extension() == GetExtension(orig_file))
+ return RemoveExtension(temp_file);
+ return temp_file;
+ }
}
- string outfile;
- string const temp = AddName(buf->tmppath, filename_);
- outfile = RemoveExtension(temp);
- lyxerr << "tempname = " << temp << "\n";
- lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
- lyxerr << "filename_ = " << filename_ << "\n";
- lyxerr << "outfile = " << outfile << endl;
- converters.convert(buf, filename_, outfile, extension, image_target);
- return outfile;
+
+ string const outfile_base = RemoveExtension(temp_file);
+ lyxerr[Debug::GRAPHICS]
+ << "\tThe original file is " << orig_file << "\n"
+ << "\tA copy has been made and convert is to be called with:\n"
+ << "\tfile to convert = " << temp_file << '\n'
+ << "\toutfile_base = " << outfile_base << '\n'
+ << "\t from " << from << " to " << to << '\n';
+
+ // if no special converter defined, than we take the default one
+ // from ImageMagic: convert from:inname.from to:outname.to
+ if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
+ string const command =
+ LibFileSearch("scripts", "convertDefault.sh") +
+ ' ' + from + ':' + temp_file + ' ' +
+ to + ':' + outfile_base + '.' + to;
+ lyxerr[Debug::GRAPHICS]
+ << "No converter defined! I use convertDefault.sh:\n\t"
+ << command << endl;
+ Systemcall one;
+ one.startscript(Systemcall::Wait, command);
+ if (!IsFileReadable(ChangeExtension(outfile_base, to))) {
+#if USE_BOOST_FORMAT
+ boost::format fmt(_("No information for converting %1$s format files to %1$s.\n"
+ "Try defining a convertor in the preferences."));
+ fmt % from % to;
+ string str = fmt.str();
+#else
+ string str = _("No information for converting ");
+ str += from + _(" format files to ") + to;
+ str += _(".\nTry defining a convertor in the preferences.");
+#endif
+ Alert::error(_("Could not convert image"), str);
+ }
+ }
+
+ return RemoveExtension(temp_file);
}
-int InsetGraphics::latex(Buffer const *buf, ostream & os,
+int InsetGraphics::latex(Buffer const * buf, ostream & os,
bool /*fragile*/, bool/*fs*/) const
{
- // If there is no file specified, just output a message about it in
- // the latex output.
- if (params.filename.empty()) {
- os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
- << _("empty figure path") << "}\n";
- return 1; // One end of line marker added to the stream.
- }
- // Keep count of newlines that we issued.
-#warning the newlines=0 were in the original code. where is the sense? (Herbert)
- int newlines = 0;
- // This variables collect all the latex code that should be before and
+ // If there is no file specified or not existing,
+ // just output a message about it in the latex output.
+ lyxerr[Debug::GRAPHICS]
+ << "insetgraphics::latex: Filename = "
+ << params().filename << endl;
+
+ // A missing (e)ps-extension is no problem for LaTeX, so
+ // we have to test three different cases
+ string const file_ = MakeAbsPath(params().filename, buf->filePath());
+ bool const file_exists =
+ !file_.empty() &&
+ (IsFileReadable(file_) || // original
+ IsFileReadable(file_ + ".eps") || // original.eps
+ IsFileReadable(file_ + ".ps")); // original.ps
+ string const message = file_exists ?
+ string() : string("bb = 0 0 200 100, draft, type=eps");
+ // if !message.empty() than there was no existing file
+ // "filename(.(e)ps)" found. In this case LaTeX
+ // draws only a rectangle with the above bb and the
+ // not found filename in it.
+ lyxerr[Debug::GRAPHICS]
+ << "\tMessage = \"" << message << '\"' << endl;
+
+ // These variables collect all the latex code that should be before and
// after the actual includegraphics command.
string before;
string after;
// Do we want subcaptions?
- if (params.subcaption) {
- before += "\\subfigure[" + params.subcaptionText + "]{";
- after = '}' + after;
+ if (params().subcaption) {
+ before += "\\subfigure[" + params().subcaptionText + "]{";
+ after = '}';
}
// We never use the starred form, we use the "clip" option instead.
- os << before << "\\includegraphics";
+ before += "\\includegraphics";
+
// Write the options if there are any.
string const opts = createLatexOptions();
- if (!opts.empty()) {
- os << "[%\n" << opts << ']';
+ lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
+
+ if (!opts.empty() && !message.empty())
+ before += ("[%\n" + opts + ',' + message + ']');
+ else if (!opts.empty() || !message.empty())
+ before += ("[%\n" + opts + message + ']');
+
+ lyxerr[Debug::GRAPHICS]
+ << "\tBefore = " << before
+ << "\n\tafter = " << after << endl;
+
+
+ // "nice" means that the buffer is exported to LaTeX format but not
+ // run through the LaTeX compiler.
+ if (buf->niceFile) {
+ os << before <<'{' << params().filename << '}' << after;
+ return 1;
}
+
// Make the filename relative to the lyx file
// and remove the extension so the LaTeX will use whatever is
// appropriate (when there are several versions in different formats)
- string const filename = prepareFile(buf);
- os << '{' << filename << '}' << after;
+ string const latex_str = message.empty() ?
+ (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
+ (before + '{' + params().filename + " not found!}" + after);
+ os << latex_str;
+
// Return how many newlines we issued.
- return newlines;
+ return int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
}
// 1. Convert file to ascii using gifscii
// 2. Read ascii output file and add it to the output stream.
// at least we send the filename
- os << '<' << _("Graphicfile:") << params.filename << ">\n";
+ os << '<' << bformat(_("Graphics file: %1$s"), params().filename) << ">\n";
return 0;
}
// For explanation on inserting graphics into DocBook checkout:
// http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(Buffer const * buf, ostream & os) const
+int InsetGraphics::docbook(Buffer const *, ostream & os,
+ bool /*mixcont*/) const
{
- // Change the path to be relative to the main file.
- string const buffer_dir = buf->filePath();
- string filename = RemoveExtension(
- MakeRelPath(params.filename, buffer_dir));
-
- if (suffixIs(filename, ".eps"))
- filename.erase(filename.length() - 4);
-
- // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
- // need to switch to MediaObject. However, for now this is sufficient and
+ // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
+ // need to switch to MediaObject. However, for now this is sufficient and
// easier to use.
- os << "<graphic fileref=\"" << filename << "\"></graphic>";
+ os << "<graphic fileref=\"&" << graphic_label << ";\">";
return 0;
}
void InsetGraphics::validate(LaTeXFeatures & features) const
{
// If we have no image, we should not require anything.
- if (params.filename.empty())
- return ;
+ if (params().filename.empty())
+ return;
+
+ features.includeFile(graphic_label, RemoveExtension(params().filename));
features.require("graphicx");
- if (params.subcaption)
+ if (params().subcaption)
features.require("subfigure");
}
-bool InsetGraphics::setParams(InsetGraphicsParams const & p)
+void InsetGraphics::statusChanged()
+{
+ if (!cache_->view.expired())
+ cache_->view.lock()->updateInset(this);
+}
+
+
+bool InsetGraphics::setParams(InsetGraphicsParams const & p,
+ string const & filepath)
{
// If nothing is changed, just return and say so.
- if (params == p)
+ if (params() == p && !p.filename.empty())
return false;
// Copy the new parameters.
- params = p;
+ params_ = p;
// Update the inset with the new parameters.
- updateInset();
+ cache_->update(MakeAbsPath(params().filename, filepath));
// We have changed data, report it.
return true;
}
-InsetGraphicsParams InsetGraphics::getParams() const
+InsetGraphicsParams const & InsetGraphics::params() const
+{
+ return params_;
+}
+
+
+string const InsetGraphicsMailer::name_("graphics");
+
+InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetGraphicsMailer::inset2string() const
{
- return params;
+ return params2string(inset_.params());
}
-Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
+void InsetGraphicsMailer::string2params(string const & in,
+ InsetGraphicsParams & params)
{
- return new InsetGraphics(*this, same_id);
+ params = InsetGraphicsParams();
+
+ if (in.empty())
+ return;
+
+ istringstream data(STRCONV(in));
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ if (lex.isOK()) {
+ lex.next();
+ string const token = lex.getString();
+ if (token != name_)
+ return;
+ }
+
+ if (lex.isOK()) {
+ InsetGraphics inset;
+ inset.readInsetGraphics(lex);
+ params = inset.params();
+ }
}
+
+string const
+InsetGraphicsMailer::params2string(InsetGraphicsParams const & params)
+{
+ ostringstream data;
+ data << name_ << ' ';
+ params.Write(data);
+ data << "\\end_inset\n";
+ return STRCONV(data.str());
+}
projects / lyx.git / blobdiff