src/EmbeddedFiles.h

   1 // -*- C++ -*-
   2 /**
   3  * \file EmbeddedFiles.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  */
  12
  13 #ifndef EMBEDDEDFILES_H
  14 #define EMBEDDEDFILES_H
  15
  16 #include "support/FileName.h"
  17
  18 #include <vector>
  19 #include <utility>
  20
  21 #include "ParIterator.h"
  22 #include "Paragraph.h"
  23
  24 /**
  25
  26 This file, and the embedding dialog implemented in src/frontends, implements
  27 an 'Embedded Files' feature of lyx.
  28
  29
  30 Expected features:
  31 =========================
  32
  33 1. With embedding enabled (disabled by default), .lyx file can embed graphics,
  34 listings, bib file etc.
  35
  36 2. Embedded file.lyx file is a zip file, with file.lyx, manifest.txt
  37 and embedded files.
  38
  39 3. An embedding dialog is provided to change embedding status (buffer
  40 level or individual embedded files), manually embed, extract, view
  41 or edit files.
  42
  43 Overall, this feature allows two ways of editing a .lyx file
  44
  45 a. The continuous use of the pure-text .lyx file format with external
  46 files. This is the default file format, and allows external editing
  47 of .lyx file and better use of version control systems.
  48
  49 b. The embedded way. Figures etc are inserted to .lyx file and will
  50 be embedded. These embedded files can be viewed or edited through
  51 the embedding dialog. This file can be shared with others more
  52 easily.
  53
  54 Format a anb b can be converted easily, by enable/disable embedding. Diabling
  55 embedding is also called unpacking because all embedded files will be copied
  56 to their original locations.
  57
  58 Implementation:
  59 ======================
  60
  61 1. An EmbeddedFiles class is implemented to keep the embedded files (
  62 class EmbeddedFile). (c.f. src/EmbeddedFiles.[h|cpp])
  63 This class keeps a manifest that has
  64   a. external relative filename
  65   b. inzip filename. It is the relative path name if the embedded file is
  66     in or under the document directory, or file name otherwise. Name aliasing
  67     is used if two external files share the same name.
  68   c. embedding status.
  69 It also provides functions to
  70   a. manipulate manifest
  71   b. scan a buffer for embeddable files
  72   c. determine which file to use according to embedding status
  73
  74 2. When a file is saved, it is scanned for embedded files. (c.f.
  75 EmbeddedFiles::update(), Inset::registerEmbeddedFiles()).
  76
  77 3. When a lyx file file.lyx is saved, it is save to tmppath() first.
  78 Embedded files are compressed along with file.lyx and a manifest.txt.
  79 If embedding is disabled, file.lyx is saved in the usual pure-text form.
  80 (c.f. Buffer::writeFile(), EmbeddedFiles::write())
  81
  82 4. When a lyx file.lyx file is opened, if it is a zip file, it is
  83 decompressed to tmppath(). If manifest.txt and file.lyx exists in
  84 tmppath(), the manifest is read to buffer, and tmppath()/file.lyx is
  85 read as usual. If file.lyx is not a zip file, it is read as usual.
  86 (c.f. bool Buffer::readFile())
  87
  88 5. A menu item Document -> Embedded Files is provided to open
  89 a embedding dialog. It handles a EmbddedFiles point directly.
  90 From this dialog, a user can disable embedding, change embedding status,
  91 or embed other files, extract, view, edit files.
  92
  93 6. If embedding of a .lyx file with embedded files is disabled, all its
  94 embedded files are copied to their respective external filenames. This
  95 is why external filename will exist even if a file is at "EMBEDDED" status.
  96
  97 7. Individual embeddable insets should find ways to handle embedded files.
  98 InsetGraphics replace params().filename with its temppath()/inzipname version
  99 when the inset is created. The filename appears as /tmp/..../inzipname
 100 when lyx runs. When params().filename is saved, lyx checks if this is an
 101 embedded file (check path == temppath()), if so, save filename() instead.
 102 (c.f. InsetGraphic::read(), InsetGraphics::edit(), InsetGraphicsParams::write())
 103
 104
 105 */
 106
 107 namespace lyx {
 108
 109 class Buffer;
 110
 111 class EmbeddedFile : public support::DocFileName
 112 {
 113 public:
 114         EmbeddedFile(std::string const & file, std::string const & inzip_name,
 115                 bool embedded, ParConstIterator const & pit);
 116
 117         /// filename in the zip file, usually the relative path
 118         std::string inzipName() const { return inzip_name_; }
 119         /// embedded file, equals to temppath()/inzipName()
 120         std::string embeddedFile(Buffer const * buf) const;
 121         /// embeddedFile() or absFilename() depending on embedding status
 122         std::string availableFile(Buffer const * buf) const;
 123
 124         /// paragraph id
 125         void addParIter(ParConstIterator const & pit);
 126         int parID(int idx) const;
 127         /// Number of Insets this file item is referred
 128         /// If refCount() == 0, this file must be manually inserted.
 129         /// This fact is used by the update() function to skip updating
 130         /// such items.
 131         int refCount() const { return par_it_.size(); }
 132
 133         /// embedding status of this file
 134         bool embedded() const { return embedded_; }
 135         /// set embedding status. updateFromExternal() should be called before this
 136         /// to copy or sync the embedded file with external one.
 137         bool setEmbed(bool embed) { embedded_ = embed; }
 138
 139         // A flag indicating whether or not this filename is valid.
 140         // When lyx runs, InsetGraphics etc may be added or removed so filename
 141         // maybe obsolete. In Buffer::updateEmbeddedFiles, the EmbeddedFiles is first
 142         // invalidated (c.f. invalidate()), and all insets are asked to register
 143         // embedded files. In this way, EmbeddedFileList will be refreshed, with
 144         // status setting untouched.
 145         bool valid() const { return valid_; }
 146         void validate() { valid_ = true; }
 147         void invalidate();
 148
 149         /// extract file, does not change embedding status
 150         bool extract(Buffer const * buf) const;
 151         /// update embedded file from external file, does not change embedding status
 152         bool updateFromExternalFile(Buffer const * buf) const;
 153
 154 private:
 155         /// filename in zip file
 156         std::string inzip_name_;
 157         /// the status of this docfile
 158         bool embedded_;
 159         ///
 160         bool valid_;
 161         /// Current position of the item, used to locate the files. Because one
 162         /// file item can be referred by several Insets, a vector is used.
 163         std::vector<ParConstIterator> par_it_;
 164 };
 165
 166
 167 class EmbeddedFiles {
 168 public:
 169         typedef std::vector<EmbeddedFile> EmbeddedFileList;
 170 public:
 171         ///
 172         EmbeddedFiles(Buffer * buffer = NULL): file_list_(), buffer_(buffer) {}
 173         ///
 174         ~EmbeddedFiles() {}
 175
 176         /// return buffer params embedded flag
 177         bool enabled() const;
 178         /// set buffer params embedded flag. Files will be updated or extracted
 179         /// if such an operation fails, enable will fail.
 180         bool enable(bool flag);
 181
 182         /// add a file item.
 183         /* \param filename filename to add
 184          * \param embed embedding status. For a new file item, this is always true.
 185          *    If the file already exists, this parameter is ignored.
 186          * \param pit paragraph id.
 187          */
 188         void registerFile(std::string const & filename, bool embed = false,
 189                 ParConstIterator const & pit = ParConstIterator());
 190
 191         /// scan the buffer and get a list of EmbeddedFile
 192         void update();
 193
 194         /// write a zip file
 195         bool write(support::DocFileName const & filename);
 196
 197         void clear() { file_list_.clear(); }
 198
 199         ///
 200         EmbeddedFile & operator[](size_t idx) { return *(file_list_.begin() + idx); }
 201         EmbeddedFile const & operator[](size_t idx) const { return *(file_list_.begin() + idx); }
 202         ///
 203         EmbeddedFileList::iterator begin() { return file_list_.begin(); }
 204         EmbeddedFileList::iterator end() { return file_list_.end(); }
 205         EmbeddedFileList::const_iterator begin() const { return file_list_.begin(); }
 206         EmbeddedFileList::const_iterator end() const { return file_list_.end(); }
 207         // try to locate filename, using either absFilename() or embeddedFile()
 208         EmbeddedFileList::const_iterator find(std::string filename) const;
 209         /// extract all file items, used when disable embedding
 210         bool extract() const;
 211         /// update all files from external, used when enable embedding
 212         bool updateFromExternalFile() const;
 213         ///
 214         friend std::istream & operator>> (std::istream & is, EmbeddedFiles &);
 215
 216         friend std::ostream & operator<< (std::ostream & os, EmbeddedFiles const &);
 217 private:
 218         /// get a unique inzip name
 219         std::string const getInzipName(std::string const & name);
 220         /// list of embedded files
 221         EmbeddedFileList file_list_;
 222         ///
 223         Buffer * buffer_;
 224 };
 225
 226
 227 std::istream & operator>> (std::istream & is, EmbeddedFiles &);
 228
 229 std::ostream & operator<< (std::ostream & os, EmbeddedFiles const &);
 230
 231 }
 232 #endif