]> git.lyx.org Git - features.git/blobdiff - src/insets/insetgraphics.C
change "support/std_sstream.h" to <sstream>
[features.git] / src / insets / insetgraphics.C
index ee67049c86657522679e7c96c2d9c39669ba0428..fe29faf3ba076b397f9aabd04e8d0a38aaa2262e 100644 (file)
@@ -58,6 +58,7 @@ TODO
 #include "cursor.h"
 #include "debug.h"
 #include "dispatchresult.h"
+#include "exporter.h"
 #include "format.h"
 #include "funcrequest.h"
 #include "gettext.h"
@@ -76,12 +77,14 @@ TODO
 #include "support/os.h"
 #include "support/systemcall.h"
 #include "support/tostr.h"
-#include "support/std_sstream.h"
 
 #include <boost/bind.hpp>
 #include <boost/tuple/tuple.hpp>
 
+#include <sstream>
+
 namespace support = lyx::support;
+
 using lyx::support::AbsolutePath;
 using lyx::support::bformat;
 using lyx::support::ChangeExtension;
@@ -93,6 +96,7 @@ using lyx::support::GetExtension;
 using lyx::support::getExtFromContents;
 using lyx::support::IsFileReadable;
 using lyx::support::LibFileSearch;
+using lyx::support::OnlyFilename;
 using lyx::support::rtrim;
 using lyx::support::subst;
 using lyx::support::Systemcall;
@@ -399,12 +403,29 @@ copyToDirIfNeeded(string const & file_in, string const & dir, bool zipped)
 }
 
 
+string const stripExtension(string const & file)
+{
+       // Remove the extension so the LaTeX will use whatever
+       // is appropriate (when there are several versions in
+       // different formats)
+       // This works only if the filename contains no dots besides
+       // the just removed one. We can fool here by replacing all
+       // dots with a macro whose definition is just a dot ;-)
+       return subst(RemoveExtension(file), ".", "\\lyxdot ");
+}
+
+
 string const stripExtensionIfPossible(string const & file, string const & to)
 {
        // No conversion is needed. LaTeX can handle the graphic file as is.
        // This is true even if the orig_file is compressed.
-       if (formats.getFormat(to)->extension() == GetExtension(file))
-               return RemoveExtension(file);
+       string const to_format = formats.getFormat(to)->extension();
+       string const file_format = GetExtension(file);
+       // for latex .ps == .eps
+       if (to_format == file_format ||
+           (to_format == "eps" && file_format ==  "ps") ||
+           (to_format ==  "ps" && file_format == "eps"))
+               return stripExtension(file);
        return file;
 }
 
@@ -414,18 +435,10 @@ string const stripExtensionIfPossible(string const & file, string const & to)
 string const InsetGraphics::prepareFile(Buffer const & buf,
                                        OutputParams const & runparams) const
 {
-       string orig_file = params().filename.absFilename();
+       // We assume that the file exists (the caller checks this)
+       string const orig_file = params().filename.absFilename();
        string const rel_file = params().filename.relFilename(buf.filePath());
 
-       // LaTeX can cope if the graphics file doesn't exist, so just return the
-       // filename.
-       if (!IsFileReadable(orig_file)) {
-               lyxerr[Debug::GRAPHICS]
-                       << "InsetGraphics::prepareFile\n"
-                       << "No file '" << orig_file << "' can be found!" << endl;
-               return rel_file;
-       }
-
        // 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!
@@ -435,12 +448,14 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        // we move it to a temp dir or uncompress it.
        string temp_file = orig_file;
 
+       // The master buffer. This is useful when there are multiple levels
+       // of include files
+       Buffer const * m_buffer = buf.getMasterBuffer();
+
        // We place all temporary files in the master buffer's temp dir.
        // This is possible because we use mangled file names.
        // This is necessary for DVI export.
-       string const temp_path = buf.getMasterBuffer()->temppath();
-
-       bool conversion_needed = true;
+       string const temp_path = m_buffer->temppath();
 
        CopyStatus status;
        boost::tie(status, temp_file) =
@@ -448,21 +463,48 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 
        if (status == FAILURE)
                return orig_file;
-       else if (status == IDENTICAL_CONTENTS)
-               conversion_needed = false;
+
+       // a relative filename should be relative to the master
+       // buffer.
+       // "nice" means that the buffer is exported to LaTeX format but not
+       //        run through the LaTeX compiler.
+       string const output_file = os::external_path(runparams.nice ?
+               params().filename.outputFilename(m_buffer->filePath()) :
+               OnlyFilename(temp_file));
+       string const source_file = runparams.nice ? orig_file : temp_file;
 
        if (zipped) {
                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.\n";
-                       // LaTeX needs the bounding box file in the tmp dir
-                       string bb_file;
-                       boost::tie(status, bb_file) =
-                               copyFileIfNeeded(ChangeExtension(orig_file, "bb"),
-                                                ChangeExtension(temp_file, "bb"));
-                       if (status == FAILURE)
-                               return orig_file;
-                       return temp_file;
+
+                       string const bb_orig_file = ChangeExtension(orig_file, "bb");
+                       if (runparams.nice) {
+                               runparams.exportdata->addExternalFile("latex",
+                                               bb_orig_file,
+                                               ChangeExtension(output_file, "bb"));
+                       } else {
+                               // LaTeX needs the bounding box file in the
+                               // tmp dir
+                               string bb_file = ChangeExtension(temp_file, "bb");
+                               boost::tie(status, bb_file) =
+                                       copyFileIfNeeded(bb_orig_file, bb_file);
+                               if (status == FAILURE)
+                                       return orig_file;
+                               runparams.exportdata->addExternalFile("latex",
+                                               bb_file);
+                       }
+                       runparams.exportdata->addExternalFile("latex",
+                                       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 output_file;
                }
 
                string const unzipped_temp_file = unzippedFileName(temp_file);
@@ -493,43 +535,56 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        lyxerr[Debug::GRAPHICS]
                << "\tthe orig file is: " << orig_file << endl;
 
-       if (from == to)
-               return stripExtensionIfPossible(temp_file, to);
+       if (from == to) {
+               // The extension of temp_file might be != to!
+               runparams.exportdata->addExternalFile("latex", source_file,
+                                                     output_file);
+               runparams.exportdata->addExternalFile("dvi", source_file,
+                                                     output_file);
+               return stripExtensionIfPossible(output_file, to);
+       }
 
-       string const to_file_base = RemoveExtension(temp_file);
-       string const to_file = ChangeExtension(to_file_base, to);
+       string const to_file = ChangeExtension(temp_file, to);
+       string const output_to_file = ChangeExtension(output_file, to);
 
        // Do we need to perform the conversion?
        // Yes if to_file does not exist or if temp_file is newer than to_file
-       if (!conversion_needed ||
-           compare_timestamps(temp_file, to_file) < 0) {
+       if (compare_timestamps(temp_file, to_file) < 0) {
                lyxerr[Debug::GRAPHICS]
                        << bformat(_("No conversion of %1$s is needed after all"),
                                   rel_file)
                        << std::endl;
-               return to_file_base;
+               runparams.exportdata->addExternalFile("latex", to_file,
+                                                     output_to_file);
+               runparams.exportdata->addExternalFile("dvi", to_file,
+                                                     output_to_file);
+               return stripExtension(output_file);
        }
 
        lyxerr[Debug::GRAPHICS]
                << "\tThe original file is " << orig_file << "\n"
                << "\tA copy has been made and convert is to be called with:\n"
                << "\tfile to convert = " << temp_file << '\n'
-               << "\tto_file_base = " << to_file_base << '\n'
                << "\t from " << from << " to " << to << '\n';
 
        // if no special converter defined, then we take the default one
        // from ImageMagic: convert from:inname.from to:outname.to
-       if (!converters.convert(&buf, temp_file, to_file_base, from, to)) {
+       if (!converters.convert(&buf, temp_file, temp_file, from, to)) {
                string const command =
                        "sh " + LibFileSearch("scripts", "convertDefault.sh") +
                                ' ' + from + ':' + temp_file + ' ' +
-                               to + ':' + to_file_base + '.' + to;
+                               to + ':' + to_file;
                lyxerr[Debug::GRAPHICS]
                        << "No converter defined! I use convertDefault.sh:\n\t"
                        << command << endl;
                Systemcall one;
                one.startscript(Systemcall::Wait, command);
-               if (!IsFileReadable(ChangeExtension(to_file_base, to))) {
+               if (IsFileReadable(to_file)) {
+                       runparams.exportdata->addExternalFile("latex",
+                                       to_file, output_to_file);
+                       runparams.exportdata->addExternalFile("dvi",
+                                       to_file, output_to_file);
+               } else {
                        string str = bformat(_("No information for converting %1$s "
                                "format files to %2$s.\n"
                                "Try defining a convertor in the preferences."), from, to);
@@ -537,17 +592,13 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                }
        }
 
-       return to_file_base;
+       return stripExtension(output_file);
 }
 
 
 int InsetGraphics::latex(Buffer const & buf, ostream & os,
                         OutputParams const & runparams) const
 {
-       // The master buffer. This is useful when there are multiple levels
-       // of include files
-       Buffer const * m_buffer = buf.getMasterBuffer();
-
        // If there is no file specified or not existing,
        // just output a message about it in the latex output.
        lyxerr[Debug::GRAPHICS]
@@ -561,7 +612,7 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os,
        bool const file_exists = !file_.empty() && IsFileReadable(file_);
        string const message = file_exists ?
                string() : string("bb = 0 0 200 100, draft, type=eps");
-       // if !message.empty() than there was no existing file
+       // if !message.empty() then there was no existing file
        // "filename" found. In this case LaTeX
        // draws only a rectangle with the above bb and the
        // not found filename in it.
@@ -595,29 +646,13 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os,
 
 
        string latex_str = before + '{';
-       // "nice" means that the buffer is exported to LaTeX format but not
-       //        run through the LaTeX compiler.
-       if (runparams.nice) {
-               // a relative filename should be relative to the master
-               // buffer.
-               string basename = params().filename.outputFilename(m_buffer->filePath());
+       if (file_exists)
+               // Convert the file if necessary.
                // Remove the extension so the LaTeX will use whatever
                // is appropriate (when there are several versions in
                // different formats)
-               basename = RemoveExtension(basename);
-               if(params().filename.isZipped())
-                       basename = RemoveExtension(basename);
-               // This works only if the filename contains no dots besides
-               // the just removed one. We can fool here by replacing all
-               // dots with a macro whose definition is just a dot ;-)
-               latex_str += subst(basename, ".", "\\lyxdot ");
-       } else if (file_exists) {
-               // Make the filename relative to the lyx file
-               // and remove the extension so the LaTeX will use whatever
-               // is appropriate (when there are several versions in
-               // different formats)
-               latex_str += os::external_path(prepareFile(buf, runparams));
-       } else
+               latex_str += prepareFile(buf, runparams);
+       else
                latex_str += relative_file + " not found!";
 
        latex_str += '}' + after;
@@ -651,6 +686,8 @@ int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
                                params().filename.relFilename(buf.filePath()):
                                params().filename.absFilename();
 
+       runparams.exportdata->addExternalFile("linuxdoc",
+                                             params().filename.absFilename());
        os << "<eps file=\"" << file_name << "\">\n";
        os << "<img src=\"" << file_name << "\">";
        return 0;
@@ -658,14 +695,18 @@ int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
 
 
 // For explanation on inserting graphics into DocBook checkout:
-// http://en.tldp.org/LDP/LDP-Author-Guide/inserting-pictures.html
+// 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(Buffer const &, ostream & os,
-                          OutputParams const &) const
+                          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.
+       runparams.exportdata->addExternalFile("docbook",
+                                             params().filename.absFilename());
+       runparams.exportdata->addExternalFile("docbook-xml",
+                                             params().filename.absFilename());
        os << "<graphic fileref=\"&" << graphic_label << ";\">";
        return 0;
 }