/* This file is part of
- * ======================================================
- *
+ * ======================================================
+ *
* LyX, The Document Processor
- *
- * Copyright 1995-2000 the LyX Team.
- *
- * This file Copyright 2000 Baruch Even.
+ *
+ * Copyright 1995-2002 the LyX Team.
+ *
+ * \author Baruch Even
+ * \author Herbert Voss <voss@lyx.org>
* ====================================================== */
-/*
-How to use it for now:
- * The lyxfunc 'graphics-insert' will insert this inset into the document.
-*/
-
-/*
-Immediate tasks:
- * Add the GraphicsCache and FormatTranslator in order to get inline
- viewing of the figures.
-
-*/
-
/*
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.
- * Bug in FileDlg class (src/filedlg.[hC]) when selecting a file and then
- pressing ok, it counts as if no real selection done. Apparently it
- when choosing a file it doesn't update the select file input line.
-
-Current PROBLEMS:
-
- * How to support both PDF and PS output, should we do the conversion
- or should we just give the bounding box and tell latex how to do the
- conversion itself?
- I (Baruch Even) tend towards doing the conversion ourselves, otherwise
- we need to give latex quite a few translation commands and from the
- graphicx package docs it appears that it takes quite a bit of memory
- on the side of TeXing.
-
- * How do we handle the inline viewing? we may need to show the same image
- in several formats (color, monochrome, grayscale) or even in different
- sizes, not to mention rotations!
-
-TODO Basics:
-
- * Add support for more features so that it will be better than insetfig.
- * Keep aspect ratio radio button
-
- * Create the GraphicsCache and FormatTranslator
- * Add inline viewing of image.
-
+ 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:
- * Replace insetfig everywhere
- * Read it's file format
- * Get created by all commands used to create figinset currently.
- * Search for comments of the form
- // INSET_GRAPHICS: remove this when InsetFig is thrown.
- And act upon them.
-
- * Pop up a dialog if the widget version is higher than what we accept.
- * Finish the basic To-do list.
- * Extract the general logic of the dialog in order to allow easier porting
- to Gnome/KDE, and put the general logic in frontends and the inherited
- platform dependent code in the appropriate dirs.
-
-TODO Extended features:
-
- * Advanced Latex tab folder.
- * Add even more options to make it better than insetfig.
- * Support for complete control over the latex parameters for TeXperts
- * What advanced features the users want to do?
- Implement them in a non latex dependent way, but a logical way.
- LyX should translate it to latex or any other fitting format.
+
+ * What advanced features the users want to do?
+ Implement them in a non latex dependent way, but a logical way.
+ LyX should translate it to latex or any other fitting format.
* Add a way to roll the image file into the file format.
- * When loading if the image is not found in the expected place, try
- to find it in the clipart, or in the same directory with the image.
- * If the dialog had no real change from previous time, do not mark document
- as changed.
+ * 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.
- */
+ * The image choosing dialog could show thumbnails of the image formats
+ it knows of, thus selection based on the image instead of based on
+ filename.
+ * Add support for the 'picins' package.
+ * Add support for the 'picinpar' package.
+ * Improve support for 'subfigure' - Allow to set the various options
+ that are possible.
+*/
/* NOTES:
- *
- * Intentions:
- * This is currently a moving target, I'm trying stuff and learning what
- * is needed and how to accomplish it, since there is no predefined goal or
- * way to go I invent it as I go.
- *
- * My current intention is for seperation from LaTeX, the basic needs are
- * resizing and rotating, displaying on screen in various depths and printing
- * conversion of depths (independent of the display depth). For this I'll
- * provide a simple interface.
- *
- * The medium level includes clipping of the image, but in a limited way.
- *
- * For the LaTeX gurus I'll provide a complete control over the output, but
- * this is latex dependent and guru dependent so I'd rather avoid doing this
- * for the normal user. This stuff includes clipping, special image size
- * specifications (\textwidth\minus 2in) which I see no way to generalize
- * to non-latex specific way.
- *
- * Used packages:
- * 'graphicx' for the graphics inclusion.
- * 'subfigure' for the subfigures.
- *
* 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.
*
- * Conversions:
- *
- * Apparently the PNG output is preferred over PDF images when doing PDF
- * documents (i.e. prefer imagemagick eps2png over eps2pdf)
- */
-
-/* Current Stage:
- * Embryonic.
- *
- * PLAN:
- * Finish basic support:
- * Inline image viewing
- * Get into lyx-devel as an unactivated inset for the benefit of those
- * who really need it.
*
- * Do Release quality support:
- * Allow to change display depth
- * Make default figure instead of InsetFig
- * Add to LyX (probably after 1.1.6 is released)
- *
- * Extended features:
- * Output format conversion
- * Print depth changes
- * Image file tracking of changes.
+ * Conversions:
+ * Postscript output means EPS figures.
*
- * Extended^2:
- * Image roll-in (how? when? why?)
- * This means to add the image inside the LyX file, usefull when
- * transferring the file around.
+ * PDF output is best done with PDF figures if it's a direct conversion
+ * or PNG figures otherwise.
+ * Image format
+ * from to
+ * EPS epstopdf
+ * PS ps2pdf
+ * JPG/PNG direct
+ * PDF direct
+ * others PNG
*/
-
-#include <config.h>
+#include <config.h>
#ifdef __GNUG__
#pragma implementation
-#endif
+#endif
#include "insets/insetgraphics.h"
#include "insets/insetgraphicsParams.h"
+
#include "graphics/GraphicsCache.h"
-#include "graphics/GraphicsCacheItem.h"
+#include "graphics/GraphicsImage.h"
-#include "frontends/Dialogs.h"
#include "LyXView.h"
+#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
+#include "converter.h"
#include "Painter.h"
-#include "lyx_gui_misc.h"
-#include "filedlg.h"
-#include "support/FileInfo.h"
+#include "lyxrc.h"
+#include "font.h" // For the lyxfont class.
+#include "debug.h"
+#include "gettext.h"
+#include "LaTeXFeatures.h"
+
+#include "frontends/Dialogs.h"
+#include "frontends/controllers/helper_funcs.h" // getVectorFromString
+
+#include "support/LAssert.h"
#include "support/filetools.h"
-#include "lyxtext.h"
+#include "support/lyxalgo.h" // lyx::count
+#include "support/path.h"
-#include "debug.h"
+#include <algorithm> // For the std::max
+extern string system_tempdir;
using std::ostream;
using std::endl;
+///////////////////////////////////////////////////////////////////////////
+int const VersionNumber = 1;
+///////////////////////////////////////////////////////////////////////////
+
+namespace {
+
+// This function is a utility function
+// ... that should be with ChangeExtension ...
+inline
+string const RemoveExtension(string const & filename)
+{
+ return ChangeExtension(filename, string());
+}
+
+} // namespace anon
+
+
+namespace {
+
+string const unique_id()
+{
+ static unsigned int seed = 1000;
+
+ ostringstream ost;
+ ost << "graph" << ++seed;
+
+ // Needed if we use lyxstring.
+ return ost.str().c_str();
+}
+
+} // namespace anon
+
-// Initialize only those variables that do not have a constructor.
InsetGraphics::InsetGraphics()
-#ifdef IG_OLDPARAMS
- : use_bb(false), hiresbb(false), angle(0.0), origin(DEFAULT)
- , keepaspectratio(false), scale(0.0), clip(false), draft(false)
- , cacheHandle(0)
-#endif
- : cacheHandle(0), pixmapInitialized(false)
+ : graphic_label(unique_id()),
+ cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
+
{}
+
+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)
+{
+ setParams(ig.params(), filepath);
+}
+
+
InsetGraphics::~InsetGraphics()
{
+ cached_image_.reset(0);
+ grfx::GCache & gc = grfx::GCache::get();
+ gc.remove(*this);
+
// Emits the hide signal to the dialog connected (if any)
- hide();
+ hideDialog();
+}
+
+
+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
{
- if (pixmapInitialized)
- return cacheHandle->getHeight();
- else
- return 50;
+ old_asc = 50;
+ if (drawImage())
+ old_asc = cached_image_->getHeight();
+ return old_asc;
}
int InsetGraphics::descent(BufferView *, LyXFont const &) const
{
- // this is not true if viewport is used and clip is not.
return 0;
}
-int InsetGraphics::width(BufferView *, LyXFont const &) const
+int InsetGraphics::width(BufferView *, LyXFont const & font) const
{
- if (pixmapInitialized)
- return cacheHandle->getWidth();
- else
- return 50;
+ if (drawImage())
+ return cached_image_->getWidth();
+ 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 = lyxfont::width(justname, msgFont);
+ }
+
+ string const msg = statusMessage();
+ if (!msg.empty()) {
+ msgFont.setSize(LyXFont::SIZE_TINY);
+ int const msg_width = lyxfont::width(msg, msgFont);
+ font_width = std::max(font_width, msg_width);
+ }
+
+ return std::max(50, font_width + 15);
+ }
}
void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
- int baseline, float & x, bool) const
+ int baseline, float & x, bool) const
{
- Painter & paint = bv->painter();
+ int oasc = old_asc;
+ grfx::ImageStatus old_status_ = cached_status_;
- int lwidth = width(bv, font);
int ldescent = descent(bv, font);
- int lascent = ascent(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.
- if (pixmapInitialized) {
+ 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());
- paint.pixmap(int(x) + 2, baseline - lascent,
- lwidth - 4, lascent + ldescent,
- pixmap);
} else {
- paint.rectangle(int(x) + 2, baseline - lascent,
- lwidth - 4,
- lascent + ldescent);
-
- // Check if the image is now ready.
- if (cacheHandle &&
- (cacheHandle->getImageStatus() == GraphicsCacheItem::Loaded)) {
- pixmap = cacheHandle->getImage();
- pixmapInitialized = true;
-
- // Tell BufferView we need to be updated!
- bv->text->status = LyXText::CHANGED_IN_DRAW;
+
+ 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);
}
}
- // Add the image width to the row width.
- x += lwidth;
+ // 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);
+ }
+
+ // Reset the cache, ready for the next draw request
+ cached_status_ = grfx::ErrorUnknown;
+ cached_image_.reset(0);
+ cache_filled_ = false;
}
-void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
+// 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
{
- bv->owner()->getDialogs() -> showGraphics(this);
+ grfx::GCache & gc = grfx::GCache::get();
+ gc.update(*this, filepath);
}
-Inset::EDITABLE InsetGraphics::Editable() const
+void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
{
- return IS_EDITABLE;
+ bv->owner()->getDialogs()->showGraphics(this);
}
-void InsetGraphics::Write(Buffer const * buf, ostream & os) const
+void InsetGraphics::edit(BufferView * bv, bool)
{
- os << "GRAPHICS FormatVersion 1" << endl;
-
- params.Write(buf, os);
+ edit(bv, 0, 0, 0);
}
-#if 0
-// Baruch Even 2000-07-08
-
-// A Thought for another way to read the file...
-// The map should be a static part of the object or a static part of this
-// file and should be filled during program start.
-// The questions are:
-// 1. Is this cleaner?
-// 2. Is there no hidden performance costs?
-//
-// Regarding 2 I can already see that we will have two copies of the strings
-// one in the data part of the program and one in the map, but that won't be
-// more than say 2K (overestimation here), there is no real benefit to put
-// it in the map since there aren't that many configuration items that will
-// make it a faster solution, it might just be a bit cleaner.
-// (a map stores either in a hash or a kind of a balanced tree).
-
-void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
-{
- typedef map < string, enum TOKENS > ReadActionMap;
- static ReadActionMap const readMap;
-
- bool finished = false;
- while (lex.IsOK() && !finished) {
- lex.next();
-
- string const token = lex.GetString();
- lyxerr.debug() << "Token: '" << token << '\'' << endl;
+Inset::EDITABLE InsetGraphics::editable() const
+{
+ return IS_EDITABLE;
+}
- if (token.empty())
- continue;
- ReadActionMap::const_iterator it =
- readMap.find(token);
+void InsetGraphics::write(Buffer const *, ostream & os) const
+{
+ os << "Graphics FormatVersion " << VersionNumber << '\n';
+ params().Write(os);
+}
- if (it == readMap.end()) {
- lyxerr << "Unknown keyword, skipping." << endl;
- continue;
- }
- switch (it.second) {
- case FILENAME_TOKEN:
- break;
- case VERSION_TOKEN:
- break;
- default:
- break;
- }
+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);
+ else
+ lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
- }
+ updateInset(buf->filePath());
}
-#endif
-void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
+
+void InsetGraphics::readInsetGraphics(LyXLex & lex)
{
bool finished = false;
- while (lex.IsOK() && !finished) {
+ while (lex.isOK() && !finished) {
lex.next();
- string const token = lex.GetString();
- lyxerr.debug() << "Token: '" << token << '\'' << endl;
+ string const token = lex.getString();
+ lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
+ << std::endl;
if (token.empty()) {
continue;
finished = true;
} else if (token == "FormatVersion") {
lex.next();
- int version = lex.GetInteger();
- if (version > 1)
+ 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."
- << endl;
+ << std::endl;
// TODO: Possibly open up a dialog?
}
else {
- if (! params.Read(buf, lex, token))
- lyxerr << "Unknown token, " << token << ",skipping." << endl;
+ if (! params_.Read(lex, token))
+ lyxerr << "Unknown token, " << token << ", skipping."
+ << std::endl;
}
}
-
- updateInset();
}
-static
-void formatResize(ostream & os, string const & key,
- InsetGraphicsParams::Resize resizeType, double size)
+// FormatVersion < 1.0 (LyX < 1.2)
+void InsetGraphics::readFigInset(LyXLex & lex)
{
- switch (resizeType) {
- case InsetGraphicsParams::DEFAULT_SIZE:
- break;
-
- case InsetGraphicsParams::CM:
- os << key << '=' << size << "cm,";
- break;
-
- case InsetGraphicsParams::INCH:
- os << key << '=' << size << "in,";
- break;
-
- case InsetGraphicsParams::PERCENT_PAGE:
- os << key << '=' << size / 100 << "\\text" << key << ',';
- break;
+ 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();
- case InsetGraphicsParams::PERCENT_COLUMN:
- os << key << '=' << size / 100 << "\\column" << key << ',';
- break;
+ 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");
+ 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;
+ }
+ }
+ }
}
}
-int InsetGraphics::Latex(Buffer const *buf, ostream & os,
- bool /*fragile*/, bool/*fs*/) const
+string const InsetGraphics::createLatexOptions() const
{
- // MISSING: We have to decide how to do the order of the options
- // that is dependent of order, like witdth, height, angle. Should
- // we rotate before scale? Should we let the user decide?
- // bool rot_before_scale; ?
-
- // (BE) As a first step we should do a scale before rotate since this is
- // more like the natural thought of how to do it.
- // (BE) I believe that a priority list presented to the user with
- // a default order would be the best, though it would be better to
- // hide such a thing in an "Advanced options" dialog.
- // (BE) This should go an advanced LaTeX options dialog.
-
- // 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")
- << '}'
- << endl;
-
- return 1;
- }
-
// Calculate the options part of the command, we must do it to a string
// stream since we might have a trailing comma that we would like to remove
// before writing it to the output stream.
- std::ostringstream options;
-
- formatResize(options, "width", params.widthResize, params.widthSize);
- formatResize(options, "height", params.heightResize, params.heightSize);
-
- if (params.rotateAngle != 0) {
- options << "angle="
- << params.rotateAngle << ',';
- }
-
-#ifdef IG_OLDPARAMS
- if (bb.isSet() && use_bb) {
- options << "bb="
- << bb.llx << ' ' << bb.lly << ' '
- << bb.urx << ' ' << bb.ury << ',';
+ ostringstream options;
+ if (!params().bb.empty())
+ options << " bb=" << strip(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 (hiresbb) {
- options << "hiresbb,";
+ if (params().keepAspectRatio)
+ options << " keepaspectratio,\n";
+ // Make sure it's not very close to zero, a float can be effectively
+ // zero but not exactly zero.
+ if (!lyx::float_equal(params().rotateAngle, 0, 0.001) && params().rotate) {
+ options << " angle=" << params().rotateAngle << ",\n";
+ if (!params().rotateOrigin.empty()) {
+ options << " origin=" << params().rotateOrigin[0];
+ if (contains(params().rotateOrigin,"Top"))
+ options << 't';
+ else if (contains(params().rotateOrigin,"Bottom"))
+ options << 'b';
+ else if (contains(params().rotateOrigin,"Baseline"))
+ options << 'B';
+ options << ",\n";
+ }
}
- if (viewport.isSet()) {
- options << "viewport="
- << viewport.llx << ' ' << viewport.lly << ' '
- << viewport.urx << ' ' << viewport.ury << ',';
- }
- if (trim.isSet()) {
- options << "trim="
- << trim.llx << ' ' << trim.lly << ' '
- << trim.urx << ' ' << trim.ury << ',';
- }
- if (natheight.value() != 0) {
- options << "natheight=" << natheight.asString() << ',';
- }
- if (natwidth.value() != 0) {
- options << "natwidth=" << natwidth.asString() << ',';
- }
- if (angle != 0.0) {
- options << "angle=" << angle << ',';
- }
- if (origin != DEFAULT) {
- switch (origin) {
- case DEFAULT: break;
- case LEFTTOP:
- options << "origin=lt,";
- break;
- case LEFTCENTER:
- options << "origin=lc,";
- break;
- case LEFTBASELINE:
- options << "origin=lB,";
- break;
- case LEFTBOTTOM:
- options << "origin=lb,";
- break;
- case CENTERTOP:
- options << "origin=ct,";
- break;
- case CENTER:
- options << "origin=c,";
- break;
- case CENTERBASELINE:
- options << "origin=cB,";
- break;
- case CENTERBOTTOM:
- options << "origin=cb,";
- break;
- case RIGHTTOP:
- options << "origin=rt,";
- break;
- case RIGHTCENTER:
- options << "origin=rc,";
- break;
- case RIGHTBASELINE:
- options << "origin=rB,";
- break;
- case RIGHTBOTTOM:
- options << "origin=rb,";
- break;
- }
- }
- if (g_width.value() != 0) {
- options << "width=" << g_width.asString() << ',';
- }
- if (g_height.value() != 0) {
- options << "height=" << g_height.asString() << ',';
- }
- if (totalheight.value() != 0) {
- options << "totalheight=" << totalheight.asString() << ',';
- }
- if (keepaspectratio) {
- options << "keepaspectratio,";
- }
- if (scale != 0.0) {
- options << "scale=" << scale << ',';
- }
- if (clip) {
- options << "clip,";
- }
- if (draft) {
- options << "draft,";
- }
- if (!type.empty()) {
- options << "type=" << type << ',';
+ if (!params().special.empty())
+ options << params().special << ",\n";
+ string opts = options.str().c_str();
+ return opts.substr(0,opts.size()-2); // delete last ",\n"
+}
- // These should be present only when type is used.
- if (!ext.empty()) {
- options << "ext=" << type << ',';
- }
- if (!read.empty()) {
- options << "read=" << type << ',';
- }
- if (!command.empty()) {
- options << "command=" << type << ',';
- }
+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";
}
-#endif
+ // 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";
+}
- string opts(options.str().c_str());
- opts = strip(opts, ',');
+} // Anon. namespace
- // If it's not an inline image, surround it with the centering paragraph.
- if (! params.inlineFigure) {
- os << endl
- << "\\vspace{0.3cm}" << endl
- << "{\\par\\centering ";
+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_;
}
- // Do we want subcaptions?
- if (params.subcaption) {
- os << "\\subfigure[" << params.subcaptionText << "]{";
- }
+ // Enable these helper functions to find the file if it is stored as
+ // a relative path.
+ Path p(buf->filePath());
+
+ if (zipped)
+ filename_ = unzipFile(filename_);
- // We never used the starred form, we use the "clip" option instead.
- os << "\\includegraphics";
+ string const from = getExtFromContents(filename_);
+ string const to = findTargetFormat(from);
- if (!opts.empty()) {
- os << '[' << opts << ']';
+ if (from == to) {
+ // No conversion needed!
+ return filename_;
}
- // Make the filename relative to the lyx file
- string filename = MakeRelPath(params.filename, OnlyPath(buf->fileName()));
+ string const temp = AddName(buf->tmppath, filename_);
+ string const outfile_base = RemoveExtension(temp);
- // and remove the extension so the LaTeX will use whatever is
- // appropriate (when there are several versions in different formats)
- filename = ChangeExtension(filename, string());
+ 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;
- os << '{' << filename << '}';
+ converters.convert(buf, filename_, outfile_base, from, to);
+ return outfile_base;
+}
- // Do we want a subcaption?
- if (params.subcaption) {
- // Close the subcaption command
- os << '}';
- }
- // Is this an inline graphics?
- if (!params.inlineFigure) {
- os << " \\par}" << endl
- << "\\vspace{0.3cm}" << endl;
+int InsetGraphics::latex(Buffer const *buf, ostream & os,
+ bool /*fragile*/, bool/*fs*/) const
+{
+ // If there is no file specified or not existing,
+ // just output a message about it in the latex output.
+ lyxerr[Debug::GRAPHICS] << "[latex]filename = "
+ << params().filename << endl;
+ string const message =
+ (IsFileReadable(MakeAbsPath(params().filename, buf->filePath()))
+ && !params().filename.empty()) ?
+ string() :
+ string("bb = 0 0 200 100, draft, type=eps]");
+ lyxerr[Debug::GRAPHICS] << "[latex]Messagestring = " << message << endl;
+
+ // These variables collect all the latex code that should be before and
+ // after the actual includegraphics command.
+ string before;
+ string after;
+ // Do we want subcaptions?
+ if (params().subcaption) {
+ before += "\\subfigure[" + params().subcaptionText + "]{";
+ after = '}';
}
+ // 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();
+ lyxerr[Debug::GRAPHICS] << "[latex]opts = " << opts << endl;
+ if (!opts.empty() && !message.empty())
+ before += ("[" + opts + ',' + message);
+ else if (!message.empty())
+ before += ('[' + message);
+ else if (!opts.empty())
+ before += ("[" + opts + ']');
+ lyxerr[Debug::GRAPHICS] << "[latex]before = " << before << endl;
+ lyxerr[Debug::GRAPHICS] << "[latex]after = " << after << endl;
- // How do we decide to what format should we export?
- // cacheHandle->>export(ImageType::EPS);
- // cacheHandle->>export(ImageType::PNG);
+ // 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 + '{' + prepareFile(buf) + '}' + after) :
+ (before + '{' + params().filename + " not found!}" + after);
+ os << latex_str;
- return 1;
+ // Return how many newlines we issued.
+ int const newlines =
+ int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
+
+ return newlines;
}
-int InsetGraphics::Ascii(Buffer const *, ostream &, int) const
+int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
{
- // No graphics in ascii output.
+ // 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";
return 0;
}
-int InsetGraphics::Linuxdoc(Buffer const *, ostream &) const
+int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
{
// No graphics in LinuxDoc output. Should check how/what to add.
return 0;
}
-int InsetGraphics::DocBook(Buffer const *, ostream &) const
+// For explanation on inserting graphics into DocBook checkout:
+// http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
+// See also the docbook guide at http://www.docbook.org/
+int InsetGraphics::docbook(Buffer const *, ostream & os) const
{
- // No graphics in DocBook output. Should check how/what to add.
+ // 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;
}
-void InsetGraphics::Validate(LaTeXFeatures & features) const
+void InsetGraphics::validate(LaTeXFeatures & features) const
{
// If we have no image, we should not require anything.
- if (params.filename.empty())
+ if (params().filename.empty())
return ;
- features.graphicx = true;
+ features.includeFile(graphic_label, RemoveExtension(params_.filename));
- if (params.subcaption)
- features.subfigure = true;
-}
+ features.require("graphicx");
-// Update the inset after parameters changed (read from file or changed in
-// dialog.
-void InsetGraphics::updateInset()
-{
- // If file changed...
-
- GraphicsCache * gc = GraphicsCache::getInstance();
- GraphicsCacheItem * temp = 0;
-
- if (!params.filename.empty()) {
- temp = gc->addFile(params.filename);
- }
-
- delete cacheHandle;
- cacheHandle = temp;
+ if (params().subcaption)
+ features.require("subfigure");
}
-bool InsetGraphics::setParams(InsetGraphicsParams const & params)
+
+bool InsetGraphics::setParams(InsetGraphicsParams const & p,
+ string const & filepath)
{
// If nothing is changed, just return and say so.
- if (this->params == params)
+ if (params() == p && !p.filename.empty()) {
return false;
+ }
// Copy the new parameters.
- this->params = params;
+ params_ = p;
// Update the inset with the new parameters.
- updateInset();
+ updateInset(filepath);
// We have changed data, report it.
return true;
}
-InsetGraphicsParams InsetGraphics::getParams() const
-{
- return params;
-}
-Inset * InsetGraphics::Clone(Buffer const &) const
+InsetGraphicsParams const & InsetGraphics::params() const
{
- InsetGraphics * newInset = new InsetGraphics;
-
- newInset->cacheHandle = cacheHandle;
- newInset->pixmap = pixmap;
- newInset->pixmapInitialized = pixmapInitialized;
+ return params_;
+}
- newInset->setParams(getParams());
- return newInset;
+Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
+{
+ return new InsetGraphics(*this, buffer.filePath(), same_id);
}
projects / lyx.git / blobdiff