Add DDCAPS_OVERLAY and DDCAPS_OVERLAYSTRETCH to GetCaps().
[wine] / 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
90 /* run is splittable (contains white spaces in the middle or end) */
91 #define MERF_SPLITTABLE 0x001000
92 /* run starts with whitespaces */
93 #define MERF_STARTWHITE 0x002000
94 /* run ends with whitespaces */
95 #define MERF_ENDWHITE   0x004000
96 /* run is completely made of whitespaces */
97 #define MERF_WHITESPACE 0x008000
98 /* run is a last (dummy) run in the paragraph */
99 #define MERF_SKIPPED    0x010000
100 /* flags that are calculated during text wrapping */
101 #define MERF_CALCBYWRAP 0x0F0000
102 /* the "end of paragraph" run, contains 1 character */
103 #define MERF_ENDPARA    0x100000
104
105 /* those flags are kept when the row is split */
106 #define MERF_SPLITMASK (~(0))
107
108 /******************************** para flags *************************/
109
110 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
111 #define MEPF_WRAPPED 1
112 #define MEPF_REDRAW 2
113
114 /******************************** structures *************************/
115
116 struct tagME_DisplayItem;
117
118 typedef struct tagME_Run
119 {
120   ME_String *strText;
121   ME_Style *style;
122   int nCharOfs; /* relative to para's offset */
123   int nWidth; /* width of full run, width of leading&trailing ws */
124   int nFlags;
125   int nAscent, nDescent; /* pixels above/below baseline */
126   POINT pt; /* relative to para's position */
127 } ME_Run;
128
129 typedef struct tagME_Document {
130   struct tagME_DisplayItem *def_char_style;
131   struct tagME_DisplayItem *def_para_style;
132   int last_wrapped_line;
133 } ME_Document;
134
135 typedef struct tagME_Paragraph
136 {
137   PARAFORMAT2 *pFmt;
138   int nLeftMargin, nRightMargin, nFirstMargin;
139   int nCharOfs;
140   int nFlags;
141   int nYPos, nHeight;
142   struct tagME_DisplayItem *prev_para, *next_para, *document;
143 } ME_Paragraph;
144
145 typedef struct tagME_Row
146 {
147   int nHeight;
148   int nBaseline;
149   int nWidth;
150   int nLMargin;
151   int nRMargin;
152   int nYPos;
153 } ME_Row;
154
155 typedef struct tagME_DisplayItem
156 {
157   ME_DIType type;
158   struct tagME_DisplayItem *prev, *next;
159   union {
160     ME_Run run;
161     ME_Row row;
162     ME_Paragraph para;
163     ME_Document doc; /* not used */
164     ME_Style *ustyle; /* used by diUndoSetCharFormat */
165   } member;
166 } ME_DisplayItem;
167
168 typedef struct tagME_UndoItem
169 {
170   ME_DisplayItem di;
171   int nStart, nLen;
172 } ME_UndoItem;
173
174 typedef struct tagME_TextBuffer
175 {
176   ME_DisplayItem *pFirst, *pLast;
177   ME_Style *pCharStyle;
178   ME_Style *pDefaultStyle;
179 } ME_TextBuffer;
180
181 typedef struct tagME_Cursor
182 {
183   ME_DisplayItem *pRun;
184   int nOffset;
185 } ME_Cursor;
186
187 typedef enum {
188   umAddToUndo,
189   umAddToRedo,
190   umIgnore,
191   umAddBackToUndo
192 } ME_UndoMode;
193
194 typedef struct tagME_TextEditor
195 {
196   HWND hWnd;
197   BOOL bCaretShown;
198   ME_TextBuffer *pBuffer;
199   ME_Cursor *pCursors;
200   int nCursors;
201   SIZE sizeWindow;
202   int nScrollPos;
203   int nTotalLength;
204   int nUDArrowX;
205   int nSequence;
206   int nOldSelFrom, nOldSelTo;
207   COLORREF rgbBackColor;
208   BOOL bCaretAtEnd;
209   int nEventMask;
210   int nModifyStep;
211   ME_DisplayItem *pUndoStack, *pRedoStack;
212   ME_UndoMode nUndoMode;
213   int nParagraphs;
214 } ME_TextEditor;
215
216 typedef struct tagME_Context
217 {
218   HDC hDC;
219   POINT pt;
220   POINT ptRowOffset;
221   RECT rcView;
222   HBRUSH hbrMargin;
223
224   /* those are valid inside ME_WrapTextParagraph and related */
225   POINT ptFirstRun;
226   ME_TextEditor *editor;
227   int nSequence;
228 } ME_Context;
229
230 typedef struct tagME_WrapContext
231 {
232   ME_Style *style;
233   ME_Context *context;
234   int nLeftMargin, nRightMargin, nFirstMargin;
235   int nTotalWidth, nAvailWidth;
236   int nRow;
237   POINT pt;
238   BOOL bOverflown;
239   ME_DisplayItem *pRowStart;
240   
241   ME_DisplayItem *pLastSplittableRun;
242   POINT ptLastSplittableRun;
243 } ME_WrapContext;  
244
245 #endif