1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995-2002 the LyX Team.
9 * \author Herbert Voss <voss@lyx.org>
10 * ====================================================== */
15 * If the image is from the clipart, and the document is moved to another
16 directory, the user is screwed. Need a way to handle it.
17 This amounts to a problem of when to use relative or absolute file paths
18 We should probably use what the user asks to use... but when he chooses
19 by the file dialog we normally get an absolute path and this may not be
21 [Note that browseRelFile in helper_funcs.* provides a file name
22 which is relative if it is at reference path (here puffer path)
23 level or below, and an absolute path if the file name is not a
24 `natural' relative file name. In any case,
25 MakeAbsPath(filename, buf->filePath())
26 is guaranteed to provide the correct absolute path. This is what is
27 done know for include insets. Feel free to ask me -- JMarc
30 * If we are trying to create a file in a read-only directory and there
31 are graphics that need converting, the converting will fail because
32 it is done in-place, into the same directory as the original image.
33 This needs to be fixed in the src/converter.C file
34 [ This is presumed to be fixed, needs testing.]
36 * We do not dither or resize the image in a WYSIWYM way, we load it at
37 its original size and color, resizing is done in the final output,
38 but not in the LyX window.
40 TODO Before initial production release:
41 * Replace insetfig everywhere
42 * Search for comments of the form
43 // INSET_GRAPHICS: remove this when InsetFig is thrown.
44 And act upon them. Make sure not to remove InsetFig code for the
45 1.2.0 release, only afterwards, after deployment shows InsetGraphics
47 * What advanced features the users want to do?
48 Implement them in a non latex dependent way, but a logical way.
49 LyX should translate it to latex or any other fitting format.
50 * Add a way to roll the image file into the file format.
51 * When loading, if the image is not found in the expected place, try
52 to find it in the clipart, or in the same directory with the image.
53 * Keep a tab on the image file, if it changes, update the lyx view.
54 * The image choosing dialog could show thumbnails of the image formats
55 it knows of, thus selection based on the image instead of based on
57 * Add support for the 'picins' package.
58 * Add support for the 'picinpar' package.
59 * Improve support for 'subfigure' - Allow to set the various options
65 * Current version is 1 (inset file format version), when changing it
66 * it should be changed in the Write() function when writing in one place
67 * and when reading one should change the version check and the error message.
68 * The filename is kept in the lyx file in a relative way, so as to allow
69 * moving the document file and its images with no problem.
73 * Postscript output means EPS figures.
75 * PDF output is best done with PDF figures if it's a direct conversion
76 * or PNG figures otherwise.
89 #pragma implementation
92 #include "insets/insetgraphics.h"
93 #include "insets/insetgraphicsParams.h"
95 #include "graphics/GraphicsCache.h"
96 #include "graphics/GraphicsCacheItem.h"
100 #include "BufferView.h"
101 #include "converter.h"
103 #include "lyx_gui_misc.h"
110 #include "frontends/Dialogs.h"
111 #include "frontends/Alert.h"
112 #include "frontends/controllers/helper_funcs.h"
113 #include "frontends/support/LyXImage.h"
115 #include "support/FileInfo.h"
116 #include "support/filetools.h"
117 #include "support/lyxlib.h"
118 #include "support/lyxmanip.h"
119 #include "support/lyxalgo.h"
124 extern string system_tempdir;
133 ///////////////////////////////////////////////////////////////////////////
134 int const VersionNumber = 1;
135 ///////////////////////////////////////////////////////////////////////////
137 // This function is a utility function
138 // ... that should be with ChangeExtension ...
140 string const RemoveExtension(string const & filename)
142 return ChangeExtension(filename, string());
148 string const unique_id()
150 static unsigned int seed = 1000;
153 ost << "graph" << ++seed;
155 // Needed if we use lyxstring.
156 return ost.str().c_str();
162 // Initialize only those variables that do not have a constructor.
163 InsetGraphics::InsetGraphics()
164 : cacheHandle(0), imageLoaded(false), graphic_label(unique_id())
168 InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
169 : Inset(), SigC::Object()
170 , cacheHandle(ig.cacheHandle)
171 , imageLoaded(ig.imageLoaded)
172 , graphic_label(unique_id())
174 setParams(ig.getParams());
180 InsetGraphics::~InsetGraphics()
182 // Emits the hide signal to the dialog connected (if any)
187 string const InsetGraphics::statusMessage() const
190 if (cacheHandle.get()) {
191 switch (cacheHandle->getImageStatus()) {
192 case GraphicsCacheItem::UnknownError:
193 msg = _("Unknown Error");
195 case GraphicsCacheItem::Loading:
196 msg = _("Loading...");
198 case GraphicsCacheItem::ErrorReading:
199 msg = _("Error reading");
201 case GraphicsCacheItem::Converting:
202 msg = _("Converting Image");
204 case GraphicsCacheItem::ErrorConverting:
205 msg = _("Error converting");
207 case GraphicsCacheItem::Loaded:
208 // No message to write.
216 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
218 LyXImage * pixmap = 0;
219 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
220 return pixmap->getHeight();
226 int InsetGraphics::descent(BufferView *, LyXFont const &) const
228 // this is not true if viewport is used and clip is not.
233 int InsetGraphics::width(BufferView *, LyXFont const & font) const
235 LyXImage * pixmap = 0;
237 if (cacheHandle.get() && (pixmap = cacheHandle->getImage()))
238 return pixmap->getWidth();
242 LyXFont msgFont(font);
243 msgFont.setFamily(LyXFont::SANS_FAMILY);
245 string const justname = OnlyFilename (params.filename);
246 if (!justname.empty()) {
247 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
248 font_width = lyxfont::width(justname, msgFont);
251 string const msg = statusMessage();
253 msgFont.setSize(LyXFont::SIZE_TINY);
254 int const msg_width = lyxfont::width(msg, msgFont);
255 font_width = max(font_width, msg_width);
258 return max(50, font_width + 15);
263 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
264 int baseline, float & x, bool) const
266 Painter & paint = bv->painter();
268 int ldescent = descent(bv, font);
269 int lascent = ascent(bv, font);
270 int lwidth = width(bv, font);
272 // Make sure x is updated upon exit from this routine
276 // This will draw the graphics. If the graphics has not been loaded yet,
277 // we draw just a rectangle.
280 paint.image(old_x + 2, baseline - lascent,
281 lwidth - 4, lascent + ldescent,
282 cacheHandle->getImage());
284 // Get the image status, default to unknown error.
285 GraphicsCacheItem::ImageStatus status = GraphicsCacheItem::UnknownError;
286 if (lyxrc.use_gui && params.display != InsetGraphicsParams::NONE &&
288 status = cacheHandle->getImageStatus();
289 // Check if the image is now ready.
290 if (status == GraphicsCacheItem::Loaded) {
292 // Tell BufferView we need to be updated!
293 bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
296 paint.rectangle(old_x + 2, baseline - lascent,
299 // Print the file name.
300 LyXFont msgFont(font);
301 msgFont.setFamily(LyXFont::SANS_FAMILY);
302 string const justname = OnlyFilename (params.filename);
303 if (!justname.empty()) {
304 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
305 paint.text(old_x + 8,
306 baseline - lyxfont::maxAscent(msgFont) - 4,
309 // Print the message.
310 string const msg = statusMessage();
312 msgFont.setSize(LyXFont::SIZE_TINY);
313 paint.text(old_x + 8, baseline - 4, msg, msgFont);
319 void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
321 bv->owner()->getDialogs()->showGraphics(this);
325 void InsetGraphics::edit(BufferView * bv, bool)
331 Inset::EDITABLE InsetGraphics::editable() const
337 void InsetGraphics::write(Buffer const * buf, ostream & os) const
339 os << "Graphics FormatVersion " << VersionNumber << '\n';
340 params.Write(buf, os);
344 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
346 string const token = lex.getString();
348 if (token == "Graphics")
349 readInsetGraphics(buf, lex);
350 else if (token == "Figure") // Compatibility reading of FigInset figures.
351 readFigInset(buf, lex);
353 lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
358 void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
360 bool finished = false;
362 while (lex.isOK() && !finished) {
365 string const token = lex.getString();
366 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
371 } else if (token == "\\end_inset") {
373 } else if (token == "FormatVersion") {
375 int version = lex.getInteger();
376 if (version > VersionNumber)
378 << "This document was created with a newer Graphics widget"
379 ", You should use a newer version of LyX to read this"
382 // TODO: Possibly open up a dialog?
385 if (! params.Read(buf, lex, token))
386 lyxerr << "Unknown token, " << token << ", skipping."
392 // FormatVersion < 1.0 (LyX < 1.2)
393 void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
395 vector<string> const oldUnits =
396 getVectorFromString("pt,cm,in,p%,c%");
397 bool finished = false;
398 // set the display default
399 if (lyxrc.display_graphics == "mono")
400 params.display = InsetGraphicsParams::MONOCHROME;
401 else if (lyxrc.display_graphics == "gray")
402 params.display = InsetGraphicsParams::GRAYSCALE;
403 else if (lyxrc.display_graphics == "color")
404 params.display = InsetGraphicsParams::COLOR;
406 params.display = InsetGraphicsParams::NONE;
407 while (lex.isOK() && !finished) {
410 string const token = lex.getString();
411 lyxerr[Debug::GRAPHICS] << "Token: " << token << endl;
415 else if (token == "\\end_inset") {
417 } else if (token == "file") {
419 string const name = lex.getString();
420 string const path = buf->filePath();
421 params.filename = MakeAbsPath(name, path);
423 } else if (token == "extra") {
425 // kept for backwards compability. Delete in 0.13.x
426 } else if (token == "subcaption") {
428 params.subcaptionText = lex.getString();
429 params.subcaption = true;
430 } else if (token == "label") {
432 // kept for backwards compability. Delete in 0.13.x
433 } else if (token == "angle") {
435 params.rotate = true;
436 params.rotateAngle = lex.getFloat();
437 } else if (token == "size") {
439 params.lyxwidth = LyXLength(lex.getString()+"pt");
441 params.lyxheight = LyXLength(lex.getString()+"pt");
442 } else if (token == "flags") {
444 switch (lex.getInteger()) {
445 case 1: params.display = InsetGraphicsParams::MONOCHROME;
447 case 2: params.display = InsetGraphicsParams::GRAYSCALE;
449 case 3: params.display = InsetGraphicsParams::COLOR;
452 } else if (token == "subfigure") {
453 params.subcaption = true;
454 } else if (token == "width") {
456 int i = lex.getInteger();
459 params.scale = lex.getInteger();
460 params.size_type = InsetGraphicsParams::SCALE;
462 params.width = LyXLength(lex.getString()+oldUnits[i]);
463 params.size_type = InsetGraphicsParams::WH;
467 } else if (token == "height") {
469 int i = lex.getInteger();
471 params.height = LyXLength(lex.getString()+oldUnits[i]);
472 params.size_type = InsetGraphicsParams::WH;
479 string const InsetGraphics::createLatexOptions() const
481 // Calculate the options part of the command, we must do it to a string
482 // stream since we might have a trailing comma that we would like to remove
483 // before writing it to the output stream.
484 ostringstream options;
485 if (!params.bb.empty())
486 options << " bb=" << strip(params.bb) << ",\n";
488 options << " draft,\n";
490 options << " clip,\n";
491 if (params.size_type == InsetGraphicsParams::WH) {
492 if (!params.width.zero())
493 options << " width=" << params.width.asLatexString() << ",\n";
494 if (!params.height.zero())
495 options << " height=" << params.height.asLatexString() << ",\n";
496 } else if (params.size_type == InsetGraphicsParams::SCALE) {
497 if (params.scale > 0)
498 options << " scale=" << double(params.scale)/100.0 << ",\n";
500 if (params.keepAspectRatio)
501 options << " keepaspectratio,\n";
502 // Make sure it's not very close to zero, a float can be effectively
503 // zero but not exactly zero.
504 if (!lyx::float_equal(params.rotateAngle, 0, 0.001) && params.rotate) {
505 options << " angle=" << params.rotateAngle << ",\n";
506 if (!params.rotateOrigin.empty()) {
507 options << " origin=" << params.rotateOrigin[0];
508 if (contains(params.rotateOrigin,"Top"))
510 else if (contains(params.rotateOrigin,"Bottom"))
512 else if (contains(params.rotateOrigin,"Baseline"))
517 if (!params.special.empty())
518 options << params.special << ",\n";
519 string opts = options.str().c_str();
520 return opts.substr(0,opts.size()-2); // delete last ",\n"
524 string decideOutputImageFormat(string const & suffix)
526 // lyxrc.pdf_mode means:
527 // Are we creating a PDF or a PS file?
528 // (Should actually mean, are we using latex or pdflatex).
529 lyxerr[Debug::GRAPHICS] << "decideOutput::lyxrc.pdf_mode = " << lyxrc.pdf_mode << "\n";
530 if (lyxrc.pdf_mode) {
531 if (contains(suffix,"ps") || suffix == "pdf")
533 else if (suffix == "jpg")
538 // If it's postscript, we always do eps.
539 lyxerr[Debug::GRAPHICS] << "decideOutput: we have PostScript mode\n";
548 string const InsetGraphics::prepareFile(Buffer const *buf) const
550 // do_convert = Do we need to convert the file?
551 // nice = Do we create a nice version?
552 // This is used when exporting the latex file only.
554 // return original filename
556 // convert_place = temp directory
557 // return new filename in temp directory
559 // convert_place = original file directory
560 // return original filename without the extension
562 // if it's a zipped one, than let LaTeX do the rest!!!
563 if ((zippedFile(params.filename) && params.noUnzip) || buf->niceFile) {
564 lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
565 << params.filename << endl;
566 return params.filename;
568 string filename_ = params.filename;
569 if (zippedFile(filename_))
570 filename_ = unzipFile(filename_);
571 // now we have unzipped files
572 // Get the extension (format) of the original file.
573 // we handle it like a virtual one, so we can have
574 // different extensions with the same type.
575 string const extension = getExtFromContents(filename_);
576 // are we usind latex ((e)ps) or pdflatex (pdf,jpg,png)
577 string const image_target = decideOutputImageFormat(extension);
578 if (extension == image_target) // :-)
580 // commented out to check if the "not exist"bug is fixed.
581 // if (!IsFileReadable(filename_)) { // :-(
582 // Alert::alert(_("File") + params.filename,
583 // _("isn't readable or doesn't exists!"));
587 string const temp = AddName(buf->tmppath, filename_);
588 outfile = RemoveExtension(temp);
589 lyxerr[Debug::GRAPHICS] << "tempname = " << temp << "\n";
590 lyxerr[Debug::GRAPHICS] << "buf::tmppath = " << buf->tmppath << "\n";
591 lyxerr[Debug::GRAPHICS] << "filename_ = " << filename_ << "\n";
592 lyxerr[Debug::GRAPHICS] << "outfile = " << outfile << endl;
593 converters.convert(buf, filename_, outfile, extension, image_target);
598 int InsetGraphics::latex(Buffer const *buf, ostream & os,
599 bool /*fragile*/, bool/*fs*/) const
601 // If there is no file specified, just output a message about it in
603 if (params.filename.empty()) {
604 os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
605 << _("empty figure path") << "}\n";
606 return 1; // One end of line marker added to the stream.
608 // These variables collect all the latex code that should be before and
609 // after the actual includegraphics command.
612 // Do we want subcaptions?
613 if (params.subcaption) {
614 before += "\\subfigure[" + params.subcaptionText + "]{";
617 // We never use the starred form, we use the "clip" option instead.
618 before += "\\includegraphics";
619 // Write the options if there are any.
620 string const opts = createLatexOptions();
622 before += ("[%\n" + opts +']');
624 // Make the filename relative to the lyx file
625 // and remove the extension so the LaTeX will use whatever is
626 // appropriate (when there are several versions in different formats)
627 string const latex_str = before + '{' + prepareFile(buf) + '}' + after;
629 // Return how many newlines we issued.
631 int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
632 // lyxerr << "includegraphics: " << newlines << " lines of text"
638 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
640 // No graphics in ascii output. Possible to use gifscii to convert
641 // images to ascii approximation.
642 // 1. Convert file to ascii using gifscii
643 // 2. Read ascii output file and add it to the output stream.
644 // at least we send the filename
645 os << '<' << _("Graphicfile:") << params.filename << ">\n";
650 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
652 // No graphics in LinuxDoc output. Should check how/what to add.
657 // For explanation on inserting graphics into DocBook checkout:
658 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
659 // See also the docbook guide at http://www.docbook.org/
660 int InsetGraphics::docbook(Buffer const *, ostream & os) const
662 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
663 // need to switch to MediaObject. However, for now this is sufficient and
665 os << "<graphic fileref=\"&" << graphic_label << ";\">";
670 void InsetGraphics::validate(LaTeXFeatures & features) const
672 // If we have no image, we should not require anything.
673 if (params.filename.empty())
676 features.includeFile(graphic_label, RemoveExtension(params.filename));
678 features.require("graphicx");
680 if (params.subcaption)
681 features.require("subfigure");
685 // Update the inset after parameters changed (read from file or changed in
687 void InsetGraphics::updateInset() const
689 GraphicsCache & gc = GraphicsCache::getInstance();
690 boost::shared_ptr<GraphicsCacheItem> temp(0);
692 // We do it this way so that in the face of some error, we will still
693 // be in a valid state.
694 InsetGraphicsParams::DisplayType local_display = params.display;
695 if (local_display == InsetGraphicsParams::DEFAULT) {
696 if (lyxrc.display_graphics == "mono")
697 local_display = InsetGraphicsParams::MONOCHROME;
698 else if (lyxrc.display_graphics == "gray")
699 local_display = InsetGraphicsParams::GRAYSCALE;
700 else if (lyxrc.display_graphics == "color")
701 local_display = InsetGraphicsParams::COLOR;
703 local_display = InsetGraphicsParams::NONE;
706 if (!params.filename.empty() && lyxrc.use_gui &&
707 local_display != InsetGraphicsParams::NONE) {
708 temp = gc.addFile(params.filename);
711 // Mark the image as unloaded so that it gets updated.
718 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
720 // If nothing is changed, just return and say so.
724 // Copy the new parameters.
727 // Update the inset with the new parameters.
730 // We have changed data, report it.
735 InsetGraphicsParams InsetGraphics::getParams() const
741 Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
743 return new InsetGraphics(*this, same_id);