4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
9 * Full author contact details are available in file CREDITS.
15 #include "support/docstring.h"
26 * The class holds all all open buffers, and handles construction
27 * and deletions of new ones.
31 typedef std::vector<Buffer *>::iterator iterator;
32 typedef std::vector<Buffer *>::const_iterator const_iterator;
38 const_iterator begin() const;
41 const_iterator end() const;
43 /// create a new buffer
44 /// \return 0 if the Buffer creation is not possible for whatever reason.
45 Buffer * newBuffer(std::string const & s, bool ronly = false);
48 void release(Buffer * b);
50 /// Close all open buffers.
53 /// returns a vector with all the buffers filenames
54 std::vector<std::string> const getFileNames() const;
57 void updateIncludedTeXfiles(std::string const &, OutputParams const &);
59 /// emergency save for all buffers
60 void emergencyWriteAll();
62 /// return true if no buffers loaded
65 /// return head of buffer list if any
68 /// return back of buffer list if any
71 /// returns true if the buffer exists already
72 bool exists(std::string const &) const;
74 /// returns true if the buffer is loaded
75 bool isLoaded(Buffer const * b) const;
77 /// return index of named buffer in buffer list
78 int bufferNum(std::string const & name) const;
79 /// returns a pointer to the buffer with the given name.
80 Buffer * getBuffer(std::string const &);
81 /// returns a pointer to the buffer with the given number.
82 Buffer * getBuffer(unsigned int);
83 /// returns a pointer to the buffer whose temppath matches the string
84 Buffer * getBufferFromTmp(std::string const &);
86 /** returns a pointer to the buffer that follows argument in
87 * buffer list. The buffer following the last in list is the
90 Buffer * next(Buffer const *) const;
92 /** returns a pointer to the buffer that precedes argument in
93 * buffer list. The buffer preceding the first in list is the
96 Buffer * previous(Buffer const *) const;
98 /// reset current author for all buffers
99 void setCurrentAuthor(docstring const & name, docstring const & email);
103 BufferList(BufferList const &);
104 void operator=(BufferList const &);
106 typedef std::vector<Buffer *> BufferStorage;
108 /// storage of all buffers
109 BufferStorage bstore;
111 /// save emergency file for the given buffer
112 void emergencyWrite(Buffer * buf);
115 /// Implementation is in LyX.cpp
116 extern BufferList & theBufferList();
121 #endif // BUFFERLIST_H