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::editXY, checkInsetHit using row information (getPosNearX)?
 108
 109    The helper version should return a Row::Element instead of an InsetTable.
 110
 111 ** DONE Do not make RowPainter operations update x_
 112
 113 It is better to make them const and update x_ separately.
 114
 115 ** DONE remove pit argument to breakRow
 116
 117 There are probably other places where the pit is not needed anymore:
 118 computeRowMetrics, labelFill, setRowHeight, isLastRow, isFirstRow
 119
 120 ** DONE Split setRowHeight to separate the computation of space above/below paragraph
 121
 122 This allows to remove the topBottomSpace parameter. The spacing is
 123 computed in redoParagraph, where it feels more natural.
 124
 125 ** Remember rtl status in the row object
 126
 127 This will avoid to pass a Paragraph object to methods that do not need it.
 128
 129 ** Rewrite RowPainter::paintSelection using row information
 130
 131 Currently it uses some very complicated code. It should be possible to
 132 reuse the logic of paintStringAndSel.
 133
 134 ** Set inset position during metrics phase
 135
 136 In order to do that, a no-paint drawing will be initiated after every
 137 redoParagraph. This code path will need to be made as fast as possible.
 138
 139 Effect: avoid depending on actual drawing having taken place. In turn,
 140 it will allow to do drawing on paint events, like any reasonable
 141 application would do.
 142
 143 ** Cleanup after complete metrics
 144    Then the following can be done:
 145    + remove hack in InsetMathNest::drawSelection
 146    + remove painting when not inside in drawParagraph
 147    + remove Cursor::inCoordCache?
 148
 149 ** Use Row for MathData
 150
 151 It may not be so difficult. Implement x2pos and pos2x from
 152 the TM:cursorX and TM::getPosNearX, and use them for both text and
 153 math.
 154
 155 Will the strings display OK if drawing string-wise?
 156
 157 Then it would be possible to streamline drawing with disabled painter.
 158
 159 ** Paint directly to screen
 160
 161 Instead of using an intermediary pixmap. I have no idea of how
 162 difficult it will prove.
 163 One benefit will be that subpixel aliasing will work again (#9972)
 164
 165 ** Merging bv::updateMetrics and tm::metrics
 166
 167 While the full metrics computation tries hard to limit the number of
 168 paragraphs that are rebroken, the version that is used for inner inset
 169 does not try any such optimization. This can be very bad for very tall
 170 insets. We should re-use the bv::updateMetrics logic:
 171  + transfer all the logic of bv::updateMetrics to tm.
 172  + Main InsetText should not be special.
 173
 174 The difficuly for a tall table cell for example, is that it may be
 175 necessary to break the whole contents to know the width of the cell.
 176
 177
 178 * Description of current drawing mechanism
 179
 180 ** Two stage drawing
 181
 182 There are two parts to drawing the work area:
 183
 184  + the metrics phase computes the size of insets and breaks the
 185    paragraphs into rows. It stores the dimension of insets (both
 186    normal and math) in bv::coordCache.
 187
 188  + the drawing phase draws the contents and caches the inset
 189    positions. Since the caching of positions is useful in itself,
 190    there is a provision for drawing "without" drawing when the only
 191    thing we want is to cache inset positions
 192    (Painter::setDrawingEnabled).
 193
 194 The machinery is controlled via bv::processUpdateFlags. This method is
 195 called at the end of bv::mouseEventDispatch and in
 196 GuiApplication::dispatch, via the updateCurrentView method. There are
 197 also several calls in code related to dialogs. We should evaluate
 198 whether this is correct.
 199
 200 Depending on the Update::flags passed to the method, it sets an update
 201 strategy in (NoScreenUpdate, SingleParUpdate, FullScreenUpdate,
 202 DecorationUpdate). It triggers a recomputation of the metrics when either:
 203
 204  + Update::Force has been specified
 205  + Update::FitCursor has been specified and there is a need to scroll
 206    the display.
 207  + the current paragraph, after rebreak, does not have the same height as in
 208    existing metrics. Note that the Update::SinglePar flag is *never*
 209    taken into account.
 210
 211 The screen is drawn (with appropriate update strategy), except when
 212 update flag is Update::None.
 213
 214
 215 ** Metrics computation
 216
 217 This is triggered by bv::updateMetrics, which calls tm::redoParagraph for
 218 all visible paragraphs. Paragraphs above or below the screen (needed
 219 for page up/down) and computed as needed.
 220
 221 tm::redoParagraph will call Inset::metrics for each inset. In the case
 222 of text insets, this will invoke recursively tm::metrics, which redoes
 223 all the paragraphs of the inset.
 224
 225
 226 ** Drawing the work area.
 227
 228 This is done in bv::draw. This method is triggered mainly by
 229 Buffer::changed, which draws all the work areas that show the given buffer.
 230
 231 Note that, When Buffer::changed is called outside of
 232 bv::processUpdateFlags, it is not clear whether the update strategy
 233 has been set to a reasonable value beforehand.
 234
 235 The action depends on the update strategy:
 236
 237  + NoScreenUpdate: repaint the whole screen with drawing disabled.
 238    This is only needed to update the inset positions. I am not sure
 239    when this is necessary, actually. This is triggered when:
 240    - Update::FitCursor is set but the cursor is already visible. It is
 241      not clear why something needs to be done in this case, since this
 242      should be equivalent to Update::None.
 243    - this is also set when update flag is Update::None, but this value
 244      is AFAICS not acted on in the code (meaning that nothing happens
 245      at all in this case).
 246
 247  + FullScreenUpdate: repaint the whole screen. This is set when:
 248    - updateMetrics has been invoked.
 249    - scroll value of current row has changed (although this should not
 250      be necessary).
 251
 252  + DecorationUpdate: actually like FullScreenUpdate, although it is
 253    intended to only update inset decorations. This triggers when:
 254    - Update::Decoration is set (without Update::Force) as flag.
 255    - An hovered inset is detected.
 256
 257  + SingleParUpdate: only tries to repaint current paragraph in a way
 258    that is not yet very clear to me.