/**
-This file, and the embedding dialog implemented in src/frontends, implements
+This file, and the embed checkbox in dialogs of InsetGraphics etc, implements
an 'Embedded Files' feature of lyx.
2. Embedded file.lyx file is a zip file, with content.lyx and embedded files.
-3. The embedding status of embedded files can be set at the inset level,
-or from Document->Settings->Embedded Files.
+3. The embedding status of embedded files are set from individual insets.
4. Extra files such as .cls and .layout can be embedded from Document->
-Settings->Embedded Files->Extra Files.
+Settings->Embedded Files->Extra Embedded Files.
5. When Document->Save in bundled format is selected, all embedded files
become bundled. Changes to the external version of this file does not
b. The embedded way. Figures etc are inserted to .lyx file and will
be embedded. These embedded files can be viewed or edited through
the embedding dialog. This file can be shared with others more
-easily.
+easily.
Format a and b can be converted easily, by packing/unpacking a .lyx file.
-NOTE: With current implementation, files with absolute filenames (not in
-or deeper under the current document directory) can not be embedded.
-
Implementation:
======================
3. When a lyx file file.lyx is saved, it is save to tmppath()/content.lyx
first. Embedded files are compressed along with content.lyx.
-If embedding is disabled, file.lyx is saved in the usual pure-text form.
+If embedding is disabled, file.lyx is saved in the usual pure-text format.
(c.f. Buffer::writeFile(), EmbeddedFiles::writeFile())
4. When a lyx file.lyx file is opened, if it is a zip file, it is
std::string const & buffer_path = std::string());
/// set filename and inzipName.
+ /**
+ * NOTE: inzip_name_ is not unique across operation systems and is not
+ * guaranteed to be the same across different versions of LyX.
+ * inzip_name_ will be saved to the LyX file, and is used to indicate
+ * whether or not a file is embedded, and where the embedded file is in
+ * the bundled file. When a file is read, the stored inzip names are used
+ * at first. EmbeddedFiles::validate() will then scan these embedded files
+ * and update their inzip name, moving bundled files around if needed.
+ * This scheme has the advantage that it is safe to change how inzip files
+ * are saved in a bundled file.
+ *
+ * NOTE that this treatment does not welcome an UUID solution because
+ * all embedded files will have to be renamed when an embedded file is
+ * opened. It is of course possible to use saved inzipname, but that is
+ * not easy. For example, when a new EmbeddedFile is created with the same
+ * file as an old one, it needs to be synced to the old inzipname...
+ **/
void set(std::string const & filename, std::string const & buffer_path);
+ /** Set the inzip name of an EmbeddedFile, which should be the name
+ * of an actual embedded file on disk.
+ */
+ void setInzipName(std::string const & name);
- /// filename in the zip file, which is the relative path
+ /// filename in the zip file, which is related to buffer temp directory.
std::string inzipName() const { return inzip_name_; }
/// embedded file, equals to temppath()/inzipName()
/// embeddedFile() or absFilename() depending on embedding status
/// and whether or not embedding is enabled.
FileName availableFile() const;
- ///
+ /// relative file name or inzipName()
std::string latexFilename(std::string const & buffer_path) const;
/// add an inset that refers to this file
void addInset(Inset const * inset);
- int refCount() const { return inset_list_.size(); }
+ /// clear all isnets that associated with this file.
+ void clearInsets() const { inset_list_.clear(); }
/// embedding status of this file
bool embedded() const { return embedded_; }
- /// set embedding status. updateFromExternal() should be called before this
- /// to copy or sync the embedded file with external one.
+ /// set embedding status.
void setEmbed(bool embed);
/// whether or not embedding is enabled in the current buffer
- bool enabled() const { return temp_path_ != ""; }
+ /**
+ * An embedded file needs to know the temp path of a buffer to know
+ * where its embedded copy is. This has to be stored within EmbeddedFile
+ * because this class is often used when Buffer is unavailable. However,
+ * when an embedded file is copied to another buffer, temp_path_ has
+ * to be updated and file copying may be needed.
+ */
+ bool enabled() const { return !temp_path_.empty(); }
/// enable embedding of this file
- void enable(bool flag, Buffer const * buf);
+ void enable(bool flag, Buffer const * buf, bool updateFile);
/// extract file, does not change embedding status
bool extract() const;
/// update embedded file from external file, does not change embedding status
bool updateFromExternalFile() const;
+ /// copy an embedded file to another buffer
+ EmbeddedFile copyTo(Buffer const * buf);
///
/// After the embedding status is changed, update all insets related
/// to this file item. For example, a graphic inset may need to monitor
- /// embedded file instead of external file. To make sure inset pointers
- /// are up to date, please make sure there is no modification to the
- /// document between EmbeddedFiles::update() and this function.
- void updateInsets(Buffer const * buf) const;
+ /// embedded file instead of external file.
+ void updateInsets() const;
/// Check readability of availableFile
bool isReadableFile() const;
/// Calculate checksum of availableFile
unsigned long checksum() const;
+ // calculate inzip_name_ from filename
+ std::string calcInzipName(std::string const & buffer_path);
+ // move an embedded disk file with an existing inzip_name_ to
+ // a calculated inzip_name_, if they differ.
+ void syncInzipFile(std::string const & buffer_path);
+
private:
/// filename in zip file
std::string inzip_name_;
bool embedded_;
/// Insets that contains this file item. Because a
/// file item can be referred by several Insets, a vector is used.
- std::vector<Inset const *> inset_list_;
+ mutable std::vector<Inset const *> inset_list_;
/// Embedded file needs to know whether enbedding is enabled,
/// and where is the lyx temporary directory. Such information can
/// be retrived from a buffer, but a buffer is not always available when
bool operator!=(EmbeddedFile const & lhs, EmbeddedFile const & rhs);
-class EmbeddedFiles : public std::vector<EmbeddedFile> {
+class EmbeddedFileList : public std::vector<EmbeddedFile> {
public:
/// set buffer params embedded flag. Files will be updated or extracted
/// if such an operation fails, enable will fail.
- void enable(bool flag, Buffer & buffer);
+ void enable(bool flag, Buffer & buffer, bool updateFile);
/// add a file item.
/* \param file Embedded file to add
* \param inset Inset pointer
*/
- void registerFile(EmbeddedFile const & file, Inset const * inset, Buffer const & buffer);
+ void registerFile(EmbeddedFile const & file, Inset const * inset,
+ Buffer const & buffer);
+
+ /// validate embedded fies after a file is read.
+ void validate(Buffer const & buffer);
/// scan the buffer and get a list of EmbeddedFile
void update(Buffer const & buffer);
projects / lyx.git / blobdiff