Pileus Git - ~andy/gtk/blob - gtk/gtktextbtree.h

   1 #ifndef GTK_TEXT_BTREE_H
   2 #define GTK_TEXT_BTREE_H
   3
   4 #if 0
   5 #define DEBUG_VALIDATION_AND_SCROLLING
   6 #endif
   7
   8 #ifdef DEBUG_VALIDATION_AND_SCROLLING
   9 #define DV(x) (x)
  10 #else
  11 #define DV(x)
  12 #endif
  13
  14 #include <gtk/gtktextbuffer.h>
  15 #include <gtk/gtktexttag.h>
  16 #include <gtk/gtktextmark.h>
  17 #include <gtk/gtktextchild.h>
  18 #include <gtk/gtktextsegment.h>
  19 #include <gtk/gtktextiter.h>
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif /* __cplusplus */
  24
  25 GtkTextBTree  *_gtk_text_btree_new        (GtkTextTagTable *table,
  26                                            GtkTextBuffer   *buffer);
  27 void           _gtk_text_btree_ref        (GtkTextBTree    *tree);
  28 void           _gtk_text_btree_unref      (GtkTextBTree    *tree);
  29 GtkTextBuffer *_gtk_text_btree_get_buffer (GtkTextBTree    *tree);
  30
  31
  32 guint _gtk_text_btree_get_chars_changed_stamp    (GtkTextBTree *tree);
  33 guint _gtk_text_btree_get_segments_changed_stamp (GtkTextBTree *tree);
  34 void  _gtk_text_btree_segments_changed           (GtkTextBTree *tree);
  35
  36 gboolean _gtk_text_btree_is_end (GtkTextBTree       *tree,
  37                                  GtkTextLine        *line,
  38                                  GtkTextLineSegment *seg,
  39                                  int                 byte_index,
  40                                  int                 char_offset);
  41
  42 /* Indexable segment mutation */
  43
  44 void _gtk_text_btree_delete        (GtkTextIter *start,
  45                                     GtkTextIter *end);
  46 void _gtk_text_btree_insert        (GtkTextIter *iter,
  47                                     const gchar *text,
  48                                     gint         len);
  49 void _gtk_text_btree_insert_pixbuf (GtkTextIter *iter,
  50                                     GdkPixbuf   *pixbuf);
  51
  52 void _gtk_text_btree_insert_child_anchor (GtkTextIter        *iter,
  53                                           GtkTextChildAnchor *anchor);
  54
  55 void _gtk_text_btree_unregister_child_anchor (GtkTextChildAnchor *anchor);
  56
  57 /* View stuff */
  58 GtkTextLine *_gtk_text_btree_find_line_by_y    (GtkTextBTree      *tree,
  59                                                 gpointer           view_id,
  60                                                 gint               ypixel,
  61                                                 gint              *line_top_y);
  62 gint         _gtk_text_btree_find_line_top     (GtkTextBTree      *tree,
  63                                                 GtkTextLine       *line,
  64                                                 gpointer           view_id);
  65 void         _gtk_text_btree_add_view          (GtkTextBTree      *tree,
  66                                                 GtkTextLayout     *layout);
  67 void         _gtk_text_btree_remove_view       (GtkTextBTree      *tree,
  68                                                 gpointer           view_id);
  69 void         _gtk_text_btree_invalidate_region (GtkTextBTree      *tree,
  70                                                 const GtkTextIter *start,
  71                                                 const GtkTextIter *end);
  72 void         _gtk_text_btree_get_view_size     (GtkTextBTree      *tree,
  73                                                 gpointer           view_id,
  74                                                 gint              *width,
  75                                                 gint              *height);
  76 gboolean     _gtk_text_btree_is_valid          (GtkTextBTree      *tree,
  77                                                 gpointer           view_id);
  78 gboolean     _gtk_text_btree_validate          (GtkTextBTree      *tree,
  79                                                 gpointer           view_id,
  80                                                 gint               max_pixels,
  81                                                 gint              *y,
  82                                                 gint              *old_height,
  83                                                 gint              *new_height);
  84 void         _gtk_text_btree_validate_line     (GtkTextBTree      *tree,
  85                                                 GtkTextLine       *line,
  86                                                 gpointer           view_id);
  87
  88 /* Tag */
  89
  90 void _gtk_text_btree_tag (const GtkTextIter *start,
  91                           const GtkTextIter *end,
  92                           GtkTextTag        *tag,
  93                           gboolean           apply);
  94
  95 /* "Getters" */
  96
  97 GtkTextLine * _gtk_text_btree_get_line          (GtkTextBTree      *tree,
  98                                                  gint               line_number,
  99                                                  gint              *real_line_number);
 100 GtkTextLine * _gtk_text_btree_get_line_no_last  (GtkTextBTree      *tree,
 101                                                  gint               line_number,
 102                                                  gint              *real_line_number);
 103 GtkTextLine * _gtk_text_btree_get_end_iter_line (GtkTextBTree      *tree);
 104 GtkTextLine * _gtk_text_btree_get_line_at_char  (GtkTextBTree      *tree,
 105                                                  gint               char_index,
 106                                                  gint              *line_start_index,
 107                                                  gint              *real_char_index);
 108 GtkTextTag**  _gtk_text_btree_get_tags          (const GtkTextIter *iter,
 109                                                  gint              *num_tags);
 110 gchar        *_gtk_text_btree_get_text          (const GtkTextIter *start,
 111                                                  const GtkTextIter *end,
 112                                                  gboolean           include_hidden,
 113                                                  gboolean           include_nonchars);
 114 gint          _gtk_text_btree_line_count        (GtkTextBTree      *tree);
 115 gint          _gtk_text_btree_char_count        (GtkTextBTree      *tree);
 116 gboolean      _gtk_text_btree_char_is_invisible (const GtkTextIter *iter);
 117
 118
 119
 120 /* Get iterators (these are implemented in gtktextiter.c) */
 121 void     _gtk_text_btree_get_iter_at_char         (GtkTextBTree       *tree,
 122                                                    GtkTextIter        *iter,
 123                                                    gint                char_index);
 124 void     _gtk_text_btree_get_iter_at_line_char    (GtkTextBTree       *tree,
 125                                                    GtkTextIter        *iter,
 126                                                    gint                line_number,
 127                                                    gint                char_index);
 128 void     _gtk_text_btree_get_iter_at_line_byte    (GtkTextBTree       *tree,
 129                                                    GtkTextIter        *iter,
 130                                                    gint                line_number,
 131                                                    gint                byte_index);
 132 gboolean _gtk_text_btree_get_iter_from_string     (GtkTextBTree       *tree,
 133                                                    GtkTextIter        *iter,
 134                                                    const gchar        *string);
 135 gboolean _gtk_text_btree_get_iter_at_mark_name    (GtkTextBTree       *tree,
 136                                                    GtkTextIter        *iter,
 137                                                    const gchar        *mark_name);
 138 void     _gtk_text_btree_get_iter_at_mark         (GtkTextBTree       *tree,
 139                                                    GtkTextIter        *iter,
 140                                                    GtkTextMark        *mark);
 141 void     _gtk_text_btree_get_end_iter             (GtkTextBTree       *tree,
 142                                                    GtkTextIter        *iter);
 143 void     _gtk_text_btree_get_iter_at_line         (GtkTextBTree       *tree,
 144                                                    GtkTextIter        *iter,
 145                                                    GtkTextLine        *line,
 146                                                    gint                byte_offset);
 147 gboolean _gtk_text_btree_get_iter_at_first_toggle (GtkTextBTree       *tree,
 148                                                    GtkTextIter        *iter,
 149                                                    GtkTextTag         *tag);
 150 gboolean _gtk_text_btree_get_iter_at_last_toggle  (GtkTextBTree       *tree,
 151                                                    GtkTextIter        *iter,
 152                                                    GtkTextTag         *tag);
 153
 154 void     _gtk_text_btree_get_iter_at_child_anchor  (GtkTextBTree       *tree,
 155                                                     GtkTextIter        *iter,
 156                                                     GtkTextChildAnchor *anchor);
 157
 158
 159
 160 /* Manipulate marks */
 161 GtkTextMark        *_gtk_text_btree_set_mark                (GtkTextBTree       *tree,
 162                                                              GtkTextMark         *existing_mark,
 163                                                              const gchar        *name,
 164                                                              gboolean            left_gravity,
 165                                                              const GtkTextIter  *index,
 166                                                              gboolean           should_exist);
 167 void                _gtk_text_btree_remove_mark_by_name     (GtkTextBTree       *tree,
 168                                                              const gchar        *name);
 169 void                _gtk_text_btree_remove_mark             (GtkTextBTree       *tree,
 170                                                              GtkTextMark        *segment);
 171 gboolean            _gtk_text_btree_get_selection_bounds    (GtkTextBTree       *tree,
 172                                                              GtkTextIter        *start,
 173                                                              GtkTextIter        *end);
 174 void                _gtk_text_btree_place_cursor            (GtkTextBTree       *tree,
 175                                                              const GtkTextIter  *where);
 176 gboolean            _gtk_text_btree_mark_is_insert          (GtkTextBTree       *tree,
 177                                                              GtkTextMark        *segment);
 178 gboolean            _gtk_text_btree_mark_is_selection_bound (GtkTextBTree       *tree,
 179                                                              GtkTextMark        *segment);
 180 GtkTextMark        *_gtk_text_btree_get_mark_by_name        (GtkTextBTree       *tree,
 181                                                              const gchar        *name);
 182 GtkTextLine *       _gtk_text_btree_first_could_contain_tag (GtkTextBTree       *tree,
 183                                                              GtkTextTag         *tag);
 184 GtkTextLine *       _gtk_text_btree_last_could_contain_tag  (GtkTextBTree       *tree,
 185                                                              GtkTextTag         *tag);
 186
 187 /* Lines */
 188
 189 /* Chunk of data associated with a line; views can use this to store
 190    info at the line. They should "subclass" the header struct here. */
 191 struct _GtkTextLineData {
 192   gpointer view_id;
 193   GtkTextLineData *next;
 194   gint height;
 195   signed int width : 24;
 196   guint valid : 8;              /* Actually a boolean */
 197 };
 198
 199 /*
 200  * The data structure below defines a single line of text (from newline
 201  * to newline, not necessarily what appears on one line of the screen).
 202  *
 203  * You can consider this line a "paragraph" also
 204  */
 205
 206 struct _GtkTextLine {
 207   GtkTextBTreeNode *parent;             /* Pointer to parent node containing
 208                                          * line. */
 209   GtkTextLine *next;            /* Next in linked list of lines with
 210                                  * same parent node in B-tree.  NULL
 211                                  * means end of list. */
 212   GtkTextLineSegment *segments; /* First in ordered list of segments
 213                                  * that make up the line. */
 214   GtkTextLineData *views;      /* data stored here by views */
 215 };
 216
 217
 218 gint                _gtk_text_line_get_number                 (GtkTextLine         *line);
 219 gboolean            _gtk_text_line_char_has_tag               (GtkTextLine         *line,
 220                                                                GtkTextBTree        *tree,
 221                                                                gint                 char_in_line,
 222                                                                GtkTextTag          *tag);
 223 gboolean            _gtk_text_line_byte_has_tag               (GtkTextLine         *line,
 224                                                                GtkTextBTree        *tree,
 225                                                                gint                 byte_in_line,
 226                                                                GtkTextTag          *tag);
 227 gboolean            _gtk_text_line_is_last                    (GtkTextLine         *line,
 228                                                                GtkTextBTree        *tree);
 229 gboolean            _gtk_text_line_contains_end_iter          (GtkTextLine         *line,
 230                                                                GtkTextBTree        *tree);
 231 GtkTextLine *       _gtk_text_line_next                       (GtkTextLine         *line);
 232 GtkTextLine *       _gtk_text_line_next_excluding_last        (GtkTextLine         *line);
 233 GtkTextLine *       _gtk_text_line_previous                   (GtkTextLine         *line);
 234 void                _gtk_text_line_add_data                   (GtkTextLine         *line,
 235                                                                GtkTextLineData     *data);
 236 gpointer            _gtk_text_line_remove_data                (GtkTextLine         *line,
 237                                                                gpointer             view_id);
 238 gpointer            _gtk_text_line_get_data                   (GtkTextLine         *line,
 239                                                                gpointer             view_id);
 240 void                _gtk_text_line_invalidate_wrap            (GtkTextLine         *line,
 241                                                                GtkTextLineData     *ld);
 242 gint                _gtk_text_line_char_count                 (GtkTextLine         *line);
 243 gint                _gtk_text_line_byte_count                 (GtkTextLine         *line);
 244 gint                _gtk_text_line_char_index                 (GtkTextLine         *line);
 245 GtkTextLineSegment *_gtk_text_line_byte_to_segment            (GtkTextLine         *line,
 246                                                                gint                 byte_offset,
 247                                                                gint                *seg_offset);
 248 GtkTextLineSegment *_gtk_text_line_char_to_segment            (GtkTextLine         *line,
 249                                                                gint                 char_offset,
 250                                                                gint                *seg_offset);
 251 gboolean            _gtk_text_line_byte_locate                (GtkTextLine         *line,
 252                                                                gint                 byte_offset,
 253                                                                GtkTextLineSegment **segment,
 254                                                                GtkTextLineSegment **any_segment,
 255                                                                gint                *seg_byte_offset,
 256                                                                gint                *line_byte_offset);
 257 gboolean            _gtk_text_line_char_locate                (GtkTextLine         *line,
 258                                                                gint                 char_offset,
 259                                                                GtkTextLineSegment **segment,
 260                                                                GtkTextLineSegment **any_segment,
 261                                                                gint                *seg_char_offset,
 262                                                                gint                *line_char_offset);
 263 void                _gtk_text_line_byte_to_char_offsets       (GtkTextLine         *line,
 264                                                                gint                 byte_offset,
 265                                                                gint                *line_char_offset,
 266                                                                gint                *seg_char_offset);
 267 void                _gtk_text_line_char_to_byte_offsets       (GtkTextLine         *line,
 268                                                                gint                 char_offset,
 269                                                                gint                *line_byte_offset,
 270                                                                gint                *seg_byte_offset);
 271 GtkTextLineSegment *_gtk_text_line_byte_to_any_segment        (GtkTextLine         *line,
 272                                                                gint                 byte_offset,
 273                                                                gint                *seg_offset);
 274 GtkTextLineSegment *_gtk_text_line_char_to_any_segment        (GtkTextLine         *line,
 275                                                                gint                 char_offset,
 276                                                                gint                *seg_offset);
 277 gint                _gtk_text_line_byte_to_char               (GtkTextLine         *line,
 278                                                                gint                 byte_offset);
 279 gint                _gtk_text_line_char_to_byte               (GtkTextLine         *line,
 280                                                                gint                 char_offset);
 281 GtkTextLine    *    _gtk_text_line_next_could_contain_tag     (GtkTextLine         *line,
 282                                                                GtkTextBTree        *tree,
 283                                                                GtkTextTag          *tag);
 284 GtkTextLine    *    _gtk_text_line_previous_could_contain_tag (GtkTextLine         *line,
 285                                                                GtkTextBTree        *tree,
 286                                                                GtkTextTag          *tag);
 287
 288 GtkTextLineData    *_gtk_text_line_data_new                   (GtkTextLayout     *layout,
 289                                                                GtkTextLine       *line);
 290
 291 /* Debug */
 292 void _gtk_text_btree_check (GtkTextBTree *tree);
 293 void _gtk_text_btree_spew (GtkTextBTree *tree);
 294 extern gboolean _gtk_text_view_debug_btree;
 295
 296 /* ignore, exported only for gtktextsegment.c */
 297 void _gtk_toggle_segment_check_func (GtkTextLineSegment *segPtr,
 298                                      GtkTextLine        *line);
 299 void _gtk_change_node_toggle_count  (GtkTextBTreeNode   *node,
 300                                      GtkTextTagInfo     *info,
 301                                      gint                delta);
 302
 303 /* for gtktextmark.c */
 304 void _gtk_text_btree_release_mark_segment (GtkTextBTree       *tree,
 305                                            GtkTextLineSegment *segment);
 306
 307 /* for coordination with the tag table */
 308 void _gtk_text_btree_notify_will_remove_tag (GtkTextBTree *tree,
 309                                              GtkTextTag   *tag);
 310
 311 #ifdef __cplusplus
 312 }
 313 #endif /* __cplusplus */
 314
 315 #endif
 316
 317