src/TextCache.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team
   8  *
   9  *           This file is Copyright 2000-2001
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ====================================================== */
  13
  14 #ifndef TEXT_CACHE_H
  15 #define TEXT_CACHE_H
  16
  17 #include "LString.h"
  18
  19 #include <iosfwd>
  20 #include <map>
  21
  22 class Buffer;
  23 class LyXText;
  24
  25 // This is only the very first implemetation and use of the TextCache,
  26 // operations on it needs to be put into a class or a namespace, that part
  27 // is _NOT_ finished so don't bother to come with too many comments on it
  28 // (unless you have some nice ideas on where/how to do it)
  29 //
  30 // I think we need a global TextCache that is common for all BufferViews,
  31 // also the BufferList needs access to the TextCache. Please tell if you
  32 // don't agree.
  33 //
  34 // Q. What are we caching?
  35 // A. We are caching the screen representations (LyXText) of the
  36 //    documents (Buffer,Paragraph) for specific BufferView widths.
  37 // Q. Why the cache?
  38 // A. It is not really needed, but it speeds things up a lot
  39 //    when you have more than one document loaded at once since a total
  40 //    rebreak (reformatting) need not be done when switching between
  41 //    documents. When the cache is in function a document only needs to be
  42 //    formatted upon loading and when the with of the BufferView changes.
  43 //    Later it will also be unneccessary to reformat when having two
  44 //    BufferViews of equal width with the same document, a simple copy
  45 //    of the LyXText structure will do.
  46 // Invariant for the TextCache:
  47 //        - The buffer of the text  in the TextCache _must_ exists
  48 //          in the bufferlist.
  49 //        - For a text in the TextCache there _must not_ be an equivalent
  50 //          text in any BufferView. (same buffer and width).
  51 // Among others this mean:
  52 //        - When a document is closed all trace of it must be removed from
  53 //          the TextCache.
  54 // Scenarios:
  55 //    I believe there are only three possible scenarios where the two first
  56 //    are also covered by the third.
  57 //        - The simplest scenario is what we have now, a single
  58 //          BufferView only.
  59 //          o Opening
  60 //            Nothing to do with the TextCache is done when opening a file.
  61 //          o Switching
  62 //            We switch from buffer A to buffer B.
  63 //            * A's text is cached in TextCache.
  64 //            * We make a search for a text in TextCache that fits B
  65 //              (same buffer and same width).
  66 //          o Horizontal resize
  67 //            If the BufferView's width (LyXView) is horizontally changed all
  68 //            the entries in the TextCache are deleted. (This causes
  69 //            reformat of all loaded documents when next viewed)
  70 //          o Close
  71 //            When a buffer is closed we don't have to do anything, because
  72 //            to close a single buffer it is required to only exist in the
  73 //            BufferView and not in the TextCache. Upon LFUN_QUIT we
  74 //            don't really care since everything is deleted anyway.
  75 //        - The next scenario is when we have several BufferViews (in one or
  76 //          more LyXViews) of equal width.
  77 //          o Opening
  78 //            Nothing to do with the TextCache is done when opening a file.
  79 //          o Switching
  80 //            We switch from buffer A to buffer B.
  81 //            * If A is in another Bufferview we do not put it into TextCache.
  82 //              else we put A into TextCache.
  83 //            * If B is viewed in another BufferView we make a copy of its
  84 //              text and use that, else we search in TextCache for a match.
  85 //              (same buffer same width)
  86 //          o Horizontal resize
  87 //            If the BufferView's width (LyXView) is horisontaly changed all
  88 //            the entries in the TextCache is deleted. (This causes
  89 //            reformat of all loaded documents when next viewed)
  90 //          o Close
  91 //        - The last scenario should cover both the previous ones, this time
  92 //          we have several BufferViews (in one or more LyXViews) with no
  93 //          limitations on width. (And if you wonder why the two other
  94 //          senarios are needed... I used them to get to this one.)
  95 //          o Opening
  96 //            Nothing to do with the TextCache is done when opening a file.
  97 //          o Switching
  98 //            We switch from buffer A to buffer B.
  99 //          o Horisontal rezize
 100 //          o Close
 101
 102 /** This class is used to cache generated LyXText's.
 103     The LyXText's is used by the BufferView to visualize the contents
 104     of a buffer and its paragraphs. Instead of deleting the LyXText when
 105     we switch from one document to another we cache it here so that when
 106     we switch back we do not have to reformat. This makes switching very
 107     fast at the expense of a bit higher memory usage.
 108 */
 109 class TextCache {
 110 public:
 111         ///
 112         typedef std::map<Buffer *, std::pair<int,LyXText *> > Cache;
 113
 114         ///
 115         typedef Cache::value_type value_type;
 116
 117         /** Returns a pointer to a LyXText that fits the provided buffer
 118             and width. Of there is no match 0 is returned. */
 119         LyXText * findFit(Buffer * b, int p);
 120         /** Lists all the LyXText's currently in the cache.
 121             Uses msg as header for the list. */
 122         void show(std::ostream & o, string const & msg);
 123         /// Gives info on a single LyXText (buffer and width)
 124         static void show(std::ostream & o, value_type const &);
 125         /** Adds a LyXText to the cache iff its buffer is
 126             present in bufferlist. */
 127         void add(Buffer *, int witdth, LyXText *);
 128         /** Clears the cache. Deletes all LyXText's and releases
 129             the allocated memory. */
 130         void clear();
 131         /// Removes all LyXText's that has buffer b from the TextCache
 132         void removeAllWithBuffer(Buffer * b);
 133 private:
 134         /// The cache.
 135         Cache cache;
 136 };
 137
 138 ///
 139 extern TextCache textcache;
 140 #endif