git.oblomov.eu Git - wine/blob - dlls/riched20/wrap.c

   1 /*
   2  * RichEdit - Paragraph wrapping. Don't try to understand it. You've been
   3  * warned !
   4  *
   5  * Copyright 2004 by Krzysztof Foltman
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22
  23 #include "editor.h"
  24
  25 WINE_DEFAULT_DEBUG_CHANNEL(richedit);
  26
  27 /*
  28  * Unsolved problems:
  29  *
  30  * - center and right align in WordPad omits all spaces at the start, we don't
  31  * - objects/images are not handled yet
  32  * - no tabs
  33  */
  34
  35 static ME_DisplayItem *ME_MakeRow(int height, int baseline, int width)
  36 {
  37   ME_DisplayItem *item = ME_MakeDI(diStartRow);
  38
  39   item->member.row.nHeight = height;
  40   item->member.row.nBaseline = baseline;
  41   item->member.row.nWidth = width;
  42   return item;
  43 }
  44
  45 static void ME_BeginRow(ME_WrapContext *wc)
  46 {
  47   wc->pRowStart = NULL;
  48   wc->bOverflown = FALSE;
  49   wc->pLastSplittableRun = NULL;
  50   if (wc->context->editor->bWordWrap)
  51     wc->nAvailWidth = wc->context->rcView.right - wc->context->rcView.left -
  52         (wc->nRow ? wc->nLeftMargin : wc->nFirstMargin) - wc->nRightMargin;
  53   else
  54     wc->nAvailWidth = ~0u >> 1;
  55   wc->pt.x = 0;
  56 }
  57
  58 static void ME_InsertRowStart(ME_WrapContext *wc, const ME_DisplayItem *pEnd)
  59 {
  60   ME_DisplayItem *p, *row, *para;
  61   BOOL bSkippingSpaces = TRUE;
  62   int ascent = 0, descent = 0, width=0, shift = 0, align = 0;
  63   /* wrap text */
  64   para = ME_GetParagraph(wc->pRowStart);
  65
  66   for (p = pEnd->prev; p!=wc->pRowStart->prev; p = p->prev)
  67   {
  68       /* ENDPARA run shouldn't affect row height, except if it's the only run in the paragraph */
  69       if (p->type==diRun && ((p==wc->pRowStart) || !(p->member.run.nFlags & MERF_ENDPARA))) { /* FIXME add more run types */
  70         if (p->member.run.nAscent>ascent)
  71           ascent = p->member.run.nAscent;
  72         if (p->member.run.nDescent>descent)
  73           descent = p->member.run.nDescent;
  74         if (bSkippingSpaces)
  75         {
  76           /* Exclude space characters from run width.
  77            * Other whitespace or delimiters are not treated this way. */
  78           SIZE sz;
  79           int len = p->member.run.strText->nLen;
  80           WCHAR *text = p->member.run.strText->szData + len - 1;
  81
  82           assert (len);
  83           while (len && *(text--) == ' ')
  84               len--;
  85           if (len)
  86           {
  87               if (len == p->member.run.strText->nLen)
  88               {
  89                   width += p->member.run.nWidth;
  90               } else {
  91                   sz = ME_GetRunSize(wc->context, &para->member.para,
  92                                      &p->member.run, len, p->member.run.pt.x);
  93                   width += sz.cx;
  94               }
  95           }
  96           bSkippingSpaces = !len;
  97         } else if (!(p->member.run.nFlags & MERF_ENDPARA))
  98           width += p->member.run.nWidth;
  99       }
 100   }
 101
 102   row = ME_MakeRow(ascent+descent, ascent, width);
 103   row->member.row.nYPos = wc->pt.y;
 104   row->member.row.nLMargin = (!wc->nRow ? wc->nFirstMargin : wc->nLeftMargin);
 105   row->member.row.nRMargin = wc->nRightMargin;
 106   assert(para->member.para.pFmt->dwMask & PFM_ALIGNMENT);
 107   align = para->member.para.pFmt->wAlignment;
 108   if (align == PFA_CENTER)
 109     shift = (wc->nAvailWidth-width)/2;
 110   if (align == PFA_RIGHT)
 111     shift = wc->nAvailWidth-width;
 112   for (p = wc->pRowStart; p!=pEnd; p = p->next)
 113   {
 114     if (p->type==diRun) { /* FIXME add more run types */
 115       p->member.run.pt.x += row->member.row.nLMargin+shift;
 116     }
 117   }
 118   ME_InsertBefore(wc->pRowStart, row);
 119   wc->nRow++;
 120   wc->pt.y += ascent+descent;
 121   ME_BeginRow(wc);
 122 }
 123
 124 static void ME_WrapEndParagraph(ME_WrapContext *wc, ME_DisplayItem *p)
 125 {
 126   if (wc->pRowStart)
 127     ME_InsertRowStart(wc, p);
 128
 129   /*
 130   p = p->member.para.prev_para->next;
 131   while(p) {
 132     if (p->type == diParagraph || p->type == diTextEnd)
 133       return;
 134     if (p->type == diRun)
 135     {
 136       ME_Run *run = &p->member.run;
 137       TRACE("%s - (%d, %d)\n", debugstr_w(run->strText->szData), run->pt.x, run->pt.y);
 138     }
 139     p = p->next;
 140   }
 141   */
 142 }
 143
 144 static void ME_WrapSizeRun(ME_WrapContext *wc, ME_DisplayItem *p)
 145 {
 146   /* FIXME compose style (out of character and paragraph styles) here */
 147
 148   ME_UpdateRunFlags(wc->context->editor, &p->member.run);
 149
 150   ME_CalcRunExtent(wc->context, &ME_GetParagraph(p)->member.para,
 151                    wc->nRow ? wc->nLeftMargin : wc->nFirstMargin, &p->member.run);
 152 }
 153
 154 static ME_DisplayItem *ME_MaximizeSplit(ME_WrapContext *wc, ME_DisplayItem *p, int i)
 155 {
 156   ME_DisplayItem *pp, *piter = p;
 157   int j;
 158   if (!i)
 159     return NULL;
 160   j = ME_ReverseFindNonWhitespaceV(p->member.run.strText, i);
 161   if (j>0) {
 162     pp = ME_SplitRun(wc, piter, j);
 163     wc->pt.x += piter->member.run.nWidth;
 164     return pp;
 165   }
 166   else
 167   {
 168     pp = piter;
 169     /* omit all spaces before split point */
 170     while(piter != wc->pRowStart)
 171     {
 172       piter = ME_FindItemBack(piter, diRun);
 173       if (piter->member.run.nFlags & MERF_WHITESPACE)
 174       {
 175         pp = piter;
 176         continue;
 177       }
 178       if (piter->member.run.nFlags & MERF_ENDWHITE)
 179       {
 180         j = ME_ReverseFindNonWhitespaceV(piter->member.run.strText, i);
 181         pp = ME_SplitRun(wc, piter, i);
 182         wc->pt = pp->member.run.pt;
 183         return pp;
 184       }
 185       /* this run is the end of spaces, so the run edge is a good point to split */
 186       wc->pt = pp->member.run.pt;
 187       wc->bOverflown = TRUE;
 188       TRACE("Split point is: %s|%s\n", debugstr_w(piter->member.run.strText->szData), debugstr_w(pp->member.run.strText->szData));
 189       return pp;
 190     }
 191     wc->pt = piter->member.run.pt;
 192     return piter;
 193   }
 194 }
 195
 196 static ME_DisplayItem *ME_SplitByBacktracking(ME_WrapContext *wc, ME_DisplayItem *p, int loc)
 197 {
 198   ME_DisplayItem *piter = p, *pp;
 199   int i, idesp, len;
 200   ME_Run *run = &p->member.run;
 201
 202   idesp = i = ME_CharFromPoint(wc->context, loc, run);
 203   len = ME_StrVLen(run->strText);
 204   assert(len>0);
 205   assert(i<len);
 206   if (i) {
 207     /* don't split words */
 208     i = ME_ReverseFindWhitespaceV(run->strText, i);
 209     pp = ME_MaximizeSplit(wc, p, i);
 210     if (pp)
 211       return pp;
 212   }
 213   TRACE("Must backtrack to split at: %s\n", debugstr_w(p->member.run.strText->szData));
 214   if (wc->pLastSplittableRun)
 215   {
 216     if (wc->pLastSplittableRun->member.run.nFlags & (MERF_GRAPHICS|MERF_TAB))
 217     {
 218       wc->pt = wc->ptLastSplittableRun;
 219       return wc->pLastSplittableRun;
 220     }
 221     else if (wc->pLastSplittableRun->member.run.nFlags & MERF_SPLITTABLE)
 222     {
 223       /* the following two lines are just to check if we forgot to call UpdateRunFlags earlier,
 224          they serve no other purpose */
 225       ME_UpdateRunFlags(wc->context->editor, run);
 226       assert((wc->pLastSplittableRun->member.run.nFlags & MERF_SPLITTABLE));
 227
 228       piter = wc->pLastSplittableRun;
 229       run = &piter->member.run;
 230       len = ME_StrVLen(run->strText);
 231       /* don't split words */
 232       i = ME_ReverseFindWhitespaceV(run->strText, len);
 233       if (i == len)
 234         i = ME_ReverseFindNonWhitespaceV(run->strText, len);
 235       if (i) {
 236         ME_DisplayItem *piter2 = ME_SplitRun(wc, piter, i);
 237         wc->pt = piter2->member.run.pt;
 238         return piter2;
 239       }
 240       /* splittable = must have whitespaces */
 241       assert(0 == "Splittable, but no whitespaces");
 242     }
 243     else
 244     {
 245       /* restart from the first run beginning with spaces */
 246       wc->pt = wc->ptLastSplittableRun;
 247       return wc->pLastSplittableRun;
 248     }
 249   }
 250   TRACE("Backtracking failed, trying desperate: %s\n", debugstr_w(p->member.run.strText->szData));
 251   /* OK, no better idea, so assume we MAY split words if we can split at all*/
 252   if (idesp)
 253     return ME_SplitRun(wc, piter, idesp);
 254   else
 255   if (wc->pRowStart && piter != wc->pRowStart)
 256   {
 257     /* don't need to break current run, because it's possible to split
 258        before this run */
 259     wc->bOverflown = TRUE;
 260     return piter;
 261   }
 262   else
 263   {
 264     /* split point inside first character - no choice but split after that char */
 265     int chars = 1;
 266     int pos2 = ME_StrRelPos(run->strText, 0, &chars);
 267     if (pos2 != len) {
 268       /* the run is more than 1 char, so we may split */
 269       return ME_SplitRun(wc, piter, pos2);
 270     }
 271     /* the run is one char, can't split it */
 272     return piter;
 273   }
 274 }
 275
 276 static ME_DisplayItem *ME_WrapHandleRun(ME_WrapContext *wc, ME_DisplayItem *p)
 277 {
 278   ME_DisplayItem *pp;
 279   ME_Run *run;
 280   int len;
 281
 282   assert(p->type == diRun);
 283   if (!wc->pRowStart)
 284     wc->pRowStart = p;
 285   run = &p->member.run;
 286   run->pt.x = wc->pt.x;
 287   run->pt.y = wc->pt.y;
 288   ME_WrapSizeRun(wc, p);
 289   len = ME_StrVLen(run->strText);
 290
 291   if (wc->bOverflown) /* just skipping final whitespaces */
 292   {
 293     /* End paragraph run can't overflow to the next line by itself. */
 294     if (run->nFlags & MERF_ENDPARA)
 295       return p->next;
 296
 297     if (run->nFlags & MERF_WHITESPACE) {
 298       p->member.run.nFlags |= MERF_SKIPPED;
 299       wc->pt.x += run->nWidth;
 300       /* skip runs consisting of only whitespaces */
 301       return p->next;
 302     }
 303
 304     if (run->nFlags & MERF_STARTWHITE) {
 305       /* try to split the run at the first non-white char */
 306       int black;
 307       black = ME_FindNonWhitespaceV(run->strText, 0);
 308       if (black) {
 309         wc->bOverflown = FALSE;
 310         pp = ME_SplitRun(wc, p, black);
 311         p->member.run.nFlags |= MERF_SKIPPED;
 312         ME_InsertRowStart(wc, pp);
 313         return pp;
 314       }
 315     }
 316     /* black run: the row goes from pRowStart to the previous run */
 317     ME_InsertRowStart(wc, p);
 318     return p;
 319   }
 320   /* simply end the current row and move on to next one */
 321   if (run->nFlags & MERF_ENDROW)
 322   {
 323     p = p->next;
 324     ME_InsertRowStart(wc, p);
 325     return p;
 326   }
 327
 328   /* will current run fit? */
 329   if (wc->pt.x + run->nWidth > wc->nAvailWidth)
 330   {
 331     int loc = wc->nAvailWidth - wc->pt.x;
 332     /* total white run ? */
 333     if (run->nFlags & MERF_WHITESPACE) {
 334       /* let the overflow logic handle it */
 335       wc->bOverflown = TRUE;
 336       return p;
 337     }
 338     /* TAB: we can split before */
 339     if (run->nFlags & MERF_TAB) {
 340       wc->bOverflown = TRUE;
 341       return p;
 342     }
 343     /* graphics: we can split before, if run's width is smaller than row's width */
 344     if ((run->nFlags & MERF_GRAPHICS) && run->nWidth <= wc->nAvailWidth) {
 345       wc->bOverflown = TRUE;
 346       return p;
 347     }
 348     /* can we separate out the last spaces ? (to use overflow logic later) */
 349     if (run->nFlags & MERF_ENDWHITE)
 350     {
 351       /* we aren't sure if it's *really* necessary, it's a good start however */
 352       int black = ME_ReverseFindNonWhitespaceV(run->strText, len);
 353       ME_SplitRun(wc, p, black);
 354       /* handle both parts again */
 355       return p;
 356     }
 357     /* determine the split point by backtracking */
 358     pp = ME_SplitByBacktracking(wc, p, loc);
 359     if (pp == wc->pRowStart)
 360     {
 361       /* we have a row that starts with spaces, or a single large character
 362        * which we cannot split. */
 363       wc->pt.x += run->nWidth;
 364       return p->next;
 365     }
 366     if (p != pp) /* found a suitable split point */
 367     {
 368       wc->bOverflown = TRUE;
 369       return pp;
 370     }
 371     /* we detected that it's best to split on start of this run */
 372     if (wc->bOverflown)
 373       return pp;
 374     ERR("failure!\n");
 375     /* not found anything - writing over margins is the only option left */
 376   }
 377   if ((run->nFlags & (MERF_SPLITTABLE | MERF_STARTWHITE))
 378     || ((run->nFlags & (MERF_GRAPHICS|MERF_TAB)) && (p != wc->pRowStart)))
 379   {
 380     wc->pLastSplittableRun = p;
 381     wc->ptLastSplittableRun = wc->pt;
 382   }
 383   wc->pt.x += run->nWidth;
 384   return p->next;
 385 }
 386
 387 static void ME_PrepareParagraphForWrapping(ME_Context *c, ME_DisplayItem *tp);
 388
 389 static void ME_WrapTextParagraph(ME_Context *c, ME_DisplayItem *tp, DWORD beginofs) {
 390   ME_DisplayItem *p;
 391   ME_WrapContext wc;
 392   int border = 0;
 393   int linespace = 0;
 394
 395   assert(tp->type == diParagraph);
 396   if (!(tp->member.para.nFlags & MEPF_REWRAP)) {
 397     return;
 398   }
 399   ME_PrepareParagraphForWrapping(c, tp);
 400
 401   wc.context = c;
 402 /*   wc.para_style = tp->member.para.style; */
 403   wc.style = NULL;
 404   wc.nFirstMargin = ME_twips2pointsX(c, tp->member.para.pFmt->dxStartIndent) + beginofs;
 405   wc.nLeftMargin = wc.nFirstMargin + ME_twips2pointsX(c, tp->member.para.pFmt->dxOffset);
 406   wc.nRightMargin = ME_twips2pointsX(c, tp->member.para.pFmt->dxRightIndent);
 407   wc.nRow = 0;
 408   wc.pt.x = 0;
 409   wc.pt.y = 0;
 410   if (tp->member.para.pFmt->dwMask & PFM_SPACEBEFORE)
 411     wc.pt.y += ME_twips2pointsY(c, tp->member.para.pFmt->dySpaceBefore);
 412   if (tp->member.para.pFmt->dwMask & PFM_BORDER)
 413   {
 414     border = ME_GetParaBorderWidth(c->editor, tp->member.para.pFmt->wBorders);
 415     if (tp->member.para.pFmt->wBorders & 1) {
 416       wc.nFirstMargin += border;
 417       wc.nLeftMargin += border;
 418     }
 419     if (tp->member.para.pFmt->wBorders & 2)
 420       wc.nRightMargin -= border;
 421     if (tp->member.para.pFmt->wBorders & 4)
 422       wc.pt.y += border;
 423   }
 424
 425   linespace = ME_GetParaLineSpace(c, &tp->member.para);
 426
 427   ME_BeginRow(&wc);
 428   for (p = tp->next; p!=tp->member.para.next_para; ) {
 429     assert(p->type != diStartRow);
 430     if (p->type == diRun) {
 431       p = ME_WrapHandleRun(&wc, p);
 432     }
 433     else p = p->next;
 434     if (wc.nRow && p == wc.pRowStart)
 435       wc.pt.y += linespace;
 436   }
 437   ME_WrapEndParagraph(&wc, p);
 438   if ((tp->member.para.pFmt->dwMask & PFM_BORDER) && (tp->member.para.pFmt->wBorders & 8))
 439     wc.pt.y += border;
 440   if (tp->member.para.pFmt->dwMask & PFM_SPACEAFTER)
 441     wc.pt.y += ME_twips2pointsY(c, tp->member.para.pFmt->dySpaceAfter);
 442
 443   tp->member.para.nFlags &= ~MEPF_REWRAP;
 444   tp->member.para.nHeight = wc.pt.y;
 445   tp->member.para.nRows = wc.nRow;
 446 }
 447
 448
 449 static void ME_PrepareParagraphForWrapping(ME_Context *c, ME_DisplayItem *tp) {
 450   ME_DisplayItem *p, *pRow;
 451
 452   /* remove all items that will be reinserted by paragraph wrapper anyway */
 453   tp->member.para.nRows = 0;
 454   for (p = tp->next; p!=tp->member.para.next_para; p = p->next) {
 455     switch(p->type) {
 456       case diStartRow:
 457         pRow = p;
 458         p = p->prev;
 459         ME_Remove(pRow);
 460         ME_DestroyDisplayItem(pRow);
 461         break;
 462       default:
 463         break;
 464     }
 465   }
 466   /* join runs that can be joined, set up flags */
 467   for (p = tp->next; p!=tp->member.para.next_para; p = p->next) {
 468     int changed = 0;
 469     switch(p->type) {
 470       case diStartRow: assert(0); break; /* should have deleted it */
 471       case diRun:
 472         while (p->next->type == diRun) { /* FIXME */
 473           if (ME_CanJoinRuns(&p->member.run, &p->next->member.run)) {
 474             ME_JoinRuns(c->editor, p);
 475             changed = 1;
 476           }
 477           else
 478             break;
 479         }
 480         p->member.run.nFlags &= ~MERF_CALCBYWRAP;
 481         break;
 482       default:
 483         break;
 484     }
 485   }
 486 }
 487
 488 BOOL ME_WrapMarkedParagraphs(ME_TextEditor *editor) {
 489   ME_DisplayItem *item;
 490   ME_Context c;
 491   BOOL bModified = FALSE;
 492   int yStart = -1;
 493   int yLastPos = 0;
 494
 495   ME_InitContext(&c, editor, GetDC(editor->hWnd));
 496   editor->nHeight = 0;
 497   item = editor->pBuffer->pFirst->next;
 498   while(item != editor->pBuffer->pLast) {
 499     BOOL bRedraw = FALSE;
 500
 501     assert(item->type == diParagraph);
 502     editor->nHeight = max(editor->nHeight, item->member.para.nYPos);
 503     if ((item->member.para.nFlags & MEPF_REWRAP)
 504      || (item->member.para.nYPos != c.pt.y))
 505       bRedraw = TRUE;
 506     item->member.para.nYPos = c.pt.y;
 507
 508     ME_WrapTextParagraph(&c, item, editor->selofs);
 509
 510     if (bRedraw)
 511     {
 512       item->member.para.nFlags |= MEPF_REPAINT;
 513       if (yStart == -1)
 514         yStart = c.pt.y;
 515     }
 516
 517     bModified = bModified | bRedraw;
 518
 519     yLastPos = c.pt.y;
 520     c.pt.y += item->member.para.nHeight;
 521     item = item->member.para.next_para;
 522   }
 523   editor->sizeWindow.cx = c.rcView.right-c.rcView.left;
 524   editor->sizeWindow.cy = c.rcView.bottom-c.rcView.top;
 525
 526   editor->nTotalLength = c.pt.y;
 527   editor->pBuffer->pLast->member.para.nYPos = yLastPos;
 528
 529   ME_DestroyContext(&c, editor->hWnd);
 530
 531   /* Each paragraph may contain multiple rows, which should be scrollable, even
 532      if the containing paragraph has nYPos == 0 */
 533   item = editor->pBuffer->pFirst;
 534   while ((item = ME_FindItemFwd(item, diStartRow)) != NULL) {
 535     assert(item->type == diStartRow);
 536     editor->nHeight = max(editor->nHeight, item->member.row.nYPos);
 537   }
 538
 539   if (bModified || editor->nTotalLength < editor->nLastTotalLength)
 540     ME_InvalidateMarkedParagraphs(editor);
 541   return bModified;
 542 }
 543
 544 void ME_InvalidateMarkedParagraphs(ME_TextEditor *editor) {
 545   ME_Context c;
 546
 547   ME_InitContext(&c, editor, GetDC(editor->hWnd));
 548   if (editor->bRedraw)
 549   {
 550     RECT rc = c.rcView;
 551     int ofs = ME_GetYScrollPos(editor);
 552
 553     ME_DisplayItem *item = editor->pBuffer->pFirst;
 554     while(item != editor->pBuffer->pLast) {
 555       if (item->member.para.nFlags & MEPF_REPAINT) {
 556         rc.top = item->member.para.nYPos - ofs;
 557         rc.bottom = item->member.para.nYPos + item->member.para.nHeight - ofs;
 558         InvalidateRect(editor->hWnd, &rc, TRUE);
 559       }
 560       item = item->member.para.next_para;
 561     }
 562     if (editor->nTotalLength < editor->nLastTotalLength)
 563     {
 564       rc.top = editor->nTotalLength - ofs;
 565       rc.bottom = editor->nLastTotalLength - ofs;
 566       InvalidateRect(editor->hWnd, &rc, TRUE);
 567     }
 568   }
 569   ME_DestroyContext(&c, editor->hWnd);
 570 }
 571
 572
 573 void
 574 ME_SendRequestResize(ME_TextEditor *editor, BOOL force)
 575 {
 576   if (editor->nEventMask & ENM_REQUESTRESIZE)
 577   {
 578     RECT rc;
 579
 580     GetClientRect(editor->hWnd, &rc);
 581
 582     if (force || rc.bottom != editor->nTotalLength)
 583     {
 584       REQRESIZE info;
 585
 586       info.nmhdr.hwndFrom = editor->hWnd;
 587       info.nmhdr.idFrom = GetWindowLongW(editor->hWnd, GWLP_ID);
 588       info.nmhdr.code = EN_REQUESTRESIZE;
 589       info.rc = rc;
 590       info.rc.bottom = editor->nTotalLength;
 591
 592       editor->nEventMask &= ~ENM_REQUESTRESIZE;
 593       SendMessageW(GetParent(editor->hWnd), WM_NOTIFY,
 594                    info.nmhdr.idFrom, (LPARAM)&info);
 595       editor->nEventMask |= ENM_REQUESTRESIZE;
 596     }
 597   }
 598 }