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.
55 #include "insets/insetgraphics.h"
56 #include "insets/insetgraphicsParams.h"
58 #include "graphics/GraphicsLoader.h"
59 #include "graphics/GraphicsImage.h"
60 #include "graphics/GraphicsParams.h"
64 #include "BufferView.h"
65 #include "converter.h"
68 #include "funcrequest.h"
70 #include "LaTeXFeatures.h"
76 #include "frontends/lyx_gui.h"
77 #include "frontends/Alert.h"
78 #include "frontends/Dialogs.h"
79 #include "frontends/font_metrics.h"
80 #include "frontends/LyXView.h"
81 #include "frontends/Painter.h"
83 #include "support/LAssert.h"
84 #include "support/filetools.h"
85 #include "support/lyxalgo.h" // lyx::count
86 #include "support/lyxlib.h" // float_equal
87 #include "support/path.h"
88 #include "support/tostr.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 "support/BoostFormat.h"
97 #include <algorithm> // For the std::max
99 extern string system_tempdir;
101 extern bool pdf_mode;
109 ///////////////////////////////////////////////////////////////////////////
110 int const VersionNumber = 1;
111 ///////////////////////////////////////////////////////////////////////////
113 // This function is a utility function
114 // ... that should be with ChangeExtension ...
116 string const RemoveExtension(string const & filename)
118 return ChangeExtension(filename, string());
122 string const uniqueID()
124 static unsigned int seed = 1000;
125 return "graph" + tostr(++seed);
129 string findTargetFormat(string const & suffix)
132 // Are we creating a PDF or a PS file?
133 // (Should actually mean, are we using latex or pdflatex).
135 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
136 if (contains(suffix, "ps") || suffix == "pdf")
138 if (suffix == "jpg") // pdflatex can use jpeg
140 return "png"; // and also png
142 // If it's postscript, we always do eps.
143 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
144 if (suffix != "ps") // any other than ps
145 return "eps"; // is changed to eps
146 return suffix; // let ps untouched
152 struct InsetGraphics::Cache : boost::signals::trackable
155 Cache(InsetGraphics &);
157 void update(string const & file_with_path);
164 unsigned long checksum;
166 boost::weak_ptr<BufferView> view;
170 InsetGraphics & parent_;
174 InsetGraphics::Cache::Cache(InsetGraphics & p)
175 : old_ascent(0), checksum(0), parent_(p)
177 loader.connect(boost::bind(&InsetGraphics::statusChanged, &parent_));
181 void InsetGraphics::Cache::update(string const & file_with_path)
183 lyx::Assert(!file_with_path.empty());
185 string const path = OnlyPath(file_with_path);
186 loader.reset(file_with_path, parent_.params().as_grfxParams(path));
190 InsetGraphics::InsetGraphics()
191 : graphic_label(uniqueID()),
192 cache_(new Cache(*this))
196 InsetGraphics::InsetGraphics(InsetGraphics const & ig,
197 string const & filepath,
199 : Inset(ig, same_id),
200 graphic_label(uniqueID()),
201 cache_(new Cache(*this))
203 setParams(ig.params(), filepath);
207 Inset * InsetGraphics::clone(Buffer const & buffer, bool same_id) const
209 return new InsetGraphics(*this, buffer.filePath(), same_id);
213 InsetGraphics::~InsetGraphics()
215 InsetGraphicsMailer mailer(*this);
220 dispatch_result InsetGraphics::localDispatch(FuncRequest const & cmd)
222 switch (cmd.action) {
223 case LFUN_INSET_MODIFY: {
224 InsetGraphicsParams p;
225 InsetGraphicsMailer::string2params(cmd.argument, p);
226 if (!p.filename.empty()) {
227 string const filepath = cmd.view()->buffer()->filePath();
228 setParams(p, filepath);
229 cmd.view()->updateInset(this);
234 case LFUN_INSET_DIALOG_UPDATE:
235 InsetGraphicsMailer(*this).updateDialog(cmd.view());
238 case LFUN_INSET_EDIT:
239 case LFUN_MOUSE_RELEASE:
240 InsetGraphicsMailer(*this).showDialog(cmd.view());
244 return Inset::localDispatch(cmd);
249 string const InsetGraphics::statusMessage() const
251 using namespace grfx;
253 switch (cache_->loader.status()) {
255 return _("Not shown.");
257 return _("Loading...");
259 return _("Converting to loadable format...");
261 return _("Loaded into memory. Must now generate pixmap.");
263 return _("Scaling etc...");
265 return _("Ready to display");
267 return _("No file found!");
268 case ErrorConverting:
269 return _("Error converting to loadable format");
271 return _("Error loading file into memory");
272 case ErrorGeneratingPixmap:
273 return _("Error generating the pixmap");
275 return _("No image");
281 bool InsetGraphics::imageIsDrawable() const
283 if (!cache_->loader.image() || cache_->loader.status() != grfx::Ready)
286 return cache_->loader.image()->isDrawable();
290 int InsetGraphics::ascent(BufferView *, LyXFont const &) const
292 cache_->old_ascent = 50;
293 if (imageIsDrawable())
294 cache_->old_ascent = cache_->loader.image()->getHeight();
295 return cache_->old_ascent;
299 int InsetGraphics::descent(BufferView *, LyXFont const &) const
305 int InsetGraphics::width(BufferView *, LyXFont const & font) const
307 if (imageIsDrawable())
308 return cache_->loader.image()->getWidth() + 2 * TEXT_TO_INSET_OFFSET;
312 LyXFont msgFont(font);
313 msgFont.setFamily(LyXFont::SANS_FAMILY);
315 string const justname = OnlyFilename (params().filename);
316 if (!justname.empty()) {
317 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
318 font_width = font_metrics::width(justname, msgFont);
321 string const msg = statusMessage();
323 msgFont.setSize(LyXFont::SIZE_TINY);
324 int const msg_width = font_metrics::width(msg, msgFont);
325 font_width = std::max(font_width, msg_width);
328 return std::max(50, font_width + 15);
332 BufferView * InsetGraphics::view() const
334 return cache_->view.lock().get();
338 void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
339 int baseline, float & x) const
341 // MakeAbsPath returns params().filename unchanged if it absolute
343 string const file_with_path =
344 MakeAbsPath(params().filename, bv->buffer()->filePath());
346 // A 'paste' operation creates a new inset with the correct filepath,
347 // but then the 'old' inset stored in the 'copy' operation is actually
348 // added to the buffer.
349 // Thus, we should ensure that the filepath is correct.
350 if (file_with_path != cache_->loader.filename())
351 cache_->update(file_with_path);
353 cache_->view = bv->owner()->view();
354 int oasc = cache_->old_ascent;
356 int ldescent = descent(bv, font);
357 int lascent = ascent(bv, font);
358 int lwidth = width(bv, font);
360 // we may have changed while someone other was drawing us so better
361 // to not draw anything as we surely call to redraw ourself soon.
362 // This is not a nice thing to do and should be fixed properly somehow.
363 // But I still don't know the best way to go. So let's do this like this
364 // for now (Jug 20020311)
368 // Make sure now that x is updated upon exit from this routine
372 grfx::Params const & gparams = params().as_grfxParams();
374 if (gparams.display != grfx::NoDisplay &&
375 cache_->loader.status() == grfx::WaitingToLoad)
376 cache_->loader.startLoading();
378 if (!cache_->loader.monitoring())
379 cache_->loader.startMonitoring();
381 // This will draw the graphics. If the graphics has not been loaded yet,
382 // we draw just a rectangle.
383 Painter & paint = bv->painter();
385 if (imageIsDrawable()) {
386 paint.image(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
387 lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent,
388 *cache_->loader.image());
392 paint.rectangle(old_x + TEXT_TO_INSET_OFFSET, baseline - lascent,
393 lwidth - 2 * TEXT_TO_INSET_OFFSET, lascent + ldescent);
395 // Print the file name.
396 LyXFont msgFont(font);
397 msgFont.setFamily(LyXFont::SANS_FAMILY);
398 string const justname = OnlyFilename (params().filename);
399 if (!justname.empty()) {
400 msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
401 paint.text(old_x + TEXT_TO_INSET_OFFSET + 6,
402 baseline - font_metrics::maxAscent(msgFont) - 4,
406 // Print the message.
407 string const msg = statusMessage();
409 msgFont.setSize(LyXFont::SIZE_TINY);
410 paint.text(old_x + TEXT_TO_INSET_OFFSET + 6, baseline - 4, msg, msgFont);
416 Inset::EDITABLE InsetGraphics::editable() const
422 void InsetGraphics::write(Buffer const *, ostream & os) const
429 void InsetGraphics::read(Buffer const * buf, LyXLex & lex)
431 string const token = lex.getString();
433 if (token == "Graphics")
434 readInsetGraphics(lex);
436 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!\n";
438 cache_->update(MakeAbsPath(params().filename, buf->filePath()));
442 void InsetGraphics::readInsetGraphics(LyXLex & lex)
444 bool finished = false;
446 while (lex.isOK() && !finished) {
449 string const token = lex.getString();
450 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
455 } else if (token == "\\end_inset") {
457 } else if (token == "FormatVersion") {
459 int version = lex.getInteger();
460 if (version > VersionNumber)
462 << "This document was created with a newer Graphics widget"
463 ", You should use a newer version of LyX to read this"
466 // TODO: Possibly open up a dialog?
469 if (! params_.Read(lex, token))
470 lyxerr << "Unknown token, " << token << ", skipping."
477 string const InsetGraphics::createLatexOptions() const
479 // Calculate the options part of the command, we must do it to a string
480 // stream since we might have a trailing comma that we would like to remove
481 // before writing it to the output stream.
482 ostringstream options;
483 if (!params().bb.empty())
484 options << " bb=" << rtrim(params().bb) << ",\n";
486 options << " draft,\n";
488 options << " clip,\n";
489 if (!lyx::float_equal(params().scale, 0.0, 0.05)) {
490 if (!lyx::float_equal(params().scale, 100.0, 0.05))
491 options << " scale=" << params().scale / 100.0
494 if (!params().width.zero())
495 options << " width=" << params().width.asLatexString() << ",\n";
496 if (!params().height.zero())
497 options << " height=" << params().height.asLatexString() << ",\n";
498 if (params().keepAspectRatio)
499 options << " keepaspectratio,\n";
502 // Make sure rotation angle is not very close to zero;
503 // a float can be effectively zero but not exactly zero.
504 if (!lyx::float_equal(params().rotateAngle, 0, 0.001)) {
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"))
518 if (!params().special.empty())
519 options << params().special << ",\n";
521 string opts = STRCONV(options.str());
523 return opts.substr(0, opts.size() - 2);
527 string const InsetGraphics::prepareFile(Buffer const * buf) const
529 // LaTeX can cope if the graphics file doesn't exist, so just return the
531 string const orig_file = params().filename;
532 string orig_file_with_path =
533 MakeAbsPath(orig_file, buf->filePath());
534 lyxerr[Debug::GRAPHICS] << "[InsetGraphics::prepareFile] orig_file = "
535 << orig_file << "\n\twith path: "
536 << orig_file_with_path << endl;
538 if (!IsFileReadable(orig_file_with_path))
541 bool const zipped = zippedFile(orig_file_with_path);
543 // If the file is compressed and we have specified that it
544 // should not be uncompressed, then just return its name and
545 // let LaTeX do the rest!
546 if (zipped && params().noUnzip) {
547 lyxerr[Debug::GRAPHICS]
548 << "\tpass zipped file to LaTeX but with full path.\n";
549 // LaTeX needs an absolue path, otherwise the
550 // coresponding *.eps.bb file isn't found
551 return orig_file_with_path;
554 // Ascertain whether the file has changed.
555 unsigned long const new_checksum = cache_->loader.checksum();
556 bool const file_has_changed = cache_->checksum != new_checksum;
557 if (file_has_changed)
558 cache_->checksum = new_checksum;
560 // temp_file will contain the file for LaTeX to act on if, for example,
561 // we move it to a temp dir or uncompress it.
562 string temp_file = orig_file;
565 // Uncompress the file if necessary.
566 // If it has been uncompressed in a previous call to
567 // prepareFile, do nothing.
568 temp_file = MakeAbsPath(OnlyFilename(temp_file), buf->tmppath);
569 lyxerr[Debug::GRAPHICS]
570 << "\ttemp_file: " << temp_file << endl;
571 if (file_has_changed || !IsFileReadable(temp_file)) {
572 bool const success = lyx::copy(orig_file_with_path,
574 lyxerr[Debug::GRAPHICS]
575 << "\tCopying zipped file from "
576 << orig_file_with_path << " to " << temp_file
577 << (success ? " succeeded\n" : " failed\n");
579 lyxerr[Debug::GRAPHICS]
580 << "\tzipped file " << temp_file
581 << " exists! Maybe no tempdir ...\n";
582 orig_file_with_path = unzipFile(temp_file);
583 lyxerr[Debug::GRAPHICS]
584 << "\tunzipped to " << orig_file_with_path << endl;
587 string const from = getExtFromContents(orig_file_with_path);
588 string const to = findTargetFormat(from);
589 lyxerr[Debug::GRAPHICS]
590 << "\t we have: from " << from << " to " << to << '\n';
592 if (from == to && !lyxrc.use_tempdir) {
593 // No conversion is needed. LaTeX can handle the
594 // graphic file as is.
595 // This is true even if the orig_file is compressed.
596 if (formats.getFormat(to)->extension() == GetExtension(orig_file))
597 return RemoveExtension(orig_file_with_path);
598 return 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");
637 boost::format fmt(_("Could not copy the file\n%1$s\ninto the temporary directory."));
638 fmt % orig_file_with_path;
639 string str = fmt.str();
641 string str = _("Could not copy the file\n");
642 str += orig_file_with_path;
643 str += _("\ninto the temporary directory.");
645 Alert::error(_("Graphics display failed"), str);
651 // No conversion is needed. LaTeX can handle the
652 // graphic file as is.
653 if (formats.getFormat(to)->extension() == GetExtension(orig_file))
654 return RemoveExtension(temp_file);
659 string const outfile_base = RemoveExtension(temp_file);
660 lyxerr[Debug::GRAPHICS]
661 << "\tThe original file is " << orig_file << "\n"
662 << "\tA copy has been made and convert is to be called with:\n"
663 << "\tfile to convert = " << temp_file << '\n'
664 << "\toutfile_base = " << outfile_base << '\n'
665 << "\t from " << from << " to " << to << '\n';
667 // if no special converter defined, than we take the default one
668 // from ImageMagic: convert from:inname.from to:outname.to
669 if (!converters.convert(buf, temp_file, outfile_base, from, to)) {
670 string const command =
671 LibFileSearch("scripts", "convertDefault.sh") +
672 ' ' + from + ':' + temp_file + ' ' +
673 to + ':' + outfile_base + '.' + to;
674 lyxerr[Debug::GRAPHICS]
675 << "No converter defined! I use convertDefault.sh:\n\t"
678 one.startscript(Systemcall::Wait, command);
679 if (!IsFileReadable(ChangeExtension(outfile_base, to))) {
681 boost::format fmt(_("No information for converting %1$s format files to %1$s.\n"
682 "Try defining a convertor in the preferences."));
684 string str = fmt.str();
686 string str = _("No information for converting ");
687 str += from + _(" format files to ") + to;
688 str += _(".\nTry defining a convertor in the preferences.");
690 Alert::error(_("Could not convert image"), str);
694 return RemoveExtension(temp_file);
698 int InsetGraphics::latex(Buffer const * buf, ostream & os,
699 bool /*fragile*/, bool/*fs*/) const
701 // If there is no file specified or not existing,
702 // just output a message about it in the latex output.
703 lyxerr[Debug::GRAPHICS]
704 << "insetgraphics::latex: Filename = "
705 << params().filename << endl;
707 // A missing (e)ps-extension is no problem for LaTeX, so
708 // we have to test three different cases
709 string const file_ = MakeAbsPath(params().filename, buf->filePath());
710 bool const file_exists =
712 (IsFileReadable(file_) || // original
713 IsFileReadable(file_ + ".eps") || // original.eps
714 IsFileReadable(file_ + ".ps")); // original.ps
715 string const message = file_exists ?
716 string() : string("bb = 0 0 200 100, draft, type=eps");
717 // if !message.empty() than there was no existing file
718 // "filename(.(e)ps)" found. In this case LaTeX
719 // draws only a rectangle with the above bb and the
720 // not found filename in it.
721 lyxerr[Debug::GRAPHICS]
722 << "\tMessage = \"" << message << '\"' << endl;
724 // These variables collect all the latex code that should be before and
725 // after the actual includegraphics command.
728 // Do we want subcaptions?
729 if (params().subcaption) {
730 before += "\\subfigure[" + params().subcaptionText + "]{";
733 // We never use the starred form, we use the "clip" option instead.
734 before += "\\includegraphics";
736 // Write the options if there are any.
737 string const opts = createLatexOptions();
738 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
740 if (!opts.empty() && !message.empty())
741 before += ("[%\n" + opts + ',' + message + ']');
742 else if (!opts.empty() || !message.empty())
743 before += ("[%\n" + opts + message + ']');
745 lyxerr[Debug::GRAPHICS]
746 << "\tBefore = " << before
747 << "\n\tafter = " << after << endl;
750 // "nice" means that the buffer is exported to LaTeX format but not
751 // run through the LaTeX compiler.
753 os << before <<'{' << params().filename << '}' << after;
757 // Make the filename relative to the lyx file
758 // and remove the extension so the LaTeX will use whatever is
759 // appropriate (when there are several versions in different formats)
760 string const latex_str = message.empty() ?
761 (before + '{' + os::external_path(prepareFile(buf)) + '}' + after) :
762 (before + '{' + params().filename + " not found!}" + after);
765 // Return how many newlines we issued.
766 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
770 int InsetGraphics::ascii(Buffer const *, ostream & os, int) const
772 // No graphics in ascii output. Possible to use gifscii to convert
773 // images to ascii approximation.
774 // 1. Convert file to ascii using gifscii
775 // 2. Read ascii output file and add it to the output stream.
776 // at least we send the filename
777 os << '<' << bformat(_("Graphics file: %1$s"), params().filename) << ">\n";
782 int InsetGraphics::linuxdoc(Buffer const *, ostream &) const
784 // No graphics in LinuxDoc output. Should check how/what to add.
789 // For explanation on inserting graphics into DocBook checkout:
790 // http://linuxdoc.org/LDP/LDP-Author-Guide/inserting-pictures.html
791 // See also the docbook guide at http://www.docbook.org/
792 int InsetGraphics::docbook(Buffer const *, ostream & os,
793 bool /*mixcont*/) const
795 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
796 // need to switch to MediaObject. However, for now this is sufficient and
798 os << "<graphic fileref=\"&" << graphic_label << ";\">";
803 void InsetGraphics::validate(LaTeXFeatures & features) const
805 // If we have no image, we should not require anything.
806 if (params().filename.empty())
809 features.includeFile(graphic_label, RemoveExtension(params().filename));
811 features.require("graphicx");
813 if (params().subcaption)
814 features.require("subfigure");
818 void InsetGraphics::statusChanged()
820 if (!cache_->view.expired())
821 cache_->view.lock()->updateInset(this);
825 bool InsetGraphics::setParams(InsetGraphicsParams const & p,
826 string const & filepath)
828 // If nothing is changed, just return and say so.
829 if (params() == p && !p.filename.empty())
832 // Copy the new parameters.
835 // Update the inset with the new parameters.
836 cache_->update(MakeAbsPath(params().filename, filepath));
838 // We have changed data, report it.
843 InsetGraphicsParams const & InsetGraphics::params() const
849 string const InsetGraphicsMailer::name_("graphics");
851 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
856 string const InsetGraphicsMailer::inset2string() const
858 return params2string(inset_.params());
862 void InsetGraphicsMailer::string2params(string const & in,
863 InsetGraphicsParams & params)
865 params = InsetGraphicsParams();
870 istringstream data(STRCONV(in));
876 string const token = lex.getString();
883 inset.readInsetGraphics(lex);
884 params = inset.params();
890 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params)
893 data << name_ << ' ';
895 data << "\\end_inset\n";
896 return STRCONV(data.str());