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/render_graphic.h"
59 #include "BufferView.h"
60 #include "converter.h"
62 #include "dispatchresult.h"
64 #include "funcrequest.h"
66 #include "LaTeXFeatures.h"
70 #include "metricsinfo.h"
71 #include "outputparams.h"
73 #include "frontends/Alert.h"
74 #include "frontends/LyXView.h"
76 #include "support/filetools.h"
77 #include "support/lyxalgo.h" // lyx::count
78 #include "support/lyxlib.h" // float_equal
79 #include "support/os.h"
80 #include "support/systemcall.h"
81 #include "support/tostr.h"
83 #include <boost/bind.hpp>
84 #include <boost/tuple/tuple.hpp>
86 #include "support/std_sstream.h"
88 namespace support = lyx::support;
89 using lyx::support::AbsolutePath;
90 using lyx::support::bformat;
91 using lyx::support::ChangeExtension;
92 using lyx::support::contains;
93 using lyx::support::FileName;
94 using lyx::support::float_equal;
95 using lyx::support::GetExtension;
96 using lyx::support::getExtFromContents;
97 using lyx::support::IsFileReadable;
98 using lyx::support::LibFileSearch;
99 using lyx::support::rtrim;
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 ///////////////////////////////////////////////////////////////////////////
117 int const VersionNumber = 1;
118 ///////////////////////////////////////////////////////////////////////////
120 // This function is a utility function
121 // ... that should be with ChangeExtension ...
123 string const RemoveExtension(string const & filename)
125 return ChangeExtension(filename, string());
129 string const uniqueID()
131 static unsigned int seed = 1000;
132 return "graph" + tostr(++seed);
136 string findTargetFormat(string const & suffix, OutputParams const & runparams)
138 // Are we using latex or pdflatex).
139 if (runparams.flavor == OutputParams::PDFLATEX) {
140 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
141 if (contains(suffix, "ps") || suffix == "pdf")
143 if (suffix == "jpg") // pdflatex can use jpeg
145 return "png"; // and also png
147 // If it's postscript, we always do eps.
148 lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode" << endl;
149 if (suffix != "ps") // any other than ps
150 return "eps"; // is changed to eps
151 return suffix; // let ps untouched
157 InsetGraphics::InsetGraphics()
158 : graphic_label(uniqueID()),
159 graphic_(new RenderGraphic)
161 graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this));
165 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
167 boost::signals::trackable(),
168 graphic_label(uniqueID()),
169 graphic_(new RenderGraphic(*ig.graphic_))
171 graphic_->connect(boost::bind(&InsetGraphics::statusChanged, this));
172 setParams(ig.params());
176 auto_ptr<InsetBase> InsetGraphics::clone() const
178 return auto_ptr<InsetBase>(new InsetGraphics(*this));
182 InsetGraphics::~InsetGraphics()
184 InsetGraphicsMailer(*this).hideDialog();
188 void InsetGraphics::statusChanged() const
190 LyX::cref().updateInset(this);
195 InsetGraphics::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
197 switch (cmd.action) {
198 case LFUN_INSET_MODIFY: {
199 Buffer const & buffer = *cmd.view()->buffer();
200 InsetGraphicsParams p;
201 InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
202 if (!p.filename.empty()) {
204 cmd.view()->update();
206 return DispatchResult(true, true);
209 case LFUN_INSET_DIALOG_UPDATE:
210 InsetGraphicsMailer(*this).updateDialog(cmd.view());
211 return DispatchResult(true, true);
213 case LFUN_MOUSE_RELEASE:
214 InsetGraphicsMailer(*this).showDialog(cmd.view());
215 return DispatchResult(true, true);
218 return DispatchResult(false);
223 void InsetGraphics::edit(BufferView * bv, bool)
225 InsetGraphicsMailer(*this).showDialog(bv);
229 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
231 graphic_->metrics(mi, dim);
236 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
240 graphic_->draw(pi, x, y);
244 InsetOld::EDITABLE InsetGraphics::editable() const
250 void InsetGraphics::write(Buffer const & buf, ostream & os) const
253 params().Write(os, buf.filePath());
257 void InsetGraphics::read(Buffer const & buf, LyXLex & lex)
259 string const token = lex.getString();
261 if (token == "Graphics")
262 readInsetGraphics(lex, buf.filePath());
264 lyxerr[Debug::GRAPHICS] << "Not a Graphics inset!" << endl;
266 graphic_->update(params().as_grfxParams());
270 void InsetGraphics::readInsetGraphics(LyXLex & lex, string const & bufpath)
272 bool finished = false;
274 while (lex.isOK() && !finished) {
277 string const token = lex.getString();
278 lyxerr[Debug::GRAPHICS] << "Token: '" << token << '\''
283 } else if (token == "\\end_inset") {
285 } else if (token == "FormatVersion") {
287 int version = lex.getInteger();
288 if (version > VersionNumber)
290 << "This document was created with a newer Graphics widget"
291 ", You should use a newer version of LyX to read this"
294 // TODO: Possibly open up a dialog?
297 if (!params_.Read(lex, token, bufpath))
298 lyxerr << "Unknown token, " << token << ", skipping."
305 string const InsetGraphics::createLatexOptions() const
307 // Calculate the options part of the command, we must do it to a string
308 // stream since we might have a trailing comma that we would like to remove
309 // before writing it to the output stream.
310 ostringstream options;
311 if (!params().bb.empty())
312 options << " bb=" << rtrim(params().bb) << ",\n";
314 options << " draft,\n";
316 options << " clip,\n";
317 if (!float_equal(params().scale, 0.0, 0.05)) {
318 if (!float_equal(params().scale, 100.0, 0.05))
319 options << " scale=" << params().scale / 100.0
322 if (!params().width.zero())
323 options << " width=" << params().width.asLatexString() << ",\n";
324 if (!params().height.zero())
325 options << " height=" << params().height.asLatexString() << ",\n";
326 if (params().keepAspectRatio)
327 options << " keepaspectratio,\n";
330 // Make sure rotation angle is not very close to zero;
331 // a float can be effectively zero but not exactly zero.
332 if (!float_equal(params().rotateAngle, 0, 0.001)) {
333 options << " angle=" << params().rotateAngle << ",\n";
334 if (!params().rotateOrigin.empty()) {
335 options << " origin=" << params().rotateOrigin[0];
336 if (contains(params().rotateOrigin,"Top"))
338 else if (contains(params().rotateOrigin,"Bottom"))
340 else if (contains(params().rotateOrigin,"Baseline"))
346 if (!params().special.empty())
347 options << params().special << ",\n";
349 string opts = options.str();
351 return opts.substr(0, opts.size() - 2);
365 std::pair<CopyStatus, string> const
366 copyToDirIfNeeded(string const & file_in, string const & dir)
368 using support::rtrim;
370 BOOST_ASSERT(AbsolutePath(file_in));
372 string const only_path = support::OnlyPath(file_in);
373 if (rtrim(support::OnlyPath(file_in) , "/") == rtrim(dir, "/"))
374 return std::make_pair(IDENTICAL_PATHS, file_in);
377 if (support::zippedFile(file_in)) {
378 string const ext = GetExtension(file_in);
379 string const unzipped = support::unzippedFileName(file_in);
380 mangled = FileName(unzipped).mangledFilename();
381 mangled += "." + ext;
383 mangled = FileName(file_in).mangledFilename();
385 string const file_out = support::MakeAbsPath(mangled, dir);
387 unsigned long const checksum_in = support::sum(file_in);
388 unsigned long const checksum_out = support::sum(file_out);
390 if (checksum_in == checksum_out)
392 return std::make_pair(IDENTICAL_CONTENTS, file_out);
394 bool const success = support::copy(file_in, file_out);
396 lyxerr[Debug::GRAPHICS]
397 << support::bformat(_("Could not copy the file\n%1$s\n"
398 "into the temporary directory."),
403 CopyStatus status = success ? SUCCESS : FAILURE;
404 return std::make_pair(status, file_out);
408 string const stripExtensionIfPossible(string const & file, string const & to)
410 // No conversion is needed. LaTeX can handle the graphic file as is.
411 // This is true even if the orig_file is compressed.
412 if (formats.getFormat(to)->extension() == GetExtension(file))
413 return RemoveExtension(file);
420 string const InsetGraphics::prepareFile(Buffer const & buf,
421 OutputParams const & runparams) const
423 string orig_file = params().filename.absFilename();
424 string const rel_file = params().filename.relFilename(buf.filePath());
426 // LaTeX can cope if the graphics file doesn't exist, so just return the
428 if (!IsFileReadable(orig_file)) {
429 lyxerr[Debug::GRAPHICS]
430 << "InsetGraphics::prepareFile\n"
431 << "No file '" << orig_file << "' can be found!" << endl;
435 // If the file is compressed and we have specified that it
436 // should not be uncompressed, then just return its name and
437 // let LaTeX do the rest!
438 bool const zipped = params().filename.isZipped();
440 if (zipped && params().noUnzip) {
441 lyxerr[Debug::GRAPHICS]
442 << "\tpass zipped file to LaTeX but with full path.\n";
443 // LaTeX needs an absolute path, otherwise the
444 // coresponding *.eps.bb file isn't found
448 // temp_file will contain the file for LaTeX to act on if, for example,
449 // we move it to a temp dir or uncompress it.
450 string temp_file = orig_file;
454 boost::tie(status, temp_file) =
455 copyToDirIfNeeded(orig_file, buf.temppath());
457 if (status == FAILURE)
460 orig_file = unzippedFileName(temp_file);
461 if (!IsFileReadable(orig_file)) {
462 unzipFile(temp_file);
463 lyxerr[Debug::GRAPHICS]
464 << "\tunzipped to " << orig_file << endl;
468 string const from = getExtFromContents(orig_file);
469 string const to = findTargetFormat(from, runparams);
470 lyxerr[Debug::GRAPHICS]
471 << "\t we have: from " << from << " to " << to << '\n';
473 if (from == to && !lyxrc.use_tempdir)
474 return stripExtensionIfPossible(orig_file, to);
476 // We're going to be running the exported buffer through the LaTeX
477 // compiler, so must ensure that LaTeX can cope with the graphics
480 lyxerr[Debug::GRAPHICS]
481 << "\tthe orig file is: " << orig_file << endl;
483 bool conversion_needed = true;
484 if (lyxrc.use_tempdir) {
486 boost::tie(status, temp_file) =
487 copyToDirIfNeeded(orig_file, buf.temppath());
489 if (status == FAILURE)
491 else if (status == IDENTICAL_CONTENTS)
492 conversion_needed = false;
496 return stripExtensionIfPossible(temp_file, to);
498 string const to_file_base = RemoveExtension(temp_file);
499 string const to_file = ChangeExtension(to_file_base, to);
501 // Do we need to perform the conversion?
502 // Yes if to_file does not exist or if temp_file is newer than to_file
503 if (!conversion_needed ||
504 support::compare_timestamps(temp_file, to_file) < 0) {
505 lyxerr[Debug::GRAPHICS]
506 << bformat(_("No conversion of %1$s is needed after all"),
512 lyxerr[Debug::GRAPHICS]
513 << "\tThe original file is " << orig_file << "\n"
514 << "\tA copy has been made and convert is to be called with:\n"
515 << "\tfile to convert = " << temp_file << '\n'
516 << "\tto_file_base = " << to_file_base << '\n'
517 << "\t from " << from << " to " << to << '\n';
519 // if no special converter defined, than we take the default one
520 // from ImageMagic: convert from:inname.from to:outname.to
521 if (!converters.convert(&buf, temp_file, to_file_base, from, to)) {
522 string const command =
523 "sh " + LibFileSearch("scripts", "convertDefault.sh") +
524 ' ' + from + ':' + temp_file + ' ' +
525 to + ':' + to_file_base + '.' + to;
526 lyxerr[Debug::GRAPHICS]
527 << "No converter defined! I use convertDefault.sh:\n\t"
530 one.startscript(Systemcall::Wait, command);
531 if (!IsFileReadable(ChangeExtension(to_file_base, to))) {
532 string str = bformat(_("No information for converting %1$s "
533 "format files to %2$s.\n"
534 "Try defining a convertor in the preferences."), from, to);
535 Alert::error(_("Could not convert image"), str);
543 int InsetGraphics::latex(Buffer const & buf, ostream & os,
544 OutputParams const & runparams) const
546 // If there is no file specified or not existing,
547 // just output a message about it in the latex output.
548 lyxerr[Debug::GRAPHICS]
549 << "insetgraphics::latex: Filename = "
550 << params().filename.absFilename() << endl;
552 string const relative_file =
553 params().filename.relFilename(buf.filePath());
555 // A missing (e)ps-extension is no problem for LaTeX, so
556 // we have to test three different cases
557 #warning uh, but can our cache handle it ? no.
558 string const file_ = params().filename.absFilename();
559 bool const file_exists =
561 (IsFileReadable(file_) || // original
562 IsFileReadable(file_ + ".eps") || // original.eps
563 IsFileReadable(file_ + ".ps")); // original.ps
564 string const message = file_exists ?
565 string() : string("bb = 0 0 200 100, draft, type=eps");
566 // if !message.empty() than there was no existing file
567 // "filename(.(e)ps)" found. In this case LaTeX
568 // draws only a rectangle with the above bb and the
569 // not found filename in it.
570 lyxerr[Debug::GRAPHICS]
571 << "\tMessage = \"" << message << '\"' << endl;
573 // These variables collect all the latex code that should be before and
574 // after the actual includegraphics command.
577 // Do we want subcaptions?
578 if (params().subcaption) {
579 before += "\\subfigure[" + params().subcaptionText + "]{";
582 // We never use the starred form, we use the "clip" option instead.
583 before += "\\includegraphics";
585 // Write the options if there are any.
586 string const opts = createLatexOptions();
587 lyxerr[Debug::GRAPHICS] << "\tOpts = " << opts << endl;
589 if (!opts.empty() && !message.empty())
590 before += ("[%\n" + opts + ',' + message + ']');
591 else if (!opts.empty() || !message.empty())
592 before += ("[%\n" + opts + message + ']');
594 lyxerr[Debug::GRAPHICS]
595 << "\tBefore = " << before
596 << "\n\tafter = " << after << endl;
599 // "nice" means that the buffer is exported to LaTeX format but not
600 // run through the LaTeX compiler.
601 if (runparams.nice) {
602 os << before <<'{' << relative_file << '}' << after;
606 // Make the filename relative to the lyx file
607 // and remove the extension so the LaTeX will use whatever is
608 // appropriate (when there are several versions in different formats)
609 string const latex_str = message.empty() ?
610 (before + '{' + os::external_path(prepareFile(buf, runparams)) + '}' + after) :
611 (before + '{' + relative_file + " not found!}" + after);
614 lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
615 << latex_str << endl;
616 // Return how many newlines we issued.
617 return int(lyx::count(latex_str.begin(), latex_str.end(),'\n') + 1);
621 int InsetGraphics::plaintext(Buffer const &, ostream & os,
622 OutputParams const &) const
624 // No graphics in ascii output. Possible to use gifscii to convert
625 // images to ascii approximation.
626 // 1. Convert file to ascii using gifscii
627 // 2. Read ascii output file and add it to the output stream.
628 // at least we send the filename
629 os << '<' << bformat(_("Graphics file: %1$s"),
630 params().filename.absFilename()) << ">\n";
635 int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
636 OutputParams const &) const
638 string const file_name = buf.niceFile() ?
639 params().filename.relFilename(buf.filePath()):
640 params().filename.absFilename();
642 os << "<eps file=\"" << file_name << "\">\n";
643 os << "<img src=\"" << file_name << "\">";
648 // For explanation on inserting graphics into DocBook checkout:
649 // http://en.tldp.org/LDP/LDP-Author-Guide/inserting-pictures.html
650 // See also the docbook guide at http://www.docbook.org/
651 int InsetGraphics::docbook(Buffer const &, ostream & os,
652 OutputParams const &) const
654 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
655 // need to switch to MediaObject. However, for now this is sufficient and
657 os << "<graphic fileref=\"&" << graphic_label << ";\">";
662 void InsetGraphics::validate(LaTeXFeatures & features) const
664 // If we have no image, we should not require anything.
665 if (params().filename.empty())
668 features.includeFile(graphic_label,
669 RemoveExtension(params().filename.absFilename()));
671 features.require("graphicx");
673 if (params().subcaption)
674 features.require("subfigure");
678 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
680 // If nothing is changed, just return and say so.
681 if (params() == p && !p.filename.empty())
684 // Copy the new parameters.
687 // Update the display using the new parameters.
688 graphic_->update(params().as_grfxParams());
690 // We have changed data, report it.
695 InsetGraphicsParams const & InsetGraphics::params() const
701 string const InsetGraphicsMailer::name_("graphics");
703 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
708 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
710 return params2string(inset_.params(), buffer);
714 void InsetGraphicsMailer::string2params(string const & in,
715 Buffer const & buffer,
716 InsetGraphicsParams & params)
718 params = InsetGraphicsParams();
723 istringstream data(in);
729 string const token = lex.getString();
736 inset.readInsetGraphics(lex, buffer.filePath());
737 params = inset.params();
743 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
744 Buffer const & buffer)
747 data << name_ << ' ';
748 params.Write(data, buffer.filePath());
749 data << "\\end_inset\n";