home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Linux / Divers / lyx-0.13.2.tar.gz / lyx-0.13.2.tar / lyx-0.13.2 / src / bufferlist.h < prev    next >
C/C++ Source or Header  |  1998-04-23  |  4KB  |  174 lines
  1. // -*- C++ -*-
  2. /* This file is part of
  3. * ======================================================
  4. * 
  5. *           LyX, The Document Processor      
  6. *        Copyright (C) 1995 Matthias Ettrich
  7. *
  8. *           This file is Copyleft (C) 1996
  9. *           Lars Gullik Bj°nnes
  10. *
  11. *======================================================*/
  12.  
  13. #ifndef _BUFFER_LIST_H_
  14. #define _BUFFER_LIST_H_
  15.  
  16. #ifdef __GNUG__
  17. #pragma interface
  18. #endif
  19.  
  20. #include "buffer.h"
  21. #include "error.h"
  22.  
  23. /** A class to hold all the buffers in a structure
  24.   The point of this class is to hide from bufferlist what kind
  25.   of structure the buffers are stored in. Should be no concern for
  26.   bufferlist if the buffers is in a array or in a linked list.
  27.  
  28.   This class should ideally be enclosed inside class BufferList, but that
  29.   gave me an "internal gcc error".
  30.   */
  31. class BufferStorage {
  32. public:
  33.     ///
  34.     BufferStorage();
  35.     ///
  36.     bool isEmpty();
  37.     ///
  38.     void release(Buffer* buf);
  39.     ///
  40.     Buffer* newBuffer(LString const &s, LyXRC *, bool =false);
  41. private:
  42.     /** The max number of buffers there are possible to have
  43.       loaded at the same time. (this only applies when we use an
  44.       array)
  45.       */
  46.     enum{ NUMBER_OF_BUFFERS = 50 };
  47.     
  48.     /** The Bufferlist is currently implemented as a static array.
  49.       The buffers are new'ed and deleted as reqested.
  50.       */
  51.     Buffer *buffer[NUMBER_OF_BUFFERS];
  52.     ///
  53.     friend class BufferStorage_Iter;
  54. };
  55.  
  56. /// An Iterator class for BufferStorage
  57. class BufferStorage_Iter {
  58. public:
  59.     ///
  60.     BufferStorage_Iter(const BufferStorage & bs)
  61.     { cs=&bs; index=0;}
  62.     /// next
  63.     Buffer* operator() ();
  64.     ///
  65.     Buffer* operator[] (int a);
  66. private:
  67.     ///
  68.     const BufferStorage *cs;
  69.     ///
  70.     unsigned char index;
  71. };
  72.  
  73.  
  74.  
  75. /** The class governing all the open buffers
  76.   This class governs all the currently open buffers. Currently all the buffer
  77.   are located in a static array, soon this will change and we will have a
  78.   linked list instead.
  79.  */
  80. class BufferList {
  81. public:
  82.     ///
  83.      BufferList();
  84.  
  85.     ///
  86.     ~BufferList();
  87.  
  88.     /// state info
  89.     enum list_state {
  90.         ///
  91.         OK,
  92.         ///
  93.         CLOSING
  94.     };
  95.  
  96.     /// returns the state of the bufferlist
  97.     list_state getState() { return _state; }
  98.     
  99.     /** loads a LyX file or...
  100.       If the optional argument tolastfiles is false (default is
  101.             true), the file name will not be added to the last opened
  102.         files list
  103.         */  
  104.     Buffer* loadLyXFile(LString const & filename, 
  105.                 bool tolastfiles = true);
  106.     
  107.     ///
  108.     bool isEmpty();
  109.  
  110.     /// Saves buffer. Returns false if unsuccesful.
  111.     bool write(Buffer *, bool makeBackup = true);
  112.  
  113.     ///
  114.         bool QwriteAll();
  115.  
  116.     /// Close all open buffers.
  117.     void closeAll();
  118.  
  119.     ///
  120.     void resize();
  121.  
  122.     /// Read a file into a buffer readonly or not.
  123.     Buffer* readFile(LString const &, bool ro);
  124.  
  125.     /// Make a new file (buffer) using a template
  126.     Buffer* newFile(LString const &, LString);
  127.  
  128.     /** This one must be moved to some other place.
  129.      */
  130.     void makePup(int);
  131.  
  132.     /** Later with multiple frames this should not be here.
  133.      */
  134.     //Buffer* switchBuffer(Buffer *from, int);
  135.  
  136.     ///
  137.     void updateInset(Inset*, bool = true);
  138.  
  139.     ///
  140.     int unlockInset(UpdatableInset*);
  141.  
  142.     ///
  143.     void updateIncludedTeXfiles(LString const &);
  144.  
  145.     ///
  146.     void emergencyWriteAll();
  147.  
  148.     /** closes buffer
  149.       Returns false if operation was canceled
  150.       */
  151.     bool close(Buffer *);
  152.  
  153.     ///
  154.     Buffer* first();
  155.     
  156.     /// returns true if the buffer exists already
  157.     bool exists(LString const &);
  158.  
  159.     /// returns a pointer to the buffer with the given name.
  160.     Buffer* getBuffer(LString const &);
  161.     /// returns a pointer to the buffer with the given number.
  162.     Buffer* getBuffer(int);
  163.  
  164. private:
  165.     ///
  166.     BufferStorage bstore;
  167.     
  168.     ///
  169.     list_state _state;
  170. };
  171.  
  172.  
  173. #endif
  174.