]> git.lyx.org Git - lyx.git/blobdiff - src/EmbeddedFiles.cpp
Embedding: prepare to read/write manifest in .lyx file
[lyx.git] / src / EmbeddedFiles.cpp
index bad37e77898b446a8adbdb2a0cf9d30e29121e76..155ed86ac787c1b57f58d669b59c9bc71f0bf482 100644 (file)
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "Paragraph.h"
-#include "ParIterator.h"
+#include "InsetIterator.h"
 #include "debug.h"
 #include "gettext.h"
 #include "Format.h"
+#include "Lexer.h"
+#include "ErrorList.h"
 
 #include "frontends/alert.h"
 
@@ -31,6 +33,9 @@
 #include "support/lyxlib.h"
 #include "support/lstrings.h"
 
+#include "LyX.h"
+#include "Session.h"
+
 #include <sstream>
 #include <fstream>
 #include <utility>
@@ -67,12 +72,12 @@ using support::makedir;
 
 
 EmbeddedFile::EmbeddedFile(string const & file, string const & inzip_name,
-       bool embed, ParConstIterator const & pit)
+       bool embed, Inset const * inset)
        : DocFileName(file, true), inzip_name_(inzip_name), embedded_(embed),
-               valid_(true), par_it_()
+               valid_(true), inset_list_()
 {
-       if (pit != ParConstIterator())
-               par_it_.push_back(pit);
+       if (inset != NULL)
+               inset_list_.push_back(inset);
 }
 
 
@@ -82,17 +87,39 @@ string EmbeddedFile::embeddedFile(Buffer const * buf) const
 }
 
 
-void EmbeddedFile::addParIter(ParConstIterator const & pit)
+void EmbeddedFile::addInset(Inset const * inset)
 {
-       par_it_.push_back(pit);
+       inset_list_.push_back(inset);
 }
 
 
-int EmbeddedFile::parID(int idx) const
+Inset const * EmbeddedFile::inset(int idx) const
 {
        BOOST_ASSERT(idx < refCount());
        // some embedded file do not have a valid par iterator
-       return par_it_[idx]->id();
+       return inset_list_[idx];
+}
+
+
+void EmbeddedFile::saveBookmark(Buffer const * buf, int idx) const
+{
+       Inset const * ptr = inset(idx);
+       // This might not be the most efficient method ... 
+       for (InsetIterator it = inset_iterator_begin(buf->inset()); it; ++it)
+               if (&(*it) == ptr) {
+                       // this is basically BufferView::saveBookmark(0)
+                       LyX::ref().session().bookmarks().save(
+                               FileName(buf->fileName()),
+                               it.bottom().pit(),
+                               it.bottom().pos(),
+                               it.paragraph().id(),
+                               it.pos(),
+                               0
+                       );
+               }
+       // this inset can not be located. There is something wrong that needs
+       // to be fixed.
+       BOOST_ASSERT(true);
 }
 
 
@@ -107,8 +134,8 @@ string EmbeddedFile::availableFile(Buffer const * buf) const
 
 void EmbeddedFile::invalidate()
 {
-       // Clear par_it_ because they will be registered again.
-       par_it_.clear();
+       // Clear inset_list_ because they will be registered again.
+       inset_list_.clear();
        valid_ = false;
 }
 
@@ -219,7 +246,7 @@ bool EmbeddedFiles::enable(bool flag)
 
 
 void EmbeddedFiles::registerFile(string const & filename,
-       bool embed, ParConstIterator const & pit)
+       bool embed, Inset const * inset, string const & inzipName)
 {
        // filename can be relative or absolute, translate to absolute filename
        string abs_filename = makeAbsPath(filename, buffer_->filePath()).absFilename();
@@ -231,19 +258,13 @@ void EmbeddedFiles::registerFile(string const & filename,
                        break;
        // find this filename, keep the original embedding status
        if (it != file_list_.end()) {
-               it->addParIter(pit);
-               // if the file is embedded, the embedded file should have exist
-               // check for this to ensure that our logic is correct
-               if (it->embedded())
-                       BOOST_ASSERT(fs::exists(it->embeddedFile(buffer_)));
+               it->addInset(inset);
                it->validate();
                return;
        }
        // try to be more careful
        file_list_.push_back(EmbeddedFile(abs_filename, 
-               getInzipName(abs_filename), embed, pit));
-       // validate if things are OK
-       BOOST_ASSERT(fs::exists(file_list_.back().availableFile(buffer_)));
+               getInzipName(abs_filename, inzipName), embed, inset));
 }
 
 
@@ -260,20 +281,8 @@ void EmbeddedFiles::update()
                if (it->refCount() > 0)
                        it->invalidate();
 
-       ParIterator pit = buffer_->par_iterator_begin();
-       ParIterator pit_end = buffer_->par_iterator_end();
-       for (; pit != pit_end; ++pit) {
-               // For each paragraph, traverse its insets and register embedded files
-               InsetList::const_iterator iit = pit->insetlist.begin();
-               InsetList::const_iterator iit_end = pit->insetlist.end();
-               for (; iit != iit_end; ++iit) {
-                       Inset & inset = *iit->inset;
-                       inset.registerEmbeddedFiles(*buffer_, *this, pit);
-               }
-       }
-       LYXERR(Debug::FILES) << "Manifest updated: " << endl
-               << *this
-               << "End Manifest" << endl;
+       for (InsetIterator it = inset_iterator_begin(buffer_->inset()); it; ++it)
+               it->registerEmbeddedFiles(*buffer_, *this);
 }
 
 
@@ -281,17 +290,11 @@ bool EmbeddedFiles::write(DocFileName const & filename)
 {
        // file in the temporary path has the content
        string const content = FileName(addName(buffer_->temppath(),
-               onlyFilename(filename.toFilesystemEncoding()))).toFilesystemEncoding();
+               "content.lyx")).toFilesystemEncoding();
 
-       // get a file list and write a manifest file
        vector<pair<string, string> > filenames;
-       string const manifest = FileName(
-               addName(buffer_->temppath(), "manifest.txt")).toFilesystemEncoding();
-
-       // write a manifest file
-       ofstream os(manifest.c_str());
-       os << *this;
-       os.close();
+       // add content.lyx to filenames
+       filenames.push_back(make_pair(content, "content.lyx"));
        // prepare list of embedded file
        EmbeddedFileList::iterator it = file_list_.begin();
        EmbeddedFileList::iterator it_end = file_list_.end();
@@ -304,9 +307,6 @@ bool EmbeddedFiles::write(DocFileName const & filename)
                                filenames.push_back(make_pair(file, it->inzipName()));
                }
        }
-       // add filename (.lyx) and manifest to filenames
-       filenames.push_back(make_pair(content, onlyFilename(filename.toFilesystemEncoding())));
-       filenames.push_back(make_pair(manifest, "manifest.txt"));
        // write a zip file with all these files. Write to a temp file first, to
        // avoid messing up the original file in case something goes terribly wrong.
        DocFileName zipfile(addName(buffer_->temppath(),
@@ -363,11 +363,13 @@ bool EmbeddedFiles::updateFromExternalFile() const
 }
 
 
-string const EmbeddedFiles::getInzipName(string const & abs_filename)
+string const EmbeddedFiles::getInzipName(string const & abs_filename, string const & name)
 {
        // register a new one, using relative file path as inzip_name
-       string inzip_name = to_utf8(makeRelPath(from_utf8(abs_filename),
-               from_utf8(buffer_->fileName())));
+       string inzip_name = name;
+       if (name.empty())
+               inzip_name = to_utf8(makeRelPath(from_utf8(abs_filename),
+                       from_utf8(buffer_->filePath())));
        // if inzip_name is an absolute path, use filename only to avoid
        // leaking of filesystem information in inzip_name
        // The second case covers cases '../path/file' and '.'
@@ -396,81 +398,74 @@ string const EmbeddedFiles::getInzipName(string const & abs_filename)
 }
 
 
-istream & operator>> (istream & is, EmbeddedFiles & files)
+bool EmbeddedFiles::readManifest(Lexer & lex, ErrorList & errorList)
 {
-       files.clear();
-       string tmp;
-       getline(is, tmp);
-       // get version
-       istringstream itmp(tmp);
-       int version;
-       itmp.ignore(string("# LyX manifest version ").size());
-       itmp >> version;
-
-       if (version != 1) {
-               lyxerr << "This version of LyX can only read LyX manifest version 1" << endl;
-               return is;
-       }
+       int line = -1;
+       int begin_manifest_line = -1;
 
-       getline(is, tmp);
-       if (tmp != "<manifest>") {
-               lyxerr << "Invalid manifest file, lacking <manifest>" << endl;
-               return is;
-       }
-       // manifest file may be messed up, be carefully
-       while (is.good()) {
-               getline(is, tmp);
-               if (tmp != "<file>")
-                       break;
+       file_list_.clear();
+       string filename = "";
+       string inzipName = "";
+       bool status = "";
+
+       while (lex.isOK()) {
+               lex.next();
+               string const token = lex.getString();
+
+               if (token.empty())
+                       continue;
 
-               string fname;
-               getline(is, fname);
-               string inzip_name;
-               getline(is, inzip_name);
-               getline(is, tmp);
-               istringstream itmp(tmp);
-               int embed;
-               itmp >> embed;
-
-               getline(is, tmp);
-               if (tmp != "</file>") {
-                       lyxerr << "Invalid manifest file, lacking </file>" << endl;
+               if (token == "\\end_manifest")
                        break;
-               }
 
-               files.registerFile(fname, embed);
-       };
-       // the last line must be </manifest>
-       if (tmp != "</manifest>") {
-               lyxerr << "Invalid manifest file, lacking </manifest>" << endl;
-               return is;
+               ++line;
+               if (token == "\\begin_manifest") {
+                       begin_manifest_line = line;
+                       continue;
+               }
+               
+               LYXERR(Debug::PARSER) << "Handling document manifest token: `"
+                                     << token << '\'' << endl;
+
+               if (token == "\\filename")
+                       lex >> filename;
+               else if (token == "\\inzipName")
+                       lex >> inzipName;
+               else if (token == "\\status") {
+                       lex >> status;
+                       registerFile(filename, status, NULL, inzipName);
+                       filename = "";
+                       inzipName = "";
+               } else {
+                       docstring const s = _("\\begin_file is missing");
+                       errorList.push_back(ErrorItem(_("Manifest error"),
+                               s, -1, 0, 0));
+               }
+       }
+       if (begin_manifest_line) {
+               docstring const s = _("\\begin_manifest is missing");
+               errorList.push_back(ErrorItem(_("Manifest error"),
+                       s, -1, 0, 0));
        }
-       return is;
+       return true;
 }
 
 
-ostream & operator<< (ostream & os, EmbeddedFiles const & files)
+void EmbeddedFiles::writeManifest(ostream & os) const
 {
-       // store a version so that operator >> can read later versions
-       // using version information.
-       os << "# lyx manifest version 1\n";
-       os << "<manifest>\n";
-       EmbeddedFiles::EmbeddedFileList::const_iterator it = files.begin();
-       EmbeddedFiles::EmbeddedFileList::const_iterator it_end = files.end();
+       EmbeddedFiles::EmbeddedFileList::const_iterator it = begin();
+       EmbeddedFiles::EmbeddedFileList::const_iterator it_end = end();
        for (; it != it_end; ++it) {
                if (!it->valid())
                        continue;
-               // use differnt lines to make reading easier.
-               os << "<file>\n"
-                       // save the relative path
+               // save the relative path
+               os << "\\filename "
                        << to_utf8(makeRelPath(from_utf8(it->absFilename()),
-                               from_utf8(files.buffer_->filePath()))) << '\n'
-                       << it->inzipName() << '\n'
-                       << it->embedded() << '\n'
-                       << "</file>\n";
+                               from_utf8(buffer_->filePath()))) << '\n'
+                       << "\\inzipName " << it->inzipName() << '\n'
+                       << "\\status " << (it->embedded() ? "true" : "false") << '\n';
        }
-       os << "</manifest>\n";
-       return os;
 }
 
+
 }