development/PAINTING_ANALYSIS

   1 # -*- org -*-
   2 Understanding the painting process
   3
   4 This file tries to describe the state of the metrics/painting
   5 mechanism, and identify the improvements that could be made. The first
   6 section can be read alone, although the context for them is really
   7 given in the following ones.
   8
   9 Please keep this file up to date as the code evolves!!!
  10
  11 Abbreviations:
  12 bv: BufferView
  13 pm: ParagraphMetrics
  14 tm::TextMetrics
  15
  16 * Questions / Ideas
  17
  18 These questions are consequences of the description made in the
  19 following section. Some actions are proposed.
  20
  21 ** SinglePar update
  22
  23 The flag Update::SinglePar is set in many places but never acted on.
  24 Instead, metrics update is skipped whenever the recorded height of
  25 current paragraph did not change and Update::Force was not specified.
  26 Is it better to keep that (which incurs extra work) or to condition it
  27 on Update::SinglePar? If the first solution is kept, the flag
  28 SingleParUpdate shall be removed.
  29
  30 Moreover, I fail to see (yet) where the 'single' part of the program
  31 is acted on.
  32
  33 ** Buffer::change issues
  34
  35 When calling Buffer::changed outside of bv::processUpdateFlags,
  36 how do we know that the update strategy is set correctly? It is
  37 possible to reset the strategy at the end of bv::draw. What would be
  38 a good value? NoScreenUpdate?
  39
  40 On a related note, what is the semantics of a call to
  41 Buffer::changed(false)? What does the caller mean?
  42
  43 ** How to avoid redraw with FitCursor when the cursor is already OK?
  44
  45 In this case, we invoke Buffer::change(false) with drawing disabled
  46 and NoScreenUpdate strategy.
  47
  48 In the draw phase, bv::checkCursorScrollOffset (the horizontal
  49 scrolling machinery) will change the strategy to FullScreenUpdate if
  50 the current row needs further scrolling.
  51
  52 When the update strategy it kept to NoScreenUpdate, there is currently
  53 a no-draw full repaint, which should not be necessary. It would be
  54 possible to avoid that if the call to checkCursorScrollOffset was done
  55 in bv::processUpdateFlags instead of bv::draw.
  56
  57 The global idea would be to extend FitCursor to cover also horizontal
  58 cursor.
  59
  60
  61 * Proposals
  62
  63 ** set inset position during metrics phase
  64
  65 This implies to set inset positions relative to outer inset during
  66 metrics phase and then in a second loop to descend into insets and
  67 update positions correctly.
  68
  69 Effect: avoid going through the painter machinery when it is not necessary.
  70
  71 ** Merging bv::updateMetrics and tm::metrics
  72
  73 While the full metrics computation tries hard to limit the number of
  74 paragraphs that are rebroken, the version that is used for inner inset
  75 does not try any such optimization. This can be very bad for very tall
  76 insets. We should re-use the bv::updateMetrics logic:
  77  + transfer all the logic of bv::updateMetrics to tm.
  78  +  Main InsetText should not be special.
  79
  80 ** Metrics outside of visible area
  81
  82 Currently metrics are computed for current visible paet of text, the
  83 page above and the page below. It should be possible to compute hidden
  84 rows ony on demand, although it might be a bit slow.
  85
  86 There was a proposal to always compute _all_ rows, but this may become
  87 expensive for large files. This would though help scrolling.
  88
  89
  90 * Description of current drawing mechanism
  91
  92 ** Two stage drawing
  93
  94 There are two parts to drawing the work area:
  95
  96  + the metrics phase computes the size of insets and breaks the
  97    paragraphs into rows. It stores the dimension of insets (both
  98    normal and math) in bv::coordCache.
  99
 100  + the drawing phase draws the contents and caches the inset
 101    positions. Since the caching of positions is useful in itself,
 102    there is a provision for drawing "without" drawing when the only
 103    thing we want is to cache inset positions
 104    (Painter::setDrawingEnabled).
 105
 106 The machinery is controlled via bv::processUpdateFlags. This method is
 107 called at the end of bv::mouseEventDispatch and in
 108 GuiApplication::dispatch, via the updateCurrentView method. There are
 109 also several calls in code related to dialogs. We should evaluate
 110 whether this is correct.
 111
 112 Depending on the Update::flags passed to the method, it sets an update
 113 strategy in (NoScreenUpdate, SingleParUpdate, FullScreenUpdate,
 114 DecorationUpdate). It triggers a recomputation of the metrics when either:
 115
 116  + Update::Force has been specified
 117  + Update::FitCursor has been specified and there is a need to scroll
 118    the display.
 119  + the current paragraph, after rebreak, does not have the same height as in
 120    existing metrics. Note that the Update::SinglePar flag is *never*
 121    taken into account.
 122
 123 The screen is drawn (with appropriate update strategy), except when
 124 update flag is Update::None.
 125
 126
 127 ** Metrics computation
 128
 129 This is triggered by bv::updateMetrics, which calls tm::redoParagraph for
 130   + all visible paragraphs
 131   + paragraph above the screen (up to one page)
 132   + paragraphs below the screen (up to one page again)
 133
 134 The paragraphs outside of the screen are required to make PageUp/Down
 135 work.
 136
 137 tm::redoParagraph will call Inset::metrics for each inset. In the case
 138 of text insets, this will invoke recursively tm::metrics, which redoes
 139 all the paragraphs of the inset.
 140
 141
 142 ** Drawing the work area.
 143
 144 This is done in bv::draw. This method is triggered mainly by
 145 Buffer::changed, which draws all the work areas that show the given buffer.
 146
 147 Note that, When Buffer::changed is called outside of
 148 bv::processUpdateFlags, it is not clear whether the update strategy
 149 has been set to a reasonable value beforehand.
 150
 151 The action depends on the update strategy:
 152
 153  + NoScreenUpdate: repaint the whole screen with drawing disabled.
 154    This is only needed to update the inset positions. I am not sure
 155    when this is necessary, actually. This is triggered when:
 156    - Update::FitCursor is set but the cursor is already visible. It is
 157      not clear why something needs to be done in this case, since this
 158      should be equivalent to Update::None.
 159    - this is also set when update flag is Update::None, but this value
 160      is AFAICS not acted on in the code (meaning that nothing happens
 161      at all in this case).
 162
 163  + FullScreenUpdate: repaint the whole screen. This is set when:
 164    - updateMetrics has been invoked.
 165    - scroll value of current row has changed (although this should not
 166      be necessary).
 167
 168  + DecorationUpdate: actually like FullScreenUpdate, although it is
 169    intended to only update inset decorations. This triggers when:
 170    - Update::Decoration is set (without Update::Force) as flag.
 171    - An hovered inset is detected.
 172
 173  + SingleParUpdate: only tries to repaint current paragraph in a way
 174    that is not yet very clear to me.