-/* 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
-
-TODO Before initial production release:
+TODO
* What advanced features the users want to do?
Implement them in a non latex dependent way, but a logical way.
* 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.
#include "graphics/GraphicsImage.h"
#include "graphics/GraphicsParams.h"
-#include "frontends/LyXView.h"
#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "debug.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
+#include "lyxlex.h"
-#include "frontends/Dialogs.h"
#include "frontends/Alert.h"
+#include "frontends/Dialogs.h"
+#include "frontends/LyXView.h"
+
#include "frontends/controllers/helper_funcs.h" // getVectorFromString
#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/systemcall.h"
#include "support/os.h"
+#include <boost/weak_ptr.hpp>
#include <boost/bind.hpp>
#include <boost/signals/trackable.hpp>
+#include "BoostFormat.h"
#include <algorithm> // For the std::max
-// Very, Very UGLY!
-extern BufferView * current_view;
-
extern string system_tempdir;
using std::ostream;
using std::endl;
+
+namespace {
+
///////////////////////////////////////////////////////////////////////////
int const VersionNumber = 1;
///////////////////////////////////////////////////////////////////////////
-namespace {
-
// This function is a utility function
// ... that should be with ChangeExtension ...
inline
return ChangeExtension(filename, string());
}
-} // namespace anon
-
-
-namespace {
string const uniqueID()
{
ost << "graph" << ++seed;
// Needed if we use lyxstring.
- return ost.str().c_str();
+ return STRCONV(ost.str());
+}
+
+
+string findTargetFormat(string const & suffix)
+{
+ // lyxrc.pdf_mode means:
+ // Are we creating a PDF or a PS file?
+ // (Should actually mean, are we using latex or pdflatex).
+ if (lyxrc.pdf_mode) {
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
+ if (contains(suffix, "ps") || suffix == "pdf")
+ return "pdf";
+ else if (suffix == "jpg") // pdflatex can use jpeg
+ return suffix;
+ else
+ 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
+ else
+ return suffix; // let ps untouched
}
} // namespace anon
int old_ascent;
///
grfx::Loader loader;
+ ///
+ unsigned long checksum;
+ ///
+ boost::weak_ptr<BufferView> view;
private:
///
InsetGraphics::Cache::Cache(InsetGraphics & p)
- : old_ascent(0), parent_(p)
+ : old_ascent(0), checksum(0), parent_(p)
{
- loader.statusChanged.connect(
- boost::bind(&InsetGraphics::statusChanged, &parent_));
+ loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
}
if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
return false;
- return cache_->loader.image()->getPixmap() != 0;
+ return cache_->loader.image()->isDrawable();
}
void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
int baseline, float & x, bool) const
{
+ // 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);
+
+ cache_->view = bv->owner()->view();
int oasc = cache_->old_ascent;
int ldescent = descent(bv, font);
int old_x = int(x);
x += lwidth;
- if (cache_->loader.status() == grfx::WaitingToLoad) {
+ if (cache_->loader.status() == grfx::WaitingToLoad)
cache_->loader.startLoading(*this, *bv);
- }
+
+ 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.
void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
{
- bv->owner()->getDialogs()->showGraphics(this);
+ bv->owner()->getDialogs().showGraphics(this);
}
void InsetGraphics::write(Buffer const *, ostream & os) const
{
- os << "Graphics FormatVersion " << VersionNumber << '\n';
+ os << "Graphics\n";
params().Write(os);
}
if (token == "Graphics")
readInsetGraphics(lex);
- else if (token == "Figure") // Compatibility reading of FigInset figures.
- readFigInset(lex);
else
- lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
+ lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
cache_->update(MakeAbsPath(params().filename, buf->filePath()));
}
}
}
-// FormatVersion < 1.0 (LyX < 1.2)
-void InsetGraphics::readFigInset(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::GRAPHICS] << "Token: " << token << endl;
-
- if (token.empty())
- continue;
- else if (token == "\\end_inset") {
- finished = true;
- } else if (token == "file") {
- if (lex.next()) {
- params_.filename = lex.getString();
- }
- } 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();
- } 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");
- params_.lyxsize_type = InsetGraphicsParams::WH;
- } 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
{
// before writing it to the output stream.
ostringstream options;
if (!params().bb.empty())
- options << " bb=" << strip(params().bb) << ",\n";
+ options << " bb=" << rtrim(params().bb) << ",\n";
if (params().draft)
options << " draft,\n";
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) {
+
+ // 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];
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"
-}
-namespace {
-string findTargetFormat(string const & suffix)
-{
- // lyxrc.pdf_mode means:
- // Are we creating a PDF or a PS file?
- // (Should actually mean, are we using latex or pdflatex).
- if (lyxrc.pdf_mode) {
- lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
- if (contains(suffix,"ps") || suffix == "pdf")
- return "pdf";
- else if (suffix == "jpg") // pdflatex can use jpeg
- return suffix;
- else
- 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
- else
- return suffix; // let ps untouched
+ string opts = STRCONV(options.str());
+ // delete last ",\n"
+ return opts.substr(0, opts.size() - 2);
}
-} // Anon. namespace
-
-string const InsetGraphics::prepareFile(Buffer const *buf) const
+string const InsetGraphics::prepareFile(Buffer const * buf) const
{
// LaTeX can cope if the graphics file doesn't exist, so just return the
// filename.
if (!IsFileReadable(orig_file_with_path))
return orig_file;
- // 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!
-
- // maybe that other zip extensions also be useful, especially the
- // ones that may be declared in texmf/tex/latex/config/graphics.cfg.
- // for example:
- /* -----------snip-------------
- {\DeclareGraphicsRule{.pz}{eps}{.bb}{}%
- \DeclareGraphicsRule{.eps.Z}{eps}{.eps.bb}{}%
- \DeclareGraphicsRule{.ps.Z}{eps}{.ps.bb}{}%
- \DeclareGraphicsRule{.ps.gz}{eps}{.ps.bb}{}%
- \DeclareGraphicsRule{.eps.gz}{eps}{.eps.bb}{}}}%
- -----------snip-------------*/
-
bool const zipped = zippedFile(orig_file_with_path);
- if (zipped)
- lyxerr[Debug::GRAPHICS] << "\twe have a zipped file ("
- << getExtFromContents(orig_file_with_path) << ")\n";
- if (params().noUnzip && zipped) {
+
+ // 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 file unzipped to LaTeX but with full path.\n";
- // latex needs an absolue path, otherwise the coresponding
- // *.eps.bb file isn't found
+ << "\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;
}
+ // 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);
- // Uncompress the file if necessary. If it has been uncompressed in
- // a previous call to prepareFile, do nothing.
+
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 (!IsFileReadable(temp_file)) {
- bool const success = lyx::copy(orig_file_with_path, temp_file);
+ 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
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';
- // "nice" means that the buffer is exported to LaTeX format but not
- // run through the LaTeX compiler.
- // if (nice)
- // No conversion of the graphics file is needed.
- // Return the original filename without any extension.
- if (buf->niceFile)
- return RemoveExtension(orig_file);
+ 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.
+ return RemoveExtension(orig_file_with_path);
// We're going to be running the exported buffer through the LaTeX
// compiler, so must ensure that LaTeX can cope with the graphics
lyxerr[Debug::GRAPHICS]
<< "\tchanged to: " << temp_file << endl;
- // if the file doen't exists, copy it into the tempdi
- if (!IsFileReadable(temp_file)) {
+ // 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 "
return orig_file;
}
}
- }
- string const to = findTargetFormat(from);
- lyxerr[Debug::GRAPHICS]
- << "\t we have: from " << from << " to " << to << '\n';
- if (from == to) {
- // No conversion is needed. LaTeX can handle the graphic file as is.
- // This is true even if the orig_file is compressed. We have to return
- // the orig_file_with_path, maybe it is a zipped one
- if (lyxrc.use_tempdir)
+ if (from == to)
+ // No conversion is needed. LaTeX can handle the
+ // graphic file as is.
return RemoveExtension(temp_file);
- return RemoveExtension(orig_file_with_path);
}
string const outfile_base = RemoveExtension(temp_file);
// from ImageMagic: convert from:inname.from to:outname.to
if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
string const command =
- "convert " +
- from + ':' + temp_file + ' ' +
- to + ':' + outfile_base + '.' + to;
+ LibFileSearch("scripts", "convertDefault.sh") +
+ ' ' + from + ':' + temp_file + ' ' +
+ to + ':' + outfile_base + '.' + to;
lyxerr[Debug::GRAPHICS]
- << "No converter defined! I use convert from ImageMagic:\n\t"
+ << "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
+ Alert::alert(_("Cannot convert Image (not existing file?)"),
+ boost::io::str(boost::format(_("No information for converting from %1$s to %2$s"))
+ % from % to));
+#else
Alert::alert(_("Cannot convert Image (not existing file?)"),
- _("No information for converting from ")
- + from + _(" to ") + to);
+ _("No information for converting from ") + from + " to " + to);
+#endif
}
return RemoveExtension(temp_file);
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]");
+ 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
lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
if (!opts.empty() && !message.empty())
- before += ("[%\n" + opts + ',' + message);
- else if (!message.empty())
- before += ("[%\n" + message);
- else if (!opts.empty())
- before += ("[%\n" + opts + ']');
+ 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)
// 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 << '<' << _("Graphic file:") << params().filename << ">\n";
+#if USE_BOOST_FORMAT
+ os << '<'
+ << boost::format(_("Graphic file: %1$s")) % params().filename
+ << ">\n";
+#else
+ os << '<'
+ << _("Graphic file: ") << params().filename
+ << ">\n";
+#endif
return 0;
}
void InsetGraphics::statusChanged()
{
- current_view->updateInset(this, false);
+ if (cache_->view.get())
+ cache_->view.get()->updateInset(this, false);
}