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"
57 #include "EmbeddedFiles.h"
58 #include "ErrorList.h"
61 #include "FuncRequest.h"
62 #include "FuncStatus.h"
63 #include "LaTeXFeatures.h"
66 #include "MetricsInfo.h"
68 #include "OutputParams.h"
70 #include "TocBackend.h"
72 #include "frontends/alert.h"
74 #include "support/convert.h"
75 #include "support/debug.h"
76 #include "support/docstream.h"
77 #include "support/ExceptionMessage.h"
78 #include "support/filetools.h"
79 #include "support/gettext.h"
80 #include "support/lyxlib.h"
81 #include "support/lstrings.h"
82 #include "support/os.h"
83 #include "support/Systemcall.h"
85 #include <boost/bind.hpp>
86 #include <boost/tuple/tuple.hpp>
92 using namespace lyx::support;
96 namespace Alert = frontend::Alert;
100 /// Find the most suitable image format for images in \p format
101 /// Note that \p format may be unknown (i. e. an empty string)
102 string findTargetFormat(string const & format, OutputParams const & runparams)
104 // Are we using latex or pdflatex?
105 if (runparams.flavor == OutputParams::PDFLATEX) {
106 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
107 Format const * const f = formats.getFormat(format);
108 // Convert vector graphics to pdf
109 if (f && f->vectorFormat())
111 // pdflatex can use jpeg, png and pdf directly
114 // Convert everything else to png
117 // If it's postscript, we always do eps.
118 LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
120 // any other than ps is changed to eps
127 void readInsetGraphics(Lexer & lex, string const & bufpath,
128 InsetGraphicsParams & params)
130 bool finished = false;
132 while (lex.isOK() && !finished) {
135 string const token = lex.getString();
136 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
141 if (token == "\\end_inset") {
144 if (!params.Read(lex, token, bufpath))
145 lyxerr << "Unknown token, " << token << ", skipping."
154 InsetGraphics::InsetGraphics(Buffer & buf)
155 : graphic_label(sgml::uniqueID(from_ascii("graph"))),
156 graphic_(new RenderGraphic(this))
158 Inset::setBuffer(buf);
162 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
164 boost::signals::trackable(),
165 graphic_label(sgml::uniqueID(from_ascii("graph"))),
166 graphic_(new RenderGraphic(*ig.graphic_, this))
168 setParams(ig.params());
172 Inset * InsetGraphics::clone() const
174 return new InsetGraphics(*this);
178 InsetGraphics::~InsetGraphics()
180 InsetGraphicsMailer(*this).hideDialog();
184 void InsetGraphics::setBuffer(Buffer & buffer)
188 // a file may not be copied successfully when, e.g. buffer_
189 // has already been closed.
190 params_.filename = params_.filename.copyTo(&buffer);
191 } catch (ExceptionMessage const & message) {
192 Alert::error(message.title_, message.details_);
194 params_.filename.setEmbed(false);
197 Inset::setBuffer(buffer);
201 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
203 switch (cmd.action) {
204 case LFUN_GRAPHICS_EDIT: {
205 InsetGraphicsParams p = params();
206 if (!cmd.argument().empty())
207 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
208 editGraphics(p, buffer());
212 case LFUN_INSET_MODIFY: {
213 InsetGraphicsParams p;
214 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
215 if (!p.filename.empty())
222 case LFUN_INSET_DIALOG_UPDATE:
223 InsetGraphicsMailer(*this).updateDialog(&cur.bv());
226 case LFUN_MOUSE_RELEASE:
227 if (!cur.selection() && cmd.button() == mouse_button::button1)
228 InsetGraphicsMailer(*this).showDialog(&cur.bv());
232 Inset::doDispatch(cur, cmd);
238 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
239 FuncStatus & flag) const
241 switch (cmd.action) {
242 case LFUN_GRAPHICS_EDIT:
243 case LFUN_INSET_MODIFY:
244 case LFUN_INSET_DIALOG_UPDATE:
249 return Inset::getStatus(cur, cmd, flag);
254 void InsetGraphics::registerEmbeddedFiles(EmbeddedFileList & files) const
256 files.registerFile(params().filename, this, buffer());
260 void InsetGraphics::updateEmbeddedFile(EmbeddedFile const & file)
262 // only properties of an embedded file can be changed here.
263 params_.filename = file;
267 void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
269 InsetGraphicsMailer(*this).showDialog(&cur.bv());
273 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
275 graphic_->metrics(mi, dim);
279 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
281 graphic_->draw(pi, x, y);
285 Inset::EDITABLE InsetGraphics::editable() const
291 void InsetGraphics::write(ostream & os) const
294 params().Write(os, buffer());
298 void InsetGraphics::read(Lexer & lex)
300 string const token = lex.getString();
302 if (token == "Graphics")
303 readInsetGraphics(lex, buffer().filePath(), params_);
305 LYXERR(Debug::GRAPHICS, "Not a Graphics inset!");
307 params_.filename.enable(buffer().embedded(), &buffer(), false);
308 graphic_->update(params().as_grfxParams());
312 string const InsetGraphics::createLatexOptions() const
314 // Calculate the options part of the command, we must do it to a string
315 // stream since we might have a trailing comma that we would like to remove
316 // before writing it to the output stream.
317 ostringstream options;
318 if (!params().bb.empty())
319 options << "bb=" << rtrim(params().bb) << ',';
325 double const scl = convert<double>(params().scale);
326 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
327 if (!float_equal(scl, 100.0, 0.05))
328 size << "scale=" << scl / 100.0 << ',';
330 if (!params().width.zero())
331 size << "width=" << params().width.asLatexString() << ',';
332 if (!params().height.zero())
333 size << "height=" << params().height.asLatexString() << ',';
334 if (params().keepAspectRatio)
335 size << "keepaspectratio,";
337 if (params().scaleBeforeRotation && !size.str().empty())
338 options << size.str();
340 // Make sure rotation angle is not very close to zero;
341 // a float can be effectively zero but not exactly zero.
342 if (!params().rotateAngle.empty()
343 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
344 options << "angle=" << params().rotateAngle << ',';
345 if (!params().rotateOrigin.empty()) {
346 options << "origin=" << params().rotateOrigin[0];
347 if (contains(params().rotateOrigin,"Top"))
349 else if (contains(params().rotateOrigin,"Bottom"))
351 else if (contains(params().rotateOrigin,"Baseline"))
356 if (!params().scaleBeforeRotation && !size.str().empty())
357 options << size.str();
359 if (!params().special.empty())
360 options << params().special << ',';
362 string opts = options.str();
364 if (suffixIs(opts, ','))
365 opts = opts.substr(0, opts.size() - 1);
371 docstring const InsetGraphics::toDocbookLength(Length const & len) const
373 odocstringstream result;
374 switch (len.unit()) {
375 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
376 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
378 case Length::PT: // Point = 1/72.27in = 0.351mm
379 result << len.value() * 72 / 72.27 << "pt";
381 case Length::BP: // Big point (72bp = 1in), also PostScript point
382 result << len.value() << "pt";
384 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
385 result << len.value() * 0.376 << "mm";
387 case Length::MM: // Millimeter = 2.845pt
388 result << len.value() << "mm";
390 case Length::PC: // Pica = 12pt = 4.218mm
391 result << len.value() << "pc";
393 case Length::CC: // Cicero = 12dd = 4.531mm
394 result << len.value() * 4.531 << "mm";
396 case Length::CM: // Centimeter = 10mm = 2.371pc
397 result << len.value() << "cm";
399 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
400 result << len.value() << "in";
402 case Length::EX: // Height of a small "x" for the current font.
403 // Obviously we have to compromise here. Any better ratio than 1.5 ?
404 result << len.value() / 1.5 << "em";
406 case Length::EM: // Width of capital "M" in current font.
407 result << len.value() << "em";
409 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
410 result << len.value() * 18 << "em";
412 case Length::PTW: // Percent of TextWidth
413 case Length::PCW: // Percent of ColumnWidth
414 case Length::PPW: // Percent of PageWidth
415 case Length::PLW: // Percent of LineWidth
416 case Length::PTH: // Percent of TextHeight
417 case Length::PPH: // Percent of Paper
418 // Sigh, this will go wrong.
419 result << len.value() << "%";
422 result << len.asDocstring();
428 docstring const InsetGraphics::createDocBookAttributes() const
430 // Calculate the options part of the command, we must do it to a string
431 // stream since we copied the code from createLatexParams() ;-)
433 // FIXME: av: need to translate spec -> Docbook XSL spec
434 // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
435 // Right now it only works with my version of db2latex :-)
437 odocstringstream options;
438 double const scl = convert<double>(params().scale);
439 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
440 if (!float_equal(scl, 100.0, 0.05))
441 options << " scale=\""
442 << static_cast<int>( (scl) + 0.5 )
445 if (!params().width.zero()) {
446 options << " width=\"" << toDocbookLength(params().width) << "\" ";
448 if (!params().height.zero()) {
449 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
451 if (params().keepAspectRatio) {
452 // This will be irrelevant unless both width and height are set
453 options << "scalefit=\"1\" ";
458 if (!params().special.empty())
459 options << from_ascii(params().special) << " ";
461 // trailing blanks are ok ...
462 return options.str();
468 enum GraphicsCopyStatus {
476 pair<GraphicsCopyStatus, FileName> const
477 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
479 LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
480 unsigned long const checksum_in = file_in.checksum();
481 unsigned long const checksum_out = file_out.checksum();
483 if (checksum_in == checksum_out)
485 return make_pair(IDENTICAL_CONTENTS, file_out);
487 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
488 bool const success = mover.copy(file_in, file_out);
491 LYXERR(Debug::GRAPHICS,
492 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
493 "into the temporary directory."),
494 from_utf8(file_in.absFilename()))));
497 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
498 return make_pair(status, file_out);
502 pair<GraphicsCopyStatus, FileName> const
503 copyToDirIfNeeded(DocFileName const & file, string const & dir)
505 string const file_in = file.absFilename();
506 string const only_path = onlyPath(file_in);
507 if (rtrim(onlyPath(file_in) , "/") == rtrim(dir, "/"))
508 return make_pair(IDENTICAL_PATHS, file_in);
510 string mangled = file.mangledFilename();
511 if (file.isZipped()) {
512 // We need to change _eps.gz to .eps.gz. The mangled name is
513 // still unique because of the counter in mangledFilename().
514 // We can't just call mangledFilename() with the zip
515 // extension removed, because base.eps and base.eps.gz may
516 // have different content but would get the same mangled
517 // name in this case.
518 string const base = removeExtension(file.unzippedFilename());
519 string::size_type const ext_len = file_in.length() - base.length();
520 mangled[mangled.length() - ext_len] = '.';
522 FileName const file_out(makeAbsPath(mangled, dir));
524 return copyFileIfNeeded(file, file_out);
528 string const stripExtensionIfPossible(string const & file, bool nice)
530 // Remove the extension so the LaTeX compiler will use whatever
531 // is appropriate (when there are several versions in different
533 // Do this only if we are not exporting for internal usage, because
534 // pdflatex prefers png over pdf and it would pick up the png images
535 // that we generate for preview.
536 // This works only if the filename contains no dots besides
537 // the just removed one. We can fool here by replacing all
538 // dots with a macro whose definition is just a dot ;-)
539 // The automatic format selection does not work if the file
541 string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
542 if (!nice || contains(latex_name, '"'))
544 return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
548 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
550 // No conversion is needed. LaTeX can handle the graphic file as is.
551 // This is true even if the orig_file is compressed.
552 string const to_format = formats.getFormat(to)->extension();
553 string const file_format = getExtension(file);
554 // for latex .ps == .eps
555 if (to_format == file_format ||
556 (to_format == "eps" && file_format == "ps") ||
557 (to_format == "ps" && file_format == "eps"))
558 return stripExtensionIfPossible(file, nice);
559 return latex_path(file, EXCLUDE_EXTENSION);
565 string InsetGraphics::prepareFile(OutputParams const & runparams) const
567 // The following code depends on non-empty filenames
568 if (params().filename.empty())
571 string const orig_file = params().filename.availableFile().absFilename();
572 // this is for dryrun and display purposes, do not use latexFilename
573 string const rel_file = params().filename.relFilename(buffer().filePath());
575 // previewing source code, no file copying or file format conversion
576 if (runparams.dryrun)
577 return stripExtensionIfPossible(rel_file, runparams.nice);
579 // temp_file will contain the file for LaTeX to act on if, for example,
580 // we move it to a temp dir or uncompress it.
581 FileName temp_file = params().filename.availableFile();
583 // The master buffer. This is useful when there are multiple levels
585 Buffer const * masterBuffer = buffer().masterBuffer();
587 // Return the output name if we are inside a comment or the file does
589 // We are not going to change the extension or using the name of the
590 // temporary file, the code is already complicated enough.
591 if (runparams.inComment || !params().filename.isReadableFile())
592 return params().filename.outputFilename(masterBuffer->filePath());
594 // We place all temporary files in the master buffer's temp dir.
595 // This is possible because we use mangled file names.
596 // This is necessary for DVI export.
597 string const temp_path = masterBuffer->temppath();
599 GraphicsCopyStatus status;
600 boost::tie(status, temp_file) =
601 copyToDirIfNeeded(params().filename.availableFile(), temp_path);
603 if (status == FAILURE)
606 // a relative filename should be relative to the master buffer.
607 // "nice" means that the buffer is exported to LaTeX format but not
608 // run through the LaTeX compiler.
609 string output_file = runparams.nice ?
610 params().filename.outputFilename(masterBuffer->filePath()) :
611 onlyFilename(temp_file.absFilename());
613 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
614 frontend::Alert::warning(_("Invalid filename"),
615 _("The following filename is likely to cause trouble "
616 "when running the exported file through LaTeX: ") +
617 from_utf8(output_file));
620 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
621 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
622 "latex" : "pdflatex";
624 // If the file is compressed and we have specified that it
625 // should not be uncompressed, then just return its name and
626 // let LaTeX do the rest!
627 if (params().filename.isZipped()) {
628 if (params().noUnzip) {
629 // We don't know whether latex can actually handle
630 // this file, but we can't check, because that would
631 // mean to unzip the file and thereby making the
632 // noUnzip parameter meaningless.
633 LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
635 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
636 if (runparams.nice) {
637 runparams.exportdata->addExternalFile(tex_format,
639 changeExtension(output_file, "bb"));
641 // LaTeX needs the bounding box file in the
643 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
644 boost::tie(status, bb_file) =
645 copyFileIfNeeded(bb_orig_file, bb_file);
646 if (status == FAILURE)
648 runparams.exportdata->addExternalFile(tex_format,
651 runparams.exportdata->addExternalFile(tex_format,
652 source_file, output_file);
653 runparams.exportdata->addExternalFile("dvi",
654 source_file, output_file);
655 // We can't strip the extension, because we don't know
656 // the unzipped file format
657 return latex_path(output_file, EXCLUDE_EXTENSION);
660 FileName const unzipped_temp_file =
661 FileName(unzippedFileName(temp_file.absFilename()));
662 output_file = unzippedFileName(output_file);
663 source_file = FileName(unzippedFileName(source_file.absFilename()));
664 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
665 // temp_file has been unzipped already and
666 // orig_file has not changed in the meantime.
667 temp_file = unzipped_temp_file;
668 LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
670 // unzipped_temp_file does not exist or is too old
671 temp_file = unzipFile(temp_file);
672 LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
676 string const from = formats.getFormatFromFile(temp_file);
678 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
680 string const to = findTargetFormat(from, runparams);
681 string const ext = formats.extension(to);
682 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
684 // We're going to be running the exported buffer through the LaTeX
685 // compiler, so must ensure that LaTeX can cope with the graphics
688 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
691 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
692 // The LaTeX compiler will not be able to determine
693 // the file format from the extension, so we must
695 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
696 if (temp_file.moveTo(new_file)) {
697 temp_file = new_file;
698 output_file = changeExtension(output_file, ext);
699 source_file = FileName(changeExtension(source_file.absFilename(), ext));
701 LYXERR(Debug::GRAPHICS, "Could not rename file `"
702 << temp_file << "' to `" << new_file << "'.");
705 // The extension of temp_file might be != ext!
706 runparams.exportdata->addExternalFile(tex_format, source_file,
708 runparams.exportdata->addExternalFile("dvi", source_file,
710 return stripExtensionIfPossible(output_file, to, runparams.nice);
713 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
714 string const output_to_file = changeExtension(output_file, ext);
716 // Do we need to perform the conversion?
717 // Yes if to_file does not exist or if temp_file is newer than to_file
718 if (compare_timestamps(temp_file, to_file) < 0) {
720 LYXERR(Debug::GRAPHICS,
721 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
722 from_utf8(rel_file))));
723 runparams.exportdata->addExternalFile(tex_format, to_file,
725 runparams.exportdata->addExternalFile("dvi", to_file,
727 return stripExtensionIfPossible(output_to_file, runparams.nice);
730 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
731 << "\tA copy has been made and convert is to be called with:\n"
732 << "\tfile to convert = " << temp_file << '\n'
733 << "\t from " << from << " to " << to);
735 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
737 if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
739 Converters::try_default | Converters::try_cache)) {
740 runparams.exportdata->addExternalFile(tex_format,
741 to_file, output_to_file);
742 runparams.exportdata->addExternalFile("dvi",
743 to_file, output_to_file);
746 return stripExtensionIfPossible(output_to_file, runparams.nice);
750 int InsetGraphics::latex(odocstream & os,
751 OutputParams const & runparams) const
753 // If there is no file specified or not existing,
754 // just output a message about it in the latex output.
755 LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
756 << params().filename.absFilename());
758 bool const file_exists = !params().filename.empty()
759 && params().filename.isReadableFile();
760 string const message = file_exists ?
761 string() : string("bb = 0 0 200 100, draft, type=eps");
762 // if !message.empty() then there was no existing file
763 // "filename" found. In this case LaTeX
764 // draws only a rectangle with the above bb and the
765 // not found filename in it.
766 LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
768 // These variables collect all the latex code that should be before and
769 // after the actual includegraphics command.
773 if (runparams.moving_arg)
774 before += "\\protect";
776 // We never use the starred form, we use the "clip" option instead.
777 before += "\\includegraphics";
779 // Write the options if there are any.
780 string const opts = createLatexOptions();
781 LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
783 if (!opts.empty() && !message.empty())
784 before += ('[' + opts + ',' + message + ']');
785 else if (!opts.empty() || !message.empty())
786 before += ('[' + opts + message + ']');
788 LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
790 string latex_str = before + '{';
791 // Convert the file if necessary.
792 // Remove the extension so LaTeX will use whatever is appropriate
793 // (when there are several versions in different formats)
794 latex_str += prepareFile(runparams);
795 latex_str += '}' + after;
797 os << from_utf8(latex_str);
799 LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
800 // Return how many newlines we issued.
801 return int(count(latex_str.begin(), latex_str.end(),'\n'));
805 int InsetGraphics::plaintext(odocstream & os, OutputParams const &) const
807 // No graphics in ascii output. Possible to use gifscii to convert
808 // images to ascii approximation.
809 // 1. Convert file to ascii using gifscii
810 // 2. Read ascii output file and add it to the output stream.
811 // at least we send the filename
813 // FIXME: We have no idea what the encoding of the filename is
815 docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
816 from_utf8(params().filename.absFilename()));
817 os << '<' << str << '>';
819 return 2 + str.size();
823 static int writeImageObject(char const * format, odocstream & os,
824 OutputParams const & runparams, docstring const & graphic_label,
825 docstring const & attributes)
827 if (runparams.flavor != OutputParams::XML)
828 os << "<![ %output.print." << format
831 os <<"<imageobject><imagedata fileref=\"&"
838 if (runparams.flavor == OutputParams::XML)
839 os << " role=\"" << format << "\"/>" ;
841 os << " format=\"" << format << "\">" ;
843 os << "</imageobject>";
845 if (runparams.flavor != OutputParams::XML)
846 os << endl << "]]>" ;
848 return runparams.flavor == OutputParams::XML ? 0 : 2;
852 // For explanation on inserting graphics into DocBook checkout:
853 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
854 // See also the docbook guide at http://www.docbook.org/
855 int InsetGraphics::docbook(odocstream & os,
856 OutputParams const & runparams) const
858 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
859 // need to switch to MediaObject. However, for now this is sufficient and
861 if (runparams.flavor == OutputParams::XML)
862 runparams.exportdata->addExternalFile("docbook-xml",
865 runparams.exportdata->addExternalFile("docbook",
868 os << "<inlinemediaobject>";
871 docstring attributes = createDocBookAttributes();
872 r += writeImageObject("png", os, runparams, graphic_label, attributes);
873 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
874 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
875 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
877 os << "</inlinemediaobject>";
882 void InsetGraphics::validate(LaTeXFeatures & features) const
884 // If we have no image, we should not require anything.
885 if (params().filename.empty())
888 features.includeFile(graphic_label,
889 removeExtension(params().filename.absFilename()));
891 features.require("graphicx");
893 if (features.runparams().nice) {
894 Buffer const * masterBuffer = features.buffer().masterBuffer();
895 string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath()));
896 if (contains(rel_file, "."))
897 features.require("lyxdot");
902 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
904 // If nothing is changed, just return and say so.
905 if (params() == p && !p.filename.empty())
908 // Copy the new parameters.
911 // Update the display using the new parameters.
912 graphic_->update(params().as_grfxParams());
914 // We have changed data, report it.
919 InsetGraphicsParams const & InsetGraphics::params() const
925 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
926 Buffer const & buffer) const
928 formats.edit(buffer, p.filename,
929 formats.getFormatFromFile(p.filename));
933 void InsetGraphics::addToToc(ParConstIterator const & cpit) const
935 TocBackend & backend = buffer().tocBackend();
937 docstring str = params_.filename.displayName();
938 if (params_.filename.embedded()) {
939 backend.toc("embedded").push_back(TocItem(cpit, 0, str));
940 str += _(" (embedded)");
942 backend.toc("graphics").push_back(TocItem(cpit, 0, str));
946 docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
948 return from_ascii("context-graphics");
952 string const InsetGraphicsMailer::name_("graphics");
954 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
959 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
961 return params2string(inset_.params(), buffer);
965 void InsetGraphicsMailer::string2params(string const & in,
966 Buffer const & buffer,
967 InsetGraphicsParams & params)
972 istringstream data(in);
978 if (!lex || name != name_)
979 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
981 params = InsetGraphicsParams();
982 readInsetGraphics(lex, buffer.filePath(), params);
987 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
988 Buffer const & buffer)
991 data << name_ << ' ';
992 params.Write(data, buffer);
993 data << "\\end_inset\n";