* Licence details can be found in the file COPYING.
*
* \author Baruch Even
- * \author Herbert Voss
+ * \author Herbert Voß
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
/*
/* NOTES:
* Fileformat:
- * Current version is 1 (inset file format version), when changing it
- * it should be changed in the Write() function when writing in one place
- * 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.
*
#include <config.h>
-
#include "insets/insetgraphics.h"
-#include "insets/insetgraphicsParams.h"
-
-#include "graphics/GraphicsLoader.h"
-#include "graphics/GraphicsImage.h"
-#include "graphics/GraphicsParams.h"
+#include "insets/render_graphic.h"
-#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
-#include "frontends/Painter.h"
-#include "lyxrc.h"
-#include "frontends/font_metrics.h"
+#include "cursor.h"
#include "debug.h"
+#include "dispatchresult.h"
+#include "exporter.h"
+#include "format.h"
+#include "funcrequest.h"
+#include "FuncStatus.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
+#include "lyx_main.h"
+#include "lyxlength.h"
#include "lyxlex.h"
+#include "metricsinfo.h"
+#include "mover.h"
+#include "outputparams.h"
+#include "sgml.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/convert.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/lyxlib.h" // lyx::sum
+#include "support/lstrings.h"
#include "support/os.h"
+#include "support/systemcall.h"
-#include <boost/weak_ptr.hpp>
#include <boost/bind.hpp>
-#include <boost/signals/trackable.hpp>
-#include "BoostFormat.h"
-
-#include <algorithm> // For the std::max
+#include <boost/tuple/tuple.hpp>
+
+#include <sstream>
+
+namespace support = lyx::support;
+
+using lyx::support::AbsolutePath;
+using lyx::support::bformat;
+using lyx::support::ChangeExtension;
+using lyx::support::compare_timestamps;
+using lyx::support::contains;
+using lyx::support::FileName;
+using lyx::support::float_equal;
+using lyx::support::GetExtension;
+using lyx::support::IsFileReadable;
+using lyx::support::latex_path;
+using lyx::support::OnlyFilename;
+using lyx::support::rtrim;
+using lyx::support::subst;
+using lyx::support::Systemcall;
+using lyx::support::unzipFile;
+using lyx::support::unzippedFileName;
+
+namespace os = lyx::support::os;
-extern string system_tempdir;
-
-using std::ostream;
using std::endl;
+using std::string;
+using std::auto_ptr;
+using std::istringstream;
+using std::ostream;
+using std::ostringstream;
namespace {
-///////////////////////////////////////////////////////////////////////////
-int const VersionNumber = 1;
-///////////////////////////////////////////////////////////////////////////
-
// This function is a utility function
// ... that should be with ChangeExtension ...
inline
}
-string const uniqueID()
-{
- static unsigned int seed = 1000;
-
- ostringstream ost;
- ost << "graph" << ++seed;
-
- // Needed if we use lyxstring.
- return STRCONV(ost.str());
-}
-
-
-string findTargetFormat(string const & suffix)
+string findTargetFormat(string const & format, OutputParams const & runparams)
{
- // 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")
+ // Are we using latex or pdflatex?
+ if (runparams.flavor == OutputParams::PDFLATEX) {
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
+ // Convert postscript to pdf
+ if (format == "eps" || format == "ps")
return "pdf";
- else if (suffix == "jpg") // pdflatex can use jpeg
- return suffix;
- else
- return "png"; // and also png
+ // pdflatex can use jpeg, png and pdf directly
+ if (format == "jpg" || format == "pdf")
+ return format;
+ // Convert everything else to png
+ return "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
+ lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode" << endl;
+ if (format != "ps")
+ // any other than ps is changed to eps
+ return "eps";
+ // let ps untouched
+ return format;
}
} // 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_));
-}
+InsetGraphics::InsetGraphics()
+ : graphic_label(sgml::uniqueID("graph")),
+ graphic_(new RenderGraphic(this))
+{}
-void InsetGraphics::Cache::update(string const & file_with_path)
+InsetGraphics::InsetGraphics(InsetGraphics const & ig)
+ : InsetOld(ig),
+ boost::signals::trackable(),
+ graphic_label(sgml::uniqueID("graph")),
+ graphic_(new RenderGraphic(*ig.graphic_, this))
{
- lyx::Assert(!file_with_path.empty());
-
- string const path = OnlyPath(file_with_path);
- loader.reset(file_with_path, parent_.params().as_grfxParams(path));
+ setParams(ig.params());
}
-InsetGraphics::InsetGraphics()
- : graphic_label(uniqueID()),
- cache_(new Cache(*this))
-{}
-
-
-InsetGraphics::InsetGraphics(InsetGraphics const & ig,
- string const & filepath,
- bool same_id)
- : Inset(ig, same_id),
- graphic_label(uniqueID()),
- cache_(new Cache(*this))
+auto_ptr<InsetBase> InsetGraphics::doClone() const
{
- setParams(ig.params(), filepath);
+ return auto_ptr<InsetBase>(new InsetGraphics(*this));
}
InsetGraphics::~InsetGraphics()
{
- // Emits the hide signal to the dialog connected (if any)
- hideDialog();
+ InsetGraphicsMailer(*this).hideDialog();
}
-string const InsetGraphics::statusMessage() const
+void InsetGraphics::doDispatch(LCursor & cur, FuncRequest & cmd)
{
- string msg;
-
- switch (cache_->loader.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::Loaded:
- msg = _("Loaded into memory. Must now generate pixmap.");
- break;
- case grfx::ScalingEtc:
- msg = _("Scaling etc...");
- break;
- case grfx::Ready:
- msg = _("Ready to display");
- break;
- case grfx::ErrorNoFile:
- msg = _("No file found!");
- break;
- case grfx::ErrorConverting:
- msg = _("Error converting to loadable format");
- break;
- case grfx::ErrorLoading:
- msg = _("Error loading file into memory");
- break;
- case grfx::ErrorGeneratingPixmap:
- msg = _("Error generating the pixmap");
- break;
- case grfx::ErrorUnknown:
- msg = _("No image");
+ switch (cmd.action) {
+ case LFUN_GRAPHICS_EDIT: {
+ Buffer const & buffer = *cur.bv().buffer();
+ InsetGraphicsParams p;
+ InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
+ editGraphics(p, buffer);
break;
}
- return msg;
-}
-
-
-bool InsetGraphics::imageIsDrawable() const
-{
- if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
- return false;
-
- return cache_->loader.image()->isDrawable();
-}
-
+ case LFUN_INSET_MODIFY: {
+ Buffer const & buffer = cur.buffer();
+ InsetGraphicsParams p;
+ InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
+ if (!p.filename.empty())
+ setParams(p);
+ else
+ cur.noUpdate();
+ break;
+ }
-int InsetGraphics::ascent(BufferView *, LyXFont const &) const
-{
- cache_->old_ascent = 50;
- if (imageIsDrawable())
- cache_->old_ascent = cache_->loader.image()->getHeight();
- return cache_->old_ascent;
-}
+ case LFUN_INSET_DIALOG_UPDATE:
+ InsetGraphicsMailer(*this).updateDialog(&cur.bv());
+ break;
+ case LFUN_MOUSE_RELEASE:
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
+ break;
-int InsetGraphics::descent(BufferView *, LyXFont const &) const
-{
- return 0;
+ default:
+ InsetBase::doDispatch(cur, cmd);
+ break;
+ }
}
-int InsetGraphics::width(BufferView *, LyXFont const & font) const
+bool InsetGraphics::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
{
- if (imageIsDrawable())
- return cache_->loader.image()->getWidth() + 2 * TEXT_TO_INSET_OFFSET;
- else {
- int font_width = 0;
-
- LyXFont msgFont(font);
- msgFont.setFamily(LyXFont::SANS_FAMILY);
-
- 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 = font_metrics::width(msg, msgFont);
- font_width = std::max(font_width, msg_width);
- }
-
- return std::max(50, font_width + 15);
+ switch (cmd.action) {
+ case LFUN_GRAPHICS_EDIT:
+ case LFUN_INSET_MODIFY:
+ case LFUN_INSET_DIALOG_UPDATE:
+ flag.enabled(true);
+ return true;
+
+ default:
+ return InsetBase::getStatus(cur, cmd, flag);
}
}
-void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
- int baseline, float & x, bool) const
+void InsetGraphics::edit(LCursor & cur, bool)
{
- // 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 lascent = ascent(bv, font);
- int lwidth = width(bv, font);
-
- // 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 now that x is updated upon exit from this routine
- int old_x = int(x);
- x += lwidth;
-
- 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.
- Painter & paint = bv->painter();
-
- if (imageIsDrawable()) {
- paint.image(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
- lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent,
- *cache_->loader.image());
-
- } else {
-
- 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);
- if (!justname.empty()) {
- msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- paint.text(old_x + TEXT_TO_INSET_OFFSET + 6,
- baseline - font_metrics::maxAscent(msgFont) - 4,
- justname, msgFont);
- }
-
- // Print the message.
- string const msg = statusMessage();
- if (!msg.empty()) {
- msgFont.setSize(LyXFont::SIZE_TINY);
- paint.text(old_x + TEXT_TO_INSET_OFFSET + 6, baseline - 4, msg, msgFont);
- }
- }
-
- // the status message may mean we changed size, so indicate
- // we need a row redraw
-#if 0
- if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
- bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
- }
-#endif
-
- // Reset the cache, ready for the next draw request
-#if 0
- cached_status_ = grfx::ErrorUnknown;
- cached_image_.reset();
- cache_filled_ = false;
-#endif
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
}
-void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
+void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
{
- bv->owner()->getDialogs().showGraphics(this);
+ graphic_->metrics(mi, dim);
+ dim_ = dim;
}
-void InsetGraphics::edit(BufferView * bv, bool)
+void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
{
- edit(bv, 0, 0, mouse_button::none);
+ setPosCache(pi, x, y);
+ graphic_->draw(pi, x, y);
}
-Inset::EDITABLE InsetGraphics::editable() const
+InsetBase::EDITABLE InsetGraphics::editable() const
{
return IS_EDITABLE;
}
-void InsetGraphics::write(Buffer const *, ostream & os) const
+void InsetGraphics::write(Buffer const & buf, ostream & os) const
{
os << "Graphics\n";
- params().Write(os);
+ params().Write(os, buf.filePath());
}
-void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
+void InsetGraphics::read(Buffer const & buf, LyXLex & lex)
{
string const token = lex.getString();
if (token == "Graphics")
- readInsetGraphics(lex);
+ readInsetGraphics(lex, buf.filePath());
else
- lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
+ lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!" << endl;
- cache_->update(MakeAbsPath(params().filename, buf->filePath()));
+ graphic_->update(params().as_grfxParams());
}
-void InsetGraphics::readInsetGraphics(LyXLex & lex)
+void InsetGraphics::readInsetGraphics(LyXLex & lex, string const & bufpath)
{
bool finished = false;
string const token = lex.getString();
lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
- << std::endl;
+ << endl;
if (token.empty()) {
continue;
} else if (token == "\\end_inset") {
finished = true;
- } else if (token == "FormatVersion") {
- lex.next();
- int version = lex.getInteger();
- if (version > VersionNumber)
- lyxerr
- << "This document was created with a newer Graphics widget"
- ", You should use a newer version of LyX to read this"
- " file."
- << std::endl;
- // TODO: Possibly open up a dialog?
- }
- else {
- if (! params_.Read(lex, token))
+ } else {
+ if (!params_.Read(lex, token, bufpath))
lyxerr << "Unknown token, " << token << ", skipping."
<< std::endl;
}
// before writing it to the output stream.
ostringstream options;
if (!params().bb.empty())
- options << " bb=" << rtrim(params().bb) << ",\n";
+ options << "bb=" << rtrim(params().bb) << ',';
if (params().draft)
- options << " draft,\n";
+ options << "draft,";
if (params().clip)
- options << " clip,\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";
+ options << "clip,";
+ double const scl = convert<double>(params().scale);
+ if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
+ if (!float_equal(scl, 100.0, 0.05))
+ options << "scale=" << scl / 100.0 << ',';
} else {
if (!params().width.zero())
- options << " width=" << params().width.asLatexString() << ",\n";
+ options << "width=" << params().width.asLatexString() << ',';
if (!params().height.zero())
- options << " height=" << params().height.asLatexString() << ",\n";
+ options << "height=" << params().height.asLatexString() << ',';
if (params().keepAspectRatio)
- options << " keepaspectratio,\n";
+ options << "keepaspectratio,";
}
// 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().rotateAngle.empty()
+ && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
+ options << "angle=" << params().rotateAngle << ',';
if (!params().rotateOrigin.empty()) {
- options << " origin=" << params().rotateOrigin[0];
+ options << "origin=" << params().rotateOrigin[0];
if (contains(params().rotateOrigin,"Top"))
options << 't';
else if (contains(params().rotateOrigin,"Bottom"))
options << 'b';
else if (contains(params().rotateOrigin,"Baseline"))
options << 'B';
- options << ",\n";
+ options << ',';
}
}
if (!params().special.empty())
- options << params().special << ",\n";
+ options << params().special << ',';
- string opts = STRCONV(options.str());
- // delete last ",\n"
- return opts.substr(0, opts.size() - 2);
+ string opts = options.str();
+ // delete last ','
+ return opts.substr(0, opts.size() - 1);
}
-string const InsetGraphics::prepareFile(Buffer const * buf) const
+string const InsetGraphics::toDocbookLength(LyXLength const & len) const
{
- // 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;
+ ostringstream result;
+ switch (len.unit()) {
+ case LyXLength::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
+ result << len.value() * 65536.0 * 72 / 72.27 << "pt";
+ break;
+ case LyXLength::PT: // Point = 1/72.27in = 0.351mm
+ result << len.value() * 72 / 72.27 << "pt";
+ break;
+ case LyXLength::BP: // Big point (72bp = 1in), also PostScript point
+ result << len.value() << "pt";
+ break;
+ case LyXLength::DD: // Didot point = 1/72 of a French inch, = 0.376mm
+ result << len.value() * 0.376 << "mm";
+ break;
+ case LyXLength::MM: // Millimeter = 2.845pt
+ result << len.value() << "mm";
+ break;
+ case LyXLength::PC: // Pica = 12pt = 4.218mm
+ result << len.value() << "pc";
+ break;
+ case LyXLength::CC: // Cicero = 12dd = 4.531mm
+ result << len.value() * 4.531 << "mm";
+ break;
+ case LyXLength::CM: // Centimeter = 10mm = 2.371pc
+ result << len.value() << "cm";
+ break;
+ case LyXLength::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
+ result << len.value() << "in";
+ break;
+ case LyXLength::EX: // Height of a small "x" for the current font.
+ // Obviously we have to compromise here. Any better ratio than 1.5 ?
+ result << len.value() / 1.5 << "em";
+ break;
+ case LyXLength::EM: // Width of capital "M" in current font.
+ result << len.value() << "em";
+ break;
+ case LyXLength::MU: // Math unit (18mu = 1em) for positioning in math mode
+ result << len.value() * 18 << "em";
+ break;
+ case LyXLength::PTW: // Percent of TextWidth
+ case LyXLength::PCW: // Percent of ColumnWidth
+ case LyXLength::PPW: // Percent of PageWidth
+ case LyXLength::PLW: // Percent of LineWidth
+ case LyXLength::PTH: // Percent of TextHeight
+ case LyXLength::PPH: // Percent of Paper
+ // Sigh, this will go wrong.
+ result << len.value() << "%";
+ break;
+ default:
+ result << len.asString();
+ break;
+ }
+ return result.str();
+}
- if (!IsFileReadable(orig_file_with_path))
- return orig_file;
+string const InsetGraphics::createDocBookAttributes() const
+{
+ // Calculate the options part of the command, we must do it to a string
+ // stream since we copied the code from createLatexParams() ;-)
- bool const zipped = zippedFile(orig_file_with_path);
+ // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
+ // Right now it only works with my version of db2latex :-)
- // 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) {
+ ostringstream options;
+ double const scl = convert<double>(params().scale);
+ if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
+ if (!float_equal(scl, 100.0, 0.05))
+ options << " scale=\""
+ << static_cast<int>( (scl) + 0.5 )
+ << "\" ";
+ } else {
+ if (!params().width.zero()) {
+ options << " width=\"" << toDocbookLength(params().width) << "\" ";
+ }
+ if (!params().height.zero()) {
+ options << " depth=\"" << toDocbookLength(params().height) << "\" ";
+ }
+ if (params().keepAspectRatio) {
+ // This will be irrelevant unless both width and height are set
+ options << "scalefit=\"1\" ";
+ }
+ }
+
+
+ if (!params().special.empty())
+ options << params().special << " ";
+
+ string opts = options.str();
+ // trailing blanks are ok ...
+ return opts;
+}
+
+
+namespace {
+
+enum CopyStatus {
+ SUCCESS,
+ FAILURE,
+ IDENTICAL_PATHS,
+ IDENTICAL_CONTENTS
+};
+
+
+std::pair<CopyStatus, string> const
+copyFileIfNeeded(string const & file_in, string const & file_out)
+{
+ BOOST_ASSERT(AbsolutePath(file_in));
+ BOOST_ASSERT(AbsolutePath(file_out));
+
+ unsigned long const checksum_in = support::sum(file_in);
+ unsigned long const checksum_out = support::sum(file_out);
+
+ if (checksum_in == checksum_out)
+ // Nothing to do...
+ return std::make_pair(IDENTICAL_CONTENTS, file_out);
+
+ Mover const & mover = movers(formats.getFormatFromFile(file_in));
+ bool const success = mover.copy(file_in, file_out);
+ if (!success) {
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;
+ << support::bformat(_("Could not copy the file\n%1$s\n"
+ "into the temporary directory."),
+ file_in)
+ << std::endl;
}
- // 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;
+ CopyStatus status = success ? SUCCESS : FAILURE;
+ return std::make_pair(status, file_out);
+}
+
+
+std::pair<CopyStatus, string> const
+copyToDirIfNeeded(string const & file_in, string const & dir, bool zipped)
+{
+ using support::rtrim;
+
+ BOOST_ASSERT(AbsolutePath(file_in));
+
+ string const only_path = support::OnlyPath(file_in);
+ if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/"))
+ return std::make_pair(IDENTICAL_PATHS, file_in);
+
+ string mangled = FileName(file_in).mangledFilename();
+ if (zipped) {
+ // We need to change _eps.gz to .eps.gz. The mangled name is
+ // still unique because of the counter in mangledFilename().
+ // We can't just call mangledFilename() with the zip
+ // extension removed, because base.eps and base.eps.gz may
+ // have different content but would get the same mangled
+ // name in this case.
+ string const base = RemoveExtension(unzippedFileName(file_in));
+ string::size_type const ext_len = file_in.length() - base.length();
+ mangled[mangled.length() - ext_len] = '.';
+ }
+ string const file_out = support::MakeAbsPath(mangled, dir);
+
+ return copyFileIfNeeded(file_in, file_out);
+}
+
+
+string const stripExtensionIfPossible(string const & file)
+{
+ // Remove the extension so the LaTeX will use whatever
+ // is appropriate (when there are several versions in
+ // different formats)
+ // This works only if the filename contains no dots besides
+ // the just removed one. We can fool here by replacing all
+ // dots with a macro whose definition is just a dot ;-)
+ // The automatic format selection does not work if the file
+ // name is escaped.
+ string const latex_name = latex_path(file,
+ lyx::support::EXCLUDE_EXTENSION);
+ if (contains(latex_name, '"'))
+ return latex_name;
+ return latex_path(RemoveExtension(file),
+ lyx::support::PROTECT_EXTENSION,
+ lyx::support::ESCAPE_DOTS);
+}
+
+
+string const stripExtensionIfPossible(string const & file, string const & to)
+{
+ // No conversion is needed. LaTeX can handle the graphic file as is.
+ // This is true even if the orig_file is compressed.
+ string const to_format = formats.getFormat(to)->extension();
+ string const file_format = GetExtension(file);
+ // for latex .ps == .eps
+ if (to_format == file_format ||
+ (to_format == "eps" && file_format == "ps") ||
+ (to_format == "ps" && file_format == "eps"))
+ return stripExtensionIfPossible(file);
+ return latex_path(file, lyx::support::EXCLUDE_EXTENSION);
+}
+
+} // namespace anon
+
+
+string const InsetGraphics::prepareFile(Buffer const & buf,
+ OutputParams const & runparams) const
+{
+ // The following code depends on non-empty filenames
+ if (params().filename.empty())
+ return string();
+
+ string const orig_file = params().filename.absFilename();
+ string const rel_file = params().filename.relFilename(buf.filePath());
+
+ // 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!
+ bool const zipped = params().filename.isZipped();
// 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);
+ string temp_file = orig_file;
+
+ // The master buffer. This is useful when there are multiple levels
+ // of include files
+ Buffer const * m_buffer = buf.getMasterBuffer();
+
+ // Return the output name if the file does not exist.
+ // We are not going to change the extension or using the name of the
+ // temporary file, the code is already complicated enough.
+ if (!IsFileReadable(orig_file))
+ return params().filename.outputFilename(m_buffer->filePath());
+
+ // We place all temporary files in the master buffer's temp dir.
+ // This is possible because we use mangled file names.
+ // This is necessary for DVI export.
+ string const temp_path = m_buffer->temppath();
+
+ CopyStatus status;
+ boost::tie(status, temp_file) =
+ copyToDirIfNeeded(orig_file, temp_path, zipped);
+
+ if (status == FAILURE)
+ return orig_file;
+
+ // a relative filename should be relative to the master
+ // buffer.
+ // "nice" means that the buffer is exported to LaTeX format but not
+ // run through the LaTeX compiler.
+ string const output_file = os::external_path(runparams.nice ?
+ params().filename.outputFilename(m_buffer->filePath()) :
+ OnlyFilename(temp_file));
+ string const source_file = runparams.nice ? orig_file : temp_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);
+ if (params().noUnzip) {
+ // We don't know whether latex can actually handle
+ // this file, but we can't check, because that would
+ // mean to unzip the file and thereby making the
+ // noUnzip parameter meaningless.
+ lyxerr[Debug::GRAPHICS]
+ << "\tpass zipped file to LaTeX.\n";
+
+ string const bb_orig_file = ChangeExtension(orig_file, "bb");
+ if (runparams.nice) {
+ runparams.exportdata->addExternalFile("latex",
+ bb_orig_file,
+ ChangeExtension(output_file, "bb"));
+ } else {
+ // LaTeX needs the bounding box file in the
+ // tmp dir
+ string bb_file = ChangeExtension(temp_file, "bb");
+ boost::tie(status, bb_file) =
+ copyFileIfNeeded(bb_orig_file, bb_file);
+ if (status == FAILURE)
+ return orig_file;
+ runparams.exportdata->addExternalFile("latex",
+ bb_file);
+ }
+ runparams.exportdata->addExternalFile("latex",
+ source_file, output_file);
+ runparams.exportdata->addExternalFile("dvi",
+ source_file, output_file);
+ // We can't strip the extension, because we don't know
+ // the unzipped file format
+ return latex_path(output_file,
+ lyx::support::EXCLUDE_EXTENSION);
+ }
+
+ string const unzipped_temp_file = unzippedFileName(temp_file);
+ if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
+ // temp_file has been unzipped already and
+ // orig_file has not changed in the meantime.
+ temp_file = unzipped_temp_file;
lyxerr[Debug::GRAPHICS]
- << "\tCopying zipped file from "
- << orig_file_with_path << " to " << temp_file
- << (success ? " succeeded\n" : " failed\n");
- } else
+ << "\twas already unzipped to " << temp_file
+ << endl;
+ } else {
+ // unzipped_temp_file does not exist or is too old
+ temp_file = unzipFile(temp_file);
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;
+ << "\tunzipped to " << temp_file << endl;
+ }
}
- string const from = getExtFromContents(orig_file_with_path);
- string const to = findTargetFormat(from);
+ string const from = formats.getFormatFromFile(temp_file);
+ if (from.empty()) {
+ lyxerr[Debug::GRAPHICS]
+ << "\tCould not get file format." << endl;
+ return orig_file;
+ }
+ string const to = findTargetFormat(from, runparams);
+ string const ext = formats.extension(to);
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);
- } else {
- return 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
// 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;
+ << "\tthe orig file is: " << orig_file << endl;
+
+ if (from == to) {
+ // The extension of temp_file might be != ext!
+ runparams.exportdata->addExternalFile("latex", source_file,
+ output_file);
+ runparams.exportdata->addExternalFile("dvi", source_file,
+ output_file);
+ return stripExtensionIfPossible(output_file, to);
+ }
- // 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) {
- Alert::alert(_("Cannot copy file"), orig_file_with_path,
- _("into tempdir"));
- return orig_file;
- }
- }
+ string const to_file = ChangeExtension(temp_file, ext);
+ string const output_to_file = ChangeExtension(output_file, ext);
- 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);
- else
- return temp_file;
- }
+ // Do we need to perform the conversion?
+ // Yes if to_file does not exist or if temp_file is newer than to_file
+ if (compare_timestamps(temp_file, to_file) < 0) {
+ lyxerr[Debug::GRAPHICS]
+ << bformat(_("No conversion of %1$s is needed after all"),
+ rel_file)
+ << std::endl;
+ runparams.exportdata->addExternalFile("latex", to_file,
+ output_to_file);
+ runparams.exportdata->addExternalFile("dvi", to_file,
+ output_to_file);
+ return stripExtensionIfPossible(output_file);
}
-
- 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
- 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);
-#endif
+ if (converters.convert(&buf, temp_file, temp_file, from, to, true)) {
+ runparams.exportdata->addExternalFile("latex",
+ to_file, output_to_file);
+ runparams.exportdata->addExternalFile("dvi",
+ to_file, output_to_file);
}
- return RemoveExtension(temp_file);
+ return stripExtensionIfPossible(output_file);
}
-int InsetGraphics::latex(Buffer const *buf, ostream & os,
- bool /*fragile*/, bool/*fs*/) const
+int InsetGraphics::latex(Buffer const & buf, ostream & os,
+ OutputParams const & runparams) const
{
// 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
+ << params().filename.absFilename() << endl;
+
+ string const relative_file =
+ params().filename.relFilename(buf.filePath());
+
+ string const file_ = params().filename.absFilename();
+ bool const file_exists = !file_.empty() && IsFileReadable(file_);
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
+ // if !message.empty() then there was no existing file
+ // "filename" found. In this case LaTeX
// draws only a rectangle with the above bb and the
// not found filename in it.
lyxerr[Debug::GRAPHICS]
lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
if (!opts.empty() && !message.empty())
- before += ("[%\n" + opts + ',' + message + ']');
+ before += ('[' + opts + ',' + message + ']');
else if (!opts.empty() || !message.empty())
- before += ("[%\n" + opts + message + ']');
+ before += ('[' + 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 latex_str = message.empty() ?
- (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
- (before + '{' + params().filename + " not found!}" + after);
+ string latex_str = before + '{';
+ // Convert the file if necessary.
+ // Remove the extension so LaTeX will use whatever is appropriate
+ // (when there are several versions in different formats)
+ latex_str += prepareFile(buf, runparams);
+ latex_str += '}' + after;
os << latex_str;
+ lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
+ << latex_str << endl;
// Return how many newlines we issued.
- int const newlines =
- int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
-
- return newlines;
+ return int(lyx::count(latex_str.begin(), latex_str.end(),'\n'));
}
-int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
+int InsetGraphics::plaintext(Buffer const &, ostream & os,
+ OutputParams const &) const
{
// No graphics in ascii output. Possible to use gifscii to convert
// images to ascii approximation.
// 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
-#if USE_BOOST_FORMAT
- os << '<'
- << boost::format(_("Graphics file: %1$s")) % params().filename
- << ">\n";
-#else
- os << '<'
- << _("Graphics file: ") << params().filename
- << ">\n";
-#endif
+ os << '<' << bformat(_("Graphics file: %1$s"),
+ params().filename.absFilename()) << ">\n";
return 0;
}
-int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
+int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
+ OutputParams const & runparams) const
{
- // No graphics in LinuxDoc output. Should check how/what to add.
+ string const file_name = runparams.nice ?
+ params().filename.relFilename(buf.filePath()):
+ params().filename.absFilename();
+
+ runparams.exportdata->addExternalFile("linuxdoc",
+ params().filename.absFilename());
+ os << "<eps file=\"" << file_name << "\">\n";
+ os << "<img src=\"" << file_name << "\">";
return 0;
}
+namespace {
+
+int writeImageObject(char * format, ostream& os, OutputParams const & runparams,
+ string const graphic_label, string const attributes)
+{
+ if (runparams.flavor != OutputParams::XML) {
+ os << "<![ %output.print." << format << "; [" << std::endl;
+ }
+ os <<"<imageobject><imagedata fileref=\"&"
+ << graphic_label << ";." << format << "\" " << attributes ;
+ if (runparams.flavor == OutputParams::XML) {
+ os << " role=\"" << format << "\"/>" ;
+ }
+ else {
+ os << " format=\"" << format << "\">" ;
+ }
+ os << "</imageobject>";
+ if (runparams.flavor != OutputParams::XML) {
+ os << std::endl << "]]>" ;
+ }
+ return runparams.flavor == OutputParams::XML ? 0 : 2;
+}
+// end anonymous namespace
+}
+
+
// For explanation on inserting graphics into DocBook checkout:
-// http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
+// http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
// See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(Buffer const *, ostream & os,
- bool /*mixcont*/) const
+int InsetGraphics::docbook(Buffer const &, ostream & os,
+ OutputParams const & runparams) const
{
// 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=\"&" << graphic_label << ";\">";
- return 0;
+ if (runparams.flavor == OutputParams::XML) {
+ runparams.exportdata->addExternalFile("docbook-xml",
+ params().filename.absFilename());
+ } else {
+ runparams.exportdata->addExternalFile("docbook",
+ params().filename.absFilename());
+ }
+ os << "<inlinemediaobject>";
+
+ int r = 0;
+ string attributes = createDocBookAttributes();
+ r += writeImageObject("png", os, runparams, graphic_label, attributes);
+ r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
+ r += writeImageObject("eps", os, runparams, graphic_label, attributes);
+ r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
+
+ os << "</inlinemediaobject>";
+ return r;
}
{
// If we have no image, we should not require anything.
if (params().filename.empty())
- return ;
+ return;
- features.includeFile(graphic_label, RemoveExtension(params().filename));
+ features.includeFile(graphic_label,
+ RemoveExtension(params().filename.absFilename()));
features.require("graphicx");
+ if (features.nice()) {
+ Buffer const * m_buffer = features.buffer().getMasterBuffer();
+ string basename =
+ params().filename.outputFilename(m_buffer->filePath());
+ basename = RemoveExtension(basename);
+ if(params().filename.isZipped())
+ basename = RemoveExtension(basename);
+ if (contains(basename, "."))
+ features.require("lyxdot");
+ }
+
if (params().subcaption)
features.require("subfigure");
}
-void InsetGraphics::statusChanged()
-{
- if (cache_->view.get())
- cache_->view.get()->updateInset(this, false);
-}
-
-
-bool InsetGraphics::setParams(InsetGraphicsParams const & p,
- string const & filepath)
+bool InsetGraphics::setParams(InsetGraphicsParams const & p)
{
// If nothing is changed, just return and say so.
- if (params() == p && !p.filename.empty()) {
+ if (params() == p && !p.filename.empty())
return false;
- }
// Copy the new parameters.
params_ = p;
- // Update the inset with the new parameters.
- cache_->update(MakeAbsPath(params().filename, filepath));
+ // Update the display using the new parameters.
+ graphic_->update(params().as_grfxParams());
// We have changed data, report it.
return true;
}
-Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
+void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
+ Buffer const & buffer) const
+{
+ string const file_with_path = p.filename.absFilename();
+ formats.edit(buffer, file_with_path,
+ formats.getFormatFromFile(file_with_path));
+}
+
+
+string const InsetGraphicsMailer::name_("graphics");
+
+InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
+{
+ return params2string(inset_.params(), buffer);
+}
+
+
+void InsetGraphicsMailer::string2params(string const & in,
+ Buffer const & buffer,
+ InsetGraphicsParams & params)
+{
+ params = InsetGraphicsParams();
+ if (in.empty())
+ return;
+
+ istringstream data(in);
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ string name;
+ lex >> name;
+ if (!lex || name != name_)
+ return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
+
+ InsetGraphics inset;
+ inset.readInsetGraphics(lex, buffer.filePath());
+ params = inset.params();
+}
+
+
+string const
+InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
+ Buffer const & buffer)
{
- return new InsetGraphics(*this, buffer.filePath(), same_id);
+ ostringstream data;
+ data << name_ << ' ';
+ params.Write(data, buffer.filePath());
+ data << "\\end_inset\n";
+ return data.str();
}