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 * The filename is kept in the lyx file in a relative way, so as to allow
33 * moving the document file and its images with no problem.
37 * Postscript output means EPS figures.
39 * PDF output is best done with PDF figures if it's a direct conversion
40 * or PNG figures otherwise.
52 #include "insets/insetgraphics.h"
53 #include "insets/render_graphic.h"
56 #include "BufferView.h"
57 #include "converter.h"
60 #include "dispatchresult.h"
63 #include "funcrequest.h"
65 #include "LaTeXFeatures.h"
68 #include "metricsinfo.h"
69 #include "outputparams.h"
71 #include "frontends/Alert.h"
72 #include "frontends/LyXView.h"
74 #include "support/filetools.h"
75 #include "support/lyxalgo.h" // lyx::count
76 #include "support/lyxlib.h" // float_equal
77 #include "support/os.h"
78 #include "support/systemcall.h"
79 #include "support/tostr.h"
80 #include "support/std_sstream.h"
82 #include <boost/bind.hpp>
83 #include <boost/tuple/tuple.hpp>
85 namespace support = lyx::support;
86 using lyx::support::AbsolutePath;
87 using lyx::support::bformat;
88 using lyx::support::ChangeExtension;
89 using lyx::support::compare_timestamps;
90 using lyx::support::contains;
91 using lyx::support::FileName;
92 using lyx::support::float_equal;
93 using lyx::support::GetExtension;
94 using lyx::support::getExtFromContents;
95 using lyx::support::IsFileReadable;
96 using lyx::support::LibFileSearch;
97 using lyx::support::OnlyFilename;
98 using lyx::support::rtrim;
99 using lyx::support::subst;
100 using lyx::support::Systemcall;
101 using lyx::support::unzipFile;
102 using lyx::support::unzippedFileName;
104 namespace os = lyx::support::os;
109 using std::istringstream;
111 using std::ostringstream;
116 // This function is a utility function
117 // ... that should be with ChangeExtension ...
119 string const RemoveExtension(string const & filename)
121 return ChangeExtension(filename, string());
125 string const uniqueID()
127 static unsigned int seed = 1000;
128 return "graph" + tostr(++seed);
132 string findTargetFormat(string const & suffix, OutputParams const & runparams)
134 // Are we using latex or pdflatex).
135 if (runparams.flavor == OutputParams::PDFLATEX) {
136 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
137 if (contains(suffix, "ps") || suffix == "pdf")
139 if (suffix == "jpg") // pdflatex can use jpeg
141 return "png"; // and also png
143 // If it's postscript, we always do eps.
144 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode" << endl;
145 if (suffix != "ps") // any other than ps
146 return "eps"; // is changed to eps
147 return suffix; // let ps untouched
153 InsetGraphics::InsetGraphics()
154 : graphic_label(uniqueID()),
155 graphic_(new RenderGraphic(this))
159 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
161 boost::signals::trackable(),
162 graphic_label(uniqueID()),
163 graphic_(new RenderGraphic(*ig.graphic_, this))
165 setParams(ig.params());
169 auto_ptr<InsetBase> InsetGraphics::clone() const
171 return auto_ptr<InsetBase>(new InsetGraphics(*this));
175 InsetGraphics::~InsetGraphics()
177 InsetGraphicsMailer(*this).hideDialog();
181 void InsetGraphics::priv_dispatch(LCursor & cur, FuncRequest & cmd)
183 switch (cmd.action) {
184 case LFUN_GRAPHICS_EDIT: {
185 Buffer const & buffer = *cur.bv().buffer();
186 InsetGraphicsParams p;
187 InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
188 editGraphics(p, buffer);
192 case LFUN_INSET_MODIFY: {
193 Buffer const & buffer = cur.buffer();
194 InsetGraphicsParams p;
195 InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
196 if (!p.filename.empty()) {
203 case LFUN_INSET_DIALOG_UPDATE:
204 InsetGraphicsMailer(*this).updateDialog(&cur.bv());
207 case LFUN_MOUSE_RELEASE:
208 InsetGraphicsMailer(*this).showDialog(&cur.bv());
212 InsetOld::priv_dispatch(cur, cmd);
218 void InsetGraphics::edit(LCursor & cur, bool)
220 InsetGraphicsMailer(*this).showDialog(&cur.bv());
224 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
226 graphic_->metrics(mi, dim);
231 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
233 setPosCache(pi, x, y);
234 graphic_->draw(pi, x, y);
238 InsetOld::EDITABLE InsetGraphics::editable() const
244 void InsetGraphics::write(Buffer const & buf, ostream & os) const
247 params().Write(os, buf.filePath());
251 void InsetGraphics::read(Buffer const & buf, LyXLex & lex)
253 string const token = lex.getString();
255 if (token == "Graphics")
256 readInsetGraphics(lex, buf.filePath());
258 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!" << endl;
260 graphic_->update(params().as_grfxParams());
264 void InsetGraphics::readInsetGraphics(LyXLex & lex, string const & bufpath)
266 bool finished = false;
268 while (lex.isOK() && !finished) {
271 string const token = lex.getString();
272 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
277 } else if (token == "\\end_inset") {
280 if (!params_.Read(lex, token, bufpath))
281 lyxerr << "Unknown token, " << token << ", skipping."
288 string const InsetGraphics::createLatexOptions() const
290 // Calculate the options part of the command, we must do it to a string
291 // stream since we might have a trailing comma that we would like to remove
292 // before writing it to the output stream.
293 ostringstream options;
294 if (!params().bb.empty())
295 options << " bb=" << rtrim(params().bb) << ",\n";
297 options << " draft,\n";
299 options << " clip,\n";
300 if (!float_equal(params().scale, 0.0, 0.05)) {
301 if (!float_equal(params().scale, 100.0, 0.05))
302 options << " scale=" << params().scale / 100.0
305 if (!params().width.zero())
306 options << " width=" << params().width.asLatexString() << ",\n";
307 if (!params().height.zero())
308 options << " height=" << params().height.asLatexString() << ",\n";
309 if (params().keepAspectRatio)
310 options << " keepaspectratio,\n";
313 // Make sure rotation angle is not very close to zero;
314 // a float can be effectively zero but not exactly zero.
315 if (!float_equal(params().rotateAngle, 0, 0.001)) {
316 options << " angle=" << params().rotateAngle << ",\n";
317 if (!params().rotateOrigin.empty()) {
318 options << " origin=" << params().rotateOrigin[0];
319 if (contains(params().rotateOrigin,"Top"))
321 else if (contains(params().rotateOrigin,"Bottom"))
323 else if (contains(params().rotateOrigin,"Baseline"))
329 if (!params().special.empty())
330 options << params().special << ",\n";
332 string opts = options.str();
334 return opts.substr(0, opts.size() - 2);
348 std::pair<CopyStatus, string> const
349 copyFileIfNeeded(string const & file_in, string const & file_out)
351 BOOST_ASSERT(AbsolutePath(file_in));
352 BOOST_ASSERT(AbsolutePath(file_out));
354 unsigned long const checksum_in = support::sum(file_in);
355 unsigned long const checksum_out = support::sum(file_out);
357 if (checksum_in == checksum_out)
359 return std::make_pair(IDENTICAL_CONTENTS, file_out);
361 bool const success = support::copy(file_in, file_out);
363 lyxerr[Debug::GRAPHICS]
364 << support::bformat(_("Could not copy the file\n%1$s\n"
365 "into the temporary directory."),
370 CopyStatus status = success ? SUCCESS : FAILURE;
371 return std::make_pair(status, file_out);
375 std::pair<CopyStatus, string> const
376 copyToDirIfNeeded(string const & file_in, string const & dir, bool zipped)
378 using support::rtrim;
380 BOOST_ASSERT(AbsolutePath(file_in));
382 string const only_path = support::OnlyPath(file_in);
383 if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/"))
384 return std::make_pair(IDENTICAL_PATHS, file_in);
386 string mangled = FileName(file_in).mangledFilename();
388 // We need to change _eps.gz to .eps.gz. The mangled name is
389 // still unique because of the counter in mangledFilename().
390 // We can't just call mangledFilename() with the zip
391 // extension removed, because base.eps and base.eps.gz may
392 // have different content but would get the same mangled
393 // name in this case.
394 string const base = RemoveExtension(unzippedFileName(file_in));
395 string::size_type const ext_len = file_in.length() - base.length();
396 mangled[mangled.length() - ext_len] = '.';
398 string const file_out = support::MakeAbsPath(mangled, dir);
400 return copyFileIfNeeded(file_in, file_out);
404 string const stripExtension(string const & file)
406 // Remove the extension so the LaTeX will use whatever
407 // is appropriate (when there are several versions in
408 // different formats)
409 // This works only if the filename contains no dots besides
410 // the just removed one. We can fool here by replacing all
411 // dots with a macro whose definition is just a dot ;-)
412 return subst(RemoveExtension(file), ".", "\\lyxdot ");
416 string const stripExtensionIfPossible(string const & file, string const & to)
418 // No conversion is needed. LaTeX can handle the graphic file as is.
419 // This is true even if the orig_file is compressed.
420 string const to_format = formats.getFormat(to)->extension();
421 string const file_format = GetExtension(file);
422 // for latex .ps == .eps
423 if (to_format == file_format ||
424 (to_format == "eps" && file_format == "ps") ||
425 (to_format == "ps" && file_format == "eps"))
426 return stripExtension(file);
433 string const InsetGraphics::prepareFile(Buffer const & buf,
434 OutputParams const & runparams) const
436 // We assume that the file exists (the caller checks this)
437 string const orig_file = params().filename.absFilename();
438 string const rel_file = params().filename.relFilename(buf.filePath());
440 // If the file is compressed and we have specified that it
441 // should not be uncompressed, then just return its name and
442 // let LaTeX do the rest!
443 bool const zipped = params().filename.isZipped();
445 // temp_file will contain the file for LaTeX to act on if, for example,
446 // we move it to a temp dir or uncompress it.
447 string temp_file = orig_file;
449 // The master buffer. This is useful when there are multiple levels
451 Buffer const * m_buffer = buf.getMasterBuffer();
453 // We place all temporary files in the master buffer's temp dir.
454 // This is possible because we use mangled file names.
455 // This is necessary for DVI export.
456 string const temp_path = m_buffer->temppath();
459 boost::tie(status, temp_file) =
460 copyToDirIfNeeded(orig_file, temp_path, zipped);
462 if (status == FAILURE)
465 // a relative filename should be relative to the master
467 // "nice" means that the buffer is exported to LaTeX format but not
468 // run through the LaTeX compiler.
469 string const output_file = os::external_path(runparams.nice ?
470 params().filename.outputFilename(m_buffer->filePath()) :
471 OnlyFilename(temp_file));
472 string const source_file = runparams.nice ? orig_file : temp_file;
475 if (params().noUnzip) {
476 // We don't know whether latex can actually handle
477 // this file, but we can't check, because that would
478 // mean to unzip the file and thereby making the
479 // noUnzip parameter meaningless.
480 lyxerr[Debug::GRAPHICS]
481 << "\tpass zipped file to LaTeX.\n";
483 string const bb_orig_file = ChangeExtension(orig_file, "bb");
484 if (runparams.nice) {
485 runparams.exportdata->addExternalFile("latex",
487 ChangeExtension(output_file, "bb"));
489 // LaTeX needs the bounding box file in the
491 string bb_file = ChangeExtension(temp_file, "bb");
492 boost::tie(status, bb_file) =
493 copyFileIfNeeded(bb_orig_file, bb_file);
494 if (status == FAILURE)
496 runparams.exportdata->addExternalFile("latex",
499 runparams.exportdata->addExternalFile("latex",
500 source_file, output_file);
501 runparams.exportdata->addExternalFile("dvi",
502 source_file, output_file);
503 // We can't strip the extension, because we don't know
504 // the unzipped file format
508 string const unzipped_temp_file = unzippedFileName(temp_file);
509 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
510 // temp_file has been unzipped already and
511 // orig_file has not changed in the meantime.
512 temp_file = unzipped_temp_file;
513 lyxerr[Debug::GRAPHICS]
514 << "\twas already unzipped to " << temp_file
517 // unzipped_temp_file does not exist or is too old
518 temp_file = unzipFile(temp_file);
519 lyxerr[Debug::GRAPHICS]
520 << "\tunzipped to " << temp_file << endl;
524 string const from = getExtFromContents(temp_file);
525 string const to = findTargetFormat(from, runparams);
526 lyxerr[Debug::GRAPHICS]
527 << "\t we have: from " << from << " to " << to << '\n';
529 // We're going to be running the exported buffer through the LaTeX
530 // compiler, so must ensure that LaTeX can cope with the graphics
533 lyxerr[Debug::GRAPHICS]
534 << "\tthe orig file is: " << orig_file << endl;
537 // The extension of temp_file might be != to!
538 runparams.exportdata->addExternalFile("latex", source_file,
540 runparams.exportdata->addExternalFile("dvi", source_file,
542 return stripExtensionIfPossible(output_file, to);
545 string const to_file = ChangeExtension(temp_file, to);
546 string const output_to_file = ChangeExtension(output_file, to);
548 // Do we need to perform the conversion?
549 // Yes if to_file does not exist or if temp_file is newer than to_file
550 if (compare_timestamps(temp_file, to_file) < 0) {
551 lyxerr[Debug::GRAPHICS]
552 << bformat(_("No conversion of %1$s is needed after all"),
555 runparams.exportdata->addExternalFile("latex", to_file,
557 runparams.exportdata->addExternalFile("dvi", to_file,
559 return stripExtension(output_file);
562 lyxerr[Debug::GRAPHICS]
563 << "\tThe original file is " << orig_file << "\n"
564 << "\tA copy has been made and convert is to be called with:\n"
565 << "\tfile to convert = " << temp_file << '\n'
566 << "\t from " << from << " to " << to << '\n';
568 // if no special converter defined, then we take the default one
569 // from ImageMagic: convert from:inname.from to:outname.to
570 if (!converters.convert(&buf, temp_file, temp_file, from, to)) {
571 string const command =
572 "sh " + LibFileSearch("scripts", "convertDefault.sh") +
573 ' ' + from + ':' + temp_file + ' ' +
575 lyxerr[Debug::GRAPHICS]
576 << "No converter defined! I use convertDefault.sh:\n\t"
579 one.startscript(Systemcall::Wait, command);
580 if (IsFileReadable(to_file)) {
581 runparams.exportdata->addExternalFile("latex",
582 to_file, output_to_file);
583 runparams.exportdata->addExternalFile("dvi",
584 to_file, output_to_file);
586 string str = bformat(_("No information for converting %1$s "
587 "format files to %2$s.\n"
588 "Try defining a convertor in the preferences."), from, to);
589 Alert::error(_("Could not convert image"), str);
593 return stripExtension(output_file);
597 int InsetGraphics::latex(Buffer const & buf, ostream & os,
598 OutputParams const & runparams) const
600 // If there is no file specified or not existing,
601 // just output a message about it in the latex output.
602 lyxerr[Debug::GRAPHICS]
603 << "insetgraphics::latex: Filename = "
604 << params().filename.absFilename() << endl;
606 string const relative_file =
607 params().filename.relFilename(buf.filePath());
609 string const file_ = params().filename.absFilename();
610 bool const file_exists = !file_.empty() && IsFileReadable(file_);
611 string const message = file_exists ?
612 string() : string("bb = 0 0 200 100, draft, type=eps");
613 // if !message.empty() then there was no existing file
614 // "filename" found. In this case LaTeX
615 // draws only a rectangle with the above bb and the
616 // not found filename in it.
617 lyxerr[Debug::GRAPHICS]
618 << "\tMessage = \"" << message << '\"' << endl;
620 // These variables collect all the latex code that should be before and
621 // after the actual includegraphics command.
624 // Do we want subcaptions?
625 if (params().subcaption) {
626 before += "\\subfigure[" + params().subcaptionText + "]{";
629 // We never use the starred form, we use the "clip" option instead.
630 before += "\\includegraphics";
632 // Write the options if there are any.
633 string const opts = createLatexOptions();
634 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
636 if (!opts.empty() && !message.empty())
637 before += ("[%\n" + opts + ',' + message + ']');
638 else if (!opts.empty() || !message.empty())
639 before += ("[%\n" + opts + message + ']');
641 lyxerr[Debug::GRAPHICS]
642 << "\tBefore = " << before
643 << "\n\tafter = " << after << endl;
646 string latex_str = before + '{';
648 // Convert the file if necessary.
649 // Remove the extension so the LaTeX will use whatever
650 // is appropriate (when there are several versions in
651 // different formats)
652 latex_str += prepareFile(buf, runparams);
654 latex_str += relative_file + " not found!";
656 latex_str += '}' + after;
659 lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
660 << latex_str << endl;
661 // Return how many newlines we issued.
662 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
666 int InsetGraphics::plaintext(Buffer const &, ostream & os,
667 OutputParams const &) const
669 // No graphics in ascii output. Possible to use gifscii to convert
670 // images to ascii approximation.
671 // 1. Convert file to ascii using gifscii
672 // 2. Read ascii output file and add it to the output stream.
673 // at least we send the filename
674 os << '<' << bformat(_("Graphics file: %1$s"),
675 params().filename.absFilename()) << ">\n";
680 int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
681 OutputParams const & runparams) const
683 string const file_name = runparams.nice ?
684 params().filename.relFilename(buf.filePath()):
685 params().filename.absFilename();
687 runparams.exportdata->addExternalFile("linuxdoc",
688 params().filename.absFilename());
689 os << "<eps file=\"" << file_name << "\">\n";
690 os << "<img src=\"" << file_name << "\">";
695 // For explanation on inserting graphics into DocBook checkout:
696 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
697 // See also the docbook guide at http://www.docbook.org/
698 int InsetGraphics::docbook(Buffer const &, ostream & os,
699 OutputParams const & runparams) const
701 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
702 // need to switch to MediaObject. However, for now this is sufficient and
704 runparams.exportdata->addExternalFile("docbook",
705 params().filename.absFilename());
706 runparams.exportdata->addExternalFile("docbook-xml",
707 params().filename.absFilename());
708 os << "<graphic fileref=\"&" << graphic_label << ";\">";
713 void InsetGraphics::validate(LaTeXFeatures & features) const
715 // If we have no image, we should not require anything.
716 if (params().filename.empty())
719 features.includeFile(graphic_label,
720 RemoveExtension(params().filename.absFilename()));
722 features.require("graphicx");
724 if (features.nice()) {
725 Buffer const * m_buffer = features.buffer().getMasterBuffer();
727 params().filename.outputFilename(m_buffer->filePath());
728 basename = RemoveExtension(basename);
729 if(params().filename.isZipped())
730 basename = RemoveExtension(basename);
731 if (contains(basename, "."))
732 features.require("lyxdot");
735 if (params().subcaption)
736 features.require("subfigure");
740 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
742 // If nothing is changed, just return and say so.
743 if (params() == p && !p.filename.empty())
746 // Copy the new parameters.
749 // Update the display using the new parameters.
750 graphic_->update(params().as_grfxParams());
752 // We have changed data, report it.
757 InsetGraphicsParams const & InsetGraphics::params() const
763 void InsetGraphics::editGraphics(InsetGraphicsParams const & p, Buffer const & buffer) const
765 string const file_with_path = p.filename.absFilename();
766 formats.edit(buffer, file_with_path, getExtFromContents(file_with_path));
770 string const InsetGraphicsMailer::name_("graphics");
772 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
777 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
779 return params2string(inset_.params(), buffer);
783 void InsetGraphicsMailer::string2params(string const & in,
784 Buffer const & buffer,
785 InsetGraphicsParams & params)
787 params = InsetGraphicsParams();
791 istringstream data(in);
797 if (!lex || name != name_)
798 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
801 inset.readInsetGraphics(lex, buffer.filePath());
802 params = inset.params();
807 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
808 Buffer const & buffer)
811 data << name_ << ' ';
812 params.Write(data, buffer.filePath());
813 data << "\\end_inset\n";