Document many of the advpack functions.
[wine] / dlls / riched20 / paint.c
1 /*
2  * RichEdit - painting functions
3  *
4  * Copyright 2004 by Krzysztof Foltman
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #include "editor.h"
22
23 WINE_DEFAULT_DEBUG_CHANNEL(richedit);
24
25 void ME_PaintContent(ME_TextEditor *editor, HDC hDC, BOOL bOnlyNew, RECT *rcUpdate) {
26   ME_DisplayItem *item;
27   ME_Context c;
28   int yoffset;
29
30   editor->nSequence++;
31   yoffset = ME_GetYScrollPos(editor);
32   ME_InitContext(&c, editor, hDC);
33   SetBkMode(hDC, TRANSPARENT);
34   ME_MoveCaret(editor);
35   item = editor->pBuffer->pFirst->next;
36   c.pt.y -= yoffset;
37   while(item != editor->pBuffer->pLast) {
38     int ye;
39     assert(item->type == diParagraph);
40     ye = c.pt.y + item->member.para.nHeight;
41     if (!bOnlyNew || (item->member.para.nFlags & MEPF_REPAINT))
42     {
43       BOOL bPaint = (rcUpdate == NULL);
44       if (rcUpdate)
45         bPaint = c.pt.y<rcUpdate->bottom && 
46           c.pt.y+item->member.para.nHeight>rcUpdate->top;
47       if (bPaint)
48       {
49         ME_DrawParagraph(&c, item);
50         if (!rcUpdate || (rcUpdate->top<=c.pt.y && rcUpdate->bottom>=ye))
51           item->member.para.nFlags &= ~MEPF_REPAINT;
52       }
53     }
54     c.pt.y = ye;
55     item = item->member.para.next_para;
56   }
57   if (c.pt.y<c.rcView.bottom) {
58     RECT rc;
59     int xs = c.rcView.left, xe = c.rcView.right;
60     int ys = c.pt.y, ye = c.rcView.bottom;
61     
62     if (bOnlyNew)
63     {
64       int y1 = editor->nTotalLength-yoffset, y2 = editor->nLastTotalLength-yoffset;
65       if (y1<y2)
66         ys = y1, ye = y2+1;
67       else
68         ys = ye;
69     }
70     
71     if (rcUpdate && ys!=ye)
72     {
73       xs = rcUpdate->left, xe = rcUpdate->right;
74       if (rcUpdate->top > ys)
75         ys = rcUpdate->top;
76       if (rcUpdate->bottom < ye)
77         ye = rcUpdate->bottom;
78     }
79
80     if (ye>ys) {
81       rc.left = xs;
82       rc.top = ys;
83       rc.right = xe;
84       rc.bottom = ye;
85       FillRect(hDC, &rc, c.editor->hbrBackground);
86     }
87     if (ys == c.pt.y) /* don't overwrite the top bar */
88       ys++;
89   }
90   if (editor->nTotalLength != editor->nLastTotalLength)
91     ME_SendRequestResize(editor, FALSE);
92   editor->nLastTotalLength = editor->nTotalLength;
93   ME_DestroyContext(&c);
94 }
95
96 static void ME_MarkParagraphRange(ME_TextEditor *editor, ME_DisplayItem *p1,
97                            ME_DisplayItem *p2, int nFlags)
98 {
99   ME_DisplayItem *p3;  
100   if (p1 == p2)
101   {
102     p1->member.para.nFlags |= nFlags;
103     return;
104   }
105   if (p1->member.para.nCharOfs > p2->member.para.nCharOfs)
106     p3 = p1, p1 = p2, p2 = p3;
107     
108   p1->member.para.nFlags |= nFlags;
109   do {
110     p1 = p1->member.para.next_para;
111     p1->member.para.nFlags |= nFlags;
112   } while (p1 != p2);
113 }
114
115 static void ME_MarkOffsetRange(ME_TextEditor *editor, int from, int to, int nFlags)
116 {
117   ME_Cursor c1, c2;
118   ME_CursorFromCharOfs(editor, from, &c1);
119   ME_CursorFromCharOfs(editor, to, &c2);
120   
121   ME_MarkParagraphRange(editor, ME_GetParagraph(c1.pRun), ME_GetParagraph(c2.pRun), nFlags);
122 }
123
124 static void ME_MarkSelectionForRepaint(ME_TextEditor *editor)
125 {
126   int from, to, from2, to2, end;
127   
128   end = ME_GetTextLength(editor);
129   ME_GetSelection(editor, &from, &to);
130   from2 = editor->nLastSelStart;
131   to2 = editor->nLastSelEnd;
132   if (from<from2) ME_MarkOffsetRange(editor, from, from2, MEPF_REPAINT);
133   if (from>from2) ME_MarkOffsetRange(editor, from2, from, MEPF_REPAINT);
134   if (to<to2) ME_MarkOffsetRange(editor, to, to2, MEPF_REPAINT);
135   if (to>to2) ME_MarkOffsetRange(editor, to2, to, MEPF_REPAINT);
136
137   editor->nLastSelStart = from;
138   editor->nLastSelEnd = to;
139 }
140
141 void ME_Repaint(ME_TextEditor *editor)
142 {
143   ME_Cursor *pCursor = &editor->pCursors[0];
144   ME_DisplayItem *pRun = NULL;
145   int nOffset = -1;
146   HDC hDC;
147   int nCharOfs = ME_CharOfsFromRunOfs(editor, pCursor->pRun, pCursor->nOffset);
148   
149   ME_RunOfsFromCharOfs(editor, nCharOfs, &pRun, &nOffset);
150   assert(pRun == pCursor->pRun);
151   assert(nOffset == pCursor->nOffset);
152   ME_MarkSelectionForRepaint(editor);
153   if (ME_WrapMarkedParagraphs(editor)) {
154     ME_UpdateScrollBar(editor);
155   }
156   if (editor->bRedraw)
157   {
158     hDC = GetDC(editor->hWnd);
159     ME_HideCaret(editor);
160     ME_PaintContent(editor, hDC, TRUE, NULL);
161     ReleaseDC(editor->hWnd, hDC);
162     ME_ShowCaret(editor);
163     ME_EnsureVisible(editor, pCursor->pRun);
164   }
165 }
166
167 void ME_UpdateRepaint(ME_TextEditor *editor)
168 {
169 /*
170   InvalidateRect(editor->hWnd, NULL, TRUE);
171   */
172   ME_SendOldNotify(editor, EN_CHANGE);
173   ME_Repaint(editor);
174   ME_SendOldNotify(editor, EN_UPDATE);
175   ME_SendSelChange(editor);
176 }
177
178
179 void
180 ME_RewrapRepaint(ME_TextEditor *editor)
181 {
182   ME_MarkAllForWrapping(editor);
183   ME_WrapMarkedParagraphs(editor);
184   ME_UpdateScrollBar(editor);
185   ME_Repaint(editor);
186 }
187
188
189 static void ME_DrawTextWithStyle(ME_Context *c, int x, int y, LPCWSTR szText, int nChars, 
190   ME_Style *s, int *width, int nSelFrom, int nSelTo, int ymin, int cy) {
191   HDC hDC = c->hDC;
192   HGDIOBJ hOldFont;
193   COLORREF rgbOld, rgbBack;
194   int yOffset = 0, yTwipsOffset = 0;
195   hOldFont = ME_SelectStyleFont(c->editor, hDC, s);
196   rgbBack = ME_GetBackColor(c->editor);
197   if ((s->fmt.dwMask & CFM_COLOR) && (s->fmt.dwEffects & CFE_AUTOCOLOR))
198     rgbOld = SetTextColor(hDC, GetSysColor(COLOR_WINDOWTEXT));
199   else
200     rgbOld = SetTextColor(hDC, s->fmt.crTextColor);
201   if ((s->fmt.dwMask & s->fmt.dwEffects) & CFM_OFFSET) {
202     yTwipsOffset = s->fmt.yOffset;
203   }
204   if ((s->fmt.dwMask & s->fmt.dwEffects) & (CFM_SUPERSCRIPT | CFM_SUBSCRIPT)) {
205     if (s->fmt.dwEffects & CFE_SUPERSCRIPT) yTwipsOffset = s->fmt.yHeight/3;
206     if (s->fmt.dwEffects & CFE_SUBSCRIPT) yTwipsOffset = -s->fmt.yHeight/12;
207   }
208   if (yTwipsOffset)
209   {
210     int numerator = 1;
211     int denominator = 1;
212     
213     if (c->editor->nZoomNumerator)
214     {
215       numerator = c->editor->nZoomNumerator;
216       denominator = c->editor->nZoomDenominator;
217     }
218     yOffset = yTwipsOffset * GetDeviceCaps(hDC, LOGPIXELSY) * numerator / denominator / 1440;
219   }
220   ExtTextOutW(hDC, x, y-yOffset, 0, NULL, szText, nChars, NULL);
221   if (width) {
222     SIZE sz;
223     GetTextExtentPoint32W(hDC, szText, nChars, &sz);
224     *width = sz.cx;
225   }
226   if (nSelFrom < nChars && nSelTo >= 0 && nSelFrom<nSelTo)
227   {
228     SIZE sz;
229     if (nSelFrom < 0) nSelFrom = 0;
230     if (nSelTo > nChars) nSelTo = nChars;
231     GetTextExtentPoint32W(hDC, szText, nSelFrom, &sz);
232     x += sz.cx;
233     GetTextExtentPoint32W(hDC, szText+nSelFrom, nSelTo-nSelFrom, &sz);
234     PatBlt(hDC, x, ymin, sz.cx, cy, DSTINVERT);
235   }
236   SetTextColor(hDC, rgbOld);
237   ME_UnselectStyleFont(c->editor, hDC, s, hOldFont);
238 }
239
240 static void ME_DebugWrite(HDC hDC, POINT *pt, WCHAR *szText) {
241   int align = SetTextAlign(hDC, TA_LEFT|TA_TOP);
242   HGDIOBJ hFont = SelectObject(hDC, GetStockObject(DEFAULT_GUI_FONT));
243   COLORREF color = SetTextColor(hDC, RGB(128,128,128));
244   TextOutW(hDC, pt->x, pt->y, szText, lstrlenW(szText));
245   SelectObject(hDC, hFont);
246   SetTextAlign(hDC, align);
247   SetTextColor(hDC, color);
248 }
249
250 void ME_DrawGraphics(ME_Context *c, int x, int y, ME_Run *run, 
251                      ME_Paragraph *para, BOOL selected) {
252   SIZE sz;
253   int xs, ys, xe, ye, h, ym, width, eyes;
254   ME_GetGraphicsSize(c->editor, run, &sz);
255   xs = run->pt.x;
256   ys = y-sz.cy;
257   xe = xs+sz.cx;
258   ye = y;
259   h = ye-ys;
260   ym = ys+h/4;
261   width = sz.cx;
262   eyes = width/8;
263   /* draw a smiling face :) */
264   Ellipse(c->hDC, xs, ys, xe, ye);
265   Ellipse(c->hDC, xs+width/8, ym, x+width/8+eyes, ym+eyes);
266   Ellipse(c->hDC, xs+7*width/8-eyes, ym, xs+7*width/8, ym+eyes);
267   MoveToEx(c->hDC, xs+width/8, ys+3*h/4-eyes, NULL);
268   LineTo(c->hDC, xs+width/8, ys+3*h/4);
269   LineTo(c->hDC, xs+7*width/8, ys+3*h/4);
270   LineTo(c->hDC, xs+7*width/8, ys+3*h/4-eyes);
271   if (selected)
272   {
273     /* descent is usually (always?) 0 for graphics */
274     PatBlt(c->hDC, x, y-run->nAscent, sz.cx, run->nAscent+run->nDescent, DSTINVERT);    
275   }
276 }
277
278 static void ME_DrawRun(ME_Context *c, int x, int y, ME_DisplayItem *rundi, ME_Paragraph *para) {
279   ME_Run *run = &rundi->member.run;
280   int runofs = run->nCharOfs+para->nCharOfs;
281   
282   /* you can always comment it out if you need visible paragraph marks */
283   if (run->nFlags & (MERF_ENDPARA|MERF_TAB)) 
284     return;
285   if (run->nFlags & MERF_GRAPHICS) {
286     int blfrom, blto;
287     ME_GetSelection(c->editor, &blfrom, &blto);
288     ME_DrawGraphics(c, x, y, run, para, (runofs >= blfrom) && (runofs < blto));
289   } else
290   {
291     int blfrom, blto;
292     ME_DisplayItem *start = ME_FindItemBack(rundi, diStartRow);
293     ME_GetSelection(c->editor, &blfrom, &blto);
294     
295     ME_DrawTextWithStyle(c, x, y, 
296       run->strText->szData, ME_StrVLen(run->strText), run->style, NULL, 
297         blfrom-runofs, blto-runofs, c->pt.y+start->member.row.nYPos, start->member.row.nHeight);
298   }
299 }
300
301 COLORREF ME_GetBackColor(ME_TextEditor *editor)
302 {
303 /* Looks like I was seriously confused
304     return GetSysColor((GetWindowLong(editor->hWnd, GWL_STYLE) & ES_READONLY) ? COLOR_3DFACE: COLOR_WINDOW);
305 */
306   if (editor->rgbBackColor == -1)
307     return GetSysColor(COLOR_WINDOW);
308   else
309     return editor->rgbBackColor;
310 }
311
312 void ME_DrawParagraph(ME_Context *c, ME_DisplayItem *paragraph) {
313   int align = SetTextAlign(c->hDC, TA_BASELINE);
314   ME_DisplayItem *p;
315   ME_Run *run;
316   ME_Paragraph *para = NULL;
317   RECT rc, rcPara;
318   int y = c->pt.y;
319   int height = 0, baseline = 0, no=0, pno = 0;
320   int xs, xe;
321   int visible = 0;
322   int nMargWidth = 0;
323   
324   c->pt.x = c->rcView.left;
325   rcPara.left = c->rcView.left;
326   rcPara.right = c->rcView.right;
327   for (p = paragraph; p!=paragraph->member.para.next_para; p = p->next) {
328     switch(p->type) {
329       case diParagraph:
330         para = &p->member.para;
331         break;
332       case diStartRow:
333         assert(para);
334         nMargWidth = (pno==0?para->nFirstMargin:para->nLeftMargin);
335         xs = c->rcView.left+nMargWidth;
336         xe = c->rcView.right-para->nRightMargin;
337         y += height;
338         rcPara.top = y;
339         rcPara.bottom = y+p->member.row.nHeight;
340         visible = RectVisible(c->hDC, &rcPara);
341         if (visible) {
342           HBRUSH hbr;
343           hbr = CreateSolidBrush(ME_GetBackColor(c->editor));
344           /* left margin */
345           rc.left = c->rcView.left;
346           rc.right = c->rcView.left+nMargWidth;
347           rc.top = y;
348           rc.bottom = y+p->member.row.nHeight;
349           FillRect(c->hDC, &rc, hbr/* c->hbrMargin */);
350           /* right margin */
351           rc.left = xe;
352           rc.right = c->rcView.right;
353           FillRect(c->hDC, &rc, hbr/* c->hbrMargin */);
354           rc.left = c->rcView.left+nMargWidth;
355           rc.right = xe;
356           FillRect(c->hDC, &rc, hbr);
357           DeleteObject(hbr);
358         }
359         if (me_debug)
360         {
361           const WCHAR wszRowDebug[] = {'r','o','w','[','%','d',']',0};
362           WCHAR buf[128];
363           POINT pt = c->pt;
364           wsprintfW(buf, wszRowDebug, no);
365           pt.y = 12+y;
366           ME_DebugWrite(c->hDC, &pt, buf);
367         }
368         
369         height = p->member.row.nHeight;
370         baseline = p->member.row.nBaseline;
371         pno++;
372         break;
373       case diRun:
374         assert(para);
375         run = &p->member.run;
376         if (visible && me_debug) {
377           rc.left = c->rcView.left+run->pt.x;
378           rc.right = c->rcView.left+run->pt.x+run->nWidth;
379           rc.top = c->pt.y+run->pt.y;
380           rc.bottom = c->pt.y+run->pt.y+height;
381           TRACE("rc = (%ld, %ld, %ld, %ld)\n", rc.left, rc.top, rc.right, rc.bottom);
382           if (run->nFlags & MERF_SKIPPED)
383             DrawFocusRect(c->hDC, &rc);
384           else
385             FrameRect(c->hDC, &rc, GetSysColorBrush(COLOR_GRAYTEXT));
386         }
387         if (visible)
388           ME_DrawRun(c, run->pt.x, c->pt.y+run->pt.y+baseline, p, &paragraph->member.para);
389         if (me_debug)
390         {
391           /* I'm using %ls, hope wsprintfW is not going to use wrong (4-byte) WCHAR version */
392           const WCHAR wszRunDebug[] = {'[','%','d',':','%','x',']',' ','%','l','s',0};
393           WCHAR buf[2560];
394           POINT pt;
395           pt.x = run->pt.x;
396           pt.y = c->pt.y + run->pt.y;
397           wsprintfW(buf, wszRunDebug, no, p->member.run.nFlags, p->member.run.strText->szData);
398           ME_DebugWrite(c->hDC, &pt, buf);
399         }
400         /* c->pt.x += p->member.run.nWidth; */
401         break;
402       default:
403         break;
404     }
405     no++;
406   }
407   SetTextAlign(c->hDC, align);
408 }
409
410 void ME_Scroll(ME_TextEditor *editor, int cx, int cy)
411 {
412   SCROLLINFO si;
413   HWND hWnd = editor->hWnd;
414
415   si.cbSize = sizeof(SCROLLINFO);
416   si.fMask = SIF_POS;
417   GetScrollInfo(hWnd, SB_VERT, &si);
418   si.nPos = editor->nScrollPosY -= cy;
419   SetScrollInfo(hWnd, SB_VERT, &si, TRUE);
420   if (editor->bRedraw)
421   {
422     if (abs(cy) > editor->sizeWindow.cy)
423       InvalidateRect(editor->hWnd, NULL, TRUE);
424     else
425       ScrollWindowEx(hWnd, cx, cy, NULL, NULL, NULL, NULL, SW_ERASE|SW_INVALIDATE);
426   }
427 }
428
429 void ME_UpdateScrollBar(ME_TextEditor *editor)
430 {
431   HWND hWnd = editor->hWnd;
432   SCROLLINFO si;
433   int nOldLen = editor->nTotalLength;
434   BOOL bScrollY = (editor->nTotalLength > editor->sizeWindow.cy);
435   BOOL bUpdateScrollBars;
436   si.cbSize = sizeof(si);
437   si.fMask = SIF_POS | SIF_RANGE;
438   GetScrollInfo(hWnd, SB_VERT, &si);
439   bUpdateScrollBars = (bScrollY || editor->bScrollY)&& ((si.nMax != nOldLen) || (si.nPage != editor->sizeWindow.cy));
440   
441   if (bScrollY != editor->bScrollY)
442   {
443     si.fMask = SIF_RANGE | SIF_PAGE;
444     si.nMin = 0;
445     si.nPage = editor->sizeWindow.cy;
446     if (bScrollY) {
447       si.nMax = editor->nTotalLength;
448     } else {
449       si.nMax = 0;
450     }
451     SetScrollInfo(hWnd, SB_VERT, &si, FALSE);
452     ME_MarkAllForWrapping(editor);
453     editor->bScrollY = bScrollY;
454     ME_WrapMarkedParagraphs(editor);
455     bUpdateScrollBars = TRUE;
456   }
457   if (bUpdateScrollBars) {
458     int nScroll = 0;
459     si.fMask = SIF_PAGE | SIF_RANGE | SIF_POS;
460     if (editor->nTotalLength > editor->sizeWindow.cy) {
461       si.nMax = editor->nTotalLength;
462       si.nPage = editor->sizeWindow.cy;
463       if (si.nPos > si.nMax-si.nPage) {
464         nScroll = (si.nMax-si.nPage)-si.nPos;
465         si.nPos = si.nMax-si.nPage;
466       }
467     }
468     else {
469       si.nMax = 0;
470       si.nPage = 0;
471       si.nPos = 0;
472     }
473     TRACE("min=%d max=%d page=%d pos=%d shift=%d\n", si.nMin, si.nMax, si.nPage, si.nPos, nScroll);
474     editor->nScrollPosY = si.nPos;
475     SetScrollInfo(hWnd, SB_VERT, &si, TRUE);
476     if (nScroll)
477       ScrollWindow(hWnd, 0, -nScroll, NULL, NULL);
478   }
479 }
480
481 int ME_GetYScrollPos(ME_TextEditor *editor)
482 {
483   return editor->nScrollPosY;
484 }
485
486 void ME_EnsureVisible(ME_TextEditor *editor, ME_DisplayItem *pRun)
487 {
488   ME_DisplayItem *pRow = ME_FindItemBack(pRun, diStartRow);
489   ME_DisplayItem *pPara = ME_FindItemBack(pRun, diParagraph);
490   int y, yrel, yheight, yold;
491   HWND hWnd = editor->hWnd;
492   
493   assert(pRow);
494   assert(pPara);
495   
496   y = pPara->member.para.nYPos+pRow->member.row.nYPos;
497   yheight = pRow->member.row.nHeight;
498   yold = ME_GetYScrollPos(editor);
499   yrel = y - yold;
500   if (yrel < 0) {
501     editor->nScrollPosY = y;
502     SetScrollPos(hWnd, SB_VERT, y, TRUE);
503     if (editor->bRedraw)
504     {
505       ScrollWindow(hWnd, 0, -yrel, NULL, NULL);
506       UpdateWindow(hWnd);
507     }
508   } else if (yrel + yheight > editor->sizeWindow.cy) {
509     int newy = y+yheight-editor->sizeWindow.cy;
510     editor->nScrollPosY = newy;
511     SetScrollPos(hWnd, SB_VERT, newy, TRUE);
512     if (editor->bRedraw)
513     {
514       ScrollWindow(hWnd, 0, -(newy-yold), NULL, NULL);
515       UpdateWindow(hWnd);
516     }
517   }
518 }
519         
520
521 BOOL
522 ME_SetZoom(ME_TextEditor *editor, int numerator, int denominator)
523 {
524   /* TODO: Zoom images and objects */
525
526   if (numerator != 0)
527   {
528     if (denominator == 0)
529       return FALSE;
530     if (1.0 / 64.0 > (float)numerator / (float)denominator
531         || (float)numerator / (float)denominator > 64.0)
532       return FALSE;
533   }
534   
535   editor->nZoomNumerator = numerator;
536   editor->nZoomDenominator = denominator;
537   
538   ME_RewrapRepaint(editor);
539   return TRUE;
540 }