]> git.lyx.org Git - lyx.git/blobdiff - src/EmbeddedFiles.cpp
Allow using \binom without amsmath and add support for \brace and \brack
[lyx.git] / src / EmbeddedFiles.cpp
index df3ed8513d88fb2ea4f0effd57c9eca4a2034750..666cb7acf26bcec6b40947f06d26538e388e7996 100644 (file)
@@ -34,6 +34,8 @@
 #include "support/ExceptionMessage.h"
 #include "support/FileZipListDir.h"
 
+#include <boost/assert.hpp>
+
 #include <sstream>
 #include <fstream>
 #include <utility>
@@ -46,8 +48,7 @@ namespace lyx {
 namespace Alert = frontend::Alert;
 
 EmbeddedFile::EmbeddedFile(string const & file, std::string const & buffer_path)
-       : DocFileName("", false), inzip_name_(""), embedded_(false), inset_list_(),
-       temp_path_("")
+       : DocFileName("", false), embedded_(false), inset_list_()
 {
        set(file, buffer_path);
 }
@@ -70,7 +71,7 @@ void EmbeddedFile::setInzipName(std::string const & name)
                return;
 
        // an enabled EmbeededFile should have this problem handled
-       BOOST_ASSERT(!enabled());
+       BOOST_ASSERT(!isEnabled());
        // file will be synced when it is enabled
        inzip_name_ = name;
 }
@@ -78,14 +79,14 @@ void EmbeddedFile::setInzipName(std::string const & name)
 
 string EmbeddedFile::embeddedFile() const
 {
-       BOOST_ASSERT(enabled());
+       BOOST_ASSERT(isEnabled());
        return temp_path_ + inzip_name_;
 }
 
 
 FileName EmbeddedFile::availableFile() const
 {
-       if (enabled() && embedded())
+       if (isEnabled() && embedded())
                return FileName(embeddedFile());
        else
                return *this;
@@ -94,7 +95,7 @@ FileName EmbeddedFile::availableFile() const
 
 string EmbeddedFile::latexFilename(std::string const & buffer_path) const
 {
-       return (enabled() && embedded()) ? inzip_name_ : relFilename(buffer_path);
+       return (isEnabled() && embedded()) ? inzip_name_ : relFilename(buffer_path);
 }
 
 
@@ -111,7 +112,7 @@ void EmbeddedFile::setEmbed(bool embed)
 }
 
 
-void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
+void EmbeddedFile::enable(bool enabled, Buffer const & buf, bool updateFile)
 {
        // This function will be called when
        // 1. through EmbeddedFiles::enable() when a file is read. Files
@@ -120,18 +121,20 @@ void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
        // 2. through menu item enable/disable. updateFile should be true.
        // 3. A single embedded file is added or modified. updateFile
        //    can be true or false.
-       LYXERR(Debug::FILES, (flag ? "Enable" : "Disable") 
+       LYXERR(Debug::FILES, (enabled ? "Enable" : "Disable") 
                << " " << absFilename() 
                << (updateFile ? " (update file)." : " (no update)."));
 
-       if (flag) {
-               temp_path_ = buf->temppath();
+       if (enabled) {
+               temp_path_ = buf.temppath();
                if (!suffixIs(temp_path_, '/'))
                        temp_path_ += '/';
                if (embedded() && updateFile)
                        updateFromExternalFile();
        } else {
-               if (embedded() && updateFile)
+               // when a new embeddeed file is created, it is not enabled, and 
+               // there is no need to extract.
+               if (isEnabled() && embedded() && updateFile)
                        extract();
                temp_path_ = "";
        }
@@ -140,7 +143,7 @@ void EmbeddedFile::enable(bool flag, Buffer const * buf, bool updateFile)
 
 bool EmbeddedFile::extract() const
 {
-       BOOST_ASSERT(enabled());
+       BOOST_ASSERT(isEnabled());
 
        string ext_file = absFilename();
        string emb_file = embeddedFile();
@@ -165,7 +168,7 @@ bool EmbeddedFile::extract() const
                // otherwise, ask if overwrite
                int ret = Alert::prompt(
                        _("Overwrite external file?"),
-                       bformat(_("External file %1$s already exists, do you want to overwrite it"),
+                       bformat(_("External file %1$s already exists, do you want to overwrite it?"),
                                from_utf8(ext_file)), 1, 1, _("&Overwrite"), _("&Cancel"));
                if (ret != 0)
                        // if the user does not want to overwrite, we still consider it
@@ -199,7 +202,7 @@ bool EmbeddedFile::extract() const
 
 bool EmbeddedFile::updateFromExternalFile() const
 {
-       BOOST_ASSERT(enabled());
+       BOOST_ASSERT(isEnabled());
 
        string ext_file = absFilename();
        string emb_file = embeddedFile();
@@ -251,6 +254,64 @@ bool EmbeddedFile::updateFromExternalFile() const
 }
 
 
+EmbeddedFile EmbeddedFile::copyTo(Buffer const & buf)
+{
+       EmbeddedFile file = EmbeddedFile(absFilename(), buf.filePath());
+       file.setEmbed(embedded());
+       file.enable(buf.embedded(), buf, false);
+       
+       // use external file.
+       if (!embedded())
+               return file;
+
+       LYXERR(Debug::FILES, "Copy " << availableFile()
+               << " to " << file.availableFile());
+
+       FileName from_file = availableFile();
+       FileName to_file = file.availableFile();
+
+       if (!from_file.exists()) {
+               // no from file
+               throw ExceptionMessage(ErrorException,
+                       _("Failed to copy embedded file"),
+                       bformat(_("Failed to embed file %1$s.\n"
+                          "Please check whether the source file is available"),
+                               from_utf8(absFilename())));
+               file.setEmbed(false);
+               return file;
+       }
+
+       // if destination file already exists ...
+       if (to_file.exists()) {
+               // no need to copy if the files are the same
+               if (checksum() == to_file.checksum())
+                       return file;
+               // other wise, ask if overwrite
+               int const ret = Alert::prompt(
+                       _("Update embedded file?"),
+                       bformat(_("Embedded file %1$s already exists, do you want to overwrite it"),
+                               from_utf8(to_file.absFilename())), 1, 1, _("&Overwrite"), _("&Cancel"));
+               if (ret != 0)
+                       // if the user does not want to overwrite, we still consider it
+                       // a successful operation.
+                       return file;
+       }
+       // copy file
+       // need to make directory?
+       FileName path = to_file.onlyPath();
+       if (!path.isDirectory())
+               path.createPath();
+       if (from_file.copyTo(to_file))
+               return file;
+       throw ExceptionMessage(ErrorException,
+               _("Copy file failure"),
+               bformat(_("Cannot copy file %1$s to %2$s.\n"
+                          "Please check whether the directory exists and is writeable."),
+                               from_utf8(from_file.absFilename()), from_utf8(to_file.absFilename())));
+       return file;
+}
+
+
 void EmbeddedFile::updateInsets() const
 {
        vector<Inset const *>::const_iterator it = inset_list_.begin();
@@ -331,7 +392,7 @@ std::string EmbeddedFile::calcInzipName(std::string const & buffer_path)
 
 void EmbeddedFile::syncInzipFile(std::string const & buffer_path)
 {
-       BOOST_ASSERT(enabled());
+       BOOST_ASSERT(isEnabled());
        string old_emb_file = temp_path_ + '/' + inzip_name_;
        FileName old_emb(old_emb_file);
 
@@ -387,7 +448,7 @@ bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs)
 }
 
 
-void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
+void EmbeddedFileList::enable(bool enabled, Buffer & buffer, bool updateFile)
 {
        // update embedded file list
        update(buffer);
@@ -398,25 +459,24 @@ void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
        iterator it_end = end();
        // an exception may be thrown
        for (; it != it_end; ++it) {
-               it->enable(flag, &buffer, updateFile);
+               it->enable(enabled, buffer, updateFile);
                if (it->embedded())
                        ++count_embedded;
                else
                        ++count_external;
        }
        // if operation is successful (no exception is thrown)
-       buffer.markDirty();
-       buffer.params().embedded = flag;
+       buffer.params().embedded = enabled;
 
        // if the operation is successful, update insets
        for (it = begin(); it != it_end; ++it)
                it->updateInsets();
 
-       if (!updateFile)
+       if (!updateFile || (count_external == 0 && count_embedded == 0))
                return;
 
        // show result
-       if (flag) {
+       if (enabled) {
                docstring const msg = bformat(_("%1$d external files are ignored.\n"
                        "%2$d embeddable files are embedded.\n"), count_external, count_embedded);
                Alert::information(_("Packing all files"), msg);
@@ -431,29 +491,52 @@ void EmbeddedFileList::enable(bool flag, Buffer & buffer, bool updateFile)
 void EmbeddedFileList::registerFile(EmbeddedFile const & file,
        Inset const * inset, Buffer const & buffer)
 {
-       BOOST_ASSERT(!buffer.embedded() || file.enabled());
+       BOOST_ASSERT(!buffer.embedded() || file.isEnabled());
+
+       string newfile = file.absFilename();
+       iterator efp = findFile(newfile);
+       if (efp != end()) {
+               if (efp->embedded() != file.embedded()) {
+                       Alert::error(_("Wrong embedding status."),
+                               bformat(_("File %1$s is included in more than one insets, "
+                                       "but with different embedding status. Assuming embedding status."),
+                                       from_utf8(efp->outputFilename())));
+                       efp->setEmbed(true);
+                       // update the inset with this embedding status.
+                       const_cast<Inset*>(inset)->updateEmbeddedFile(*efp);
+               }
+               efp->addInset(inset);
+               return;
+       }
+       file.clearInsets();
+       push_back(file);
+       back().addInset(inset);
+}
+
 
+EmbeddedFileList::const_iterator 
+       EmbeddedFileList::findFile(std::string const & filename) const
+{
+       // try to find this file from the list
+       std::vector<EmbeddedFile>::const_iterator it = begin();
+       std::vector<EmbeddedFile>::const_iterator it_end = end();
+       for (; it != it_end; ++it)
+               if (it->absFilename() == filename)
+                       return it;
+       return end();
+}
+
+
+EmbeddedFileList::iterator 
+       EmbeddedFileList::findFile(std::string const & filename)
+{
        // try to find this file from the list
        std::vector<EmbeddedFile>::iterator it = begin();
        std::vector<EmbeddedFile>::iterator it_end = end();
        for (; it != it_end; ++it)
-               if (it->absFilename() == file.absFilename()) {
-                       if (it->embedded() != file.embedded()) {
-                               Alert::error(_("Wrong embedding status."),
-                                       bformat(_("File %1$s is included in more than one insets, "
-                                               "but with different embedding status. Assuming embedding status."),
-                                               from_utf8(it->outputFilename())));
-                               it->setEmbed(true);
-                               // update the inset with this embedding status.
-                               const_cast<Inset*>(inset)->updateEmbeddedFile(*it);
-                       }
-                       it->addInset(inset);
-                       return;
-               }
-       //
-       file.clearInsets();
-       push_back(file);
-       back().addInset(inset);
+               if (it->absFilename() == filename)
+                       return it;
+       return end();
 }
 
 
@@ -487,7 +570,7 @@ void EmbeddedFileList::validate(Buffer const & buffer)
        for (; e_it != e_end; ++e_it) {
                EmbeddedFile file = EmbeddedFile(*e_it, buffer.filePath());
                // do not update from external file
-               file.enable(true, &buffer, false);
+               file.enable(true, buffer, false);
                // but we do need to check file existence.
                if (!FileName(file.embeddedFile()).exists())
                        throw ExceptionMessage(ErrorException, _("Failed to open file"),
@@ -511,7 +594,7 @@ void EmbeddedFileList::update(Buffer const & buffer)
        for (; it != it_end; ++it) {
                EmbeddedFile file = EmbeddedFile(*it, buffer.filePath());
                file.setEmbed(true);
-               file.enable(buffer.embedded(), &buffer, false);
+               file.enable(buffer.embedded(), buffer, false);
                insert(end(), file);
        }
 }