dlls/riched20/editstr.h

   1 /*
   2  * RichEdit - structures and constant
   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 #ifndef __EDITSTR_H
  22 #define __EDITSTR_H
  23
  24 #include <assert.h>
  25 #include <stdarg.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <limits.h>
  29
  30 #define COBJMACROS
  31
  32 #include <windef.h>
  33 #include <winbase.h>
  34 #include <winnls.h>
  35 #include <winnt.h>
  36 #include <wingdi.h>
  37 #include <winuser.h>
  38 #include <richedit.h>
  39 #include <commctrl.h>
  40 #include <ole2.h>
  41 #include <richole.h>
  42 #include "imm.h"
  43 #include <textserv.h>
  44 #include <tom.h>
  45 #include "usp10.h"
  46
  47 #include "wine/asm.h"
  48 #include "wine/debug.h"
  49 #include "wine/heap.h"
  50 #include "wine/list.h"
  51 #include "wine/rbtree.h"
  52
  53 typedef struct tagME_String
  54 {
  55   WCHAR *szData;
  56   int nLen, nBuffer;
  57   void (*free)(struct tagME_String *);
  58 } ME_String;
  59
  60 typedef struct tagME_FontCacheItem
  61 {
  62   LOGFONTW lfSpecs;
  63   HFONT hFont;
  64   int nRefs;
  65   int nAge;
  66 } ME_FontCacheItem;
  67
  68 #define HFONT_CACHE_SIZE 10
  69
  70 typedef struct tagME_Style
  71 {
  72   CHARFORMAT2W fmt;
  73
  74   ME_FontCacheItem *font_cache; /* cached font for the style */
  75   TEXTMETRICW tm; /* cached font metrics for the style */
  76   int nRefs; /* reference count */
  77   SCRIPT_CACHE script_cache;
  78   struct list entry;
  79 } ME_Style;
  80
  81 typedef enum {
  82   diInvalid,
  83   diTextStart, /* start of the text buffer */
  84   diParagraph, /* paragraph start */
  85   diCell, /* cell start */
  86   diRun, /* run (sequence of chars with the same character format) */
  87   diStartRow, /* start of the row (line of text on the screen) */
  88   diTextEnd, /* end of the text buffer */
  89
  90   /********************* these below are meant for finding only *********************/
  91   diStartRowOrParagraph, /* 7 */
  92   diStartRowOrParagraphOrEnd,
  93   diRunOrParagraph,
  94   diRunOrStartRow,
  95   diParagraphOrEnd,
  96   diRunOrParagraphOrEnd, /* 12 */
  97 } ME_DIType;
  98
  99 #define SELECTIONBAR_WIDTH 8
 100
 101 /******************************** run flags *************************/
 102 #define MERF_STYLEFLAGS 0x0FFF
 103 /* run contains non-text content, which has its own rules for wrapping, sizing etc */
 104 #define MERF_GRAPHICS   0x001
 105 /* run is a tab (or, in future, any kind of content whose size is dependent on run position) */
 106 #define MERF_TAB        0x002
 107 /* run is a cell boundary */
 108 #define MERF_ENDCELL    0x004 /* v4.1 */
 109
 110 #define MERF_NONTEXT (MERF_GRAPHICS | MERF_TAB | MERF_ENDCELL)
 111
 112 /* run is splittable (contains white spaces in the middle or end) */
 113 #define MERF_SPLITTABLE 0x001000
 114 /* run starts with whitespaces */
 115 #define MERF_STARTWHITE 0x002000
 116 /* run ends with whitespaces */
 117 #define MERF_ENDWHITE   0x004000
 118 /* run is completely made of whitespaces */
 119 #define MERF_WHITESPACE 0x008000
 120 /* the "end of paragraph" run, contains 1 character */
 121 #define MERF_ENDPARA    0x100000
 122 /* forcing the "end of row" run, contains 1 character */
 123 #define MERF_ENDROW     0x200000
 124 /* run is hidden */
 125 #define MERF_HIDDEN     0x400000
 126 /* start of a table row has an empty paragraph that should be skipped over. */
 127 #define MERF_TABLESTART 0x800000 /* v4.1 */
 128
 129 /* runs with any of these flags set cannot be joined */
 130 #define MERF_NOJOIN (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 131 /* runs that don't contain real text */
 132 #define MERF_NOTEXT (MERF_GRAPHICS|MERF_TAB|MERF_ENDPARA|MERF_ENDROW)
 133
 134 /* those flags are kept when the row is split */
 135 #define MERF_SPLITMASK (~(0))
 136
 137 /******************************** para flags *************************/
 138
 139 /* this paragraph was already wrapped and hasn't changed, every change resets that flag */
 140 #define MEPF_REWRAP   0x01
 141 /* v4.1 */
 142 #define MEPF_CELL     0x04 /* The paragraph is nested in a cell */
 143 #define MEPF_ROWSTART 0x08 /* Hidden empty paragraph at the start of the row */
 144 #define MEPF_ROWEND   0x10 /* Visible empty paragraph at the end of the row */
 145 #define MEPF_COMPLEX  0x20 /* Use uniscribe */
 146
 147 /******************************** structures *************************/
 148
 149 struct tagME_DisplayItem;
 150
 151 struct re_object
 152 {
 153   struct list entry;
 154   REOBJECT obj;
 155 };
 156
 157 typedef struct tagME_Run
 158 {
 159   ME_Style *style;
 160   struct tagME_Paragraph *para; /* ptr to the run's paragraph */
 161   int nCharOfs; /* relative to para's offset */
 162   int len;      /* length of run's text */
 163   int nWidth; /* width of full run, width of leading&trailing ws */
 164   int nFlags;
 165   int nAscent, nDescent; /* pixels above/below baseline */
 166   POINT pt; /* relative to para's position */
 167   struct re_object *reobj; /* FIXME: should be a union with strText (at least) */
 168
 169   SCRIPT_ANALYSIS script_analysis;
 170   int num_glyphs, max_glyphs;
 171   WORD *glyphs;
 172   SCRIPT_VISATTR *vis_attrs;
 173   int *advances;
 174   GOFFSET *offsets;
 175   int max_clusters;
 176   WORD *clusters;
 177 } ME_Run;
 178
 179 typedef struct tagME_Border
 180 {
 181   int width;
 182   COLORREF colorRef;
 183 } ME_Border;
 184
 185 typedef struct tagME_BorderRect
 186 {
 187   ME_Border top;
 188   ME_Border left;
 189   ME_Border bottom;
 190   ME_Border right;
 191 } ME_BorderRect;
 192
 193 struct para_num
 194 {
 195     ME_Style *style;
 196     ME_String *text;
 197     INT width;
 198     POINT pt;
 199 };
 200
 201 typedef struct tagME_Paragraph
 202 {
 203   PARAFORMAT2 fmt;
 204   ME_String *text;
 205
 206   struct tagME_Cell *cell; /* v4.1 */
 207   ME_BorderRect border;
 208
 209   int nCharOfs;
 210   int nFlags;
 211   POINT pt;
 212   int nHeight, nWidth;
 213   int nRows;
 214   struct para_num para_num;
 215   ME_Run *eop_run; /* ptr to the end-of-para run */
 216   struct tagME_DisplayItem *prev_para, *next_para;
 217   struct wine_rb_entry marked_entry;
 218 } ME_Paragraph;
 219
 220 typedef struct tagME_Cell /* v4.1 */
 221 {
 222   int nNestingLevel; /* 0 for normal cells, and greater for nested cells */
 223   int nRightBoundary;
 224   ME_BorderRect border;
 225   POINT pt;
 226   int nHeight, nWidth;
 227   int yTextOffset; /* The text offset is caused by the largest top border. */
 228   struct tagME_Cell *prev_cell, *next_cell, *parent_cell;
 229 } ME_Cell;
 230
 231 typedef struct tagME_Row
 232 {
 233   int nHeight;
 234   int nBaseline;
 235   int nWidth;
 236   int nLMargin;
 237   int nRMargin;
 238   POINT pt;
 239 } ME_Row;
 240
 241 /* the display item list layout is like this:
 242  * - the document consists of paragraphs
 243  * - each paragraph contains at least one run, the last run in the paragraph
 244  *   is an end-of-paragraph run
 245  * - each formatted paragraph contains at least one row, which corresponds
 246  *   to a screen line (that's why there are no rows in an unformatted
 247  *   paragraph
 248  * - the paragraphs contain "shortcut" pointers to the previous and the next
 249  *   paragraph, that makes iteration over paragraphs faster
 250  * - the list starts with diTextStart and ends with diTextEnd
 251  */
 252
 253 typedef struct tagME_DisplayItem
 254 {
 255   ME_DIType type;
 256   struct tagME_DisplayItem *prev, *next;
 257   union {
 258     ME_Run run;
 259     ME_Row row;
 260     ME_Cell cell;
 261     ME_Paragraph para;
 262   } member;
 263 } ME_DisplayItem;
 264
 265 typedef struct tagME_TextBuffer
 266 {
 267   ME_DisplayItem *pFirst, *pLast;
 268   ME_Style *pCharStyle;
 269   ME_Style *pDefaultStyle;
 270 } ME_TextBuffer;
 271
 272 typedef struct tagME_Cursor
 273 {
 274   ME_Paragraph *para;
 275   ME_Run *run;
 276   int nOffset;
 277 } ME_Cursor;
 278
 279 typedef enum {
 280   umAddToUndo,
 281   umAddToRedo,
 282   umIgnore,
 283   umAddBackToUndo
 284 } ME_UndoMode;
 285
 286 enum undo_type
 287 {
 288     undo_insert_run,
 289     undo_delete_run,
 290     undo_join_paras,
 291     undo_split_para,
 292     undo_set_para_fmt,
 293     undo_set_char_fmt,
 294     undo_end_transaction,          /* marks the end of a group of changes for undo */
 295     undo_potential_end_transaction /* allows grouping typed chars for undo */
 296 };
 297
 298 struct insert_run_item
 299 {
 300     int pos, len;
 301     WCHAR *str;
 302     ME_Style *style;
 303     DWORD flags;
 304 };
 305
 306 struct delete_run_item
 307 {
 308     int pos, len;
 309 };
 310
 311 struct join_paras_item
 312 {
 313     int pos;
 314 };
 315
 316 struct split_para_item
 317 {
 318     int pos;
 319     PARAFORMAT2 fmt;
 320     ME_BorderRect border;
 321     ME_String *eol_str;
 322     DWORD flags;
 323     ME_BorderRect cell_border;
 324     int cell_right_boundary;
 325 };
 326
 327 struct set_para_fmt_item
 328 {
 329     int pos;
 330     PARAFORMAT2 fmt;
 331     ME_BorderRect border;
 332 };
 333
 334 struct set_char_fmt_item
 335 {
 336     int pos, len;
 337     CHARFORMAT2W fmt;
 338 };
 339
 340 struct undo_item
 341 {
 342     struct list entry;
 343     enum undo_type type;
 344     union
 345     {
 346         struct insert_run_item insert_run;
 347         struct delete_run_item delete_run;
 348         struct join_paras_item join_paras;
 349         struct split_para_item split_para;
 350         struct set_para_fmt_item set_para_fmt;
 351         struct set_char_fmt_item set_char_fmt;
 352     } u;
 353 };
 354
 355 typedef enum {
 356   stPosition = 0,
 357   stWord,
 358   stLine,
 359   stParagraph,
 360   stDocument
 361 } ME_SelectionType;
 362
 363 typedef struct tagME_FontTableItem {
 364   BYTE bCharSet;
 365   WCHAR *szFaceName;
 366 } ME_FontTableItem;
 367
 368
 369 #define STREAMIN_BUFFER_SIZE 4096 /* M$ compatibility */
 370
 371 struct tagME_InStream {
 372   EDITSTREAM *editstream;
 373   DWORD dwSize;
 374   DWORD dwUsed;
 375   char buffer[STREAMIN_BUFFER_SIZE];
 376 };
 377 typedef struct tagME_InStream ME_InStream;
 378
 379 typedef struct tagME_TextEditor
 380 {
 381   ITextHost2 *texthost;
 382   unsigned int bEmulateVersion10 : 1;
 383   unsigned int in_place_active : 1;
 384   unsigned int have_texthost2 : 1;
 385   ME_TextBuffer *pBuffer;
 386   ME_Cursor *pCursors;
 387   DWORD props;
 388   DWORD scrollbars;
 389   int nCursors;
 390   SIZE sizeWindow;
 391   int nTotalLength, nLastTotalLength;
 392   int nTotalWidth, nLastTotalWidth;
 393   int nAvailWidth; /* 0 = wrap to client area, else wrap width in twips */
 394   int nUDArrowX;
 395   int total_rows;
 396   int nEventMask;
 397   int nModifyStep;
 398   struct list undo_stack;
 399   struct list redo_stack;
 400   int nUndoStackSize;
 401   int nUndoLimit;
 402   ME_UndoMode nUndoMode;
 403   int nParagraphs;
 404   int nLastSelStart, nLastSelEnd;
 405   ME_Paragraph *last_sel_start_para, *last_sel_end_para;
 406   ME_FontCacheItem pFontCache[HFONT_CACHE_SIZE];
 407   int nZoomNumerator, nZoomDenominator;
 408   RECT rcFormat;
 409   BOOL bWordWrap;
 410   int nTextLimit;
 411   EDITWORDBREAKPROCW pfnWordBreak;
 412   IRichEditOle *richole;
 413   LPRICHEDITOLECALLBACK lpOleCallback;
 414   /*TEXTMODE variable; contains only one of each of the following options:
 415    *TM_RICHTEXT or TM_PLAINTEXT
 416    *TM_SINGLELEVELUNDO or TM_MULTILEVELUNDO
 417    *TM_SINGLECODEPAGE or TM_MULTICODEPAGE*/
 418   int mode;
 419   BOOL bHideSelection;
 420   BOOL AutoURLDetect_bEnable;
 421   WCHAR password_char;
 422   BOOL bHaveFocus;
 423   /*for IME */
 424   int imeStartIndex;
 425   DWORD selofs; /* The size of the selection bar on the left side of control */
 426   ME_SelectionType nSelectionType;
 427
 428   /* Track previous notified selection */
 429   CHARRANGE notified_cr;
 430
 431   /* Cache previously set scrollbar info */
 432   SCROLLINFO vert_si, horz_si;
 433   unsigned int vert_sb_enabled : 1;
 434   unsigned int horz_sb_enabled : 1;
 435
 436   int caret_height;
 437   BOOL caret_hidden;
 438   BOOL bMouseCaptured;
 439   int wheel_remain;
 440   TXTBACKSTYLE back_style;
 441   struct list style_list;
 442   struct list reobj_list;
 443   struct wine_rb_tree marked_paras;
 444 } ME_TextEditor;
 445
 446 typedef struct tagME_Context
 447 {
 448   HDC hDC;
 449   POINT pt;
 450   RECT rcView;
 451   SIZE dpi;
 452   int nAvailWidth;
 453   ME_Style *current_style;
 454   HFONT orig_font;
 455
 456   /* those are valid inside ME_WrapTextParagraph and related */
 457   ME_TextEditor *editor;
 458 } ME_Context;
 459
 460 struct text_selection
 461 {
 462     ITextSelection ITextSelection_iface;
 463     LONG ref;
 464
 465     struct text_services *services;
 466 };
 467
 468 struct text_services
 469 {
 470     IUnknown IUnknown_inner;
 471     ITextServices ITextServices_iface;
 472     IRichEditOle IRichEditOle_iface;
 473     ITextDocument2Old ITextDocument2Old_iface;
 474     IUnknown *outer_unk;
 475     LONG ref;
 476     ME_TextEditor *editor;
 477     struct text_selection *text_selection;
 478     struct list rangelist;
 479     struct list clientsites;
 480     char spare[256]; /* for bug #12179 */
 481 };
 482
 483 #endif