*
* LyX, The Document Processor
*
- * Copyright 1995 Matthias Ettrich
* Copyright 1995-2000 the LyX Team.
- *
+ *
+ * This file Copyright 2000 Baruch Even.
* ====================================================== */
+/*
+How to use it for now:
+ * The lyxfunc 'graphics-insert' will insert this inset into the document.
+*/
+
+/*
+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(?)
+
+*/
+
+/*
+Known BUGS:
+
+ * If the image is from the clipart, and the document is moved to another
+ directory, the user is screwed. Need a way to handle it.
+ This amounts to a problem of when to use relative or absolute file paths
+ We should probably use what the user asks to use... but when he chooses
+ by the file dialog we normally get an absolute path and this may not be
+ what the user meant.
+ * Bug in FileDlg class (src/filedlg.[hC]) when selecting a file and then
+ pressing ok, it counts as if no real selection done. Apparently
+ when choosing a file it doesn't update the select file input line.
+
+ * 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.
+
+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.
+
+TODO Extended features:
+
+ * Advanced Latex tab folder.
+ * Add support for more features so that it will be better than insetfig.
+ * Keep aspect ratio radio button
+ * 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.
+ * When loading, if the image is not found in the expected place, try
+ to find it in the clipart, or in the same directory with the image.
+ * Keep a tab on the image file, if it changes, update the lyx view.
+ * The image choosing dialog could show thumbnails of the image formats
+ it knows of, thus selection based on the image instead of based on
+ filename.
+ * 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)
+ */
+
+#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 "support/FileInfo.h"
+#include "support/filetools.h"
+#include "support/lyxlib.h"
+#include "lyxtext.h"
+#include "lyxrc.h"
+#include "font.h" // For the lyxfont class.
+#include <algorithm> // For the std::max
+#include "support/lyxmanip.h"
+#include "debug.h"
+
+extern string system_tempdir;
+
+using std::ostream;
+
+// This function is a utility function
+inline
+string const RemoveExtension(string const & filename)
+{
+ return ChangeExtension(filename, string());
+}
+
+// Initialize only those variables that do not have a constructor.
+InsetGraphics::InsetGraphics()
+ : cacheHandle(0), imageLoaded(false)
+{}
-int InsetGraphics::ascent(Painter &, LyXFont const &) const
+InsetGraphics::~InsetGraphics()
{
-
- return 100;
+ // Emits the hide signal to the dialog connected (if any)
+ hideDialog();
+}
+
+char const *
+InsetGraphics::statusMessage() const
+{
+ char const * msg = 0;
+
+ 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::ErrorConverting:
+ msg = _("Error converting");
+ break;
+
+ case GraphicsCacheItem::Loaded:
+ // No message to write.
+ break;
+ }
+ }
+
+ return msg;
+}
+
+int InsetGraphics::ascent(BufferView *, LyXFont const &) const
+{
+ LyXImage * pixmap = 0;
+ if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
+ return pixmap->getHeight();
+ else
+ return 50;
}
-int InsetGraphics::descent(Painter &, LyXFont const &) const
+int InsetGraphics::descent(BufferView *, LyXFont const &) const
{
// this is not true if viewport is used and clip is not.
- return 1;
+ return 0;
}
-int InsetGraphics::width(Painter &, LyXFont const &) const
+int InsetGraphics::width(BufferView *, LyXFont const & font) const
{
- if (bb.isSet()) {
- return bb.urx - bb.llx;
+ LyXImage * pixmap = 0;
+
+ if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
+ return pixmap->getWidth();
+ else {
+ char const * msg = statusMessage();
+ int font_width = 0;
+
+ if (msg)
+ font_width = lyxfont::width(msg, font);
+
+ return std::max(50, font_width + 15);
}
- return 100;
}
-
-void InsetGraphics::draw(Painter & pain, LyXFont const & font,
- int baseline, float & x) const
+void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
+ int baseline, float & x, bool) const
{
- // This will draw the graphics. As for now we only draw a
- // placeholder rectangele.
- pain.rectangle(x, baseline - ascent(pain, font),
- width(pain, font),
- ascent(pain, font) + descent(pain, font));
+ Painter & paint = bv->painter();
+
+ int ldescent = descent(bv, font);
+ int lascent = ascent(bv, font);
+ int lwidth = width(bv, font);
+
+ // Make sure x is updated upon exit from this routine
+ float old_x = 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(int(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 (cacheHandle.get())
+ status = cacheHandle->getImageStatus();
+
+ // Check if the image is now ready.
+ if (status == GraphicsCacheItem::Loaded) {
+ imageLoaded = true;
+
+ // Tell BufferView we need to be updated!
+ bv->text->status = LyXText::CHANGED_IN_DRAW;
+ return;
+ }
+
+ char const * msg = statusMessage();
+
+ paint.rectangle(int(old_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(old_x) + 8,
+ baseline - lyxfont::maxAscent(msgFont) - 4,
+ justname, msgFont);
+
+ msgFont.setSize(LyXFont::SIZE_TINY);
+ paint.text(int(old_x) + 8, baseline - 4,
+ msg, strlen(msg), msgFont);
+ }
+ }
}
-void InsetGraphics::Edit(BufferView *, int, int, unsigned int)
+void InsetGraphics::Edit(BufferView *bv, int, int, unsigned int)
{
- // Here we want to popup a dialog from which we get the
- // graphics paramters.
+ bv->owner()->getDialogs()->showGraphics(this);
}
}
-void InsetGraphics::Write(ostream & os) const
+void InsetGraphics::Write(Buffer const * buf, ostream & os) const
{
- // The question on the file format is still open.
- // Suggestions?
- os << "GRAPHICS\n";
+ os << "GRAPHICS FormatVersion 1\n";
+
+ params.Write(buf, os);
}
-void InsetGraphics::Read(LyXLex & /*lex*/)
+void InsetGraphics::Read(Buffer const * buf, LyXLex & lex)
{
- // For now we only use a static file...
- graphicsfile = "testfile.xpm";
- //graphicscache.addFile(graphicsfile);
- //bb = graphicscache.getBB(graphicsfile);
- //pixmap = graphicscache.getPixmap(graphicsfile);
+ bool finished = false;
+
+ while (lex.IsOK() && !finished) {
+ lex.next();
+
+ string const token = lex.GetString();
+ lyxerr.debug() << "Token: '" << token << '\'' << std::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."
+ << std::endl;
+ // TODO: Possibly open up a dialog?
+ }
+ else {
+ if (! params.Read(buf, lex, token))
+ lyxerr << "Unknown token, " << token << ", skipping."
+ << std::endl;
+ }
+ }
+
+ updateInset();
}
-int InsetGraphics::Latex(ostream & os, signed char /*fragile*/, bool/*fs*/) const
+namespace {
+
+void formatResize(ostream & os, string const & key,
+ InsetGraphicsParams::Resize resizeType, double size)
{
- // MISSING: We have to decide how to do the order of the options
- // that is depentant of order, like witdth, height, andlge. Should
- // we rotate before scale? Should we let the user decide?
- // bool rot_before_scale; ?
- // Nothing to do if we don't have a graphics file
- if (graphicsfile.empty()) return 0;
+ 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;
- // We never used the starred form, we use the "clip" option instead.
- string command("\\insetgraphics");
-
-#ifdef HAVE_SSTREAM
- ostringstream options;
-#else
- ostrstream options;
-#endif
- 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;
- }
- }
- 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,";
+}
+
+} // namespace anon
+
+
+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 << ',';
}
- if (!type.empty()) {
- options << "type=" << type << ",";
+
+ 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);
+
+ //lyxerr << "buf::tmppath = " << buf->tmppath << "\n";
+ //lyxerr << "filename = " << params.filename << "\n";
+ //lyxerr << "temp = " << temp << "\n";
+ //lyxerr << "outfile = " << outfile << endl;
+ } else {
+ string const path = OnlyPath(buf->fileName());
+ string const relname = MakeRelPath(params.filename, path);
+ outfile = RemoveExtension(relname);
}
- if (!ext.empty()) {
- options << "ext=" << type << ",";
+
+ converters.Convert(buf, params.filename, outfile, extension, image_target);
+
+ return outfile;
+}
+
+int InsetGraphics::Latex(Buffer const *buf, ostream & os,
+ bool /*fragile*/, bool/*fs*/) const
+{
+ // MISSING: We have to decide how to do the order of the options
+ // that is dependent of order, like width, 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")
+ << "}\n";
+
+ return 1; // One end of line marker added to the stream.
}
- if (!read.empty()) {
- options << "read=" << type << ",";
+
+ // Keep count of newlines that we issued.
+ int newlines = 0;
+
+ // This variables collect all the latex code that should be before and
+ // after the actual includegraphics command.
+ string before;
+ string after;
+
+ // If it's not an inline image, surround it with the centering paragraph.
+ if (! params.inlineFigure) {
+ before += "\n" "\\vspace{0.3cm}\n" "{\\par\\centering ";
+ after = " \\par}\n" "\\vspace{0.3cm}\n" + after;
+ newlines += 4;
}
- if (!command.empty()) {
- options << "command=" << type << ",";
+
+ // Do we want subcaptions?
+ if (params.subcaption) {
+ before += "\\subfigure[" + params.subcaptionText + "]{";
+ after = '}' + after;
}
-#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, ',');
+
+ // We never use the starred form, we use the "clip" option instead.
+ os << before << "\\includegraphics";
+
+ // Write the options if there are any.
+ string const opts = createLatexOptions();
if (!opts.empty()) {
- command += "[";
- command += opts;
- command += "]";
+ os << '[' << opts << ']';
}
- command += "{";
- command += graphicsfile;
- command += "}";
- os << command << '\n';
+ // 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 filename = prepareFile(buf);
- return 1;
+ os << '{' << filename << '}' << after;
+
+ // Return how many newlines we issued.
+ return newlines;
}
-#ifndef USE_OSTREAM_ONLY
-int InsetGraphics::Latex(string & /*file*/, signed char /*fragile*/, bool/*fs*/) const
+int InsetGraphics::Ascii(Buffer const *, ostream &, int) const
{
+ // 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.
+
return 0;
}
-int InsetGraphics::Linuxdoc(string & /*file*/) const
+int InsetGraphics::Linuxdoc(Buffer const *, ostream &) const
{
+ // No graphics in LinuxDoc output. Should check how/what to add.
return 0;
}
-
-int InsetGraphics::DocBook(string & /*file*/) 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 * buf, ostream & os) const
{
+ // 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>";
return 0;
}
-#else
-int InsetGraphics::Linuxdoc(ostream &) const
+void InsetGraphics::Validate(LaTeXFeatures & features) const
{
- return 0;
-}
+ // If we have no image, we should not require anything.
+ if (params.filename.empty())
+ return ;
+ features.graphicx = true;
-int InsetGraphics::DocBook(ostream &) const
-{
- return 0;
+ if (params.subcaption)
+ features.subfigure = true;
}
-#endif
-
-void InsetGraphics::Validate(LaTeXFeatures & /*features*/) const
+// Update the inset after parameters changed (read from file or changed in
+// dialog.
+void InsetGraphics::updateInset() const
{
- //features.graphicx = true;
+ 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.
+ if (!params.filename.empty()) {
+ temp = gc.addFile(params.filename);
+ }
+
+ // Mark the image as unloaded so that it gets updated.
+ imageLoaded = false;
+
+ cacheHandle = temp;
}
+bool InsetGraphics::setParams(InsetGraphicsParams const & params)
+{
+ // If nothing is changed, just return and say so.
+ if (this->params == params)
+ return false;
-Inset * InsetGraphics::Clone() const
+ // Copy the new parameters.
+ this->params = params;
+
+ // Update the inset with the new parameters.
+ updateInset();
+
+ // We have changed data, report it.
+ return true;
+}
+
+InsetGraphicsParams InsetGraphics::getParams() const
{
- return new InsetGraphics;
+ return params;
}
+Inset * InsetGraphics::Clone(Buffer const &) const
+{
+ InsetGraphics * newInset = new InsetGraphics;
+
+ newInset->cacheHandle = cacheHandle;
+ newInset->imageLoaded = imageLoaded;
+ newInset->setParams(getParams());
+
+ return newInset;
+}
projects / lyx.git / blobdiff