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 * Add a way to roll the image file into the file format.
19 * When loading, if the image is not found in the expected place, try
20 to find it in the clipart, or in the same directory with the image.
21 * The image choosing dialog could show thumbnails of the image formats
22 it knows of, thus selection based on the image instead of based on
24 * Add support for the 'picins' package.
25 * Add support for the 'picinpar' package.
26 * Improve support for 'subfigure' - Allow to set the various options
32 * The filename is kept in the lyx file in a relative way, so as to allow
33 * moving the document file and its images with no problem.
37 * Postscript output means EPS figures.
39 * PDF output is best done with PDF figures if it's a direct conversion
40 * or PNG figures otherwise.
52 #include "insets/InsetGraphics.h"
53 #include "insets/RenderGraphic.h"
56 #include "BufferView.h"
57 #include "Converter.h"
60 #include "DispatchResult.h"
61 #include "ErrorList.h"
64 #include "FuncRequest.h"
65 #include "FuncStatus.h"
67 #include "LaTeXFeatures.h"
70 #include "MetricsInfo.h"
72 #include "OutputParams.h"
74 #include "EmbeddedFiles.h"
76 #include "frontends/alert.h"
78 #include "support/convert.h"
79 #include "support/filetools.h"
80 #include "support/lyxlib.h" // sum
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>
94 using support::bformat;
95 using support::changeExtension;
96 using support::compare_timestamps;
97 using support::contains;
98 using support::DocFileName;
99 using support::FileName;
100 using support::float_equal;
101 using support::getExtension;
102 using support::isFileReadable;
103 using support::isValidLaTeXFilename;
104 using support::latex_path;
105 using support::onlyFilename;
106 using support::removeExtension;
107 using support::rtrim;
108 using support::subst;
109 using support::suffixIs;
110 using support::Systemcall;
111 using support::unzipFile;
112 using support::unzippedFileName;
116 using std::istringstream;
118 using std::ostringstream;
123 /// Find the most suitable image format for images in \p format
124 /// Note that \p format may be unknown (i. e. an empty string)
125 string findTargetFormat(string const & format, OutputParams const & runparams)
127 // Are we using latex or pdflatex?
128 if (runparams.flavor == OutputParams::PDFLATEX) {
129 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PDF mode" << endl;
130 Format const * const f = formats.getFormat(format);
131 // Convert vector graphics to pdf
132 if (f && f->vectorFormat())
134 // pdflatex can use jpeg, png and pdf directly
137 // Convert everything else to png
140 // If it's postscript, we always do eps.
141 LYXERR(Debug::GRAPHICS) << "findTargetFormat: PostScript mode" << endl;
143 // any other than ps is changed to eps
152 InsetGraphics::InsetGraphics()
153 : graphic_label(sgml::uniqueID(from_ascii("graph"))),
154 graphic_(new RenderGraphic(this))
158 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
160 boost::signals::trackable(),
161 graphic_label(sgml::uniqueID(from_ascii("graph"))),
162 graphic_(new RenderGraphic(*ig.graphic_, this))
164 setParams(ig.params());
168 Inset * InsetGraphics::clone() const
170 return new InsetGraphics(*this);
174 InsetGraphics::~InsetGraphics()
176 InsetGraphicsMailer(*this).hideDialog();
180 void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
182 switch (cmd.action) {
183 case LFUN_GRAPHICS_EDIT: {
184 Buffer const & buffer = cur.bv().buffer();
185 InsetGraphicsParams p;
186 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
187 editGraphics(p, buffer);
191 case LFUN_INSET_MODIFY: {
192 Buffer const & buffer = cur.buffer();
193 InsetGraphicsParams p;
194 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
195 if (!p.filename.empty())
202 case LFUN_INSET_DIALOG_UPDATE:
203 InsetGraphicsMailer(*this).updateDialog(&cur.bv());
206 case LFUN_MOUSE_RELEASE:
207 if (!cur.selection())
208 InsetGraphicsMailer(*this).showDialog(&cur.bv());
212 Inset::doDispatch(cur, cmd);
218 bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
219 FuncStatus & flag) const
221 switch (cmd.action) {
222 case LFUN_GRAPHICS_EDIT:
223 case LFUN_INSET_MODIFY:
224 case LFUN_INSET_DIALOG_UPDATE:
229 return Inset::getStatus(cur, cmd, flag);
234 void InsetGraphics::registerEmbeddedFiles(Buffer const &,
235 EmbeddedFiles & files, ParConstIterator const & pit) const
237 files.registerFile(params().filename.absFilename(),
238 EmbeddedFile::AUTO, pit);
242 void InsetGraphics::edit(Cursor & cur, bool)
244 InsetGraphicsMailer(*this).showDialog(&cur.bv());
248 bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
250 graphic_->metrics(mi, dim);
251 bool const changed = dim_ != dim;
257 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
259 setPosCache(pi, x, y);
260 graphic_->draw(pi, x, y);
264 Inset::EDITABLE InsetGraphics::editable() const
270 void InsetGraphics::write(Buffer const & buf, ostream & os) const
273 params().Write(os, buf.filePath());
277 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
279 string const token = lex.getString();
281 if (token == "Graphics")
282 readInsetGraphics(lex, buf.filePath());
284 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
286 graphic_->update(params().as_grfxParams());
290 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
292 bool finished = false;
294 while (lex.isOK() && !finished) {
297 string const token = lex.getString();
298 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
303 } else if (token == "\\end_inset") {
306 if (!params_.Read(lex, token, bufpath))
307 lyxerr << "Unknown token, " << token << ", skipping."
314 string const InsetGraphics::createLatexOptions() const
316 // Calculate the options part of the command, we must do it to a string
317 // stream since we might have a trailing comma that we would like to remove
318 // before writing it to the output stream.
319 ostringstream options;
320 if (!params().bb.empty())
321 options << "bb=" << rtrim(params().bb) << ',';
327 double const scl = convert<double>(params().scale);
328 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
329 if (!float_equal(scl, 100.0, 0.05))
330 size << "scale=" << scl / 100.0 << ',';
332 if (!params().width.zero())
333 size << "width=" << params().width.asLatexString() << ',';
334 if (!params().height.zero())
335 size << "height=" << params().height.asLatexString() << ',';
336 if (params().keepAspectRatio)
337 size << "keepaspectratio,";
339 if (params().scaleBeforeRotation && !size.str().empty())
340 options << size.str();
342 // Make sure rotation angle is not very close to zero;
343 // a float can be effectively zero but not exactly zero.
344 if (!params().rotateAngle.empty()
345 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
346 options << "angle=" << params().rotateAngle << ',';
347 if (!params().rotateOrigin.empty()) {
348 options << "origin=" << params().rotateOrigin[0];
349 if (contains(params().rotateOrigin,"Top"))
351 else if (contains(params().rotateOrigin,"Bottom"))
353 else if (contains(params().rotateOrigin,"Baseline"))
358 if (!params().scaleBeforeRotation && !size.str().empty())
359 options << size.str();
361 if (!params().special.empty())
362 options << params().special << ',';
364 string opts = options.str();
366 if (suffixIs(opts, ','))
367 opts = opts.substr(0, opts.size() - 1);
373 docstring const InsetGraphics::toDocbookLength(Length const & len) const
375 odocstringstream result;
376 switch (len.unit()) {
377 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
378 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
380 case Length::PT: // Point = 1/72.27in = 0.351mm
381 result << len.value() * 72 / 72.27 << "pt";
383 case Length::BP: // Big point (72bp = 1in), also PostScript point
384 result << len.value() << "pt";
386 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
387 result << len.value() * 0.376 << "mm";
389 case Length::MM: // Millimeter = 2.845pt
390 result << len.value() << "mm";
392 case Length::PC: // Pica = 12pt = 4.218mm
393 result << len.value() << "pc";
395 case Length::CC: // Cicero = 12dd = 4.531mm
396 result << len.value() * 4.531 << "mm";
398 case Length::CM: // Centimeter = 10mm = 2.371pc
399 result << len.value() << "cm";
401 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
402 result << len.value() << "in";
404 case Length::EX: // Height of a small "x" for the current font.
405 // Obviously we have to compromise here. Any better ratio than 1.5 ?
406 result << len.value() / 1.5 << "em";
408 case Length::EM: // Width of capital "M" in current font.
409 result << len.value() << "em";
411 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
412 result << len.value() * 18 << "em";
414 case Length::PTW: // Percent of TextWidth
415 case Length::PCW: // Percent of ColumnWidth
416 case Length::PPW: // Percent of PageWidth
417 case Length::PLW: // Percent of LineWidth
418 case Length::PTH: // Percent of TextHeight
419 case Length::PPH: // Percent of Paper
420 // Sigh, this will go wrong.
421 result << len.value() << "%";
424 result << len.asDocstring();
430 docstring const InsetGraphics::createDocBookAttributes() const
432 // Calculate the options part of the command, we must do it to a string
433 // stream since we copied the code from createLatexParams() ;-)
435 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
436 // Right now it only works with my version of db2latex :-)
438 odocstringstream options;
439 double const scl = convert<double>(params().scale);
440 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
441 if (!float_equal(scl, 100.0, 0.05))
442 options << " scale=\""
443 << static_cast<int>( (scl) + 0.5 )
446 if (!params().width.zero()) {
447 options << " width=\"" << toDocbookLength(params().width) << "\" ";
449 if (!params().height.zero()) {
450 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
452 if (params().keepAspectRatio) {
453 // This will be irrelevant unless both width and height are set
454 options << "scalefit=\"1\" ";
459 if (!params().special.empty())
460 options << from_ascii(params().special) << " ";
462 // trailing blanks are ok ...
463 return options.str();
477 std::pair<CopyStatus, FileName> const
478 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
480 unsigned long const checksum_in = support::sum(file_in);
481 unsigned long const checksum_out = support::sum(file_out);
483 if (checksum_in == checksum_out)
485 return std::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(support::bformat(_("Could not copy the file\n%1$s\n"
493 "into the temporary directory."),
494 from_utf8(file_in.absFilename())))
498 CopyStatus status = success ? SUCCESS : FAILURE;
499 return std::make_pair(status, file_out);
503 std::pair<CopyStatus, FileName> const
504 copyToDirIfNeeded(DocFileName const & file, string const & dir)
506 using support::rtrim;
508 string const file_in = file.absFilename();
509 string const only_path = support::onlyPath(file_in);
510 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
511 return std::make_pair(IDENTICAL_PATHS, file_in);
513 string mangled = file.mangledFilename();
514 if (file.isZipped()) {
515 // We need to change _eps.gz to .eps.gz. The mangled name is
516 // still unique because of the counter in mangledFilename().
517 // We can't just call mangledFilename() with the zip
518 // extension removed, because base.eps and base.eps.gz may
519 // have different content but would get the same mangled
520 // name in this case.
521 string const base = removeExtension(file.unzippedFilename());
522 string::size_type const ext_len = file_in.length() - base.length();
523 mangled[mangled.length() - ext_len] = '.';
525 FileName const file_out(support::makeAbsPath(mangled, dir));
527 return copyFileIfNeeded(file, file_out);
531 string const stripExtensionIfPossible(string const & file, bool nice)
533 // Remove the extension so the LaTeX compiler will use whatever
534 // is appropriate (when there are several versions in different
536 // Do this only if we are not exporting for internal usage, because
537 // pdflatex prefers png over pdf and it would pick up the png images
538 // that we generate for preview.
539 // This works only if the filename contains no dots besides
540 // the just removed one. We can fool here by replacing all
541 // dots with a macro whose definition is just a dot ;-)
542 // The automatic format selection does not work if the file
544 string const latex_name = latex_path(file,
545 support::EXCLUDE_EXTENSION);
546 if (!nice || contains(latex_name, '"'))
548 return latex_path(removeExtension(file),
549 support::PROTECT_EXTENSION,
550 support::ESCAPE_DOTS);
554 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
556 // No conversion is needed. LaTeX can handle the graphic file as is.
557 // This is true even if the orig_file is compressed.
558 string const to_format = formats.getFormat(to)->extension();
559 string const file_format = getExtension(file);
560 // for latex .ps == .eps
561 if (to_format == file_format ||
562 (to_format == "eps" && file_format == "ps") ||
563 (to_format == "ps" && file_format == "eps"))
564 return stripExtensionIfPossible(file, nice);
565 return latex_path(file, support::EXCLUDE_EXTENSION);
571 string const InsetGraphics::prepareFile(Buffer const & buf,
572 OutputParams const & runparams) const
574 // The following code depends on non-empty filenames
575 if (params().filename.empty())
578 string const orig_file = params().filename.absFilename();
579 string const rel_file = params().filename.relFilename(buf.filePath());
581 // previewing source code, no file copying or file format conversion
582 if (runparams.dryrun)
583 return stripExtensionIfPossible(rel_file, runparams.nice);
585 // temp_file will contain the file for LaTeX to act on if, for example,
586 // we move it to a temp dir or uncompress it.
587 FileName temp_file = params().filename;
589 // The master buffer. This is useful when there are multiple levels
591 Buffer const * m_buffer = buf.getMasterBuffer();
593 // Return the output name if we are inside a comment or the file does
595 // We are not going to change the extension or using the name of the
596 // temporary file, the code is already complicated enough.
597 if (runparams.inComment || !isFileReadable(params().filename))
598 return params().filename.outputFilename(m_buffer->filePath());
600 // We place all temporary files in the master buffer's temp dir.
601 // This is possible because we use mangled file names.
602 // This is necessary for DVI export.
603 string const temp_path = m_buffer->temppath();
606 boost::tie(status, temp_file) =
607 copyToDirIfNeeded(params().filename, temp_path);
609 if (status == FAILURE)
612 // a relative filename should be relative to the master
614 // "nice" means that the buffer is exported to LaTeX format but not
615 // run through the LaTeX compiler.
616 string output_file = support::os::external_path(runparams.nice ?
617 params().filename.outputFilename(m_buffer->filePath()) :
618 onlyFilename(temp_file.absFilename()));
620 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
621 frontend::Alert::warning(_("Invalid filename"),
622 _("The following filename is likely to cause trouble "
623 "when running the exported file through LaTeX: ") +
624 from_utf8(output_file));
627 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
628 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
629 "latex" : "pdflatex";
631 // If the file is compressed and we have specified that it
632 // should not be uncompressed, then just return its name and
633 // let LaTeX do the rest!
634 if (params().filename.isZipped()) {
635 if (params().noUnzip) {
636 // We don't know whether latex can actually handle
637 // this file, but we can't check, because that would
638 // mean to unzip the file and thereby making the
639 // noUnzip parameter meaningless.
640 LYXERR(Debug::GRAPHICS)
641 << "\tpass zipped file to LaTeX.\n";
643 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
644 if (runparams.nice) {
645 runparams.exportdata->addExternalFile(tex_format,
647 changeExtension(output_file, "bb"));
649 // LaTeX needs the bounding box file in the
651 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
652 boost::tie(status, bb_file) =
653 copyFileIfNeeded(bb_orig_file, bb_file);
654 if (status == FAILURE)
656 runparams.exportdata->addExternalFile(tex_format,
659 runparams.exportdata->addExternalFile(tex_format,
660 source_file, output_file);
661 runparams.exportdata->addExternalFile("dvi",
662 source_file, output_file);
663 // We can't strip the extension, because we don't know
664 // the unzipped file format
665 return latex_path(output_file,
666 support::EXCLUDE_EXTENSION);
669 FileName const unzipped_temp_file =
670 FileName(unzippedFileName(temp_file.absFilename()));
671 output_file = unzippedFileName(output_file);
672 source_file = FileName(unzippedFileName(source_file.absFilename()));
673 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
674 // temp_file has been unzipped already and
675 // orig_file has not changed in the meantime.
676 temp_file = unzipped_temp_file;
677 LYXERR(Debug::GRAPHICS)
678 << "\twas already unzipped to " << temp_file
681 // unzipped_temp_file does not exist or is too old
682 temp_file = unzipFile(temp_file);
683 LYXERR(Debug::GRAPHICS)
684 << "\tunzipped to " << temp_file << endl;
688 string const from = formats.getFormatFromFile(temp_file);
690 LYXERR(Debug::GRAPHICS)
691 << "\tCould not get file format." << endl;
693 string const to = findTargetFormat(from, runparams);
694 string const ext = formats.extension(to);
695 LYXERR(Debug::GRAPHICS)
696 << "\t we have: from " << from << " to " << to << '\n';
698 // We're going to be running the exported buffer through the LaTeX
699 // compiler, so must ensure that LaTeX can cope with the graphics
702 LYXERR(Debug::GRAPHICS)
703 << "\tthe orig file is: " << orig_file << endl;
706 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
707 // The LaTeX compiler will not be able to determine
708 // the file format from the extension, so we must
710 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
711 if (support::rename(temp_file, new_file)) {
712 temp_file = new_file;
713 output_file = changeExtension(output_file, ext);
714 source_file = FileName(changeExtension(source_file.absFilename(), ext));
716 LYXERR(Debug::GRAPHICS)
717 << "Could not rename file `"
718 << temp_file << "' to `" << new_file
721 // The extension of temp_file might be != ext!
722 runparams.exportdata->addExternalFile(tex_format, source_file,
724 runparams.exportdata->addExternalFile("dvi", source_file,
726 return stripExtensionIfPossible(output_file, to, runparams.nice);
729 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
730 string const output_to_file = changeExtension(output_file, ext);
732 // Do we need to perform the conversion?
733 // Yes if to_file does not exist or if temp_file is newer than to_file
734 if (compare_timestamps(temp_file, to_file) < 0) {
736 LYXERR(Debug::GRAPHICS)
737 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
738 from_utf8(rel_file)))
740 runparams.exportdata->addExternalFile(tex_format, to_file,
742 runparams.exportdata->addExternalFile("dvi", to_file,
744 return stripExtensionIfPossible(output_to_file, runparams.nice);
747 LYXERR(Debug::GRAPHICS)
748 << "\tThe original file is " << orig_file << "\n"
749 << "\tA copy has been made and convert is to be called with:\n"
750 << "\tfile to convert = " << temp_file << '\n'
751 << "\t from " << from << " to " << to << '\n';
753 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
755 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
757 Converters::try_default | Converters::try_cache)) {
758 runparams.exportdata->addExternalFile(tex_format,
759 to_file, output_to_file);
760 runparams.exportdata->addExternalFile("dvi",
761 to_file, output_to_file);
764 return stripExtensionIfPossible(output_to_file, runparams.nice);
768 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
769 OutputParams const & runparams) const
771 // If there is no file specified or not existing,
772 // just output a message about it in the latex output.
773 LYXERR(Debug::GRAPHICS)
774 << "insetgraphics::latex: Filename = "
775 << params().filename.absFilename() << endl;
777 string const relative_file =
778 params().filename.relFilename(buf.filePath());
780 bool const file_exists = !params().filename.empty() &&
781 isFileReadable(params().filename);
782 string const message = file_exists ?
783 string() : string("bb = 0 0 200 100, draft, type=eps");
784 // if !message.empty() then there was no existing file
785 // "filename" found. In this case LaTeX
786 // draws only a rectangle with the above bb and the
787 // not found filename in it.
788 LYXERR(Debug::GRAPHICS)
789 << "\tMessage = \"" << message << '\"' << endl;
791 // These variables collect all the latex code that should be before and
792 // after the actual includegraphics command.
795 // Do we want subcaptions?
796 if (params().subcaption) {
797 if (runparams.moving_arg)
798 before += "\\protect";
799 before += "\\subfigure[" + params().subcaptionText + "]{";
803 if (runparams.moving_arg)
804 before += "\\protect";
806 // We never use the starred form, we use the "clip" option instead.
807 before += "\\includegraphics";
809 // Write the options if there are any.
810 string const opts = createLatexOptions();
811 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
813 if (!opts.empty() && !message.empty())
814 before += ('[' + opts + ',' + message + ']');
815 else if (!opts.empty() || !message.empty())
816 before += ('[' + opts + message + ']');
818 LYXERR(Debug::GRAPHICS)
819 << "\tBefore = " << before
820 << "\n\tafter = " << after << endl;
822 string latex_str = before + '{';
823 // Convert the file if necessary.
824 // Remove the extension so LaTeX will use whatever is appropriate
825 // (when there are several versions in different formats)
826 latex_str += prepareFile(buf, runparams);
827 latex_str += '}' + after;
829 os << from_utf8(latex_str);
831 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
832 << latex_str << endl;
833 // Return how many newlines we issued.
834 return int(std::count(latex_str.begin(), latex_str.end(),'\n'));
838 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
839 OutputParams const &) const
841 // No graphics in ascii output. Possible to use gifscii to convert
842 // images to ascii approximation.
843 // 1. Convert file to ascii using gifscii
844 // 2. Read ascii output file and add it to the output stream.
845 // at least we send the filename
847 // FIXME: We have no idea what the encoding of the filename is
849 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
850 from_utf8(params().filename.absFilename()));
851 os << '<' << str << '>';
853 return 2 + str.size();
859 int writeImageObject(char const * format,
861 OutputParams const & runparams,
862 docstring const & graphic_label,
863 docstring const & attributes)
865 if (runparams.flavor != OutputParams::XML) {
866 os << "<![ %output.print."
871 os <<"<imageobject><imagedata fileref=\"&"
877 if (runparams.flavor == OutputParams::XML) {
878 os << " role=\"" << format << "\"/>" ;
881 os << " format=\"" << format << "\">" ;
883 os << "</imageobject>";
884 if (runparams.flavor != OutputParams::XML) {
885 os << std::endl << "]]>" ;
887 return runparams.flavor == OutputParams::XML ? 0 : 2;
889 // end anonymous namespace
893 // For explanation on inserting graphics into DocBook checkout:
894 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
895 // See also the docbook guide at http://www.docbook.org/
896 int InsetGraphics::docbook(Buffer const &, odocstream & os,
897 OutputParams const & runparams) const
899 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
900 // need to switch to MediaObject. However, for now this is sufficient and
902 if (runparams.flavor == OutputParams::XML) {
903 runparams.exportdata->addExternalFile("docbook-xml",
906 runparams.exportdata->addExternalFile("docbook",
909 os << "<inlinemediaobject>";
912 docstring attributes = createDocBookAttributes();
913 r += writeImageObject("png", os, runparams, graphic_label, attributes);
914 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
915 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
916 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
918 os << "</inlinemediaobject>";
923 void InsetGraphics::validate(LaTeXFeatures & features) const
925 // If we have no image, we should not require anything.
926 if (params().filename.empty())
929 features.includeFile(graphic_label,
930 removeExtension(params().filename.absFilename()));
932 features.require("graphicx");
934 if (features.runparams().nice) {
935 Buffer const * m_buffer = features.buffer().getMasterBuffer();
936 string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
937 if (contains(rel_file, "."))
938 features.require("lyxdot");
941 if (params().subcaption)
942 features.require("subfigure");
946 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
948 // If nothing is changed, just return and say so.
949 if (params() == p && !p.filename.empty())
952 // Copy the new parameters.
955 // Update the display using the new parameters.
956 graphic_->update(params().as_grfxParams());
958 // We have changed data, report it.
963 InsetGraphicsParams const & InsetGraphics::params() const
969 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
970 Buffer const & buffer) const
972 formats.edit(buffer, p.filename,
973 formats.getFormatFromFile(p.filename));
977 string const InsetGraphicsMailer::name_("graphics");
979 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
984 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
986 return params2string(inset_.params(), buffer);
990 void InsetGraphicsMailer::string2params(string const & in,
991 Buffer const & buffer,
992 InsetGraphicsParams & params)
994 params = InsetGraphicsParams();
998 istringstream data(in);
1000 lex.setStream(data);
1004 if (!lex || name != name_)
1005 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
1007 InsetGraphics inset;
1008 inset.readInsetGraphics(lex, buffer.filePath());
1009 params = inset.params();
1014 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
1015 Buffer const & buffer)
1018 data << name_ << ' ';
1019 params.Write(data, buffer.filePath());
1020 data << "\\end_inset\n";