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 * Clean-up of drawing code
  62
  63 The goal is to make painting with drawing disable fast enough that it
  64 can be used after every metrics computation. Then we can separate real
  65 drawing from metrics.
  66
  67 Other changes are only clean-ups.
  68
  69 ** When a paragraph ends with a newline, compute correctly the height of the extra row.
  70 ** Merging bv::updateMetrics and tm::metrics
  71
  72 While the full metrics computation tries hard to limit the number of
  73 paragraphs that are rebroken, the version that is used for inner inset
  74 does not try any such optimization. This can be very bad for very tall
  75 insets. We should re-use the bv::updateMetrics logic:
  76  + transfer all the logic of bv::updateMetrics to tm.
  77  + Main InsetText should not be special.
  78
  79 The difficuly for a tall table cell for example, is that it may be
  80 necessary to break the whole contents to know the width of the cell.
  81
  82
  83 * Description of current drawing mechanism
  84
  85 ** Three-stage drawing
  86
  87 There are three parts to drawing the work area:
  88
  89  + the metrics phase computes the size of insets and breaks the
  90    paragraphs into rows. It stores the dimension of insets (both
  91    normal and math) in bv::coordCache.
  92
  93  + the nodraw drawing phase paints the screen (see below) with a null
  94    painter. The only useful effect is to store the inset positions.
  95
  96  + an update() signal is sent. This in turn will trigger a paint
  97    event, and the actual screen painting will happen then.
  98
  99 The machinery is controlled via bv::processUpdateFlags. This method is
 100 called at the end of bv::mouseEventDispatch and in
 101 GuiApplication::dispatch, via the updateCurrentView method. There are
 102 also several calls in code related to dialogs. We should evaluate
 103 whether this is correct.
 104
 105 Depending on the Update::flags passed to the method, it sets an update
 106 strategy in (NoScreenUpdate, SingleParUpdate, FullScreenUpdate,
 107 DecorationUpdate). It triggers a recomputation of the metrics when either:
 108
 109  + Update::Force has been specified
 110  + Update::FitCursor has been specified and there is a need to scroll
 111    the display.
 112  + the current paragraph, after rebreak, does not have the same height as in
 113    existing metrics. Note that the Update::SinglePar flag is *never*
 114    taken into account.
 115
 116 The screen is drawn (with appropriate update strategy), except when
 117 update flag is Update::None.
 118
 119
 120 ** Metrics computation
 121
 122 This is triggered by bv::updateMetrics, which calls tm::redoParagraph for
 123 all visible paragraphs. Some Paragraphs above or below the screen (needed
 124 for page up/down) and computed as needed.
 125
 126 tm::redoParagraph will call Inset::metrics for each inset. In the case
 127 of text insets, this will invoke recursively tm::metrics, which redoes
 128 all the paragraphs of the inset.
 129
 130
 131 ** Drawing the work area.
 132
 133 This is done in bv::draw. This method is triggered by a paint event,
 134 mainly called through Buffer::changed, which draws all the work areas
 135 that show the given buffer.
 136
 137 Note that, When Buffer::changed is called outside of
 138 bv::processUpdateFlags, it is not clear whether the update strategy
 139 has been set to a reasonable value beforehand.
 140
 141 The action depends on the update strategy:
 142
 143  + NoScreenUpdate: repaint the whole screen with drawing disabled.
 144    This is only needed to update the inset positions. I am not sure
 145    when this is necessary, actually. This is triggered when:
 146    - Update::FitCursor is set but the cursor is already visible. It is
 147      not clear why something needs to be done in this case, since this
 148      should be equivalent to Update::None.
 149    - this is also set when update flag is Update::None, but this value
 150      is AFAICS not acted on in the code (meaning that nothing happens
 151      at all in this case).
 152
 153  + FullScreenUpdate: repaint the whole screen. This is set when:
 154    - updateMetrics has been invoked.
 155    - scroll value of current row has changed (although this should not
 156      be necessary).
 157
 158  + DecorationUpdate: actually like FullScreenUpdate, although it is
 159    intended to only update inset decorations. This triggers when:
 160    - Update::Decoration is set (without Update::Force) as flag.
 161    - An hovered inset is detected.
 162
 163  + SingleParUpdate: only tries to repaint current paragraph in a way
 164    that is not yet very clear to me.
 165
 166 BufferView::draw can also be called with a null painter from
 167 BufferView::updateMetrics().