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

   1 #ifndef GTK_TEXT_BTREE_H
   2 #define GTK_TEXT_BTREE_H
   3
   4 #ifdef __cplusplus
   5 extern "C" {
   6 #endif /* __cplusplus */
   7
   8 #include <gtk/gtktextbuffer.h>
   9 #include <gtk/gtktexttag.h>
  10 #include <gtk/gtktextmark.h>
  11 #include <gtk/gtktextchild.h>
  12 #include <gtk/gtktextsegment.h>
  13 #include <gtk/gtktextiter.h>
  14
  15
  16 GtkTextBTree  *gtk_text_btree_new        (GtkTextTagTable *table,
  17                                           GtkTextBuffer   *buffer);
  18 void           gtk_text_btree_ref        (GtkTextBTree    *tree);
  19 void           gtk_text_btree_unref      (GtkTextBTree    *tree);
  20 GtkTextBuffer *gtk_text_btree_get_buffer (GtkTextBTree    *tree);
  21
  22
  23 guint gtk_text_btree_get_chars_changed_stamp    (GtkTextBTree *tree);
  24 guint gtk_text_btree_get_segments_changed_stamp (GtkTextBTree *tree);
  25 void  gtk_text_btree_segments_changed           (GtkTextBTree *tree);
  26
  27
  28 /* Indexable segment mutation */
  29
  30 void gtk_text_btree_delete        (GtkTextIter *start,
  31                                    GtkTextIter *end);
  32 void gtk_text_btree_insert        (GtkTextIter *iter,
  33                                    const gchar *text,
  34                                    gint         len);
  35 void gtk_text_btree_insert_pixmap (GtkTextIter *iter,
  36                                    GdkPixmap   *pixmap,
  37                                    GdkBitmap   *mask);
  38
  39
  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_last_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
 135 /* Manipulate marks */
 136 GtkTextMark        *gtk_text_btree_set_mark                (GtkTextBTree       *tree,
 137                                                             GtkTextMark         *existing_mark,
 138                                                             const gchar        *name,
 139                                                             gboolean            left_gravity,
 140                                                             const GtkTextIter  *index,
 141                                                             gboolean           should_exist);
 142 void                gtk_text_btree_remove_mark_by_name     (GtkTextBTree       *tree,
 143                                                             const gchar        *name);
 144 void                gtk_text_btree_remove_mark             (GtkTextBTree       *tree,
 145                                                             GtkTextMark        *segment);
 146 gboolean            gtk_text_btree_get_selection_bounds    (GtkTextBTree       *tree,
 147                                                             GtkTextIter        *start,
 148                                                             GtkTextIter        *end);
 149 void                gtk_text_btree_place_cursor            (GtkTextBTree       *tree,
 150                                                             const GtkTextIter  *where);
 151 gboolean            gtk_text_btree_mark_is_insert          (GtkTextBTree       *tree,
 152                                                             GtkTextMark        *segment);
 153 gboolean            gtk_text_btree_mark_is_selection_bound (GtkTextBTree       *tree,
 154                                                             GtkTextMark        *segment);
 155 GtkTextMark        *gtk_text_btree_get_mark_by_name        (GtkTextBTree       *tree,
 156                                                             const gchar        *name);
 157 GtkTextLine *       gtk_text_btree_first_could_contain_tag (GtkTextBTree       *tree,
 158                                                             GtkTextTag         *tag);
 159 GtkTextLine *       gtk_text_btree_last_could_contain_tag  (GtkTextBTree       *tree,
 160                                                             GtkTextTag         *tag);
 161
 162 /* Lines */
 163
 164 /* Chunk of data associated with a line; views can use this to store
 165    info at the line. They should "subclass" the header struct here. */
 166 typedef struct _GtkTextLineData GtkTextLineData;
 167
 168 struct _GtkTextLineData {
 169   gpointer view_id;
 170   GtkTextLineData *next;
 171   gint height;
 172   gint width : 24;
 173   gint valid : 8;
 174 };
 175
 176 /*
 177  * The data structure below defines a single line of text (from newline
 178  * to newline, not necessarily what appears on one line of the screen).
 179  *
 180  * You can consider this line a "paragraph" also
 181  */
 182
 183 struct _GtkTextLine {
 184   GtkTextBTreeNode *parent;             /* Pointer to parent node containing
 185                                  * line. */
 186   GtkTextLine *next;            /* Next in linked list of lines with
 187                                  * same parent node in B-tree.  NULL
 188                                  * means end of list. */
 189   GtkTextLineSegment *segments; /* First in ordered list of segments
 190                                  * that make up the line. */
 191   GtkTextLineData *views;      /* data stored here by views */
 192 };
 193
 194
 195 gint                gtk_text_line_get_number                 (GtkTextLine         *line);
 196 gboolean            gtk_text_line_char_has_tag               (GtkTextLine         *line,
 197                                                               GtkTextBTree        *tree,
 198                                                               gint                 char_in_line,
 199                                                               GtkTextTag          *tag);
 200 gboolean            gtk_text_line_byte_has_tag               (GtkTextLine         *line,
 201                                                               GtkTextBTree        *tree,
 202                                                               gint                 byte_in_line,
 203                                                               GtkTextTag          *tag);
 204 GtkTextLine *       gtk_text_line_next                       (GtkTextLine         *line);
 205 GtkTextLine *       gtk_text_line_previous                   (GtkTextLine         *line);
 206 void                gtk_text_line_add_data                   (GtkTextLine         *line,
 207                                                               GtkTextLineData     *data);
 208 gpointer            gtk_text_line_remove_data                (GtkTextLine         *line,
 209                                                               gpointer             view_id);
 210 gpointer            gtk_text_line_get_data                   (GtkTextLine         *line,
 211                                                               gpointer             view_id);
 212 void                gtk_text_line_invalidate_wrap            (GtkTextLine         *line,
 213                                                               GtkTextLineData     *ld);
 214 gint                gtk_text_line_char_count                 (GtkTextLine         *line);
 215 gint                gtk_text_line_byte_count                 (GtkTextLine         *line);
 216 gint                gtk_text_line_char_index                 (GtkTextLine         *line);
 217 GtkTextLineSegment *gtk_text_line_byte_to_segment            (GtkTextLine         *line,
 218                                                               gint                 byte_offset,
 219                                                               gint                *seg_offset);
 220 GtkTextLineSegment *gtk_text_line_char_to_segment            (GtkTextLine         *line,
 221                                                               gint                 char_offset,
 222                                                               gint                *seg_offset);
 223 void                gtk_text_line_byte_locate                (GtkTextLine         *line,
 224                                                               gint                 byte_offset,
 225                                                               GtkTextLineSegment **segment,
 226                                                               GtkTextLineSegment **any_segment,
 227                                                               gint                *seg_byte_offset,
 228                                                               gint                *line_byte_offset);
 229 void                gtk_text_line_char_locate                (GtkTextLine         *line,
 230                                                               gint                 char_offset,
 231                                                               GtkTextLineSegment **segment,
 232                                                               GtkTextLineSegment **any_segment,
 233                                                               gint                *seg_char_offset,
 234                                                               gint                *line_char_offset);
 235 void                gtk_text_line_byte_to_char_offsets       (GtkTextLine         *line,
 236                                                               gint                 byte_offset,
 237                                                               gint                *line_char_offset,
 238                                                               gint                *seg_char_offset);
 239 void                gtk_text_line_char_to_byte_offsets       (GtkTextLine         *line,
 240                                                               gint                 char_offset,
 241                                                               gint                *line_byte_offset,
 242                                                               gint                *seg_byte_offset);
 243 GtkTextLineSegment *gtk_text_line_byte_to_any_segment        (GtkTextLine         *line,
 244                                                               gint                 byte_offset,
 245                                                               gint                *seg_offset);
 246 GtkTextLineSegment *gtk_text_line_char_to_any_segment        (GtkTextLine         *line,
 247                                                               gint                 char_offset,
 248                                                               gint                *seg_offset);
 249 gint                gtk_text_line_byte_to_char               (GtkTextLine         *line,
 250                                                               gint                 byte_offset);
 251 gint                gtk_text_line_char_to_byte               (GtkTextLine         *line,
 252                                                               gint                 char_offset);
 253 GtkTextLine    *    gtk_text_line_next_could_contain_tag     (GtkTextLine         *line,
 254                                                               GtkTextBTree        *tree,
 255                                                               GtkTextTag          *tag);
 256 GtkTextLine    *    gtk_text_line_previous_could_contain_tag (GtkTextLine         *line,
 257                                                               GtkTextBTree        *tree,
 258                                                               GtkTextTag          *tag);
 259
 260
 261 /* Debug */
 262 void gtk_text_btree_check (GtkTextBTree *tree);
 263 void gtk_text_btree_spew (GtkTextBTree *tree);
 264 extern gboolean gtk_text_view_debug_btree;
 265
 266 /* ignore, exported only for gtktextsegment.c */
 267 void toggle_segment_check_func (GtkTextLineSegment *segPtr,
 268                                 GtkTextLine        *line);
 269 void change_node_toggle_count  (GtkTextBTreeNode   *node,
 270                                 GtkTextTagInfo     *info,
 271                                 gint                delta);
 272
 273
 274 #ifdef __cplusplus
 275 }
 276 #endif /* __cplusplus */
 277
 278 #endif
 279
 280