src/bufferlist.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2000 The LyX Team
   8  *
   9  *           This file is Copyright 1996-2000
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ====================================================== */
  13
  14 #ifndef BUFFER_LIST_H
  15 #define BUFFER_LIST_H
  16
  17 #ifdef __GNUG__
  18 #pragma interface
  19 #endif
  20
  21 #include "buffer.h"
  22 #include "debug.h"
  23
  24 /** A class to hold all the buffers in a structure
  25   The point of this class is to hide from bufferlist what kind
  26   of structure the buffers are stored in. Should be no concern for
  27   bufferlist if the buffers is in a array or in a linked list.
  28
  29   This class should ideally be enclosed inside class BufferList, but that
  30   gave me an "internal gcc error".
  31   */
  32 class BufferStorage {
  33 public:
  34         ///
  35         typedef vector<Buffer *> Container;
  36         ///
  37         typedef Container::iterator iterator;
  38         ///
  39         typedef Container::const_iterator const_iterator;
  40         ///
  41         bool empty() const { return container.empty(); }
  42         ///
  43         void release(Buffer * buf);
  44         ///
  45         Buffer * newBuffer(string const & s, LyXRC *, bool = false);
  46         ///
  47         Container::iterator begin() { return container.begin(); }
  48         ///
  49         Container::iterator end() { return container.end(); }
  50         ///
  51         Container::const_iterator begin() const { return container.begin(); }
  52         ///
  53         Container::const_iterator end() const { return container.end(); }
  54         ///
  55         Buffer * front() { return container.front(); }
  56         ///
  57         Buffer * operator[](int c) { return container[c]; }
  58         ///
  59         int size() const { return container.size(); }
  60 private:
  61         ///
  62         Container container;
  63 };
  64
  65
  66 /** The class governing all the open buffers
  67   This class governs all the currently open buffers. Currently all the buffer
  68   are located in a static array, soon this will change and we will have a
  69   linked list instead.
  70  */
  71 class BufferList {
  72 public:
  73         ///
  74         BufferList();
  75
  76         /// state info
  77         enum list_state {
  78                 ///
  79                 OK,
  80                 ///
  81                 CLOSING
  82         };
  83
  84         /// returns the state of the bufferlist
  85         list_state getState() const { return state_; }
  86
  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
  90             files list
  91         */
  92         Buffer * loadLyXFile(string const & filename,
  93                              bool tolastfiles = true);
  94
  95         ///
  96         bool empty() const;
  97
  98         /// Saves buffer. Returns false if unsuccesful.
  99 #if 0
 100         bool write(Buffer *, bool makeBackup);
 101 #endif
 102
 103         ///
 104         bool QwriteAll();
 105
 106         /// Close all open buffers.
 107         void closeAll();
 108
 109         ///
 110         void resize();
 111
 112         /// Read a file into a buffer readonly or not.
 113         Buffer * readFile(string const &, bool ro);
 114
 115         /// Make a new file (buffer) using a template
 116         Buffer * newFile(string const &, string);
 117         /// returns a vector with all the buffers filenames
 118         vector<string> getFileNames() const;
 119
 120         ///
 121         void updateInset(Inset *, bool = true);
 122
 123         ///
 124         int unlockInset(UpdatableInset *);
 125
 126         ///
 127         void updateIncludedTeXfiles(string const &);
 128
 129         ///
 130         void emergencyWriteAll();
 131
 132         /** closes buffer
 133           Returns false if operation was canceled
 134           */
 135         bool close(Buffer *);
 136
 137         ///
 138         Buffer * first();
 139
 140         /// returns true if the buffer exists already
 141         bool exists(string const &) const;
 142
 143         /// returns true if the buffer is loaded
 144         bool isLoaded(Buffer const * b) const;
 145
 146         /// returns a pointer to the buffer with the given name.
 147         Buffer * getBuffer(string const &);
 148         /// returns a pointer to the buffer with the given number.
 149         Buffer * getBuffer(int);
 150
 151 private:
 152         ///
 153         BufferStorage bstore;
 154
 155         ///
 156         list_state state_;
 157 };
 158
 159 #endif