2 * \file InsetGraphics.cpp
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 * When loading, if the image is not found in the expected place, try
19 to find it in the clipart, or in the same directory with the image.
20 * The image choosing dialog could show thumbnails of the image formats
21 it knows of, thus selection based on the image instead of based on
23 * Add support for the 'picins' package.
24 * Add support for the 'picinpar' package.
29 * The filename is kept in the lyx file in a relative way, so as to allow
30 * moving the document file and its images with no problem.
34 * Postscript output means EPS figures.
36 * PDF output is best done with PDF figures if it's a direct conversion
37 * or PNG figures otherwise.
49 #include "insets/InsetGraphics.h"
50 #include "insets/RenderGraphic.h"
53 #include "BufferView.h"
54 #include "Converter.h"
56 #include "DispatchResult.h"
58 #include "ErrorList.h"
61 #include "FuncRequest.h"
62 #include "FuncStatus.h"
63 #include "InsetIterator.h"
64 #include "LaTeXFeatures.h"
67 #include "MetricsInfo.h"
69 #include "OutputParams.h"
70 #include "output_xhtml.h"
72 #include "texstream.h"
73 #include "TocBackend.h"
75 #include "frontends/alert.h"
76 #include "frontends/Application.h"
78 #include "graphics/GraphicsCache.h"
79 #include "graphics/GraphicsCacheItem.h"
80 #include "graphics/GraphicsImage.h"
82 #include "support/convert.h"
83 #include "support/debug.h"
84 #include "support/docstream.h"
85 #include "support/ExceptionMessage.h"
86 #include "support/filetools.h"
87 #include "support/gettext.h"
88 #include "support/lyxlib.h"
89 #include "support/lstrings.h"
90 #include "support/os.h"
91 #include "support/qstring_helpers.h"
92 #include "support/Systemcall.h"
101 using namespace lyx::support;
105 namespace Alert = frontend::Alert;
109 /// Find the most suitable image format for images in \p format
110 /// Note that \p format may be unknown (i. e. an empty string)
111 string findTargetFormat(string const & format, OutputParams const & runparams)
113 // Are we latexing to DVI or PDF?
114 if (runparams.flavor == OutputParams::PDFLATEX
115 || runparams.flavor == OutputParams::XETEX
116 || runparams.flavor == OutputParams::LUATEX) {
117 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
118 Format const * const f = theFormats().getFormat(format);
119 // Convert vector graphics to pdf
120 if (f && f->vectorFormat())
122 // pdflatex can use jpeg, png and pdf directly
125 // Convert everything else to png
128 // for HTML, we leave the known formats and otherwise convert to png
129 if (runparams.flavor == OutputParams::HTML) {
130 Format const * const f = theFormats().getFormat(format);
131 // Convert vector graphics to svg
132 if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
134 // Leave the known formats alone
135 if (format == "jpg" || format == "png" || format == "gif")
137 // Convert everything else to png
140 // If it's postscript, we always do eps.
141 LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
143 // any other than ps is changed to eps
150 void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
151 InsetGraphicsParams & params)
153 bool finished = false;
155 while (lex.isOK() && !finished) {
158 string const token = lex.getString();
159 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
164 if (token == "\\end_inset") {
167 if (!params.Read(lex, token, buf, allowOrigin))
168 lyxerr << "Unknown token, "
179 InsetGraphics::InsetGraphics(Buffer * buf)
180 : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
181 graphic_(new RenderGraphic(this))
186 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
188 graphic_label(sgml::uniqueID(from_ascii("graph"))),
189 graphic_(new RenderGraphic(*ig.graphic_, this))
191 setParams(ig.params());
195 Inset * InsetGraphics::clone() const
197 return new InsetGraphics(*this);
201 InsetGraphics::~InsetGraphics()
203 hideDialogs("graphics", this);
208 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
210 switch (cmd.action()) {
211 case LFUN_INSET_EDIT: {
212 InsetGraphicsParams p = params();
213 if (!cmd.argument().empty())
214 string2params(to_utf8(cmd.argument()), buffer(), p);
219 case LFUN_INSET_MODIFY: {
220 if (cmd.getArg(0) != "graphics") {
221 Inset::doDispatch(cur, cmd);
225 InsetGraphicsParams p;
226 string2params(to_utf8(cmd.argument()), buffer(), p);
227 if (p.filename.empty()) {
228 cur.noScreenUpdate();
234 // if the inset is part of a graphics group, all the
235 // other members should be updated too.
236 if (!params_.groupId.empty())
237 graphics::unifyGraphicsGroups(buffer(),
238 to_utf8(cmd.argument()));
242 case LFUN_INSET_DIALOG_UPDATE:
243 cur.bv().updateDialog("graphics", params2string(params(), buffer()));
246 case LFUN_GRAPHICS_RELOAD:
247 params_.filename.refresh();
252 Inset::doDispatch(cur, cmd);
258 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
259 FuncStatus & flag) const
261 switch (cmd.action()) {
262 case LFUN_INSET_MODIFY:
263 if (cmd.getArg(0) != "graphics")
264 return Inset::getStatus(cur, cmd, flag);
266 case LFUN_INSET_EDIT:
267 case LFUN_INSET_DIALOG_UPDATE:
268 case LFUN_GRAPHICS_RELOAD:
269 flag.setEnabled(true);
273 return Inset::getStatus(cur, cmd, flag);
278 bool InsetGraphics::showInsetDialog(BufferView * bv) const
280 bv->showDialog("graphics", params2string(params(), bv->buffer()),
281 const_cast<InsetGraphics *>(this));
287 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
289 graphic_->metrics(mi, dim);
293 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
295 graphic_->draw(pi, x, y);
299 void InsetGraphics::write(ostream & os) const
302 params().Write(os, buffer());
306 void InsetGraphics::read(Lexer & lex)
308 lex.setContext("InsetGraphics::read");
310 readInsetGraphics(lex, buffer(), true, params_);
311 graphic_->update(params().as_grfxParams());
315 void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
320 FileName const file(params().filename.absFileName());
322 // No correction is necessary for a postscript image
323 bool const zipped = theFormats().isZippedFile(file);
324 FileName const unzipped_file = zipped ? unzipFile(file) : file;
325 string const format = theFormats().getFormatFromFile(unzipped_file);
327 unzipped_file.removeFile();
328 if (Formats::isPostScriptFileFormat(format))
331 // Get the actual image dimensions in pixels
334 graphics::Cache & gc = graphics::Cache::get();
335 if (gc.inCache(file)) {
336 graphics::Image const * image = gc.item(file)->image();
338 width = image->width();
339 height = image->height();
342 if (width == 0 || height == 0)
345 // Use extractbb to find the dimensions in the typeset output
347 extractbb.start("extractbb", QStringList() << "-O" << toqstr(file.absFileName()));
348 if (!extractbb.waitForStarted() || !extractbb.waitForFinished()) {
349 LYXERR0("Cannot read output bounding box of " << file);
353 string const result = extractbb.readAll().constData();
354 size_t i = result.find("%%BoundingBox:");
355 if (i == string::npos) {
356 LYXERR0("Cannot find output bounding box of " << file);
360 string const bb = result.substr(i);
361 int out_width = convert<int>(token(bb, ' ', 3));
362 int out_height = convert<int>(token(bb, ' ', 4));
364 // Compute the scaling ratio and correct the bounding box
365 double scalex = out_width / double(width);
366 double scaley = out_height / double(height);
368 bbox.xl.value(scalex * bbox.xl.value());
369 bbox.xr.value(scalex * bbox.xr.value());
370 bbox.yb.value(scaley * bbox.yb.value());
371 bbox.yt.value(scaley * bbox.yt.value());
375 string InsetGraphics::createLatexOptions(bool const ps) const
377 // Calculate the options part of the command, we must do it to a string
378 // stream since we might have a trailing comma that we would like to remove
379 // before writing it to the output stream.
380 ostringstream options;
381 if (!params().bbox.empty()) {
382 graphics::BoundingBox out_bbox = params().bbox;
383 outBoundingBox(out_bbox);
384 string const key = ps ? "bb=" : "viewport=";
385 options << key << out_bbox.xl.asLatexString() << ' '
386 << out_bbox.yb.asLatexString() << ' '
387 << out_bbox.xr.asLatexString() << ' '
388 << out_bbox.yt.asLatexString() << ',';
395 double const scl = convert<double>(params().scale);
396 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
397 if (!float_equal(scl, 100.0, 0.05))
398 size << "scale=" << scl / 100.0 << ',';
400 if (!params().width.zero())
401 size << "width=" << params().width.asLatexString() << ',';
402 if (!params().height.zero())
403 size << "totalheight=" << params().height.asLatexString() << ',';
404 if (params().keepAspectRatio)
405 size << "keepaspectratio,";
407 if (params().scaleBeforeRotation && !size.str().empty())
408 options << size.str();
410 // Make sure rotation angle is not very close to zero;
411 // a float can be effectively zero but not exactly zero.
412 if (!params().rotateAngle.empty()
413 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
414 options << "angle=" << params().rotateAngle << ',';
415 if (!params().rotateOrigin.empty()) {
416 options << "origin=" << params().rotateOrigin[0];
417 if (contains(params().rotateOrigin,"Top"))
419 else if (contains(params().rotateOrigin,"Bottom"))
421 else if (contains(params().rotateOrigin,"Baseline"))
426 if (!params().scaleBeforeRotation && !size.str().empty())
427 options << size.str();
429 if (!params().special.empty())
430 options << params().special << ',';
432 string opts = options.str();
434 if (suffixIs(opts, ','))
435 opts = opts.substr(0, opts.size() - 1);
441 docstring InsetGraphics::toDocbookLength(Length const & len) const
443 odocstringstream result;
444 switch (len.unit()) {
445 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
446 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
448 case Length::PT: // Point = 1/72.27in = 0.351mm
449 result << len.value() * 72 / 72.27 << "pt";
451 case Length::BP: // Big point (72bp = 1in), also PostScript point
452 result << len.value() << "pt";
454 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
455 result << len.value() * 0.376 << "mm";
457 case Length::MM: // Millimeter = 2.845pt
458 result << len.value() << "mm";
460 case Length::PC: // Pica = 12pt = 4.218mm
461 result << len.value() << "pc";
463 case Length::CC: // Cicero = 12dd = 4.531mm
464 result << len.value() * 4.531 << "mm";
466 case Length::CM: // Centimeter = 10mm = 2.371pc
467 result << len.value() << "cm";
469 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
470 result << len.value() << "in";
472 case Length::EX: // Height of a small "x" for the current font.
473 // Obviously we have to compromise here. Any better ratio than 1.5 ?
474 result << len.value() / 1.5 << "em";
476 case Length::EM: // Width of capital "M" in current font.
477 result << len.value() << "em";
479 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
480 result << len.value() * 18 << "em";
482 case Length::PTW: // Percent of TextWidth
483 case Length::PCW: // Percent of ColumnWidth
484 case Length::PPW: // Percent of PageWidth
485 case Length::PLW: // Percent of LineWidth
486 case Length::PTH: // Percent of TextHeight
487 case Length::PPH: // Percent of PaperHeight
488 case Length::BLS: // Percent of BaselineSkip
489 // Sigh, this will go wrong.
490 result << len.value() << "%";
493 result << len.asDocstring();
500 docstring InsetGraphics::createDocBookAttributes() const
502 // Calculate the options part of the command, we must do it to a string
503 // stream since we copied the code from createLatexParams() ;-)
505 // FIXME: av: need to translate spec -> Docbook XSL spec
506 // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
507 // Right now it only works with my version of db2latex :-)
509 odocstringstream options;
510 double const scl = convert<double>(params().scale);
511 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
512 if (!float_equal(scl, 100.0, 0.05))
513 options << " scale=\""
514 << support::iround(scl)
517 if (!params().width.zero()) {
518 options << " width=\"" << toDocbookLength(params().width) << "\" ";
520 if (!params().height.zero()) {
521 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
523 if (params().keepAspectRatio) {
524 // This will be irrelevant unless both width and height are set
525 options << "scalefit=\"1\" ";
530 if (!params().special.empty())
531 options << from_ascii(params().special) << " ";
533 // trailing blanks are ok ...
534 return options.str();
540 enum GraphicsCopyStatus {
548 pair<GraphicsCopyStatus, FileName> const
549 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
551 LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
552 unsigned long const checksum_in = file_in.checksum();
553 unsigned long const checksum_out = file_out.checksum();
555 if (checksum_in == checksum_out)
557 return make_pair(IDENTICAL_CONTENTS, file_out);
559 Mover const & mover = getMover(theFormats().getFormatFromFile(file_in));
560 bool const success = mover.copy(file_in, file_out);
563 LYXERR(Debug::GRAPHICS,
564 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
565 "into the temporary directory."),
566 from_utf8(file_in.absFileName()))));
569 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
570 return make_pair(status, file_out);
574 pair<GraphicsCopyStatus, FileName> const
575 copyToDirIfNeeded(DocFileName const & file, string const & dir)
577 string const file_in = file.absFileName();
578 string const only_path = onlyPath(file_in);
579 if (rtrim(only_path, "/") == rtrim(dir, "/"))
580 return make_pair(IDENTICAL_PATHS, FileName(file_in));
582 string mangled = file.mangledFileName();
583 if (theFormats().isZippedFile(file)) {
584 // We need to change _eps.gz to .eps.gz. The mangled name is
585 // still unique because of the counter in mangledFileName().
586 // We can't just call mangledFileName() with the zip
587 // extension removed, because base.eps and base.eps.gz may
588 // have different content but would get the same mangled
589 // name in this case.
590 // Also take into account that if the name of the zipped file
591 // has no zip extension then the name of the unzipped one is
592 // prefixed by "unzipped_".
593 string const base = removeExtension(file.unzippedFileName());
594 string::size_type const prefix_len =
595 prefixIs(onlyFileName(base), "unzipped_") ? 9 : 0;
596 string::size_type const ext_len =
597 file_in.length() + prefix_len - base.length();
598 mangled[mangled.length() - ext_len] = '.';
600 FileName const file_out(makeAbsPath(mangled, dir));
602 return copyFileIfNeeded(file, file_out);
606 string const stripExtensionIfPossible(string const & file, bool nice)
608 // Remove the extension so the LaTeX compiler will use whatever
609 // is appropriate (when there are several versions in different
611 // Do this only if we are not exporting for internal usage, because
612 // pdflatex prefers png over pdf and it would pick up the png images
613 // that we generate for preview.
614 // This works only if the filename contains no dots besides
615 // the just removed one. We can fool here by replacing all
616 // dots with a macro whose definition is just a dot ;-)
617 // The automatic format selection does not work if the file
619 string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
620 if (!nice || contains(latex_name, '"'))
622 return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
626 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
628 // No conversion is needed. LaTeX can handle the graphic file as is.
629 // This is true even if the orig_file is compressed.
630 string const to_format = theFormats().getFormat(to)->extension();
631 string const file_format = getExtension(file);
632 // for latex .ps == .eps
633 if (to_format == file_format ||
634 (to_format == "eps" && file_format == "ps") ||
635 (to_format == "ps" && file_format == "eps"))
636 return stripExtensionIfPossible(file, nice);
637 return latex_path(file, EXCLUDE_EXTENSION);
643 string InsetGraphics::prepareFile(OutputParams const & runparams) const
645 // The following code depends on non-empty filenames
646 if (params().filename.empty())
649 string const orig_file = params().filename.absFileName();
650 // this is for dryrun and display purposes, do not use latexFilename
651 string const rel_file = params().filename.relFileName(buffer().filePath());
653 // previewing source code, no file copying or file format conversion
654 if (runparams.dryrun)
655 return stripExtensionIfPossible(rel_file, runparams.nice);
657 // The master buffer. This is useful when there are multiple levels
659 Buffer const * masterBuffer = buffer().masterBuffer();
661 // Return the output name if we are inside a comment or the file does
663 // We are not going to change the extension or using the name of the
664 // temporary file, the code is already complicated enough.
665 if (runparams.inComment || !params().filename.isReadableFile())
666 return params().filename.outputFileName(masterBuffer->filePath());
668 // We place all temporary files in the master buffer's temp dir.
669 // This is possible because we use mangled file names.
670 // This is necessary for DVI export.
671 string const temp_path = masterBuffer->temppath();
673 // temp_file will contain the file for LaTeX to act on if, for example,
674 // we move it to a temp dir or uncompress it.
676 GraphicsCopyStatus status;
677 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
679 if (status == FAILURE)
682 // a relative filename should be relative to the master buffer.
683 // "nice" means that the buffer is exported to LaTeX format but not
684 // run through the LaTeX compiler.
685 string output_file = runparams.nice ?
686 params().filename.outputFileName(masterBuffer->filePath()) :
687 onlyFileName(temp_file.absFileName());
689 if (runparams.nice) {
690 if (!isValidLaTeXFileName(output_file)) {
691 frontend::Alert::warning(_("Invalid filename"),
692 _("The following filename will cause troubles "
693 "when running the exported file through LaTeX: ") +
694 from_utf8(output_file));
696 // only show DVI-specific warning when export format is plain latex
697 if (!isValidDVIFileName(output_file)
698 && runparams.flavor == OutputParams::LATEX) {
699 frontend::Alert::warning(_("Problematic filename for DVI"),
700 _("The following filename can cause troubles "
701 "when running the exported file through LaTeX "
702 "and opening the resulting DVI: ") +
703 from_utf8(output_file), true);
707 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
708 // determine the export format
709 string const tex_format = flavor2format(runparams.flavor);
711 if (theFormats().isZippedFile(params().filename)) {
712 FileName const unzipped_temp_file =
713 FileName(unzippedFileName(temp_file.absFileName()));
714 output_file = unzippedFileName(output_file);
715 source_file = FileName(unzippedFileName(source_file.absFileName()));
716 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
717 // temp_file has been unzipped already and
718 // orig_file has not changed in the meantime.
719 temp_file = unzipped_temp_file;
720 LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
722 // unzipped_temp_file does not exist or is too old
723 temp_file = unzipFile(temp_file);
724 LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
728 string const from = theFormats().getFormatFromFile(temp_file);
730 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
732 string const to = findTargetFormat(from, runparams);
733 string const ext = theFormats().extension(to);
734 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
736 // We're going to be running the exported buffer through the LaTeX
737 // compiler, so must ensure that LaTeX can cope with the graphics
740 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
743 // source and destination formats are the same
744 if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
745 // The LaTeX compiler will not be able to determine
746 // the file format from the extension, so we must
748 FileName const new_file =
749 FileName(changeExtension(temp_file.absFileName(), ext));
750 if (temp_file.moveTo(new_file)) {
751 temp_file = new_file;
752 output_file = changeExtension(output_file, ext);
754 FileName(changeExtension(source_file.absFileName(), ext));
756 LYXERR(Debug::GRAPHICS, "Could not rename file `"
757 << temp_file << "' to `" << new_file << "'.");
760 // The extension of temp_file might be != ext!
761 runparams.exportdata->addExternalFile(tex_format, source_file,
763 runparams.exportdata->addExternalFile("dvi", source_file,
765 return stripExtensionIfPossible(output_file, to, runparams.nice);
768 // so the source and destination formats are different
769 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
770 string const output_to_file = changeExtension(output_file, ext);
772 // Do we need to perform the conversion?
773 // Yes if to_file does not exist or if temp_file is newer than to_file
774 if (compare_timestamps(temp_file, to_file) < 0) {
776 LYXERR(Debug::GRAPHICS,
777 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
778 from_utf8(rel_file))));
779 runparams.exportdata->addExternalFile(tex_format, to_file,
781 runparams.exportdata->addExternalFile("dvi", to_file,
783 return stripExtensionIfPossible(output_to_file, runparams.nice);
786 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
787 << "\tA copy has been made and convert is to be called with:\n"
788 << "\tfile to convert = " << temp_file << '\n'
789 << "\t from " << from << " to " << to);
791 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
793 Converters::RetVal const rv =
794 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
796 Converters::try_default | Converters::try_cache);
797 if (rv == Converters::KILLED) {
798 LYXERR0("Graphics preparation killed.");
799 if (buffer().isClone() && buffer().isExporting())
800 throw ConversionException();
801 } else if (rv == Converters::SUCCESS) {
802 runparams.exportdata->addExternalFile(tex_format,
803 to_file, output_to_file);
804 runparams.exportdata->addExternalFile("dvi",
805 to_file, output_to_file);
808 return stripExtensionIfPossible(output_to_file, runparams.nice);
812 void InsetGraphics::latex(otexstream & os,
813 OutputParams const & runparams) const
815 // If there is no file specified or not existing,
816 // just output a message about it in the latex output.
817 LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
818 << params().filename.absFileName());
820 bool const file_exists = !params().filename.empty()
821 && params().filename.isReadableFile();
824 if (params().bbox.empty())
825 message = "bb = 0 0 200 100";
826 if (!params().draft) {
827 if (!message.empty())
831 if (!message.empty())
833 message += "type=eps";
835 // If no existing file "filename" was found LaTeX
836 // draws only a rectangle with the above bb and the
837 // not found filename in it.
838 LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
840 // These variables collect all the latex code that should be before and
841 // after the actual includegraphics command.
845 // Write the options if there are any.
846 bool const ps = runparams.flavor == OutputParams::LATEX
847 || runparams.flavor == OutputParams::DVILUATEX;
848 string const opts = createLatexOptions(ps);
849 LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
851 if (contains(opts, '=') && contains(runparams.active_chars, '=')) {
852 // We have a language that makes = active. Deactivate locally
853 // for keyval option parsing (#2005).
854 before = "\\begingroup\\catcode`\\=12";
855 after = "\\endgroup ";
858 if (runparams.moving_arg)
859 before += "\\protect";
861 // We never use the starred form, we use the "clip" option instead.
862 before += "\\includegraphics";
864 if (!opts.empty() && !message.empty())
865 before += ('[' + opts + ',' + message + ']');
866 else if (!opts.empty() || !message.empty())
867 before += ('[' + opts + message + ']');
869 LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
871 string latex_str = before + '{';
872 // Convert the file if necessary.
873 // Remove the extension so LaTeX will use whatever is appropriate
874 // (when there are several versions in different formats)
875 docstring file_path = from_utf8(prepareFile(runparams));
876 // we can only output characters covered by the current
879 docstring encodable_file_path;
880 for (size_type i = 0 ; i < file_path.size() ; ++i) {
881 char_type c = file_path[i];
883 if (runparams.encoding->encodable(c))
884 encodable_file_path += c;
885 else if (runparams.dryrun) {
886 encodable_file_path += "<" + _("LyX Warning: ")
887 + _("uncodable character") + " '";
888 encodable_file_path += docstring(1, c);
889 encodable_file_path += "'>";
892 } catch (EncodingException & /* e */) {
893 if (runparams.dryrun) {
894 encodable_file_path += "<" + _("LyX Warning: ")
895 + _("uncodable character") + " '";
896 encodable_file_path += docstring(1, c);
897 encodable_file_path += "'>";
902 if (!uncodable.empty() && !runparams.silent) {
903 // issue a warning about omitted characters
904 // FIXME: should be passed to the error dialog
905 frontend::Alert::warning(_("Uncodable character in file path"),
906 bformat(_("The following characters in one of the graphic paths are\n"
907 "not representable in the current encoding and have been omitted: %1$s.\n"
908 "You need to adapt either the encoding or the path."),
911 latex_str += to_utf8(encodable_file_path);
912 latex_str += '}' + after;
914 os << from_utf8(latex_str);
916 LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
920 int InsetGraphics::plaintext(odocstringstream & os,
921 OutputParams const &, size_t) const
923 // No graphics in ascii output. Possible to use gifscii to convert
924 // images to ascii approximation.
925 // 1. Convert file to ascii using gifscii
926 // 2. Read ascii output file and add it to the output stream.
927 // at least we send the filename
929 // FIXME: We have no idea what the encoding of the filename is
931 docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
932 from_utf8(params().filename.absFileName()));
933 os << '<' << str << '>';
935 return 2 + str.size();
939 static int writeImageObject(char const * format, odocstream & os,
940 OutputParams const & runparams, docstring const & graphic_label,
941 docstring const & attributes)
943 if (runparams.flavor != OutputParams::XML)
944 os << "<![ %output.print." << format
947 os <<"<imageobject><imagedata fileref=\"&"
954 if (runparams.flavor == OutputParams::XML)
955 os << " role=\"" << format << "\"/>" ;
957 os << " format=\"" << format << "\">" ;
959 os << "</imageobject>";
961 if (runparams.flavor != OutputParams::XML)
962 os << endl << "]]>" ;
964 return runparams.flavor == OutputParams::XML ? 0 : 2;
968 // For explanation on inserting graphics into DocBook checkout:
969 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
970 // See also the docbook guide at http://www.docbook.org/
971 int InsetGraphics::docbook(odocstream & os,
972 OutputParams const & runparams) const
974 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
975 // need to switch to MediaObject. However, for now this is sufficient and
977 if (runparams.flavor == OutputParams::XML)
978 runparams.exportdata->addExternalFile("docbook-xml",
981 runparams.exportdata->addExternalFile("docbook",
984 os << "<inlinemediaobject>";
987 docstring attributes = createDocBookAttributes();
988 r += writeImageObject("png", os, runparams, graphic_label, attributes);
989 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
990 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
991 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
993 os << "</inlinemediaobject>";
998 string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
1000 // The following code depends on non-empty filenames
1001 if (params().filename.empty())
1004 if (!params().filename.isReadableFile())
1007 // The master buffer. This is useful when there are multiple levels
1009 Buffer const * masterBuffer = buffer().masterBuffer();
1011 // We place all temporary files in the master buffer's temp dir.
1012 // This is possible because we use mangled file names.
1013 // FIXME We may want to put these files in some special temporary
1015 string const temp_path = masterBuffer->temppath();
1017 // Copy to temporary directory.
1019 GraphicsCopyStatus status;
1020 tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
1022 if (status == FAILURE)
1025 string const from = theFormats().getFormatFromFile(temp_file);
1027 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
1031 string const to = findTargetFormat(from, runparams);
1032 string const ext = theFormats().extension(to);
1033 string const orig_file = params().filename.absFileName();
1034 string output_file = onlyFileName(temp_file.absFileName());
1035 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
1036 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
1039 // source and destination formats are the same
1040 runparams.exportdata->addExternalFile("xhtml", temp_file, output_file);
1044 // so the source and destination formats are different
1045 FileName const to_file = FileName(changeExtension(temp_file.absFileName(), ext));
1046 string const output_to_file = changeExtension(output_file, ext);
1048 // Do we need to perform the conversion?
1049 // Yes if to_file does not exist or if temp_file is newer than to_file
1050 if (compare_timestamps(temp_file, to_file) < 0) {
1052 LYXERR(Debug::GRAPHICS,
1053 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
1054 from_utf8(orig_file))));
1055 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
1056 return output_to_file;
1059 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
1060 << "\tA copy has been made and convert is to be called with:\n"
1061 << "\tfile to convert = " << temp_file << '\n'
1062 << "\t from " << from << " to " << to);
1064 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
1066 Converters::RetVal const rv =
1067 theConverters().convert(&buffer(), temp_file, to_file, params().filename,
1068 from, to, el, Converters::try_default | Converters::try_cache);
1069 if (rv == Converters::KILLED) {
1070 if (buffer().isClone() && buffer().isExporting())
1071 throw ConversionException();
1074 if (rv != Converters::SUCCESS)
1076 runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
1077 return output_to_file;
1081 docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
1083 string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
1085 if (output_file.empty() && !op.dryrun) {
1086 LYXERR0("InsetGraphics::xhtml: Unable to prepare file `"
1087 << params().filename << "' for output. File missing?");
1088 string const attr = "src='" + params().filename.absFileName()
1089 + "' alt='image: " + output_file + "'";
1090 xs << html::CompTag("img", attr);
1095 // We aren't doing anything with the crop and rotate parameters, and it would
1096 // really be better to do width and height conversion, rather than to output
1097 // these parameters here.
1099 bool const havewidth = !params().width.zero();
1100 bool const haveheight = !params().height.zero();
1101 if (havewidth || haveheight) {
1103 imgstyle += "width:" + params().width.asHTMLString() + ";";
1105 imgstyle += " height:" + params().height.asHTMLString() + ";";
1106 } else if (params().scale != "100") {
1107 // Note that this will not have the same effect as in LaTeX export:
1108 // There, the image will be scaled from its original size. Here, the
1109 // percentage will be interpreted by the browser, and the image will
1110 // be scaled to a percentage of the window size.
1111 imgstyle = "width:" + params().scale + "%;";
1113 if (!imgstyle.empty())
1114 imgstyle = "style='" + imgstyle + "' ";
1116 string const attr = imgstyle + "src='" + output_file + "' alt='image: "
1117 + output_file + "'";
1118 xs << html::CompTag("img", attr);
1123 void InsetGraphics::validate(LaTeXFeatures & features) const
1125 // If we have no image, we should not require anything.
1126 if (params().filename.empty())
1129 features.includeFile(graphic_label,
1130 removeExtension(params().filename.absFileName()));
1132 features.require("graphicx");
1134 if (features.runparams().nice) {
1135 string const rel_file = params().filename.onlyFileNameWithoutExt();
1136 if (contains(rel_file, "."))
1137 features.require("lyxdot");
1139 if (features.inDeletedInset()) {
1140 features.require("tikz");
1141 features.require("ct-tikz-object-sout");
1146 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
1148 // If nothing is changed, just return and say so.
1149 if (params() == p && !p.filename.empty())
1152 // Copy the new parameters.
1155 // Update the display using the new parameters.
1156 graphic_->update(params().as_grfxParams());
1158 // We have changed data, report it.
1163 InsetGraphicsParams const & InsetGraphics::params() const
1169 void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const
1171 theFormats().edit(buffer(), p.filename,
1172 theFormats().getFormatFromFile(p.filename));
1176 void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active,
1177 UpdateType, TocBackend & backend) const
1180 docstring const str = from_utf8(params_.filename.onlyFileName());
1181 TocBuilder & b = backend.builder("graphics");
1182 b.pushItem(cpit, str, output_active);
1187 string InsetGraphics::contextMenuName() const
1189 return "context-graphics";
1193 void InsetGraphics::string2params(string const & in, Buffer const & buffer,
1194 InsetGraphicsParams & params)
1199 istringstream data(in);
1201 lex.setStream(data);
1202 lex.setContext("InsetGraphics::string2params");
1204 params = InsetGraphicsParams();
1205 readInsetGraphics(lex, buffer, false, params);
1209 string InsetGraphics::params2string(InsetGraphicsParams const & params,
1210 Buffer const & buffer)
1213 data << "graphics" << ' ';
1214 params.Write(data, buffer);
1215 data << "\\end_inset\n";
1220 docstring InsetGraphics::toolTip(BufferView const &, int, int) const
1222 return from_utf8(params().filename.onlyFileName());
1225 namespace graphics {
1227 void getGraphicsGroups(Buffer const & b, set<string> & ids)
1229 Inset & inset = b.inset();
1230 InsetIterator it = inset_iterator_begin(inset);
1231 InsetIterator const end = inset_iterator_end(inset);
1232 for (; it != end; ++it) {
1233 InsetGraphics const * ins = it->asInsetGraphics();
1236 InsetGraphicsParams const & inspar = ins->getParams();
1237 if (!inspar.groupId.empty())
1238 ids.insert(inspar.groupId);
1243 int countGroupMembers(Buffer const & b, string const & groupId)
1246 if (groupId.empty())
1248 Inset & inset = b.inset();
1249 InsetIterator it = inset_iterator_begin(inset);
1250 InsetIterator const end = inset_iterator_end(inset);
1251 for (; it != end; ++it) {
1252 InsetGraphics const * ins = it->asInsetGraphics();
1255 if (ins->getParams().groupId == groupId)
1262 string getGroupParams(Buffer const & b, string const & groupId)
1264 if (groupId.empty())
1266 Inset & inset = b.inset();
1267 InsetIterator it = inset_iterator_begin(inset);
1268 InsetIterator const end = inset_iterator_end(inset);
1269 for (; it != end; ++it) {
1270 InsetGraphics const * ins = it->asInsetGraphics();
1273 InsetGraphicsParams const & inspar = ins->getParams();
1274 if (inspar.groupId == groupId) {
1275 InsetGraphicsParams tmp = inspar;
1276 tmp.filename.erase();
1277 return InsetGraphics::params2string(tmp, b);
1284 void unifyGraphicsGroups(Buffer & b, string const & argument)
1286 InsetGraphicsParams params;
1287 InsetGraphics::string2params(argument, b, params);
1289 // This handles undo groups automagically
1290 UndoGroupHelper ugh(&b);
1291 Inset & inset = b.inset();
1292 InsetIterator it = inset_iterator_begin(inset);
1293 InsetIterator const end = inset_iterator_end(inset);
1294 for (; it != end; ++it) {
1295 InsetGraphics * ins = it->asInsetGraphics();
1298 InsetGraphicsParams const & inspar = ins->getParams();
1299 if (params.groupId == inspar.groupId) {
1300 CursorData(it).recordUndo();
1301 params.filename = inspar.filename;
1302 ins->setParams(params);
1308 InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
1310 Inset * instmp = &cur.inset();
1311 if (!instmp->asInsetGraphics())
1312 instmp = cur.nextInset();
1313 if (!instmp || !instmp->asInsetGraphics())
1316 return instmp->asInsetGraphics();
1319 } // namespace graphics