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