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 Buffer;
  23 class OutputParams;
  24
  25 namespace support {
  26 class FileName;
  27 class FileNameList;
  28 }
  29
  30 /**
  31  * The class holds all all open buffers, and handles construction
  32  * and deletions of new ones.
  33  */
  34 class BufferList {
  35 public:
  36         typedef std::vector<Buffer *>::iterator iterator;
  37         typedef std::vector<Buffer *>::const_iterator const_iterator;
  38
  39 public:
  40         BufferList();
  41
  42         iterator begin();
  43         const_iterator begin() const;
  44
  45         iterator end();
  46         const_iterator end() const;
  47
  48         /// create a new buffer
  49         /// \return 0 if the Buffer creation is not possible for whatever reason.
  50         Buffer * newBuffer(std::string const & s, bool ronly = false);
  51
  52         /// delete a buffer
  53         void release(Buffer * b);
  54
  55         /// Release \p child if it really is a child and is not used elsewhere.
  56         /// \return true is the file was closed.
  57         bool releaseChild(Buffer * parent, Buffer * child);
  58
  59         /// Close all open buffers.
  60         void closeAll();
  61
  62         /// returns a vector with all the buffers filenames
  63         support::FileNameList const & fileNames() const;
  64
  65         /// FIXME
  66         void updateIncludedTeXfiles(std::string const &, OutputParams const &);
  67
  68         /// emergency save for all buffers
  69         void emergencyWriteAll();
  70
  71         /// save emergency file for the given buffer
  72         /**
  73           * \return a status message towards the user.
  74           */
  75         docstring emergencyWrite(Buffer * buf);
  76
  77         /// return true if no buffers loaded
  78         bool empty() const;
  79
  80         /// return head of buffer list if any
  81         Buffer * first();
  82
  83         /// return back of buffer list if any
  84         Buffer * last();
  85
  86         /// returns true if the buffer exists already
  87         bool exists(support::FileName const &) const;
  88
  89         /// returns true if the buffer is loaded
  90         bool isLoaded(Buffer const * b) const;
  91
  92         /// return index of named buffer in buffer list
  93         int bufferNum(support::FileName const & name) const;
  94         /// returns a pointer to the buffer with the given name.
  95         Buffer * getBuffer(support::FileName const &) const;
  96         /// returns a pointer to the buffer with the given number.
  97         Buffer * getBuffer(unsigned int);
  98         /// returns a pointer to the buffer whose temppath matches the string
  99         Buffer * getBufferFromTmp(std::string const &);
 100
 101         /** returns a pointer to the buffer that follows argument in
 102          * buffer list. The buffer following the last in list is the
 103          * first one.
 104          */
 105         Buffer * next(Buffer const *) const;
 106
 107         /** returns a pointer to the buffer that precedes argument in
 108          * buffer list. The buffer preceding the first in list is the
 109          * last one.
 110          */
 111         Buffer * previous(Buffer const *) const;
 112
 113         /// reset current author for all buffers
 114         void setCurrentAuthor(docstring const & name, docstring const & email);
 115
 116 private:
 117         /// noncopiable
 118         BufferList(BufferList const &);
 119         void operator=(BufferList const &);
 120
 121         typedef std::vector<Buffer *> BufferStorage;
 122
 123         /// storage of all buffers
 124         BufferStorage bstore;
 125 };
 126
 127 /// Implementation is in LyX.cpp
 128 extern BufferList & theBufferList();
 129
 130
 131 } // namespace lyx
 132
 133 #endif // BUFFERLIST_H