1 /* gtktextmark.c - mark segments
3 * Copyright (c) 1994 The Regents of the University of California.
4 * Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 * Copyright (c) 2000 Red Hat, Inc.
6 * Tk -> Gtk port by Havoc Pennington <hp@redhat.com>
8 * This software is copyrighted by the Regents of the University of
9 * California, Sun Microsystems, Inc., and other parties. The
10 * following terms apply to all files associated with the software
11 * unless explicitly disclaimed in individual files.
13 * The authors hereby grant permission to use, copy, modify,
14 * distribute, and license this software and its documentation for any
15 * purpose, provided that existing copyright notices are retained in
16 * all copies and that this notice is included verbatim in any
17 * distributions. No written agreement, license, or royalty fee is
18 * required for any of the authorized uses. Modifications to this
19 * software may be copyrighted by their authors and need not follow
20 * the licensing terms described here, provided that the new terms are
21 * clearly indicated on the first page of each file where they apply.
23 * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
24 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
25 * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
26 * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
27 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
30 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
32 * NON-INFRINGEMENT. THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
33 * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
34 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
36 * GOVERNMENT USE: If you are acquiring this software on behalf of the
37 * U.S. government, the Government shall have only "Restricted Rights"
38 * in the software and related documentation as defined in the Federal
39 * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you
40 * are acquiring the software on behalf of the Department of Defense,
41 * the software shall be classified as "Commercial Computer Software"
42 * and the Government shall have only "Restricted Rights" as defined
43 * in Clause 252.227-7013 (c) (1) of DFARs. Notwithstanding the
44 * foregoing, the authors grant the U.S. Government and others acting
45 * in its behalf permission to use and distribute the software in
46 * accordance with the terms specified in this license.
50 #define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
51 #include "gtktextbtree.h"
53 static void gtk_text_mark_init (GtkTextMark *mark);
54 static void gtk_text_mark_class_init (GtkTextMarkClass *klass);
55 static void gtk_text_mark_finalize (GObject *obj);
58 static gpointer parent_class = NULL;
61 gtk_text_mark_get_type (void)
63 static GType object_type = 0;
67 static const GTypeInfo object_info =
69 sizeof (GtkTextMarkClass),
71 (GBaseFinalizeFunc) NULL,
72 (GClassInitFunc) gtk_text_mark_class_init,
73 NULL, /* class_finalize */
74 NULL, /* class_data */
77 (GInstanceInitFunc) gtk_text_mark_init,
80 object_type = g_type_register_static (G_TYPE_OBJECT, "GtkTextMark",
88 gtk_text_mark_init (GtkTextMark *mark)
94 gtk_text_mark_class_init (GtkTextMarkClass *klass)
96 GObjectClass *object_class = G_OBJECT_CLASS (klass);
98 parent_class = g_type_class_peek_parent (klass);
100 object_class->finalize = gtk_text_mark_finalize;
104 gtk_text_mark_finalize (GObject *obj)
107 GtkTextLineSegment *seg;
109 mark = GTK_TEXT_MARK (obj);
115 if (seg->body.mark.tree != NULL)
116 g_warning ("GtkTextMark being finalized while still in the buffer; "
117 "someone removed a reference they didn't own! Crash "
120 g_free (seg->body.mark.name);
123 mark->segment = NULL;
126 /* chain parent_class' handler */
127 G_OBJECT_CLASS (parent_class)->finalize (obj);
131 * gtk_text_mark_get_visible:
132 * @mark: a #GtkTextMark
134 * Returns %TRUE if the mark is visible (i.e. a cursor is displayed
137 * Return value: %TRUE if visible
140 gtk_text_mark_get_visible (GtkTextMark *mark)
142 GtkTextLineSegment *seg;
146 return seg->body.mark.visible;
150 * gtk_text_mark_get_name:
151 * @mark: a #GtkTextMark
153 * Returns the mark name; returns NULL for anonymous marks.
155 * Return value: mark name
158 gtk_text_mark_get_name (GtkTextMark *mark)
160 GtkTextLineSegment *seg;
164 return seg->body.mark.name;
168 * gtk_text_mark_get_deleted:
169 * @mark: a #GtkTextMark
171 * Returns %TRUE if the mark has been removed from its buffer
172 * with gtk_text_buffer_delete_mark(). Marks can't be used
175 * Return value: whether the mark is deleted
178 gtk_text_mark_get_deleted (GtkTextMark *mark)
180 GtkTextLineSegment *seg;
182 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
189 return seg->body.mark.tree == NULL;
193 * gtk_text_mark_get_buffer:
194 * @mark: a #GtkTextMark
196 * Gets the buffer this mark is located inside,
197 * or NULL if the mark is deleted.
199 * Return value: the mark's #GtkTextBuffer
202 gtk_text_mark_get_buffer (GtkTextMark *mark)
204 GtkTextLineSegment *seg;
206 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
210 if (seg->body.mark.tree == NULL)
213 return _gtk_text_btree_get_buffer (seg->body.mark.tree);
217 * gtk_text_mark_get_left_gravity:
218 * @mark: a #GtkTextMark
220 * Determines whether the mark has left gravity.
222 * Return value: %TRUE if the mark has left gravity, %FALSE otherwise
225 gtk_text_mark_get_left_gravity (GtkTextMark *mark)
227 GtkTextLineSegment *seg;
229 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
233 return seg->type == >k_text_left_mark_type;
237 * Macro that determines the size of a mark segment:
240 #define MSEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
241 + sizeof (GtkTextMarkBody)))
245 _gtk_mark_segment_new (GtkTextBTree *tree,
246 gboolean left_gravity,
249 GtkTextLineSegment *mark;
251 mark = (GtkTextLineSegment *) g_malloc0 (MSEG_SIZE);
252 mark->body.mark.name = g_strdup (name);
255 mark->type = >k_text_left_mark_type;
257 mark->type = >k_text_right_mark_type;
259 mark->byte_count = 0;
260 mark->char_count = 0;
262 mark->body.mark.obj = g_object_new (GTK_TYPE_TEXT_MARK, NULL);
263 mark->body.mark.obj->segment = mark;
265 mark->body.mark.tree = tree;
266 mark->body.mark.line = NULL;
269 mark->body.mark.visible = FALSE;
270 mark->body.mark.not_deleteable = FALSE;
275 static int mark_segment_delete_func (GtkTextLineSegment *segPtr,
278 static GtkTextLineSegment *mark_segment_cleanup_func (GtkTextLineSegment *segPtr,
280 static void mark_segment_check_func (GtkTextLineSegment *segPtr,
285 * The following structures declare the "mark" segment types.
286 * There are actually two types for marks, one with left gravity
287 * and one with right gravity. They are identical except for
288 * their gravity property.
291 GtkTextLineSegmentClass gtk_text_right_mark_type = {
293 FALSE, /* leftGravity */
294 NULL, /* splitFunc */
295 mark_segment_delete_func, /* deleteFunc */
296 mark_segment_cleanup_func, /* cleanupFunc */
297 NULL, /* lineChangeFunc */
298 mark_segment_check_func /* checkFunc */
301 GtkTextLineSegmentClass gtk_text_left_mark_type = {
303 TRUE, /* leftGravity */
304 NULL, /* splitFunc */
305 mark_segment_delete_func, /* deleteFunc */
306 mark_segment_cleanup_func, /* cleanupFunc */
307 NULL, /* lineChangeFunc */
308 mark_segment_check_func /* checkFunc */
312 *--------------------------------------------------------------
314 * mark_segment_delete_func --
316 * This procedure is invoked by the text B-tree code whenever
317 * a mark lies in a range of characters being deleted.
320 * Returns 1 to indicate that deletion has been rejected,
324 * Frees mark if tree is going away
326 *--------------------------------------------------------------
330 mark_segment_delete_func (GtkTextLineSegment *seg,
336 _gtk_text_btree_release_mark_segment (seg->body.mark.tree, seg);
344 *--------------------------------------------------------------
346 * mark_segment_cleanup_func --
348 * This procedure is invoked by the B-tree code whenever a
349 * mark segment is moved from one line to another.
355 * The line field of the segment gets updated.
357 *--------------------------------------------------------------
360 static GtkTextLineSegment *
361 mark_segment_cleanup_func (GtkTextLineSegment *seg,
364 /* not sure why Tk did this here and not in LineChangeFunc */
365 seg->body.mark.line = line;
370 *--------------------------------------------------------------
372 * mark_segment_check_func --
374 * This procedure is invoked by the B-tree code to perform
375 * consistency checks on mark segments.
381 * The procedure panics if it detects anything wrong with
384 *--------------------------------------------------------------
388 mark_segment_check_func (GtkTextLineSegment *seg,
391 if (seg->body.mark.line != line)
392 g_error ("mark_segment_check_func: seg->body.mark.line bogus");