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 ** DONE RowPainter
  70
  71 Inset position is set in paintInset, paintOnlyInsets, and paintText.
  72 This should be done only once in paintInset
  73
  74 ** DONE TextMetrics::drawParagraph
  75
  76 We can really simplify the code when drawing is disabled only
  77 paintInset needs to be called.
  78  + do right at the start when drawing is already disabled
  79  + do it in the loop for rows that are not visible on screen.
  80
  81 The only thing we want to do here is to set inset positions (for
  82 text). The other insets still use the painter with drawing disabled.
  83
  84 ** DONE Painter::text
  85
  86 We cannot remove (or make private) the version that uses a
  87 FontInfo because it is used by PainterInfo::draw. Document this and
  88 remove unused arguments rtl and double spacing. This would become a specialized helper.
  89 Proposed solution: keep the existing function, but private and without
  90 optional arguments.
  91
  92 Avoid to return (and thus compute) the width of strings?
  93  + used by InsetSpecialChar (fixable)
  94  + used by textDecoration() in text(): more difficult to fix
  95
  96 Idea: add a version of text where wordspacing and textwidth (giving
  97 the width of strings) are required parameters and remove optional
  98 version.
  99
 100 ==> more versions, no optional parameters.
 101
 102 ** DONE When a document ends with a newline, add the bottom margin anyway
 103
 104 The code that tests for a newline was added at 6bb98d07 in 2007.
 105
 106 ** When a paragraph ends with a newline, compute correctly the height of the extra row.
 107 ** Rewrite TextMetrics::completionPosAndDim using row information
 108
 109 Currently it uses setRowHeight in a very weird way. In particular the
 110 topBottomSpace parameter should be removed after that.
 111
 112 ** Rewrite TextMetrics::editXY, checkInsetHit using row information (getPosNearX)?
 113
 114    The helper version should return a Row::Element instead of an InsetTable.
 115
 116 ** Do not make RowPainter operations update x_
 117
 118 It is better to make them const and update x_ separately.
 119
 120 Then it will be possible to reorder the painting of the different
 121 elements. In particular, if text is painted last, it will be more
 122 visible in the presence of underlines (foreign language, change
 123 tracking, spell check).
 124
 125 ** Set inset position during metrics phase
 126
 127 In order to do that, a no-paint drawing will be initiated after every
 128 redoParagraph. This code path will need to be made as fast as possible.
 129
 130 Effect: avoid depending on actual drawing having taken place. In turn,
 131 it will allow to do drawing on paint events, like any reasonable
 132 application would do.
 133
 134 ** Cleanup after complete metrics
 135    Then the following can be done:
 136    + remove hack in InsetMathNest::drawSelection
 137    + remove painting when not inside in drawParagraph
 138    + remove Cursor::inCoordCache?
 139
 140 ** Use Row for MathData
 141
 142 It may not be so difficult. Implement x2pos and pos2x from
 143 the TM:cursorX and TM::getPosNearX, and use them for both text and
 144 math.
 145
 146 Will the strings display OK if drawing string-wise?
 147
 148 Then it would be possible to streamline drawing with disabled painter.
 149
 150 ** Paint directly to screen
 151
 152 Instead of using an intermediary pixmap. I have no idea of how
 153 difficult it will prove.
 154 One benefit will be that subpixel aliasing will work again (#9972)
 155
 156 ** Merging bv::updateMetrics and tm::metrics
 157
 158 While the full metrics computation tries hard to limit the number of
 159 paragraphs that are rebroken, the version that is used for inner inset
 160 does not try any such optimization. This can be very bad for very tall
 161 insets. We should re-use the bv::updateMetrics logic:
 162  + transfer all the logic of bv::updateMetrics to tm.
 163  + Main InsetText should not be special.
 164
 165 The difficuly for a tall table cell for example, is that it may be
 166 necessary to break the whole contents to know the width of the cell.
 167
 168
 169 * Description of current drawing mechanism
 170
 171 ** Two stage drawing
 172
 173 There are two parts to drawing the work area:
 174
 175  + the metrics phase computes the size of insets and breaks the
 176    paragraphs into rows. It stores the dimension of insets (both
 177    normal and math) in bv::coordCache.
 178
 179  + the drawing phase draws the contents and caches the inset
 180    positions. Since the caching of positions is useful in itself,
 181    there is a provision for drawing "without" drawing when the only
 182    thing we want is to cache inset positions
 183    (Painter::setDrawingEnabled).
 184
 185 The machinery is controlled via bv::processUpdateFlags. This method is
 186 called at the end of bv::mouseEventDispatch and in
 187 GuiApplication::dispatch, via the updateCurrentView method. There are
 188 also several calls in code related to dialogs. We should evaluate
 189 whether this is correct.
 190
 191 Depending on the Update::flags passed to the method, it sets an update
 192 strategy in (NoScreenUpdate, SingleParUpdate, FullScreenUpdate,
 193 DecorationUpdate). It triggers a recomputation of the metrics when either:
 194
 195  + Update::Force has been specified
 196  + Update::FitCursor has been specified and there is a need to scroll
 197    the display.
 198  + the current paragraph, after rebreak, does not have the same height as in
 199    existing metrics. Note that the Update::SinglePar flag is *never*
 200    taken into account.
 201
 202 The screen is drawn (with appropriate update strategy), except when
 203 update flag is Update::None.
 204
 205
 206 ** Metrics computation
 207
 208 This is triggered by bv::updateMetrics, which calls tm::redoParagraph for
 209 all visible paragraphs. Paragraphs above or below the screen (needed
 210 for page up/down) and computed as needed.
 211
 212 tm::redoParagraph will call Inset::metrics for each inset. In the case
 213 of text insets, this will invoke recursively tm::metrics, which redoes
 214 all the paragraphs of the inset.
 215
 216
 217 ** Drawing the work area.
 218
 219 This is done in bv::draw. This method is triggered mainly by
 220 Buffer::changed, which draws all the work areas that show the given buffer.
 221
 222 Note that, When Buffer::changed is called outside of
 223 bv::processUpdateFlags, it is not clear whether the update strategy
 224 has been set to a reasonable value beforehand.
 225
 226 The action depends on the update strategy:
 227
 228  + NoScreenUpdate: repaint the whole screen with drawing disabled.
 229    This is only needed to update the inset positions. I am not sure
 230    when this is necessary, actually. This is triggered when:
 231    - Update::FitCursor is set but the cursor is already visible. It is
 232      not clear why something needs to be done in this case, since this
 233      should be equivalent to Update::None.
 234    - this is also set when update flag is Update::None, but this value
 235      is AFAICS not acted on in the code (meaning that nothing happens
 236      at all in this case).
 237
 238  + FullScreenUpdate: repaint the whole screen. This is set when:
 239    - updateMetrics has been invoked.
 240    - scroll value of current row has changed (although this should not
 241      be necessary).
 242
 243  + DecorationUpdate: actually like FullScreenUpdate, although it is
 244    intended to only update inset decorations. This triggers when:
 245    - Update::Decoration is set (without Update::Force) as flag.
 246    - An hovered inset is detected.
 247
 248  + SingleParUpdate: only tries to repaint current paragraph in a way
 249    that is not yet very clear to me.