]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetGraphics.cpp
Improve handling of top and bottom margin
[lyx.git] / src / insets / InsetGraphics.cpp
index 02a563067339e1842d94bade9e79a2c3a8f1b549..b4ddd77a1ab795d7261c18b05f7e697920e3b6f5 100644 (file)
@@ -54,6 +54,7 @@ TODO
 #include "Converter.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
+#include "Encoding.h"
 #include "ErrorList.h"
 #include "Exporter.h"
 #include "Format.h"
@@ -66,14 +67,19 @@ TODO
 #include "MetricsInfo.h"
 #include "Mover.h"
 #include "OutputParams.h"
+#include "output_docbook.h"
 #include "output_xhtml.h"
-#include "sgml.h"
+#include "xml.h"
 #include "texstream.h"
 #include "TocBackend.h"
 
 #include "frontends/alert.h"
 #include "frontends/Application.h"
 
+#include "graphics/GraphicsCache.h"
+#include "graphics/GraphicsCacheItem.h"
+#include "graphics/GraphicsImage.h"
+
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
@@ -83,11 +89,13 @@ TODO
 #include "support/lyxlib.h"
 #include "support/lstrings.h"
 #include "support/os.h"
+#include "support/qstring_helpers.h"
 #include "support/Systemcall.h"
 
+#include <QProcess>
+
 #include <algorithm>
 #include <sstream>
-#include <tuple>
 
 using namespace std;
 using namespace lyx::support;
@@ -99,10 +107,10 @@ namespace Alert = frontend::Alert;
 namespace {
 
 /// Find the most suitable image format for images in \p format
-/// Note that \p format may be unknown (i. e. an empty string)
+/// Note that \p format may be unknown (i.e. an empty string)
 string findTargetFormat(string const & format, OutputParams const & runparams)
 {
-       // Are we using latex or XeTeX/LuaTeX/pdflatex?
+       // Are we latexing to DVI or PDF?
        if (runparams.flavor == OutputParams::PDFLATEX
            || runparams.flavor == OutputParams::XETEX
            || runparams.flavor == OutputParams::LUATEX) {
@@ -117,8 +125,9 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
                // Convert everything else to png
                return "png";
        }
-       // for HTML, we leave the known formats and otherwise convert to png
-       if (runparams.flavor == OutputParams::HTML) {
+
+    // for HTML and DocBook, we leave the known formats and otherwise convert to png
+    if (runparams.flavor == OutputParams::HTML || runparams.flavor == OutputParams::DOCBOOK5) {
                Format const * const f = theFormats().getFormat(format);
                // Convert vector graphics to svg
                if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
@@ -169,7 +178,7 @@ void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
 
 
 InsetGraphics::InsetGraphics(Buffer * buf)
-       : Inset(buf), graphic_label(sgml::uniqueID(from_ascii("graph"))),
+       : Inset(buf), graphic_label(xml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(this))
 {
 }
@@ -177,7 +186,7 @@ InsetGraphics::InsetGraphics(Buffer * buf)
 
 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
        : Inset(ig),
-         graphic_label(sgml::uniqueID(from_ascii("graph"))),
+         graphic_label(xml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(*ig.graphic_, this))
 {
        setParams(ig.params());
@@ -304,6 +313,66 @@ void InsetGraphics::read(Lexer & lex)
 }
 
 
+void InsetGraphics::outBoundingBox(graphics::BoundingBox & bbox) const
+{
+       if (bbox.empty())
+               return;
+
+       FileName const file(params().filename.absFileName());
+
+       // No correction is necessary for a postscript image
+       bool const zipped = theFormats().isZippedFile(file);
+       FileName const unzipped_file = zipped ? unzipFile(file) : file;
+       string const format = theFormats().getFormatFromFile(unzipped_file);
+       if (zipped)
+               unzipped_file.removeFile();
+       if (Formats::isPostScriptFileFormat(format))
+               return;
+
+       // Get the actual image dimensions in pixels
+       int width = 0;
+       int height = 0;
+       graphics::Cache & gc = graphics::Cache::get();
+       if (gc.inCache(file)) {
+               graphics::Image const * image = gc.item(file)->image();
+               if (image) {
+                       width  = image->width();
+                       height = image->height();
+               }
+       }
+       if (width == 0 || height == 0)
+               return;
+
+       // Use extractbb to find the dimensions in the typeset output
+       QProcess extractbb;
+       extractbb.start("extractbb", QStringList() << "-O" << toqstr(file.absFileName()));
+       if (!extractbb.waitForStarted() || !extractbb.waitForFinished()) {
+               LYXERR0("Cannot read output bounding box of " << file);
+               return;
+       }
+
+       string const result = extractbb.readAll().constData();
+       size_t i = result.find("%%BoundingBox:");
+       if (i == string::npos) {
+               LYXERR0("Cannot find output bounding box of " << file);
+               return;
+       }
+
+       string const bb = result.substr(i);
+       int out_width = convert<int>(token(bb, ' ', 3));
+       int out_height = convert<int>(token(bb, ' ', 4));
+
+       // Compute the scaling ratio and correct the bounding box
+       double scalex = out_width / double(width);
+       double scaley = out_height / double(height);
+
+       bbox.xl.value(scalex * bbox.xl.value());
+       bbox.xr.value(scalex * bbox.xr.value());
+       bbox.yb.value(scaley * bbox.yb.value());
+       bbox.yt.value(scaley * bbox.yt.value());
+}
+
+
 string InsetGraphics::createLatexOptions(bool const ps) const
 {
        // Calculate the options part of the command, we must do it to a string
@@ -311,11 +380,13 @@ string InsetGraphics::createLatexOptions(bool const ps) const
        // before writing it to the output stream.
        ostringstream options;
        if (!params().bbox.empty()) {
+               graphics::BoundingBox out_bbox = params().bbox;
+               outBoundingBox(out_bbox);
                string const key = ps ? "bb=" : "viewport=";
-               options << key << params().bbox.xl.asLatexString() << ' '
-                       << params().bbox.yb.asLatexString() << ' '
-                       << params().bbox.xr.asLatexString() << ' '
-                       << params().bbox.yt.asLatexString() << ',';
+               options << key << out_bbox.xl.asLatexString() << ' '
+                       << out_bbox.yb.asLatexString() << ' '
+                       << out_bbox.xr.asLatexString() << ' '
+                       << out_bbox.yt.asLatexString() << ',';
        }
        if (params().draft)
            options << "draft,";
@@ -330,7 +401,7 @@ string InsetGraphics::createLatexOptions(bool const ps) const
                if (!params().width.zero())
                        size << "width=" << params().width.asLatexString() << ',';
                if (!params().height.zero())
-                       size << "height=" << params().height.asLatexString() << ',';
+                       size << "totalheight=" << params().height.asLatexString() << ',';
                if (params().keepAspectRatio)
                        size << "keepaspectratio,";
        }
@@ -432,10 +503,6 @@ docstring InsetGraphics::createDocBookAttributes() const
        // Calculate the options part of the command, we must do it to a string
        // stream since we copied the code from createLatexParams() ;-)
 
-       // FIXME: av: need to translate spec -> Docbook XSL spec
-       // (http://www.sagehill.net/docbookxsl/ImageSizing.html)
-       // Right now it only works with my version of db2latex :-)
-
        odocstringstream options;
        double const scl = convert<double>(params().scale);
        if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
@@ -456,7 +523,6 @@ docstring InsetGraphics::createDocBookAttributes() const
                }
        }
 
-
        if (!params().special.empty())
                options << from_ascii(params().special) << " ";
 
@@ -517,8 +583,14 @@ copyToDirIfNeeded(DocFileName const & file, string const & dir)
                // extension removed, because base.eps and base.eps.gz may
                // have different content but would get the same mangled
                // name in this case.
+               // Also take into account that if the name of the zipped file
+               // has no zip extension then the name of the unzipped one is
+               // prefixed by "unzipped_".
                string const base = removeExtension(file.unzippedFileName());
-               string::size_type const ext_len = file_in.length() - base.length();
+               string::size_type const prefix_len =
+                       prefixIs(onlyFileName(base), "unzipped_") ? 9 : 0;
+               string::size_type const ext_len =
+                       file_in.length() + prefix_len - base.length();
                mangled[mangled.length() - ext_len] = '.';
        }
        FileName const file_out(makeAbsPath(mangled, dir));
@@ -551,7 +623,10 @@ string const stripExtensionIfPossible(string const & file, string const & to, bo
 {
        // No conversion is needed. LaTeX can handle the graphic file as is.
        // This is true even if the orig_file is compressed.
-       string const to_format = theFormats().getFormat(to)->extension();
+       Format const * f = theFormats().getFormat(to);
+       if (!f)
+               return latex_path(file, EXCLUDE_EXTENSION);
+       string const to_format = f->extension();
        string const file_format = getExtension(file);
        // for latex .ps == .eps
        if (to_format == file_format ||
@@ -714,9 +789,15 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
 
        // FIXME (Abdel 12/08/06): Is there a need to show these errors?
        ErrorList el;
-       if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
+       Converters::RetVal const rv = 
+           theConverters().convert(&buffer(), temp_file, to_file, params().filename,
                               from, to, el,
-                              Converters::try_default | Converters::try_cache)) {
+                              Converters::try_default | Converters::try_cache);
+       if (rv == Converters::KILLED) {
+               LYXERR0("Graphics preparation killed.");
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+       } else if (rv == Converters::SUCCESS) {
                runparams.exportdata->addExternalFile(tex_format,
                                to_file, output_to_file);
                runparams.exportdata->addExternalFile("dvi",
@@ -760,18 +841,25 @@ void InsetGraphics::latex(otexstream & os,
        string before;
        string after;
 
-       if (runparams.moving_arg)
-               before += "\\protect";
-
-       // We never use the starred form, we use the "clip" option instead.
-       before += "\\includegraphics";
-
        // Write the options if there are any.
        bool const ps = runparams.flavor == OutputParams::LATEX
                || runparams.flavor == OutputParams::DVILUATEX;
        string const opts = createLatexOptions(ps);
        LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
 
+       if (contains(opts, '=') && contains(runparams.active_chars, '=')) {
+               // We have a language that makes = active. Deactivate locally
+               // for keyval option parsing (#2005).
+               before = "\\begingroup\\catcode`\\=12";
+               after = "\\endgroup ";
+       }
+
+       if (runparams.moving_arg)
+               before += "\\protect";
+
+       // We never use the starred form, we use the "clip" option instead.
+       before += "\\includegraphics";
+
        if (!opts.empty() && !message.empty())
                before += ('[' + opts + ',' + message + ']');
        else if (!opts.empty() || !message.empty())
@@ -783,8 +871,43 @@ void InsetGraphics::latex(otexstream & os,
        // Convert the file if necessary.
        // Remove the extension so LaTeX will use whatever is appropriate
        // (when there are several versions in different formats)
-       string file_path = prepareFile(runparams);
-       latex_str += file_path;
+       docstring file_path = from_utf8(prepareFile(runparams));
+       // we can only output characters covered by the current
+       // encoding!
+       docstring uncodable;
+       docstring encodable_file_path;
+       for (size_type i = 0 ; i < file_path.size() ; ++i) {
+               char_type c = file_path[i];
+               try {
+                       if (runparams.encoding->encodable(c))
+                               encodable_file_path += c;
+                       else if (runparams.dryrun) {
+                               encodable_file_path += "<" + _("LyX Warning: ")
+                                               + _("uncodable character") + " '";
+                               encodable_file_path += docstring(1, c);
+                               encodable_file_path += "'>";
+                       } else
+                               uncodable += c;
+               } catch (EncodingException & /* e */) {
+                       if (runparams.dryrun) {
+                               encodable_file_path += "<" + _("LyX Warning: ")
+                                               + _("uncodable character") + " '";
+                               encodable_file_path += docstring(1, c);
+                               encodable_file_path += "'>";
+                       } else
+                               uncodable += c;
+               }
+       }
+       if (!uncodable.empty() && !runparams.silent) {
+               // issue a warning about omitted characters
+               // FIXME: should be passed to the error dialog
+               frontend::Alert::warning(_("Uncodable character in file path"),
+                       bformat(_("The following characters in one of the graphic paths are\n"
+                                 "not representable in the current encoding and have been omitted: %1$s.\n"
+                                 "You need to adapt either the encoding or the path."),
+                       uncodable));
+       }
+       latex_str += to_utf8(encodable_file_path);
        latex_str += '}' + after;
        // FIXME UNICODE
        os << from_utf8(latex_str);
@@ -812,62 +935,24 @@ int InsetGraphics::plaintext(odocstringstream & os,
 }
 
 
-static int writeImageObject(char const * format, odocstream & os,
-       OutputParams const & runparams, docstring const & graphic_label,
-       docstring const & attributes)
-{
-       if (runparams.flavor != OutputParams::XML)
-               os << "<![ %output.print." << format
-                        << "; [" << endl;
-
-       os <<"<imageobject><imagedata fileref=\"&"
-                << graphic_label
-                << ";."
-                << format
-                << "\" "
-                << attributes;
-
-       if (runparams.flavor == OutputParams::XML)
-               os <<  " role=\"" << format << "\"/>" ;
-       else
-               os << " format=\"" << format << "\">" ;
-
-       os << "</imageobject>";
-
-       if (runparams.flavor != OutputParams::XML)
-               os << endl << "]]>" ;
-
-       return runparams.flavor == OutputParams::XML ? 0 : 2;
-}
-
-
 // For explanation on inserting graphics into DocBook checkout:
 // http://en.tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html
 // See also the docbook guide at http://www.docbook.org/
-int InsetGraphics::docbook(odocstream & os,
-                          OutputParams const & runparams) const
+void InsetGraphics::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
-       // need to switch to MediaObject. However, for now this is sufficient and
-       // easier to use.
-       if (runparams.flavor == OutputParams::XML)
-               runparams.exportdata->addExternalFile("docbook-xml",
-                                                     params().filename);
-       else
-               runparams.exportdata->addExternalFile("docbook",
-                                                     params().filename);
-
-       os << "<inlinemediaobject>";
-
-       int r = 0;
-       docstring attributes = createDocBookAttributes();
-       r += writeImageObject("png", os, runparams, graphic_label, attributes);
-       r += writeImageObject("pdf", os, runparams, graphic_label, attributes);
-       r += writeImageObject("eps", os, runparams, graphic_label, attributes);
-       r += writeImageObject("bmp", os, runparams, graphic_label, attributes);
-
-       os << "</inlinemediaobject>";
-       return r;
+       string fn = params().filename.relFileName(runparams.export_folder);
+       string tag = runparams.docbook_in_float ? "mediaobject" : "inlinemediaobject";
+
+       xs << xml::StartTag(tag);
+       xs << xml::CR();
+       xs << xml::StartTag("imageobject");
+       xs << xml::CR();
+       xs << xml::CompTag("imagedata", "fileref=\"" + fn + "\" " + to_utf8(createDocBookAttributes()));
+       xs << xml::CR();
+       xs << xml::EndTag("imageobject");
+       xs << xml::CR();
+       xs << xml::EndTag(tag);
+       xs << xml::CR();
 }
 
 
@@ -939,17 +1024,22 @@ string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
 
        // FIXME (Abdel 12/08/06): Is there a need to show these errors?
        ErrorList el;
-       bool const success =
+       Converters::RetVal const rv =
                theConverters().convert(&buffer(), temp_file, to_file, params().filename,
                        from, to, el, Converters::try_default | Converters::try_cache);
-       if (!success)
+       if (rv == Converters::KILLED) {
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+               return string();
+       }
+       if (rv != Converters::SUCCESS)
                return string();
        runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
        return output_to_file;
 }
 
 
-docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
+docstring InsetGraphics::xhtml(XMLStream & xs, OutputParams const & op) const
 {
        string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
 
@@ -958,7 +1048,7 @@ docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
                        << params().filename << "' for output. File missing?");
                string const attr = "src='" + params().filename.absFileName()
                                    + "' alt='image: " + output_file + "'";
-               xs << html::CompTag("img", attr);
+               xs << xml::CompTag("img", attr);
                return docstring();
        }
 
@@ -986,7 +1076,7 @@ docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
 
        string const attr = imgstyle + "src='" + output_file + "' alt='image: "
                            + output_file + "'";
-       xs << html::CompTag("img", attr);
+       xs << xml::CompTag("img", attr);
        return docstring();
 }
 
@@ -1007,6 +1097,10 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
                if (contains(rel_file, "."))
                        features.require("lyxdot");
        }
+       if (features.inDeletedInset()) {
+               features.require("tikz");
+               features.require("ct-tikz-object-sout");
+       }
 }