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>
96 #include <algorithm> // For the std::max
98 extern string system_tempdir;
103 ///////////////////////////////////////////////////////////////////////////
104 int const VersionNumber = 1;
105 ///////////////////////////////////////////////////////////////////////////
109 // This function is a utility function
110 // ... that should be with ChangeExtension ...
112 string const RemoveExtension(string const & filename)
114 return ChangeExtension(filename, string());
122 string const uniqueID()
124 static unsigned int seed = 1000;
127 ost << "graph" << ++seed;
129 // Needed if we use lyxstring.
130 return ost.str().c_str();
136 struct InsetGraphics::Cache : boost::signals::trackable
139 Cache(InsetGraphics &);
141 void update(string const & file_with_path);
148 unsigned long checksum;
150 boost::weak_ptr<BufferView> view;
154 InsetGraphics & parent_;
158 InsetGraphics::Cache::Cache(InsetGraphics & p)
159 : old_ascent(0), checksum(0), parent_(p)
161 loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
165 void InsetGraphics::Cache::update(string const & file_with_path)
167 lyx::Assert(!file_with_path.empty());
169 string const path = OnlyPath(file_with_path);
170 loader.reset(file_with_path, parent_.params().as_grfxParams(path));
174 InsetGraphics::InsetGraphics()
175 : graphic_label(uniqueID()),
176 cache_(new Cache(*this))
180 InsetGraphics::InsetGraphics(InsetGraphics const & ig,
181 string const & filepath,
183 : Inset(ig, same_id),
184 graphic_label(uniqueID()),
185 cache_(new Cache(*this))
187 setParams(ig.params(), filepath);
191 InsetGraphics::~InsetGraphics()
193 // Emits the hide signal to the dialog connected (if any)
198 string const InsetGraphics::statusMessage() const
202 switch (cache_->loader.status()) {
203 case grfx::WaitingToLoad:
204 msg = _("Waiting for draw request to start loading...");
207 msg = _("Loading...");
209 case grfx::Converting:
210 msg = _("Converting to loadable format...");
213 msg = _("Loaded into memory. Must now generate pixmap.");
215 case grfx::ScalingEtc:
216 msg = _("Scaling etc...");
219 msg = _("Ready to display");
221 case grfx::ErrorNoFile:
222 msg = _("No file found!");
224 case grfx::ErrorConverting:
225 msg = _("Error converting to loadable format");
227 case grfx::ErrorLoading:
228 msg = _("Error loading file into memory");
230 case grfx::ErrorGeneratingPixmap:
231 msg = _("Error generating the pixmap");
233 case grfx::ErrorUnknown:
242 bool InsetGraphics::imageIsDrawable() const
244 if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
247 return cache_->loader.image()->isDrawable();
251 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
253 cache_->old_ascent = 50;
254 if (imageIsDrawable())
255 cache_->old_ascent = cache_->loader.image()->getHeight();
256 return cache_->old_ascent;
260 int InsetGraphics::descent(BufferView *, LyXFont const &) const
266 int InsetGraphics::width(BufferView *, LyXFont const & font) const
268 if (imageIsDrawable())
269 return cache_->loader.image()->getWidth();
273 LyXFont msgFont(font);
274 msgFont.setFamily(LyXFont::SANS_FAMILY);
276 string const justname = OnlyFilename (params().filename);
277 if (!justname.empty()) {
278 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
279 font_width = font_metrics::width(justname, msgFont);
282 string const msg = statusMessage();
284 msgFont.setSize(LyXFont::SIZE_TINY);
285 int const msg_width = font_metrics::width(msg, msgFont);
286 font_width = std::max(font_width, msg_width);
289 return std::max(50, font_width + 15);
294 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
295 int baseline, float & x, bool) const
297 // MakeAbsPath returns params().filename unchanged if it absolute
299 string const file_with_path =
300 MakeAbsPath(params().filename, bv->buffer()->filePath());
302 // A 'paste' operation creates a new inset with the correct filepath,
303 // but then the 'old' inset stored in the 'copy' operation is actually
304 // added to the buffer.
305 // Thus, we should ensure that the filepath is correct.
306 if (file_with_path != cache_->loader.filename())
307 cache_->update(file_with_path);
309 cache_->view = bv->owner()->view();
310 int oasc = cache_->old_ascent;
312 int ldescent = descent(bv, font);
313 int lascent = ascent(bv, font);
314 int lwidth = width(bv, font);
316 // we may have changed while someone other was drawing us so better
317 // to not draw anything as we surely call to redraw ourself soon.
318 // This is not a nice thing to do and should be fixed properly somehow.
319 // But I still don't know the best way to go. So let's do this like this
320 // for now (Jug 20020311)
321 if (lascent != oasc) {
325 // Make sure now that x is updated upon exit from this routine
329 if (cache_->loader.status() == grfx::WaitingToLoad)
330 cache_->loader.startLoading(*this, *bv);
332 if (!cache_->loader.monitoring())
333 cache_->loader.startMonitoring();
335 // This will draw the graphics. If the graphics has not been loaded yet,
336 // we draw just a rectangle.
337 Painter & paint = bv->painter();
339 if (imageIsDrawable()) {
340 paint.image(old_x + 2, baseline - lascent,
341 lwidth - 4, lascent + ldescent,
342 *cache_->loader.image());
346 paint.rectangle(old_x + 2, baseline - lascent,
350 // Print the file name.
351 LyXFont msgFont(font);
352 msgFont.setFamily(LyXFont::SANS_FAMILY);
353 string const justname = OnlyFilename (params().filename);
354 if (!justname.empty()) {
355 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
356 paint.text(old_x + 8,
357 baseline - font_metrics::maxAscent(msgFont) - 4,
361 // Print the message.
362 string const msg = statusMessage();
364 msgFont.setSize(LyXFont::SIZE_TINY);
365 paint.text(old_x + 8, baseline - 4, msg, msgFont);
369 // the status message may mean we changed size, so indicate
370 // we need a row redraw
372 if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
373 bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
377 // Reset the cache, ready for the next draw request
379 cached_status_ = grfx::ErrorUnknown;
380 cached_image_.reset();
381 cache_filled_ = false;
386 void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
388 bv->owner()->getDialogs().showGraphics(this);
392 void InsetGraphics::edit(BufferView * bv, bool)
394 edit(bv, 0, 0, mouse_button::none);
398 Inset::EDITABLE InsetGraphics::editable() const
404 void InsetGraphics::write(Buffer const *, ostream & os) const
411 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
413 string const token = lex.getString();
415 if (token == "Graphics")
416 readInsetGraphics(lex);
418 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
420 cache_->update(MakeAbsPath(params().filename, buf->filePath()));
424 void InsetGraphics::readInsetGraphics(LyXLex & lex)
426 bool finished = false;
428 while (lex.isOK() && !finished) {
431 string const token = lex.getString();
432 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
437 } else if (token == "\\end_inset") {
439 } else if (token == "FormatVersion") {
441 int version = lex.getInteger();
442 if (version > VersionNumber)
444 << "This document was created with a newer Graphics widget"
445 ", You should use a newer version of LyX to read this"
448 // TODO: Possibly open up a dialog?
451 if (! params_.Read(lex, token))
452 lyxerr << "Unknown token, " << token << ", skipping."
459 string const InsetGraphics::createLatexOptions() const
461 // Calculate the options part of the command, we must do it to a string
462 // stream since we might have a trailing comma that we would like to remove
463 // before writing it to the output stream.
464 ostringstream options;
465 if (!params().bb.empty())
466 options << " bb=" << rtrim(params().bb) << ",\n";
468 options << " draft,\n";
470 options << " clip,\n";
472 if (!lyx::float_equal(params().scale, 0.0, 0.05)) {
473 if (!lyx::float_equal(params().scale, 100.0, 0.05))
474 options << " scale=" << params().scale / 100.0
477 if (!params().width.zero())
478 options << " width=" << params().width.asLatexString() << ",\n";
479 if (!params().height.zero())
480 options << " height=" << params().height.asLatexString() << ",\n";
481 if (params().keepAspectRatio)
482 options << " keepaspectratio,\n";
485 // Make sure rotation angle is not very close to zero;
486 // a float can be effectively zero but not exactly zero.
487 if (!lyx::float_equal(params().rotateAngle, 0, 0.001)) {
488 options << " angle=" << params().rotateAngle << ",\n";
489 if (!params().rotateOrigin.empty()) {
490 options << " origin=" << params().rotateOrigin[0];
491 if (contains(params().rotateOrigin,"Top"))
493 else if (contains(params().rotateOrigin,"Bottom"))
495 else if (contains(params().rotateOrigin,"Baseline"))
501 if (!params().special.empty())
502 options << params().special << ",\n";
504 string opts = options.str().c_str();
505 return opts.substr(0,opts.size()-2); // delete last ",\n"
509 string findTargetFormat(string const & suffix)
511 // lyxrc.pdf_mode means:
512 // Are we creating a PDF or a PS file?
513 // (Should actually mean, are we using latex or pdflatex).
514 if (lyxrc.pdf_mode) {
515 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
516 if (contains(suffix, "ps") || suffix == "pdf")
518 else if (suffix == "jpg") // pdflatex can use jpeg
521 return "png"; // and also png
523 // If it's postscript, we always do eps.
524 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
525 if (suffix != "ps") // any other than ps
526 return "eps"; // is changed to eps
528 return suffix; // let ps untouched
534 string const InsetGraphics::prepareFile(Buffer const *buf) const
536 // LaTeX can cope if the graphics file doesn't exist, so just return the
538 string const orig_file = params().filename;
539 string orig_file_with_path =
540 MakeAbsPath(orig_file, buf->filePath());
541 lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
542 << orig_file << "\n\twith path: "
543 << orig_file_with_path << endl;
545 if (!IsFileReadable(orig_file_with_path))
548 bool const zipped = zippedFile(orig_file_with_path);
550 // If the file is compressed and we have specified that it
551 // should not be uncompressed, then just return its name and
552 // let LaTeX do the rest!
553 if (zipped && params().noUnzip) {
554 lyxerr[Debug::GRAPHICS]
555 << "\tpass zipped file to LaTeX but with full path.\n";
556 // LaTeX needs an absolue path, otherwise the
557 // coresponding *.eps.bb file isn't found
558 return orig_file_with_path;
561 // Ascertain whether the file has changed.
562 unsigned long const new_checksum = cache_->loader.checksum();
563 bool const file_has_changed = cache_->checksum != new_checksum;
564 if (file_has_changed)
565 cache_->checksum = new_checksum;
567 // temp_file will contain the file for LaTeX to act on if, for example,
568 // we move it to a temp dir or uncompress it.
569 string temp_file(orig_file);
572 // Uncompress the file if necessary.
573 // If it has been uncompressed in a previous call to
574 // prepareFile, do nothing.
575 temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
576 lyxerr[Debug::GRAPHICS]
577 << "\ttemp_file: " << temp_file << endl;
578 if (file_has_changed || !IsFileReadable(temp_file)) {
579 bool const success = lyx::copy(orig_file_with_path,
581 lyxerr[Debug::GRAPHICS]
582 << "\tCopying zipped file from "
583 << orig_file_with_path << " to " << temp_file
584 << (success ? " succeeded\n" : " failed\n");
586 lyxerr[Debug::GRAPHICS]
587 << "\tzipped file " << temp_file
588 << " exists! Maybe no tempdir ...\n";
589 orig_file_with_path = unzipFile(temp_file);
590 lyxerr[Debug::GRAPHICS]
591 << "\tunzipped to " << orig_file_with_path << endl;
594 string const from = getExtFromContents(orig_file_with_path);
595 string const to = findTargetFormat(from);
596 lyxerr[Debug::GRAPHICS]
597 << "\t we have: from " << from << " to " << to << '\n';
599 if (from == to && !lyxrc.use_tempdir)
600 // No conversion is needed. LaTeX can handle the
601 // graphic file as is.
602 // This is true even if the orig_file is compressed.
603 return RemoveExtension(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 return RemoveExtension(temp_file);
652 string const outfile_base = RemoveExtension(temp_file);
653 lyxerr[Debug::GRAPHICS]
654 << "\tThe original file is " << orig_file << "\n"
655 << "\tA copy has been made and convert is to be called with:\n"
656 << "\tfile to convert = " << temp_file << '\n'
657 << "\toutfile_base = " << outfile_base << '\n'
658 << "\t from " << from << " to " << to << '\n';
660 // if no special converter defined, than we take the default one
661 // from ImageMagic: convert from:inname.from to:outname.to
662 if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
663 string const command =
664 LibFileSearch("scripts", "convertDefault.sh") +
665 ' ' + from + ':' + temp_file + ' ' +
666 to + ':' + outfile_base + '.' + to;
667 lyxerr[Debug::GRAPHICS]
668 << "No converter defined! I use convertDefault.sh:\n\t"
671 one.startscript(Systemcall::Wait, command);
672 if (!IsFileReadable(ChangeExtension(outfile_base, to)))
673 Alert::alert(_("Cannot convert Image (not existing file?)"),
674 _("No information for converting from ")
675 + from + _(" to ") + to);
678 return RemoveExtension(temp_file);
682 int InsetGraphics::latex(Buffer const *buf, ostream & os,
683 bool /*fragile*/, bool/*fs*/) const
685 // If there is no file specified or not existing,
686 // just output a message about it in the latex output.
687 lyxerr[Debug::GRAPHICS]
688 << "insetgraphics::latex: Filename = "
689 << params().filename << endl;
691 // A missing (e)ps-extension is no problem for LaTeX, so
692 // we have to test three different cases
693 string const file_(MakeAbsPath(params().filename, buf->filePath()));
694 bool const file_exists =
696 (IsFileReadable(file_) || // original
697 IsFileReadable(file_ + ".eps") || // original.eps
698 IsFileReadable(file_ + ".ps")); // original.ps
699 string const message = file_exists ?
700 string() : string("bb = 0 0 200 100, draft, type=eps");
701 // if !message.empty() than there was no existing file
702 // "filename(.(e)ps)" found. In this case LaTeX
703 // draws only a rectangle with the above bb and the
704 // not found filename in it.
705 lyxerr[Debug::GRAPHICS]
706 << "\tMessage = \"" << message << '\"' << endl;
708 // These variables collect all the latex code that should be before and
709 // after the actual includegraphics command.
712 // Do we want subcaptions?
713 if (params().subcaption) {
714 before += "\\subfigure[" + params().subcaptionText + "]{";
717 // We never use the starred form, we use the "clip" option instead.
718 before += "\\includegraphics";
720 // Write the options if there are any.
721 string const opts = createLatexOptions();
722 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
724 if (!opts.empty() && !message.empty())
725 before += ("[%\n" + opts + ',' + message + ']');
726 else if (!opts.empty() || !message.empty())
727 before += ("[%\n" + opts + message + ']');
729 lyxerr[Debug::GRAPHICS]
730 << "\tBefore = " << before
731 << "\n\tafter = " << after << endl;
734 // "nice" means that the buffer is exported to LaTeX format but not
735 // run through the LaTeX compiler.
737 os << before <<'{' << params().filename << '}' << after;
741 // Make the filename relative to the lyx file
742 // and remove the extension so the LaTeX will use whatever is
743 // appropriate (when there are several versions in different formats)
744 string const latex_str = message.empty() ?
745 (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
746 (before + '{' + params().filename + " not found!}" + after);
749 // Return how many newlines we issued.
751 int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
757 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
759 // No graphics in ascii output. Possible to use gifscii to convert
760 // images to ascii approximation.
761 // 1. Convert file to ascii using gifscii
762 // 2. Read ascii output file and add it to the output stream.
763 // at least we send the filename
764 os << '<' << _("Graphic file:") << params().filename << ">\n";
769 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
771 // No graphics in LinuxDoc output. Should check how/what to add.
776 // For explanation on inserting graphics into DocBook checkout:
777 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
778 // See also the docbook guide at http://www.docbook.org/
779 int InsetGraphics::docbook(Buffer const *, ostream & os,
780 bool /*mixcont*/) const
782 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
783 // need to switch to MediaObject. However, for now this is sufficient and
785 os << "<graphic fileref=\"&" << graphic_label << ";\">";
790 void InsetGraphics::validate(LaTeXFeatures & features) const
792 // If we have no image, we should not require anything.
793 if (params().filename.empty())
796 features.includeFile(graphic_label, RemoveExtension(params().filename));
798 features.require("graphicx");
800 if (params().subcaption)
801 features.require("subfigure");
805 void InsetGraphics::statusChanged()
807 if (cache_->view.get())
808 cache_->view.get()->updateInset(this, false);
812 bool InsetGraphics::setParams(InsetGraphicsParams const & p,
813 string const & filepath)
815 // If nothing is changed, just return and say so.
816 if (params() == p && !p.filename.empty()) {
820 // Copy the new parameters.
823 // Update the inset with the new parameters.
824 cache_->update(MakeAbsPath(params().filename, filepath));
826 // We have changed data, report it.
831 InsetGraphicsParams const & InsetGraphics::params() const
837 Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
839 return new InsetGraphics(*this, buffer.filePath(), same_id);