src/BufferList.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferList.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef BUFFER_LIST_H
  13 #define BUFFER_LIST_H
  14
  15 #include "support/docstring.h"
  16
  17 #include <vector>
  18
  19
  20 namespace lyx {
  21
  22 class Buffer;
  23 class OutputParams;
  24
  25 /**
  26  * The class holds all all open buffers, and handles construction
  27  * and deletions of new ones.
  28  */
  29 class BufferList {
  30 public:
  31         typedef std::vector<Buffer *>::iterator iterator;
  32         typedef std::vector<Buffer *>::const_iterator const_iterator;
  33
  34 public:
  35         BufferList();
  36
  37         iterator begin();
  38         const_iterator begin() const;
  39
  40         iterator end();
  41         const_iterator end() const;
  42
  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);
  46
  47         /// delete a buffer
  48         void release(Buffer * b);
  49
  50         /// Close all open buffers.
  51         void closeAll();
  52
  53         /// returns a vector with all the buffers filenames
  54         std::vector<std::string> const getFileNames() const;
  55
  56         /// FIXME
  57         void updateIncludedTeXfiles(std::string const &, OutputParams const &);
  58
  59         /// emergency save for all buffers
  60         void emergencyWriteAll();
  61
  62         /// save emergency file for the given buffer
  63         /**
  64           * \return a status message towards the user.
  65           */
  66         docstring emergencyWrite(Buffer * buf);
  67
  68         /// return true if no buffers loaded
  69         bool empty() const;
  70
  71         /// return head of buffer list if any
  72         Buffer * first();
  73
  74         /// return back of buffer list if any
  75         Buffer * last();
  76
  77         /// returns true if the buffer exists already
  78         bool exists(std::string const &) const;
  79
  80         /// returns true if the buffer is loaded
  81         bool isLoaded(Buffer const * b) const;
  82
  83         /// return index of named buffer in buffer list
  84         int bufferNum(std::string const & name) const;
  85         /// returns a pointer to the buffer with the given name.
  86         Buffer * getBuffer(std::string const &);
  87         /// returns a pointer to the buffer with the given number.
  88         Buffer * getBuffer(unsigned int);
  89         /// returns a pointer to the buffer whose temppath matches the string
  90         Buffer * getBufferFromTmp(std::string const &);
  91
  92         /** returns a pointer to the buffer that follows argument in
  93          * buffer list. The buffer following the last in list is the
  94          * first one.
  95          */
  96         Buffer * next(Buffer const *) const;
  97
  98         /** returns a pointer to the buffer that precedes argument in
  99          * buffer list. The buffer preceding the first in list is the
 100          * last one.
 101          */
 102         Buffer * previous(Buffer const *) const;
 103
 104         /// reset current author for all buffers
 105         void setCurrentAuthor(docstring const & name, docstring const & email);
 106
 107 private:
 108         /// noncopiable
 109         BufferList(BufferList const &);
 110         void operator=(BufferList const &);
 111
 112         typedef std::vector<Buffer *> BufferStorage;
 113
 114         /// storage of all buffers
 115         BufferStorage bstore;
 116 };
 117
 118 /// Implementation is in LyX.cpp
 119 extern BufferList & theBufferList();
 120
 121
 122 } // namespace lyx
 123
 124 #endif // BUFFERLIST_H