*
* LyX, The Document Processor
*
- * Copyright 1995-2000 the LyX Team.
+ * Copyright 1995-2002 the LyX Team.
*
- * This file Copyright 2000 Baruch Even.
+ * \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:
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.
+ [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]
- * 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
+ * If we are trying to create a file in a read-only directory and there
+ are graphics that need converting, the converting will fail because
+ it is done in-place, into the same directory as the original image.
+ This needs to be fixed in the src/converter.C file
+ [ This is presumed to be fixed, needs testing.]
- * Create the GraphicsCache and FormatTranslator
- * Add inline viewing of image.
+ * We do not dither or resize the image in a WYSIWYM way, we load it at
+ its original size and color, resizing is done in the final output,
+ but not in the LyX window.
TODO Before initial production release:
* Replace insetfig everywhere
- * 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
+ And act upon them. Make sure not to remove InsetFig code for the
+ 1.2.0 release, only afterwards, after deployment shows InsetGraphics
+ to be ok.
* What advanced features the users want to do?
Implement them in a non latex dependent way, but a logical way.
LyX should translate it to latex or any other fitting format.
* 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
+ * 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.
* 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.
+ 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.
+ * Postscript output means EPS figures.
*
- * 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.
- *
- * 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>
+
#ifdef __GNUG__
#pragma implementation
-#endif
-
-#include <config.h>
+#endif
#include "insets/insetgraphics.h"
#include "insets/insetgraphicsParams.h"
+
#include "graphics/GraphicsCache.h"
#include "graphics/GraphicsCacheItem.h"
-
-#include "frontends/Dialogs.h"
+
#include "LyXView.h"
#include "buffer.h"
#include "BufferView.h"
+#include "converter.h"
#include "Painter.h"
#include "lyx_gui_misc.h"
-#include "filedlg.h"
+#include "lyxtext.h"
+#include "lyxrc.h"
+#include "font.h"
+#include "debug.h"
+#include "gettext.h"
+
+#include "frontends/Dialogs.h"
+#include "frontends/Alert.h"
+#include "frontends/controllers/helper_funcs.h"
+#include "frontends/support/LyXImage.h"
+
#include "support/FileInfo.h"
#include "support/filetools.h"
-#include "lyxtext.h"
+#include "support/lyxlib.h"
+#include "support/lyxmanip.h"
+#include "support/lyxalgo.h"
-#include "debug.h"
+#include <fstream>
+#include <algorithm>
+extern string system_tempdir;
+using std::ifstream;
using std::ostream;
using std::endl;
+using std::max;
+using std::vector;
+
+
+///////////////////////////////////////////////////////////////////////////
+int const VersionNumber = 1;
+///////////////////////////////////////////////////////////////////////////
+
+// This function is a utility function
+// ... that should be with ChangeExtension ...
+inline
+string const RemoveExtension(string const & filename)
+{
+ return ChangeExtension(filename, string());
+}
+
+
+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
- : pixmapInitialized(false),cacheHandle(0)
+ : cacheHandle(0), imageLoaded(false), graphic_label(unique_id())
{}
+
+InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
+ : Inset(), SigC::Object()
+ , cacheHandle(ig.cacheHandle)
+ , imageLoaded(ig.imageLoaded)
+ , graphic_label(unique_id())
+{
+ setParams(ig.getParams());
+ if (same_id)
+ id_ = ig.id_;
+}
+
+
InsetGraphics::~InsetGraphics()
{
- // Emits the hide signal to the dialog connected (if any)
- hide();
+ // Emits the hide signal to the dialog connected (if any)
+ hideDialog();
+}
+
+
+string const InsetGraphics::statusMessage() const
+{
+ string msg;
+ if (cacheHandle.get()) {
+ switch (cacheHandle->getImageStatus()) {
+ case GraphicsCacheItem::UnknownError:
+ msg = _("Unknown Error");
+ break;
+ case GraphicsCacheItem::Loading:
+ msg = _("Loading...");
+ break;
+ case GraphicsCacheItem::ErrorReading:
+ msg = _("Error reading");
+ break;
+ case GraphicsCacheItem::Converting:
+ msg = _("Converting Image");
+ break;
+ case GraphicsCacheItem::ErrorConverting:
+ msg = _("Error converting");
+ break;
+ case GraphicsCacheItem::Loaded:
+ // No message to write.
+ break;
+ }
+ }
+ return msg;
}
-int InsetGraphics::ascent(BufferView *, LyXFont const &) const
+
+int InsetGraphics::ascent(BufferView *, LyXFont const &) const
{
- if (pixmapInitialized)
- return cacheHandle->getHeight();
+ LyXImage * pixmap = 0;
+ if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
+ return pixmap->getHeight();
else
return 50;
}
-int InsetGraphics::descent(BufferView *, LyXFont const &) const
+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;
+ LyXImage * pixmap = 0;
+
+ if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
+ return pixmap->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 = max(font_width, msg_width);
+ }
+
+ return 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();
- // This will draw the graphics. If the graphics has not been loaded yet,
- // we draw just a rectangle.
- if (pixmapInitialized) {
+ int ldescent = descent(bv, font);
+ int lascent = ascent(bv, font);
+ int lwidth = width(bv, font);
- paint.pixmap(int(x)+2, baseline - ascent(bv, font),
- width(bv, font) - 4,
- ascent(bv,font) + descent(bv,font),
- pixmap);
- } else {
- paint.rectangle(int(x)+2, baseline - ascent(bv, font),
- width(bv, font) - 4,
- ascent(bv, font) + descent(bv, font));
+ // Make sure x is updated upon exit from this routine
+ int old_x = int(x);
+ x += lwidth;
+ // This will draw the graphics. If the graphics has not been loaded yet,
+ // we draw just a rectangle.
+ if (imageLoaded) {
+
+ paint.image(old_x + 2, baseline - lascent,
+ lwidth - 4, lascent + ldescent,
+ cacheHandle->getImage());
+ } else {
+ // Get the image status, default to unknown error.
+ GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
+ if (lyxrc.use_gui && params.display != InsetGraphicsParams::NONE &&
+ cacheHandle.get())
+ status = cacheHandle->getImageStatus();
// Check if the image is now ready.
- if (cacheHandle &&
- (cacheHandle->getImageStatus() == GraphicsCacheItem::Loaded)) {
- pixmap = cacheHandle->getImage();
- pixmapInitialized = true;
-
+ if (status == GraphicsCacheItem::Loaded) {
+ imageLoaded = true;
// Tell BufferView we need to be updated!
- bv->text->status = LyXText::CHANGED_IN_DRAW;
+ bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
+ return;
+ }
+ 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);
}
}
-
- x += width(bv, font);
}
-void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
+void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
{
- bv->owner()->getDialogs() -> showGraphics(this);
+ bv->owner()->getDialogs()->showGraphics(this);
}
-Inset::EDITABLE InsetGraphics::Editable() const
+void InsetGraphics::edit(BufferView * bv, bool)
{
- return IS_EDITABLE;
+ edit(bv, 0, 0, 0);
}
-void InsetGraphics::Write(Buffer const * buf, ostream & os) const
+Inset::EDITABLE InsetGraphics::editable() const
{
- os << "GRAPHICS FormatVersion 1" << endl;
-
- params.Write(buf, os);
+ return IS_EDITABLE;
}
-#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)
+
+void InsetGraphics::write(Buffer const * buf, ostream & os) const
{
- 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;
-
- if (token.empty())
- continue;
-
- ReadActionMap::const_iterator it =
- readMap.find(token);
-
- if (it == readMap.end()) {
- lyxerr << "Unknown keyword, skipping." << endl;
- continue;
- }
-
- switch (it.second) {
- case FILENAME_TOKEN:
- break;
- case VERSION_TOKEN:
- break;
- default:
- break;
- }
-
-
- }
+ os << "Graphics FormatVersion " << VersionNumber << '\n';
+ params.Write(buf, os);
}
-#endif
-void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
+
+void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
{
- bool finished = false;
-
- while (lex.IsOK() && !finished) {
- lex.next();
-
- string const token = lex.GetString();
- lyxerr.debug() << "Token: '" << token << '\'' << endl;
-
- if (token.empty()) {
- continue;
- } else if (token == "\\end_inset") {
- finished = true;
- } else if (token == "FormatVersion") {
- lex.next();
- int version = lex.GetInteger();
- if (version > 1)
- lyxerr
- << "This document was created with a newer Graphics widget"
- ", You should use a newer version of LyX to read this"
- " file."
- << endl;
- // TODO: Possibly open up a dialog?
- } else {
- if (! params.Read(buf, lex, token))
- lyxerr << "Unknown token, " << token << ",skipping." << endl;
- }
- }
-
- updateInset();
+ string const token = lex.getString();
+
+ if (token == "Graphics")
+ readInsetGraphics(buf, lex);
+ else if (token == "Figure") // Compatibility reading of FigInset figures.
+ readFigInset(buf, lex);
+ else
+ lyxerr[Debug::INFO] << "Not a Graphics or Figure inset!\n";
+
+ updateInset();
}
-static void formatResize(ostream & os, char const *key,
- InsetGraphicsParams::Resize resizeType, double size)
+void InsetGraphics::readInsetGraphics(Buffer const * buf, 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;
-
- case InsetGraphicsParams::PERCENT_COLUMN:
- os << key << '=' << size/100 << "\\column" << key << ',';
- break;
-
- }
+ bool finished = false;
+
+ while (lex.isOK() && !finished) {
+ lex.next();
+
+ string const token = lex.getString();
+ lyxerr[Debug::INFO] << "Token: '" << token << '\''
+ << endl;
+
+ if (token.empty()) {
+ continue;
+ } else if (token == "\\end_inset") {
+ finished = true;
+ } else if (token == "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."
+ << endl;
+ // TODO: Possibly open up a dialog?
+ }
+ else {
+ if (! params.Read(buf, lex, token))
+ lyxerr << "Unknown token, " << token << ", skipping."
+ << endl;
+ }
+ }
}
-int InsetGraphics::Latex(Buffer const *buf, ostream & os,
- bool /*fragile*/, bool/*fs*/) const
+// FormatVersion < 1.0 (LyX < 1.2)
+void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
{
- // 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.
-#ifdef HAVE_SSTREAM
- std::ostringstream options;
-#else
- ostrstream options;
-#endif
-
- formatResize(options, "width", params.widthResize, params.widthSize);
- formatResize(options, "height", params.heightResize, params.heightSize);
+ 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();
- 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 << ',';
- }
- if (hiresbb) {
- options << "hiresbb,";
- }
- 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;
+ string const token = lex.getString();
+ lyxerr[Debug::INFO] << "Token: " << token << endl;
+
+ if (token.empty())
+ continue;
+ else if (token == "\\end_inset") {
+ finished = true;
+ } else if (token == "file") {
+ if (lex.next()) {
+ string const name = lex.getString();
+ string const path = buf->filePath();
+ params.filename = MakeAbsPath(name, path);
+ }
+ } else if (token == "extra") {
+ if (lex.next());
+ // kept for backwards compability. Delete in 0.13.x
+ } else if (token == "subcaption") {
+ if (lex.eatLine())
+ params.subcaptionText = lex.getString();
+ params.subcaption = true;
+ } else if (token == "label") {
+ if (lex.next());
+ // kept for backwards compability. Delete in 0.13.x
+ } else if (token == "angle") {
+ if (lex.next())
+ params.rotate = true;
+ params.rotateAngle = lex.getFloat();
+ } else if (token == "size") {
+ if (lex.next())
+ params.lyxwidth = LyXLength(lex.getString()+"pt");
+ if (lex.next())
+ params.lyxheight = LyXLength(lex.getString()+"pt");
+ } else if (token == "flags") {
+ if (lex.next())
+ switch (lex.getInteger()) {
+ case 1: params.display = InsetGraphicsParams::MONOCHROME;
+ break;
+ case 2: params.display = InsetGraphicsParams::GRAYSCALE;
+ break;
+ case 3: params.display = InsetGraphicsParams::COLOR;
+ break;
+ }
+ } else if (token == "subfigure") {
+ params.subcaption = true;
+ } else if (token == "width") {
+ if (lex.next()) {
+ int i = lex.getInteger();
+ if (lex.next()) {
+ if (i == 5) {
+ params.scale = lex.getInteger();
+ params.size_type = InsetGraphicsParams::SCALE;
+ } else {
+ params.width = LyXLength(lex.getString()+oldUnits[i]);
+ params.size_type = InsetGraphicsParams::WH;
+ }
+ }
+ }
+ } else if (token == "height") {
+ if (lex.next()) {
+ int i = lex.getInteger();
+ if (lex.next()) {
+ params.height = LyXLength(lex.getString()+oldUnits[i]);
+ params.size_type = InsetGraphicsParams::WH;
+ }
+ }
}
}
- 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,";
+}
+
+string const InsetGraphics::createLatexOptions() const
+{
+ // 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.
+ 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 (!type.empty()) {
- options << "type=" << type << ',';
-
- // 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 << ',';
+ 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";
}
- }
-#endif
-
-#ifdef HAVE_SSTREAM
- string opts(options.str().c_str());
-#else
- options << '\0';
- char * tmp = options.str();
- string opts(tmp);
- delete [] tmp;
-#endif
- opts = strip(opts, ',');
-
-
- // If it's not an inline image, surround it with the centering paragraph.
- if (! params.inlineFigure) {
- os << endl
- << "\\vspace{0.3cm}" << endl
- << "{\\par\\centering ";
- }
-
- // Do we want subcaptions?
- if (params.subcaption) {
- os << "\\subfigure[" << params.subcaptionText << "]{";
- }
-
- // We never used the starred form, we use the "clip" option instead.
- os << "\\includegraphics";
+ }
+ if (!params.special.empty())
+ options << params.special << ",\n";
+ string opts = options.str().c_str();
+ return opts.substr(0,opts.size()-2); // delete last ",\n"
+}
- if (!opts.empty()) {
- os << '[' << opts << ']';
+namespace {
+string decideOutputImageFormat(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::INFO] << "decideOutput::lyxrc.pdf_mode = " << lyxrc.pdf_mode << "\n";
+ if (lyxrc.pdf_mode) {
+ if (contains(suffix,"ps") || suffix == "pdf")
+ return "pdf";
+ else if (suffix == "jpg")
+ return suffix;
+ else
+ return "png";
}
+ // If it's postscript, we always do eps.
+ lyxerr[Debug::INFO] << "decideOutput: we have PostScript mode\n";
+ if (suffix != "ps")
+ return "eps";
+ else
+ return "ps";
+}
- // Make the filename relative to the lyx file
- string filename = MakeRelPath(params.filename, OnlyPath(buf->fileName()));
+} // Anon. namespace
- // and remove the extension so the LaTeX will use whatever is
- // appropriate (when there are several versions in different formats)
- filename = ChangeExtension(filename, string());
+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!!!
+ if ((zippedFile(params.filename) && params.noUnzip) || buf->niceFile) {
+ lyxerr[Debug::INFO] << "don't unzip file or export latex"
+ << params.filename << endl;
+ return params.filename;
+ }
+ string filename_ = params.filename;
+ if (zippedFile(filename_))
+ filename_ = unzipFile(filename_);
+ // now we have unzipped files
+ // Get the extension (format) of the original file.
+ // we handle it like a virtual one, so we can have
+ // different extensions with the same type.
+ string const extension = getExtFromContents(filename_);
+ // are we usind latex ((e)ps) or pdflatex (pdf,jpg,png)
+ string const image_target = decideOutputImageFormat(extension);
+ if (extension == image_target) // :-)
+ return filename_;
+// commented out to check if the "not exist"bug is fixed.
+// if (!IsFileReadable(filename_)) { // :-(
+// Alert::alert(_("File") + params.filename,
+// _("isn't readable or doesn't exists!"));
+// return filename_;
+// }
+ string outfile;
+ string const temp = AddName(buf->tmppath, filename_);
+ outfile = RemoveExtension(temp);
+ lyxerr[Debug::INFO] << "tempname = " << temp << "\n";
+ lyxerr[Debug::INFO] << "buf::tmppath = " << buf->tmppath << "\n";
+ lyxerr[Debug::INFO] << "filename_ = " << filename_ << "\n";
+ lyxerr[Debug::INFO] << "outfile = " << outfile << endl;
+ converters.convert(buf, filename_, outfile, extension, image_target);
+ return outfile;
+}
- os << '{' << filename << '}';
- // 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;
- }
-
- // How do we decide to what format should we export?
-// cacheHandle->>export(ImageType::EPS);
-// cacheHandle->>export(ImageType::PNG);
-
- return 1;
+int InsetGraphics::latex(Buffer const *buf, ostream & os,
+ bool /*fragile*/, bool/*fs*/) const
+{
+ // If there is no file specified, just output a message about it in
+ // the latex output.
+ if (params.filename.empty()) {
+ os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
+ << _("empty figure path") << "}\n";
+ return 1; // One end of line marker added to the stream.
+ }
+ // 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();
+ 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;
+ os << latex_str;
+ // Return how many newlines we issued.
+ int const newlines =
+ int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
+ // lyxerr << "includegraphics: " << newlines << " lines of text"
+ // << endl;
+ return newlines;
}
-int InsetGraphics::Ascii(Buffer const *, ostream &) 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 << '<' << _("Graphicfile:") << 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.
+ // 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())
- return;
+ // If we have no image, we should not require anything.
+ if (params.filename.empty())
+ return ;
+
+ features.includeFile(graphic_label, RemoveExtension(params.filename));
- features.graphicx = true;
+ features.require("graphicx");
- if (params.subcaption)
- features.subfigure = true;
+ if (params.subcaption)
+ features.require("subfigure");
}
+
// Update the inset after parameters changed (read from file or changed in
// dialog.
-void InsetGraphics::updateInset()
+void InsetGraphics::updateInset() const
{
- // If file changed...
-
- GraphicsCache * gc = GraphicsCache::getInstance();
- GraphicsCacheItem * temp = 0;
+ GraphicsCache & gc = GraphicsCache::getInstance();
+ boost::shared_ptr<GraphicsCacheItem> temp(0);
+
+ // We do it this way so that in the face of some error, we will still
+ // be in a valid state.
+ InsetGraphicsParams::DisplayType local_display = params.display;
+ if (local_display == InsetGraphicsParams::DEFAULT) {
+ if (lyxrc.display_graphics == "mono")
+ local_display = InsetGraphicsParams::MONOCHROME;
+ else if (lyxrc.display_graphics == "gray")
+ local_display = InsetGraphicsParams::GRAYSCALE;
+ else if (lyxrc.display_graphics == "color")
+ local_display = InsetGraphicsParams::COLOR;
+ else
+ local_display = InsetGraphicsParams::NONE;
+ }
- if (!params.filename.empty()) {
- temp = gc->addFile(params.filename);
+ if (!params.filename.empty() && lyxrc.use_gui &&
+ local_display != InsetGraphicsParams::NONE) {
+ temp = gc.addFile(params.filename);
}
- delete cacheHandle;
+ // Mark the image as unloaded so that it gets updated.
+ imageLoaded = false;
+
cacheHandle = temp;
}
-bool InsetGraphics::setParams(InsetGraphicsParams const & params)
+
+bool InsetGraphics::setParams(InsetGraphicsParams const & p)
{
// If nothing is changed, just return and say so.
- if (this->params == params)
- return false;
+ if (params == p)
+ return false;
- // Copy the new parameters.
- this->params = params;
+ // Copy the new parameters.
+ params = p;
- // Update the inset with the new parameters.
- updateInset();
-
- // We have changed data, report it.
- return true;
+ // Update the inset with the new parameters.
+ updateInset();
+
+ // We have changed data, report it.
+ return true;
}
+
InsetGraphicsParams InsetGraphics::getParams() const
{
- return params;
+ return params;
}
-Inset * InsetGraphics::Clone() const
+
+Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
{
- InsetGraphics * newInset = new InsetGraphics;
- newInset->setParams(getParams());
-
- return newInset;
+ return new InsetGraphics(*this, same_id);
}
+
projects / lyx.git / blobdiff