]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetGraphics.cpp
Remove all BufferParam arguments in InsetXXX methods (since insets know about their...
[lyx.git] / src / insets / InsetGraphics.cpp
index f19dd90f1af3e11192f43080b7b2e4c568ece98e..9decdaaa80cc0b0ee08a5ee6bb54bb22d922b202 100644 (file)
@@ -4,7 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Baruch Even
- * \author Herbert Voß
+ * \author Herbert Voß
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -22,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:
@@ -55,14 +53,13 @@ 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 "InsetIterator.h"
 #include "LaTeXFeatures.h"
 #include "Length.h"
 #include "Lexer.h"
@@ -70,20 +67,22 @@ 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"
 #include "support/Systemcall.h"
 
-#include <boost/bind.hpp>
 #include <boost/tuple/tuple.hpp>
 
 #include <algorithm>
@@ -102,8 +101,9 @@ namespace {
 /// Note that \p format may be unknown (i. e. an empty string)
 string findTargetFormat(string const & format, OutputParams const & runparams)
 {
-       // Are we using latex or pdflatex?
-       if (runparams.flavor == OutputParams::PDFLATEX) {
+       // Are we using latex or XeTeX/pdflatex?
+       if (runparams.flavor == OutputParams::PDFLATEX
+           || runparams.flavor == OutputParams::XETEX) {
                LYXERR(Debug::GRAPHICS, "findTargetFormat: PDF mode");
                Format const * const f = formats.getFormat(format);
                // Convert vector graphics to pdf
@@ -124,19 +124,47 @@ 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)
        : Inset(ig),
-         boost::signals::trackable(),
-               graphic_label(sgml::uniqueID(from_ascii("graph"))),
+         graphic_label(sgml::uniqueID(from_ascii("graph"))),
          graphic_(new RenderGraphic(*ig.graphic_, this))
 {
        setParams(ig.params());
@@ -151,46 +179,41 @@ Inset * InsetGraphics::clone() const
 
 InsetGraphics::~InsetGraphics()
 {
-       InsetGraphicsMailer(*this).hideDialog();
+       hideDialogs("graphics", this);
+       delete graphic_;
 }
 
 
 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);
+       case LFUN_INSET_EDIT: {
+               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 {
-                               p.filename.enable(buffer.embedded(), &buffer);
-                       } catch (ExceptionMessage const & message) {
-                               Alert::error(message.title_, message.details_);
-                               // do not set parameter if an error happens
-                               break;
-                       }
-                       setParams(p);
-               } else
+               string2params(to_utf8(cmd.argument()), buffer(), p);
+               if (p.filename.empty()) {
                        cur.noUpdate();
+                       break;
+               }
+
+               setParams(p);
+               // if the inset is part of a graphics group, all the
+               // other members should be updated too.
+               if (!params_.groupId.empty())
+                       graphics::unifyGraphicsGroups(buffer(), 
+                                                     to_utf8(cmd.argument()));
                break;
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetGraphicsMailer(*this).updateDialog(&cur.bv());
-               break;
-
-       case LFUN_MOUSE_RELEASE:
-               if (!cur.selection())
-                       InsetGraphicsMailer(*this).showDialog(&cur.bv());
+               cur.bv().updateDialog("graphics", params2string(params(), buffer()));
                break;
 
        default:
@@ -204,10 +227,10 @@ bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
        switch (cmd.action) {
-       case LFUN_GRAPHICS_EDIT:
+       case LFUN_INSET_EDIT:
        case LFUN_INSET_MODIFY:
        case LFUN_INSET_DIALOG_UPDATE:
-               flag.enabled(true);
+               flag.setEnabled(true);
                return true;
 
        default:
@@ -216,34 +239,14 @@ bool InsetGraphics::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetGraphics::registerEmbeddedFiles(Buffer const & buffer,
-       EmbeddedFileList & files) const
-{
-       files.registerFile(params().filename, this, buffer);
-}
-
-
-void InsetGraphics::updateEmbeddedFile(Buffer const & buf,
-       EmbeddedFile const & file)
+bool InsetGraphics::showInsetDialog(BufferView * bv) const
 {
-       // when embedding is enabled, change of embedding status leads to actions
-       EmbeddedFile temp = file;
-       temp.enable(buf.embedded(), &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());
+       bv->showDialog("graphics", params2string(params(), bv->buffer()),
+               const_cast<InsetGraphics *>(this));
+       return true;
 }
 
 
-void InsetGraphics::edit(Cursor & cur, bool, EntryDirection)
-{
-       InsetGraphicsMailer(*this).showDialog(&cur.bv());
-}
-
 
 void InsetGraphics::metrics(MetricsInfo & mi, Dimension & dim) const
 {
@@ -257,58 +260,23 @@ void InsetGraphics::draw(PainterInfo & pi, int x, int y) const
 }
 
 
-Inset::EDITABLE InsetGraphics::editable() const
-{
-       return IS_EDITABLE;
-}
-
-
-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.embedded(), &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
@@ -367,7 +335,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()) {
@@ -424,7 +392,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() ;-)
@@ -561,16 +530,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)
@@ -578,11 +546,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.
@@ -598,7 +566,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;
@@ -632,7 +600,8 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                        // noUnzip parameter meaningless.
                        LYXERR(Debug::GRAPHICS, "\tpass zipped file to LaTeX.");
 
-                       FileName const bb_orig_file = FileName(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,
@@ -640,7 +609,8 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
                        } else {
                                // LaTeX needs the bounding box file in the
                                // tmp dir
-                               FileName bb_file = FileName(changeExtension(temp_file.absFilename(), "bb"));
+                               FileName bb_file =
+                                       FileName(changeExtension(temp_file.absFilename(), "bb"));
                                boost::tie(status, bb_file) =
                                        copyFileIfNeeded(bb_orig_file, bb_file);
                                if (status == FAILURE)
@@ -688,15 +658,17 @@ string const InsetGraphics::prepareFile(Buffer const & buf,
        LYXERR(Debug::GRAPHICS, "\tthe orig file is: " << orig_file);
 
        if (from == to) {
-               if (!runparams.nice && getExtension(temp_file.absFilename()) != ext) {
+               if (!runparams.nice && !FileName(temp_file).hasExtension(ext)) {
                        // 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(changeExtension(temp_file.absFilename(), ext));
+                       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 = FileName(changeExtension(source_file.absFilename(), ext));
+                               source_file = 
+                                       FileName(changeExtension(source_file.absFilename(), ext));
                        } else {
                                LYXERR(Debug::GRAPHICS, "Could not rename file `"
                                        << temp_file << "' to `" << new_file << "'.");
@@ -734,7 +706,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,
@@ -747,7 +719,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,
@@ -769,13 +741,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";
@@ -798,7 +763,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);
@@ -809,8 +774,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.
@@ -820,7 +784,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 << '>';
 
@@ -860,7 +824,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
@@ -900,13 +864,11 @@ void InsetGraphics::validate(LaTeXFeatures & features) const
 
        if (features.runparams().nice) {
                Buffer const * masterBuffer = features.buffer().masterBuffer();
-               string const rel_file = removeExtension(params().filename.relFilename(masterBuffer->filePath()));
+               string const rel_file = removeExtension(
+                       params().filename.relFilename(masterBuffer->filePath()));
                if (contains(rel_file, "."))
                        features.require("lyxdot");
        }
-
-       if (params().subcaption)
-               features.require("subfigure");
 }
 
 
@@ -941,52 +903,139 @@ void InsetGraphics::editGraphics(InsetGraphicsParams const & p,
 }
 
 
-string const InsetGraphicsMailer::name_("graphics");
+void InsetGraphics::addToToc(DocIterator const & cpit)
+{
+       TocBackend & backend = buffer().tocBackend();
 
-InsetGraphicsMailer::InsetGraphicsMailer(InsetGraphics & inset)
-       : inset_(inset)
-{}
+       //FIXME UNICODE
+       docstring const str = from_utf8(params_.filename.onlyFileName());
+       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();
 }
 
+namespace graphics {
+
+void getGraphicsGroups(Buffer const & b, set<string> & ids)
+{
+       Inset & inset = b.inset();
+       InsetIterator it  = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
+       for (; it != end; ++it)
+               if (it->lyxCode() == GRAPHICS_CODE) {
+                       InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+                       InsetGraphicsParams inspar = ins.getParams();
+                       if (!inspar.groupId.empty())
+                               ids.insert(inspar.groupId);
+               }
+}
+
+
+int countGroupMembers(Buffer const & b, string const & groupId)
+{
+       int n = 0;
+       if (groupId.empty())
+               return n;
+       Inset & inset = b.inset();
+       InsetIterator it = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
+       for (; it != end; ++it)
+               if (it->lyxCode() == GRAPHICS_CODE) {
+                       InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+                       if (ins.getParams().groupId == groupId)
+                               ++n;
+               }
+       return n;
+}
+
+
+string getGroupParams(Buffer const & b, string const & groupId)
+{
+       if (groupId.empty())
+               return string();
+       Inset & inset = b.inset();
+       InsetIterator it  = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
+       for (; it != end; ++it)
+               if (it->lyxCode() == GRAPHICS_CODE) {
+                       InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+                       InsetGraphicsParams inspar = ins.getParams();
+                       if (inspar.groupId == groupId) {
+                               InsetGraphicsParams tmp = inspar;
+                               tmp.filename.erase();
+                               return InsetGraphics::params2string(tmp, b);
+                       }
+               }
+       return string();
+}
+
+
+void unifyGraphicsGroups(Buffer & b, string const & argument)
+{
+       InsetGraphicsParams params;
+       InsetGraphics::string2params(argument, b, params);
+
+       b.undo().beginUndoGroup();
+       Inset & inset = b.inset();
+       InsetIterator it  = inset_iterator_begin(inset);
+       InsetIterator const end = inset_iterator_end(inset);
+       for (; it != end; ++it) {
+               if (it->lyxCode() == GRAPHICS_CODE) {
+                       InsetGraphics & ins = static_cast<InsetGraphics &>(*it);
+                       InsetGraphicsParams inspar = ins.getParams();
+                       if (params.groupId == inspar.groupId) {
+                               b.undo().recordUndo(it);
+                               params.filename = inspar.filename;
+                               ins.setParams(params);
+                       }
+               }
+       }
+       b.undo().endUndoGroup();
+}
+
+
+InsetGraphics * getCurrentGraphicsInset(Cursor const & cur)
+{
+       Inset * instmp = &cur.inset();
+       if (instmp->lyxCode() != GRAPHICS_CODE)
+               instmp = cur.nextInset();
+       if (!instmp || instmp->lyxCode() != GRAPHICS_CODE)
+               return 0;
+
+       return static_cast<InsetGraphics *>(instmp);
+}
+
+} // namespace graphics
 
 } // namespace lyx