2000-02-29 02:19:17 +00:00
|
|
|
/* This file is part of
|
|
|
|
* ======================================================
|
|
|
|
*
|
|
|
|
* LyX, The Document Processor
|
|
|
|
*
|
|
|
|
* Copyright 1995-2000 the LyX Team.
|
2000-07-31 12:30:10 +00:00
|
|
|
*
|
|
|
|
* This file Copyright 2000 Baruch Even.
|
2000-02-29 02:19:17 +00:00
|
|
|
* ====================================================== */
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
/*
|
|
|
|
How to use it for now:
|
|
|
|
* The lyxfunc 'graphics-insert' will insert this inset into the document.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2001-03-18 17:48:56 +00:00
|
|
|
Major tasks:
|
|
|
|
* Switch to convert the images in the background, this requires work on
|
|
|
|
the converter, the systemcontroller and the graphics cache.
|
|
|
|
|
|
|
|
Minor tasks:
|
|
|
|
* 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(?)
|
2000-07-31 12:30:10 +00:00
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
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
|
2000-10-12 10:46:06 +00:00
|
|
|
pressing ok, it counts as if no real selection done. Apparently
|
2000-07-31 12:30:10 +00:00
|
|
|
when choosing a file it doesn't update the select file input line.
|
2001-03-18 17:48:56 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
* 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.
|
2001-02-20 09:08:56 +00:00
|
|
|
This needs to be fixed in the src/converter.C file
|
2001-03-18 17:48:56 +00:00
|
|
|
[ This is presumed to be fixed, needs testing.]
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
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.
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
TODO Extended features:
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
* Advanced Latex tab folder.
|
2001-02-08 13:06:55 +00:00
|
|
|
* Add support for more features so that it will be better than insetfig.
|
|
|
|
* Keep aspect ratio radio button
|
2000-07-31 12:30:10 +00:00
|
|
|
* 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.
|
|
|
|
* Add a way to roll the image file into the file format.
|
2001-02-08 13:06:55 +00:00
|
|
|
* When loading, if the image is not found in the expected place, try
|
2000-07-31 12:30:10 +00:00
|
|
|
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.
|
2000-08-08 09:18:39 +00:00
|
|
|
* 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.
|
2000-10-12 10:46:06 +00:00
|
|
|
* 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.
|
2000-07-31 12:30:10 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/* 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)
|
|
|
|
*/
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
#include <config.h>
|
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
#ifdef __GNUG__
|
|
|
|
#pragma implementation
|
2000-08-14 09:44:53 +00:00
|
|
|
#endif
|
2000-02-29 02:19:17 +00:00
|
|
|
|
|
|
|
#include "insets/insetgraphics.h"
|
2000-07-31 12:30:10 +00:00
|
|
|
#include "insets/insetgraphicsParams.h"
|
|
|
|
#include "graphics/GraphicsCache.h"
|
|
|
|
#include "graphics/GraphicsCacheItem.h"
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
#include "frontends/Dialogs.h"
|
|
|
|
#include "LyXView.h"
|
|
|
|
#include "buffer.h"
|
2000-06-21 15:07:57 +00:00
|
|
|
#include "BufferView.h"
|
2000-10-12 10:46:06 +00:00
|
|
|
#include "converter.h"
|
|
|
|
#include "frontends/support/LyXImage.h"
|
2000-02-29 02:19:17 +00:00
|
|
|
#include "Painter.h"
|
2000-03-09 23:58:55 +00:00
|
|
|
#include "lyx_gui_misc.h"
|
|
|
|
#include "support/FileInfo.h"
|
|
|
|
#include "support/filetools.h"
|
2001-02-08 13:06:55 +00:00
|
|
|
#include "support/lyxlib.h"
|
2000-08-10 13:15:05 +00:00
|
|
|
#include "lyxtext.h"
|
2001-02-08 13:06:55 +00:00
|
|
|
#include "lyxrc.h"
|
2000-10-12 10:46:06 +00:00
|
|
|
#include "font.h" // For the lyxfont class.
|
|
|
|
#include <algorithm> // For the std::max
|
2001-02-08 13:06:55 +00:00
|
|
|
#include "support/lyxmanip.h"
|
2000-07-31 12:30:10 +00:00
|
|
|
#include "debug.h"
|
2000-03-09 23:58:55 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
extern string system_tempdir;
|
2000-03-09 23:58:55 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
using std::ostream;
|
2000-03-09 23:58:55 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// This function is a utility function
|
|
|
|
inline
|
|
|
|
string const RemoveExtension(string const & filename)
|
|
|
|
{
|
|
|
|
return ChangeExtension(filename, string());
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
// Initialize only those variables that do not have a constructor.
|
2000-03-09 23:58:55 +00:00
|
|
|
InsetGraphics::InsetGraphics()
|
2001-02-20 09:08:56 +00:00
|
|
|
: cacheHandle(0), imageLoaded(false)
|
2000-03-09 23:58:55 +00:00
|
|
|
{}
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
InsetGraphics::~InsetGraphics()
|
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
// Emits the hide signal to the dialog connected (if any)
|
2001-02-19 16:01:31 +00:00
|
|
|
hideDialog();
|
2000-07-31 12:30:10 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2000-10-12 10:46:06 +00:00
|
|
|
char const *
|
|
|
|
InsetGraphics::statusMessage() const
|
|
|
|
{
|
|
|
|
char const * msg = 0;
|
|
|
|
|
2001-02-22 16:53:59 +00:00
|
|
|
if (cacheHandle.get()) {
|
2001-02-08 13:06:55 +00:00
|
|
|
switch (cacheHandle->getImageStatus()) {
|
|
|
|
case GraphicsCacheItem::UnknownError:
|
|
|
|
msg = _("Unknown Error");
|
|
|
|
break;
|
2000-10-12 10:46:06 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
case GraphicsCacheItem::Loading:
|
|
|
|
msg = _("Loading...");
|
|
|
|
break;
|
2000-10-12 10:46:06 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
case GraphicsCacheItem::ErrorReading:
|
|
|
|
msg = _("Error reading");
|
|
|
|
break;
|
2000-10-12 10:46:06 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
case GraphicsCacheItem::ErrorConverting:
|
|
|
|
msg = _("Error converting");
|
|
|
|
break;
|
2000-10-12 10:46:06 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
case GraphicsCacheItem::Loaded:
|
|
|
|
// No message to write.
|
|
|
|
break;
|
|
|
|
}
|
2000-10-12 10:46:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return msg;
|
|
|
|
}
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
int InsetGraphics::ascent(BufferView *, LyXFont const &) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2001-02-20 09:08:56 +00:00
|
|
|
LyXImage * pixmap = 0;
|
2001-02-22 16:53:59 +00:00
|
|
|
if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
|
2001-02-08 13:06:55 +00:00
|
|
|
return pixmap->getHeight();
|
2000-08-08 09:18:39 +00:00
|
|
|
else
|
|
|
|
return 50;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
int InsetGraphics::descent(BufferView *, LyXFont const &) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
|
|
|
// this is not true if viewport is used and clip is not.
|
2000-08-08 09:18:39 +00:00
|
|
|
return 0;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-10-12 10:46:06 +00:00
|
|
|
int InsetGraphics::width(BufferView *, LyXFont const & font) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2001-02-20 09:08:56 +00:00
|
|
|
LyXImage * pixmap = 0;
|
|
|
|
|
2001-02-22 16:53:59 +00:00
|
|
|
if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
|
2001-02-08 13:06:55 +00:00
|
|
|
return pixmap->getWidth();
|
2000-10-12 10:46:06 +00:00
|
|
|
else {
|
|
|
|
char const * msg = statusMessage();
|
2001-02-08 13:06:55 +00:00
|
|
|
int font_width = 0;
|
|
|
|
|
|
|
|
if (msg)
|
|
|
|
font_width = lyxfont::width(msg, font);
|
2000-10-12 10:46:06 +00:00
|
|
|
|
2001-03-18 17:48:56 +00:00
|
|
|
return std::max(50, font_width + 15);
|
2000-10-12 10:46:06 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
2000-06-21 15:07:57 +00:00
|
|
|
void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
|
2000-08-14 09:44:53 +00:00
|
|
|
int baseline, float & x, bool) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2000-07-31 12:30:10 +00:00
|
|
|
Painter & paint = bv->painter();
|
2000-06-21 15:07:57 +00:00
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
int ldescent = descent(bv, font);
|
|
|
|
int lascent = ascent(bv, font);
|
2001-02-08 13:06:55 +00:00
|
|
|
int lwidth = width(bv, font);
|
|
|
|
|
|
|
|
// Make sure x is updated upon exit from this routine
|
|
|
|
float old_x = x;
|
|
|
|
x += lwidth;
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2000-08-10 13:15:05 +00:00
|
|
|
// This will draw the graphics. If the graphics has not been loaded yet,
|
|
|
|
// we draw just a rectangle.
|
2001-02-20 09:08:56 +00:00
|
|
|
if (imageLoaded) {
|
2000-08-08 09:18:39 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
paint.image(int(old_x) + 2, baseline - lascent,
|
2000-08-14 09:44:53 +00:00
|
|
|
lwidth - 4, lascent + ldescent,
|
2001-02-20 09:08:56 +00:00
|
|
|
cacheHandle->getImage());
|
2000-08-14 09:44:53 +00:00
|
|
|
} else {
|
2001-02-08 13:06:55 +00:00
|
|
|
|
2000-10-12 10:46:06 +00:00
|
|
|
// Get the image status, default to unknown error.
|
|
|
|
GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
|
2001-02-22 16:53:59 +00:00
|
|
|
if (cacheHandle.get())
|
2000-10-12 10:46:06 +00:00
|
|
|
status = cacheHandle->getImageStatus();
|
|
|
|
|
2000-08-10 13:15:05 +00:00
|
|
|
// Check if the image is now ready.
|
2000-10-12 10:46:06 +00:00
|
|
|
if (status == GraphicsCacheItem::Loaded) {
|
2001-02-20 09:08:56 +00:00
|
|
|
imageLoaded = true;
|
2000-08-10 13:15:05 +00:00
|
|
|
|
|
|
|
// Tell BufferView we need to be updated!
|
|
|
|
bv->text->status = LyXText::CHANGED_IN_DRAW;
|
2000-10-12 10:46:06 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
char const * msg = statusMessage();
|
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
paint.rectangle(int(old_x) + 2, baseline - lascent,
|
2000-10-12 10:46:06 +00:00
|
|
|
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);
|
2001-02-08 13:06:55 +00:00
|
|
|
paint.text(int(old_x) + 8,
|
|
|
|
baseline - lyxfont::maxAscent(msgFont) - 4,
|
|
|
|
justname, msgFont);
|
2000-10-12 10:46:06 +00:00
|
|
|
|
|
|
|
msgFont.setSize(LyXFont::SIZE_TINY);
|
2001-02-08 13:06:55 +00:00
|
|
|
paint.text(int(old_x) + 8, baseline - 4,
|
|
|
|
msg, strlen(msg), msgFont);
|
2000-08-10 13:15:05 +00:00
|
|
|
}
|
2000-08-08 09:18:39 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2001-02-08 13:06:55 +00:00
|
|
|
bv->owner()->getDialogs()->showGraphics(this);
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-03-08 13:52:57 +00:00
|
|
|
Inset::EDITABLE InsetGraphics::Editable() const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2000-03-08 13:52:57 +00:00
|
|
|
return IS_EDITABLE;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
void InsetGraphics::Write(Buffer const * buf, ostream & os) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2001-03-18 17:48:56 +00:00
|
|
|
os << "GRAPHICS FormatVersion 1\n";
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
params.Write(buf, os);
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
bool finished = false;
|
|
|
|
|
|
|
|
while (lex.IsOK() && !finished) {
|
|
|
|
lex.next();
|
|
|
|
|
|
|
|
string const token = lex.GetString();
|
2001-03-18 17:48:56 +00:00
|
|
|
lyxerr.debug() << "Token: '" << token << '\'' << std::endl;
|
2000-08-14 09:44:53 +00:00
|
|
|
|
|
|
|
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."
|
2001-03-18 17:48:56 +00:00
|
|
|
<< std::endl;
|
2000-08-14 09:44:53 +00:00
|
|
|
// TODO: Possibly open up a dialog?
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
if (! params.Read(buf, lex, token))
|
2001-03-18 17:48:56 +00:00
|
|
|
lyxerr << "Unknown token, " << token << ", skipping."
|
|
|
|
<< std::endl;
|
2000-08-14 09:44:53 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
updateInset();
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
2000-09-14 17:53:12 +00:00
|
|
|
static
|
|
|
|
void formatResize(ostream & os, string const & key,
|
|
|
|
InsetGraphicsParams::Resize resizeType, double size)
|
2000-07-31 12:30:10 +00:00
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
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;
|
|
|
|
|
|
|
|
}
|
2000-07-31 12:30:10 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
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.
|
|
|
|
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 << ',';
|
|
|
|
}
|
|
|
|
|
|
|
|
string opts = options.str().c_str();
|
|
|
|
opts = strip(opts, ',');
|
|
|
|
|
|
|
|
return opts;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
//
|
|
|
|
|
|
|
|
// Get the extension (format) of the original file.
|
|
|
|
string const extension = GetExtension(params.filename);
|
|
|
|
|
|
|
|
// Are we creating a PDF or a PS file?
|
|
|
|
// (Should actually mean, are we usind latex or pdflatex).
|
|
|
|
string const image_target = (lyxrc.pdf_mode ? "png" : "eps");
|
|
|
|
|
|
|
|
if (extension == image_target)
|
|
|
|
return params.filename;
|
|
|
|
|
|
|
|
string outfile;
|
|
|
|
if (!buf->niceFile) {
|
|
|
|
string const temp = AddName(buf->tmppath, params.filename);
|
|
|
|
outfile = RemoveExtension(temp);
|
2001-02-20 09:08:56 +00:00
|
|
|
|
|
|
|
//lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
|
|
|
|
//lyxerr << "filename = " << params.filename << "\n";
|
|
|
|
//lyxerr << "temp = " << temp << "\n";
|
|
|
|
//lyxerr << "outfile = " << outfile << endl;
|
2001-02-08 13:06:55 +00:00
|
|
|
} else {
|
|
|
|
string const path = OnlyPath(buf->fileName());
|
|
|
|
string const relname = MakeRelPath(params.filename, path);
|
|
|
|
outfile = RemoveExtension(relname);
|
|
|
|
}
|
|
|
|
|
|
|
|
converters.Convert(buf, params.filename, outfile, extension, image_target);
|
|
|
|
|
|
|
|
return outfile;
|
|
|
|
}
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
int InsetGraphics::Latex(Buffer const *buf, ostream & os,
|
2001-02-08 13:06:55 +00:00
|
|
|
bool /*fragile*/, bool/*fs*/) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
|
|
|
// MISSING: We have to decide how to do the order of the options
|
2001-02-08 13:06:55 +00:00
|
|
|
// that is dependent of order, like width, height, angle. Should
|
2000-02-29 02:19:17 +00:00
|
|
|
// we rotate before scale? Should we let the user decide?
|
|
|
|
// bool rot_before_scale; ?
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
// (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()) {
|
2001-02-08 13:06:55 +00:00
|
|
|
os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
|
|
|
|
<< _("empty figure path")
|
|
|
|
<< "}\n";
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
return 1; // One end of line marker added to the stream.
|
2000-08-14 09:44:53 +00:00
|
|
|
}
|
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// Keep count of newlines that we issued.
|
|
|
|
int newlines = 0;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// This variables collect all the latex code that should be before and
|
|
|
|
// after the actual includegraphics command.
|
|
|
|
string before;
|
|
|
|
string after;
|
2000-08-14 09:44:53 +00:00
|
|
|
|
|
|
|
// If it's not an inline image, surround it with the centering paragraph.
|
|
|
|
if (! params.inlineFigure) {
|
2001-02-08 13:06:55 +00:00
|
|
|
before += "\n" "\\vspace{0.3cm}\n" "{\\par\\centering ";
|
|
|
|
after = " \\par}\n" "\\vspace{0.3cm}\n" + after;
|
|
|
|
newlines += 4;
|
2000-08-14 09:44:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Do we want subcaptions?
|
|
|
|
if (params.subcaption) {
|
2001-02-08 13:06:55 +00:00
|
|
|
before += "\\subfigure[" + params.subcaptionText + "]{";
|
|
|
|
after = '}' + after;
|
2000-08-14 09:44:53 +00:00
|
|
|
}
|
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// We never use the starred form, we use the "clip" option instead.
|
|
|
|
os << before << "\\includegraphics";
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// Write the options if there are any.
|
|
|
|
string const opts = createLatexOptions();
|
2000-02-29 02:19:17 +00:00
|
|
|
if (!opts.empty()) {
|
2000-07-31 12:30:10 +00:00
|
|
|
os << '[' << opts << ']';
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
// 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)
|
2001-02-08 13:06:55 +00:00
|
|
|
string const filename = prepareFile(buf);
|
|
|
|
|
|
|
|
os << '{' << filename << '}' << after;
|
2000-08-14 09:44:53 +00:00
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// Return how many newlines we issued.
|
|
|
|
return newlines;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-09-26 15:25:14 +00:00
|
|
|
int InsetGraphics::Ascii(Buffer const *, ostream &, int) const
|
2000-04-24 20:58:23 +00:00
|
|
|
{
|
2001-02-08 13:06:55 +00:00
|
|
|
// 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.
|
|
|
|
|
2000-04-24 20:58:23 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2000-06-12 11:27:15 +00:00
|
|
|
int InsetGraphics::Linuxdoc(Buffer const *, ostream &) const
|
2000-03-06 02:42:40 +00:00
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
// No graphics in LinuxDoc output. Should check how/what to add.
|
2000-03-06 02:42:40 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2001-02-08 13:06:55 +00:00
|
|
|
// 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 * buf, ostream & os) const
|
2000-03-06 02:42:40 +00:00
|
|
|
{
|
2001-02-08 13:06:55 +00:00
|
|
|
// Change the path to be relative to the main file.
|
|
|
|
string const buffer_dir = OnlyPath(buf->fileName());
|
|
|
|
string const filename = RemoveExtension(MakeRelPath(params.filename, buffer_dir));
|
|
|
|
|
|
|
|
// 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=\"" << filename << "\"></graphic>";
|
2000-03-06 02:42:40 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
void InsetGraphics::Validate(LaTeXFeatures & features) const
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
// If we have no image, we should not require anything.
|
|
|
|
if (params.filename.empty())
|
|
|
|
return ;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
|
|
|
features.graphicx = true;
|
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
if (params.subcaption)
|
|
|
|
features.subfigure = true;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
// Update the inset after parameters changed (read from file or changed in
|
|
|
|
// dialog.
|
2000-10-12 10:46:06 +00:00
|
|
|
void InsetGraphics::updateInset() const
|
2000-07-31 12:30:10 +00:00
|
|
|
{
|
2001-02-28 11:32:10 +00:00
|
|
|
GraphicsCache & gc = GraphicsCache::getInstance();
|
2001-02-22 16:53:59 +00:00
|
|
|
boost::shared_ptr<GraphicsCacheItem> temp(0);
|
2000-08-08 09:18:39 +00:00
|
|
|
|
2001-02-22 16:53:59 +00:00
|
|
|
// We do it this way so that in the face of some error, we will still
|
|
|
|
// be in a valid state.
|
2001-02-20 09:08:56 +00:00
|
|
|
if (!params.filename.empty()) {
|
2001-02-28 11:32:10 +00:00
|
|
|
temp = gc.addFile(params.filename);
|
2001-02-08 13:06:55 +00:00
|
|
|
}
|
2001-02-20 09:08:56 +00:00
|
|
|
|
|
|
|
// Mark the image as unloaded so that it gets updated.
|
|
|
|
imageLoaded = false;
|
|
|
|
|
|
|
|
cacheHandle = temp;
|
2000-07-31 12:30:10 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
bool InsetGraphics::setParams(InsetGraphicsParams const & params)
|
2000-02-29 02:19:17 +00:00
|
|
|
{
|
2000-08-08 09:18:39 +00:00
|
|
|
// If nothing is changed, just return and say so.
|
2000-08-14 09:44:53 +00:00
|
|
|
if (this->params == params)
|
|
|
|
return false;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
// Copy the new parameters.
|
|
|
|
this->params = params;
|
2000-07-31 12:30:10 +00:00
|
|
|
|
2000-08-14 09:44:53 +00:00
|
|
|
// Update the inset with the new parameters.
|
|
|
|
updateInset();
|
|
|
|
|
|
|
|
// We have changed data, report it.
|
|
|
|
return true;
|
2000-02-29 02:19:17 +00:00
|
|
|
}
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
InsetGraphicsParams InsetGraphics::getParams() const
|
|
|
|
{
|
2000-08-14 09:44:53 +00:00
|
|
|
return params;
|
2000-07-31 12:30:10 +00:00
|
|
|
}
|
2000-02-29 02:19:17 +00:00
|
|
|
|
2000-10-10 11:50:43 +00:00
|
|
|
Inset * InsetGraphics::Clone(Buffer const &) const
|
2000-07-31 12:30:10 +00:00
|
|
|
{
|
2000-08-14 05:24:35 +00:00
|
|
|
InsetGraphics * newInset = new InsetGraphics;
|
|
|
|
|
2001-02-22 16:53:59 +00:00
|
|
|
newInset->cacheHandle = cacheHandle;
|
2001-02-20 09:08:56 +00:00
|
|
|
newInset->imageLoaded = imageLoaded;
|
2000-08-14 05:24:35 +00:00
|
|
|
|
|
|
|
newInset->setParams(getParams());
|
|
|
|
|
2000-07-31 12:30:10 +00:00
|
|
|
return newInset;
|
|
|
|
}
|