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) const
237 files.registerFile(params().filename.absFilename(),
242 void InsetGraphics::updateEmbeddedFile(Buffer const & buf,
243 EmbeddedFile const & file)
245 BOOST_ASSERT(buf.embeddedFiles().enabled());
246 params_.filename = file;
247 LYXERR(Debug::FILES) << "Update InsetGraphic with File "
248 << params_.filename.toFilesystemEncoding()
249 << ", embedding status: "
250 << params_.filename.embedded() << std::endl;
254 void InsetGraphics::edit(Cursor & cur, bool)
256 InsetGraphicsMailer(*this).showDialog(&cur.bv());
260 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
262 graphic_->metrics(mi, dim);
266 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
268 graphic_->draw(pi, x, y);
272 Inset::EDITABLE InsetGraphics::editable() const
278 void InsetGraphics::write(Buffer const & buf, ostream & os) const
281 params().Write(os, buf);
285 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
287 string const token = lex.getString();
289 if (token == "Graphics")
290 readInsetGraphics(lex, buf.filePath());
292 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
294 // InsetGraphics is read, with filename in params_. We do not know if this file actually
295 // exists or is embedded so we need to get the 'availableFile' from buf.embeddedFiles()
296 if (buf.embeddedFiles().enabled()) {
297 EmbeddedFiles::EmbeddedFileList::const_iterator it =
298 buf.embeddedFiles().find(params_.filename.toFilesystemEncoding());
299 if (it != buf.embeddedFiles().end())
300 // using available file, embedded or external, depending on file availability and
302 params_.filename = *it;
304 graphic_->update(params().as_grfxParams());
308 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
310 bool finished = false;
312 while (lex.isOK() && !finished) {
315 string const token = lex.getString();
316 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
321 } else if (token == "\\end_inset") {
324 if (!params_.Read(lex, token, bufpath))
325 lyxerr << "Unknown token, " << token << ", skipping."
332 string const InsetGraphics::createLatexOptions() const
334 // Calculate the options part of the command, we must do it to a string
335 // stream since we might have a trailing comma that we would like to remove
336 // before writing it to the output stream.
337 ostringstream options;
338 if (!params().bb.empty())
339 options << "bb=" << rtrim(params().bb) << ',';
345 double const scl = convert<double>(params().scale);
346 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
347 if (!float_equal(scl, 100.0, 0.05))
348 size << "scale=" << scl / 100.0 << ',';
350 if (!params().width.zero())
351 size << "width=" << params().width.asLatexString() << ',';
352 if (!params().height.zero())
353 size << "height=" << params().height.asLatexString() << ',';
354 if (params().keepAspectRatio)
355 size << "keepaspectratio,";
357 if (params().scaleBeforeRotation && !size.str().empty())
358 options << size.str();
360 // Make sure rotation angle is not very close to zero;
361 // a float can be effectively zero but not exactly zero.
362 if (!params().rotateAngle.empty()
363 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
364 options << "angle=" << params().rotateAngle << ',';
365 if (!params().rotateOrigin.empty()) {
366 options << "origin=" << params().rotateOrigin[0];
367 if (contains(params().rotateOrigin,"Top"))
369 else if (contains(params().rotateOrigin,"Bottom"))
371 else if (contains(params().rotateOrigin,"Baseline"))
376 if (!params().scaleBeforeRotation && !size.str().empty())
377 options << size.str();
379 if (!params().special.empty())
380 options << params().special << ',';
382 string opts = options.str();
384 if (suffixIs(opts, ','))
385 opts = opts.substr(0, opts.size() - 1);
391 docstring const InsetGraphics::toDocbookLength(Length const & len) const
393 odocstringstream result;
394 switch (len.unit()) {
395 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
396 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
398 case Length::PT: // Point = 1/72.27in = 0.351mm
399 result << len.value() * 72 / 72.27 << "pt";
401 case Length::BP: // Big point (72bp = 1in), also PostScript point
402 result << len.value() << "pt";
404 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
405 result << len.value() * 0.376 << "mm";
407 case Length::MM: // Millimeter = 2.845pt
408 result << len.value() << "mm";
410 case Length::PC: // Pica = 12pt = 4.218mm
411 result << len.value() << "pc";
413 case Length::CC: // Cicero = 12dd = 4.531mm
414 result << len.value() * 4.531 << "mm";
416 case Length::CM: // Centimeter = 10mm = 2.371pc
417 result << len.value() << "cm";
419 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
420 result << len.value() << "in";
422 case Length::EX: // Height of a small "x" for the current font.
423 // Obviously we have to compromise here. Any better ratio than 1.5 ?
424 result << len.value() / 1.5 << "em";
426 case Length::EM: // Width of capital "M" in current font.
427 result << len.value() << "em";
429 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
430 result << len.value() * 18 << "em";
432 case Length::PTW: // Percent of TextWidth
433 case Length::PCW: // Percent of ColumnWidth
434 case Length::PPW: // Percent of PageWidth
435 case Length::PLW: // Percent of LineWidth
436 case Length::PTH: // Percent of TextHeight
437 case Length::PPH: // Percent of Paper
438 // Sigh, this will go wrong.
439 result << len.value() << "%";
442 result << len.asDocstring();
448 docstring const InsetGraphics::createDocBookAttributes() const
450 // Calculate the options part of the command, we must do it to a string
451 // stream since we copied the code from createLatexParams() ;-)
453 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
454 // Right now it only works with my version of db2latex :-)
456 odocstringstream options;
457 double const scl = convert<double>(params().scale);
458 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
459 if (!float_equal(scl, 100.0, 0.05))
460 options << " scale=\""
461 << static_cast<int>( (scl) + 0.5 )
464 if (!params().width.zero()) {
465 options << " width=\"" << toDocbookLength(params().width) << "\" ";
467 if (!params().height.zero()) {
468 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
470 if (params().keepAspectRatio) {
471 // This will be irrelevant unless both width and height are set
472 options << "scalefit=\"1\" ";
477 if (!params().special.empty())
478 options << from_ascii(params().special) << " ";
480 // trailing blanks are ok ...
481 return options.str();
495 std::pair<CopyStatus, FileName> const
496 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
498 unsigned long const checksum_in = support::sum(file_in);
499 unsigned long const checksum_out = support::sum(file_out);
501 if (checksum_in == checksum_out)
503 return std::make_pair(IDENTICAL_CONTENTS, file_out);
505 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
506 bool const success = mover.copy(file_in, file_out);
509 LYXERR(Debug::GRAPHICS)
510 << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
511 "into the temporary directory."),
512 from_utf8(file_in.absFilename())))
516 CopyStatus status = success ? SUCCESS : FAILURE;
517 return std::make_pair(status, file_out);
521 std::pair<CopyStatus, FileName> const
522 copyToDirIfNeeded(DocFileName const & file, string const & dir)
524 using support::rtrim;
526 string const file_in = file.absFilename();
527 string const only_path = support::onlyPath(file_in);
528 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
529 return std::make_pair(IDENTICAL_PATHS, file_in);
531 string mangled = file.mangledFilename();
532 if (file.isZipped()) {
533 // We need to change _eps.gz to .eps.gz. The mangled name is
534 // still unique because of the counter in mangledFilename().
535 // We can't just call mangledFilename() with the zip
536 // extension removed, because base.eps and base.eps.gz may
537 // have different content but would get the same mangled
538 // name in this case.
539 string const base = removeExtension(file.unzippedFilename());
540 string::size_type const ext_len = file_in.length() - base.length();
541 mangled[mangled.length() - ext_len] = '.';
543 FileName const file_out(support::makeAbsPath(mangled, dir));
545 return copyFileIfNeeded(file, file_out);
549 string const stripExtensionIfPossible(string const & file, bool nice)
551 // Remove the extension so the LaTeX compiler will use whatever
552 // is appropriate (when there are several versions in different
554 // Do this only if we are not exporting for internal usage, because
555 // pdflatex prefers png over pdf and it would pick up the png images
556 // that we generate for preview.
557 // This works only if the filename contains no dots besides
558 // the just removed one. We can fool here by replacing all
559 // dots with a macro whose definition is just a dot ;-)
560 // The automatic format selection does not work if the file
562 string const latex_name = latex_path(file,
563 support::EXCLUDE_EXTENSION);
564 if (!nice || contains(latex_name, '"'))
566 return latex_path(removeExtension(file),
567 support::PROTECT_EXTENSION,
568 support::ESCAPE_DOTS);
572 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
574 // No conversion is needed. LaTeX can handle the graphic file as is.
575 // This is true even if the orig_file is compressed.
576 string const to_format = formats.getFormat(to)->extension();
577 string const file_format = getExtension(file);
578 // for latex .ps == .eps
579 if (to_format == file_format ||
580 (to_format == "eps" && file_format == "ps") ||
581 (to_format == "ps" && file_format == "eps"))
582 return stripExtensionIfPossible(file, nice);
583 return latex_path(file, support::EXCLUDE_EXTENSION);
589 string const InsetGraphics::prepareFile(Buffer const & buf,
590 OutputParams const & runparams) const
592 // The following code depends on non-empty filenames
593 if (params().filename.empty())
596 string const orig_file = params().filename.absFilename();
597 string const rel_file = params().filename.relFilename(buf.filePath());
599 // previewing source code, no file copying or file format conversion
600 if (runparams.dryrun)
601 return stripExtensionIfPossible(rel_file, runparams.nice);
603 // temp_file will contain the file for LaTeX to act on if, for example,
604 // we move it to a temp dir or uncompress it.
605 FileName temp_file = params().filename;
607 // The master buffer. This is useful when there are multiple levels
609 Buffer const * m_buffer = buf.getMasterBuffer();
611 // Return the output name if we are inside a comment or the file does
613 // We are not going to change the extension or using the name of the
614 // temporary file, the code is already complicated enough.
615 if (runparams.inComment || !isFileReadable(params().filename))
616 return params().filename.outputFilename(m_buffer->filePath());
618 // We place all temporary files in the master buffer's temp dir.
619 // This is possible because we use mangled file names.
620 // This is necessary for DVI export.
621 string const temp_path = m_buffer->temppath();
624 boost::tie(status, temp_file) =
625 copyToDirIfNeeded(params().filename, temp_path);
627 if (status == FAILURE)
630 // a relative filename should be relative to the master buffer.
631 // "nice" means that the buffer is exported to LaTeX format but not
632 // run through the LaTeX compiler.
633 string output_file = runparams.nice ?
634 params().filename.outputFilename(m_buffer->filePath()) :
635 onlyFilename(temp_file.absFilename());
637 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
638 frontend::Alert::warning(_("Invalid filename"),
639 _("The following filename is likely to cause trouble "
640 "when running the exported file through LaTeX: ") +
641 from_utf8(output_file));
644 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
645 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
646 "latex" : "pdflatex";
648 // If the file is compressed and we have specified that it
649 // should not be uncompressed, then just return its name and
650 // let LaTeX do the rest!
651 if (params().filename.isZipped()) {
652 if (params().noUnzip) {
653 // We don't know whether latex can actually handle
654 // this file, but we can't check, because that would
655 // mean to unzip the file and thereby making the
656 // noUnzip parameter meaningless.
657 LYXERR(Debug::GRAPHICS)
658 << "\tpass zipped file to LaTeX.\n";
660 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
661 if (runparams.nice) {
662 runparams.exportdata->addExternalFile(tex_format,
664 changeExtension(output_file, "bb"));
666 // LaTeX needs the bounding box file in the
668 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
669 boost::tie(status, bb_file) =
670 copyFileIfNeeded(bb_orig_file, bb_file);
671 if (status == FAILURE)
673 runparams.exportdata->addExternalFile(tex_format,
676 runparams.exportdata->addExternalFile(tex_format,
677 source_file, output_file);
678 runparams.exportdata->addExternalFile("dvi",
679 source_file, output_file);
680 // We can't strip the extension, because we don't know
681 // the unzipped file format
682 return latex_path(output_file,
683 support::EXCLUDE_EXTENSION);
686 FileName const unzipped_temp_file =
687 FileName(unzippedFileName(temp_file.absFilename()));
688 output_file = unzippedFileName(output_file);
689 source_file = FileName(unzippedFileName(source_file.absFilename()));
690 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
691 // temp_file has been unzipped already and
692 // orig_file has not changed in the meantime.
693 temp_file = unzipped_temp_file;
694 LYXERR(Debug::GRAPHICS)
695 << "\twas already unzipped to " << temp_file
698 // unzipped_temp_file does not exist or is too old
699 temp_file = unzipFile(temp_file);
700 LYXERR(Debug::GRAPHICS)
701 << "\tunzipped to " << temp_file << endl;
705 string const from = formats.getFormatFromFile(temp_file);
707 LYXERR(Debug::GRAPHICS)
708 << "\tCould not get file format." << endl;
710 string const to = findTargetFormat(from, runparams);
711 string const ext = formats.extension(to);
712 LYXERR(Debug::GRAPHICS)
713 << "\t we have: from " << from << " to " << to << '\n';
715 // We're going to be running the exported buffer through the LaTeX
716 // compiler, so must ensure that LaTeX can cope with the graphics
719 LYXERR(Debug::GRAPHICS)
720 << "\tthe orig file is: " << orig_file << endl;
723 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
724 // The LaTeX compiler will not be able to determine
725 // the file format from the extension, so we must
727 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
728 if (support::rename(temp_file, new_file)) {
729 temp_file = new_file;
730 output_file = changeExtension(output_file, ext);
731 source_file = FileName(changeExtension(source_file.absFilename(), ext));
733 LYXERR(Debug::GRAPHICS)
734 << "Could not rename file `"
735 << temp_file << "' to `" << new_file
738 // The extension of temp_file might be != ext!
739 runparams.exportdata->addExternalFile(tex_format, source_file,
741 runparams.exportdata->addExternalFile("dvi", source_file,
743 return stripExtensionIfPossible(output_file, to, runparams.nice);
746 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
747 string const output_to_file = changeExtension(output_file, ext);
749 // Do we need to perform the conversion?
750 // Yes if to_file does not exist or if temp_file is newer than to_file
751 if (compare_timestamps(temp_file, to_file) < 0) {
753 LYXERR(Debug::GRAPHICS)
754 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
755 from_utf8(rel_file)))
757 runparams.exportdata->addExternalFile(tex_format, to_file,
759 runparams.exportdata->addExternalFile("dvi", to_file,
761 return stripExtensionIfPossible(output_to_file, runparams.nice);
764 LYXERR(Debug::GRAPHICS)
765 << "\tThe original file is " << orig_file << "\n"
766 << "\tA copy has been made and convert is to be called with:\n"
767 << "\tfile to convert = " << temp_file << '\n'
768 << "\t from " << from << " to " << to << '\n';
770 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
772 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
774 Converters::try_default | Converters::try_cache)) {
775 runparams.exportdata->addExternalFile(tex_format,
776 to_file, output_to_file);
777 runparams.exportdata->addExternalFile("dvi",
778 to_file, output_to_file);
781 return stripExtensionIfPossible(output_to_file, runparams.nice);
785 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
786 OutputParams const & runparams) const
788 // If there is no file specified or not existing,
789 // just output a message about it in the latex output.
790 LYXERR(Debug::GRAPHICS)
791 << "insetgraphics::latex: Filename = "
792 << params().filename.absFilename() << endl;
794 string const relative_file =
795 params().filename.relFilename(buf.filePath());
797 bool const file_exists = !params().filename.empty() &&
798 isFileReadable(params().filename);
799 string const message = file_exists ?
800 string() : string("bb = 0 0 200 100, draft, type=eps");
801 // if !message.empty() then there was no existing file
802 // "filename" found. In this case LaTeX
803 // draws only a rectangle with the above bb and the
804 // not found filename in it.
805 LYXERR(Debug::GRAPHICS)
806 << "\tMessage = \"" << message << '\"' << endl;
808 // These variables collect all the latex code that should be before and
809 // after the actual includegraphics command.
812 // Do we want subcaptions?
813 if (params().subcaption) {
814 if (runparams.moving_arg)
815 before += "\\protect";
816 before += "\\subfigure[" + params().subcaptionText + "]{";
820 if (runparams.moving_arg)
821 before += "\\protect";
823 // We never use the starred form, we use the "clip" option instead.
824 before += "\\includegraphics";
826 // Write the options if there are any.
827 string const opts = createLatexOptions();
828 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
830 if (!opts.empty() && !message.empty())
831 before += ('[' + opts + ',' + message + ']');
832 else if (!opts.empty() || !message.empty())
833 before += ('[' + opts + message + ']');
835 LYXERR(Debug::GRAPHICS)
836 << "\tBefore = " << before
837 << "\n\tafter = " << after << endl;
839 string latex_str = before + '{';
840 // Convert the file if necessary.
841 // Remove the extension so LaTeX will use whatever is appropriate
842 // (when there are several versions in different formats)
843 latex_str += prepareFile(buf, runparams);
844 latex_str += '}' + after;
846 os << from_utf8(latex_str);
848 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
849 << latex_str << endl;
850 // Return how many newlines we issued.
851 return int(std::count(latex_str.begin(), latex_str.end(),'\n'));
855 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
856 OutputParams const &) const
858 // No graphics in ascii output. Possible to use gifscii to convert
859 // images to ascii approximation.
860 // 1. Convert file to ascii using gifscii
861 // 2. Read ascii output file and add it to the output stream.
862 // at least we send the filename
864 // FIXME: We have no idea what the encoding of the filename is
866 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
867 from_utf8(params().filename.absFilename()));
868 os << '<' << str << '>';
870 return 2 + str.size();
876 int writeImageObject(char const * format,
878 OutputParams const & runparams,
879 docstring const & graphic_label,
880 docstring const & attributes)
882 if (runparams.flavor != OutputParams::XML) {
883 os << "<![ %output.print."
888 os <<"<imageobject><imagedata fileref=\"&"
894 if (runparams.flavor == OutputParams::XML) {
895 os << " role=\"" << format << "\"/>" ;
898 os << " format=\"" << format << "\">" ;
900 os << "</imageobject>";
901 if (runparams.flavor != OutputParams::XML) {
902 os << std::endl << "]]>" ;
904 return runparams.flavor == OutputParams::XML ? 0 : 2;
906 // end anonymous namespace
910 // For explanation on inserting graphics into DocBook checkout:
911 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
912 // See also the docbook guide at http://www.docbook.org/
913 int InsetGraphics::docbook(Buffer const &, odocstream & os,
914 OutputParams const & runparams) const
916 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
917 // need to switch to MediaObject. However, for now this is sufficient and
919 if (runparams.flavor == OutputParams::XML) {
920 runparams.exportdata->addExternalFile("docbook-xml",
923 runparams.exportdata->addExternalFile("docbook",
926 os << "<inlinemediaobject>";
929 docstring attributes = createDocBookAttributes();
930 r += writeImageObject("png", os, runparams, graphic_label, attributes);
931 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
932 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
933 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
935 os << "</inlinemediaobject>";
940 void InsetGraphics::validate(LaTeXFeatures & features) const
942 // If we have no image, we should not require anything.
943 if (params().filename.empty())
946 features.includeFile(graphic_label,
947 removeExtension(params().filename.absFilename()));
949 features.require("graphicx");
951 if (features.runparams().nice) {
952 Buffer const * m_buffer = features.buffer().getMasterBuffer();
953 string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
954 if (contains(rel_file, "."))
955 features.require("lyxdot");
958 if (params().subcaption)
959 features.require("subfigure");
963 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
965 // If nothing is changed, just return and say so.
966 if (params() == p && !p.filename.empty())
969 // Copy the new parameters.
972 // Update the display using the new parameters.
973 graphic_->update(params().as_grfxParams());
975 // We have changed data, report it.
980 InsetGraphicsParams const & InsetGraphics::params() const
986 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
987 Buffer const & buffer) const
989 formats.edit(buffer, p.filename,
990 formats.getFormatFromFile(p.filename));
994 string const InsetGraphicsMailer::name_("graphics");
996 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
1001 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
1003 return params2string(inset_.params(), buffer);
1007 void InsetGraphicsMailer::string2params(string const & in,
1008 Buffer const & buffer,
1009 InsetGraphicsParams & params)
1011 params = InsetGraphicsParams();
1015 istringstream data(in);
1017 lex.setStream(data);
1021 if (!lex || name != name_)
1022 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
1024 InsetGraphics inset;
1025 inset.readInsetGraphics(lex, buffer.filePath());
1026 params = inset.params();
1031 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
1032 Buffer const & buffer)
1035 data << name_ << ' ';
1036 params.Write(data, buffer);
1037 data << "\\end_inset\n";