]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetgraphics.C
static_cast-based key/mouse-state. Kill insetKeyPress.
[lyx.git] / src / insets / insetgraphics.C
index e6e352ec7ea5be784f9b5485c30d5d4fbff7ca7a..108535e6075fe210e80df2afa6f4ae8c7d96bda1 100644 (file)
@@ -81,19 +81,20 @@ TODO Before initial production release:
 #include "graphics/GraphicsCache.h"
 #include "graphics/GraphicsImage.h"
 
-#include "LyXView.h"
+#include "frontends/LyXView.h"
 #include "lyxtext.h"
 #include "buffer.h"
 #include "BufferView.h"
 #include "converter.h"
-#include "Painter.h"
+#include "frontends/Painter.h"
 #include "lyxrc.h"
-#include "font.h"    // For the lyxfont class.
+#include "frontends/font_metrics.h"
 #include "debug.h"
 #include "gettext.h"
 #include "LaTeXFeatures.h"
 
 #include "frontends/Dialogs.h"
+#include "frontends/Alert.h"
 #include "frontends/controllers/helper_funcs.h" // getVectorFromString
 
 #include "support/LAssert.h"
@@ -162,7 +163,7 @@ InsetGraphics::InsetGraphics(InsetGraphics const & ig,
 
 InsetGraphics::~InsetGraphics()
 {
-       cached_image_.reset(0);
+       cached_image_.reset();
        grfx::GCache & gc = grfx::GCache::get();
        gc.remove(*this);
 
@@ -262,13 +263,13 @@ int InsetGraphics::width(BufferView *, LyXFont const & font) const
                string const justname = OnlyFilename (params().filename);
                if (!justname.empty()) {
                        msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
-                       font_width = lyxfont::width(justname, msgFont);
+                       font_width = font_metrics::width(justname, msgFont);
                }
 
                string const msg = statusMessage();
                if (!msg.empty()) {
                        msgFont.setSize(LyXFont::SIZE_TINY);
-                       int const msg_width = lyxfont::width(msg, msgFont);
+                       int const msg_width = font_metrics::width(msg, msgFont);
                        font_width = std::max(font_width, msg_width);
                }
 
@@ -293,7 +294,6 @@ void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
        // But I still don't know the best way to go. So let's do this like this
        // for now (Jug 20020311)
        if (lascent != oasc) {
-//             lyxerr << "IG(" << this << "): " << x << endl;
                return;
        }
 
@@ -312,7 +312,6 @@ void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
        Painter & paint = bv->painter();
 
        if (drawImage()) {
-//             lyxerr << "IG(" << this << "): " << old_x << endl;
                paint.image(old_x + 2, baseline - lascent,
                            lwidth - 4, lascent + ldescent,
                            *cached_image_.get());
@@ -329,8 +328,8 @@ void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
                string const justname = OnlyFilename (params().filename);
                if (!justname.empty()) {
                        msgFont.setSize(LyXFont::SIZE_FOOTNOTE);
-                       paint.text(old_x + 8,
-                                  baseline - lyxfont::maxAscent(msgFont) - 4,
+                       paint.text(old_x + 8, 
+                                  baseline - font_metrics::maxAscent(msgFont) - 4,
                                   justname, msgFont);
                }
 
@@ -350,7 +349,7 @@ void InsetGraphics::draw(BufferView * bv, LyXFont const & font,
 
        // Reset the cache, ready for the next draw request
        cached_status_ = grfx::ErrorUnknown;
-       cached_image_.reset(0);
+       cached_image_.reset();
        cache_filled_ = false;
 }
 
@@ -365,7 +364,7 @@ void InsetGraphics::updateInset(string const & filepath) const
 }
 
 
-void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
+void InsetGraphics::edit(BufferView *bv, int, int, mouse_button::state)
 {
        bv->owner()->getDialogs()->showGraphics(this);
 }
@@ -373,7 +372,7 @@ void InsetGraphics::edit(BufferView *bv, int, int, unsigned int)
 
 void InsetGraphics::edit(BufferView * bv, bool)
 {
-       edit(bv, 0, 0, 0);
+       edit(bv, 0, 0, mouse_button::none);
 }
 
 
@@ -575,22 +574,21 @@ string findTargetFormat(string const & suffix)
        // lyxrc.pdf_mode means:
        // Are we creating a PDF or a PS file?
        // (Should actually mean, are we using latex or pdflatex).
-       lyxerr[Debug::GRAPHICS] << "decideOutput: lyxrc.pdf_mode = "
-                           << lyxrc.pdf_mode << std::endl;
        if (lyxrc.pdf_mode) {
+               lyxerr[Debug::GRAPHICS] << "findTargetFormat: PDF mode\n";
                if (contains(suffix,"ps") || suffix == "pdf")
                        return "pdf";
-               else if (suffix == "jpg")
+               else if (suffix == "jpg")       // pdflatex can use jpeg
                        return suffix;
                else
-                       return "png";
+                       return "png";           // and also png
        }
        // If it's postscript, we always do eps.
-       lyxerr[Debug::GRAPHICS] << "decideOutput: we have PostScript mode\n";
-       if (suffix != "ps")
-           return "eps";
+       lyxerr[Debug::GRAPHICS] << "findTargetFormat: PostScript mode\n";
+       if (suffix != "ps")                     // any other than ps
+           return "eps";                       // is changed to eps
        else
-           return "ps";
+           return suffix;                      // let ps untouched
 }
 
 } // Anon. namespace
@@ -598,56 +596,126 @@ string findTargetFormat(string const & suffix)
 
 string const InsetGraphics::prepareFile(Buffer const *buf) const
 {
-       // do_convert = Do we need to convert the file?
-       // nice = Do we create a nice version?
-       //        This is used when exporting the latex file only.
-       // if (!do_convert)
-       //   return original filename
-       // if (!nice)
-       //   convert_place = temp directory
-       //   return new filename in temp directory
-       // else
-       //   convert_place = original file directory
-       //   return original filename without the extension
-       //
-       // if it's a zipped one, than let LaTeX do the rest!!!
-       string filename_  = params().filename;
-       bool const zipped = zippedFile(filename_);
-
+       // LaTeX can cope if the graphics file doesn't exist, so just return the
+       // filename.
+       string const orig_file = params().filename;
+       string const orig_file_with_path =
+               MakeAbsPath(orig_file, buf->filePath());
+       lyxerr[Debug::GRAPHICS] << "prepareFile: " << orig_file << endl
+                   << "  with path: " << orig_file_with_path << endl;
+
+       if (!IsFileReadable(orig_file_with_path))
+               return orig_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!
+       bool const zipped = zippedFile(orig_file_with_path);
+       if (zipped)
+               lyxerr[Debug::GRAPHICS] << "it's a zipped file\n";
        if (zipped && params().noUnzip) {
-               lyxerr[Debug::GRAPHICS] << "don't unzip file or export latex"
-                                   << filename_ << endl;
-               return filename_;
+               lyxerr[Debug::GRAPHICS] << "pass file unzipped to LaTeX\n";
+               return orig_file;
        }
-       // only export latex without compiling the file
+
+       // "nice" means that the buffer is exported to LaTeX format but not
+       //        run through the LaTeX compiler.
+       // if (nice)
+       //     No conversion of the graphics file is needed.
+       //     Return the original filename without any extension.
        if (buf->niceFile)
-               return RemoveExtension(filename_);
+               return RemoveExtension(orig_file);
+
+       // We're going to be running the exported buffer through the LaTeX
+       // compiler, so must ensure that LaTeX can cope with the graphics
+       // file format.
+
+       // Perform all these manipulations on a temporary file if possible.
+       // If we are not using a temp dir, then temp_file contains the
+       // original file.
+       // to allow files with the same name in different dirs
+       // we manipulate the original file "any.dir/file.ext"
+       // to "any_dir_file.ext"! changing the dots in the
+       // dirname is important for the use of ChangeExtension
+       string temp_file(orig_file);
+       if (lyxrc.use_tempdir) {
+               string const ext_tmp = GetExtension(orig_file);
+               // without ext and /
+               temp_file = subst(
+                       ChangeExtension(temp_file, string()), "/", "_");
+               // without . and again with ext
+               temp_file = ChangeExtension(
+                       subst(temp_file, ".", "_"), ext_tmp);
+               // now we have any_dir_file.ext
+               temp_file = MakeAbsPath(temp_file, buf->tmppath);
+       }
+       lyxerr[Debug::GRAPHICS]
+               << "InsetGraphics::prepareFile. The temp file is: "
+               << temp_file << endl;
+
+       // If we are using a temp dir, then copy the file into it.
+       if (lyxrc.use_tempdir && !IsFileReadable(temp_file)) {
+               bool const success = lyx::copy(orig_file_with_path, temp_file);
+               lyxerr[Debug::GRAPHICS]
+                       << "InsetGraphics::prepareFile. Copying from "
+                       << orig_file << " to " << temp_file
+                       << (success ? " succeeded\n" : " failed\n");
+               if (!success) {
+                       Alert::alert(_("Cannot copy file"), orig_file,
+                                       _("into tempdir"));
+                       return orig_file;
+               }
+       }
 
-       // Enable these helper functions to find the file if it is stored as
-       // a relative path.
-       Path p(buf->filePath());
+       // Uncompress the file if necessary. If it has been uncompressed in
+       // a previous call to prepareFile, do nothing.
+       if (zipped) {
+               // What we want to end up with:
+               string const temp_file_unzipped =
+                       ChangeExtension(temp_file, string());
+
+               if (!IsFileReadable(temp_file_unzipped)) {
+                       // unzipFile generates a random filename, so move this
+                       // file where we want it to go.
+                       string const tmp = unzipFile(temp_file);
+                       lyx::copy(tmp, temp_file_unzipped);
+                       lyx::unlink(tmp);
+
+                       lyxerr[Debug::GRAPHICS]
+                               << "InsetGraphics::prepareFile. Unzipped to "
+                               << temp_file_unzipped << endl;
+               }
 
-       if (zipped)
-               filename_ = unzipFile(filename_);
+               // We have an uncompressed file where we expect it,
+               // so rename temp_file and continue.
+               temp_file = temp_file_unzipped;
+       }
 
-       string const from = getExtFromContents(filename_);
+       // Ascertain the graphics format that LaTeX requires.
+       // Make again an absolute path, maybe that we have no
+       // tempdir. Than temp_file=orig_file
+       string const from = lyxrc.use_tempdir ?
+               getExtFromContents(temp_file) :
+               getExtFromContents(MakeAbsPath(temp_file, buf->filePath()));
        string const to   = findTargetFormat(from);
 
+       // No conversion is needed. LaTeX can handle the graphics file as it is.
+       // This is true even if the orig_file is compressed.
        if (from == to) {
-               // No conversion needed!
-               return filename_;
+               return orig_file;
        }
 
-       string const temp = MakeAbsPath(filename_, buf->tmppath);
-       string const outfile_base = RemoveExtension(temp);
+       string const outfile_base = RemoveExtension(temp_file);
 
-       lyxerr[Debug::GRAPHICS] << "tempname = " << temp << "\n";
-       lyxerr[Debug::GRAPHICS] << "buf::tmppath = " << buf->tmppath << "\n";
-       lyxerr[Debug::GRAPHICS] << "filename_ = " << filename_ << "\n";
-       lyxerr[Debug::GRAPHICS] << "outfile_base = " << outfile_base << endl;
+       lyxerr[Debug::GRAPHICS]
+               << "InsetGraphics::prepareFile. The original file is "
+               << orig_file << "\n"
+               << "A copy has been made and convert is to be called with:\n"
+               << "\tfile to convert = " << temp_file << '\n'
+               << "\toutfile_base = " << outfile_base << '\n'
+               << "\t from " << from << " to " << to << '\n';
 
-       converters.convert(buf, filename_, outfile_base, from, to);
-       return RemoveExtension(filename_);
+       converters.convert(buf, temp_file, outfile_base, from, to);
+       return RemoveExtension(temp_file);
 }
 
 
@@ -656,14 +724,26 @@ int InsetGraphics::latex(Buffer const *buf, ostream & os,
 {
        // If there is no file specified or not existing,
        // just output a message about it in the latex output.
-       lyxerr[Debug::GRAPHICS] << "[latex]filename = "
-                               << params().filename << endl;
-       string const message =
-           (IsFileReadable(MakeAbsPath(params().filename, buf->filePath()))
-               && !params().filename.empty()) ?
-                   string() :
-                   string("bb = 0 0 200 100, draft, type=eps]");
-       lyxerr[Debug::GRAPHICS] << "[latex]Messagestring = " << message << endl;
+       lyxerr[Debug::GRAPHICS]
+               << "insetgraphics::latex: Filename = "
+               << params().filename << endl;
+
+       // A missing (e)ps-extension is no problem for LaTeX, so
+       // we have to test three different cases
+       string const file_(MakeAbsPath(params().filename, buf->filePath()));
+       bool const file_exists =
+               !file_.empty() &&
+               (IsFileReadable(file_) ||               // original
+                IsFileReadable(file_ + ".eps") ||      // original.eps
+                IsFileReadable(file_ + ".ps"));        // original.ps
+       string const message = file_exists ?
+               string() : string("bb = 0 0 200 100, draft, type=eps]");
+       // if !message.empty() than there was no existing file
+       // "filename(.(e)ps)" found. In this case LaTeX
+       // draws only a rectangle with the above bb and the
+       // not found filename in it.
+       lyxerr[Debug::GRAPHICS]
+               << "InsetGraphics::latex. Message = \"" << message << '\"' << endl;
 
        // These variables collect all the latex code that should be before and
        // after the actual includegraphics command.
@@ -679,15 +759,19 @@ int InsetGraphics::latex(Buffer const *buf, ostream & os,
 
        // Write the options if there are any.
        string const opts = createLatexOptions();
-       lyxerr[Debug::GRAPHICS] << "[latex]opts = " << opts << endl;
+       lyxerr[Debug::GRAPHICS]
+               << "InsetGraphics::latex. Opts = " << opts << endl;
+
        if (!opts.empty() && !message.empty())
                before += ("[" + opts + ',' + message);
        else if (!message.empty())
                before += ('[' + message);
        else if (!opts.empty())
                before += ("[" + opts + ']');
-       lyxerr[Debug::GRAPHICS] << "[latex]before = " << before << endl;
-       lyxerr[Debug::GRAPHICS] << "[latex]after = " << after << endl;
+
+       lyxerr[Debug::GRAPHICS]
+               << "InsetGraphics::latex. Before = " << before
+               << "\nafter = " << after << endl;
 
        // Make the filename relative to the lyx file
        // and remove the extension so the LaTeX will use whatever is
@@ -743,7 +827,7 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
        if (params().filename.empty())
                return ;
 
-       features.includeFile(graphic_label, RemoveExtension(params_.filename));
+       features.includeFile(graphic_label, RemoveExtension(params().filename));
 
        features.require("graphicx");