Create a branch for network fixes.
[reactos.git] / dll / win32 / 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 BOOL bTable; /* this paragraph is a table row */
174 struct tagME_TableCell *pCells; /* list of cells and their properties */
175 struct tagME_TableCell *pLastCell; /* points to the last cell in the list */
176
177 int nCharOfs;
178 int nFlags;
179 int nYPos, nHeight;
180 int nLastPaintYPos, nLastPaintHeight;
181 int nRows;
182 struct tagME_DisplayItem *prev_para, *next_para, *document;
183 } ME_Paragraph;
184
185 typedef struct tagME_Row
186 {
187 int nHeight;
188 int nBaseline;
189 int nWidth;
190 int nLMargin;
191 int nRMargin;
192 int nYPos;
193 } ME_Row;
194
195 /* the display item list layout is like this:
196 * - the document consists of paragraphs
197 * - each paragraph contains at least one run, the last run in the paragraph
198 * is an end-of-paragraph run
199 * - each formatted paragraph contains at least one row, which corresponds
200 * to a screen line (that's why there are no rows in an unformatted
201 * paragraph
202 * - the paragraphs contain "shortcut" pointers to the previous and the next
203 * paragraph, that makes iteration over paragraphs faster
204 * - the list starts with diTextStart and ends with diTextEnd
205 */
206
207 typedef struct tagME_DisplayItem
208 {
209 ME_DIType type;
210 struct tagME_DisplayItem *prev, *next;
211 union {
212 ME_Run run;
213 ME_Row row;
214 ME_Paragraph para;
215 ME_Document doc; /* not used */
216 ME_Style *ustyle; /* used by diUndoSetCharFormat */
217 } member;
218 } ME_DisplayItem;
219
220 typedef struct tagME_UndoItem
221 {
222 ME_DisplayItem di;
223 int nStart, nLen;
224 int nCR, nLF; /* used by diUndoSplitParagraph */
225 } ME_UndoItem;
226
227 typedef struct tagME_TextBuffer
228 {
229 ME_DisplayItem *pFirst, *pLast;
230 ME_Style *pCharStyle;
231 ME_Style *pDefaultStyle;
232 } ME_TextBuffer;
233
234 typedef struct tagME_Cursor
235 {
236 ME_DisplayItem *pRun;
237 int nOffset;
238 } ME_Cursor;
239
240 typedef enum {
241 umAddToUndo,
242 umAddToRedo,
243 umIgnore,
244 umAddBackToUndo
245 } ME_UndoMode;
246
247 typedef struct tagME_FontTableItem {
248 BYTE bCharSet;
249 WCHAR *szFaceName;
250 } ME_FontTableItem;
251
252
253 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
254
255 struct tagME_InStream {
256 EDITSTREAM *editstream;
257 DWORD dwSize;
258 DWORD dwUsed;
259 char buffer[STREAMIN_BUFFER_SIZE];
260 };
261 typedef struct tagME_InStream ME_InStream;
262
263
264 #define STREAMOUT_BUFFER_SIZE 4096
265 #define STREAMOUT_FONTTBL_SIZE 8192
266 #define STREAMOUT_COLORTBL_SIZE 1024
267
268 typedef struct tagME_OutStream {
269 EDITSTREAM *stream;
270 char buffer[STREAMOUT_BUFFER_SIZE];
271 UINT pos, written;
272 UINT nCodePage;
273 UINT nFontTblLen;
274 ME_FontTableItem fonttbl[STREAMOUT_FONTTBL_SIZE];
275 UINT nColorTblLen;
276 COLORREF colortbl[STREAMOUT_COLORTBL_SIZE];
277 UINT nDefaultFont;
278 UINT nDefaultCodePage;
279 } ME_OutStream;
280
281 typedef struct tagME_FontCacheItem
282 {
283 LOGFONTW lfSpecs;
284 HFONT hFont;
285 int nRefs;
286 int nAge;
287 } ME_FontCacheItem;
288
289 #define HFONT_CACHE_SIZE 10
290
291 typedef struct tagME_TextEditor
292 {
293 HWND hWnd;
294 BOOL bEmulateVersion10;
295 BOOL bCaretShown;
296 ME_TextBuffer *pBuffer;
297 ME_Cursor *pCursors;
298 int nCursors;
299 SIZE sizeWindow;
300 int nTotalLength, nLastTotalLength;
301 int nHeight;
302 int nUDArrowX;
303 int nSequence;
304 COLORREF rgbBackColor;
305 HBRUSH hbrBackground;
306 BOOL bCaretAtEnd;
307 int nEventMask;
308 int nModifyStep;
309 ME_DisplayItem *pUndoStack, *pRedoStack, *pUndoStackBottom;
310 int nUndoStackSize;
311 int nUndoLimit;
312 ME_UndoMode nUndoMode;
313 int nParagraphs;
314 int nLastSelStart, nLastSelEnd;
315 ME_DisplayItem *pLastSelStartPara, *pLastSelEndPara;
316 ME_FontCacheItem pFontCache[HFONT_CACHE_SIZE];
317 int nZoomNumerator, nZoomDenominator;
318 RECT rcFormat;
319 BOOL bRedraw;
320 BOOL bWordWrap;
321 int nInvalidOfs;
322 int nTextLimit;
323 EDITWORDBREAKPROCW pfnWordBreak;
324 LPRICHEDITOLECALLBACK lpOleCallback;
325 /*TEXTMODE variable; contains only one of each of the following options:
326 *TM_RICHTEXT or TM_PLAINTEXT
327 *TM_SINGLELEVELUNDO or TM_MULTILEVELUNDO
328 *TM_SINGLECODEPAGE or TM_MULTICODEPAGE*/
329 int mode;
330 BOOL bHideSelection;
331 BOOL AutoURLDetect_bEnable;
332 WCHAR cPasswordMask;
333 BOOL bHaveFocus;
334 /*for IME */
335 int imeStartIndex;
336 DWORD selofs, linesel, sely;
337
338 /* Track previous notified selection */
339 CHARRANGE notified_cr;
340 } ME_TextEditor;
341
342 typedef struct tagME_Context
343 {
344 HDC hDC;
345 POINT pt;
346 POINT ptRowOffset;
347 RECT rcView;
348 HBRUSH hbrMargin;
349 SIZE dpi;
350
351 /* those are valid inside ME_WrapTextParagraph and related */
352 POINT ptFirstRun;
353 ME_TextEditor *editor;
354 int nSequence;
355 } ME_Context;
356
357 typedef struct tagME_WrapContext
358 {
359 ME_Style *style;
360 ME_Context *context;
361 int nLeftMargin, nRightMargin, nFirstMargin;
362 int nAvailWidth;
363 int nRow;
364 POINT pt;
365 BOOL bOverflown;
366 ME_DisplayItem *pRowStart;
367
368 ME_DisplayItem *pLastSplittableRun;
369 POINT ptLastSplittableRun;
370 } ME_WrapContext;
371
372 #endif