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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include "editstr.h"
  22 #include "wine/unicode.h"
  23
  24 struct _RTF_Info;
  25
  26 extern HANDLE me_heap;
  27
  28 static inline void * __WINE_ALLOC_SIZE(1) heap_alloc( size_t len )
  29 {
  30     return HeapAlloc( me_heap, 0, len );
  31 }
  32
  33 static inline BOOL heap_free( void *ptr )
  34 {
  35     return HeapFree( me_heap, 0, ptr );
  36 }
  37
  38 static inline void * __WINE_ALLOC_SIZE(2) heap_realloc( void *ptr, size_t len )
  39 {
  40     return HeapReAlloc( me_heap, 0, ptr, len );
  41 }
  42
  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)
  46
  47 #define RUN_IS_HIDDEN(run) ((run)->style->fmt.dwMask & CFM_HIDDEN \
  48                              && (run)->style->fmt.dwEffects & CFE_HIDDEN)
  49
  50 #define InitFormatEtc(fe, cf, med) \
  51         {\
  52         (fe).cfFormat=cf;\
  53         (fe).dwAspect=DVASPECT_CONTENT;\
  54         (fe).ptd=NULL;\
  55         (fe).tymed=med;\
  56         (fe).lindex=-1;\
  57         };
  58
  59 /* style.c */
  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_CopyToCF2W(CHARFORMAT2W *to, CHARFORMAT2W *from);
  74 CHARFORMAT2W *ME_ToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from);
  75 void ME_CopyToCFAny(CHARFORMAT2W *to, CHARFORMAT2W *from);
  76 void ME_CopyCharFormat(CHARFORMAT2W *pDest, const CHARFORMAT2W *pSrc); /* only works with 2W structs */
  77 void ME_CharFormatFromLogFont(HDC hDC, const LOGFONTW *lf, CHARFORMAT2W *fmt); /* ditto */
  78
  79 /* list.c */
  80 void ME_InsertBefore(ME_DisplayItem *diWhere, ME_DisplayItem *diWhat);
  81 void ME_Remove(ME_DisplayItem *diWhere);
  82 ME_DisplayItem *ME_FindItemBack(ME_DisplayItem *di, ME_DIType nTypeOrClass);
  83 ME_DisplayItem *ME_FindItemFwd(ME_DisplayItem *di, ME_DIType nTypeOrClass);
  84 ME_DisplayItem *ME_FindItemBackOrHere(ME_DisplayItem *di, ME_DIType nTypeOrClass);
  85 ME_DisplayItem *ME_FindItemFwdOrHere(ME_DisplayItem *di, ME_DIType nTypeOrClass);
  86 ME_DisplayItem *ME_MakeDI(ME_DIType type);
  87 void ME_DestroyDisplayItem(ME_DisplayItem *item);
  88 void ME_DumpDocument(ME_TextBuffer *buffer);
  89 const char *ME_GetDITypeName(ME_DIType type);
  90
  91 /* string.c */
  92 int ME_GetOptimalBuffer(int nLen);
  93 ME_String *ME_MakeString(LPCWSTR szText);
  94 ME_String *ME_MakeStringN(LPCWSTR szText, int nMaxChars);
  95 ME_String *ME_MakeStringR(WCHAR cRepeat, int nMaxChars);
  96 ME_String *ME_MakeStringB(int nMaxChars);
  97 ME_String *ME_StrDup(const ME_String *s);
  98 void ME_DestroyString(ME_String *s);
  99 void ME_AppendString(ME_String *s1, const ME_String *s2);
 100 ME_String *ME_ConcatString(const ME_String *s1, const ME_String *s2);
 101 ME_String *ME_VSplitString(ME_String *orig, int nVPos);
 102 int ME_IsWhitespaces(const ME_String *s);
 103 int ME_IsSplitable(const ME_String *s);
 104 /* int ME_CalcSkipChars(ME_String *s); */
 105 int ME_StrLen(const ME_String *s);
 106 int ME_StrVLen(const ME_String *s);
 107 int ME_FindNonWhitespaceV(const ME_String *s, int nVChar);
 108 int ME_FindWhitespaceV(ME_String *s, int nVChar);
 109 int ME_CallWordBreakProc(ME_TextEditor *editor, ME_String *str, INT start, INT code);
 110 int ME_GetCharFwd(const ME_String *s, int nPos); /* get char starting from start */
 111 int ME_GetCharBack(const ME_String *s, int nPos); /* get char starting from \0  */
 112 int ME_StrRelPos(const ME_String *s, int nVChar, int *pRelChars);
 113 int ME_StrRelPos2(const ME_String *s, int nVChar, int nRelChars);
 114 int ME_VPosToPos(ME_String *s, int nVPos);
 115 int ME_PosToVPos(const ME_String *s, int nPos);
 116 void ME_StrDeleteV(ME_String *s, int nVChar, int nChars);
 117 /* smart helpers for A<->W conversions, they reserve/free memory and call MultiByte<->WideChar functions */
 118 LPWSTR ME_ToUnicode(BOOL unicode, LPVOID psz);
 119 void ME_EndToUnicode(BOOL unicode, LPVOID psz);
 120
 121 static inline int ME_IsWSpace(WCHAR ch)
 122 {
 123   return ch > '\0' && ch <= ' ';
 124 }
 125
 126 static inline int ME_CharCompare(WCHAR a, WCHAR b, int caseSensitive)
 127 {
 128   return caseSensitive ? (a == b) : (toupperW(a) == toupperW(b));
 129 }
 130
 131 /* note: those two really return the first matching offset (starting from EOS)+1
 132  * in other words, an offset of the first trailing white/black */
 133 int ME_ReverseFindNonWhitespaceV(const ME_String *s, int nVChar);
 134 int ME_ReverseFindWhitespaceV(const ME_String *s, int nVChar);
 135
 136 /* row.c */
 137 ME_DisplayItem *ME_FindRowStart(ME_Context *c, ME_DisplayItem *run, int nRelPos);
 138 ME_DisplayItem *ME_RowStart(ME_DisplayItem *item);
 139 /* ME_DisplayItem *ME_RowEnd(ME_DisplayItem *item); */
 140 void ME_RenumberParagraphs(ME_DisplayItem *item); /* TODO */
 141 ME_DisplayItem *ME_FindRowWithNumber(ME_TextEditor *editor, int nRow);
 142 int ME_RowNumberFromCharOfs(ME_TextEditor *editor, int nOfs);
 143
 144 /* run.c */
 145 ME_DisplayItem *ME_MakeRun(ME_Style *s, ME_String *strData, int nFlags);
 146 /* note: ME_InsertRun inserts a copy of the specified run - so you need to destroy the original */
 147 ME_DisplayItem *ME_InsertRun(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem *pItem);
 148 ME_DisplayItem *ME_InsertRunAtCursor(ME_TextEditor *editor, ME_Cursor *cursor,
 149                                      ME_Style *style, const WCHAR *str, int len, int flags);
 150 void ME_CheckCharOffsets(ME_TextEditor *editor);
 151 void ME_PropagateCharOffset(ME_DisplayItem *p, int shift);
 152 int ME_CharFromPoint(ME_Context *c, int cx, ME_Run *run);
 153 /* this one accounts for 1/2 char tolerance */
 154 int ME_CharFromPointCursor(ME_TextEditor *editor, int cx, ME_Run *run);
 155 int ME_PointFromChar(ME_TextEditor *editor, ME_Run *pRun, int nOffset);
 156 int ME_GetLastSplittablePlace(ME_Context *c, ME_Run *run);
 157 int ME_CanJoinRuns(const ME_Run *run1, const ME_Run *run2);
 158 void ME_JoinRuns(ME_TextEditor *editor, ME_DisplayItem *p);
 159 ME_DisplayItem *ME_SplitRun(ME_WrapContext *wc, ME_DisplayItem *item, int nChar);
 160 ME_DisplayItem *ME_SplitRunSimple(ME_TextEditor *editor, ME_DisplayItem *item, int nChar);
 161 int ME_FindSplitPoint(ME_Context *c, POINT *pt, ME_Run *run, int desperate);
 162 void ME_UpdateRunFlags(ME_TextEditor *editor, ME_Run *run);
 163 ME_DisplayItem *ME_SplitFurther(ME_TextEditor *editor, ME_DisplayItem *run);
 164 void ME_CalcRunExtent(ME_Context *c, const ME_Paragraph *para, int startx, ME_Run *run);
 165 SIZE ME_GetRunSize(ME_Context *c, const ME_Paragraph *para, ME_Run *run, int nLen, int startx);
 166 void ME_CursorFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_Cursor *pCursor);
 167 void ME_RunOfsFromCharOfs(ME_TextEditor *editor, int nCharOfs, ME_DisplayItem **ppRun, int *pOfs);
 168 int ME_CharOfsFromRunOfs(ME_TextEditor *editor, ME_DisplayItem *pRun, int nOfs);
 169 void ME_SkipAndPropagateCharOffset(ME_DisplayItem *p, int shift);
 170 void ME_SetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
 171 void ME_SetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
 172 void ME_GetCharFormat(ME_TextEditor *editor, int nFrom, int nLen, CHARFORMAT2W *pFmt);
 173 void ME_GetSelectionCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
 174 void ME_GetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *pFmt);
 175 void ME_SetDefaultCharFormat(ME_TextEditor *editor, CHARFORMAT2W *mod);
 176
 177 /* caret.c */
 178 int ME_SetSelection(ME_TextEditor *editor, int from, int to);
 179 void ME_HideCaret(ME_TextEditor *ed);
 180 void ME_ShowCaret(ME_TextEditor *ed);
 181 void ME_MoveCaret(ME_TextEditor *ed);
 182 int ME_CharFromPos(ME_TextEditor *editor, int x, int y, BOOL *isExact);
 183 void ME_LButtonDown(ME_TextEditor *editor, int x, int y, int clickNum);
 184 void ME_MouseMove(ME_TextEditor *editor, int x, int y);
 185 BOOL ME_DeleteTextAtCursor(ME_TextEditor *editor, int nCursor, int nChars);
 186 void ME_InsertTextFromCursor(ME_TextEditor *editor, int nCursor,
 187                              const WCHAR *str, int len, ME_Style *style);
 188 void ME_InsertEndRowFromCursor(ME_TextEditor *editor, int nCursor);
 189 BOOL ME_ArrowKey(ME_TextEditor *ed, int nVKey, BOOL extend, BOOL ctrl);
 190
 191 void ME_MustBeWrapped(ME_Context *c, ME_DisplayItem *para);
 192 void ME_GetCursorCoordinates(ME_TextEditor *editor, ME_Cursor *pCursor,
 193                              int *x, int *y, int *height);
 194 int ME_GetCursorOfs(ME_TextEditor *editor, int nCursor);
 195 void ME_GetSelection(ME_TextEditor *editor, int *from, int *to);
 196 int ME_CountParagraphsBetween(ME_TextEditor *editor, int from, int to);
 197 BOOL ME_IsSelection(ME_TextEditor *editor);
 198 void ME_DeleteSelection(ME_TextEditor *editor);
 199 void ME_SendSelChange(ME_TextEditor *editor);
 200 void ME_InsertOLEFromCursor(ME_TextEditor *editor, const REOBJECT* reo, int nCursor);
 201 BOOL ME_InternalDeleteText(ME_TextEditor *editor, int nOfs, int nChars, BOOL bForce);
 202 int ME_GetTextLength(ME_TextEditor *editor);
 203 int ME_GetTextLengthEx(ME_TextEditor *editor, const GETTEXTLENGTHEX *how);
 204 ME_Style *ME_GetSelectionInsertStyle(ME_TextEditor *editor);
 205
 206 /* context.c */
 207 void ME_InitContext(ME_Context *c, ME_TextEditor *editor, HDC hDC);
 208 void ME_DestroyContext(ME_Context *c, HWND release);
 209
 210 /* wrap.c */
 211 BOOL ME_WrapMarkedParagraphs(ME_TextEditor *editor);
 212 void ME_InvalidateMarkedParagraphs(ME_TextEditor *editor);
 213 void ME_SendRequestResize(ME_TextEditor *editor, BOOL force);
 214
 215 /* para.c */
 216 ME_DisplayItem *ME_GetParagraph(ME_DisplayItem *run);
 217 void ME_GetSelectionParas(ME_TextEditor *editor, ME_DisplayItem **para, ME_DisplayItem **para_end);
 218 void ME_MakeFirstParagraph(ME_TextEditor *editor);
 219 ME_DisplayItem *ME_SplitParagraph(ME_TextEditor *editor, ME_DisplayItem *rp, ME_Style *style, int numCR, int numLF, int paraFlags);
 220 ME_DisplayItem *ME_JoinParagraphs(ME_TextEditor *editor, ME_DisplayItem *tp,
 221                                   BOOL keepFirstParaFormat);
 222 void ME_DumpParaStyle(ME_Paragraph *s);
 223 void ME_DumpParaStyleToBuf(const PARAFORMAT2 *pFmt, char buf[2048]);
 224 BOOL ME_SetSelectionParaFormat(ME_TextEditor *editor, const PARAFORMAT2 *pFmt);
 225 void ME_GetSelectionParaFormat(ME_TextEditor *editor, PARAFORMAT2 *pFmt);
 226 /* marks from first up to (but not including) last */
 227 void ME_MarkForPainting(ME_TextEditor *editor, ME_DisplayItem *first, const ME_DisplayItem *last);
 228 void ME_MarkAllForWrapping(ME_TextEditor *editor);
 229 void ME_SetDefaultParaFormat(PARAFORMAT2 *pFmt);
 230
 231 /* paint.c */
 232 void ME_PaintContent(ME_TextEditor *editor, HDC hDC, BOOL bOnlyNew, const RECT *rcUpdate);
 233 void ME_Repaint(ME_TextEditor *editor);
 234 void ME_RewrapRepaint(ME_TextEditor *editor);
 235 void ME_UpdateRepaint(ME_TextEditor *editor);
 236 void ME_EnsureVisible(ME_TextEditor *editor, ME_Cursor *pCursor);
 237 void ME_InvalidateSelection(ME_TextEditor *editor);
 238 void ME_QueueInvalidateFromCursor(ME_TextEditor *editor, int nCursor);
 239 BOOL ME_SetZoom(ME_TextEditor *editor, int numerator, int denominator);
 240 int  ME_twips2pointsX(ME_Context *c, int x);
 241 int  ME_twips2pointsY(ME_Context *c, int y);
 242
 243 /* scroll functions in paint.c */
 244
 245 void ME_ScrollAbs(ME_TextEditor *editor, int x, int y);
 246 void ME_HScrollAbs(ME_TextEditor *editor, int x);
 247 void ME_VScrollAbs(ME_TextEditor *editor, int y);
 248 void ME_ScrollUp(ME_TextEditor *editor, int cy);
 249 void ME_ScrollDown(ME_TextEditor *editor, int cy);
 250 void ME_ScrollLeft(ME_TextEditor *editor, int cx);
 251 void ME_ScrollRight(ME_TextEditor *editor, int cx);
 252 void ME_UpdateScrollBar(ME_TextEditor *editor);
 253
 254 /* other functions in paint.c */
 255 int  ME_GetParaBorderWidth(ME_TextEditor *editor, int);
 256 int  ME_GetParaLineSpace(ME_Context *c, ME_Paragraph*);
 257
 258 /* richole.c */
 259 LRESULT CreateIRichEditOle(ME_TextEditor *editor, LPVOID *);
 260 void ME_DrawOLE(ME_Context *c, int x, int y, ME_Run* run, ME_Paragraph *para, BOOL selected);
 261 void ME_GetOLEObjectSize(ME_Context *c, ME_Run *run, SIZE *pSize);
 262 void ME_CopyReObject(REOBJECT* dst, const REOBJECT* src);
 263 void ME_DeleteReObject(REOBJECT* reo);
 264
 265 /* editor.c */
 266 void ME_SendOldNotify(ME_TextEditor *editor, int nCode);
 267 int ME_GetTextW(ME_TextEditor *editor, WCHAR *buffer, int nStart, int nChars, BOOL bCRLF);
 268 ME_DisplayItem *ME_FindItemAtOffset(ME_TextEditor *editor, ME_DIType nItemType, int nOffset, int *nItemOffset);
 269 void ME_RTFCharAttrHook(struct _RTF_Info *info);
 270 void ME_RTFParAttrHook(struct _RTF_Info *info);
 271 void ME_RTFTblAttrHook(struct _RTF_Info *info);
 272 void ME_RTFSpecialCharHook(struct _RTF_Info *info);
 273 void ME_StreamInFill(ME_InStream *stream);
 274 extern int me_debug;
 275 extern void DoWrap(ME_TextEditor *editor);
 276
 277 /* table.c */
 278 BOOL ME_IsInTable(ME_DisplayItem *pItem);
 279 ME_DisplayItem *ME_InsertTableRowStartFromCursor(ME_TextEditor *editor);
 280 ME_DisplayItem *ME_InsertTableRowStartAtParagraph(ME_TextEditor *editor,
 281                                                   ME_DisplayItem *para);
 282 ME_DisplayItem *ME_InsertTableCellFromCursor(ME_TextEditor *editor);
 283 ME_DisplayItem *ME_InsertTableRowEndFromCursor(ME_TextEditor *editor);
 284 ME_DisplayItem *ME_GetTableRowEnd(ME_DisplayItem *para);
 285 ME_DisplayItem *ME_GetTableRowStart(ME_DisplayItem *para);
 286 void ME_CheckTablesForCorruption(ME_TextEditor *editor);
 287 void ME_ProtectPartialTableDeletion(ME_TextEditor *editor, int nOfs,int *nChars);
 288 ME_DisplayItem* ME_AppendTableRow(ME_TextEditor *editor, ME_DisplayItem *table_row);
 289 void ME_TabPressedInTable(ME_TextEditor *editor, BOOL bSelectedRow);
 290 void ME_MoveCursorFromTableRowStartParagraph(ME_TextEditor *editor);
 291 struct RTFTable *ME_MakeTableDef(ME_TextEditor *editor);
 292 void ME_InitTableDef(ME_TextEditor *editor, struct RTFTable *tableDef);
 293
 294 /* undo.c */
 295 ME_UndoItem *ME_AddUndoItem(ME_TextEditor *editor, ME_DIType type, const ME_DisplayItem *pdi);
 296 void ME_CommitUndo(ME_TextEditor *editor);
 297 void ME_ContinueCoalescingTransaction(ME_TextEditor *editor);
 298 void ME_CommitCoalescingUndo(ME_TextEditor *editor);
 299 BOOL ME_Undo(ME_TextEditor *editor);
 300 BOOL ME_Redo(ME_TextEditor *editor);
 301 void ME_EmptyUndoStack(ME_TextEditor *editor);
 302
 303 /* writer.c */
 304 LRESULT ME_StreamOutRange(ME_TextEditor *editor, DWORD dwFormat, int nStart, int nTo, EDITSTREAM *stream);
 305 LRESULT ME_StreamOut(ME_TextEditor *editor, DWORD dwFormat, EDITSTREAM *stream);
 306
 307 /* clipboard.c */
 308 HRESULT ME_GetDataObject(ME_TextEditor *editor, const CHARRANGE *lpchrg, LPDATAOBJECT *lplpdataobj);