/*
Immediate tasks:
- * Add the GraphicsCache and FormatTranslator in order to get inline
- viewing of the figures.
+ * Make the inline viewing work, there is a preliminary work going on,
+ need to finish it up.
+
+ * Polishing tasks:
+ * Add messages in the empty rectangle to say how are we doing.
+ - Implemented, needs testing.
+ * Clean up GraphicsCacheItem(_pimpl)
+ * Pop up a dialog if the widget version is higher than what we accept.
+ * Prepare code to read FigInset insets to upgrade upwards
+ * Provide sed/awk/C code to downgrade from InsetGraphics to FigInset.
*/
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
+ pressing ok, it counts as if no real selection done. Apparently
when choosing a file it doesn't update the select file input line.
-
+ * Inline viewing is still not completely operational, in fact it is no
+ disabled. To enable it enable the define:
+ INSETGRAPHICS_INLINE_VIEW
+
Current PROBLEMS:
* How to support both PDF and PS output, should we do the conversion
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.
-
+
+ * Work on inline viewing of image.
+
TODO Before initial production release:
* Replace insetfig everywhere
* Read it's file format
* 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
* 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.
* 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.
+ * 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:
* 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
* transferring the file around.
*/
-
+
+#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 "frontends/support/LyXImage.h"
#include "Painter.h"
#include "lyx_gui_misc.h"
#include "filedlg.h"
#include "support/FileInfo.h"
#include "support/filetools.h"
#include "lyxtext.h"
+#include "font.h" // For the lyxfont class.
+#include <algorithm> // For the std::max
+#include "lyxrc.h"
#include "debug.h"
using std::ostream;
using std::endl;
-
+using std::max;
// 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)
+#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), pixmap(0), pixmapInitialized(false)
{}
InsetGraphics::~InsetGraphics()
{
- // Emits the hide signal to the dialog connected (if any)
- hide();
+ // Emits the hide signal to the dialog connected (if any)
+ hide();
}
-int InsetGraphics::ascent(BufferView *, LyXFont const &) const
+char const *
+InsetGraphics::statusMessage() const
+{
+ char const * msg = 0;
+
+#ifdef INSETGRAPHICS_INLINE_VIEW
+ switch (status) {
+ case GraphicsCacheItem::UnknownError:
+ msg = _("Unknown Error");
+ break;
+
+ case GraphicsCacheItem::Loading:
+ msg = _("Loading...");
+ break;
+
+ case GraphicsCacheItem::ErrorReading:
+ msg = _("Error reading");
+ break;
+
+ case GraphicsCacheItem::ErrorConverting:
+ msg = _("Error converting");
+ break;
+
+ case GraphicsCacheItem::Loaded:
+ // No message to write.
+ break;
+ }
+#else
+ msg = _("Inline view disabled");
+#endif
+
+ return msg;
+}
+
+int InsetGraphics::ascent(BufferView *, LyXFont const &) const
{
if (pixmapInitialized)
return cacheHandle->getHeight();
}
-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;
+ else {
+ char const * msg = statusMessage();
+ int font_width = lyxfont::width(msg, font);
+
+ 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();
+ int lwidth = width(bv, font);
+ int ldescent = descent(bv, font);
+ int lascent = ascent(bv, font);
+
// This will draw the graphics. If the graphics has not been loaded yet,
// we draw just a rectangle.
if (pixmapInitialized) {
- 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));
-
+ paint.image(int(x) + 2, baseline - lascent,
+ lwidth - 4, lascent + ldescent,
+ pixmap);
+ } else {
+#ifdef INSETGRAPHICS_INLINE_VIEW
+ // Get the image status, default to unknown error.
+ GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
+ if (cacheHandle)
+ status = cacheHandle->getImageStatus();
+
// Check if the image is now ready.
- if (cacheHandle &&
- (cacheHandle->getImageStatus() == GraphicsCacheItem::Loaded)) {
+ if (status == GraphicsCacheItem::Loaded) {
+ // It is, get it and inform the world.
pixmap = cacheHandle->getImage();
pixmapInitialized = true;
// Tell BufferView we need to be updated!
bv->text->status = LyXText::CHANGED_IN_DRAW;
+ return;
+ }
+#endif
+
+ char const * msg = statusMessage();
+
+ paint.rectangle(int(x) + 2, baseline - lascent,
+ lwidth - 4,
+ lascent + ldescent);
+
+ if (msg) {
+ // Print the message.
+ LyXFont msgFont(font);
+ msgFont.setFamily(LyXFont::SANS_FAMILY);
+ msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
+ string const justname = OnlyFilename (params.filename);
+ paint.text(int(x + 8), baseline - lyxfont::maxAscent(msgFont) - 4,
+ justname, msgFont);
+
+ msgFont.setSize(LyXFont::SIZE_TINY);
+ paint.text(int(x + 8), baseline - 4, msg, strlen(msg), msgFont);
}
}
- x += width(bv, font);
+ // Add the image width to the row width.
+ x += lwidth;
}
void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
{
- bv->owner()->getDialogs() -> showGraphics(this);
+ bv->owner()->getDialogs() -> showGraphics(this);
}
{
os << "GRAPHICS FormatVersion 1" << endl;
- params.Write(buf, os);
+ params.Write(buf, os);
}
#if 0
// 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
void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
{
- typedef map<string, enum TOKENS> ReadActionMap;
- static ReadActionMap const readMap;
+ typedef map < string, enum TOKENS > ReadActionMap;
+ static ReadActionMap const readMap;
- bool finished = false;
+ bool finished = false;
- while (lex.IsOK() && !finished) {
- lex.next();
+ while (lex.IsOK() && !finished) {
+ lex.next();
- string const token = lex.GetString();
- lyxerr.debug() << "Token: '" << token << '\'' << endl;
+ string const token = lex.GetString();
+ lyxerr.debug() << "Token: '" << token << '\'' << endl;
- if (token.empty())
- continue;
-
- ReadActionMap::const_iterator it =
- readMap.find(token);
+ if (token.empty())
+ continue;
- if (it == readMap.end()) {
- lyxerr << "Unknown keyword, skipping." << endl;
- continue;
- }
-
- switch (it.second) {
- case FILENAME_TOKEN:
- break;
- case VERSION_TOKEN:
- break;
- default:
- break;
- }
-
-
- }
+ 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;
+ }
+
+
+ }
}
-#endif
+#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();
+ 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();
}
-static void formatResize(ostream & os, char const *key,
- InsetGraphicsParams::Resize resizeType, double size)
+static
+void formatResize(ostream & os, string const & key,
+ InsetGraphicsParams::Resize resizeType, double size)
{
- 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;
-
- }
+ 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;
+
+ }
}
int InsetGraphics::Latex(Buffer const *buf, ostream & os,
- bool /*fragile*/, bool/*fs*/) const
+ bool /*fragile*/, bool/*fs*/) 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.
-#ifdef HAVE_SSTREAM
+ // (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;
-#else
- ostrstream options;
-#endif
-
- 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
+ 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 << ',';
+ << 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 << ',';
+ << viewport.llx << ' ' << viewport.lly << ' '
+ << viewport.urx << ' ' << viewport.ury << ',';
}
if (trim.isSet()) {
options << "trim="
- << trim.llx << ' ' << trim.lly << ' '
- << trim.urx << ' ' << trim.ury << ',';
+ << trim.llx << ' ' << trim.lly << ' '
+ << trim.urx << ' ' << trim.ury << ',';
}
if (natheight.value() != 0) {
options << "natheight=" << natheight.asString() << ',';
options << "angle=" << angle << ',';
}
if (origin != DEFAULT) {
- switch(origin) {
+ switch (origin) {
case DEFAULT: break;
case LEFTTOP:
options << "origin=lt,";
}
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 << ',';
- }
- }
-#endif
-#ifdef HAVE_SSTREAM
+ // 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 << ',';
+ }
+ }
+#endif
+
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 << "]{";
- }
-
+
+ // 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";
+ os << "\\includegraphics";
if (!opts.empty()) {
os << '[' << opts << ']';
}
- // Make the filename relative to the lyx file
- string filename = MakeRelPath(params.filename, OnlyPath(buf->fileName()));
+ // Make the filename relative to the lyx file
+ string filename = MakeRelPath(params.filename, OnlyPath(buf->fileName()));
- // and remove the extension so the LaTeX will use whatever is
- // appropriate (when there are several versions in different formats)
- filename = ChangeExtension(filename, string());
+ // and remove the extension so the LaTeX will use whatever is
+ // appropriate (when there are several versions in different formats)
+ filename = ChangeExtension(filename, string());
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);
-
+ // 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?
+ string extension = GetExtension(params.filename);
+ if (lyxrc.pdf_mode) {
+ if (extension != "jpg")
+ converters.Convert(buf,
+ params.filename, params.filename,
+ extension, "png");
+ } else
+ converters.Convert(buf, params.filename, params.filename,
+ extension, "eps");
+
return 1;
}
-int InsetGraphics::Ascii(Buffer const *, ostream &) const
+int InsetGraphics::Ascii(Buffer const *, ostream &, int) const
{
- // No graphics in ascii output.
+ // No graphics in ascii output.
return 0;
}
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
{
- // No graphics in DocBook output. Should check how/what to add.
+ // No graphics in DocBook output. Should check how/what to add.
return 0;
}
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.graphicx = true;
- if (params.subcaption)
- features.subfigure = true;
+ if (params.subcaption)
+ features.subfigure = true;
}
// Update the inset after parameters changed (read from file or changed in
// dialog.
-void InsetGraphics::updateInset()
+void InsetGraphics::updateInset() const
{
- // If file changed...
+ // If file changed...
+#ifdef INSETGRAPHICS_INLINE_VIEW
GraphicsCache * gc = GraphicsCache::getInstance();
GraphicsCacheItem * temp = 0;
delete cacheHandle;
cacheHandle = temp;
+#else
+ cacheHandle = 0;
+#endif
}
bool InsetGraphics::setParams(InsetGraphicsParams const & params)
{
// If nothing is changed, just return and say so.
- if (this->params == params)
- return false;
+ if (this->params == params)
+ return false;
- // Copy the new parameters.
- this->params = params;
+ // Copy the new parameters.
+ this->params = params;
- // 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 &) const
{
- InsetGraphics * newInset = new InsetGraphics;
- newInset->setParams(getParams());
-
+ InsetGraphics * newInset = new InsetGraphics;
+
+ if (cacheHandle)
+ newInset->cacheHandle = cacheHandle->Clone();
+ else
+ newInset->cacheHandle = 0;
+ newInset->pixmap = pixmap;
+ newInset->pixmapInitialized = pixmapInitialized;
+
+ newInset->setParams(getParams());
+
return newInset;
}
projects / lyx.git / blobdiff