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

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