2 * \file insetgraphics.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS
15 * What advanced features the users want to do?
16 Implement them in a non latex dependent way, but a logical way.
17 LyX should translate it to latex or any other fitting format.
18 * Add a way to roll the image file into the file format.
19 * When loading, if the image is not found in the expected place, try
20 to find it in the clipart, or in the same directory with the image.
21 * The image choosing dialog could show thumbnails of the image formats
22 it knows of, thus selection based on the image instead of based on
24 * Add support for the 'picins' package.
25 * Add support for the 'picinpar' package.
26 * Improve support for 'subfigure' - Allow to set the various options
32 * Current version is 1 (inset file format version), when changing it
33 * it should be changed in the Write() function when writing in one place
34 * and when reading one should change the version check and the error message.
35 * The filename is kept in the lyx file in a relative way, so as to allow
36 * moving the document file and its images with no problem.
40 * Postscript output means EPS figures.
42 * PDF output is best done with PDF figures if it's a direct conversion
43 * or PNG figures otherwise.
56 #pragma implementation
59 #include "insets/insetgraphics.h"
60 #include "insets/insetgraphicsParams.h"
62 #include "graphics/GraphicsLoader.h"
63 #include "graphics/GraphicsImage.h"
64 #include "graphics/GraphicsParams.h"
68 #include "BufferView.h"
69 #include "converter.h"
70 #include "frontends/Painter.h"
72 #include "frontends/font_metrics.h"
75 #include "LaTeXFeatures.h"
78 #include "frontends/Alert.h"
79 #include "frontends/Dialogs.h"
80 #include "frontends/LyXView.h"
82 #include "frontends/controllers/helper_funcs.h" // getVectorFromString
84 #include "support/LAssert.h"
85 #include "support/filetools.h"
86 #include "support/lyxalgo.h" // lyx::count
87 #include "support/lyxlib.h" // float_equal
88 #include "support/path.h"
89 #include "support/systemcall.h"
90 #include "support/os.h"
92 #include <boost/weak_ptr.hpp>
93 #include <boost/bind.hpp>
94 #include <boost/signals/trackable.hpp>
95 #include "BoostFormat.h"
97 #include <algorithm> // For the std::max
99 extern string system_tempdir;
107 ///////////////////////////////////////////////////////////////////////////
108 int const VersionNumber = 1;
109 ///////////////////////////////////////////////////////////////////////////
111 // This function is a utility function
112 // ... that should be with ChangeExtension ...
114 string const RemoveExtension(string const & filename)
116 return ChangeExtension(filename, string());
120 string const uniqueID()
122 static unsigned int seed = 1000;
125 ost << "graph" << ++seed;
127 // Needed if we use lyxstring.
128 return STRCONV(ost.str());
132 string findTargetFormat(string const & suffix)
134 // lyxrc.pdf_mode means:
135 // Are we creating a PDF or a PS file?
136 // (Should actually mean, are we using latex or pdflatex).
137 if (lyxrc.pdf_mode) {
138 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
139 if (contains(suffix, "ps") || suffix == "pdf")
141 else if (suffix == "jpg") // pdflatex can use jpeg
144 return "png"; // and also png
146 // If it's postscript, we always do eps.
147 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
148 if (suffix != "ps") // any other than ps
149 return "eps"; // is changed to eps
151 return suffix; // let ps untouched
157 struct InsetGraphics::Cache : boost::signals::trackable
160 Cache(InsetGraphics &);
162 void update(string const & file_with_path);
169 unsigned long checksum;
171 boost::weak_ptr<BufferView> view;
175 InsetGraphics & parent_;
179 InsetGraphics::Cache::Cache(InsetGraphics & p)
180 : old_ascent(0), checksum(0), parent_(p)
182 loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
186 void InsetGraphics::Cache::update(string const & file_with_path)
188 lyx::Assert(!file_with_path.empty());
190 string const path = OnlyPath(file_with_path);
191 loader.reset(file_with_path, parent_.params().as_grfxParams(path));
195 InsetGraphics::InsetGraphics()
196 : graphic_label(uniqueID()),
197 cache_(new Cache(*this))
201 InsetGraphics::InsetGraphics(InsetGraphics const & ig,
202 string const & filepath,
204 : Inset(ig, same_id),
205 graphic_label(uniqueID()),
206 cache_(new Cache(*this))
208 setParams(ig.params(), filepath);
212 InsetGraphics::~InsetGraphics()
214 // Emits the hide signal to the dialog connected (if any)
219 string const InsetGraphics::statusMessage() const
223 switch (cache_->loader.status()) {
224 case grfx::WaitingToLoad:
225 msg = _("Waiting for draw request to start loading...");
228 msg = _("Loading...");
230 case grfx::Converting:
231 msg = _("Converting to loadable format...");
234 msg = _("Loaded into memory. Must now generate pixmap.");
236 case grfx::ScalingEtc:
237 msg = _("Scaling etc...");
240 msg = _("Ready to display");
242 case grfx::ErrorNoFile:
243 msg = _("No file found!");
245 case grfx::ErrorConverting:
246 msg = _("Error converting to loadable format");
248 case grfx::ErrorLoading:
249 msg = _("Error loading file into memory");
251 case grfx::ErrorGeneratingPixmap:
252 msg = _("Error generating the pixmap");
254 case grfx::ErrorUnknown:
263 bool InsetGraphics::imageIsDrawable() const
265 if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
268 return cache_->loader.image()->isDrawable();
272 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
274 cache_->old_ascent = 50;
275 if (imageIsDrawable())
276 cache_->old_ascent = cache_->loader.image()->getHeight();
277 return cache_->old_ascent;
281 int InsetGraphics::descent(BufferView *, LyXFont const &) const
287 int InsetGraphics::width(BufferView *, LyXFont const & font) const
289 if (imageIsDrawable())
290 return cache_->loader.image()->getWidth() + 2 * TEXT_TO_INSET_OFFSET;
294 LyXFont msgFont(font);
295 msgFont.setFamily(LyXFont::SANS_FAMILY);
297 string const justname = OnlyFilename (params().filename);
298 if (!justname.empty()) {
299 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
300 font_width = font_metrics::width(justname, msgFont);
303 string const msg = statusMessage();
305 msgFont.setSize(LyXFont::SIZE_TINY);
306 int const msg_width = font_metrics::width(msg, msgFont);
307 font_width = std::max(font_width, msg_width);
310 return std::max(50, font_width + 15);
315 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
316 int baseline, float & x, bool) const
318 // MakeAbsPath returns params().filename unchanged if it absolute
320 string const file_with_path =
321 MakeAbsPath(params().filename, bv->buffer()->filePath());
323 // A 'paste' operation creates a new inset with the correct filepath,
324 // but then the 'old' inset stored in the 'copy' operation is actually
325 // added to the buffer.
326 // Thus, we should ensure that the filepath is correct.
327 if (file_with_path != cache_->loader.filename())
328 cache_->update(file_with_path);
330 cache_->view = bv->owner()->view();
331 int oasc = cache_->old_ascent;
333 int ldescent = descent(bv, font);
334 int lascent = ascent(bv, font);
335 int lwidth = width(bv, font);
337 // we may have changed while someone other was drawing us so better
338 // to not draw anything as we surely call to redraw ourself soon.
339 // This is not a nice thing to do and should be fixed properly somehow.
340 // But I still don't know the best way to go. So let's do this like this
341 // for now (Jug 20020311)
342 if (lascent != oasc) {
346 // Make sure now that x is updated upon exit from this routine
350 if (cache_->loader.status() == grfx::WaitingToLoad)
351 cache_->loader.startLoading(*this, *bv);
353 if (!cache_->loader.monitoring())
354 cache_->loader.startMonitoring();
356 // This will draw the graphics. If the graphics has not been loaded yet,
357 // we draw just a rectangle.
358 Painter & paint = bv->painter();
360 if (imageIsDrawable()) {
361 paint.image(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
362 lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent,
363 *cache_->loader.image());
367 paint.rectangle(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
368 lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent);
370 // Print the file name.
371 LyXFont msgFont(font);
372 msgFont.setFamily(LyXFont::SANS_FAMILY);
373 string const justname = OnlyFilename (params().filename);
374 if (!justname.empty()) {
375 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
376 paint.text(old_x + TEXT_TO_INSET_OFFSET + 6,
377 baseline - font_metrics::maxAscent(msgFont) - 4,
381 // Print the message.
382 string const msg = statusMessage();
384 msgFont.setSize(LyXFont::SIZE_TINY);
385 paint.text(old_x + TEXT_TO_INSET_OFFSET + 6, baseline - 4, msg, msgFont);
389 // the status message may mean we changed size, so indicate
390 // we need a row redraw
392 if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
393 bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
397 // Reset the cache, ready for the next draw request
399 cached_status_ = grfx::ErrorUnknown;
400 cached_image_.reset();
401 cache_filled_ = false;
406 void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
408 bv->owner()->getDialogs().showGraphics(this);
412 void InsetGraphics::edit(BufferView * bv, bool)
414 edit(bv, 0, 0, mouse_button::none);
418 Inset::EDITABLE InsetGraphics::editable() const
424 void InsetGraphics::write(Buffer const *, ostream & os) const
431 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
433 string const token = lex.getString();
435 if (token == "Graphics")
436 readInsetGraphics(lex);
438 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
440 cache_->update(MakeAbsPath(params().filename, buf->filePath()));
444 void InsetGraphics::readInsetGraphics(LyXLex & lex)
446 bool finished = false;
448 while (lex.isOK() && !finished) {
451 string const token = lex.getString();
452 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
457 } else if (token == "\\end_inset") {
459 } else if (token == "FormatVersion") {
461 int version = lex.getInteger();
462 if (version > VersionNumber)
464 << "This document was created with a newer Graphics widget"
465 ", You should use a newer version of LyX to read this"
468 // TODO: Possibly open up a dialog?
471 if (! params_.Read(lex, token))
472 lyxerr << "Unknown token, " << token << ", skipping."
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=" << rtrim(params().bb) << ",\n";
488 options << " draft,\n";
490 options << " clip,\n";
491 if (!lyx::float_equal(params().scale, 0.0, 0.05)) {
492 if (!lyx::float_equal(params().scale, 100.0, 0.05))
493 options << " scale=" << params().scale / 100.0
496 if (!params().width.zero())
497 options << " width=" << params().width.asLatexString() << ",\n";
498 if (!params().height.zero())
499 options << " height=" << params().height.asLatexString() << ",\n";
500 if (params().keepAspectRatio)
501 options << " keepaspectratio,\n";
504 // Make sure rotation angle is not very close to zero;
505 // a float can be effectively zero but not exactly zero.
506 if (!lyx::float_equal(params().rotateAngle, 0, 0.001)) {
507 options << " angle=" << params().rotateAngle << ",\n";
508 if (!params().rotateOrigin.empty()) {
509 options << " origin=" << params().rotateOrigin[0];
510 if (contains(params().rotateOrigin,"Top"))
512 else if (contains(params().rotateOrigin,"Bottom"))
514 else if (contains(params().rotateOrigin,"Baseline"))
520 if (!params().special.empty())
521 options << params().special << ",\n";
523 string opts = STRCONV(options.str());
525 return opts.substr(0, opts.size() - 2);
529 string const InsetGraphics::prepareFile(Buffer const * buf) const
531 // LaTeX can cope if the graphics file doesn't exist, so just return the
533 string const orig_file = params().filename;
534 string orig_file_with_path =
535 MakeAbsPath(orig_file, buf->filePath());
536 lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
537 << orig_file << "\n\twith path: "
538 << orig_file_with_path << endl;
540 if (!IsFileReadable(orig_file_with_path))
543 bool const zipped = zippedFile(orig_file_with_path);
545 // If the file is compressed and we have specified that it
546 // should not be uncompressed, then just return its name and
547 // let LaTeX do the rest!
548 if (zipped && params().noUnzip) {
549 lyxerr[Debug::GRAPHICS]
550 << "\tpass zipped file to LaTeX but with full path.\n";
551 // LaTeX needs an absolue path, otherwise the
552 // coresponding *.eps.bb file isn't found
553 return orig_file_with_path;
556 // Ascertain whether the file has changed.
557 unsigned long const new_checksum = cache_->loader.checksum();
558 bool const file_has_changed = cache_->checksum != new_checksum;
559 if (file_has_changed)
560 cache_->checksum = new_checksum;
562 // temp_file will contain the file for LaTeX to act on if, for example,
563 // we move it to a temp dir or uncompress it.
564 string temp_file(orig_file);
567 // Uncompress the file if necessary.
568 // If it has been uncompressed in a previous call to
569 // prepareFile, do nothing.
570 temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
571 lyxerr[Debug::GRAPHICS]
572 << "\ttemp_file: " << temp_file << endl;
573 if (file_has_changed || !IsFileReadable(temp_file)) {
574 bool const success = lyx::copy(orig_file_with_path,
576 lyxerr[Debug::GRAPHICS]
577 << "\tCopying zipped file from "
578 << orig_file_with_path << " to " << temp_file
579 << (success ? " succeeded\n" : " failed\n");
581 lyxerr[Debug::GRAPHICS]
582 << "\tzipped file " << temp_file
583 << " exists! Maybe no tempdir ...\n";
584 orig_file_with_path = unzipFile(temp_file);
585 lyxerr[Debug::GRAPHICS]
586 << "\tunzipped to " << orig_file_with_path << endl;
589 string const from = getExtFromContents(orig_file_with_path);
590 string const to = findTargetFormat(from);
591 lyxerr[Debug::GRAPHICS]
592 << "\t we have: from " << from << " to " << to << '\n';
594 if (from == to && !lyxrc.use_tempdir) {
595 // No conversion is needed. LaTeX can handle the
596 // graphic file as is.
597 // This is true even if the orig_file is compressed.
598 if (formats.getFormat(to)->extension() == GetExtension(orig_file)) {
599 return RemoveExtension(orig_file_with_path);
601 return orig_file_with_path;
605 // We're going to be running the exported buffer through the LaTeX
606 // compiler, so must ensure that LaTeX can cope with the graphics
609 // Perform all these manipulations on a temporary file if possible.
610 // If we are not using a temp dir, then temp_file contains the
612 // to allow files with the same name in different dirs
613 // we manipulate the original file "any.dir/file.ext"
614 // to "any_dir_file.ext"! changing the dots in the
615 // dirname is important for the use of ChangeExtension
616 lyxerr[Debug::GRAPHICS]
617 << "\tthe orig file is: " << orig_file_with_path << endl;
619 if (lyxrc.use_tempdir) {
620 string const ext_tmp = GetExtension(orig_file_with_path);
623 ChangeExtension(orig_file_with_path, string()), "/", "_");
624 // without dots and again with ext
625 temp_file = ChangeExtension(
626 subst(temp_file, ".", "_"), ext_tmp);
627 // now we have any_dir_file.ext
628 temp_file = MakeAbsPath(temp_file, buf->tmppath);
629 lyxerr[Debug::GRAPHICS]
630 << "\tchanged to: " << temp_file << endl;
632 // if the file doen't exists, copy it into the tempdir
633 if (file_has_changed || !IsFileReadable(temp_file)) {
634 bool const success = lyx::copy(orig_file_with_path, temp_file);
635 lyxerr[Debug::GRAPHICS]
636 << "\tcopying from " << orig_file_with_path << " to "
638 << (success ? " succeeded\n" : " failed\n");
640 Alert::alert(_("Cannot copy file"), orig_file_with_path,
647 // No conversion is needed. LaTeX can handle the
648 // graphic file as is.
649 if (formats.getFormat(to)->extension() == GetExtension(orig_file))
650 return RemoveExtension(temp_file);
656 string const outfile_base = RemoveExtension(temp_file);
657 lyxerr[Debug::GRAPHICS]
658 << "\tThe original file is " << orig_file << "\n"
659 << "\tA copy has been made and convert is to be called with:\n"
660 << "\tfile to convert = " << temp_file << '\n'
661 << "\toutfile_base = " << outfile_base << '\n'
662 << "\t from " << from << " to " << to << '\n';
664 // if no special converter defined, than we take the default one
665 // from ImageMagic: convert from:inname.from to:outname.to
666 if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
667 string const command =
668 LibFileSearch("scripts", "convertDefault.sh") +
669 ' ' + from + ':' + temp_file + ' ' +
670 to + ':' + outfile_base + '.' + to;
671 lyxerr[Debug::GRAPHICS]
672 << "No converter defined! I use convertDefault.sh:\n\t"
675 one.startscript(Systemcall::Wait, command);
676 if (!IsFileReadable(ChangeExtension(outfile_base, to)))
678 Alert::alert(_("Cannot convert Image (not existing file?)"),
679 boost::io::str(boost::format(_("No information for converting from %1$s to %2$s"))
682 Alert::alert(_("Cannot convert Image (not existing file?)"),
683 _("No information for converting from ") + from + " to " + to);
687 return RemoveExtension(temp_file);
691 int InsetGraphics::latex(Buffer const *buf, ostream & os,
692 bool /*fragile*/, bool/*fs*/) const
694 // If there is no file specified or not existing,
695 // just output a message about it in the latex output.
696 lyxerr[Debug::GRAPHICS]
697 << "insetgraphics::latex: Filename = "
698 << params().filename << endl;
700 // A missing (e)ps-extension is no problem for LaTeX, so
701 // we have to test three different cases
702 string const file_(MakeAbsPath(params().filename, buf->filePath()));
703 bool const file_exists =
705 (IsFileReadable(file_) || // original
706 IsFileReadable(file_ + ".eps") || // original.eps
707 IsFileReadable(file_ + ".ps")); // original.ps
708 string const message = file_exists ?
709 string() : string("bb = 0 0 200 100, draft, type=eps");
710 // if !message.empty() than there was no existing file
711 // "filename(.(e)ps)" found. In this case LaTeX
712 // draws only a rectangle with the above bb and the
713 // not found filename in it.
714 lyxerr[Debug::GRAPHICS]
715 << "\tMessage = \"" << message << '\"' << endl;
717 // These variables collect all the latex code that should be before and
718 // after the actual includegraphics command.
721 // Do we want subcaptions?
722 if (params().subcaption) {
723 before += "\\subfigure[" + params().subcaptionText + "]{";
726 // We never use the starred form, we use the "clip" option instead.
727 before += "\\includegraphics";
729 // Write the options if there are any.
730 string const opts = createLatexOptions();
731 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
733 if (!opts.empty() && !message.empty())
734 before += ("[%\n" + opts + ',' + message + ']');
735 else if (!opts.empty() || !message.empty())
736 before += ("[%\n" + opts + message + ']');
738 lyxerr[Debug::GRAPHICS]
739 << "\tBefore = " << before
740 << "\n\tafter = " << after << endl;
743 // "nice" means that the buffer is exported to LaTeX format but not
744 // run through the LaTeX compiler.
746 os << before <<'{' << params().filename << '}' << after;
750 // Make the filename relative to the lyx file
751 // and remove the extension so the LaTeX will use whatever is
752 // appropriate (when there are several versions in different formats)
753 string const latex_str = message.empty() ?
754 (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
755 (before + '{' + params().filename + " not found!}" + after);
758 // Return how many newlines we issued.
760 int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
766 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
768 // No graphics in ascii output. Possible to use gifscii to convert
769 // images to ascii approximation.
770 // 1. Convert file to ascii using gifscii
771 // 2. Read ascii output file and add it to the output stream.
772 // at least we send the filename
775 << boost::format(_("Graphics file: %1$s")) % params().filename
779 << _("Graphics file: ") << params().filename
786 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
788 // No graphics in LinuxDoc output. Should check how/what to add.
793 // For explanation on inserting graphics into DocBook checkout:
794 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
795 // See also the docbook guide at http://www.docbook.org/
796 int InsetGraphics::docbook(Buffer const *, ostream & os,
797 bool /*mixcont*/) const
799 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
800 // need to switch to MediaObject. However, for now this is sufficient and
802 os << "<graphic fileref=\"&" << graphic_label << ";\">";
807 void InsetGraphics::validate(LaTeXFeatures & features) const
809 // If we have no image, we should not require anything.
810 if (params().filename.empty())
813 features.includeFile(graphic_label, RemoveExtension(params().filename));
815 features.require("graphicx");
817 if (params().subcaption)
818 features.require("subfigure");
822 void InsetGraphics::statusChanged()
824 if (cache_->view.get())
825 cache_->view.get()->updateInset(this, false);
829 bool InsetGraphics::setParams(InsetGraphicsParams const & p,
830 string const & filepath)
832 // If nothing is changed, just return and say so.
833 if (params() == p && !p.filename.empty()) {
837 // Copy the new parameters.
840 // Update the inset with the new parameters.
841 cache_->update(MakeAbsPath(params().filename, filepath));
843 // We have changed data, report it.
848 InsetGraphicsParams const & InsetGraphics::params() const
854 Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
856 return new InsetGraphics(*this, buffer.filePath(), same_id);