2 * RichEdit - prototypes for functions and macro definitions
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
22 #include "wine/unicode.h"
26 extern HANDLE me_heap;
28 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc( size_t len )
30 return HeapAlloc( me_heap, 0, len );
33 static inline BOOL heap_free( void *ptr )
35 return HeapFree( me_heap, 0, ptr );
38 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc( void *ptr, size_t len )
40 return HeapReAlloc( me_heap, 0, ptr, len );
43 #define ALLOC_OBJ(type) heap_alloc(sizeof(type))
44 #define ALLOC_N_OBJ(type, count) heap_alloc((count)*sizeof(type))
45 #define FREE_OBJ(ptr) heap_free(ptr)
47 #define RUN_IS_HIDDEN(run) ((run)->style->fmt.dwMask & CFM_HIDDEN \
48 && (run)->style->fmt.dwEffects & CFE_HIDDEN)
50 #define InitFormatEtc(fe, cf, med) \
53 (fe).dwAspect=DVASPECT_CONTENT;\
60 ME_Style *ME_MakeStyle(CHARFORMAT2W *style);
61 void ME_AddRefStyle(ME_Style *item);
62 void ME_ReleaseStyle(ME_Style *item);
63 ME_Style *ME_GetInsertStyle(ME_TextEditor *editor, int nCursor);
64 ME_Style *ME_ApplyStyle(ME_Style *sSrc, CHARFORMAT2W *style);
65 HFONT ME_SelectStyleFont(ME_Context *c, ME_Style *s);
66 void ME_UnselectStyleFont(ME_Context *c, ME_Style *s, HFONT hOldFont);
67 void ME_InitCharFormat2W(CHARFORMAT2W *pFmt);
68 void ME_SaveTempStyle(ME_TextEditor *editor);
69 void ME_ClearTempStyle(ME_TextEditor *editor);
70 void ME_DumpStyleToBuf(CHARFORMAT2W *pFmt, char buf[2048]);
71 void ME_DumpStyle(ME_Style *s);
72 CHARFORMAT2W *ME_ToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from);
73 void ME_CopyToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from);
74 void ME_CopyCharFormat(CHARFORMAT2W *pDest, const CHARFORMAT2W *pSrc); /* only works with 2W structs */
75 void ME_CharFormatFromLogFont(HDC hDC, const LOGFONTW *lf, CHARFORMAT2W *fmt); /* ditto */
78 void ME_InsertBefore(ME_DisplayItem *diWhere, ME_DisplayItem *diWhat);
79 void ME_Remove(ME_DisplayItem *diWhere);
80 ME_DisplayItem *ME_FindItemBack(ME_DisplayItem *di, ME_DIType nTypeOrClass);
81 ME_DisplayItem *ME_FindItemFwd(ME_DisplayItem *di, ME_DIType nTypeOrClass);
82 ME_DisplayItem *ME_FindItemBackOrHere(ME_DisplayItem *di, ME_DIType nTypeOrClass);
83 ME_DisplayItem *ME_MakeDI(ME_DIType type);
84 void ME_DestroyDisplayItem(ME_DisplayItem *item);
85 void ME_DumpDocument(ME_TextBuffer *buffer);
86 const char *ME_GetDITypeName(ME_DIType type);
89 ME_String *ME_MakeStringN(LPCWSTR szText, int nMaxChars);
90 ME_String *ME_MakeStringR(WCHAR cRepeat, int nMaxChars);
91 ME_String *ME_StrDup(const ME_String *s);
92 void ME_DestroyString(ME_String *s);
93 void ME_AppendString(ME_String *s1, const ME_String *s2);
94 ME_String *ME_VSplitString(ME_String *orig, int nVPos);
95 int ME_IsWhitespaces(const ME_String *s);
96 int ME_IsSplitable(const ME_String *s);
97 int ME_FindNonWhitespaceV(const ME_String *s, int nVChar);
98 int ME_CallWordBreakProc(ME_TextEditor *editor, ME_String *str, INT start, INT code);
99 void ME_StrDeleteV(ME_String *s, int nVChar, int nChars);
100 /* smart helpers for A<->W conversions, they reserve/free memory and call MultiByte<->WideChar functions */
101 LPWSTR ME_ToUnicode(BOOL unicode, LPVOID psz);
102 void ME_EndToUnicode(BOOL unicode, LPVOID psz);
104 static inline int ME_IsWSpace(WCHAR ch)
106 return ch > '\0' && ch <= ' ';
109 static inline int ME_CharCompare(WCHAR a, WCHAR b, int caseSensitive)
111 return caseSensitive ? (a == b) : (toupperW(a) == toupperW(b));
114 /* note: those two really return the first matching offset (starting from EOS)+1
115 * in other words, an offset of the first trailing white/black */
116 int ME_ReverseFindNonWhitespaceV(const ME_String *s, int nVChar);
117 int ME_ReverseFindWhitespaceV(const ME_String *s, int nVChar);
120 ME_DisplayItem *ME_RowStart(ME_DisplayItem *item);
121 /* ME_DisplayItem *ME_RowEnd(ME_DisplayItem *item); */
122 ME_DisplayItem *ME_FindRowWithNumber(ME_TextEditor *editor, int nRow);
123 int ME_RowNumberFromCharOfs(ME_TextEditor *editor, int nOfs);
126 ME_DisplayItem *ME_MakeRun(ME_Style *s, ME_String *strData, int nFlags);
127 /* note: ME_InsertRun inserts a copy of the specified run - so you need to destroy the original */
128 ME_DisplayItem *ME_InsertRun(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem *pItem);
129 ME_DisplayItem *ME_InsertRunAtCursor(ME_TextEditor *editor, ME_Cursor *cursor,
130 ME_Style *style, const WCHAR *str, int len, int flags);
131 void ME_CheckCharOffsets(ME_TextEditor *editor);
132 void ME_PropagateCharOffset(ME_DisplayItem *p, int shift);
133 int ME_CharFromPoint(ME_Context *c, int cx, ME_Run *run);
134 /* this one accounts for 1/2 char tolerance */
135 int ME_CharFromPointCursor(ME_TextEditor *editor, int cx, ME_Run *run);
136 int ME_PointFromChar(ME_TextEditor *editor, ME_Run *pRun, int nOffset);
137 int ME_CanJoinRuns(const ME_Run *run1, const ME_Run *run2);
138 void ME_JoinRuns(ME_TextEditor *editor, ME_DisplayItem *p);
139 ME_DisplayItem *ME_SplitRun(ME_WrapContext *wc, ME_DisplayItem *item, int nChar);
140 ME_DisplayItem *ME_SplitRunSimple(ME_TextEditor *editor, ME_DisplayItem *item, int nChar);
141 void ME_UpdateRunFlags(ME_TextEditor *editor, ME_Run *run);
142 void ME_CalcRunExtent(ME_Context *c, const ME_Paragraph *para, int startx, ME_Run *run);
143 SIZE ME_GetRunSize(ME_Context *c, const ME_Paragraph *para, ME_Run *run, int nLen, int startx);
144 void ME_CursorFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_Cursor *pCursor);
145 void ME_RunOfsFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem **ppPara, ME_DisplayItem **ppRun, int *pOfs);
146 int ME_CharOfsFromRunOfs(ME_TextEditor *editor, const ME_DisplayItem *pPara, const ME_DisplayItem *pRun, int nOfs);
147 void ME_SkipAndPropagateCharOffset(ME_DisplayItem *p, int shift);
148 void ME_SetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
149 void ME_SetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
150 void ME_GetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
151 void ME_GetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
152 void ME_GetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
153 void ME_SetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *mod);
156 int ME_SetSelection(ME_TextEditor *editor, int from, int to);
157 void ME_HideCaret(ME_TextEditor *ed);
158 void ME_ShowCaret(ME_TextEditor *ed);
159 void ME_MoveCaret(ME_TextEditor *ed);
160 int ME_CharFromPos(ME_TextEditor *editor, int x, int y, BOOL *isExact);
161 void ME_LButtonDown(ME_TextEditor *editor, int x, int y, int clickNum);
162 void ME_MouseMove(ME_TextEditor *editor, int x, int y);
163 BOOL ME_DeleteTextAtCursor(ME_TextEditor *editor, int nCursor, int nChars);
164 void ME_InsertTextFromCursor(ME_TextEditor *editor, int nCursor,
165 const WCHAR *str, int len, ME_Style *style);
166 void ME_InsertEndRowFromCursor(ME_TextEditor *editor, int nCursor);
167 BOOL ME_ArrowKey(ME_TextEditor *ed, int nVKey, BOOL extend, BOOL ctrl);
169 int ME_GetCursorOfs(ME_TextEditor *editor, int nCursor);
170 void ME_GetSelection(ME_TextEditor *editor, int *from, int *to);
171 int ME_CountParagraphsBetween(ME_TextEditor *editor, int from, int to);
172 BOOL ME_IsSelection(ME_TextEditor *editor);
173 void ME_DeleteSelection(ME_TextEditor *editor);
174 void ME_SendSelChange(ME_TextEditor *editor);
175 void ME_InsertOLEFromCursor(ME_TextEditor *editor, const REOBJECT* reo, int nCursor);
176 BOOL ME_InternalDeleteText(ME_TextEditor *editor, int nOfs, int nChars, BOOL bForce);
177 int ME_GetTextLength(ME_TextEditor *editor);
178 int ME_GetTextLengthEx(ME_TextEditor *editor, const GETTEXTLENGTHEX *how);
179 ME_Style *ME_GetSelectionInsertStyle(ME_TextEditor *editor);
182 void ME_InitContext(ME_Context *c, ME_TextEditor *editor, HDC hDC);
183 void ME_DestroyContext(ME_Context *c);
186 BOOL ME_WrapMarkedParagraphs(ME_TextEditor *editor);
187 void ME_InvalidateMarkedParagraphs(ME_TextEditor *editor);
188 void ME_SendRequestResize(ME_TextEditor *editor, BOOL force);
191 ME_DisplayItem *ME_GetParagraph(ME_DisplayItem *run);
192 void ME_GetSelectionParas(ME_TextEditor *editor, ME_DisplayItem **para, ME_DisplayItem **para_end);
193 void ME_MakeFirstParagraph(ME_TextEditor *editor);
194 ME_DisplayItem *ME_SplitParagraph(ME_TextEditor *editor, ME_DisplayItem *rp, ME_Style *style, ME_String *eol_str, int paraFlags);
195 ME_DisplayItem *ME_JoinParagraphs(ME_TextEditor *editor, ME_DisplayItem *tp,
196 BOOL keepFirstParaFormat);
197 void ME_DumpParaStyle(ME_Paragraph *s);
198 void ME_DumpParaStyleToBuf(const PARAFORMAT2 *pFmt, char buf[2048]);
199 BOOL ME_SetSelectionParaFormat(ME_TextEditor *editor, const PARAFORMAT2 *pFmt);
200 void ME_GetSelectionParaFormat(ME_TextEditor *editor, PARAFORMAT2 *pFmt);
201 /* marks from first up to (but not including) last */
202 void ME_MarkForPainting(ME_TextEditor *editor, ME_DisplayItem *first, const ME_DisplayItem *last);
203 void ME_MarkAllForWrapping(ME_TextEditor *editor);
204 void ME_SetDefaultParaFormat(PARAFORMAT2 *pFmt);
207 void ME_PaintContent(ME_TextEditor *editor, HDC hDC, BOOL bOnlyNew, const RECT *rcUpdate);
208 void ME_Repaint(ME_TextEditor *editor);
209 void ME_RewrapRepaint(ME_TextEditor *editor);
210 void ME_UpdateRepaint(ME_TextEditor *editor);
211 void ME_EnsureVisible(ME_TextEditor *editor, ME_Cursor *pCursor);
212 void ME_InvalidateSelection(ME_TextEditor *editor);
213 BOOL ME_SetZoom(ME_TextEditor *editor, int numerator, int denominator);
214 int ME_twips2pointsX(ME_Context *c, int x);
215 int ME_twips2pointsY(ME_Context *c, int y);
217 /* scroll functions in paint.c */
219 void ME_ScrollAbs(ME_TextEditor *editor, int x, int y);
220 void ME_HScrollAbs(ME_TextEditor *editor, int x);
221 void ME_VScrollAbs(ME_TextEditor *editor, int y);
222 void ME_ScrollUp(ME_TextEditor *editor, int cy);
223 void ME_ScrollDown(ME_TextEditor *editor, int cy);
224 void ME_ScrollLeft(ME_TextEditor *editor, int cx);
225 void ME_ScrollRight(ME_TextEditor *editor, int cx);
226 void ME_UpdateScrollBar(ME_TextEditor *editor);
228 /* other functions in paint.c */
229 int ME_GetParaBorderWidth(ME_TextEditor *editor, int);
230 int ME_GetParaLineSpace(ME_Context *c, ME_Paragraph*);
233 LRESULT CreateIRichEditOle(ME_TextEditor *editor, LPVOID *);
234 void ME_DrawOLE(ME_Context *c, int x, int y, ME_Run* run, ME_Paragraph *para, BOOL selected);
235 void ME_GetOLEObjectSize(ME_Context *c, ME_Run *run, SIZE *pSize);
236 void ME_CopyReObject(REOBJECT* dst, const REOBJECT* src);
237 void ME_DeleteReObject(REOBJECT* reo);
240 ME_TextEditor *ME_MakeEditor(ITextHost *texthost, BOOL bEmulateVersion10);
241 LRESULT ME_HandleMessage(ME_TextEditor *editor, UINT msg, WPARAM wParam,
242 LPARAM lParam, BOOL unicode, HRESULT* phresult);
243 void ME_SendOldNotify(ME_TextEditor *editor, int nCode);
244 int ME_GetTextW(ME_TextEditor *editor, WCHAR *buffer, int nStart, int nChars, BOOL bCRLF);
245 void ME_RTFCharAttrHook(struct _RTF_Info *info);
246 void ME_RTFParAttrHook(struct _RTF_Info *info);
247 void ME_RTFTblAttrHook(struct _RTF_Info *info);
248 void ME_RTFSpecialCharHook(struct _RTF_Info *info);
249 void ME_StreamInFill(ME_InStream *stream);
253 BOOL ME_IsInTable(ME_DisplayItem *pItem);
254 ME_DisplayItem *ME_InsertTableRowStartFromCursor(ME_TextEditor *editor);
255 ME_DisplayItem *ME_InsertTableRowStartAtParagraph(ME_TextEditor *editor,
256 ME_DisplayItem *para);
257 ME_DisplayItem *ME_InsertTableCellFromCursor(ME_TextEditor *editor);
258 ME_DisplayItem *ME_InsertTableRowEndFromCursor(ME_TextEditor *editor);
259 ME_DisplayItem *ME_GetTableRowEnd(ME_DisplayItem *para);
260 ME_DisplayItem *ME_GetTableRowStart(ME_DisplayItem *para);
261 void ME_CheckTablesForCorruption(ME_TextEditor *editor);
262 void ME_ProtectPartialTableDeletion(ME_TextEditor *editor, int nOfs,int *nChars);
263 ME_DisplayItem* ME_AppendTableRow(ME_TextEditor *editor, ME_DisplayItem *table_row);
264 void ME_TabPressedInTable(ME_TextEditor *editor, BOOL bSelectedRow);
265 void ME_MoveCursorFromTableRowStartParagraph(ME_TextEditor *editor);
266 struct RTFTable *ME_MakeTableDef(ME_TextEditor *editor);
267 void ME_InitTableDef(ME_TextEditor *editor, struct RTFTable *tableDef);
270 ITextHost *ME_CreateTextHost(HWND hwnd, BOOL bEmulateVersion10);
271 #ifdef __i386__ /* Use wrappers to perform thiscall on i386 */
272 #define TXTHOST_VTABLE(This) (&itextHostStdcallVtbl)
274 #define TXTHOST_VTABLE(This) (This)->lpVtbl
275 #endif /* __i386__ */
276 /*** ITextHost methods ***/
277 #define ITextHost_TxGetDC(This) TXTHOST_VTABLE(This)->TxGetDC(This)
278 #define ITextHost_TxReleaseDC(This,a) TXTHOST_VTABLE(This)->TxReleaseDC(This,a)
279 #define ITextHost_TxShowScrollBar(This,a,b) TXTHOST_VTABLE(This)->TxShowScrollBar(This,a,b)
280 #define ITextHost_TxEnableScrollBar(This,a,b) TXTHOST_VTABLE(This)->TxEnableScrollBar(This,a,b)
281 #define ITextHost_TxSetScrollRange(This,a,b,c,d) TXTHOST_VTABLE(This)->TxSetScrollRange(This,a,b,c,d)
282 #define ITextHost_TxSetScrollPos(This,a,b,c) TXTHOST_VTABLE(This)->TxSetScrollPos(This,a,b,c)
283 #define ITextHost_TxInvalidateRect(This,a,b) TXTHOST_VTABLE(This)->TxInvalidateRect(This,a,b)
284 #define ITextHost_TxViewChange(This,a) TXTHOST_VTABLE(This)->TxViewChange(This,a)
285 #define ITextHost_TxCreateCaret(This,a,b,c) TXTHOST_VTABLE(This)->TxCreateCaret(This,a,b,c)
286 #define ITextHost_TxShowCaret(This,a) TXTHOST_VTABLE(This)->TxShowCaret(This,a)
287 #define ITextHost_TxSetCaretPos(This,a,b) TXTHOST_VTABLE(This)->TxSetCaretPos(This,a,b)
288 #define ITextHost_TxSetTimer(This,a,b) TXTHOST_VTABLE(This)->TxSetTimer(This,a,b)
289 #define ITextHost_TxKillTimer(This,a) TXTHOST_VTABLE(This)->TxKillTimer(This,a)
290 #define ITextHost_TxScrollWindowEx(This,a,b,c,d,e,f,g) TXTHOST_VTABLE(This)->TxScrollWindowEx(This,a,b,c,d,e,f,g)
291 #define ITextHost_TxSetCapture(This,a) TXTHOST_VTABLE(This)->TxSetCapture(This,a)
292 #define ITextHost_TxSetFocus(This) TXTHOST_VTABLE(This)->TxSetFocus(This)
293 #define ITextHost_TxSetCursor(This,a,b) TXTHOST_VTABLE(This)->TxSetCursor(This,a,b)
294 #define ITextHost_TxScreenToClient(This,a) TXTHOST_VTABLE(This)->TxScreenToClient(This,a)
295 #define ITextHost_TxClientToScreen(This,a) TXTHOST_VTABLE(This)->TxClientToScreen(This,a)
296 #define ITextHost_TxActivate(This,a) TXTHOST_VTABLE(This)->TxActivate(This,a)
297 #define ITextHost_TxDeactivate(This,a) TXTHOST_VTABLE(This)->TxDeactivate(This,a)
298 #define ITextHost_TxGetClientRect(This,a) TXTHOST_VTABLE(This)->TxGetClientRect(This,a)
299 #define ITextHost_TxGetViewInset(This,a) TXTHOST_VTABLE(This)->TxGetViewInset(This,a)
300 #define ITextHost_TxGetCharFormat(This,a) TXTHOST_VTABLE(This)->TxGetCharFormat(This,a)
301 #define ITextHost_TxGetParaFormat(This,a) TXTHOST_VTABLE(This)->TxGetParaFormat(This,a)
302 #define ITextHost_TxGetSysColor(This,a) TXTHOST_VTABLE(This)->TxGetSysColor(This,a)
303 #define ITextHost_TxGetBackStyle(This,a) TXTHOST_VTABLE(This)->TxGetBackStyle(This,a)
304 #define ITextHost_TxGetMaxLength(This,a) TXTHOST_VTABLE(This)->TxGetMaxLength(This,a)
305 #define ITextHost_TxGetScrollBars(This,a) TXTHOST_VTABLE(This)->TxGetScrollBars(This,a)
306 #define ITextHost_TxGetPasswordChar(This,a) TXTHOST_VTABLE(This)->TxGetPasswordChar(This,a)
307 #define ITextHost_TxGetAcceleratorPos(This,a) TXTHOST_VTABLE(This)->TxGetAcceleratorPos(This,a)
308 #define ITextHost_TxGetExtent(This,a) TXTHOST_VTABLE(This)->TxGetExtent(This,a)
309 #define ITextHost_OnTxCharFormatChange(This,a) TXTHOST_VTABLE(This)->OnTxCharFormatChange(This,a)
310 #define ITextHost_OnTxParaFormatChange(This,a) TXTHOST_VTABLE(This)->OnTxParaFormatChange(This,a)
311 #define ITextHost_TxGetPropertyBits(This,a,b) TXTHOST_VTABLE(This)->TxGetPropertyBits(This,a,b)
312 #define ITextHost_TxNotify(This,a,b) TXTHOST_VTABLE(This)->TxNotify(This,a,b)
313 #define ITextHost_TxImmGetContext(This) TXTHOST_VTABLE(This)->TxImmGetContext(This)
314 #define ITextHost_TxImmReleaseContext(This,a) TXTHOST_VTABLE(This)->TxImmReleaseContext(This,a)
315 #define ITextHost_TxGetSelectionBarWidth(This,a) TXTHOST_VTABLE(This)->TxGetSelectionBarWidth(This,a)
318 ME_UndoItem *ME_AddUndoItem(ME_TextEditor *editor, ME_DIType type, const ME_DisplayItem *pdi);
319 void ME_CommitUndo(ME_TextEditor *editor);
320 void ME_ContinueCoalescingTransaction(ME_TextEditor *editor);
321 void ME_CommitCoalescingUndo(ME_TextEditor *editor);
322 BOOL ME_Undo(ME_TextEditor *editor);
323 BOOL ME_Redo(ME_TextEditor *editor);
324 void ME_EmptyUndoStack(ME_TextEditor *editor);
327 LRESULT ME_StreamOutRange(ME_TextEditor *editor, DWORD dwFormat, int nStart, int nTo, EDITSTREAM *stream);
328 LRESULT ME_StreamOut(ME_TextEditor *editor, DWORD dwFormat, EDITSTREAM *stream);
331 HRESULT ME_GetDataObject(ME_TextEditor *editor, const CHARRANGE *lpchrg, LPDATAOBJECT *lplpdataobj);