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 /// write all buffers, asking the user, returns false if cancelled
46 /// create a new buffer
47 Buffer * newBuffer(std::string const & s, bool ronly = false);
50 void release(Buffer * b);
52 /// Close all open buffers.
55 /// returns a vector with all the buffers filenames
56 std::vector<std::string> const getFileNames() const;
59 void updateIncludedTeXfiles(std::string const &, OutputParams const &);
61 /// emergency save for all buffers
62 void emergencyWriteAll();
64 /// close buffer. Returns false if cancelled by user
65 bool close(Buffer * buf, bool ask);
67 /// return true if no buffers loaded
70 /// return head of buffer list if any
73 /// return back of buffer list if any
76 /// returns true if the buffer exists already
77 bool exists(std::string const &) const;
79 /// returns true if the buffer is loaded
80 bool isLoaded(Buffer const * b) const;
82 /// return index of named buffer in buffer list
83 int bufferNum(std::string const & name) const;
84 /// returns a pointer to the buffer with the given name.
85 Buffer * getBuffer(std::string const &);
86 /// returns a pointer to the buffer with the given number.
87 Buffer * getBuffer(unsigned int);
88 /// returns a pointer to the buffer whose temppath matches the string
89 Buffer * getBufferFromTmp(std::string const &);
91 /** returns a pointer to the buffer that follows argument in
92 * buffer list. The buffer following the last in list is the
95 Buffer * next(Buffer const *) const;
97 /** returns a pointer to the buffer that precedes argument in
98 * buffer list. The buffer preceding the first in list is the
101 Buffer * previous(Buffer const *) const;
103 /// reset current author for all buffers
104 void setCurrentAuthor(docstring const & name, docstring const & email);
108 BufferList(BufferList const &);
109 void operator=(BufferList const &);
111 /// ask to save a buffer on quit, returns false if should cancel
112 bool quitWriteBuffer(Buffer * buf);
114 typedef std::vector<Buffer *> BufferStorage;
116 /// storage of all buffers
117 BufferStorage bstore;
119 /// save emergency file for the given buffer
120 void emergencyWrite(Buffer * buf);
123 /// Implementation is in LyX.cpp
124 extern BufferList & theBufferList();
129 #endif // BUFFERLIST_H