2 * RichEdit - structures and constant
4 * Copyright 2004 by Krzysztof Foltman
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.
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.
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
25 #define _WIN32_IE 0x0400
50 #include "wine/debug.h"
51 #include "wine/list.h"
54 extern const struct ITextHostVtbl itextHostStdcallVtbl DECLSPEC_HIDDEN
;
57 typedef struct tagME_String
63 typedef struct tagME_FontCacheItem
71 #define HFONT_CACHE_SIZE 10
73 typedef struct tagME_Style
77 ME_FontCacheItem
*font_cache
; /* cached font for the style */
78 TEXTMETRICW tm
; /* cached font metrics for the style */
79 int nRefs
; /* reference count */
80 SCRIPT_CACHE script_cache
;
86 diTextStart
, /* start of the text buffer */
87 diParagraph
, /* paragraph start */
88 diCell
, /* cell start */
89 diRun
, /* run (sequence of chars with the same character format) */
90 diStartRow
, /* start of the row (line of text on the screen) */
91 diTextEnd
, /* end of the text buffer */
93 /********************* these below are meant for finding only *********************/
94 diStartRowOrParagraph
, /* 7 */
95 diStartRowOrParagraphOrEnd
,
99 diRunOrParagraphOrEnd
, /* 12 */
102 #define SELECTIONBAR_WIDTH 8
104 /******************************** run flags *************************/
105 #define MERF_STYLEFLAGS 0x0FFF
106 /* run contains non-text content, which has its own rules for wrapping, sizing etc */
107 #define MERF_GRAPHICS 0x001
108 /* run is a tab (or, in future, any kind of content whose size is dependent on run position) */
109 #define MERF_TAB 0x002
110 /* run is a cell boundary */
111 #define MERF_ENDCELL 0x004 /* v4.1 */
113 #define MERF_NONTEXT (MERF_GRAPHICS | MERF_TAB | MERF_ENDCELL)
115 /* run is splittable (contains white spaces in the middle or end) */
116 #define MERF_SPLITTABLE 0x001000
117 /* run starts with whitespaces */
118 #define MERF_STARTWHITE 0x002000
119 /* run ends with whitespaces */
120 #define MERF_ENDWHITE 0x004000
121 /* run is completely made of whitespaces */
122 #define MERF_WHITESPACE 0x008000
123 /* the "end of paragraph" run, contains 1 character */
124 #define MERF_ENDPARA 0x100000
125 /* forcing the "end of row" run, contains 1 character */
126 #define MERF_ENDROW 0x200000
128 #define MERF_HIDDEN 0x400000
129 /* start of a table row has an empty paragraph that should be skipped over. */
130 #define MERF_TABLESTART 0x800000 /* v4.1 */
132 /* runs with any of these flags set cannot be joined */
133 #define MERF_NOJOIN (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
134 /* runs that don't contain real text */
135 #define MERF_NOTEXT (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
137 /* those flags are kept when the row is split */
138 #define MERF_SPLITMASK (~(0))
140 /******************************** para flags *************************/
142 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
143 #define MEPF_REWRAP 0x01
145 #define MEPF_CELL 0x04 /* The paragraph is nested in a cell */
146 #define MEPF_ROWSTART 0x08 /* Hidden empty paragraph at the start of the row */
147 #define MEPF_ROWEND 0x10 /* Visible empty paragraph at the end of the row */
148 #define MEPF_COMPLEX 0x20 /* Use uniscribe */
150 /******************************** structures *************************/
152 struct tagME_DisplayItem
;
154 typedef struct tagME_Run
157 struct tagME_Paragraph
*para
; /* ptr to the run's paragraph */
158 int nCharOfs
; /* relative to para's offset */
159 int len
; /* length of run's text */
160 int nWidth
; /* width of full run, width of leading&trailing ws */
162 int nAscent
, nDescent
; /* pixels above/below baseline */
163 POINT pt
; /* relative to para's position */
164 REOBJECT
*ole_obj
; /* FIXME: should be a union with strText (at least) */
166 SCRIPT_ANALYSIS script_analysis
;
167 int num_glyphs
, max_glyphs
;
169 SCRIPT_VISATTR
*vis_attrs
;
176 typedef struct tagME_Border
182 typedef struct tagME_BorderRect
190 typedef struct tagME_Paragraph
195 struct tagME_DisplayItem
*pCell
; /* v4.1 */
196 ME_BorderRect border
;
203 struct tagME_DisplayItem
*prev_para
, *next_para
;
206 typedef struct tagME_Cell
/* v4.1 */
208 int nNestingLevel
; /* 0 for normal cells, and greater for nested cells */
210 ME_BorderRect border
;
213 int yTextOffset
; /* The text offset is caused by the largest top border. */
214 struct tagME_DisplayItem
*prev_cell
, *next_cell
, *parent_cell
;
217 typedef struct tagME_Row
227 /* the display item list layout is like this:
228 * - the document consists of paragraphs
229 * - each paragraph contains at least one run, the last run in the paragraph
230 * is an end-of-paragraph run
231 * - each formatted paragraph contains at least one row, which corresponds
232 * to a screen line (that's why there are no rows in an unformatted
234 * - the paragraphs contain "shortcut" pointers to the previous and the next
235 * paragraph, that makes iteration over paragraphs faster
236 * - the list starts with diTextStart and ends with diTextEnd
239 typedef struct tagME_DisplayItem
242 struct tagME_DisplayItem
*prev
, *next
;
251 typedef struct tagME_TextBuffer
253 ME_DisplayItem
*pFirst
, *pLast
;
254 ME_Style
*pCharStyle
;
255 ME_Style
*pDefaultStyle
;
258 typedef struct tagME_Cursor
260 ME_DisplayItem
*pPara
;
261 ME_DisplayItem
*pRun
;
280 undo_end_transaction
, /* marks the end of a group of changes for undo */
281 undo_potential_end_transaction
/* allows grouping typed chars for undo */
284 struct insert_run_item
292 struct delete_run_item
297 struct join_paras_item
302 struct split_para_item
306 ME_BorderRect border
;
309 ME_BorderRect cell_border
;
310 int cell_right_boundary
;
313 struct set_para_fmt_item
317 ME_BorderRect border
;
320 struct set_char_fmt_item
332 struct insert_run_item insert_run
;
333 struct delete_run_item delete_run
;
334 struct join_paras_item join_paras
;
335 struct split_para_item split_para
;
336 struct set_para_fmt_item set_para_fmt
;
337 struct set_char_fmt_item set_char_fmt
;
349 typedef struct tagME_FontTableItem
{
355 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
357 struct tagME_InStream
{
358 EDITSTREAM
*editstream
;
361 char buffer
[STREAMIN_BUFFER_SIZE
];
363 typedef struct tagME_InStream ME_InStream
;
366 #define STREAMOUT_BUFFER_SIZE 4096
367 #define STREAMOUT_FONTTBL_SIZE 8192
368 #define STREAMOUT_COLORTBL_SIZE 1024
370 typedef struct tagME_OutStream
{
372 char buffer
[STREAMOUT_BUFFER_SIZE
];
376 ME_FontTableItem fonttbl
[STREAMOUT_FONTTBL_SIZE
];
378 COLORREF colortbl
[STREAMOUT_COLORTBL_SIZE
];
380 UINT nDefaultCodePage
;
381 /* nNestingLevel = 0 means we aren't in a cell, 1 means we are in a cell,
382 * an greater numbers mean we are in a cell nested within a cell. */
386 typedef struct tagME_TextEditor
388 HWND hWnd
, hwndParent
;
391 BOOL bEmulateVersion10
;
392 ME_TextBuffer
*pBuffer
;
399 int nTotalLength
, nLastTotalLength
;
400 int nTotalWidth
, nLastTotalWidth
;
401 int nAvailWidth
; /* 0 = wrap to client area, else wrap width in twips */
403 COLORREF rgbBackColor
;
404 HBRUSH hbrBackground
;
408 struct list undo_stack
;
409 struct list redo_stack
;
412 ME_UndoMode nUndoMode
;
414 int nLastSelStart
, nLastSelEnd
;
415 ME_DisplayItem
*pLastSelStartPara
, *pLastSelEndPara
;
416 ME_FontCacheItem pFontCache
[HFONT_CACHE_SIZE
];
417 int nZoomNumerator
, nZoomDenominator
;
420 BOOL bDefaultFormatRect
;
423 EDITWORDBREAKPROCW pfnWordBreak
;
424 LPRICHEDITOLECALLBACK lpOleCallback
;
425 /*TEXTMODE variable; contains only one of each of the following options:
426 *TM_RICHTEXT or TM_PLAINTEXT
427 *TM_SINGLELEVELUNDO or TM_MULTILEVELUNDO
428 *TM_SINGLECODEPAGE or TM_MULTICODEPAGE*/
431 BOOL AutoURLDetect_bEnable
;
434 BOOL bDialogMode
; /* Indicates that we are inside a dialog window */
437 DWORD selofs
; /* The size of the selection bar on the left side of control */
438 ME_SelectionType nSelectionType
;
440 /* Track previous notified selection */
441 CHARRANGE notified_cr
;
443 /* Cache previously set scrollbar info */
444 SCROLLINFO vert_si
, horz_si
;
448 struct list style_list
;
451 typedef struct tagME_Context
459 /* those are valid inside ME_WrapTextParagraph and related */
460 ME_TextEditor
*editor
;
463 typedef struct tagME_WrapContext
467 int nLeftMargin
, nRightMargin
, nFirstMargin
;
471 BOOL bOverflown
, bWordWrap
;
472 ME_DisplayItem
*pPara
;
473 ME_DisplayItem
*pRowStart
;
475 ME_DisplayItem
*pLastSplittableRun
;