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/GraphicsImage.h"
100 #include "BufferView.h"
101 #include "converter.h"
104 #include "font.h" // For the lyxfont class.
107 #include "LaTeXFeatures.h"
109 #include "frontends/Dialogs.h"
110 #include "frontends/Alert.h"
111 #include "frontends/controllers/helper_funcs.h" // getVectorFromString
113 #include "support/LAssert.h"
114 #include "support/filetools.h"
115 #include "support/lyxalgo.h" // lyx::count
117 #include <algorithm> // For the std::max
119 extern string system_tempdir;
124 ///////////////////////////////////////////////////////////////////////////
125 int const VersionNumber = 1;
126 ///////////////////////////////////////////////////////////////////////////
130 // This function is a utility function
131 // ... that should be with ChangeExtension ...
133 string const RemoveExtension(string const & filename)
135 return ChangeExtension(filename, string());
143 string const unique_id()
145 static unsigned int seed = 1000;
148 ost << "graph" << ++seed;
150 // Needed if we use lyxstring.
151 return ost.str().c_str();
157 InsetGraphics::InsetGraphics()
158 : cached_status_(grfx::ErrorUnknown), cache_filled_(false),
159 graphic_label(unique_id())
163 InsetGraphics::InsetGraphics(InsetGraphics const & ig, bool same_id)
164 : cached_status_(grfx::ErrorUnknown), cache_filled_(false),
165 graphic_label(unique_id())
167 setParams(ig.params());
173 InsetGraphics::~InsetGraphics()
175 cached_image_.reset(0);
176 grfx::GCache & gc = grfx::GCache::get();
179 // Emits the hide signal to the dialog connected (if any)
184 string const InsetGraphics::statusMessage() const
188 switch (cached_status_) {
189 case grfx::WaitingToLoad:
190 msg = _("Waiting for draw request to start loading...");
193 msg = _("Loading...");
195 case grfx::Converting:
196 msg = _("Converting to loadable format...");
198 case grfx::ScalingEtc:
199 msg = _("Loaded. Scaling etc...");
201 case grfx::ErrorNoFile:
202 msg = _("No file found!");
204 case grfx::ErrorLoading:
205 msg = _("Error loading file into memory");
207 case grfx::ErrorConverting:
208 msg = _("Error converting to loadable format");
210 case grfx::ErrorScalingEtc:
211 msg = _("Error scaling etc");
213 case grfx::ErrorUnknown:
214 msg = _("No image associated with this inset is in the cache!");
217 msg = _("Loaded but not displaying");
225 void InsetGraphics::setCache() const
230 grfx::GCache & gc = grfx::GCache::get();
231 cached_status_ = gc.status(*this);
232 cached_image_ = gc.image(*this);
236 bool InsetGraphics::drawImage() const
239 Pixmap const pixmap =
240 (cached_status_ == grfx::Loaded && cached_image_.get() != 0) ?
241 cached_image_->getPixmap() : 0;
247 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
250 return cached_image_->getHeight();
256 int InsetGraphics::descent(BufferView *, LyXFont const &) const
262 int InsetGraphics::width(BufferView *, LyXFont const & font) const
265 return cached_image_->getWidth();
269 LyXFont msgFont(font);
270 msgFont.setFamily(LyXFont::SANS_FAMILY);
272 string const justname = OnlyFilename (params().filename);
273 if (!justname.empty()) {
274 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
275 font_width = lyxfont::width(justname, msgFont);
278 string const msg = statusMessage();
280 msgFont.setSize(LyXFont::SIZE_TINY);
281 int const msg_width = lyxfont::width(msg, msgFont);
282 font_width = std::max(font_width, msg_width);
285 return std::max(50, font_width + 15);
290 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
291 int baseline, float & x, bool) const
293 int ldescent = descent(bv, font);
294 int lascent = ascent(bv, font);
295 int lwidth = width(bv, font);
297 // Make sure now that x is updated upon exit from this routine
301 // Initiate the loading of the graphics file
302 if (cached_status_ == grfx::WaitingToLoad) {
303 grfx::GCache & gc = grfx::GCache::get();
304 gc.startLoading(*this);
307 // This will draw the graphics. If the graphics has not been loaded yet,
308 // we draw just a rectangle.
309 Painter & paint = bv->painter();
313 paint.image(old_x + 2, baseline - lascent,
314 lwidth - 4, lascent + ldescent,
315 *cached_image_.get());
319 paint.rectangle(old_x + 2, baseline - lascent,
323 // Print the file name.
324 LyXFont msgFont(font);
325 msgFont.setFamily(LyXFont::SANS_FAMILY);
326 string const justname = OnlyFilename (params().filename);
327 if (!justname.empty()) {
328 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
329 paint.text(old_x + 8,
330 baseline - lyxfont::maxAscent(msgFont) - 4,
334 // Print the message.
335 string const msg = statusMessage();
337 msgFont.setSize(LyXFont::SIZE_TINY);
338 paint.text(old_x + 8, baseline - 4, msg, msgFont);
342 // Reset the cache, ready for the next draw request
343 cached_status_ = grfx::ErrorUnknown;
344 cached_image_.reset(0);
345 cache_filled_ = false;
349 // Update the inset after parameters changed (read from file or changed in
350 // dialog. The grfx::GCache makes the decisions about whether or not to draw
351 // (interogates lyxrc, ascertains whether file exists etc)
352 void InsetGraphics::updateInset() const
354 grfx::GCache & gc = grfx::GCache::get();
359 void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
361 bv->owner()->getDialogs()->showGraphics(this);
365 void InsetGraphics::edit(BufferView * bv, bool)
371 Inset::EDITABLE InsetGraphics::editable() const
377 void InsetGraphics::write(Buffer const * buf, ostream & os) const
379 os << "Graphics FormatVersion " << VersionNumber << '\n';
380 params().Write(buf, os);
384 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
386 string const token = lex.getString();
388 if (token == "Graphics")
389 readInsetGraphics(buf, lex);
390 else if (token == "Figure") // Compatibility reading of FigInset figures.
391 readFigInset(buf, lex);
393 lyxerr[Debug::GRAPHICS] << "Not a Graphics or Figure inset!\n";
398 void InsetGraphics::readInsetGraphics(Buffer const * buf, LyXLex & lex)
400 bool finished = false;
402 while (lex.isOK() && !finished) {
405 string const token = lex.getString();
406 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
411 } else if (token == "\\end_inset") {
413 } else if (token == "FormatVersion") {
415 int version = lex.getInteger();
416 if (version > VersionNumber)
418 << "This document was created with a newer Graphics widget"
419 ", You should use a newer version of LyX to read this"
422 // TODO: Possibly open up a dialog?
425 if (! params_.Read(buf, lex, token))
426 lyxerr << "Unknown token, " << token << ", skipping."
432 // FormatVersion < 1.0 (LyX < 1.2)
433 void InsetGraphics::readFigInset(Buffer const * buf, LyXLex & lex)
435 std::vector<string> const oldUnits =
436 getVectorFromString("pt,cm,in,p%,c%");
437 bool finished = false;
438 // set the display default
439 if (lyxrc.display_graphics == "mono")
440 params_.display = InsetGraphicsParams::MONOCHROME;
441 else if (lyxrc.display_graphics == "gray")
442 params_.display = InsetGraphicsParams::GRAYSCALE;
443 else if (lyxrc.display_graphics == "color")
444 params_.display = InsetGraphicsParams::COLOR;
446 params_.display = InsetGraphicsParams::NONE;
447 while (lex.isOK() && !finished) {
450 string const token = lex.getString();
451 lyxerr[Debug::GRAPHICS] << "Token: " << token << endl;
455 else if (token == "\\end_inset") {
457 } else if (token == "file") {
459 string const name = lex.getString();
460 string const path = buf->filePath();
461 params_.filename = MakeAbsPath(name, path);
463 } else if (token == "extra") {
465 // kept for backwards compability. Delete in 0.13.x
466 } else if (token == "subcaption") {
468 params_.subcaptionText = lex.getString();
469 params_.subcaption = true;
470 } else if (token == "label") {
472 // kept for backwards compability. Delete in 0.13.x
473 } else if (token == "angle") {
475 params_.rotate = true;
476 params_.rotateAngle = lex.getFloat();
477 } else if (token == "size") {
479 params_.lyxwidth = LyXLength(lex.getString()+"pt");
481 params_.lyxheight = LyXLength(lex.getString()+"pt");
482 } else if (token == "flags") {
484 switch (lex.getInteger()) {
485 case 1: params_.display = InsetGraphicsParams::MONOCHROME;
487 case 2: params_.display = InsetGraphicsParams::GRAYSCALE;
489 case 3: params_.display = InsetGraphicsParams::COLOR;
492 } else if (token == "subfigure") {
493 params_.subcaption = true;
494 } else if (token == "width") {
496 int i = lex.getInteger();
499 params_.scale = lex.getInteger();
500 params_.size_type = InsetGraphicsParams::SCALE;
502 params_.width = LyXLength(lex.getString()+oldUnits[i]);
503 params_.size_type = InsetGraphicsParams::WH;
507 } else if (token == "height") {
509 int i = lex.getInteger();
511 params_.height = LyXLength(lex.getString()+oldUnits[i]);
512 params_.size_type = InsetGraphicsParams::WH;
519 string const InsetGraphics::createLatexOptions() const
521 // Calculate the options part of the command, we must do it to a string
522 // stream since we might have a trailing comma that we would like to remove
523 // before writing it to the output stream.
524 ostringstream options;
525 if (!params().bb.empty())
526 options << " bb=" << strip(params().bb) << ",\n";
528 options << " draft,\n";
530 options << " clip,\n";
531 if (params().size_type == InsetGraphicsParams::WH) {
532 if (!params().width.zero())
533 options << " width=" << params().width.asLatexString() << ",\n";
534 if (!params().height.zero())
535 options << " height=" << params().height.asLatexString() << ",\n";
536 } else if (params().size_type == InsetGraphicsParams::SCALE) {
537 if (params().scale > 0)
538 options << " scale=" << double(params().scale)/100.0 << ",\n";
540 if (params().keepAspectRatio)
541 options << " keepaspectratio,\n";
542 // Make sure it's not very close to zero, a float can be effectively
543 // zero but not exactly zero.
544 if (!lyx::float_equal(params().rotateAngle, 0, 0.001) && params().rotate) {
545 options << " angle=" << params().rotateAngle << ",\n";
546 if (!params().rotateOrigin.empty()) {
547 options << " origin=" << params().rotateOrigin[0];
548 if (contains(params().rotateOrigin,"Top"))
550 else if (contains(params().rotateOrigin,"Bottom"))
552 else if (contains(params().rotateOrigin,"Baseline"))
557 if (!params().special.empty())
558 options << params().special << ",\n";
559 string opts = options.str().c_str();
560 return opts.substr(0,opts.size()-2); // delete last ",\n"
564 string findTargetFormat(string const & suffix)
566 // lyxrc.pdf_mode means:
567 // Are we creating a PDF or a PS file?
568 // (Should actually mean, are we using latex or pdflatex).
569 lyxerr[Debug::GRAPHICS] << "decideOutput: lyxrc.pdf_mode = "
570 << lyxrc.pdf_mode << std::endl;
571 if (lyxrc.pdf_mode) {
572 if (contains(suffix,"ps") || suffix == "pdf")
574 else if (suffix == "jpg")
579 // If it's postscript, we always do eps.
580 lyxerr[Debug::GRAPHICS] << "decideOutput: we have PostScript mode\n";
590 string const InsetGraphics::prepareFile(Buffer const *buf) const
592 // do_convert = Do we need to convert the file?
593 // nice = Do we create a nice version?
594 // This is used when exporting the latex file only.
596 // return original filename
598 // convert_place = temp directory
599 // return new filename in temp directory
601 // convert_place = original file directory
602 // return original filename without the extension
604 // if it's a zipped one, than let LaTeX do the rest!!!
605 string filename_ = params().filename;
606 bool const zipped = zippedFile(filename_);
608 if ((zipped && params().noUnzip) || buf->niceFile) {
609 lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
610 << filename_ << endl;
615 filename_ = unzipFile(filename_);
617 string const from = getExtFromContents(filename_);
618 string const to = findTargetFormat(from);
621 // No conversion needed!
625 string const temp = AddName(buf->tmppath, filename_);
626 string const outfile_base = RemoveExtension(temp);
628 lyxerr[Debug::GRAPHICS] << "tempname = " << temp << "\n";
629 lyxerr[Debug::GRAPHICS] << "buf::tmppath = " << buf->tmppath << "\n";
630 lyxerr[Debug::GRAPHICS] << "filename_ = " << filename_ << "\n";
631 lyxerr[Debug::GRAPHICS] << "outfile_base = " << outfile_base << endl;
633 converters.convert(buf, filename_, outfile_base, from, to);
638 int InsetGraphics::latex(Buffer const *buf, ostream & os,
639 bool /*fragile*/, bool/*fs*/) const
641 // If there is no file specified, just output a message about it in
643 if (params().filename.empty()) {
644 os << "\\fbox{\\rule[-0.5in]{0pt}{1in}"
645 << _("empty figure path") << "}\n";
646 return 1; // One end of line marker added to the stream.
648 // These variables collect all the latex code that should be before and
649 // after the actual includegraphics command.
652 // Do we want subcaptions?
653 if (params().subcaption) {
654 before += "\\subfigure[" + params().subcaptionText + "]{";
657 // We never use the starred form, we use the "clip" option instead.
658 before += "\\includegraphics";
659 // Write the options if there are any.
660 string const opts = createLatexOptions();
662 before += ("[%\n" + opts +']');
664 // Make the filename relative to the lyx file
665 // and remove the extension so the LaTeX will use whatever is
666 // appropriate (when there are several versions in different formats)
667 string const latex_str = before + '{' + prepareFile(buf) + '}' + after;
670 // Return how many newlines we issued.
672 int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
674 // lyxerr << "includegraphics: " << newlines << " lines of text"
680 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
682 // No graphics in ascii output. Possible to use gifscii to convert
683 // images to ascii approximation.
684 // 1. Convert file to ascii using gifscii
685 // 2. Read ascii output file and add it to the output stream.
686 // at least we send the filename
687 os << '<' << _("Graphicfile:") << params().filename << ">\n";
692 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
694 // No graphics in LinuxDoc output. Should check how/what to add.
699 // For explanation on inserting graphics into DocBook checkout:
700 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
701 // See also the docbook guide at http://www.docbook.org/
702 int InsetGraphics::docbook(Buffer const *, ostream & os) const
704 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
705 // need to switch to MediaObject. However, for now this is sufficient and
707 os << "<graphic fileref=\"&" << graphic_label << ";\">";
712 void InsetGraphics::validate(LaTeXFeatures & features) const
714 // If we have no image, we should not require anything.
715 if (params().filename.empty())
718 features.includeFile(graphic_label, RemoveExtension(params_.filename));
720 features.require("graphicx");
722 if (params().subcaption)
723 features.require("subfigure");
727 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
729 // If nothing is changed, just return and say so.
730 if (params() == p && !p.filename.empty()) {
734 // Copy the new parameters.
737 // Update the inset with the new parameters.
740 // We have changed data, report it.
745 InsetGraphicsParams const & InsetGraphics::params() const
751 Inset * InsetGraphics::clone(Buffer const &, bool same_id) const
753 return new InsetGraphics(*this, same_id);