dlls/riched20/editstr.h

   1 /*
   2  * RichEdit - structures and constant
   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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #ifndef __EDITSTR_H
  22 #define __EDITSTR_H
  23
  24 #ifndef _WIN32_IE
  25 #define _WIN32_IE 0x0400
  26 #endif
  27
  28 #include <assert.h>
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32
  33 #define COBJMACROS
  34 #define NONAMELESSUNION
  35 #define NONAMELESSSTRUCT
  36
  37 #include <windef.h>
  38 #include <winbase.h>
  39 #include <winnls.h>
  40 #include <winnt.h>
  41 #include <wingdi.h>
  42 #include <winuser.h>
  43 #include <richedit.h>
  44 #include <commctrl.h>
  45 #include <ole2.h>
  46 #include <richole.h>
  47
  48 #include "wine/debug.h"
  49
  50 typedef struct tagME_String
  51 {
  52   WCHAR *szData;
  53   int nLen, nBuffer;
  54 } ME_String;
  55
  56 typedef struct tagME_Style
  57 {
  58   CHARFORMAT2W fmt;
  59
  60   HFONT hFont; /* cached font for the style */
  61   TEXTMETRICW tm; /* cached font metrics for the style */
  62   int nRefs; /* reference count */
  63   int nSequence; /* incremented when cache needs to be rebuilt, ie. every screen redraw */
  64 } ME_Style;
  65
  66 typedef enum {
  67   diInvalid,
  68   diTextStart, /* start of the text buffer */
  69   diParagraph, /* paragraph start */
  70   diCell, /* cell start */
  71   diRun, /* run (sequence of chars with the same character format) */
  72   diStartRow, /* start of the row (line of text on the screen) */
  73   diTextEnd, /* end of the text buffer */
  74
  75   /********************* these below are meant for finding only *********************/
  76   diStartRowOrParagraph, /* 7 */
  77   diStartRowOrParagraphOrEnd,
  78   diRunOrParagraph,
  79   diRunOrStartRow,
  80   diParagraphOrEnd,
  81   diRunOrParagraphOrEnd, /* 12 */
  82
  83   diUndoInsertRun, /* 13 */
  84   diUndoDeleteRun, /* 14 */
  85   diUndoJoinParagraphs, /* 15 */
  86   diUndoSplitParagraph, /* 16 */
  87   diUndoSetParagraphFormat, /* 17 */
  88   diUndoSetCharFormat, /* 18 */
  89   diUndoEndTransaction, /* 19 - marks the end of a group of changes for undo */
  90   diUndoPotentialEndTransaction, /* 20 - allows grouping typed chars for undo */
  91 } ME_DIType;
  92
  93 #define SELECTIONBAR_WIDTH 8
  94
  95 /******************************** run flags *************************/
  96 #define MERF_STYLEFLAGS 0x0FFF
  97 /* run contains non-text content, which has its own rules for wrapping, sizing etc */
  98 #define MERF_GRAPHICS   0x001
  99 /* run is a tab (or, in future, any kind of content whose size is dependent on run position) */
 100 #define MERF_TAB        0x002
 101 /* run is a cell boundary */
 102 #define MERF_ENDCELL    0x004 /* v4.1 */
 103
 104 #define MERF_NONTEXT (MERF_GRAPHICS | MERF_TAB | MERF_ENDCELL)
 105
 106 /* run is splittable (contains white spaces in the middle or end) */
 107 #define MERF_SPLITTABLE 0x001000
 108 /* run starts with whitespaces */
 109 #define MERF_STARTWHITE 0x002000
 110 /* run ends with whitespaces */
 111 #define MERF_ENDWHITE   0x004000
 112 /* run is completely made of whitespaces */
 113 #define MERF_WHITESPACE 0x008000
 114 /* run is a last (dummy) run in the paragraph */
 115 #define MERF_SKIPPED    0x010000
 116 /* flags that are calculated during text wrapping */
 117 #define MERF_CALCBYWRAP 0x0F0000
 118 /* the "end of paragraph" run, contains 1 character */
 119 #define MERF_ENDPARA    0x100000
 120 /* forcing the "end of row" run, contains 1 character */
 121 #define MERF_ENDROW     0x200000
 122 /* run is hidden */
 123 #define MERF_HIDDEN     0x400000
 124 /* start of a table row has an empty paragraph that should be skipped over. */
 125 #define MERF_TABLESTART 0x800000 /* v4.1 */
 126
 127 /* runs with any of these flags set cannot be joined */
 128 #define MERF_NOJOIN (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 129 /* runs that don't contain real text */
 130 #define MERF_NOTEXT (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 131
 132 /* those flags are kept when the row is split */
 133 #define MERF_SPLITMASK (~(0))
 134
 135 /******************************** para flags *************************/
 136
 137 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
 138 #define MEPF_REWRAP   0x01
 139 #define MEPF_REPAINT  0x02
 140 /* v4.1 */
 141 #define MEPF_CELL     0x04 /* The paragraph is nested in a cell */
 142 #define MEPF_ROWSTART 0x08 /* Hidden empty paragraph at the start of the row */
 143 #define MEPF_ROWEND   0x10 /* Visible empty paragraph at the end of the row */
 144
 145 /******************************** structures *************************/
 146
 147 struct tagME_DisplayItem;
 148
 149 typedef struct tagME_Run
 150 {
 151   ME_String *strText;
 152   ME_Style *style;
 153   int nCharOfs; /* relative to para's offset */
 154   int nWidth; /* width of full run, width of leading&trailing ws */
 155   int nFlags;
 156   int nAscent, nDescent; /* pixels above/below baseline */
 157   POINT pt; /* relative to para's position */
 158   REOBJECT *ole_obj; /* FIXME: should be a union with strText (at least) */
 159   int nCR; int nLF;  /* for MERF_ENDPARA: number of \r and \n characters encoded by run */
 160 } ME_Run;
 161
 162 typedef struct tagME_Document {
 163   struct tagME_DisplayItem *def_char_style;
 164   struct tagME_DisplayItem *def_para_style;
 165   int last_wrapped_line;
 166 } ME_Document;
 167
 168 typedef struct tagME_Border
 169 {
 170   int width;
 171   COLORREF colorRef;
 172 } ME_Border;
 173
 174 typedef struct tagME_BorderRect
 175 {
 176   ME_Border top;
 177   ME_Border left;
 178   ME_Border bottom;
 179   ME_Border right;
 180 } ME_BorderRect;
 181
 182 typedef struct tagME_Paragraph
 183 {
 184   PARAFORMAT2 *pFmt;
 185
 186   struct tagME_DisplayItem *pCell; /* v4.1 */
 187   ME_BorderRect border;
 188
 189   int nCharOfs;
 190   int nFlags;
 191   POINT pt;
 192   int nHeight;
 193   int nLastPaintYPos, nLastPaintHeight;
 194   int nRows;
 195   struct tagME_DisplayItem *prev_para, *next_para, *document;
 196 } ME_Paragraph;
 197
 198 typedef struct tagME_Cell /* v4.1 */
 199 {
 200   int nNestingLevel; /* 0 for normal cells, and greater for nested cells */
 201   int nRightBoundary;
 202   ME_BorderRect border;
 203   POINT pt;
 204   int nHeight, nWidth;
 205   int yTextOffset; /* The text offset is caused by the largest top border. */
 206   struct tagME_DisplayItem *prev_cell, *next_cell, *parent_cell;
 207 } ME_Cell;
 208
 209 typedef struct tagME_Row
 210 {
 211   int nHeight;
 212   int nBaseline;
 213   int nWidth;
 214   int nLMargin;
 215   int nRMargin;
 216   POINT pt;
 217 } ME_Row;
 218
 219 /* the display item list layout is like this:
 220  * - the document consists of paragraphs
 221  * - each paragraph contains at least one run, the last run in the paragraph
 222  *   is an end-of-paragraph run
 223  * - each formatted paragraph contains at least one row, which corresponds
 224  *   to a screen line (that's why there are no rows in an unformatted
 225  *   paragraph
 226  * - the paragraphs contain "shortcut" pointers to the previous and the next
 227  *   paragraph, that makes iteration over paragraphs faster
 228  * - the list starts with diTextStart and ends with diTextEnd
 229  */
 230
 231 typedef struct tagME_DisplayItem
 232 {
 233   ME_DIType type;
 234   struct tagME_DisplayItem *prev, *next;
 235   union {
 236     ME_Run run;
 237     ME_Row row;
 238     ME_Cell cell;
 239     ME_Paragraph para;
 240     ME_Document doc; /* not used */
 241     ME_Style *ustyle; /* used by diUndoSetCharFormat */
 242   } member;
 243 } ME_DisplayItem;
 244
 245 typedef struct tagME_UndoItem
 246 {
 247   ME_DisplayItem di;
 248   int nStart, nLen;
 249   int nCR, nLF;      /* used by diUndoSplitParagraph */
 250 } ME_UndoItem;
 251
 252 typedef struct tagME_TextBuffer
 253 {
 254   ME_DisplayItem *pFirst, *pLast;
 255   ME_Style *pCharStyle;
 256   ME_Style *pDefaultStyle;
 257 } ME_TextBuffer;
 258
 259 typedef struct tagME_Cursor
 260 {
 261   ME_DisplayItem *pRun;
 262   int nOffset;
 263 } ME_Cursor;
 264
 265 typedef enum {
 266   umAddToUndo,
 267   umAddToRedo,
 268   umIgnore,
 269   umAddBackToUndo
 270 } ME_UndoMode;
 271
 272 typedef enum {
 273   stPosition = 0,
 274   stWord,
 275   stLine,
 276   stParagraph,
 277   stDocument
 278 } ME_SelectionType;
 279
 280 typedef struct tagME_FontTableItem {
 281   BYTE bCharSet;
 282   WCHAR *szFaceName;
 283 } ME_FontTableItem;
 284
 285
 286 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
 287
 288 struct tagME_InStream {
 289   EDITSTREAM *editstream;
 290   DWORD dwSize;
 291   DWORD dwUsed;
 292   char buffer[STREAMIN_BUFFER_SIZE];
 293 };
 294 typedef struct tagME_InStream ME_InStream;
 295
 296
 297 #define STREAMOUT_BUFFER_SIZE 4096
 298 #define STREAMOUT_FONTTBL_SIZE 8192
 299 #define STREAMOUT_COLORTBL_SIZE 1024
 300
 301 typedef struct tagME_OutStream {
 302   EDITSTREAM *stream;
 303   char buffer[STREAMOUT_BUFFER_SIZE];
 304   UINT pos, written;
 305   UINT nCodePage;
 306   UINT nFontTblLen;
 307   ME_FontTableItem fonttbl[STREAMOUT_FONTTBL_SIZE];
 308   UINT nColorTblLen;
 309   COLORREF colortbl[STREAMOUT_COLORTBL_SIZE];
 310   UINT nDefaultFont;
 311   UINT nDefaultCodePage;
 312   /* nNestingLevel = 0 means we aren't in a cell, 1 means we are in a cell,
 313    * an greater numbers mean we are in a cell nested within a cell. */
 314   UINT nNestingLevel;
 315 } ME_OutStream;
 316
 317 typedef struct tagME_FontCacheItem
 318 {
 319   LOGFONTW lfSpecs;
 320   HFONT hFont;
 321   int nRefs;
 322   int nAge;
 323 } ME_FontCacheItem;
 324
 325 #define HFONT_CACHE_SIZE 10
 326
 327 typedef struct tagME_TextEditor
 328 {
 329   HWND hWnd;
 330   BOOL bEmulateVersion10;
 331   ME_TextBuffer *pBuffer;
 332   ME_Cursor *pCursors;
 333   int nCursors;
 334   SIZE sizeWindow;
 335   int nTotalLength, nLastTotalLength;
 336   int nUDArrowX;
 337   int nSequence;
 338   COLORREF rgbBackColor;
 339   HBRUSH hbrBackground;
 340   BOOL bCaretAtEnd;
 341   int nEventMask;
 342   int nModifyStep;
 343   ME_DisplayItem *pUndoStack, *pRedoStack, *pUndoStackBottom;
 344   int nUndoStackSize;
 345   int nUndoLimit;
 346   ME_UndoMode nUndoMode;
 347   int nParagraphs;
 348   int nLastSelStart, nLastSelEnd;
 349   ME_DisplayItem *pLastSelStartPara, *pLastSelEndPara;
 350   ME_FontCacheItem pFontCache[HFONT_CACHE_SIZE];
 351   int nZoomNumerator, nZoomDenominator;
 352   RECT prevClientRect;
 353   RECT rcFormat;
 354   BOOL bDefaultFormatRect;
 355   BOOL bWordWrap;
 356   int nInvalidOfs;
 357   int nTextLimit;
 358   EDITWORDBREAKPROCW pfnWordBreak;
 359   LPRICHEDITOLECALLBACK lpOleCallback;
 360   /*TEXTMODE variable; contains only one of each of the following options:
 361    *TM_RICHTEXT or TM_PLAINTEXT
 362    *TM_SINGLELEVELUNDO or TM_MULTILEVELUNDO
 363    *TM_SINGLECODEPAGE or TM_MULTICODEPAGE*/
 364   int mode;
 365   BOOL bHideSelection;
 366   BOOL AutoURLDetect_bEnable;
 367   WCHAR cPasswordMask;
 368   BOOL bHaveFocus;
 369   /*for IME */
 370   int imeStartIndex;
 371   DWORD selofs; /* The size of the selection bar on the left side of control */
 372   ME_SelectionType nSelectionType;
 373
 374   /* Track previous notified selection */
 375   CHARRANGE notified_cr;
 376
 377   /* Cache previously set vertical scrollbar info */
 378   SCROLLINFO vert_si;
 379 } ME_TextEditor;
 380
 381 typedef struct tagME_Context
 382 {
 383   HDC hDC;
 384   POINT pt;
 385   POINT ptRowOffset;
 386   RECT rcView;
 387   HBRUSH hbrMargin;
 388   SIZE dpi;
 389
 390   /* those are valid inside ME_WrapTextParagraph and related */
 391   POINT ptFirstRun;
 392   ME_TextEditor *editor;
 393   int nSequence;
 394 } ME_Context;
 395
 396 typedef struct tagME_WrapContext
 397 {
 398   ME_Style *style;
 399   ME_Context *context;
 400   int nLeftMargin, nRightMargin, nFirstMargin;
 401   int nAvailWidth;
 402   int nRow;
 403   POINT pt;
 404   BOOL bOverflown, bWordWrap;
 405   ME_DisplayItem *pRowStart;
 406
 407   ME_DisplayItem *pLastSplittableRun;
 408   POINT ptLastSplittableRun;
 409 } ME_WrapContext;
 410
 411 #endif