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();
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 + 2, baseline - lascent,
362 lwidth - 4, lascent + ldescent,
363 *cache_->loader.image());
367 paint.rectangle(old_x + 2, baseline - lascent,
371 // Print the file name.
372 LyXFont msgFont(font);
373 msgFont.setFamily(LyXFont::SANS_FAMILY);
374 string const justname = OnlyFilename (params().filename);
375 if (!justname.empty()) {
376 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
377 paint.text(old_x + 8,
378 baseline - font_metrics::maxAscent(msgFont) - 4,
382 // Print the message.
383 string const msg = statusMessage();
385 msgFont.setSize(LyXFont::SIZE_TINY);
386 paint.text(old_x + 8, baseline - 4, msg, msgFont);
390 // the status message may mean we changed size, so indicate
391 // we need a row redraw
393 if (old_status_ != grfx::ErrorUnknown && old_status_ != cached_status_) {
394 bv->getLyXText()->status(bv, LyXText::CHANGED_IN_DRAW);
398 // Reset the cache, ready for the next draw request
400 cached_status_ = grfx::ErrorUnknown;
401 cached_image_.reset();
402 cache_filled_ = false;
407 void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
409 bv->owner()->getDialogs().showGraphics(this);
413 void InsetGraphics::edit(BufferView * bv, bool)
415 edit(bv, 0, 0, mouse_button::none);
419 Inset::EDITABLE InsetGraphics::editable() const
425 void InsetGraphics::write(Buffer const *, ostream & os) const
432 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
434 string const token = lex.getString();
436 if (token == "Graphics")
437 readInsetGraphics(lex);
439 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
441 cache_->update(MakeAbsPath(params().filename, buf->filePath()));
445 void InsetGraphics::readInsetGraphics(LyXLex & lex)
447 bool finished = false;
449 while (lex.isOK() && !finished) {
452 string const token = lex.getString();
453 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
458 } else if (token == "\\end_inset") {
460 } else if (token == "FormatVersion") {
462 int version = lex.getInteger();
463 if (version > VersionNumber)
465 << "This document was created with a newer Graphics widget"
466 ", You should use a newer version of LyX to read this"
469 // TODO: Possibly open up a dialog?
472 if (! params_.Read(lex, token))
473 lyxerr << "Unknown token, " << token << ", skipping."
480 string const InsetGraphics::createLatexOptions() const
482 // Calculate the options part of the command, we must do it to a string
483 // stream since we might have a trailing comma that we would like to remove
484 // before writing it to the output stream.
485 ostringstream options;
486 if (!params().bb.empty())
487 options << " bb=" << rtrim(params().bb) << ",\n";
489 options << " draft,\n";
491 options << " clip,\n";
492 if (!lyx::float_equal(params().scale, 0.0, 0.05)) {
493 if (!lyx::float_equal(params().scale, 100.0, 0.05))
494 options << " scale=" << params().scale / 100.0
497 if (!params().width.zero())
498 options << " width=" << params().width.asLatexString() << ",\n";
499 if (!params().height.zero())
500 options << " height=" << params().height.asLatexString() << ",\n";
501 if (params().keepAspectRatio)
502 options << " keepaspectratio,\n";
505 // Make sure rotation angle is not very close to zero;
506 // a float can be effectively zero but not exactly zero.
507 if (!lyx::float_equal(params().rotateAngle, 0, 0.001)) {
508 options << " angle=" << params().rotateAngle << ",\n";
509 if (!params().rotateOrigin.empty()) {
510 options << " origin=" << params().rotateOrigin[0];
511 if (contains(params().rotateOrigin,"Top"))
513 else if (contains(params().rotateOrigin,"Bottom"))
515 else if (contains(params().rotateOrigin,"Baseline"))
521 if (!params().special.empty())
522 options << params().special << ",\n";
524 string opts = STRCONV(options.str());
526 return opts.substr(0, opts.size() - 2);
530 string const InsetGraphics::prepareFile(Buffer const * buf) const
532 // LaTeX can cope if the graphics file doesn't exist, so just return the
534 string const orig_file = params().filename;
535 string orig_file_with_path =
536 MakeAbsPath(orig_file, buf->filePath());
537 lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
538 << orig_file << "\n\twith path: "
539 << orig_file_with_path << endl;
541 if (!IsFileReadable(orig_file_with_path))
544 bool const zipped = zippedFile(orig_file_with_path);
546 // If the file is compressed and we have specified that it
547 // should not be uncompressed, then just return its name and
548 // let LaTeX do the rest!
549 if (zipped && params().noUnzip) {
550 lyxerr[Debug::GRAPHICS]
551 << "\tpass zipped file to LaTeX but with full path.\n";
552 // LaTeX needs an absolue path, otherwise the
553 // coresponding *.eps.bb file isn't found
554 return orig_file_with_path;
557 // Ascertain whether the file has changed.
558 unsigned long const new_checksum = cache_->loader.checksum();
559 bool const file_has_changed = cache_->checksum != new_checksum;
560 if (file_has_changed)
561 cache_->checksum = new_checksum;
563 // temp_file will contain the file for LaTeX to act on if, for example,
564 // we move it to a temp dir or uncompress it.
565 string temp_file(orig_file);
568 // Uncompress the file if necessary.
569 // If it has been uncompressed in a previous call to
570 // prepareFile, do nothing.
571 temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
572 lyxerr[Debug::GRAPHICS]
573 << "\ttemp_file: " << temp_file << endl;
574 if (file_has_changed || !IsFileReadable(temp_file)) {
575 bool const success = lyx::copy(orig_file_with_path,
577 lyxerr[Debug::GRAPHICS]
578 << "\tCopying zipped file from "
579 << orig_file_with_path << " to " << temp_file
580 << (success ? " succeeded\n" : " failed\n");
582 lyxerr[Debug::GRAPHICS]
583 << "\tzipped file " << temp_file
584 << " exists! Maybe no tempdir ...\n";
585 orig_file_with_path = unzipFile(temp_file);
586 lyxerr[Debug::GRAPHICS]
587 << "\tunzipped to " << orig_file_with_path << endl;
590 string const from = getExtFromContents(orig_file_with_path);
591 string const to = findTargetFormat(from);
592 lyxerr[Debug::GRAPHICS]
593 << "\t we have: from " << from << " to " << to << '\n';
595 if (from == to && !lyxrc.use_tempdir)
596 // No conversion is needed. LaTeX can handle the
597 // graphic file as is.
598 // This is true even if the orig_file is compressed.
599 return RemoveExtension(orig_file_with_path);
601 // We're going to be running the exported buffer through the LaTeX
602 // compiler, so must ensure that LaTeX can cope with the graphics
605 // Perform all these manipulations on a temporary file if possible.
606 // If we are not using a temp dir, then temp_file contains the
608 // to allow files with the same name in different dirs
609 // we manipulate the original file "any.dir/file.ext"
610 // to "any_dir_file.ext"! changing the dots in the
611 // dirname is important for the use of ChangeExtension
612 lyxerr[Debug::GRAPHICS]
613 << "\tthe orig file is: " << orig_file_with_path << endl;
615 if (lyxrc.use_tempdir) {
616 string const ext_tmp = GetExtension(orig_file_with_path);
619 ChangeExtension(orig_file_with_path, string()), "/", "_");
620 // without dots and again with ext
621 temp_file = ChangeExtension(
622 subst(temp_file, ".", "_"), ext_tmp);
623 // now we have any_dir_file.ext
624 temp_file = MakeAbsPath(temp_file, buf->tmppath);
625 lyxerr[Debug::GRAPHICS]
626 << "\tchanged to: " << temp_file << endl;
628 // if the file doen't exists, copy it into the tempdir
629 if (file_has_changed || !IsFileReadable(temp_file)) {
630 bool const success = lyx::copy(orig_file_with_path, temp_file);
631 lyxerr[Debug::GRAPHICS]
632 << "\tcopying from " << orig_file_with_path << " to "
634 << (success ? " succeeded\n" : " failed\n");
636 Alert::alert(_("Cannot copy file"), orig_file_with_path,
643 // No conversion is needed. LaTeX can handle the
644 // graphic file as is.
645 return RemoveExtension(temp_file);
648 string const outfile_base = RemoveExtension(temp_file);
649 lyxerr[Debug::GRAPHICS]
650 << "\tThe original file is " << orig_file << "\n"
651 << "\tA copy has been made and convert is to be called with:\n"
652 << "\tfile to convert = " << temp_file << '\n'
653 << "\toutfile_base = " << outfile_base << '\n'
654 << "\t from " << from << " to " << to << '\n';
656 // if no special converter defined, than we take the default one
657 // from ImageMagic: convert from:inname.from to:outname.to
658 if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
659 string const command =
660 LibFileSearch("scripts", "convertDefault.sh") +
661 ' ' + from + ':' + temp_file + ' ' +
662 to + ':' + outfile_base + '.' + to;
663 lyxerr[Debug::GRAPHICS]
664 << "No converter defined! I use convertDefault.sh:\n\t"
667 one.startscript(Systemcall::Wait, command);
668 if (!IsFileReadable(ChangeExtension(outfile_base, to)))
669 Alert::alert(_("Cannot convert Image (not existing file?)"),
670 boost::io::str(boost::format(_("No information for converting from %1$s to %2$s"))
674 return RemoveExtension(temp_file);
678 int InsetGraphics::latex(Buffer const *buf, ostream & os,
679 bool /*fragile*/, bool/*fs*/) const
681 // If there is no file specified or not existing,
682 // just output a message about it in the latex output.
683 lyxerr[Debug::GRAPHICS]
684 << "insetgraphics::latex: Filename = "
685 << params().filename << endl;
687 // A missing (e)ps-extension is no problem for LaTeX, so
688 // we have to test three different cases
689 string const file_(MakeAbsPath(params().filename, buf->filePath()));
690 bool const file_exists =
692 (IsFileReadable(file_) || // original
693 IsFileReadable(file_ + ".eps") || // original.eps
694 IsFileReadable(file_ + ".ps")); // original.ps
695 string const message = file_exists ?
696 string() : string("bb = 0 0 200 100, draft, type=eps");
697 // if !message.empty() than there was no existing file
698 // "filename(.(e)ps)" found. In this case LaTeX
699 // draws only a rectangle with the above bb and the
700 // not found filename in it.
701 lyxerr[Debug::GRAPHICS]
702 << "\tMessage = \"" << message << '\"' << endl;
704 // These variables collect all the latex code that should be before and
705 // after the actual includegraphics command.
708 // Do we want subcaptions?
709 if (params().subcaption) {
710 before += "\\subfigure[" + params().subcaptionText + "]{";
713 // We never use the starred form, we use the "clip" option instead.
714 before += "\\includegraphics";
716 // Write the options if there are any.
717 string const opts = createLatexOptions();
718 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
720 if (!opts.empty() && !message.empty())
721 before += ("[%\n" + opts + ',' + message + ']');
722 else if (!opts.empty() || !message.empty())
723 before += ("[%\n" + opts + message + ']');
725 lyxerr[Debug::GRAPHICS]
726 << "\tBefore = " << before
727 << "\n\tafter = " << after << endl;
730 // "nice" means that the buffer is exported to LaTeX format but not
731 // run through the LaTeX compiler.
733 os << before <<'{' << params().filename << '}' << after;
737 // Make the filename relative to the lyx file
738 // and remove the extension so the LaTeX will use whatever is
739 // appropriate (when there are several versions in different formats)
740 string const latex_str = message.empty() ?
741 (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
742 (before + '{' + params().filename + " not found!}" + after);
745 // Return how many newlines we issued.
747 int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
753 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
755 // No graphics in ascii output. Possible to use gifscii to convert
756 // images to ascii approximation.
757 // 1. Convert file to ascii using gifscii
758 // 2. Read ascii output file and add it to the output stream.
759 // at least we send the filename
761 << boost::format(_("Graphic file: %1$s")) % params().filename
767 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
769 // No graphics in LinuxDoc output. Should check how/what to add.
774 // For explanation on inserting graphics into DocBook checkout:
775 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
776 // See also the docbook guide at http://www.docbook.org/
777 int InsetGraphics::docbook(Buffer const *, ostream & os,
778 bool /*mixcont*/) const
780 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
781 // need to switch to MediaObject. However, for now this is sufficient and
783 os << "<graphic fileref=\"&" << graphic_label << ";\">";
788 void InsetGraphics::validate(LaTeXFeatures & features) const
790 // If we have no image, we should not require anything.
791 if (params().filename.empty())
794 features.includeFile(graphic_label, RemoveExtension(params().filename));
796 features.require("graphicx");
798 if (params().subcaption)
799 features.require("subfigure");
803 void InsetGraphics::statusChanged()
805 if (cache_->view.get())
806 cache_->view.get()->updateInset(this, false);
810 bool InsetGraphics::setParams(InsetGraphicsParams const & p,
811 string const & filepath)
813 // If nothing is changed, just return and say so.
814 if (params() == p && !p.filename.empty()) {
818 // Copy the new parameters.
821 // Update the inset with the new parameters.
822 cache_->update(MakeAbsPath(params().filename, filepath));
824 // We have changed data, report it.
829 InsetGraphicsParams const & InsetGraphics::params() const
835 Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
837 return new InsetGraphics(*this, buffer.filePath(), same_id);