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