2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team
9 * This file is Copyright 1996-2001
12 * ====================================================== */
23 #include <boost/utility.hpp>
25 /** A class to hold all the buffers in a structure
26 The point of this class is to hide from bufferlist what kind
27 of structure the buffers are stored in. Should be no concern for
28 bufferlist if the buffers is in a array or in a linked list.
30 This class should ideally be enclosed inside class BufferList, but that
31 gave me an "internal gcc error".
33 class BufferStorage : boost::noncopyable {
36 typedef std::vector<Buffer *> Container;
38 typedef Container::iterator iterator;
40 typedef Container::const_iterator const_iterator;
42 typedef Container::size_type size_type;
44 bool empty() const { return container.empty(); }
46 void release(Buffer * buf);
48 Buffer * newBuffer(string const & s, bool = false);
50 Container::iterator begin() { return container.begin(); }
52 Container::iterator end() { return container.end(); }
54 Container::const_iterator begin() const { return container.begin(); }
56 Container::const_iterator end() const { return container.end(); }
58 Buffer * front() { return container.front(); }
60 Buffer * operator[](int c) { return container[c]; }
62 size_type size() const { return container.size(); }
69 /** The class govern all open buffers.
71 class BufferList : boost::noncopyable {
84 /// returns the state of the bufferlist
85 list_state getState() const { return state_; }
87 /** loads a LyX file or...
88 If the optional argument tolastfiles is false (default is
89 true), the file name will not be added to the last opened
92 Buffer * loadLyXFile(string const & filename,
93 bool tolastfiles = true);
101 /// Close all open buffers.
104 /// Read a file into a buffer readonly or not.
105 Buffer * readFile(string const &, bool ro);
107 /// Make a new file (buffer) using a template
108 Buffer * newFile(string const &, string, bool isNamed = false);
109 /// returns a vector with all the buffers filenames
110 std::vector<string> const getFileNames() const;
113 int unlockInset(UpdatableInset *);
116 void updateIncludedTeXfiles(string const &);
119 void emergencyWriteAll();
122 @param buf the buffer that should be closed
123 @return #false# if operation was canceled
125 bool close(Buffer * buf);
130 /// returns true if the buffer exists already
131 bool exists(string const &) const;
133 /// returns true if the buffer is loaded
134 bool isLoaded(Buffer const * b) const;
136 /// returns a pointer to the buffer with the given name.
137 Buffer * getBuffer(string const &);
138 /// returns a pointer to the buffer with the given number.
139 Buffer * getBuffer(unsigned int);
143 BufferStorage bstore;
148 void emergencyWrite(Buffer * buf);