]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetGraphics.cpp
Complete the removal of the embedding stuff. Maybe. It's hard to be sure we got every...
[features.git] / src / insets / InsetGraphics.cpp
index 36ad1b7f40d6a89529e08f5efe4e06d208172a61..51a527fa0c02408b3a4bc7e1b480fdb29035901b 100644 (file)
@@ -15,7 +15,6 @@ TODO
     * What advanced features the users want to do?
       Implement them in a non latex dependent way, but a logical way.
       LyX should translate it to latex or any other fitting format.
-    * Add a way to roll the image file into the file format.
     * When loading, if the image is not found in the expected place, try
       to find it in the clipart, or in the same directory with the image.
     * The image choosing dialog could show thumbnails of the image formats
@@ -23,8 +22,6 @@ TODO
       filename.
     * Add support for the 'picins' package.
     * Add support for the 'picinpar' package.
-    * Improve support for 'subfigure' - Allow to set the various options
-      that are possible.
 */
 
 /* NOTES:
@@ -56,14 +53,12 @@ TODO
 #include "BufferView.h"
 #include "Converter.h"
 #include "Cursor.h"
-#include "support/debug.h"
 #include "DispatchResult.h"
 #include "ErrorList.h"
 #include "Exporter.h"
 #include "Format.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "Length.h"
 #include "Lexer.h"
@@ -71,14 +66,17 @@ TODO
 #include "Mover.h"
 #include "OutputParams.h"
 #include "sgml.h"
-#include "EmbeddedFiles.h"
+#include "TocBackend.h"
 
 #include "frontends/alert.h"
+#include "frontends/Application.h"
 
 #include "support/convert.h"
+#include "support/debug.h"
 #include "support/docstream.h"
 #include "support/ExceptionMessage.h"
 #include "support/filetools.h"
+#include "support/gettext.h"
 #include "support/lyxlib.h"
 #include "support/lstrings.h"
 #include "support/os.h"
@@ -125,13 +123,40 @@ string findTargetFormat(string const & format, OutputParams const & runparams)
        return format;
 }
 
+
+void readInsetGraphics(Lexer & lex, string const & bufpath,
+       InsetGraphicsParams & params)
+{
+       bool finished = false;
+
+       while (lex.isOK() && !finished) {
+               lex.next();
+
+               string const token = lex.getString();
+               LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
+
+               if (token.empty())
+                       continue;
+
+               if (token == "\\end_inset") {
+                       finished = true;
+               } else {
+                       if (!params.Read(lex, token, bufpath))
+                               lyxerr << "Unknown token, " << token << ", skipping."
+                                       << endl;
+               }
+       }
+}
+
 } // namespace anon
 
 
-InsetGraphics::InsetGraphics()
+InsetGraphics::InsetGraphics(Buffer & buf)
        : graphic_label(sgml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(this))
-{}
+{
+       Inset::setBuffer(buf);
+}
 
 
 InsetGraphics::InsetGraphics(InsetGraphics const & ig)
@@ -152,7 +177,7 @@ Inset * InsetGraphics::clone() const
 
 InsetGraphics::~InsetGraphics()
 {
-       InsetGraphicsMailer(*this).hideDialog();
+       hideDialogs("graphics", this);
 }
 
 
@@ -160,38 +185,32 @@ void InsetGraphics::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
        case LFUN_GRAPHICS_EDIT: {
-               Buffer const & buffer = cur.bv().buffer();
-               InsetGraphicsParams p;
-               InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               editGraphics(p, buffer);
+               InsetGraphicsParams p = params();
+               if (!cmd.argument().empty())
+                       string2params(to_utf8(cmd.argument()), buffer(), p);
+               editGraphics(p, buffer());
                break;
        }
 
        case LFUN_INSET_MODIFY: {
-               Buffer const & buffer = cur.buffer();
                InsetGraphicsParams p;
-               InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               if (!p.filename.empty()) {
-                       try {
-                               updateEmbeddedFile(buffer, p.filename);
-                       } catch (ExceptionMessage const & message) {
-                               Alert::error(message.title_, message.details_);
-                               // do not set parameter if an error happens
-                               break;
-                       }
+               string2params(to_utf8(cmd.argument()), buffer(), p);
+               if (!p.filename.empty())
                        setParams(p);
-               else
+               else
                        cur.noUpdate();
                break;
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetGraphicsMailer(*this).updateDialog(&cur.bv());
+               cur.bv().updateDialog("graphics", params2string(params(),
+cur.bv().buffer()));
                break;
 
        case LFUN_MOUSE_RELEASE:
-               if (!cur.selection())
-                       InsetGraphicsMailer(*this).showDialog(&cur.bv());
+               if (!cur.selection() && cmd.button() == mouse_button::button1)
+                       cur.bv().showDialog("graphics", params2string(params(),
+cur.bv().buffer()), this);
                break;
 
        default:
@@ -217,32 +236,10 @@ bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetGraphics::registerEmbeddedFiles(Buffer const &, 
-       EmbeddedFiles & files) const
+void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
 {
-       files.registerFile(params().filename, this);
-}
-
-
-void InsetGraphics::updateEmbeddedFile(Buffer const & buf,
-       EmbeddedFile const & file)
-{
-       // when embedding is enabled, change of embedding status leads to actions
-       EmbeddedFile temp = file;
-       temp.enable(buf.embeddedFiles().enabled(), &buf);
-       // this will not be set if an exception is thorwn in enable()
-       params_.filename = temp;
-
-       LYXERR(Debug::FILES, "Update InsetGraphic with File " 
-               << params_.filename.toFilesystemEncoding() 
-               << ", embedding status: " << params_.filename.embedded()
-               << ", enabled: " << params_.filename.enabled());
-}
-
-
-void InsetGraphics::edit(Cursor & cur, bool)
-{
-       InsetGraphicsMailer(*this).showDialog(&cur.bv());
+       cur.bv().showDialog("graphics", params2string(params(),
+               cur.bv().buffer()), this);
 }
 
 
@@ -264,52 +261,23 @@ Inset::EDITABLE InsetGraphics::editable() const
 }
 
 
-void InsetGraphics::write(Buffer const & buf, ostream & os) const
+void InsetGraphics::write(ostream & os) const
 {
        os << "Graphics\n";
-       params().Write(os, buf);
+       params().Write(os, buffer());
 }
 
 
-void InsetGraphics::read(Buffer const & buf, Lexer & lex)
+void InsetGraphics::read(Lexer & lex)
 {
-       string const token = lex.getString();
-
-       if (token == "Graphics")
-               readInsetGraphics(lex, buf.filePath());
-       else
-               LYXERR(Debug::GRAPHICS, "Not a Graphics inset!");
-
-       params_.filename.enable(buf.embeddedFiles().enabled(), &buf);
+       lex.setContext("InsetGraphics::read");
+       //lex >> "Graphics";
+       readInsetGraphics(lex, buffer().filePath(), params_);
        graphic_->update(params().as_grfxParams());
 }
 
 
-void InsetGraphics::readInsetGraphics(Lexer & lex, string const & bufpath)
-{
-       bool finished = false;
-
-       while (lex.isOK() && !finished) {
-               lex.next();
-
-               string const token = lex.getString();
-               LYXERR(Debug::GRAPHICS, "Token: '" << token << '\'');
-
-               if (token.empty())
-                       continue;
-
-               if (token == "\\end_inset") {
-                       finished = true;
-               } else {
-                       if (!params_.Read(lex, token, bufpath))
-                               lyxerr << "Unknown token, " << token << ", skipping."
-                                       << endl;
-               }
-       }
-}
-
-
-string const InsetGraphics::createLatexOptions() const
+string InsetGraphics::createLatexOptions() 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
@@ -368,7 +336,7 @@ string const InsetGraphics::createLatexOptions() const
 }
 
 
-docstring const InsetGraphics::toDocbookLength(Length const & len) const
+docstring InsetGraphics::toDocbookLength(Length const & len) const
 {
        odocstringstream result;
        switch (len.unit()) {
@@ -425,7 +393,8 @@ docstring const InsetGraphics::toDocbookLength(Length const & len) const
        return result.str();
 }
 
-docstring const InsetGraphics::createDocBookAttributes() const
+
+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() ;-)
@@ -562,16 +531,15 @@ string const stripExtensionIfPossible(string const & file, string const & to, bo
 } // namespace anon
 
 
-string const InsetGraphics::prepareFile(Buffer const & buf,
-                                       OutputParams const & runparams) const
+string InsetGraphics::prepareFile(OutputParams const & runparams) const
 {
        // The following code depends on non-empty filenames
        if (params().filename.empty())
                return string();
 
-       string const orig_file = params().filename.availableFile().absFilename();
+       string const orig_file = params().filename.absFilename();
        // this is for dryrun and display purposes, do not use latexFilename
-       string const rel_file = params().filename.relFilename(buf.filePath());
+       string const rel_file = params().filename.relFilename(buffer().filePath());
 
        // previewing source code, no file copying or file format conversion
        if (runparams.dryrun)
@@ -579,11 +547,11 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 
        // temp_file will contain the file for LaTeX to act on if, for example,
        // we move it to a temp dir or uncompress it.
-       FileName temp_file = params().filename.availableFile();
+       FileName temp_file = params().filename;
 
        // The master buffer. This is useful when there are multiple levels
        // of include files
-       Buffer const * masterBuffer = buf.masterBuffer();
+       Buffer const * masterBuffer = buffer().masterBuffer();
 
        // Return the output name if we are inside a comment or the file does
        // not exist.
@@ -599,7 +567,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 
        GraphicsCopyStatus status;
        boost::tie(status, temp_file) =
-                       copyToDirIfNeeded(params().filename.availableFile(), temp_path);
+                       copyToDirIfNeeded(params().filename, temp_path);
 
        if (status == FAILURE)
                return orig_file;
@@ -735,7 +703,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 
        // 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,
+       if (theConverters().convert(&buffer(), temp_file, to_file, params().filename,
                               from, to, el,
                               Converters::try_default | Converters::try_cache)) {
                runparams.exportdata->addExternalFile(tex_format,
@@ -748,7 +716,7 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
 }
 
 
-int InsetGraphics::latex(Buffer const & buf, odocstream & os,
+int InsetGraphics::latex(odocstream & os,
                         OutputParams const & runparams) const
 {
        // If there is no file specified or not existing,
@@ -770,13 +738,6 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os,
        // after the actual includegraphics command.
        string before;
        string after;
-       // Do we want subcaptions?
-       if (params().subcaption) {
-               if (runparams.moving_arg)
-                       before += "\\protect";
-               before += "\\subfigure[" + params().subcaptionText + "]{";
-               after = '}';
-       }
 
        if (runparams.moving_arg)
                before += "\\protect";
@@ -799,7 +760,7 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os,
        // Convert the file if necessary.
        // Remove the extension so LaTeX will use whatever is appropriate
        // (when there are several versions in different formats)
-       latex_str += prepareFile(buf, runparams);
+       latex_str += prepareFile(runparams);
        latex_str += '}' + after;
        // FIXME UNICODE
        os << from_utf8(latex_str);
@@ -810,8 +771,7 @@ int InsetGraphics::latex(Buffer const & buf, odocstream & os,
 }
 
 
-int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
-                            OutputParams const &) const
+int InsetGraphics::plaintext(odocstream & os, OutputParams const &) const
 {
        // No graphics in ascii output. Possible to use gifscii to convert
        // images to ascii approximation.
@@ -821,7 +781,7 @@ int InsetGraphics::plaintext(Buffer const & buf, odocstream & os,
        // FIXME UNICODE
        // FIXME: We have no idea what the encoding of the filename is
 
-       docstring const str = bformat(buf.B_("Graphics file: %1$s"),
+       docstring const str = bformat(buffer().B_("Graphics file: %1$s"),
                                      from_utf8(params().filename.absFilename()));
        os << '<' << str << '>';
 
@@ -861,7 +821,7 @@ static int writeImageObject(char const * format, odocstream & os,
 // 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 &, odocstream & os,
+int InsetGraphics::docbook(odocstream & os,
                           OutputParams const & runparams) const
 {
        // In DocBook v5.0, the graphic tag will be eliminated from DocBook, will
@@ -905,9 +865,6 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
                if (contains(rel_file, "."))
                        features.require("lyxdot");
        }
-
-       if (params().subcaption)
-               features.require("subfigure");
 }
 
 
@@ -942,48 +899,42 @@ void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
 }
 
 
-string const InsetGraphicsMailer::name_("graphics");
+void InsetGraphics::addToToc(ParConstIterator const & cpit) const
+{
+       TocBackend & backend = buffer().tocBackend();
 
-InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
-       : inset_(inset)
-{}
+       docstring const str = params_.filename.displayName();
+       backend.toc("graphics").push_back(TocItem(cpit, 0, str));
+}
 
 
-string const InsetGraphicsMailer::inset2string(Buffer const & buffer) const
+docstring InsetGraphics::contextMenu(BufferView const &, int, int) const
 {
-       return params2string(inset_.params(), buffer);
+       return from_ascii("context-graphics");
 }
 
 
-void InsetGraphicsMailer::string2params(string const & in,
-                                       Buffer const & buffer,
-                                       InsetGraphicsParams & params)
+void InsetGraphics::string2params(string const & in, Buffer const & buffer,
+       InsetGraphicsParams & params)
 {
-       params = InsetGraphicsParams();
        if (in.empty())
                return;
 
        istringstream data(in);
-       Lexer lex(0,0);
+       Lexer lex;
        lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (!lex || name != name_)
-               return print_mailer_error("InsetGraphicsMailer", in, 1, name_);
-
-       InsetGraphics inset;
-       inset.readInsetGraphics(lex, buffer.filePath());
-       params = inset.params();
+       lex.setContext("InsetGraphics::string2params");
+       lex >> "graphics";
+       params = InsetGraphicsParams();
+       readInsetGraphics(lex, buffer.filePath(), params);
 }
 
 
-string const
-InsetGraphicsMailer::params2string(InsetGraphicsParams const & params,
-                                  Buffer const & buffer)
+string InsetGraphics::params2string(InsetGraphicsParams const & params,
+       Buffer const & buffer)
 {
        ostringstream data;
-       data << name_ << ' ';
+       data << "graphics" << ' ';
        params.Write(data, buffer);
        data << "\\end_inset\n";
        return data.str();