Fixed DLL_PROCESS_DETACH handler to actually unregister the window
[wine] / dlls / riched20 / editor.h
1 /*
2  * RichEdit - prototypes for functions and macro definitions
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 #include "editstr.h"
22
23 #define ALLOC_OBJ(type) (type *)HeapAlloc(me_heap, 0, sizeof(type))
24 #define ALLOC_N_OBJ(type, count) (type *)HeapAlloc(me_heap, 0, count*sizeof(type))
25 #define FREE_OBJ(ptr) HeapFree(me_heap, 0, ptr)
26
27 /* style.c */
28 ME_Style *ME_MakeStyle(CHARFORMAT2W *style);
29 void ME_AddRefStyle(ME_Style *item);
30 void ME_ReleaseStyle(ME_Style *item);
31 ME_Style *ME_GetInsertStyle(ME_TextEditor *editor, int nCursor);
32 ME_Style *ME_ApplyStyle(ME_Style *sSrc, CHARFORMAT2W *style);
33 void ME_PrepareStyle(ME_Context *c, ME_Style *s);
34 void ME_PrepareStyleFromDC(ME_Style *s, HDC hDC, int nSequence);
35 void ME_UnprepareStyle(ME_Style *s);
36 HFONT ME_SelectStyleFont(HDC hDC, ME_Style *s);
37 void ME_InitCharFormat2W(CHARFORMAT2W *pFmt);
38 void ME_SaveTempStyle(ME_TextEditor *editor);
39 void ME_ClearTempStyle(ME_TextEditor *editor);
40 void ME_DumpStyleToBuf(CHARFORMAT2W *pFmt, char buf[2048]);
41 void ME_DumpStyle(ME_Style *s);
42 CHARFORMAT2W *ME_ToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from);
43 void ME_CopyToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from);
44 CHARFORMAT2W *ME_ToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from);
45 void ME_CopyToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from);
46 void ME_CopyCharFormat(CHARFORMAT2W *pDest, CHARFORMAT2W *pSrc); /* only works with 2W structs */
47
48 /* list.c */
49 void ME_InsertBefore(ME_DisplayItem *diWhere, ME_DisplayItem *diWhat);
50 void ME_Remove(ME_DisplayItem *diWhere);
51 ME_DisplayItem *ME_FindItemBack(ME_DisplayItem *di, ME_DIType nTypeOrClass);
52 ME_DisplayItem *ME_FindItemFwd(ME_DisplayItem *di, ME_DIType nTypeOrClass);
53 ME_DisplayItem *ME_FindItemBackOrHere(ME_DisplayItem *di, ME_DIType nTypeOrClass);
54 ME_DisplayItem *ME_FindItemFwdOrHere(ME_DisplayItem *di, ME_DIType nTypeOrClass);
55 BOOL ME_DITypesEqual(ME_DIType type, ME_DIType nTypeOrClass);
56 ME_DisplayItem *ME_MakeDI(ME_DIType type);
57 void ME_DestroyDisplayItem(ME_DisplayItem *item);
58 void ME_DumpDocument(ME_TextBuffer *buffer);
59 const char *ME_GetDITypeName(ME_DIType type);
60
61 /* string.c */
62 int ME_GetOptimalBuffer(int nLen);
63 ME_String *ME_MakeString(LPCWSTR szText);
64 ME_String *ME_MakeStringN(LPCWSTR szText, int nMaxChars);
65 ME_String *ME_StrDup(ME_String *s);
66 void ME_DestroyString(ME_String *s);
67 void ME_AppendString(ME_String *s1, ME_String *s2);
68 ME_String *ME_ConcatString(ME_String *s1, ME_String *s2);
69 ME_String *ME_VSplitString(ME_String *orig, int nVPos);
70 int ME_IsWhitespaces(ME_String *s);
71 int ME_IsSplitable(ME_String *s);
72 /* int ME_CalcSkipChars(ME_String *s); */
73 int ME_StrLen(ME_String *s);
74 int ME_StrVLen(ME_String *s);
75 int ME_FindNonWhitespaceV(ME_String *s, int nVChar);
76 int ME_FindWhitespaceV(ME_String *s, int nVChar);
77 int ME_GetCharFwd(ME_String *s, int nPos); /* get char starting from start */
78 int ME_GetCharBack(ME_String *s, int nPos); /* get char starting from \0  */
79 int ME_StrRelPos(ME_String *s, int nVChar, int *pRelChars);
80 int ME_StrRelPos2(ME_String *s, int nVChar, int nRelChars);
81 int ME_VPosToPos(ME_String *s, int nVPos);
82 int ME_PosToVPos(ME_String *s, int nPos);
83 void ME_StrDeleteV(ME_String *s, int nVChar, int nChars);
84 /* smart helpers for A<->W conversions, they reserve/free memory and call MultiByte<->WideChar functions */
85 LPWSTR ME_ToUnicode(HWND hWnd, LPVOID psz);
86 void ME_EndToUnicode(HWND hWnd, LPVOID psz);
87 LPSTR ME_ToAnsi(HWND hWnd, LPVOID psz);
88 void ME_EndToAnsi(HWND hWnd, LPVOID psz);
89
90
91 /* note: those two really return the first matching offset (starting from EOS)+1 
92  * in other words, an offset of the first trailing white/black */
93 int ME_ReverseFindNonWhitespaceV(ME_String *s, int nVChar);
94 int ME_ReverseFindWhitespaceV(ME_String *s, int nVChar);
95
96 /* row.c */
97 ME_DisplayItem *ME_FindRowStart(ME_Context *c, ME_DisplayItem *run, int nRelPos);
98 ME_DisplayItem *ME_RowStart(ME_DisplayItem *item);
99 ME_DisplayItem *ME_RowEnd(ME_DisplayItem *item);
100 void ME_RenumberParagraphs(ME_DisplayItem *item); /* TODO */
101
102 /* run.c */
103 ME_DisplayItem *ME_MakeRun(ME_Style *s, ME_String *strData, int nFlags);
104 /* note: ME_InsertRun inserts a copy of the specified run - so you need to destroy the original */
105 ME_DisplayItem *ME_InsertRun(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem *pItem);
106 void ME_CheckCharOffsets(ME_TextEditor *editor);
107 void ME_PropagateCharOffset(ME_DisplayItem *p, int shift);
108 void ME_GetGraphicsSize(ME_TextEditor *editor, ME_Run *run, SIZE *pSize);
109 int ME_CharFromPoint(ME_TextEditor *editor, int cx, ME_Run *run);
110 /* this one accounts for 1/2 char tolerance */
111 int ME_CharFromPointCursor(ME_TextEditor *editor, int cx, ME_Run *run);
112 int ME_PointFromChar(ME_TextEditor *editor, ME_Run *pRun, int nOffset);
113 int ME_GetLastSplittablePlace(ME_Context *c, ME_Run *run);
114 int ME_CanJoinRuns(ME_Run *run1, ME_Run *run2);
115 void ME_JoinRuns(ME_TextEditor *editor, ME_DisplayItem *p);
116 ME_DisplayItem *ME_SplitRun(ME_Context *c, ME_DisplayItem *item, int nChar);
117 ME_DisplayItem *ME_SplitRunSimple(ME_TextEditor *editor, ME_DisplayItem *item, int nChar);
118 int ME_FindSplitPoint(ME_Context *c, POINT *pt, ME_Run *run, int desperate);
119 void ME_UpdateRunFlags(ME_TextEditor *editor, ME_Run *run);
120 ME_DisplayItem *ME_SplitFurther(ME_TextEditor *editor, ME_DisplayItem *run);
121 void ME_CalcRunExtent(ME_Context *c, ME_Run *run);
122 SIZE ME_GetRunSize(ME_Context *c, ME_Run *run, int nLen);
123 void ME_CursorFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_Cursor *pCursor);
124 void ME_RunOfsFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem **ppRun, int *pOfs);
125 int ME_CharOfsFromRunOfs(ME_TextEditor *editor, ME_DisplayItem *pRun, int nOfs);
126 void ME_SkipAndPropagateCharOffset(ME_DisplayItem *p, int shift);
127 void ME_SetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
128 void ME_SetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
129 void ME_GetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
130 void ME_GetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
131 void ME_GetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
132 void ME_SetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *mod);
133
134 /* caret.c */
135 void ME_SetSelection(ME_TextEditor *editor, int from, int to);
136 void ME_HideCaret(ME_TextEditor *ed);
137 void ME_ShowCaret(ME_TextEditor *ed);
138 void ME_MoveCaret(ME_TextEditor *ed);
139 int ME_FindPixelPos(ME_TextEditor *editor, int x, int y, ME_Cursor *result, BOOL *is_eol);
140 void ME_LButtonDown(ME_TextEditor *editor, int x, int y);
141 void ME_MouseMove(ME_TextEditor *editor, int x, int y);
142 void ME_DeleteTextAtCursor(ME_TextEditor *editor, int nCursor, int nChars);
143 void ME_InsertTextFromCursor(ME_TextEditor *editor, int nCursor, 
144                              const WCHAR *str, int len, ME_Style *style);
145 void ME_SetCharFormat(ME_TextEditor *editor, int nOfs, int nChars, CHARFORMAT2W *pFmt);
146 BOOL ME_ArrowKey(ME_TextEditor *ed, int nVKey, int nCtrl);
147
148 void ME_InitContext(ME_Context *c, ME_TextEditor *editor, HDC hDC);
149 void ME_DestroyContext(ME_Context *c);
150 ME_Style *GetInsertStyle(ME_TextEditor *editor, int nCursor);
151 void ME_MustBeWrapped(ME_Context *c, ME_DisplayItem *para);
152 int ME_GetCursorOfs(ME_TextEditor *editor, int nCursor);
153 void ME_GetSelection(ME_TextEditor *editor, int *from, int *to);
154 int ME_CountParagraphsBetween(ME_TextEditor *editor, int from, int to);
155 BOOL ME_IsSelection(ME_TextEditor *editor);
156 void ME_DeleteSelection(ME_TextEditor *editor);
157 void ME_SendSelChange(ME_TextEditor *editor);
158 void ME_InsertGraphicsFromCursor(ME_TextEditor *editor, int nCursor);
159 void ME_InternalDeleteText(ME_TextEditor *editor, int nOfs, int nChars);
160 int ME_GetTextLength(ME_TextEditor *editor);
161
162 /* wrap.c */
163 void ME_PrepareParagraphForWrapping(ME_Context *c, ME_DisplayItem *tp);
164 ME_DisplayItem *ME_MakeRow(int height, int baseline, int width);
165 void ME_InsertRowStart(ME_WrapContext *wc, ME_DisplayItem *pEnd);
166 void ME_WrapTextParagraph(ME_Context *c, ME_DisplayItem *tp);
167
168 /* para.c */
169 ME_DisplayItem *ME_GetParagraph(ME_DisplayItem *run); 
170 void ME_MakeFirstParagraph(HDC hDC, ME_TextBuffer *editor);
171 ME_DisplayItem *ME_SplitParagraph(ME_TextEditor *editor, ME_DisplayItem *rp, ME_Style *style);
172 ME_DisplayItem *ME_JoinParagraphs(ME_TextEditor *editor, ME_DisplayItem *tp);
173 void ME_DumpParaStyle(ME_Paragraph *s);
174 void ME_DumpParaStyleToBuf(PARAFORMAT2 *pFmt, char buf[2048]);
175 void ME_SetParaFormat(ME_TextEditor *editor, ME_DisplayItem *para, PARAFORMAT2 *pFmt);
176 void ME_SetSelectionParaFormat(ME_TextEditor *editor, PARAFORMAT2 *pFmt);
177 void ME_GetParaFormat(ME_TextEditor *editor, ME_DisplayItem *para, PARAFORMAT2 *pFmt);
178 void ME_GetSelectionParaFormat(ME_TextEditor *editor, PARAFORMAT2 *pFmt);
179 /* marks from first up to (but not including) last */
180 void ME_MarkForWrapping(ME_TextEditor *editor, ME_DisplayItem *first, ME_DisplayItem *last);
181 void ME_MarkAllForWrapping(ME_TextEditor *editor);
182
183 /* paint.c */
184 void ME_PaintContent(ME_TextEditor *editor, HDC hDC, BOOL bOnlyNew);
185 void ME_Repaint(ME_TextEditor *editor);
186 void ME_UpdateRepaint(ME_TextEditor *editor);
187 void ME_DrawParagraph(ME_Context *c, ME_DisplayItem *paragraph);
188 void ME_UpdateScrollBar(ME_TextEditor *editor, int ypos);
189 int ME_GetScrollPos(ME_TextEditor *editor);
190 void ME_EnsureVisible(ME_TextEditor *editor, ME_DisplayItem *pRun);
191 COLORREF ME_GetBackColor(ME_TextEditor *editor);
192
193 /* wintest.c */
194
195 /* editor.c */
196 void ME_RegisterEditorClass();
197 ME_TextEditor *ME_MakeEditor(HWND hWnd);
198 void ME_DestroyEditor(ME_TextEditor *editor);
199 void ME_SendOldNotify(ME_TextEditor *editor, int nCode);
200 ME_UndoItem *ME_AddUndoItem(ME_TextEditor *editor, ME_DIType type, ME_DisplayItem *di);
201 void ME_CommitUndo(ME_TextEditor *editor);
202 void ME_Undo(ME_TextEditor *editor);
203 void ME_Redo(ME_TextEditor *editor);
204 void ME_EmptyUndoStack(ME_TextEditor *editor);
205 int ME_GetTextW(ME_TextEditor *editor, WCHAR *buffer, int nStart, int nChars, BOOL bCRLF);
206
207 extern int me_debug;
208 extern HANDLE me_heap;
209 extern void DoWrap(ME_TextEditor *editor);