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 bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
262 graphic_->metrics(mi, dim);
263 bool const changed = dim_ != dim;
269 void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
271 graphic_->draw(pi, x, y);
275 Inset::EDITABLE InsetGraphics::editable() const
281 void InsetGraphics::write(Buffer const & buf, ostream & os) const
284 params().Write(os, buf);
288 void InsetGraphics::read(Buffer const & buf, Lexer & lex)
290 string const token = lex.getString();
292 if (token == "Graphics")
293 readInsetGraphics(lex, buf.filePath());
295 LYXERR(Debug::GRAPHICS) << "Not a Graphics inset!" << endl;
297 // InsetGraphics is read, with filename in params_. We do not know if this file actually
298 // exists or is embedded so we need to get the 'availableFile' from buf.embeddedFiles()
299 if (buf.embeddedFiles().enabled()) {
300 EmbeddedFiles::EmbeddedFileList::const_iterator it =
301 buf.embeddedFiles().find(params_.filename.toFilesystemEncoding());
302 if (it != buf.embeddedFiles().end())
303 // using available file, embedded or external, depending on file availability and
305 params_.filename = *it;
307 graphic_->update(params().as_grfxParams());
311 void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
313 bool finished = false;
315 while (lex.isOK() && !finished) {
318 string const token = lex.getString();
319 LYXERR(Debug::GRAPHICS) << "Token: '" << token << '\''
324 } else if (token == "\\end_inset") {
327 if (!params_.Read(lex, token, bufpath))
328 lyxerr << "Unknown token, " << token << ", skipping."
335 string const InsetGraphics::createLatexOptions() const
337 // Calculate the options part of the command, we must do it to a string
338 // stream since we might have a trailing comma that we would like to remove
339 // before writing it to the output stream.
340 ostringstream options;
341 if (!params().bb.empty())
342 options << "bb=" << rtrim(params().bb) << ',';
348 double const scl = convert<double>(params().scale);
349 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
350 if (!float_equal(scl, 100.0, 0.05))
351 size << "scale=" << scl / 100.0 << ',';
353 if (!params().width.zero())
354 size << "width=" << params().width.asLatexString() << ',';
355 if (!params().height.zero())
356 size << "height=" << params().height.asLatexString() << ',';
357 if (params().keepAspectRatio)
358 size << "keepaspectratio,";
360 if (params().scaleBeforeRotation && !size.str().empty())
361 options << size.str();
363 // Make sure rotation angle is not very close to zero;
364 // a float can be effectively zero but not exactly zero.
365 if (!params().rotateAngle.empty()
366 && !float_equal(convert<double>(params().rotateAngle), 0.0, 0.001)) {
367 options << "angle=" << params().rotateAngle << ',';
368 if (!params().rotateOrigin.empty()) {
369 options << "origin=" << params().rotateOrigin[0];
370 if (contains(params().rotateOrigin,"Top"))
372 else if (contains(params().rotateOrigin,"Bottom"))
374 else if (contains(params().rotateOrigin,"Baseline"))
379 if (!params().scaleBeforeRotation && !size.str().empty())
380 options << size.str();
382 if (!params().special.empty())
383 options << params().special << ',';
385 string opts = options.str();
387 if (suffixIs(opts, ','))
388 opts = opts.substr(0, opts.size() - 1);
394 docstring const InsetGraphics::toDocbookLength(Length const & len) const
396 odocstringstream result;
397 switch (len.unit()) {
398 case Length::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
399 result << len.value() * 65536.0 * 72 / 72.27 << "pt";
401 case Length::PT: // Point = 1/72.27in = 0.351mm
402 result << len.value() * 72 / 72.27 << "pt";
404 case Length::BP: // Big point (72bp = 1in), also PostScript point
405 result << len.value() << "pt";
407 case Length::DD: // Didot point = 1/72 of a French inch, = 0.376mm
408 result << len.value() * 0.376 << "mm";
410 case Length::MM: // Millimeter = 2.845pt
411 result << len.value() << "mm";
413 case Length::PC: // Pica = 12pt = 4.218mm
414 result << len.value() << "pc";
416 case Length::CC: // Cicero = 12dd = 4.531mm
417 result << len.value() * 4.531 << "mm";
419 case Length::CM: // Centimeter = 10mm = 2.371pc
420 result << len.value() << "cm";
422 case Length::IN: // Inch = 25.4mm = 72.27pt = 6.022pc
423 result << len.value() << "in";
425 case Length::EX: // Height of a small "x" for the current font.
426 // Obviously we have to compromise here. Any better ratio than 1.5 ?
427 result << len.value() / 1.5 << "em";
429 case Length::EM: // Width of capital "M" in current font.
430 result << len.value() << "em";
432 case Length::MU: // Math unit (18mu = 1em) for positioning in math mode
433 result << len.value() * 18 << "em";
435 case Length::PTW: // Percent of TextWidth
436 case Length::PCW: // Percent of ColumnWidth
437 case Length::PPW: // Percent of PageWidth
438 case Length::PLW: // Percent of LineWidth
439 case Length::PTH: // Percent of TextHeight
440 case Length::PPH: // Percent of Paper
441 // Sigh, this will go wrong.
442 result << len.value() << "%";
445 result << len.asDocstring();
451 docstring const InsetGraphics::createDocBookAttributes() const
453 // Calculate the options part of the command, we must do it to a string
454 // stream since we copied the code from createLatexParams() ;-)
456 // FIXME: av: need to translate spec -> Docbook XSL spec (http://www.sagehill.net/docbookxsl/ImageSizing.html)
457 // Right now it only works with my version of db2latex :-)
459 odocstringstream options;
460 double const scl = convert<double>(params().scale);
461 if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
462 if (!float_equal(scl, 100.0, 0.05))
463 options << " scale=\""
464 << static_cast<int>( (scl) + 0.5 )
467 if (!params().width.zero()) {
468 options << " width=\"" << toDocbookLength(params().width) << "\" ";
470 if (!params().height.zero()) {
471 options << " depth=\"" << toDocbookLength(params().height) << "\" ";
473 if (params().keepAspectRatio) {
474 // This will be irrelevant unless both width and height are set
475 options << "scalefit=\"1\" ";
480 if (!params().special.empty())
481 options << from_ascii(params().special) << " ";
483 // trailing blanks are ok ...
484 return options.str();
498 std::pair<CopyStatus, FileName> const
499 copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
501 unsigned long const checksum_in = support::sum(file_in);
502 unsigned long const checksum_out = support::sum(file_out);
504 if (checksum_in == checksum_out)
506 return std::make_pair(IDENTICAL_CONTENTS, file_out);
508 Mover const & mover = getMover(formats.getFormatFromFile(file_in));
509 bool const success = mover.copy(file_in, file_out);
512 LYXERR(Debug::GRAPHICS)
513 << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
514 "into the temporary directory."),
515 from_utf8(file_in.absFilename())))
519 CopyStatus status = success ? SUCCESS : FAILURE;
520 return std::make_pair(status, file_out);
524 std::pair<CopyStatus, FileName> const
525 copyToDirIfNeeded(DocFileName const & file, string const & dir)
527 using support::rtrim;
529 string const file_in = file.absFilename();
530 string const only_path = support::onlyPath(file_in);
531 if (rtrim(support::onlyPath(file_in) , "/") == rtrim(dir, "/"))
532 return std::make_pair(IDENTICAL_PATHS, file_in);
534 string mangled = file.mangledFilename();
535 if (file.isZipped()) {
536 // We need to change _eps.gz to .eps.gz. The mangled name is
537 // still unique because of the counter in mangledFilename().
538 // We can't just call mangledFilename() with the zip
539 // extension removed, because base.eps and base.eps.gz may
540 // have different content but would get the same mangled
541 // name in this case.
542 string const base = removeExtension(file.unzippedFilename());
543 string::size_type const ext_len = file_in.length() - base.length();
544 mangled[mangled.length() - ext_len] = '.';
546 FileName const file_out(support::makeAbsPath(mangled, dir));
548 return copyFileIfNeeded(file, file_out);
552 string const stripExtensionIfPossible(string const & file, bool nice)
554 // Remove the extension so the LaTeX compiler will use whatever
555 // is appropriate (when there are several versions in different
557 // Do this only if we are not exporting for internal usage, because
558 // pdflatex prefers png over pdf and it would pick up the png images
559 // that we generate for preview.
560 // This works only if the filename contains no dots besides
561 // the just removed one. We can fool here by replacing all
562 // dots with a macro whose definition is just a dot ;-)
563 // The automatic format selection does not work if the file
565 string const latex_name = latex_path(file,
566 support::EXCLUDE_EXTENSION);
567 if (!nice || contains(latex_name, '"'))
569 return latex_path(removeExtension(file),
570 support::PROTECT_EXTENSION,
571 support::ESCAPE_DOTS);
575 string const stripExtensionIfPossible(string const & file, string const & to, bool nice)
577 // No conversion is needed. LaTeX can handle the graphic file as is.
578 // This is true even if the orig_file is compressed.
579 string const to_format = formats.getFormat(to)->extension();
580 string const file_format = getExtension(file);
581 // for latex .ps == .eps
582 if (to_format == file_format ||
583 (to_format == "eps" && file_format == "ps") ||
584 (to_format == "ps" && file_format == "eps"))
585 return stripExtensionIfPossible(file, nice);
586 return latex_path(file, support::EXCLUDE_EXTENSION);
592 string const InsetGraphics::prepareFile(Buffer const & buf,
593 OutputParams const & runparams) const
595 // The following code depends on non-empty filenames
596 if (params().filename.empty())
599 string const orig_file = params().filename.absFilename();
600 string const rel_file = params().filename.relFilename(buf.filePath());
602 // previewing source code, no file copying or file format conversion
603 if (runparams.dryrun)
604 return stripExtensionIfPossible(rel_file, runparams.nice);
606 // temp_file will contain the file for LaTeX to act on if, for example,
607 // we move it to a temp dir or uncompress it.
608 FileName temp_file = params().filename;
610 // The master buffer. This is useful when there are multiple levels
612 Buffer const * m_buffer = buf.getMasterBuffer();
614 // Return the output name if we are inside a comment or the file does
616 // We are not going to change the extension or using the name of the
617 // temporary file, the code is already complicated enough.
618 if (runparams.inComment || !isFileReadable(params().filename))
619 return params().filename.outputFilename(m_buffer->filePath());
621 // We place all temporary files in the master buffer's temp dir.
622 // This is possible because we use mangled file names.
623 // This is necessary for DVI export.
624 string const temp_path = m_buffer->temppath();
627 boost::tie(status, temp_file) =
628 copyToDirIfNeeded(params().filename, temp_path);
630 if (status == FAILURE)
633 // a relative filename should be relative to the master
635 // "nice" means that the buffer is exported to LaTeX format but not
636 // run through the LaTeX compiler.
637 string output_file = support::os::external_path(runparams.nice ?
638 params().filename.outputFilename(m_buffer->filePath()) :
639 onlyFilename(temp_file.absFilename()));
641 if (runparams.nice && !isValidLaTeXFilename(output_file)) {
642 frontend::Alert::warning(_("Invalid filename"),
643 _("The following filename is likely to cause trouble "
644 "when running the exported file through LaTeX: ") +
645 from_utf8(output_file));
648 FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
649 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
650 "latex" : "pdflatex";
652 // If the file is compressed and we have specified that it
653 // should not be uncompressed, then just return its name and
654 // let LaTeX do the rest!
655 if (params().filename.isZipped()) {
656 if (params().noUnzip) {
657 // We don't know whether latex can actually handle
658 // this file, but we can't check, because that would
659 // mean to unzip the file and thereby making the
660 // noUnzip parameter meaningless.
661 LYXERR(Debug::GRAPHICS)
662 << "\tpass zipped file to LaTeX.\n";
664 FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
665 if (runparams.nice) {
666 runparams.exportdata->addExternalFile(tex_format,
668 changeExtension(output_file, "bb"));
670 // LaTeX needs the bounding box file in the
672 FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
673 boost::tie(status, bb_file) =
674 copyFileIfNeeded(bb_orig_file, bb_file);
675 if (status == FAILURE)
677 runparams.exportdata->addExternalFile(tex_format,
680 runparams.exportdata->addExternalFile(tex_format,
681 source_file, output_file);
682 runparams.exportdata->addExternalFile("dvi",
683 source_file, output_file);
684 // We can't strip the extension, because we don't know
685 // the unzipped file format
686 return latex_path(output_file,
687 support::EXCLUDE_EXTENSION);
690 FileName const unzipped_temp_file =
691 FileName(unzippedFileName(temp_file.absFilename()));
692 output_file = unzippedFileName(output_file);
693 source_file = FileName(unzippedFileName(source_file.absFilename()));
694 if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
695 // temp_file has been unzipped already and
696 // orig_file has not changed in the meantime.
697 temp_file = unzipped_temp_file;
698 LYXERR(Debug::GRAPHICS)
699 << "\twas already unzipped to " << temp_file
702 // unzipped_temp_file does not exist or is too old
703 temp_file = unzipFile(temp_file);
704 LYXERR(Debug::GRAPHICS)
705 << "\tunzipped to " << temp_file << endl;
709 string const from = formats.getFormatFromFile(temp_file);
711 LYXERR(Debug::GRAPHICS)
712 << "\tCould not get file format." << endl;
714 string const to = findTargetFormat(from, runparams);
715 string const ext = formats.extension(to);
716 LYXERR(Debug::GRAPHICS)
717 << "\t we have: from " << from << " to " << to << '\n';
719 // We're going to be running the exported buffer through the LaTeX
720 // compiler, so must ensure that LaTeX can cope with the graphics
723 LYXERR(Debug::GRAPHICS)
724 << "\tthe orig file is: " << orig_file << endl;
727 if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
728 // The LaTeX compiler will not be able to determine
729 // the file format from the extension, so we must
731 FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
732 if (support::rename(temp_file, new_file)) {
733 temp_file = new_file;
734 output_file = changeExtension(output_file, ext);
735 source_file = FileName(changeExtension(source_file.absFilename(), ext));
737 LYXERR(Debug::GRAPHICS)
738 << "Could not rename file `"
739 << temp_file << "' to `" << new_file
742 // The extension of temp_file might be != ext!
743 runparams.exportdata->addExternalFile(tex_format, source_file,
745 runparams.exportdata->addExternalFile("dvi", source_file,
747 return stripExtensionIfPossible(output_file, to, runparams.nice);
750 FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
751 string const output_to_file = changeExtension(output_file, ext);
753 // Do we need to perform the conversion?
754 // Yes if to_file does not exist or if temp_file is newer than to_file
755 if (compare_timestamps(temp_file, to_file) < 0) {
757 LYXERR(Debug::GRAPHICS)
758 << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
759 from_utf8(rel_file)))
761 runparams.exportdata->addExternalFile(tex_format, to_file,
763 runparams.exportdata->addExternalFile("dvi", to_file,
765 return stripExtensionIfPossible(output_to_file, runparams.nice);
768 LYXERR(Debug::GRAPHICS)
769 << "\tThe original file is " << orig_file << "\n"
770 << "\tA copy has been made and convert is to be called with:\n"
771 << "\tfile to convert = " << temp_file << '\n'
772 << "\t from " << from << " to " << to << '\n';
774 // FIXME (Abdel 12/08/06): Is there a need to show these errors?
776 if (theConverters().convert(&buf, temp_file, to_file, params().filename,
778 Converters::try_default | Converters::try_cache)) {
779 runparams.exportdata->addExternalFile(tex_format,
780 to_file, output_to_file);
781 runparams.exportdata->addExternalFile("dvi",
782 to_file, output_to_file);
785 return stripExtensionIfPossible(output_to_file, runparams.nice);
789 int InsetGraphics::latex(Buffer const & buf, odocstream & os,
790 OutputParams const & runparams) const
792 // If there is no file specified or not existing,
793 // just output a message about it in the latex output.
794 LYXERR(Debug::GRAPHICS)
795 << "insetgraphics::latex: Filename = "
796 << params().filename.absFilename() << endl;
798 string const relative_file =
799 params().filename.relFilename(buf.filePath());
801 bool const file_exists = !params().filename.empty() &&
802 isFileReadable(params().filename);
803 string const message = file_exists ?
804 string() : string("bb = 0 0 200 100, draft, type=eps");
805 // if !message.empty() then there was no existing file
806 // "filename" found. In this case LaTeX
807 // draws only a rectangle with the above bb and the
808 // not found filename in it.
809 LYXERR(Debug::GRAPHICS)
810 << "\tMessage = \"" << message << '\"' << endl;
812 // These variables collect all the latex code that should be before and
813 // after the actual includegraphics command.
816 // Do we want subcaptions?
817 if (params().subcaption) {
818 if (runparams.moving_arg)
819 before += "\\protect";
820 before += "\\subfigure[" + params().subcaptionText + "]{";
824 if (runparams.moving_arg)
825 before += "\\protect";
827 // We never use the starred form, we use the "clip" option instead.
828 before += "\\includegraphics";
830 // Write the options if there are any.
831 string const opts = createLatexOptions();
832 LYXERR(Debug::GRAPHICS) << "\tOpts = " << opts << endl;
834 if (!opts.empty() && !message.empty())
835 before += ('[' + opts + ',' + message + ']');
836 else if (!opts.empty() || !message.empty())
837 before += ('[' + opts + message + ']');
839 LYXERR(Debug::GRAPHICS)
840 << "\tBefore = " << before
841 << "\n\tafter = " << after << endl;
843 string latex_str = before + '{';
844 // Convert the file if necessary.
845 // Remove the extension so LaTeX will use whatever is appropriate
846 // (when there are several versions in different formats)
847 latex_str += prepareFile(buf, runparams);
848 latex_str += '}' + after;
850 os << from_utf8(latex_str);
852 LYXERR(Debug::GRAPHICS) << "InsetGraphics::latex outputting:\n"
853 << latex_str << endl;
854 // Return how many newlines we issued.
855 return int(std::count(latex_str.begin(), latex_str.end(),'\n'));
859 int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
860 OutputParams const &) const
862 // No graphics in ascii output. Possible to use gifscii to convert
863 // images to ascii approximation.
864 // 1. Convert file to ascii using gifscii
865 // 2. Read ascii output file and add it to the output stream.
866 // at least we send the filename
868 // FIXME: We have no idea what the encoding of the filename is
870 docstring const str = bformat(buf.B_("Graphics file: %1$s"),
871 from_utf8(params().filename.absFilename()));
872 os << '<' << str << '>';
874 return 2 + str.size();
880 int writeImageObject(char const * format,
882 OutputParams const & runparams,
883 docstring const & graphic_label,
884 docstring const & attributes)
886 if (runparams.flavor != OutputParams::XML) {
887 os << "<![ %output.print."
892 os <<"<imageobject><imagedata fileref=\"&"
898 if (runparams.flavor == OutputParams::XML) {
899 os << " role=\"" << format << "\"/>" ;
902 os << " format=\"" << format << "\">" ;
904 os << "</imageobject>";
905 if (runparams.flavor != OutputParams::XML) {
906 os << std::endl << "]]>" ;
908 return runparams.flavor == OutputParams::XML ? 0 : 2;
910 // end anonymous namespace
914 // For explanation on inserting graphics into DocBook checkout:
915 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
916 // See also the docbook guide at http://www.docbook.org/
917 int InsetGraphics::docbook(Buffer const &, odocstream & os,
918 OutputParams const & runparams) const
920 // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
921 // need to switch to MediaObject. However, for now this is sufficient and
923 if (runparams.flavor == OutputParams::XML) {
924 runparams.exportdata->addExternalFile("docbook-xml",
927 runparams.exportdata->addExternalFile("docbook",
930 os << "<inlinemediaobject>";
933 docstring attributes = createDocBookAttributes();
934 r += writeImageObject("png", os, runparams, graphic_label, attributes);
935 r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
936 r += writeImageObject("eps", os, runparams, graphic_label, attributes);
937 r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
939 os << "</inlinemediaobject>";
944 void InsetGraphics::validate(LaTeXFeatures & features) const
946 // If we have no image, we should not require anything.
947 if (params().filename.empty())
950 features.includeFile(graphic_label,
951 removeExtension(params().filename.absFilename()));
953 features.require("graphicx");
955 if (features.runparams().nice) {
956 Buffer const * m_buffer = features.buffer().getMasterBuffer();
957 string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
958 if (contains(rel_file, "."))
959 features.require("lyxdot");
962 if (params().subcaption)
963 features.require("subfigure");
967 bool InsetGraphics::setParams(InsetGraphicsParams const & p)
969 // If nothing is changed, just return and say so.
970 if (params() == p && !p.filename.empty())
973 // Copy the new parameters.
976 // Update the display using the new parameters.
977 graphic_->update(params().as_grfxParams());
979 // We have changed data, report it.
984 InsetGraphicsParams const & InsetGraphics::params() const
990 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
991 Buffer const & buffer) const
993 formats.edit(buffer, p.filename,
994 formats.getFormatFromFile(p.filename));
998 string const InsetGraphicsMailer::name_("graphics");
1000 InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
1005 string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
1007 return params2string(inset_.params(), buffer);
1011 void InsetGraphicsMailer::string2params(string const & in,
1012 Buffer const & buffer,
1013 InsetGraphicsParams & params)
1015 params = InsetGraphicsParams();
1019 istringstream data(in);
1021 lex.setStream(data);
1025 if (!lex || name != name_)
1026 return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
1028 InsetGraphics inset;
1029 inset.readInsetGraphics(lex, buffer.filePath());
1030 params = inset.params();
1035 InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
1036 Buffer const & buffer)
1039 data << name_ << ' ';
1040 params.Write(data, buffer);
1041 data << "\\end_inset\n";