// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-1999 The LyX Team
+/**
+ * \file bufferlist.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * This file is Copyright 1996
- * Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
*
- * ======================================================*/
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef BUFFER_LIST_H
#define BUFFER_LIST_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "buffer.h"
-#include "debug.h"
+#include <boost/utility.hpp>
-/** A class to hold all the buffers in a structure
- The point of this class is to hide from bufferlist what kind
- of structure the buffers are stored in. Should be no concern for
- bufferlist if the buffers is in a array or in a linked list.
+#include <string>
+#include <vector>
- This class should ideally be enclosed inside class BufferList, but that
- gave me an "internal gcc error".
- */
-class BufferStorage {
-public:
- ///
- BufferStorage();
- ///
- bool isEmpty();
- ///
- void release(Buffer* buf);
- ///
- Buffer* newBuffer(string const &s, LyXRC *, bool =false);
-private:
- enum {
- /** The max number of buffers there are possible to have
- loaded at the same time. (this only applies when we use an
- array)
- */
- NUMBER_OF_BUFFERS = 50
- };
-
- /** The Bufferlist is currently implemented as a static array.
- The buffers are new'ed and deleted as reqested.
- */
- Buffer *buffer[NUMBER_OF_BUFFERS];
- ///
- friend class BufferStorage_Iter;
-};
+class Buffer;
+class OutputParams;
-/// An Iterator class for BufferStorage
-class BufferStorage_Iter {
+/**
+ * The class holds all all open buffers, and handles construction
+ * and deletions of new ones.
+ */
+class BufferList : boost::noncopyable {
public:
- ///
- BufferStorage_Iter(const BufferStorage & bs)
- { cs=&bs; index=0;}
- /// next
- Buffer* operator() ();
- ///
- Buffer* operator[] (int a);
-private:
- ///
- const BufferStorage *cs;
- ///
- unsigned char index;
-};
+ BufferList();
+ /// write all buffers, asking the user, returns false if cancelled
+ bool quitWriteAll();
+ /// create a new buffer
+ Buffer * newBuffer(std::string const & s, bool ronly = false);
-/** The class governing all the open buffers
- This class governs all the currently open buffers. Currently all the buffer
- are located in a static array, soon this will change and we will have a
- linked list instead.
- */
-class BufferList {
-public:
- ///
- BufferList();
-
- ///
- ~BufferList();
-
- /// state info
- enum list_state {
- ///
- OK,
- ///
- CLOSING
- };
-
- /// returns the state of the bufferlist
- list_state getState() { return _state; }
-
- /** loads a LyX file or...
- If the optional argument tolastfiles is false (default is
- true), the file name will not be added to the last opened
- files list
- */
- Buffer* loadLyXFile(string const & filename,
- bool tolastfiles = true);
-
- ///
- bool isEmpty();
-
- /// Saves buffer. Returns false if unsuccesful.
- bool write(Buffer *, bool makeBackup = true);
-
- ///
- bool QwriteAll();
+ /// delete a buffer
+ void release(Buffer * b);
/// Close all open buffers.
void closeAll();
- ///
- void resize();
+ /// returns a vector with all the buffers filenames
+ std::vector<std::string> const getFileNames() const;
- /// Read a file into a buffer readonly or not.
- Buffer* readFile(string const &, bool ro);
+ /// FIXME
+ void updateIncludedTeXfiles(std::string const &, OutputParams const &);
- /// Make a new file (buffer) using a template
- Buffer* newFile(string const &, string);
+ /// emergency save for all buffers
+ void emergencyWriteAll();
- /** This one must be moved to some other place.
- */
- void makePup(int);
+ /// close buffer. Returns false if cancelled by user
+ bool close(Buffer * buf, bool ask);
- ///** Later with multiple frames this should not be here.
- // */
- //Buffer* switchBuffer(Buffer *from, int);
+ /// return true if no buffers loaded
+ bool empty() const;
- ///
- void updateInset(Inset*, bool = true);
+ /// return head of buffer list if any
+ Buffer * first();
- ///
- int unlockInset(UpdatableInset*);
+ /// returns true if the buffer exists already
+ bool exists(std::string const &) const;
- ///
- void updateIncludedTeXfiles(string const &);
+ /// returns true if the buffer is loaded
+ bool isLoaded(Buffer const * b) const;
- ///
- void emergencyWriteAll();
+ /// returns a pointer to the buffer with the given name.
+ Buffer * getBuffer(std::string const &);
+ /// returns a pointer to the buffer with the given number.
+ Buffer * getBuffer(unsigned int);
+ /// returns a pointer to the buffer whose temppath matches the string
+ Buffer * getBufferFromTmp(std::string const &);
- /** closes buffer
- Returns false if operation was canceled
- */
- bool close(Buffer *);
+ /** returns a pointer to the buffer that follows argument in
+ * buffer list. The buffer following the last in list is the
+ * first one.
+ */
+ Buffer * next(Buffer const *) const;
- ///
- Buffer* first();
-
- /// returns true if the buffer exists already
- bool exists(string const &);
+ /** returns a pointer to the buffer that precedes argument in
+ * buffer list. The buffer preceding the first in list is the
+ * last one.
+ */
+ Buffer * previous(Buffer const *) const;
- /// returns a pointer to the buffer with the given name.
- Buffer* getBuffer(string const &);
- /// returns a pointer to the buffer with the given number.
- Buffer* getBuffer(int);
+ /// reset current author for all buffers
+ void setCurrentAuthor(std::string const & name, std::string const & email);
private:
- ///
+ /// ask to save a buffer on quit, returns false if should cancel
+ bool quitWriteBuffer(Buffer * buf);
+
+ typedef std::vector<Buffer *> BufferStorage;
+
+ /// storage of all buffers
BufferStorage bstore;
-
- ///
- list_state _state;
+
+ /// save emergency file for the given buffer
+ void emergencyWrite(Buffer * buf);
};
-#endif
+#endif // BUFFERLIST_H
projects / lyx.git / blobdiff