/* This file is part of
- * ======================================================
- *
+ * ======================================================
+ *
* LyX, The Document Processor
- *
+ *
* Copyright 1995-2002 the LyX Team.
- *
+ *
* \author Baruch Even
* \author Herbert Voss <voss@lyx.org>
* ====================================================== */
/*
Known BUGS:
-
+
* If the image is from the clipart, and the document is moved to another
- directory, the user is screwed. Need a way to handle it.
- This amounts to a problem of when to use relative or absolute file paths
- We should probably use what the user asks to use... but when he chooses
- by the file dialog we normally get an absolute path and this may not be
- what the user meant.
- [Note that browseRelFile in helper_funcs.* provides a file name
- which is relative if it is at reference path (here puffer path)
- level or below, and an absolute path if the file name is not a
- `natural' relative file name. In any case,
- MakeAbsPath(filename, buf->filePath())
- is guaranteed to provide the correct absolute path. This is what is
- done know for include insets. Feel free to ask me -- JMarc
- 14/01/2002]
-
- * 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.]
-
- * 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.
+ 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
- * Search for comments of the form
- // INSET_GRAPHICS: remove this when InsetFig is thrown.
- 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.
+
+ * 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.
+ 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.
- * 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.
- */
+ * 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:
* Fileformat:
* 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:
* Postscript output means EPS figures.
*
* 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
+ * 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/GraphicsImage.h"
#include "LyXView.h"
+#include "lyxtext.h"
#include "buffer.h"
#include "BufferView.h"
#include "converter.h"
#include "LaTeXFeatures.h"
#include "frontends/Dialogs.h"
-#include "frontends/Alert.h"
#include "frontends/controllers/helper_funcs.h" // getVectorFromString
#include "support/LAssert.h"
#include "support/filetools.h"
#include "support/lyxalgo.h" // lyx::count
+#include "support/path.h"
#include <algorithm> // For the std::max
{
return ChangeExtension(filename, string());
}
-
+
} // namespace anon
InsetGraphics::InsetGraphics()
: graphic_label(unique_id()),
- cached_status_(grfx::ErrorUnknown), cache_filled_(false)
-
+ cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
+
{}
-InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
+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)
+ cached_status_(grfx::ErrorUnknown), cache_filled_(false), old_asc(0)
{
- setParams(ig.params());
- if (same_id)
- id_ = ig.id_;
+ setParams(ig.params(), filepath);
}
msg = _("Error scaling etc");
break;
case grfx::ErrorUnknown:
- msg = _("No image associated with this inset is in the cache!");
+ msg = _("No image");
break;
case grfx::Loaded:
msg = _("Loaded but not displaying");
return pixmap != 0;
}
-
+
int InsetGraphics::ascent(BufferView *, LyXFont const &) const
{
+ old_asc = 50;
if (drawImage())
- return cached_image_->getHeight();
- else
- return 50;
+ old_asc = cached_image_->getHeight();
+ return old_asc;
}
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
{
+ int oasc = old_asc;
+ grfx::ImageStatus old_status_ = cached_status_;
+
int ldescent = descent(bv, font);
int lascent = ascent(bv, font);
int lwidth = width(bv, font);
+ // we may have changed while someone other was drawing us so better
+ // to not draw anything as we surely call to redraw ourself soon.
+ // This is not a nice thing to do and should be fixed properly somehow.
+ // But I still don't know the best way to go. So let's do this like this
+ // for now (Jug 20020311)
+ if (lascent != oasc) {
+// lyxerr << "IG(" << this << "): " << x << endl;
+ return;
+ }
+
// Make sure now that x is updated upon exit from this routine
int old_x = int(x);
x += lwidth;
Painter & paint = bv->painter();
if (drawImage()) {
-
+// lyxerr << "IG(" << this << "): " << old_x << endl;
paint.image(old_x + 2, baseline - lascent,
- lwidth - 4, lascent + ldescent,
+ lwidth - 4, lascent + ldescent,
*cached_image_.get());
- } else {
+ } else {
paint.rectangle(old_x + 2, baseline - lascent,
- lwidth - 4,
- lascent + ldescent);
+ lwidth - 4,
+ lascent + ldescent);
// Print the file name.
LyXFont msgFont(font);
string const justname = OnlyFilename (params().filename);
if (!justname.empty()) {
msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
- paint.text(old_x + 8,
+ paint.text(old_x + 8,
baseline - lyxfont::maxAscent(msgFont) - 4,
justname, msgFont);
}
}
}
+ // the status message may mean we changed size, so indicate
+ // we need a row redraw
+ if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
+ bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
+ }
+
// Reset the cache, ready for the next draw request
cached_status_ = grfx::ErrorUnknown;
cached_image_.reset(0);
// 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() const
+void InsetGraphics::updateInset(string const & filepath) const
{
grfx::GCache & gc = grfx::GCache::get();
- gc.update(*this);
+ gc.update(*this, filepath);
}
}
-void InsetGraphics::write(Buffer const * buf, ostream & os) const
+void InsetGraphics::write(Buffer const *, ostream & os) const
{
os << "Graphics FormatVersion " << VersionNumber << '\n';
- params().Write(buf, os);
+ params().Write(os);
}
string const token = lex.getString();
if (token == "Graphics")
- readInsetGraphics(buf, lex);
+ readInsetGraphics(lex);
else if (token == "Figure") // Compatibility reading of FigInset figures.
- readFigInset(buf, lex);
+ readFigInset(lex);
else
lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
- updateInset();
+ updateInset(buf->filePath());
}
-void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
+
+void InsetGraphics::readInsetGraphics(LyXLex & lex)
{
bool finished = false;
lex.next();
string const token = lex.getString();
- lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
+ lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
<< std::endl;
if (token.empty()) {
// TODO: Possibly open up a dialog?
}
else {
- if (! params_.Read(buf, lex, token))
- lyxerr << "Unknown token, " << token << ", skipping."
+ if (! params_.Read(lex, token))
+ lyxerr << "Unknown token, " << token << ", skipping."
<< std::endl;
}
}
}
// FormatVersion < 1.0 (LyX < 1.2)
-void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
+void InsetGraphics::readFigInset(LyXLex & lex)
{
std::vector<string> const oldUnits =
getVectorFromString("pt,cm,in,p%,c%");
bool finished = false;
- // set the display default
- if (lyxrc.display_graphics == "mono")
+ // set the display default
+ if (lyxrc.display_graphics == "mono")
params_.display = InsetGraphicsParams::MONOCHROME;
- else if (lyxrc.display_graphics == "gray")
+ else if (lyxrc.display_graphics == "gray")
params_.display = InsetGraphicsParams::GRAYSCALE;
- else if (lyxrc.display_graphics == "color")
+ else if (lyxrc.display_graphics == "color")
params_.display = InsetGraphicsParams::COLOR;
else
params_.display = InsetGraphicsParams::NONE;
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()) {
- string const name = lex.getString();
- string const path = buf->filePath();
- params_.filename = MakeAbsPath(name, path);
+ params_.filename = lex.getString();
}
} else if (token == "extra") {
if (lex.next());
if (lex.next())
params_.lyxwidth = LyXLength(lex.getString()+"pt");
if (lex.next())
- params_.lyxheight = LyXLength(lex.getString()+"pt");
+ 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;
+ case 1: params_.display = InsetGraphicsParams::MONOCHROME;
break;
- case 2: params_.display = InsetGraphicsParams::GRAYSCALE;
+ case 2: params_.display = InsetGraphicsParams::GRAYSCALE;
break;
- case 3: params_.display = InsetGraphicsParams::COLOR;
+ case 3: params_.display = InsetGraphicsParams::COLOR;
break;
}
} else if (token == "subfigure") {
{
// lyxrc.pdf_mode means:
// Are we creating a PDF or a PS file?
- // (Should actually mean, are we using latex or pdflatex).
+ // (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) {
bool const zipped = zippedFile(filename_);
if ((zipped && params().noUnzip) || buf->niceFile) {
- lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
+ lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
<< filename_ << endl;
return filename_;
}
+ // Enable these helper functions to find the file if it is stored as
+ // a relative path.
+ Path p(buf->filePath());
+
if (zipped)
filename_ = unzipFile(filename_);
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.
- }
+ // 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;
}
// 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 +']');
- }
+ 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;
+
// 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;
+ string const latex_str = message.empty() ?
+ (before + '{' + prepareFile(buf) + '}' + after) :
+ (before + '{' + params().filename + " not found!}" + 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;
}
// 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";
+ os << '<' << _("Graphic file:") << params().filename << ">\n";
return 0;
}
// See also the docbook guide at http://www.docbook.org/
int InsetGraphics::docbook(Buffer const *, ostream & os) const
{
- // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
- // need to switch to MediaObject. However, for now this is sufficient and
+ // 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;
}
-bool InsetGraphics::setParams(InsetGraphicsParams const & p)
+bool InsetGraphics::setParams(InsetGraphicsParams const & p,
+ string const & filepath)
{
// If nothing is changed, just return and say so.
if (params() == p && !p.filename.empty()) {
params_ = p;
// Update the inset with the new parameters.
- updateInset();
+ updateInset(filepath);
// We have changed data, report it.
return true;
}
-Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
+Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
{
- return new InsetGraphics(*this, same_id);
+ return new InsetGraphics(*this, buffer.filePath(), same_id);
}
projects / lyx.git / blobdiff