]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetgraphics.C
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetgraphics.C
index 1440e9bad6c2eebe70c97ca8b8adfffe727e9bba..56d990bda04622110fd3bbeac131ce8b7aee81cb 100644 (file)
@@ -64,7 +64,6 @@ TODO
 #include "FuncStatus.h"
 #include "gettext.h"
 #include "LaTeXFeatures.h"
-#include "lyx_main.h"
 #include "lyxlength.h"
 #include "lyxlex.h"
 #include "metricsinfo.h"
@@ -73,12 +72,11 @@ TODO
 #include "sgml.h"
 
 #include "frontends/Alert.h"
-#include "frontends/LyXView.h"
 
 #include "support/convert.h"
 #include "support/filetools.h"
-#include "support/lyxalgo.h" // lyx::count
-#include "support/lyxlib.h" // lyx::sum
+#include "support/lyxalgo.h" // count
+#include "support/lyxlib.h" // sum
 #include "support/lstrings.h"
 #include "support/os.h"
 #include "support/systemcall.h"
@@ -88,27 +86,26 @@ TODO
 
 #include <sstream>
 
-namespace support = lyx::support;
-
-using lyx::support::absolutePath;
-using lyx::support::bformat;
-using lyx::support::changeExtension;
-using lyx::support::compare_timestamps;
-using lyx::support::contains;
-using lyx::support::FileName;
-using lyx::support::float_equal;
-using lyx::support::getExtension;
-using lyx::support::isFileReadable;
-using lyx::support::latex_path;
-using lyx::support::onlyFilename;
-using lyx::support::removeExtension;
-using lyx::support::rtrim;
-using lyx::support::subst;
-using lyx::support::Systemcall;
-using lyx::support::unzipFile;
-using lyx::support::unzippedFileName;
-
-namespace os = lyx::support::os;
+
+namespace lyx {
+
+using support::bformat;
+using support::changeExtension;
+using support::compare_timestamps;
+using support::contains;
+using support::DocFileName;
+using support::FileName;
+using support::float_equal;
+using support::getExtension;
+using support::isFileReadable;
+using support::latex_path;
+using support::onlyFilename;
+using support::removeExtension;
+using support::rtrim;
+using support::subst;
+using support::Systemcall;
+using support::unzipFile;
+using support::unzippedFileName;
 
 using std::endl;
 using std::string;
@@ -127,11 +124,12 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
        // Are we using latex or pdflatex?
        if (runparams.flavor == OutputParams::PDFLATEX) {
                lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode" << endl;
-               // Convert postscript to pdf
-               if (format == "eps" || format == "ps")
+               Format const * const f = formats.getFormat(format);
+               // Convert vector graphics to pdf
+               if (f && f->vectorFormat())
                        return "pdf";
                // pdflatex can use jpeg, png and pdf directly
-               if (format == "jpg" || format == "pdf")
+               if (format == "jpg")
                        return format;
                // Convert everything else to png
                return "png";
@@ -149,7 +147,7 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
 
 
 InsetGraphics::InsetGraphics()
-       : graphic_label(sgml::uniqueID("graph")),
+       : graphic_label(sgml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(this))
 {}
 
@@ -157,7 +155,7 @@ InsetGraphics::InsetGraphics()
 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
        : InsetOld(ig),
          boost::signals::trackable(),
-         graphic_label(sgml::uniqueID("graph")),
+               graphic_label(sgml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(*ig.graphic_, this))
 {
        setParams(ig.params());
@@ -182,7 +180,7 @@ void InsetGraphics::doDispatch(LCursor & cur, FuncRequest & cmd)
        case LFUN_GRAPHICS_EDIT: {
                Buffer const & buffer = *cur.bv().buffer();
                InsetGraphicsParams p;
-               InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
+               InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
                editGraphics(p, buffer);
                break;
        }
@@ -190,7 +188,7 @@ void InsetGraphics::doDispatch(LCursor & cur, FuncRequest & cmd)
        case LFUN_INSET_MODIFY: {
                Buffer const & buffer = cur.buffer();
                InsetGraphicsParams p;
-               InsetGraphicsMailer::string2params(cmd.argument, buffer, p);
+               InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
                if (!p.filename.empty())
                        setParams(p);
                else
@@ -235,10 +233,12 @@ void InsetGraphics::edit(LCursor & cur, bool)
 }
 
 
-void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
+bool InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        graphic_->metrics(mi, dim);
+       bool const changed = dim_ != dim;
        dim_ = dim;
+       return changed;
 }
 
 
@@ -350,9 +350,9 @@ string const InsetGraphics::createLatexOptions() const
 }
 
 
-string const InsetGraphics::toDocbookLength(LyXLength const & len) const
+docstring const InsetGraphics::toDocbookLength(LyXLength const & len) const
 {
-       ostringstream result;
+       odocstringstream result;
        switch (len.unit()) {
                case LyXLength::SP: // Scaled point (65536sp = 1pt) TeX's smallest unit.
                        result << len.value() * 65536.0 * 72 / 72.27 << "pt";
@@ -401,13 +401,13 @@ string const InsetGraphics::toDocbookLength(LyXLength const & len) const
                        result << len.value() << "%";
                        break;
                default:
-                       result << len.asString();
+                       result << len.asDocstring();
                        break;
        }
        return result.str();
 }
 
-string const InsetGraphics::createDocBookAttributes() const
+docstring const 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() ;-)
@@ -415,7 +415,7 @@ string const InsetGraphics::createDocBookAttributes() const
        // 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 :-)
 
-       ostringstream options;
+       odocstringstream options;
        double const scl = convert<double>(params().scale);
        if (!params().scale.empty() && !float_equal(scl, 0.0, 0.05)) {
                if (!float_equal(scl, 100.0, 0.05))
@@ -437,11 +437,10 @@ string const InsetGraphics::createDocBookAttributes() const
 
 
        if (!params().special.empty())
-           options << params().special << " ";
+               options << from_ascii(params().special) << " ";
 
-       string opts = options.str();
        // trailing blanks are ok ...
-       return opts;
+       return options.str();
 }
 
 
@@ -455,12 +454,9 @@ enum CopyStatus {
 };
 
 
-std::pair<CopyStatus, string> const
-copyFileIfNeeded(string const & file_in, string const & file_out)
+std::pair<CopyStatus, FileName> const
+copyFileIfNeeded(FileName const & file_in, FileName const & file_out)
 {
-       BOOST_ASSERT(absolutePath(file_in));
-       BOOST_ASSERT(absolutePath(file_out));
-
        unsigned long const checksum_in  = support::sum(file_in);
        unsigned long const checksum_out = support::sum(file_out);
 
@@ -468,13 +464,14 @@ copyFileIfNeeded(string const & file_in, string const & file_out)
                // Nothing to do...
                return std::make_pair(IDENTICAL_CONTENTS, file_out);
 
-       Mover const & mover = movers(formats.getFormatFromFile(file_in));
+       Mover const & mover = getMover(formats.getFormatFromFile(file_in));
        bool const success = mover.copy(file_in, file_out);
        if (!success) {
+               // FIXME UNICODE
                lyxerr[Debug::GRAPHICS]
-                       << support::bformat(_("Could not copy the file\n%1$s\n"
-                                             "into the temporary directory."),
-                                           file_in)
+                       << to_utf8(support::bformat(_("Could not copy the file\n%1$s\n"
+                                                          "into the temporary directory."),
+                                               from_utf8(file_in.absFilename())))
                        << std::endl;
        }
 
@@ -483,8 +480,8 @@ copyFileIfNeeded(string const & file_in, string const & file_out)
 }
 
 
-std::pair<CopyStatus, string> const
-copyToDirIfNeeded(FileName const & file, string const & dir)
+std::pair<CopyStatus, FileName> const
+copyToDirIfNeeded(DocFileName const & file, string const & dir)
 {
        using support::rtrim;
 
@@ -505,9 +502,9 @@ copyToDirIfNeeded(FileName const & file, string const & dir)
                string::size_type const ext_len = file_in.length() - base.length();
                mangled[mangled.length() - ext_len] = '.';
        }
-       string const file_out = support::makeAbsPath(mangled, dir);
+       FileName const file_out(support::makeAbsPath(mangled, dir));
 
-       return copyFileIfNeeded(file_in, file_out);
+       return copyFileIfNeeded(file, file_out);
 }
 
 
@@ -522,12 +519,12 @@ string const stripExtensionIfPossible(string const & file)
        // The automatic format selection does not work if the file
        // name is escaped.
        string const latex_name = latex_path(file,
-                                            lyx::support::EXCLUDE_EXTENSION);
+                                            support::EXCLUDE_EXTENSION);
        if (contains(latex_name, '"'))
                return latex_name;
        return latex_path(removeExtension(file),
-                         lyx::support::PROTECT_EXTENSION,
-                         lyx::support::ESCAPE_DOTS);
+                         support::PROTECT_EXTENSION,
+                         support::ESCAPE_DOTS);
 }
 
 
@@ -542,7 +539,7 @@ string const stripExtensionIfPossible(string const & file, string const & to)
            (to_format == "eps" && file_format ==  "ps") ||
            (to_format ==  "ps" && file_format == "eps"))
                return stripExtensionIfPossible(file);
-       return latex_path(file, lyx::support::EXCLUDE_EXTENSION);
+       return latex_path(file, support::EXCLUDE_EXTENSION);
 }
 
 } // namespace anon
@@ -558,13 +555,13 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        string const orig_file = params().filename.absFilename();
        string const rel_file = params().filename.relFilename(buf.filePath());
 
-       // previewing source code, no file copying or file format conversion 
+       // previewing source code, no file copying or file format conversion
        if (runparams.dryrun)
                return stripExtensionIfPossible(rel_file);
 
        // temp_file will contain the file for LaTeX to act on if, for example,
        // we move it to a temp dir or uncompress it.
-       string temp_file = orig_file;
+       FileName temp_file = params().filename;
 
        // The master buffer. This is useful when there are multiple levels
        // of include files
@@ -574,7 +571,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        // not exist.
        // We are not going to change the extension or using the name of the
        // temporary file, the code is already complicated enough.
-       if (runparams.inComment || !isFileReadable(orig_file))
+       if (runparams.inComment || !isFileReadable(params().filename))
                return params().filename.outputFilename(m_buffer->filePath());
 
        // We place all temporary files in the master buffer's temp dir.
@@ -593,10 +590,10 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        // buffer.
        // "nice" means that the buffer is exported to LaTeX format but not
        //        run through the LaTeX compiler.
-       string output_file = os::external_path(runparams.nice ?
+       string output_file = support::os::external_path(runparams.nice ?
                params().filename.outputFilename(m_buffer->filePath()) :
-               onlyFilename(temp_file));
-       string source_file = runparams.nice ? orig_file : temp_file;
+               onlyFilename(temp_file.absFilename()));
+       FileName source_file = runparams.nice ? FileName(params().filename) : temp_file;
        string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
                        "latex" : "pdflatex";
 
@@ -612,7 +609,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                        lyxerr[Debug::GRAPHICS]
                                << "\tpass zipped file to LaTeX.\n";
 
-                       string const bb_orig_file = changeExtension(orig_file, "bb");
+                       FileName const bb_orig_file = FileName(changeExtension(orig_file, "bb"));
                        if (runparams.nice) {
                                runparams.exportdata->addExternalFile(tex_format,
                                                bb_orig_file,
@@ -620,7 +617,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                        } else {
                                // LaTeX needs the bounding box file in the
                                // tmp dir
-                               string bb_file = changeExtension(temp_file, "bb");
+                               FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
                                boost::tie(status, bb_file) =
                                        copyFileIfNeeded(bb_orig_file, bb_file);
                                if (status == FAILURE)
@@ -635,12 +632,13 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                        // We can't strip the extension, because we don't know
                        // the unzipped file format
                        return latex_path(output_file,
-                                         lyx::support::EXCLUDE_EXTENSION);
+                                         support::EXCLUDE_EXTENSION);
                }
 
-               string const unzipped_temp_file = unzippedFileName(temp_file);
+               FileName const unzipped_temp_file =
+                       FileName(unzippedFileName(temp_file.absFilename()));
                output_file = unzippedFileName(output_file);
-               source_file = unzippedFileName(source_file);
+               source_file = FileName(unzippedFileName(source_file.absFilename()));
                if (compare_timestamps(unzipped_temp_file, temp_file) > 0) {
                        // temp_file has been unzipped already and
                        // orig_file has not changed in the meantime.
@@ -674,15 +672,15 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                << "\tthe orig file is: " << orig_file << endl;
 
        if (from == to) {
-               if (!runparams.nice && getExtension(temp_file) != ext) {
+               if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
                        // The LaTeX compiler will not be able to determine
                        // the file format from the extension, so we must
                        // change it.
-                       string const new_file = changeExtension(temp_file, ext);
-                       if (lyx::support::rename(temp_file, new_file)) {
+                       FileName const new_file = FileName(changeExtension(temp_file.absFilename(), ext));
+                       if (support::rename(temp_file, new_file)) {
                                temp_file = new_file;
                                output_file = changeExtension(output_file, ext);
-                               source_file = changeExtension(source_file, ext);
+                               source_file = FileName(changeExtension(source_file.absFilename(), ext));
                        } else
                                lyxerr[Debug::GRAPHICS]
                                        << "Could not rename file `"
@@ -697,15 +695,16 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                return stripExtensionIfPossible(output_file, to);
        }
 
-       string const to_file = changeExtension(temp_file, ext);
+       FileName const to_file = FileName(changeExtension(temp_file.absFilename(), ext));
        string const output_to_file = changeExtension(output_file, ext);
 
        // Do we need to perform the conversion?
        // Yes if to_file does not exist or if temp_file is newer than to_file
        if (compare_timestamps(temp_file, to_file) < 0) {
+               // FIXME UNICODE
                lyxerr[Debug::GRAPHICS]
-                       << bformat(_("No conversion of %1$s is needed after all"),
-                                  rel_file)
+                       << to_utf8(bformat(_("No conversion of %1$s is needed after all"),
+                                  from_utf8(rel_file)))
                        << std::endl;
                runparams.exportdata->addExternalFile(tex_format, to_file,
                                                      output_to_file);
@@ -720,7 +719,11 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                << "\tfile to convert = " << temp_file << '\n'
                << "\t from " << from << " to " << to << '\n';
 
-       if (converters.convert(&buf, temp_file, temp_file, from, to, true)) {
+       // FIXME (Abdel 12/08/06): Is there a need to show these errors?
+       ErrorList el;
+       if (theConverters().convert(&buf, temp_file, to_file, params().filename,
+                              from, to, el,
+                              Converters::try_default | Converters::try_cache)) {
                runparams.exportdata->addExternalFile(tex_format,
                                to_file, output_to_file);
                runparams.exportdata->addExternalFile("dvi",
@@ -731,7 +734,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 }
 
 
-int InsetGraphics::latex(Buffer const & buf, ostream & os,
+int InsetGraphics::latex(Buffer const & buf, odocstream & os,
                         OutputParams const & runparams) const
 {
        // If there is no file specified or not existing,
@@ -743,8 +746,8 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os,
        string const relative_file =
                params().filename.relFilename(buf.filePath());
 
-       string const file_ = params().filename.absFilename();
-       bool const file_exists = !file_.empty() && isFileReadable(file_);
+       bool const file_exists = !params().filename.empty() &&
+                                isFileReadable(params().filename);
        string const message = file_exists ?
                string() : string("bb = 0 0 200 100, draft, type=eps");
        // if !message.empty() then there was no existing file
@@ -791,7 +794,8 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os,
        // (when there are several versions in different formats)
        latex_str += prepareFile(buf, runparams);
        latex_str += '}' + after;
-       os << latex_str;
+       // FIXME UNICODE
+       os << from_utf8(latex_str);
 
        lyxerr[Debug::GRAPHICS] << "InsetGraphics::latex outputting:\n"
                                << latex_str << endl;
@@ -800,7 +804,7 @@ int InsetGraphics::latex(Buffer const & buf, ostream & os,
 }
 
 
-int InsetGraphics::plaintext(Buffer const &, ostream & os,
+int InsetGraphics::plaintext(Buffer const &, odocstream & os,
                         OutputParams const &) const
 {
        // No graphics in ascii output. Possible to use gifscii to convert
@@ -808,37 +812,32 @@ int InsetGraphics::plaintext(Buffer const &, ostream & os,
        // 1. Convert file to ascii using gifscii
        // 2. Read ascii output file and add it to the output stream.
        // at least we send the filename
+       // FIXME UNICODE
+       // FIXME: We have no idea what the encoding of the filename is
        os << '<' << bformat(_("Graphics file: %1$s"),
-                            params().filename.absFilename()) << ">\n";
-       return 0;
-}
-
-
-int InsetGraphics::linuxdoc(Buffer const & buf, ostream & os,
-                           OutputParams const & runparams) const
-{
-       string const file_name = runparams.nice ?
-                               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 << "\">";
+                            from_utf8(params().filename.absFilename()))
+          << ">\n";
        return 0;
 }
 
 
 namespace {
 
-int writeImageObject(char * format, ostream& os, OutputParams const & runparams,
-                                        string const graphic_label, string const attributes)
+int writeImageObject(char * format, odocstream & os, OutputParams const & runparams,
+                     docstring const graphic_label, docstring const attributes)
 {
                if (runparams.flavor != OutputParams::XML) {
-                       os << "<![ %output.print." << format << "; [" << std::endl;
+                       os << "<![ %output.print."
+                           << format
+                           << "; ["
+                           << std::endl;
                }
                os <<"<imageobject><imagedata fileref=\"&"
-                  << graphic_label << ";." << format << "\" " << attributes ;
+                  << graphic_label
+                   << ";."
+                   << format
+                   << "\" "
+                   << attributes;
                if (runparams.flavor == OutputParams::XML) {
                        os <<  " role=\"" << format << "\"/>" ;
                }
@@ -858,7 +857,7 @@ int writeImageObject(char * format, ostream& os, OutputParams const & runparams,
 // 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(Buffer const &, ostream & os,
+int InsetGraphics::docbook(Buffer const &, odocstream & os,
                           OutputParams const & runparams) const
 {
        // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
@@ -866,15 +865,15 @@ int InsetGraphics::docbook(Buffer const &, ostream & os,
        // easier to use.
        if (runparams.flavor == OutputParams::XML) {
                runparams.exportdata->addExternalFile("docbook-xml",
-                                                     params().filename.absFilename());
+                                                     params().filename);
        } else {
                runparams.exportdata->addExternalFile("docbook",
-                                                     params().filename.absFilename());
+                                                     params().filename);
        }
        os << "<inlinemediaobject>";
 
        int r = 0;
-       string attributes = createDocBookAttributes();
+       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);
@@ -898,12 +897,8 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
 
        if (features.runparams().nice) {
                Buffer const * m_buffer = features.buffer().getMasterBuffer();
-               string basename =
-                       params().filename.outputFilename(m_buffer->filePath());
-               basename = removeExtension(basename);
-               if(params().filename.isZipped())
-                       basename = removeExtension(basename);
-               if (contains(basename, "."))
+               string const rel_file = removeExtension(params().filename.relFilename(m_buffer->filePath()));
+               if (contains(rel_file, "."))
                        features.require("lyxdot");
        }
 
@@ -938,9 +933,8 @@ InsetGraphicsParams const & InsetGraphics::params() const
 void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
                                 Buffer const & buffer) const
 {
-       string const file_with_path = p.filename.absFilename();
-       formats.edit(buffer, file_with_path,
-                    formats.getFormatFromFile(file_with_path));
+       formats.edit(buffer, p.filename,
+                    formats.getFormatFromFile(p.filename));
 }
 
 
@@ -990,3 +984,6 @@ InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
        data << "\\end_inset\n";
        return data.str();
 }
+
+
+} // namespace lyx