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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 #include <windef.h>
  34 #include <winbase.h>
  35 #include <winnls.h>
  36 #include <winnt.h>
  37 #include <wingdi.h>
  38 #include <winuser.h>
  39 #include <richedit.h>
  40 #include <commctrl.h>
  41
  42 #include "wine/debug.h"
  43
  44 typedef struct tagME_String
  45 {
  46   WCHAR *szData;
  47   int nLen, nBuffer;
  48 } ME_String;
  49
  50 typedef struct tagME_Style
  51 {
  52   CHARFORMAT2W fmt;
  53
  54   HFONT hFont; /* cached font for the style */
  55   TEXTMETRICW tm; /* cached font metrics for the style */
  56   int nRefs; /* reference count */
  57   int nSequence; /* incremented when cache needs to be rebuilt, ie. every screen redraw */
  58 } ME_Style;
  59
  60 typedef enum {
  61   diTextStart, /* start of the text buffer */
  62   diParagraph, /* paragraph start */
  63   diRun, /* run (sequence of chars with the same character format) */
  64   diStartRow, /* start of the row (line of text on the screen) */
  65   diTextEnd, /* end of the text buffer */
  66
  67   /********************* these below are meant for finding only *********************/
  68   diStartRowOrParagraph, /* 5 */
  69   diStartRowOrParagraphOrEnd,
  70   diRunOrParagraph,
  71   diRunOrStartRow,
  72   diParagraphOrEnd,
  73   diRunOrParagraphOrEnd, /* 10 */
  74
  75   diUndoInsertRun, /* 11 */
  76   diUndoDeleteRun, /* 12 */
  77   diUndoJoinParagraphs, /* 13 */
  78   diUndoSplitParagraph, /* 14 */
  79   diUndoSetParagraphFormat, /* 15 */
  80   diUndoSetCharFormat, /* 16 */
  81   diUndoEndTransaction, /* 17 */
  82   diUndoSetDefaultCharFormat, /* 18 */
  83 } ME_DIType;
  84
  85 /******************************** run flags *************************/
  86 #define MERF_STYLEFLAGS 0x0FFF
  87 /* run contains non-text content, which has its own rules for wrapping, sizing etc */
  88 #define MERF_GRAPHICS 1
  89 /* run is a tab (or, in future, any kind of content whose size is dependent on run position) */
  90 #define MERF_TAB 2
  91
  92 /* run is splittable (contains white spaces in the middle or end) */
  93 #define MERF_SPLITTABLE 0x001000
  94 /* run starts with whitespaces */
  95 #define MERF_STARTWHITE 0x002000
  96 /* run ends with whitespaces */
  97 #define MERF_ENDWHITE   0x004000
  98 /* run is completely made of whitespaces */
  99 #define MERF_WHITESPACE 0x008000
 100 /* run is a last (dummy) run in the paragraph */
 101 #define MERF_SKIPPED    0x010000
 102 /* flags that are calculated during text wrapping */
 103 #define MERF_CALCBYWRAP 0x0F0000
 104 /* the "end of paragraph" run, contains 1 character */
 105 #define MERF_ENDPARA    0x100000
 106
 107 /* runs with any of these flags set cannot be joined */
 108 #define MERF_NOJOIN (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA)
 109 /* runs that don't contain real text */
 110 #define MERF_NOTEXT (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA)
 111
 112 /* those flags are kept when the row is split */
 113 #define MERF_SPLITMASK (~(0))
 114
 115 /******************************** para flags *************************/
 116
 117 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
 118 #define MEPF_REWRAP 1
 119 #define MEPF_REPAINT 2
 120
 121 /******************************** structures *************************/
 122
 123 struct tagME_DisplayItem;
 124
 125 typedef struct tagME_Run
 126 {
 127   ME_String *strText;
 128   ME_Style *style;
 129   int nCharOfs; /* relative to para's offset */
 130   int nWidth; /* width of full run, width of leading&trailing ws */
 131   int nFlags;
 132   int nAscent, nDescent; /* pixels above/below baseline */
 133   POINT pt; /* relative to para's position */
 134 } ME_Run;
 135
 136 typedef struct tagME_Document {
 137   struct tagME_DisplayItem *def_char_style;
 138   struct tagME_DisplayItem *def_para_style;
 139   int last_wrapped_line;
 140 } ME_Document;
 141
 142 typedef struct tagME_Paragraph
 143 {
 144   PARAFORMAT2 *pFmt;
 145   int nLeftMargin, nRightMargin, nFirstMargin;
 146   int nCharOfs;
 147   int nFlags;
 148   int nYPos, nHeight;
 149   int nLastPaintYPos, nLastPaintHeight;
 150   struct tagME_DisplayItem *prev_para, *next_para, *document;
 151 } ME_Paragraph;
 152
 153 typedef struct tagME_Row
 154 {
 155   int nHeight;
 156   int nBaseline;
 157   int nWidth;
 158   int nLMargin;
 159   int nRMargin;
 160   int nYPos;
 161 } ME_Row;
 162
 163 typedef struct tagME_DisplayItem
 164 {
 165   ME_DIType type;
 166   struct tagME_DisplayItem *prev, *next;
 167   union {
 168     ME_Run run;
 169     ME_Row row;
 170     ME_Paragraph para;
 171     ME_Document doc; /* not used */
 172     ME_Style *ustyle; /* used by diUndoSetCharFormat */
 173   } member;
 174 } ME_DisplayItem;
 175
 176 typedef struct tagME_UndoItem
 177 {
 178   ME_DisplayItem di;
 179   int nStart, nLen;
 180 } ME_UndoItem;
 181
 182 typedef struct tagME_TextBuffer
 183 {
 184   ME_DisplayItem *pFirst, *pLast;
 185   ME_Style *pCharStyle;
 186   ME_Style *pDefaultStyle;
 187 } ME_TextBuffer;
 188
 189 typedef struct tagME_Cursor
 190 {
 191   ME_DisplayItem *pRun;
 192   int nOffset;
 193 } ME_Cursor;
 194
 195 typedef enum {
 196   umAddToUndo,
 197   umAddToRedo,
 198   umIgnore,
 199   umAddBackToUndo
 200 } ME_UndoMode;
 201
 202 typedef struct tagME_FontTableItem {
 203   BYTE bCharSet;
 204   WCHAR *szFaceName;
 205 } ME_FontTableItem;
 206
 207
 208 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
 209
 210 struct tagME_InStream {
 211   EDITSTREAM *editstream;
 212   DWORD dwSize;
 213   DWORD dwUsed;
 214   BYTE buffer[STREAMIN_BUFFER_SIZE];
 215 };
 216 typedef struct tagME_InStream ME_InStream;
 217
 218
 219 #define STREAMOUT_BUFFER_SIZE 4096
 220 #define STREAMOUT_FONTTBL_SIZE 8192
 221 #define STREAMOUT_COLORTBL_SIZE 1024
 222
 223 typedef struct tagME_OutStream {
 224   EDITSTREAM *stream;
 225   char buffer[STREAMOUT_BUFFER_SIZE];
 226   UINT pos, written;
 227   UINT nCodePage;
 228   UINT nFontTblLen;
 229   ME_FontTableItem fonttbl[STREAMOUT_FONTTBL_SIZE];
 230   UINT nColorTblLen;
 231   COLORREF colortbl[STREAMOUT_COLORTBL_SIZE];
 232   UINT nDefaultFont;
 233   UINT nDefaultCodePage;
 234 } ME_OutStream;
 235
 236 typedef struct tagME_FontCacheItem
 237 {
 238   LOGFONTW lfSpecs;
 239   HFONT hFont;
 240   int nRefs;
 241   int nAge;
 242 } ME_FontCacheItem;
 243
 244 #define HFONT_CACHE_SIZE 10
 245
 246 typedef struct tagME_TextEditor
 247 {
 248   HWND hWnd;
 249   BOOL bCaretShown;
 250   ME_TextBuffer *pBuffer;
 251   ME_Cursor *pCursors;
 252   int nCursors;
 253   SIZE sizeWindow;
 254   int nTotalLength, nLastTotalLength;
 255   int nUDArrowX;
 256   int nSequence;
 257   int nOldSelFrom, nOldSelTo;
 258   COLORREF rgbBackColor;
 259   BOOL bCaretAtEnd;
 260   int nEventMask;
 261   int nModifyStep;
 262   ME_DisplayItem *pUndoStack, *pRedoStack;
 263   ME_UndoMode nUndoMode;
 264   int nParagraphs;
 265   int nLastSelStart, nLastSelEnd;
 266   ME_FontCacheItem pFontCache[HFONT_CACHE_SIZE];
 267   ME_OutStream *pStream;
 268   BOOL bScrollX, bScrollY;
 269   int nScrollPosY;
 270 } ME_TextEditor;
 271
 272 typedef struct tagME_Context
 273 {
 274   HDC hDC;
 275   POINT pt;
 276   POINT ptRowOffset;
 277   RECT rcView;
 278   HBRUSH hbrMargin;
 279
 280   /* those are valid inside ME_WrapTextParagraph and related */
 281   POINT ptFirstRun;
 282   ME_TextEditor *editor;
 283   int nSequence;
 284 } ME_Context;
 285
 286 typedef struct tagME_WrapContext
 287 {
 288   ME_Style *style;
 289   ME_Context *context;
 290   int nLeftMargin, nRightMargin, nFirstMargin;
 291   int nTotalWidth, nAvailWidth;
 292   int nRow;
 293   POINT pt;
 294   BOOL bOverflown;
 295   ME_DisplayItem *pRowStart;
 296
 297   ME_DisplayItem *pLastSplittableRun;
 298   POINT ptLastSplittableRun;
 299 } ME_WrapContext;
 300
 301 #endif