src/BufferList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef BUFFER_LIST_H
  13 #define BUFFER_LIST_H
  14
  15 #include "support/docstring.h"
  16
  17 #include <vector>
  18
  19
  20 namespace lyx {
  21
  22 class Author;
  23 class Buffer;
  24 class OutputParams;
  25
  26 namespace support {
  27 class FileName;
  28 class FileNameList;
  29 }
  30
  31 /**
  32  * The class holds all all open buffers, and handles construction
  33  * and deletions of new ones.
  34  */
  35 class BufferList {
  36 public:
  37         typedef std::vector<Buffer *>::iterator iterator;
  38         typedef std::vector<Buffer *>::const_iterator const_iterator;
  39
  40 public:
  41         BufferList();
  42         ~BufferList();
  43
  44         iterator begin();
  45         const_iterator begin() const;
  46
  47         iterator end();
  48         const_iterator end() const;
  49
  50         /// create a new buffer and add it to the buffer list
  51         /// \return 0 if the Buffer creation is not possible for whatever reason.
  52         Buffer * newBuffer(std::string const & s);
  53
  54         /// create an internal buffer and add it to the internal buffer list
  55         /// \return 0 if the Buffer creation is not possible for whatever reason.
  56         Buffer * newInternalBuffer(std::string const & s);
  57
  58         /// delete a buffer
  59         void release(Buffer * b);
  60
  61         /// Release \p child if it really is a child and is not used elsewhere.
  62         /// \return true is the file was closed.
  63         bool releaseChild(Buffer * parent, Buffer * child);
  64
  65         /// Close all open buffers.
  66         void closeAll();
  67
  68         /// returns a vector with all the buffers filenames
  69         support::FileNameList fileNames() const;
  70
  71         /// return true if no buffers loaded
  72         bool empty() const;
  73
  74         /// return head of buffer list if any
  75         Buffer * first();
  76
  77         /// return back of buffer list if any
  78         Buffer * last();
  79
  80         /// returns true if the buffer exists already
  81         bool exists(support::FileName const &) const;
  82
  83         /// returns true if the buffer is loaded
  84         bool isLoaded(Buffer const * b) const;
  85
  86         /// \return index of named buffer in buffer list
  87         int bufferNum(support::FileName const & name) const;
  88
  89         /** returns a pointer to the buffer with the given name
  90          *
  91          *  \param internal
  92          *    If true, the buffer is searched also among internal buffers
  93          */
  94         Buffer * getBuffer(support::FileName const & name, bool internal = false) const;
  95
  96         /// \return a pointer to the buffer with the given number
  97         Buffer * getBuffer(unsigned int);
  98
  99         /// \return a pointer to the buffer whose temppath matches the given path
 100         Buffer * getBufferFromTmp(std::string const & path);
 101
 102         /** returns a pointer to the buffer that follows argument in
 103          * buffer list. The buffer following the last in list is the
 104          * first one.
 105          */
 106         Buffer * next(Buffer const *) const;
 107
 108         /** returns a pointer to the buffer that precedes argument in
 109          * buffer list. The buffer preceding the first in list is the
 110          * last one.
 111          */
 112         Buffer * previous(Buffer const *) const;
 113
 114         /// \name Functions that just operate on all buffers
 115         //@{
 116         /// reset current author for all buffers
 117         void recordCurrentAuthor(Author const & author);
 118         /// update previews for all buffers, e.g. for Prefs update
 119         void updatePreviews();
 120         /// Call changed() on all buffers, internal or not
 121         void changed(bool update_metrics) const;
 122         /// emergency save for all buffers
 123         void emergencyWriteAll();
 124         /// FIXME
 125         void updateIncludedTeXfiles(std::string const &, OutputParams const &);
 126         //@}
 127
 128 private:
 129         /// create a new buffer
 130         /// \return 0 if the Buffer creation is not possible for whatever reason.
 131         Buffer * createNewBuffer(std::string const & s);
 132
 133         /// noncopiable
 134         BufferList(BufferList const &);
 135         void operator=(BufferList const &);
 136
 137         typedef std::vector<Buffer *> BufferStorage;
 138
 139         /// storage of all buffers
 140         BufferStorage bstore;
 141         /// storage of all internal buffers used for cut&paste, etc.
 142         BufferStorage binternal;
 143 };
 144
 145 /// Implementation is in LyX.cpp
 146 extern BufferList & theBufferList();
 147
 148
 149 } // namespace lyx
 150
 151 #endif // BUFFERLIST_H