-/* 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 Voß
+ *
+ * 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.
/* 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>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insets/insetgraphics.h"
-#include "insets/insetgraphicsParams.h"
-
-#include "graphics/GraphicsCache.h"
-#include "graphics/GraphicsImage.h"
+#include "insets/render_graphic.h"
-#include "LyXView.h"
-#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
-#include "Painter.h"
-#include "lyxrc.h"
-#include "font.h" // For the lyxfont class.
+#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 "frontends/Dialogs.h"
-#include "frontends/controllers/helper_funcs.h" // getVectorFromString
-
-#include "support/LAssert.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/LyXView.h"
+
+#include "support/convert.h"
#include "support/filetools.h"
#include "support/lyxalgo.h" // lyx::count
-#include "support/path.h"
+#include "support/lyxlib.h" // lyx::sum
+#include "support/lstrings.h"
+#include "support/os.h"
+#include "support/systemcall.h"
+
+#include <boost/bind.hpp>
+#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;
-#include <algorithm> // For the std::max
-
-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;
-///////////////////////////////////////////////////////////////////////////
-int const VersionNumber = 1;
-///////////////////////////////////////////////////////////////////////////
namespace {
return ChangeExtension(filename, string());
}
-} // namespace anon
-
-namespace {
-
-string const unique_id()
+string findTargetFormat(string const & format, OutputParams const & runparams)
{
- static unsigned int seed = 1000;
-
- ostringstream ost;
- ost << "graph" << ++seed;
-
- // Needed if we use lyxstring.
- return ost.str().c_str();
+ // 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";
+ // 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" << endl;
+ if (format != "ps")
+ // any other than ps is changed to eps
+ return "eps";
+ // let ps untouched
+ return format;
}
} // namespace anon
InsetGraphics::InsetGraphics()
- : graphic_label(unique_id()),
- cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
-
+ : graphic_label(sgml::uniqueID("graph")),
+ graphic_(new RenderGraphic(this))
{}
-InsetGraphics::InsetGraphics(InsetGraphics const & ig,
- string const & filepath,
- bool same_id)
- : Inset(ig, same_id),
- SigC::Object(),
- graphic_label(unique_id()),
- cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
+InsetGraphics::InsetGraphics(InsetGraphics const & ig)
+ : InsetOld(ig),
+ boost::signals::trackable(),
+ graphic_label(sgml::uniqueID("graph")),
+ graphic_(new RenderGraphic(*ig.graphic_, this))
{
- setParams(ig.params(), filepath);
+ setParams(ig.params());
}
-InsetGraphics::~InsetGraphics()
+auto_ptr<InsetBase> InsetGraphics::doClone() const
{
- cached_image_.reset(0);
- grfx::GCache & gc = grfx::GCache::get();
- gc.remove(*this);
-
- // Emits the hide signal to the dialog connected (if any)
- hideDialog();
+ return auto_ptr<InsetBase>(new InsetGraphics(*this));
}
-string const InsetGraphics::statusMessage() const
-{
- string msg;
-
- switch (cached_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::ErrorNoFile:
- msg = _("No file found!");
- break;
- case grfx::ErrorLoading:
- msg = _("Error loading file into memory");
- 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");
- break;
- case grfx::Loaded:
- msg = _("Loaded but not displaying");
- break;
- }
-
- return msg;
-}
-
-
-void InsetGraphics::setCache() const
-{
- if (cache_filled_)
- return;
-
- grfx::GCache & gc = grfx::GCache::get();
- cached_status_ = gc.status(*this);
- cached_image_ = gc.image(*this);
-}
-
-
-bool InsetGraphics::drawImage() const
-{
- setCache();
- Pixmap const pixmap =
- (cached_status_ == grfx::Loaded && cached_image_.get() != 0) ?
- cached_image_->getPixmap() : 0;
-
- return pixmap != 0;
-}
-
-
-int InsetGraphics::ascent(BufferView *, LyXFont const &) const
+InsetGraphics::~InsetGraphics()
{
- old_asc = 50;
- if (drawImage())
- old_asc = cached_image_->getHeight();
- return old_asc;
+ InsetGraphicsMailer(*this).hideDialog();
}
-int InsetGraphics::descent(BufferView *, LyXFont const &) const
+void InsetGraphics::doDispatch(LCursor & cur, FuncRequest & cmd)
{
- return 0;
-}
-
-
-int InsetGraphics::width(BufferView *, LyXFont const & font) const
-{
- if (drawImage())
- return cached_image_->getWidth();
- else {
- int font_width = 0;
+ 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;
+ }
- LyXFont msgFont(font);
- msgFont.setFamily(LyXFont::SANS_FAMILY);
+ 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;
+ }
- string const justname = OnlyFilename (params().filename);
- if (!justname.empty()) {
- msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- font_width = lyxfont::width(justname, msgFont);
- }
+ case LFUN_INSET_DIALOG_UPDATE:
+ InsetGraphicsMailer(*this).updateDialog(&cur.bv());
+ break;
- 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);
- }
+ case LFUN_MOUSE_RELEASE:
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
+ break;
- return std::max(50, font_width + 15);
+ default:
+ InsetBase::doDispatch(cur, cmd);
+ break;
}
}
-void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
- int baseline, float & x, bool) const
+bool InsetGraphics::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
{
- int oasc = old_asc;
- grfx::ImageStatus old_status_ = cached_status_;
-
- 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) {
-// lyxerr << "IG(" << this << "): " << x << endl;
- return;
- }
-
- // 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 (cached_status_ == grfx::WaitingToLoad) {
- grfx::GCache & gc = grfx::GCache::get();
- gc.startLoading(*this);
- }
-
- // This will draw the graphics. If the graphics has not been loaded yet,
- // we draw just a rectangle.
- Painter & paint = bv->painter();
-
- if (drawImage()) {
-// lyxerr << "IG(" << this << "): " << old_x << endl;
- paint.image(old_x + 2, baseline - lascent,
- lwidth - 4, lascent + ldescent,
- *cached_image_.get());
-
- } else {
-
- paint.rectangle(old_x + 2, baseline - lascent,
- lwidth - 4,
- 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 + 8,
- baseline - lyxfont::maxAscent(msgFont) - 4,
- justname, msgFont);
- }
-
- // Print the message.
- string const msg = statusMessage();
- if (!msg.empty()) {
- msgFont.setSize(LyXFont::SIZE_TINY);
- paint.text(old_x + 8, baseline - 4, msg, msgFont);
- }
- }
-
- // the status message may mean we changed size, so indicate
- // we need a row redraw
- if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
- bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
+ 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);
}
-
- // Reset the cache, ready for the next draw request
- cached_status_ = grfx::ErrorUnknown;
- cached_image_.reset(0);
- cache_filled_ = false;
}
-// 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(string const & filepath) const
+void InsetGraphics::edit(LCursor & cur, bool)
{
- grfx::GCache & gc = grfx::GCache::get();
- gc.update(*this, filepath);
+ InsetGraphicsMailer(*this).showDialog(&cur.bv());
}
-void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
+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, 0);
+ 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 FormatVersion " << VersionNumber << '\n';
- params().Write(os);
+ os << "Graphics\n";
+ 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);
- else if (token == "Figure") // Compatibility reading of FigInset figures.
- readFigInset(lex);
+ readInsetGraphics(lex, buf.filePath());
else
- lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
+ lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!" << endl;
- updateInset(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;
}
}
}
-// 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();
- 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
{
// before writing it to the output stream.
ostringstream options;
if (!params().bb.empty())
- options << " bb=" << strip(params().bb) << ",\n";
+ options << "bb=" << rtrim(params().bb) << ',';
if (params().draft)
- options << " draft,\n";
+ options << "draft,";
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";
+ 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() << ',';
+ if (!params().height.zero())
+ options << "height=" << params().height.asLatexString() << ',';
+ if (params().keepAspectRatio)
+ options << "keepaspectratio,";
}
- 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";
+
+ // Make sure rotation angle is not very close to zero;
+ // a float can be effectively zero but not exactly zero.
+ 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";
- string opts = options.str().c_str();
- return opts.substr(0,opts.size()-2); // delete last ",\n"
+ options << params().special << ',';
+
+ string opts = options.str();
+ // delete last ','
+ return opts.substr(0, opts.size() - 1);
}
-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).
- lyxerr[Debug::GRAPHICS] << "decideOutput: lyxrc.pdf_mode = "
- << lyxrc.pdf_mode << std::endl;
- if (lyxrc.pdf_mode) {
- if (contains(suffix,"ps") || suffix == "pdf")
- return "pdf";
- else if (suffix == "jpg")
- return suffix;
- else
- return "png";
- }
- // If it's postscript, we always do eps.
- lyxerr[Debug::GRAPHICS] << "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
- //
- // if it's a zipped one, than let LaTeX do the rest!!!
- string filename_ = params().filename;
- bool const zipped = zippedFile(filename_);
-
- if ((zipped && params().noUnzip) || buf->niceFile) {
- lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
- << filename_ << endl;
- return filename_;
- }
- // Enable these helper functions to find the file if it is stored as
- // a relative path.
- Path p(buf->filePath());
+string const InsetGraphics::toDocbookLength(LyXLength const & len) const
+{
+ 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 (zipped)
- filename_ = unzipFile(filename_);
+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() ;-)
- string const from = getExtFromContents(filename_);
- string const to = findTargetFormat(from);
+ // 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 (from == to) {
- // No conversion needed!
- return filename_;
+ 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\" ";
+ }
}
- string const temp = AddName(buf->tmppath, filename_);
- string const outfile_base = RemoveExtension(temp);
- lyxerr[Debug::GRAPHICS] << "tempname = " << temp << "\n";
- lyxerr[Debug::GRAPHICS] << "buf::tmppath = " << buf->tmppath << "\n";
- lyxerr[Debug::GRAPHICS] << "filename_ = " << filename_ << "\n";
- lyxerr[Debug::GRAPHICS] << "outfile_base = " << outfile_base << endl;
+ if (!params().special.empty())
+ options << params().special << " ";
- converters.convert(buf, filename_, outfile_base, from, to);
- return outfile_base;
+ string opts = options.str();
+ // trailing blanks are ok ...
+ return opts;
}
namespace {
-string const latexify(string const & str)
-{
- ostringstream out;
+enum CopyStatus {
+ SUCCESS,
+ FAILURE,
+ IDENTICAL_PATHS,
+ IDENTICAL_CONTENTS
+};
- string::const_iterator it = str.begin();
- string::const_iterator end = str.end();
- for (; it != end; ++it) {
- switch (*it) {
-
- case ('$'):
- case ('&'):
- case ('%'):
- case ('#'):
- case ('_'):
- case ('{'):
- case ('}'):
- out << '\\' << *it;
- break;
+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]
+ << support::bformat(_("Could not copy the file\n%1$s\n"
+ "into the temporary directory."),
+ file_in)
+ << std::endl;
+ }
- case ('~'):
- case ('^'):
- out << '\\' << *it << "{}";
- break;
+ CopyStatus status = success ? SUCCESS : FAILURE;
+ return std::make_pair(status, file_out);
+}
- case ('\\'):
- out << "\textbackslash ";
- break;
- default:
- out << *it;
- break;
- }
+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] = '.';
}
-
- return out.str().c_str();
+ 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
-int InsetGraphics::latex(Buffer const *buf, ostream & os,
- bool /*fragile*/, bool/*fs*/) const
+string const InsetGraphics::prepareFile(Buffer const & buf,
+ OutputParams const & runparams) 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.
+ // 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;
+
+ // 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) {
+ 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]
+ << "\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]
+ << "\tunzipped to " << temp_file << endl;
+ }
+ }
+
+ 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';
- // Enable these helper functions to find the file if it is stored as
- // a relative path.
- Path p(buf->filePath());
+ // 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.
- // Ditto if the file is not there.
- if (!IsFileReadable(params().filename)) {
- os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
- << latexify(MakeRelPath(params().filename, buf->filePath()))
- << _(" not found") << "}\n";
- return 1; // One end-of-line marker added to the stream.
+ lyxerr[Debug::GRAPHICS]
+ << "\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);
+ }
+
+ string const to_file = ChangeExtension(temp_file, ext);
+ string const output_to_file = ChangeExtension(output_file, ext);
+
+ // 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);
}
+
+ 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'
+ << "\t from " << from << " to " << to << '\n';
+
+ 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 stripExtensionIfPossible(output_file);
+}
+
+
+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.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() 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]
+ << "\tMessage = \"" << message << '\"' << endl;
+
// These variables collect all the latex code that should be before and
// after the actual includegraphics command.
string before;
}
// We never use the starred form, we use the "clip" option instead.
before += "\\includegraphics";
+
// Write the options if there are any.
string const opts = createLatexOptions();
- if (!opts.empty()) {
- before += ("[%\n" + opts +']');
- }
- // 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 = before + '{' + prepareFile(buf) + '}' + after;
+ lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
+
+ if (!opts.empty() && !message.empty())
+ before += ('[' + opts + ',' + message + ']');
+ else if (!opts.empty() || !message.empty())
+ before += ('[' + opts + message + ']');
+
+ lyxerr[Debug::GRAPHICS]
+ << "\tBefore = " << before
+ << "\n\tafter = " << after << endl;
+
+ 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
- os << '<' << _("Graphic file:") << params().filename << ">\n";
+ 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) 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");
}
-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.
- updateInset(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();
}
projects / lyx.git / blobdiff