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