1 /* GTK - The GIMP Toolkit
2 * gtktextbtree.h Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __GTK_TEXT_BTREE_H__
28 #define __GTK_TEXT_BTREE_H__
31 #define DEBUG_VALIDATION_AND_SCROLLING
34 #ifdef DEBUG_VALIDATION_AND_SCROLLING
40 #include <gtk/gtktextbuffer.h>
41 #include <gtk/gtktexttag.h>
42 #include <gtk/gtktextmark.h>
43 #include <gtk/gtktextchild.h>
44 #include <gtk/gtktextsegment.h>
45 #include <gtk/gtktextiter.h>
49 GtkTextBTree *_gtk_text_btree_new (GtkTextTagTable *table,
50 GtkTextBuffer *buffer);
51 void _gtk_text_btree_ref (GtkTextBTree *tree);
52 void _gtk_text_btree_unref (GtkTextBTree *tree);
53 GtkTextBuffer *_gtk_text_btree_get_buffer (GtkTextBTree *tree);
56 guint _gtk_text_btree_get_chars_changed_stamp (GtkTextBTree *tree);
57 guint _gtk_text_btree_get_segments_changed_stamp (GtkTextBTree *tree);
58 void _gtk_text_btree_segments_changed (GtkTextBTree *tree);
60 gboolean _gtk_text_btree_is_end (GtkTextBTree *tree,
62 GtkTextLineSegment *seg,
66 /* Indexable segment mutation */
68 void _gtk_text_btree_delete (GtkTextIter *start,
70 void _gtk_text_btree_insert (GtkTextIter *iter,
73 void _gtk_text_btree_insert_pixbuf (GtkTextIter *iter,
76 void _gtk_text_btree_insert_child_anchor (GtkTextIter *iter,
77 GtkTextChildAnchor *anchor);
79 void _gtk_text_btree_unregister_child_anchor (GtkTextChildAnchor *anchor);
82 GtkTextLine *_gtk_text_btree_find_line_by_y (GtkTextBTree *tree,
86 gint _gtk_text_btree_find_line_top (GtkTextBTree *tree,
89 void _gtk_text_btree_add_view (GtkTextBTree *tree,
90 GtkTextLayout *layout);
91 void _gtk_text_btree_remove_view (GtkTextBTree *tree,
93 void _gtk_text_btree_invalidate_region (GtkTextBTree *tree,
94 const GtkTextIter *start,
95 const GtkTextIter *end,
96 gboolean cursors_only);
97 void _gtk_text_btree_get_view_size (GtkTextBTree *tree,
101 gboolean _gtk_text_btree_is_valid (GtkTextBTree *tree,
103 gboolean _gtk_text_btree_validate (GtkTextBTree *tree,
109 void _gtk_text_btree_validate_line (GtkTextBTree *tree,
115 void _gtk_text_btree_tag (const GtkTextIter *start,
116 const GtkTextIter *end,
122 GtkTextLine * _gtk_text_btree_get_line (GtkTextBTree *tree,
124 gint *real_line_number);
125 GtkTextLine * _gtk_text_btree_get_line_no_last (GtkTextBTree *tree,
127 gint *real_line_number);
128 GtkTextLine * _gtk_text_btree_get_end_iter_line (GtkTextBTree *tree);
129 GtkTextLine * _gtk_text_btree_get_line_at_char (GtkTextBTree *tree,
131 gint *line_start_index,
132 gint *real_char_index);
133 GtkTextTag** _gtk_text_btree_get_tags (const GtkTextIter *iter,
135 gchar *_gtk_text_btree_get_text (const GtkTextIter *start,
136 const GtkTextIter *end,
137 gboolean include_hidden,
138 gboolean include_nonchars);
139 gint _gtk_text_btree_line_count (GtkTextBTree *tree);
140 gint _gtk_text_btree_char_count (GtkTextBTree *tree);
141 gboolean _gtk_text_btree_char_is_invisible (const GtkTextIter *iter);
145 /* Get iterators (these are implemented in gtktextiter.c) */
146 void _gtk_text_btree_get_iter_at_char (GtkTextBTree *tree,
149 void _gtk_text_btree_get_iter_at_line_char (GtkTextBTree *tree,
153 void _gtk_text_btree_get_iter_at_line_byte (GtkTextBTree *tree,
157 gboolean _gtk_text_btree_get_iter_from_string (GtkTextBTree *tree,
159 const gchar *string);
160 gboolean _gtk_text_btree_get_iter_at_mark_name (GtkTextBTree *tree,
162 const gchar *mark_name);
163 void _gtk_text_btree_get_iter_at_mark (GtkTextBTree *tree,
166 void _gtk_text_btree_get_end_iter (GtkTextBTree *tree,
168 void _gtk_text_btree_get_iter_at_line (GtkTextBTree *tree,
172 gboolean _gtk_text_btree_get_iter_at_first_toggle (GtkTextBTree *tree,
175 gboolean _gtk_text_btree_get_iter_at_last_toggle (GtkTextBTree *tree,
179 void _gtk_text_btree_get_iter_at_child_anchor (GtkTextBTree *tree,
181 GtkTextChildAnchor *anchor);
185 /* Manipulate marks */
186 GtkTextMark *_gtk_text_btree_set_mark (GtkTextBTree *tree,
187 GtkTextMark *existing_mark,
189 gboolean left_gravity,
190 const GtkTextIter *index,
191 gboolean should_exist);
192 void _gtk_text_btree_remove_mark_by_name (GtkTextBTree *tree,
194 void _gtk_text_btree_remove_mark (GtkTextBTree *tree,
195 GtkTextMark *segment);
196 gboolean _gtk_text_btree_get_selection_bounds (GtkTextBTree *tree,
199 void _gtk_text_btree_place_cursor (GtkTextBTree *tree,
200 const GtkTextIter *where);
201 void _gtk_text_btree_select_range (GtkTextBTree *tree,
202 const GtkTextIter *ins,
203 const GtkTextIter *bound);
204 gboolean _gtk_text_btree_mark_is_insert (GtkTextBTree *tree,
205 GtkTextMark *segment);
206 gboolean _gtk_text_btree_mark_is_selection_bound (GtkTextBTree *tree,
207 GtkTextMark *segment);
208 GtkTextMark *_gtk_text_btree_get_insert (GtkTextBTree *tree);
209 GtkTextMark *_gtk_text_btree_get_selection_bound (GtkTextBTree *tree);
210 GtkTextMark *_gtk_text_btree_get_mark_by_name (GtkTextBTree *tree,
212 GtkTextLine * _gtk_text_btree_first_could_contain_tag (GtkTextBTree *tree,
214 GtkTextLine * _gtk_text_btree_last_could_contain_tag (GtkTextBTree *tree,
219 /* Chunk of data associated with a line; views can use this to store
220 info at the line. They should "subclass" the header struct here. */
221 struct _GtkTextLineData {
223 GtkTextLineData *next;
225 signed int width : 24;
226 guint valid : 8; /* Actually a boolean */
230 * The data structure below defines a single line of text (from newline
231 * to newline, not necessarily what appears on one line of the screen).
233 * You can consider this line a "paragraph" also
236 struct _GtkTextLine {
237 GtkTextBTreeNode *parent; /* Pointer to parent node containing
239 GtkTextLine *next; /* Next in linked list of lines with
240 * same parent node in B-tree. NULL
241 * means end of list. */
242 GtkTextLineSegment *segments; /* First in ordered list of segments
243 * that make up the line. */
244 GtkTextLineData *views; /* data stored here by views */
245 guchar dir_strong; /* BiDi algo dir of line */
246 guchar dir_propagated_back; /* BiDi algo dir of next line */
247 guchar dir_propagated_forward; /* BiDi algo dir of prev line */
251 gint _gtk_text_line_get_number (GtkTextLine *line);
252 gboolean _gtk_text_line_char_has_tag (GtkTextLine *line,
256 gboolean _gtk_text_line_byte_has_tag (GtkTextLine *line,
260 gboolean _gtk_text_line_is_last (GtkTextLine *line,
262 gboolean _gtk_text_line_contains_end_iter (GtkTextLine *line,
264 GtkTextLine * _gtk_text_line_next (GtkTextLine *line);
265 GtkTextLine * _gtk_text_line_next_excluding_last (GtkTextLine *line);
266 GtkTextLine * _gtk_text_line_previous (GtkTextLine *line);
267 void _gtk_text_line_add_data (GtkTextLine *line,
268 GtkTextLineData *data);
269 gpointer _gtk_text_line_remove_data (GtkTextLine *line,
271 gpointer _gtk_text_line_get_data (GtkTextLine *line,
273 void _gtk_text_line_invalidate_wrap (GtkTextLine *line,
274 GtkTextLineData *ld);
275 gint _gtk_text_line_char_count (GtkTextLine *line);
276 gint _gtk_text_line_byte_count (GtkTextLine *line);
277 gint _gtk_text_line_char_index (GtkTextLine *line);
278 GtkTextLineSegment *_gtk_text_line_byte_to_segment (GtkTextLine *line,
281 GtkTextLineSegment *_gtk_text_line_char_to_segment (GtkTextLine *line,
284 gboolean _gtk_text_line_byte_locate (GtkTextLine *line,
286 GtkTextLineSegment **segment,
287 GtkTextLineSegment **any_segment,
288 gint *seg_byte_offset,
289 gint *line_byte_offset);
290 gboolean _gtk_text_line_char_locate (GtkTextLine *line,
292 GtkTextLineSegment **segment,
293 GtkTextLineSegment **any_segment,
294 gint *seg_char_offset,
295 gint *line_char_offset);
296 void _gtk_text_line_byte_to_char_offsets (GtkTextLine *line,
298 gint *line_char_offset,
299 gint *seg_char_offset);
300 void _gtk_text_line_char_to_byte_offsets (GtkTextLine *line,
302 gint *line_byte_offset,
303 gint *seg_byte_offset);
304 GtkTextLineSegment *_gtk_text_line_byte_to_any_segment (GtkTextLine *line,
307 GtkTextLineSegment *_gtk_text_line_char_to_any_segment (GtkTextLine *line,
310 gint _gtk_text_line_byte_to_char (GtkTextLine *line,
312 gint _gtk_text_line_char_to_byte (GtkTextLine *line,
314 GtkTextLine * _gtk_text_line_next_could_contain_tag (GtkTextLine *line,
317 GtkTextLine * _gtk_text_line_previous_could_contain_tag (GtkTextLine *line,
321 GtkTextLineData *_gtk_text_line_data_new (GtkTextLayout *layout,
325 void _gtk_text_btree_check (GtkTextBTree *tree);
326 void _gtk_text_btree_spew (GtkTextBTree *tree);
327 extern gboolean _gtk_text_view_debug_btree;
329 /* ignore, exported only for gtktextsegment.c */
330 void _gtk_toggle_segment_check_func (GtkTextLineSegment *segPtr,
332 void _gtk_change_node_toggle_count (GtkTextBTreeNode *node,
333 GtkTextTagInfo *info,
336 /* for gtktextmark.c */
337 void _gtk_text_btree_release_mark_segment (GtkTextBTree *tree,
338 GtkTextLineSegment *segment);
340 /* for coordination with the tag table */
341 void _gtk_text_btree_notify_will_remove_tag (GtkTextBTree *tree,