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   diRun, /* run (sequence of chars with the same character format) */
  71   diStartRow, /* start of the row (line of text on the screen) */
  72   diTextEnd, /* end of the text buffer */
  73
  74   /********************* these below are meant for finding only *********************/
  75   diStartRowOrParagraph, /* 5 */
  76   diStartRowOrParagraphOrEnd,
  77   diRunOrParagraph,
  78   diRunOrStartRow,
  79   diParagraphOrEnd,
  80   diRunOrParagraphOrEnd, /* 10 */
  81
  82   diUndoInsertRun, /* 11 */
  83   diUndoDeleteRun, /* 12 */
  84   diUndoJoinParagraphs, /* 13 */
  85   diUndoSplitParagraph, /* 14 */
  86   diUndoSetParagraphFormat, /* 15 */
  87   diUndoSetCharFormat, /* 16 */
  88   diUndoEndTransaction, /* 17 - marks the end of a group of changes for undo */
  89   diUndoSetDefaultCharFormat, /* 18 */
  90   diUndoPotentialEndTransaction, /* 19 - allows grouping typed chars for undo */
  91 } ME_DIType;
  92
  93 #define SELECTIONBAR_WIDTH 9
  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_CELL       0x004
 103
 104 #define MERF_NONTEXT (MERF_GRAPHICS | MERF_TAB | MERF_CELL)
 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
 125 /* runs with any of these flags set cannot be joined */
 126 #define MERF_NOJOIN (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 127 /* runs that don't contain real text */
 128 #define MERF_NOTEXT (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 129
 130 /* those flags are kept when the row is split */
 131 #define MERF_SPLITMASK (~(0))
 132
 133 /******************************** para flags *************************/
 134
 135 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
 136 #define MEPF_REWRAP 1
 137 #define MEPF_REPAINT 2
 138
 139 /******************************** structures *************************/
 140
 141 struct tagME_DisplayItem;
 142
 143 typedef struct tagME_Run
 144 {
 145   ME_String *strText;
 146   ME_Style *style;
 147   int nCharOfs; /* relative to para's offset */
 148   int nWidth; /* width of full run, width of leading&trailing ws */
 149   int nFlags;
 150   int nAscent, nDescent; /* pixels above/below baseline */
 151   POINT pt; /* relative to para's position */
 152   struct tagME_TableCell *pCell; /* for MERF_CELL: points to respective cell in ME_Paragraph */
 153   REOBJECT *ole_obj; /* FIXME: should be a union with strText (at least) */
 154   int nCR; int nLF;  /* for MERF_ENDPARA: number of \r and \n characters encoded by run */
 155 } ME_Run;
 156
 157 typedef struct tagME_Document {
 158   struct tagME_DisplayItem *def_char_style;
 159   struct tagME_DisplayItem *def_para_style;
 160   int last_wrapped_line;
 161 } ME_Document;
 162
 163 typedef struct tagME_TableCell
 164 {
 165   int nRightBoundary;
 166   struct tagME_TableCell *next;
 167 } ME_TableCell;
 168
 169 typedef struct tagME_Paragraph
 170 {
 171   PARAFORMAT2 *pFmt;
 172
 173   struct tagME_TableCell *pCells;    /* list of cells and their properties */
 174   struct tagME_TableCell *pLastCell; /* points to the last cell in the list */
 175
 176   int nCharOfs;
 177   int nFlags;
 178   int nYPos, nHeight;
 179   int nLastPaintYPos, nLastPaintHeight;
 180   int nRows;
 181   struct tagME_DisplayItem *prev_para, *next_para, *document;
 182 } ME_Paragraph;
 183
 184 typedef struct tagME_Row
 185 {
 186   int nHeight;
 187   int nBaseline;
 188   int nWidth;
 189   int nLMargin;
 190   int nRMargin;
 191   int nYPos;
 192 } ME_Row;
 193
 194 /* the display item list layout is like this:
 195  * - the document consists of paragraphs
 196  * - each paragraph contains at least one run, the last run in the paragraph
 197  *   is an end-of-paragraph run
 198  * - each formatted paragraph contains at least one row, which corresponds
 199  *   to a screen line (that's why there are no rows in an unformatted
 200  *   paragraph
 201  * - the paragraphs contain "shortcut" pointers to the previous and the next
 202  *   paragraph, that makes iteration over paragraphs faster
 203  * - the list starts with diTextStart and ends with diTextEnd
 204  */
 205
 206 typedef struct tagME_DisplayItem
 207 {
 208   ME_DIType type;
 209   struct tagME_DisplayItem *prev, *next;
 210   union {
 211     ME_Run run;
 212     ME_Row row;
 213     ME_Paragraph para;
 214     ME_Document doc; /* not used */
 215     ME_Style *ustyle; /* used by diUndoSetCharFormat */
 216   } member;
 217 } ME_DisplayItem;
 218
 219 typedef struct tagME_UndoItem
 220 {
 221   ME_DisplayItem di;
 222   int nStart, nLen;
 223   int nCR, nLF;      /* used by diUndoSplitParagraph */
 224 } ME_UndoItem;
 225
 226 typedef struct tagME_TextBuffer
 227 {
 228   ME_DisplayItem *pFirst, *pLast;
 229   ME_Style *pCharStyle;
 230   ME_Style *pDefaultStyle;
 231 } ME_TextBuffer;
 232
 233 typedef struct tagME_Cursor
 234 {
 235   ME_DisplayItem *pRun;
 236   int nOffset;
 237 } ME_Cursor;
 238
 239 typedef enum {
 240   umAddToUndo,
 241   umAddToRedo,
 242   umIgnore,
 243   umAddBackToUndo
 244 } ME_UndoMode;
 245
 246 typedef enum {
 247   stPosition = 0,
 248   stWord,
 249   stLine,
 250   stParagraph,
 251   stDocument
 252 } ME_SelectionType;
 253
 254 typedef struct tagME_FontTableItem {
 255   BYTE bCharSet;
 256   WCHAR *szFaceName;
 257 } ME_FontTableItem;
 258
 259
 260 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
 261
 262 struct tagME_InStream {
 263   EDITSTREAM *editstream;
 264   DWORD dwSize;
 265   DWORD dwUsed;
 266   char buffer[STREAMIN_BUFFER_SIZE];
 267 };
 268 typedef struct tagME_InStream ME_InStream;
 269
 270
 271 #define STREAMOUT_BUFFER_SIZE 4096
 272 #define STREAMOUT_FONTTBL_SIZE 8192
 273 #define STREAMOUT_COLORTBL_SIZE 1024
 274
 275 typedef struct tagME_OutStream {
 276   EDITSTREAM *stream;
 277   char buffer[STREAMOUT_BUFFER_SIZE];
 278   UINT pos, written;
 279   UINT nCodePage;
 280   UINT nFontTblLen;
 281   ME_FontTableItem fonttbl[STREAMOUT_FONTTBL_SIZE];
 282   UINT nColorTblLen;
 283   COLORREF colortbl[STREAMOUT_COLORTBL_SIZE];
 284   UINT nDefaultFont;
 285   UINT nDefaultCodePage;
 286 } ME_OutStream;
 287
 288 typedef struct tagME_FontCacheItem
 289 {
 290   LOGFONTW lfSpecs;
 291   HFONT hFont;
 292   int nRefs;
 293   int nAge;
 294 } ME_FontCacheItem;
 295
 296 #define HFONT_CACHE_SIZE 10
 297
 298 typedef struct tagME_TextEditor
 299 {
 300   HWND hWnd;
 301   BOOL bEmulateVersion10;
 302   ME_TextBuffer *pBuffer;
 303   ME_Cursor *pCursors;
 304   int nCursors;
 305   SIZE sizeWindow;
 306   int nTotalLength, nLastTotalLength;
 307   int nHeight;
 308   int nUDArrowX;
 309   int nSequence;
 310   COLORREF rgbBackColor;
 311   HBRUSH hbrBackground;
 312   BOOL bCaretAtEnd;
 313   int nEventMask;
 314   int nModifyStep;
 315   ME_DisplayItem *pUndoStack, *pRedoStack, *pUndoStackBottom;
 316   int nUndoStackSize;
 317   int nUndoLimit;
 318   ME_UndoMode nUndoMode;
 319   int nParagraphs;
 320   int nLastSelStart, nLastSelEnd;
 321   ME_DisplayItem *pLastSelStartPara, *pLastSelEndPara;
 322   ME_FontCacheItem pFontCache[HFONT_CACHE_SIZE];
 323   int nZoomNumerator, nZoomDenominator;
 324   RECT rcFormat;
 325   BOOL bRedraw;
 326   BOOL bWordWrap;
 327   int nInvalidOfs;
 328   int nTextLimit;
 329   EDITWORDBREAKPROCW pfnWordBreak;
 330   LPRICHEDITOLECALLBACK lpOleCallback;
 331   /*TEXTMODE variable; contains only one of each of the following options:
 332    *TM_RICHTEXT or TM_PLAINTEXT
 333    *TM_SINGLELEVELUNDO or TM_MULTILEVELUNDO
 334    *TM_SINGLECODEPAGE or TM_MULTICODEPAGE*/
 335   int mode;
 336   BOOL bHideSelection;
 337   BOOL AutoURLDetect_bEnable;
 338   WCHAR cPasswordMask;
 339   BOOL bHaveFocus;
 340   /*for IME */
 341   int imeStartIndex;
 342   DWORD selofs; /* The size of the selection bar on the left side of control */
 343   ME_SelectionType nSelectionType;
 344
 345   /* Track previous notified selection */
 346   CHARRANGE notified_cr;
 347 } ME_TextEditor;
 348
 349 typedef struct tagME_Context
 350 {
 351   HDC hDC;
 352   POINT pt;
 353   POINT ptRowOffset;
 354   RECT rcView;
 355   HBRUSH hbrMargin;
 356   SIZE dpi;
 357
 358   /* those are valid inside ME_WrapTextParagraph and related */
 359   POINT ptFirstRun;
 360   ME_TextEditor *editor;
 361   int nSequence;
 362 } ME_Context;
 363
 364 typedef struct tagME_WrapContext
 365 {
 366   ME_Style *style;
 367   ME_Context *context;
 368   int nLeftMargin, nRightMargin, nFirstMargin;
 369   int nAvailWidth;
 370   int nRow;
 371   POINT pt;
 372   BOOL bOverflown;
 373   ME_DisplayItem *pRowStart;
 374
 375   ME_DisplayItem *pLastSplittableRun;
 376   POINT ptLastSplittableRun;
 377 } ME_WrapContext;
 378
 379 #endif