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"
73 #include "frontends/Application.h"
75 #include "support/convert.h"
76 #include "support/debug.h"
77 #include "support/docstream.h"
78 #include "support/ExceptionMessage.h"
79 #include "support/filetools.h"
80 #include "support/gettext.h"
81 #include "support/lyxlib.h"
82 #include "support/lstrings.h"
83 #include "support/os.h"
84 #include "support/Systemcall.h"
86 #include <boost/bind.hpp>
87 #include <boost/tuple/tuple.hpp>
93 using namespace lyx::support;
97 namespace Alert = frontend::Alert;
101 /// Find the most suitable image format for images in \p format
102 /// Note that \p format may be unknown (i. e. an empty string)
103 string findTargetFormat(string const & format, OutputParams const & runparams)
105 // Are we using latex or pdflatex?
106 if (runparams.flavor == OutputParams::PDFLATEX) {
107 LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
108 Format const * const f = formats.getFormat(format);
109 // Convert vector graphics to pdf
110 if (f && f->vectorFormat())
112 // pdflatex can use jpeg, png and pdf directly
115 // Convert everything else to png
118 // If it's postscript, we always do eps.
119 LYXERR(Debug::GRAPHICS, "findTargetFormat: PostScript mode");
121 // any other than ps is changed to eps
128 void readInsetGraphics(Lexer & lex, string const & bufpath,
129 InsetGraphicsParams & params)
131 bool finished = false;
133 while (lex.isOK() && !finished) {
136 string const token = lex.getString();
137 LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
142 if (token == "\\end_inset") {
145 if (!params.Read(lex, token, bufpath))
146 lyxerr << "Unknown token, " << token << ", skipping."
155 InsetGraphics::InsetGraphics(Buffer & buf)
156 : graphic_label(sgml::uniqueID(from_ascii("graph"))),
157 graphic_(new RenderGraphic(this))
159 Inset::setBuffer(buf);
163 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
165 boost::signals::trackable(),
166 graphic_label(sgml::uniqueID(from_ascii("graph"))),
167 graphic_(new RenderGraphic(*ig.graphic_, this))
169 setParams(ig.params());
173 Inset * InsetGraphics::clone() const
175 return new InsetGraphics(*this);
179 InsetGraphics::~InsetGraphics()
181 hideDialogs("graphics", this);
185 void InsetGraphics::setBuffer(Buffer & buffer)
189 // a file may not be copied successfully when, e.g. buffer_
190 // has already been closed.
191 params_.filename = params_.filename.copyTo(&buffer);
192 } catch (ExceptionMessage const & message) {
193 Alert::error(message.title_, message.details_);
195 params_.filename.setEmbed(false);
198 Inset::setBuffer(buffer);
202 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
204 switch (cmd.action) {
205 case LFUN_GRAPHICS_EDIT: {
206 InsetGraphicsParams p = params();
207 if (!cmd.argument().empty())
208 string2params(to_utf8(cmd.argument()), buffer(), p);
209 editGraphics(p, buffer());
213 case LFUN_INSET_MODIFY: {
214 InsetGraphicsParams p;
215 string2params(to_utf8(cmd.argument()), buffer(), p);
216 if (!p.filename.empty())
223 case LFUN_INSET_DIALOG_UPDATE:
224 cur.bv().updateDialog("graphics", params2string(params(),
228 case LFUN_MOUSE_RELEASE:
229 if (!cur.selection() && cmd.button() == mouse_button::button1)
230 cur.bv().showDialog("graphics", params2string(params(),
231 cur.bv().buffer()), this);
235 Inset::doDispatch(cur, cmd);
241 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
242 FuncStatus & flag) const
244 switch (cmd.action) {
245 case LFUN_GRAPHICS_EDIT:
246 case LFUN_INSET_MODIFY:
247 case LFUN_INSET_DIALOG_UPDATE:
252 return Inset::getStatus(cur, cmd, flag);
257 void InsetGraphics::registerEmbeddedFiles(EmbeddedFileList & files) const
259 files.registerFile(params().filename, this, buffer());
263 void InsetGraphics::updateEmbeddedFile(EmbeddedFile const & file)
265 // only properties of an embedded file can be changed here.
266 params_.filename = file;
270 void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
272 cur.bv().showDialog("graphics", params2string(params(),
273 cur.bv().buffer()), this);
277 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
279 graphic_->metrics(mi, dim);
283 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
285 graphic_->draw(pi, x, y);
289 Inset::EDITABLE InsetGraphics::editable() const
295 void InsetGraphics::write(ostream & os) const
298 params().Write(os, buffer());
302 void InsetGraphics::read(Lexer & lex)
304 string const token = lex.getString();
306 if (token == "Graphics")
307 readInsetGraphics(lex, buffer().filePath(), params_);
309 LYXERR(Debug::GRAPHICS, "Not a Graphics inset!");
311 params_.filename.enable(buffer().embedded(), &buffer(), false);
312 graphic_->update(params().as_grfxParams());
316 string InsetGraphics::createLatexOptions() const
318 // Calculate the options part of the command, we must do it to a string
319 // stream since we might have a trailing comma that we would like to remove
320 // before writing it to the output stream.
321 ostringstream options;
322 if (!params().bb.empty())
323 options << "bb=" << rtrim(params().bb) << ',';
329 double const scl = convert<double>(params().scale);
330 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
331 if (!float_equal(scl, 100.0, 0.05))
332 size << "scale=" << scl / 100.0 << ',';
334 if (!params().width.zero())
335 size << "width=" << params().width.asLatexString() << ',';
336 if (!params().height.zero())
337 size << "height=" << params().height.asLatexString() << ',';
338 if (params().keepAspectRatio)
339 size << "keepaspectratio,";
341 if (params().scaleBeforeRotation && !size.str().empty())
342 options << size.str();
344 // Make sure rotation angle is not very close to zero;
345 // a float can be effectively zero but not exactly zero.
346 if (!params().rotateAngle.empty()
347 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
348 options << "angle=" << params().rotateAngle << ',';
349 if (!params().rotateOrigin.empty()) {
350 options << "origin=" << params().rotateOrigin[0];
351 if (contains(params().rotateOrigin,"Top"))
353 else if (contains(params().rotateOrigin,"Bottom"))
355 else if (contains(params().rotateOrigin,"Baseline"))
360 if (!params().scaleBeforeRotation && !size.str().empty())
361 options << size.str();
363 if (!params().special.empty())
364 options << params().special << ',';
366 string opts = options.str();
368 if (suffixIs(opts, ','))
369 opts = opts.substr(0, opts.size() - 1);
375 docstring InsetGraphics::toDocbookLength(Length const & len) const
377 odocstringstream result;
378 switch (len.unit()) {
379 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
380 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
382 case Length::PT: // Point = 1/72.27in = 0.351mm
383 result << len.value() * 72 / 72.27 << "pt";
385 case Length::BP: // Big point (72bp = 1in), also PostScript point
386 result << len.value() << "pt";
388 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
389 result << len.value() * 0.376 << "mm";
391 case Length::MM: // Millimeter = 2.845pt
392 result << len.value() << "mm";
394 case Length::PC: // Pica = 12pt = 4.218mm
395 result << len.value() << "pc";
397 case Length::CC: // Cicero = 12dd = 4.531mm
398 result << len.value() * 4.531 << "mm";
400 case Length::CM: // Centimeter = 10mm = 2.371pc
401 result << len.value() << "cm";
403 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
404 result << len.value() << "in";
406 case Length::EX: // Height of a small "x" for the current font.
407 // Obviously we have to compromise here. Any better ratio than 1.5 ?
408 result << len.value() / 1.5 << "em";
410 case Length::EM: // Width of capital "M" in current font.
411 result << len.value() << "em";
413 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
414 result << len.value() * 18 << "em";
416 case Length::PTW: // Percent of TextWidth
417 case Length::PCW: // Percent of ColumnWidth
418 case Length::PPW: // Percent of PageWidth
419 case Length::PLW: // Percent of LineWidth
420 case Length::PTH: // Percent of TextHeight
421 case Length::PPH: // Percent of Paper
422 // Sigh, this will go wrong.
423 result << len.value() << "%";
426 result << len.asDocstring();
433 docstring InsetGraphics::createDocBookAttributes() const
435 // Calculate the options part of the command, we must do it to a string
436 // stream since we copied the code from createLatexParams() ;-)
438 // FIXME: av: need to translate spec -> Docbook XSL spec
439 // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
440 // Right now it only works with my version of db2latex :-)
442 odocstringstream options;
443 double const scl = convert<double>(params().scale);
444 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
445 if (!float_equal(scl, 100.0, 0.05))
446 options << " scale=\""
447 << static_cast<int>( (scl) + 0.5 )
450 if (!params().width.zero()) {
451 options << " width=\"" << toDocbookLength(params().width) << "\" ";
453 if (!params().height.zero()) {
454 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
456 if (params().keepAspectRatio) {
457 // This will be irrelevant unless both width and height are set
458 options << "scalefit=\"1\" ";
463 if (!params().special.empty())
464 options << from_ascii(params().special) << " ";
466 // trailing blanks are ok ...
467 return options.str();
473 enum GraphicsCopyStatus {
481 pair<GraphicsCopyStatus, FileName> const
482 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
484 LYXERR(Debug::FILES, "Comparing " << file_in << " and " << file_out);
485 unsigned long const checksum_in = file_in.checksum();
486 unsigned long const checksum_out = file_out.checksum();
488 if (checksum_in == checksum_out)
490 return make_pair(IDENTICAL_CONTENTS, file_out);
492 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
493 bool const success = mover.copy(file_in, file_out);
496 LYXERR(Debug::GRAPHICS,
497 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
498 "into the temporary directory."),
499 from_utf8(file_in.absFilename()))));
502 GraphicsCopyStatus status = success ? SUCCESS : FAILURE;
503 return make_pair(status, file_out);
507 pair<GraphicsCopyStatus, FileName> const
508 copyToDirIfNeeded(DocFileName const & file, string const & dir)
510 string const file_in = file.absFilename();
511 string const only_path = onlyPath(file_in);
512 if (rtrim(onlyPath(file_in) , "/") == rtrim(dir, "/"))
513 return make_pair(IDENTICAL_PATHS, file_in);
515 string mangled = file.mangledFilename();
516 if (file.isZipped()) {
517 // We need to change _eps.gz to .eps.gz. The mangled name is
518 // still unique because of the counter in mangledFilename().
519 // We can't just call mangledFilename() with the zip
520 // extension removed, because base.eps and base.eps.gz may
521 // have different content but would get the same mangled
522 // name in this case.
523 string const base = removeExtension(file.unzippedFilename());
524 string::size_type const ext_len = file_in.length() - base.length();
525 mangled[mangled.length() - ext_len] = '.';
527 FileName const file_out(makeAbsPath(mangled, dir));
529 return copyFileIfNeeded(file, file_out);
533 string const stripExtensionIfPossible(string const & file, bool nice)
535 // Remove the extension so the LaTeX compiler will use whatever
536 // is appropriate (when there are several versions in different
538 // Do this only if we are not exporting for internal usage, because
539 // pdflatex prefers png over pdf and it would pick up the png images
540 // that we generate for preview.
541 // This works only if the filename contains no dots besides
542 // the just removed one. We can fool here by replacing all
543 // dots with a macro whose definition is just a dot ;-)
544 // The automatic format selection does not work if the file
546 string const latex_name = latex_path(file, EXCLUDE_EXTENSION);
547 if (!nice || contains(latex_name, '"'))
549 return latex_path(removeExtension(file), PROTECT_EXTENSION, ESCAPE_DOTS);
553 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
555 // No conversion is needed. LaTeX can handle the graphic file as is.
556 // This is true even if the orig_file is compressed.
557 string const to_format = formats.getFormat(to)->extension();
558 string const file_format = getExtension(file);
559 // for latex .ps == .eps
560 if (to_format == file_format ||
561 (to_format == "eps" && file_format == "ps") ||
562 (to_format == "ps" && file_format == "eps"))
563 return stripExtensionIfPossible(file, nice);
564 return latex_path(file, EXCLUDE_EXTENSION);
570 string InsetGraphics::prepareFile(OutputParams const & runparams) const
572 // The following code depends on non-empty filenames
573 if (params().filename.empty())
576 string const orig_file = params().filename.availableFile().absFilename();
577 // this is for dryrun and display purposes, do not use latexFilename
578 string const rel_file = params().filename.relFilename(buffer().filePath());
580 // previewing source code, no file copying or file format conversion
581 if (runparams.dryrun)
582 return stripExtensionIfPossible(rel_file, runparams.nice);
584 // temp_file will contain the file for LaTeX to act on if, for example,
585 // we move it to a temp dir or uncompress it.
586 FileName temp_file = params().filename.availableFile();
588 // The master buffer. This is useful when there are multiple levels
590 Buffer const * masterBuffer = buffer().masterBuffer();
592 // Return the output name if we are inside a comment or the file does
594 // We are not going to change the extension or using the name of the
595 // temporary file, the code is already complicated enough.
596 if (runparams.inComment || !params().filename.isReadableFile())
597 return params().filename.outputFilename(masterBuffer->filePath());
599 // We place all temporary files in the master buffer's temp dir.
600 // This is possible because we use mangled file names.
601 // This is necessary for DVI export.
602 string const temp_path = masterBuffer->temppath();
604 GraphicsCopyStatus status;
605 boost::tie(status, temp_file) =
606 copyToDirIfNeeded(params().filename.availableFile(), temp_path);
608 if (status == FAILURE)
611 // a relative filename should be relative to the master buffer.
612 // "nice" means that the buffer is exported to LaTeX format but not
613 // run through the LaTeX compiler.
614 string output_file = runparams.nice ?
615 params().filename.outputFilename(masterBuffer->filePath()) :
616 onlyFilename(temp_file.absFilename());
618 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
619 frontend::Alert::warning(_("Invalid filename"),
620 _("The following filename is likely to cause trouble "
621 "when running the exported file through LaTeX: ") +
622 from_utf8(output_file));
625 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
626 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
627 "latex" : "pdflatex";
629 // If the file is compressed and we have specified that it
630 // should not be uncompressed, then just return its name and
631 // let LaTeX do the rest!
632 if (params().filename.isZipped()) {
633 if (params().noUnzip) {
634 // We don't know whether latex can actually handle
635 // this file, but we can't check, because that would
636 // mean to unzip the file and thereby making the
637 // noUnzip parameter meaningless.
638 LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
640 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
641 if (runparams.nice) {
642 runparams.exportdata->addExternalFile(tex_format,
644 changeExtension(output_file, "bb"));
646 // LaTeX needs the bounding box file in the
648 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
649 boost::tie(status, bb_file) =
650 copyFileIfNeeded(bb_orig_file, bb_file);
651 if (status == FAILURE)
653 runparams.exportdata->addExternalFile(tex_format,
656 runparams.exportdata->addExternalFile(tex_format,
657 source_file, output_file);
658 runparams.exportdata->addExternalFile("dvi",
659 source_file, output_file);
660 // We can't strip the extension, because we don't know
661 // the unzipped file format
662 return latex_path(output_file, EXCLUDE_EXTENSION);
665 FileName const unzipped_temp_file =
666 FileName(unzippedFileName(temp_file.absFilename()));
667 output_file = unzippedFileName(output_file);
668 source_file = FileName(unzippedFileName(source_file.absFilename()));
669 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
670 // temp_file has been unzipped already and
671 // orig_file has not changed in the meantime.
672 temp_file = unzipped_temp_file;
673 LYXERR(Debug::GRAPHICS, "\twas already unzipped to " << temp_file);
675 // unzipped_temp_file does not exist or is too old
676 temp_file = unzipFile(temp_file);
677 LYXERR(Debug::GRAPHICS, "\tunzipped to " << temp_file);
681 string const from = formats.getFormatFromFile(temp_file);
683 LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
685 string const to = findTargetFormat(from, runparams);
686 string const ext = formats.extension(to);
687 LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
689 // We're going to be running the exported buffer through the LaTeX
690 // compiler, so must ensure that LaTeX can cope with the graphics
693 LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
696 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
697 // The LaTeX compiler will not be able to determine
698 // the file format from the extension, so we must
700 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
701 if (temp_file.moveTo(new_file)) {
702 temp_file = new_file;
703 output_file = changeExtension(output_file, ext);
704 source_file = FileName(changeExtension(source_file.absFilename(), ext));
706 LYXERR(Debug::GRAPHICS, "Could not rename file `"
707 << temp_file << "' to `" << new_file << "'.");
710 // The extension of temp_file might be != ext!
711 runparams.exportdata->addExternalFile(tex_format, source_file,
713 runparams.exportdata->addExternalFile("dvi", source_file,
715 return stripExtensionIfPossible(output_file, to, runparams.nice);
718 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
719 string const output_to_file = changeExtension(output_file, ext);
721 // Do we need to perform the conversion?
722 // Yes if to_file does not exist or if temp_file is newer than to_file
723 if (compare_timestamps(temp_file, to_file) < 0) {
725 LYXERR(Debug::GRAPHICS,
726 to_utf8(bformat(_("No conversion of %1$s is needed after all"),
727 from_utf8(rel_file))));
728 runparams.exportdata->addExternalFile(tex_format, to_file,
730 runparams.exportdata->addExternalFile("dvi", to_file,
732 return stripExtensionIfPossible(output_to_file, runparams.nice);
735 LYXERR(Debug::GRAPHICS,"\tThe original file is " << orig_file << "\n"
736 << "\tA copy has been made and convert is to be called with:\n"
737 << "\tfile to convert = " << temp_file << '\n'
738 << "\t from " << from << " to " << to);
740 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
742 if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
744 Converters::try_default | Converters::try_cache)) {
745 runparams.exportdata->addExternalFile(tex_format,
746 to_file, output_to_file);
747 runparams.exportdata->addExternalFile("dvi",
748 to_file, output_to_file);
751 return stripExtensionIfPossible(output_to_file, runparams.nice);
755 int InsetGraphics::latex(odocstream & os,
756 OutputParams const & runparams) const
758 // If there is no file specified or not existing,
759 // just output a message about it in the latex output.
760 LYXERR(Debug::GRAPHICS, "insetgraphics::latex: Filename = "
761 << params().filename.absFilename());
763 bool const file_exists = !params().filename.empty()
764 && params().filename.isReadableFile();
765 string const message = file_exists ?
766 string() : string("bb = 0 0 200 100, draft, type=eps");
767 // if !message.empty() then there was no existing file
768 // "filename" found. In this case LaTeX
769 // draws only a rectangle with the above bb and the
770 // not found filename in it.
771 LYXERR(Debug::GRAPHICS, "\tMessage = \"" << message << '\"');
773 // These variables collect all the latex code that should be before and
774 // after the actual includegraphics command.
778 if (runparams.moving_arg)
779 before += "\\protect";
781 // We never use the starred form, we use the "clip" option instead.
782 before += "\\includegraphics";
784 // Write the options if there are any.
785 string const opts = createLatexOptions();
786 LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
788 if (!opts.empty() && !message.empty())
789 before += ('[' + opts + ',' + message + ']');
790 else if (!opts.empty() || !message.empty())
791 before += ('[' + opts + message + ']');
793 LYXERR(Debug::GRAPHICS, "\tBefore = " << before << "\n\tafter = " << after);
795 string latex_str = before + '{';
796 // Convert the file if necessary.
797 // Remove the extension so LaTeX will use whatever is appropriate
798 // (when there are several versions in different formats)
799 latex_str += prepareFile(runparams);
800 latex_str += '}' + after;
802 os << from_utf8(latex_str);
804 LYXERR(Debug::GRAPHICS, "InsetGraphics::latex outputting:\n" << latex_str);
805 // Return how many newlines we issued.
806 return int(count(latex_str.begin(), latex_str.end(),'\n'));
810 int InsetGraphics::plaintext(odocstream & os, OutputParams const &) const
812 // No graphics in ascii output. Possible to use gifscii to convert
813 // images to ascii approximation.
814 // 1. Convert file to ascii using gifscii
815 // 2. Read ascii output file and add it to the output stream.
816 // at least we send the filename
818 // FIXME: We have no idea what the encoding of the filename is
820 docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
821 from_utf8(params().filename.absFilename()));
822 os << '<' << str << '>';
824 return 2 + str.size();
828 static int writeImageObject(char const * format, odocstream & os,
829 OutputParams const & runparams, docstring const & graphic_label,
830 docstring const & attributes)
832 if (runparams.flavor != OutputParams::XML)
833 os << "<![ %output.print." << format
836 os <<"<imageobject><imagedata fileref=\"&"
843 if (runparams.flavor == OutputParams::XML)
844 os << " role=\"" << format << "\"/>" ;
846 os << " format=\"" << format << "\">" ;
848 os << "</imageobject>";
850 if (runparams.flavor != OutputParams::XML)
851 os << endl << "]]>" ;
853 return runparams.flavor == OutputParams::XML ? 0 : 2;
857 // For explanation on inserting graphics into DocBook checkout:
858 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
859 // See also the docbook guide at http://www.docbook.org/
860 int InsetGraphics::docbook(odocstream & os,
861 OutputParams const & runparams) const
863 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
864 // need to switch to MediaObject. However, for now this is sufficient and
866 if (runparams.flavor == OutputParams::XML)
867 runparams.exportdata->addExternalFile("docbook-xml",
870 runparams.exportdata->addExternalFile("docbook",
873 os << "<inlinemediaobject>";
876 docstring attributes = createDocBookAttributes();
877 r += writeImageObject("png", os, runparams, graphic_label, attributes);
878 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
879 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
880 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
882 os << "</inlinemediaobject>";
887 void InsetGraphics::validate(LaTeXFeatures & features) const
889 // If we have no image, we should not require anything.
890 if (params().filename.empty())
893 features.includeFile(graphic_label,
894 removeExtension(params().filename.absFilename()));
896 features.require("graphicx");
898 if (features.runparams().nice) {
899 Buffer const * masterBuffer = features.buffer().masterBuffer();
900 string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath()));
901 if (contains(rel_file, "."))
902 features.require("lyxdot");
907 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
909 // If nothing is changed, just return and say so.
910 if (params() == p && !p.filename.empty())
913 // Copy the new parameters.
916 // Update the display using the new parameters.
917 graphic_->update(params().as_grfxParams());
919 // We have changed data, report it.
924 InsetGraphicsParams const & InsetGraphics::params() const
930 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
931 Buffer const & buffer) const
933 formats.edit(buffer, p.filename,
934 formats.getFormatFromFile(p.filename));
938 void InsetGraphics::addToToc(ParConstIterator const & cpit) const
940 TocBackend & backend = buffer().tocBackend();
942 docstring str = params_.filename.displayName();
943 if (params_.filename.embedded()) {
944 backend.toc("embedded").push_back(TocItem(cpit, 0, str));
945 str += _(" (embedded)");
947 backend.toc("graphics").push_back(TocItem(cpit, 0, str));
951 docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
953 return from_ascii("context-graphics");
957 void InsetGraphics::string2params(string const & in, Buffer const & buffer,
958 InsetGraphicsParams & params)
963 istringstream data(in);
969 if (!lex || name != "graphics") {
970 LYXERR0("InsetGraphics::string2params(" << in << ")\n"
971 "Expected arg 1 to be \"graphics\"\n");
975 params = InsetGraphicsParams();
976 readInsetGraphics(lex, buffer.filePath(), params);
980 string InsetGraphics::params2string(InsetGraphicsParams const & params,
981 Buffer const & buffer)
984 data << "graphics" << ' ';
985 params.Write(data, buffer);
986 data << "\\end_inset\n";