]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetGraphics.cpp
Do not scan BibTeX files multiple times in a collectBibKeys() procedure.
[lyx.git] / src / insets / InsetGraphics.cpp
index 7e18ec67c208315d76c4cbbddfbe9887f47b00e5..94182a73269fa5585adf4cce8de06e6d5d149b59 100644 (file)
@@ -68,6 +68,7 @@ TODO
 #include "OutputParams.h"
 #include "output_xhtml.h"
 #include "sgml.h"
+#include "texstream.h"
 #include "TocBackend.h"
 
 #include "frontends/alert.h"
@@ -84,10 +85,9 @@ TODO
 #include "support/os.h"
 #include "support/Systemcall.h"
 
-#include <boost/tuple/tuple.hpp>
-
 #include <algorithm>
 #include <sstream>
+#include <tuple>
 
 using namespace std;
 using namespace lyx::support;
@@ -107,7 +107,7 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
            || runparams.flavor == OutputParams::XETEX
            || runparams.flavor == OutputParams::LUATEX) {
                LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
-               Format const * const f = formats.getFormat(format);
+               Format const * const f = theFormats().getFormat(format);
                // Convert vector graphics to pdf
                if (f && f->vectorFormat())
                        return "pdf6";
@@ -119,8 +119,14 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
        }
        // for HTML, we leave the known formats and otherwise convert to png
        if (runparams.flavor == OutputParams::HTML) {
+               Format const * const f = theFormats().getFormat(format);
+               // Convert vector graphics to svg
+               if (f && f->vectorFormat() && theConverters().isReachable(format, "svg"))
+                       return "svg";
+               // Leave the known formats alone
                if (format == "jpg" || format == "png" || format == "gif")
                        return format;
+               // Convert everything else to png
                return "png";
        }
        // If it's postscript, we always do eps.
@@ -133,7 +139,7 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
 }
 
 
-void readInsetGraphics(Lexer & lex, string const & bufpath,
+void readInsetGraphics(Lexer & lex, Buffer const & buf, bool allowOrigin,
        InsetGraphicsParams & params)
 {
        bool finished = false;
@@ -150,7 +156,7 @@ void readInsetGraphics(Lexer & lex, string const & bufpath,
                if (token == "\\end_inset") {
                        finished = true;
                } else {
-                       if (!params.Read(lex, token, bufpath))
+                       if (!params.Read(lex, token, buf, allowOrigin))
                                lyxerr << "Unknown token, "
                                       << token
                                       << ", skipping."
@@ -159,7 +165,7 @@ void readInsetGraphics(Lexer & lex, string const & bufpath,
        }
 }
 
-} // namespace anon
+} // namespace
 
 
 InsetGraphics::InsetGraphics(Buffer * buf)
@@ -220,7 +226,7 @@ void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
                // if the inset is part of a graphics group, all the
                // other members should be updated too.
                if (!params_.groupId.empty())
-                       graphics::unifyGraphicsGroups(buffer(), 
+                       graphics::unifyGraphicsGroups(buffer(),
                                                      to_utf8(cmd.argument()));
                break;
        }
@@ -293,19 +299,24 @@ void InsetGraphics::read(Lexer & lex)
 {
        lex.setContext("InsetGraphics::read");
        //lex >> "Graphics";
-       readInsetGraphics(lex, buffer().originFilePath(), params_);
+       readInsetGraphics(lex, buffer(), true, params_);
        graphic_->update(params().as_grfxParams());
 }
 
 
-string InsetGraphics::createLatexOptions() const
+string InsetGraphics::createLatexOptions(bool const ps) const
 {
        // Calculate the options part of the command, we must do it to a string
        // stream since we might have a trailing comma that we would like to remove
        // before writing it to the output stream.
        ostringstream options;
-       if (!params().bb.empty())
-           options << "bb=" << rtrim(params().bb) << ',';
+       if (!params().bbox.empty()) {
+               string const key = ps ? "bb=" : "viewport=";
+               options << key << params().bbox.xl.asLatexString() << ' '
+                       << params().bbox.yb.asLatexString() << ' '
+                       << params().bbox.xr.asLatexString() << ' '
+                       << params().bbox.yt.asLatexString() << ',';
+       }
        if (params().draft)
            options << "draft,";
        if (params().clip)
@@ -404,6 +415,7 @@ docstring InsetGraphics::toDocbookLength(Length const & len) const
                case Length::PLW: // Percent of LineWidth
                case Length::PTH: // Percent of TextHeight
                case Length::PPH: // Percent of PaperHeight
+               case Length::BLS: // Percent of BaselineSkip
                        // Sigh, this will go wrong.
                        result << len.value() << "%";
                        break;
@@ -429,7 +441,7 @@ docstring InsetGraphics::createDocBookAttributes() const
        if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
                if (!float_equal(scl, 100.0, 0.05))
                        options << " scale=\""
-                               << static_cast<int>( (scl) + 0.5 )
+                               << support::iround(scl)
                                << "\" ";
        } else {
                if (!params().width.zero()) {
@@ -474,7 +486,7 @@ copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
                // Nothing to do...
                return make_pair(IDENTICAL_CONTENTS, file_out);
 
-       Mover const & mover = getMover(formats.getFormatFromFile(file_in));
+       Mover const & mover = getMover(theFormats().getFormatFromFile(file_in));
        bool const success = mover.copy(file_in, file_out);
        if (!success) {
                // FIXME UNICODE
@@ -494,11 +506,11 @@ copyToDirIfNeeded(DocFileName const & file, string const & dir)
 {
        string const file_in = file.absFileName();
        string const only_path = onlyPath(file_in);
-       if (rtrim(onlyPath(file_in) , "/") == rtrim(dir, "/"))
+       if (rtrim(only_path, "/") == rtrim(dir, "/"))
                return make_pair(IDENTICAL_PATHS, FileName(file_in));
 
        string mangled = file.mangledFileName();
-       if (formats.isZippedFile(file)) {
+       if (theFormats().isZippedFile(file)) {
                // We need to change _eps.gz to .eps.gz. The mangled name is
                // still unique because of the counter in mangledFileName().
                // We can't just call mangledFileName() with the zip
@@ -539,7 +551,7 @@ 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 = formats.getFormat(to)->extension();
+       string const to_format = theFormats().getFormat(to)->extension();
        string const file_format = getExtension(file);
        // for latex .ps == .eps
        if (to_format == file_format ||
@@ -549,7 +561,7 @@ string const stripExtensionIfPossible(string const & file, string const & to, bo
        return latex_path(file, EXCLUDE_EXTENSION);
 }
 
-} // namespace anon
+} // namespace
 
 
 string InsetGraphics::prepareFile(OutputParams const & runparams) const
@@ -586,8 +598,7 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
        // we move it to a temp dir or uncompress it.
        FileName temp_file;
        GraphicsCopyStatus status;
-       boost::tie(status, temp_file) =
-                       copyToDirIfNeeded(params().filename, temp_path);
+       tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
 
        if (status == FAILURE)
                return orig_file;
@@ -621,44 +632,7 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
        // determine the export format
        string const tex_format = flavor2format(runparams.flavor);
 
-       // If the file is compressed and we have specified that it
-       // should not be uncompressed, then just return its name and
-       // let LaTeX do the rest!
-       if (formats.isZippedFile(params().filename)) {
-               if (params().noUnzip) {
-                       // We don't know whether latex can actually handle
-                       // this file, but we can't check, because that would
-                       // mean to unzip the file and thereby making the
-                       // noUnzip parameter meaningless.
-                       LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
-
-                       FileName const bb_orig_file =
-                               FileName(changeExtension(orig_file, "bb"));
-                       if (runparams.nice) {
-                               runparams.exportdata->addExternalFile(tex_format,
-                                               bb_orig_file,
-                                               changeExtension(output_file, "bb"));
-                       } else {
-                               // LaTeX needs the bounding box file in the
-                               // tmp dir
-                               FileName bb_file =
-                                       FileName(changeExtension(temp_file.absFileName(), "bb"));
-                               boost::tie(status, bb_file) =
-                                       copyFileIfNeeded(bb_orig_file, bb_file);
-                               if (status == FAILURE)
-                                       return orig_file;
-                               runparams.exportdata->addExternalFile(tex_format,
-                                               bb_file);
-                       }
-                       runparams.exportdata->addExternalFile(tex_format,
-                                       source_file, output_file);
-                       runparams.exportdata->addExternalFile("dvi",
-                                       source_file, output_file);
-                       // We can't strip the extension, because we don't know
-                       // the unzipped file format
-                       return latex_path(output_file, EXCLUDE_EXTENSION);
-               }
-
+       if (theFormats().isZippedFile(params().filename)) {
                FileName const unzipped_temp_file =
                        FileName(unzippedFileName(temp_file.absFileName()));
                output_file = unzippedFileName(output_file);
@@ -675,12 +649,12 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
                }
        }
 
-       string const from = formats.getFormatFromFile(temp_file);
+       string const from = theFormats().getFormatFromFile(temp_file);
        if (from.empty())
                LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
 
        string const to   = findTargetFormat(from, runparams);
-       string const ext  = formats.extension(to);
+       string const ext  = theFormats().extension(to);
        LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
 
        // We're going to be running the exported buffer through the LaTeX
@@ -695,12 +669,12 @@ string InsetGraphics::prepareFile(OutputParams const & runparams) const
                        // The LaTeX compiler will not be able to determine
                        // the file format from the extension, so we must
                        // change it.
-                       FileName const new_file = 
+                       FileName const new_file =
                                FileName(changeExtension(temp_file.absFileName(), ext));
                        if (temp_file.moveTo(new_file)) {
                                temp_file = new_file;
                                output_file = changeExtension(output_file, ext);
-                               source_file = 
+                               source_file =
                                        FileName(changeExtension(source_file.absFileName(), ext));
                        } else {
                                LYXERR(Debug::GRAPHICS, "Could not rename file `"
@@ -765,7 +739,7 @@ void InsetGraphics::latex(otexstream & os,
                        && params().filename.isReadableFile();
        string message;
        if (!file_exists) {
-               if (params().bb.empty())
+               if (params().bbox.empty())
                    message = "bb = 0 0 200 100";
                if (!params().draft) {
                        if (!message.empty())
@@ -793,7 +767,9 @@ void InsetGraphics::latex(otexstream & os,
        before += "\\includegraphics";
 
        // Write the options if there are any.
-       string const opts = createLatexOptions();
+       bool const ps = runparams.flavor == OutputParams::LATEX
+               || runparams.flavor == OutputParams::DVILUATEX;
+       string const opts = createLatexOptions(ps);
        LYXERR(Debug::GRAPHICS, "\tOpts = " << opts);
 
        if (!opts.empty() && !message.empty())
@@ -901,15 +877,13 @@ string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
        if (params().filename.empty())
                return string();
 
-       string const orig_file = params().filename.absFileName();
+       if (!params().filename.isReadableFile())
+               return string();
 
        // The master buffer. This is useful when there are multiple levels
        // of include files
        Buffer const * masterBuffer = buffer().masterBuffer();
 
-       if (!params().filename.isReadableFile())
-               return string();
-
        // We place all temporary files in the master buffer's temp dir.
        // This is possible because we use mangled file names.
        // FIXME We may want to put these files in some special temporary
@@ -919,20 +893,21 @@ string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
        // Copy to temporary directory.
        FileName temp_file;
        GraphicsCopyStatus status;
-       boost::tie(status, temp_file) =
-                       copyToDirIfNeeded(params().filename, temp_path);
+       tie(status, temp_file) = copyToDirIfNeeded(params().filename, temp_path);
 
        if (status == FAILURE)
                return string();
 
-       string output_file = onlyFileName(temp_file.absFileName());
-
-       string const from = formats.getFormatFromFile(temp_file);
-       if (from.empty())
+       string const from = theFormats().getFormatFromFile(temp_file);
+       if (from.empty()) {
                LYXERR(Debug::GRAPHICS, "\tCould not get file format.");
+               return string();
+       }
 
        string const to   = findTargetFormat(from, runparams);
-       string const ext  = formats.extension(to);
+       string const ext  = theFormats().extension(to);
+       string const orig_file = params().filename.absFileName();
+       string output_file = onlyFileName(temp_file.absFileName());
        LYXERR(Debug::GRAPHICS, "\t we have: from " << from << " to " << to);
        LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
 
@@ -964,10 +939,10 @@ 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 = 
+       bool const success =
                theConverters().convert(&buffer(), temp_file, to_file, params().filename,
                        from, to, el, Converters::try_default | Converters::try_cache);
-       if (!success)   
+       if (!success)
                return string();
        runparams.exportdata->addExternalFile("xhtml", to_file, output_to_file);
        return output_to_file;
@@ -976,30 +951,40 @@ string InsetGraphics::prepareHTMLFile(OutputParams const & runparams) const
 
 docstring InsetGraphics::xhtml(XHTMLStream & xs, OutputParams const & op) const
 {
-       string const output_file = prepareHTMLFile(op);
+       string const output_file = op.dryrun ? string() : prepareHTMLFile(op);
 
-       if (output_file.empty()) {
-               LYXERR0("InsetGraphics::xhtml: Unable to prepare file `" 
+       if (output_file.empty() && !op.dryrun) {
+               LYXERR0("InsetGraphics::xhtml: Unable to prepare file `"
                        << params().filename << "' for output. File missing?");
-               string const attr = "src='" + params().filename.absFileName() 
+               string const attr = "src='" + params().filename.absFileName()
                                    + "' alt='image: " + output_file + "'";
                xs << html::CompTag("img", attr);
                return docstring();
        }
 
-       // FIXME XHTML 
+       // FIXME XHTML
        // We aren't doing anything with the crop and rotate parameters, and it would
        // really be better to do width and height conversion, rather than to output
        // these parameters here.
        string imgstyle;
-       if (!params().width.zero())
-               imgstyle += "width:" + params().width.asHTMLString() + ";";
-       if (!params().height.zero())
-               imgstyle += " height:" + params().height.asHTMLString() + ";";
+       bool const havewidth  = !params().width.zero();
+       bool const haveheight = !params().height.zero();
+       if (havewidth || haveheight) {
+               if (havewidth)
+                       imgstyle += "width:" + params().width.asHTMLString() + ";";
+               if (haveheight)
+                       imgstyle += " height:" + params().height.asHTMLString() + ";";
+       } else if (params().scale != "100") {
+               // Note that this will not have the same effect as in LaTeX export:
+               // There, the image will be scaled from its original size. Here, the
+               // percentage will be interpreted by the browser, and the image will
+               // be scaled to a percentage of the window size.
+               imgstyle = "width:" + params().scale + "%;";
+       }
        if (!imgstyle.empty())
                imgstyle = "style='" + imgstyle + "' ";
 
-       string const attr = imgstyle + "src='" + output_file + "' alt='image: " 
+       string const attr = imgstyle + "src='" + output_file + "' alt='image: "
                            + output_file + "'";
        xs << html::CompTag("img", attr);
        return docstring();
@@ -1050,16 +1035,19 @@ InsetGraphicsParams const & InsetGraphics::params() const
 
 void InsetGraphics::editGraphics(InsetGraphicsParams const & p) const
 {
-       formats.edit(buffer(), p.filename,
-                    formats.getFormatFromFile(p.filename));
+       theFormats().edit(buffer(), p.filename,
+                    theFormats().getFormatFromFile(p.filename));
 }
 
 
-void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active) const
+void InsetGraphics::addToToc(DocIterator const & cpit, bool output_active,
+                                                        UpdateType, TocBackend & backend) const
 {
        //FIXME UNICODE
        docstring const str = from_utf8(params_.filename.onlyFileName());
-       buffer().tocBackend().toc("graphics").push_back(TocItem(cpit, 0, str, output_active));
+       TocBuilder & b = backend.builder("graphics");
+       b.pushItem(cpit, str, output_active);
+       b.pop();
 }
 
 
@@ -1081,7 +1069,7 @@ void InsetGraphics::string2params(string const & in, Buffer const & buffer,
        lex.setContext("InsetGraphics::string2params");
        lex >> "graphics";
        params = InsetGraphicsParams();
-       readInsetGraphics(lex, buffer.filePath(), params);
+       readInsetGraphics(lex, buffer, false, params);
 }