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,
89 gtk_text_mark_init (GtkTextMark *mark)
95 gtk_text_mark_class_init (GtkTextMarkClass *klass)
97 GObjectClass *object_class = G_OBJECT_CLASS (klass);
99 parent_class = g_type_class_peek_parent (klass);
101 object_class->finalize = gtk_text_mark_finalize;
105 gtk_text_mark_finalize (GObject *obj)
108 GtkTextLineSegment *seg;
110 mark = GTK_TEXT_MARK (obj);
116 if (seg->body.mark.tree != NULL)
117 g_warning ("GtkTextMark being finalized while still in the buffer; "
118 "someone removed a reference they didn't own! Crash "
121 g_free (seg->body.mark.name);
124 mark->segment = NULL;
127 /* chain parent_class' handler */
128 G_OBJECT_CLASS (parent_class)->finalize (obj);
132 * gtk_text_mark_get_visible:
133 * @mark: a #GtkTextMark
135 * Returns %TRUE if the mark is visible (i.e. a cursor is displayed
138 * Return value: %TRUE if visible
141 gtk_text_mark_get_visible (GtkTextMark *mark)
143 GtkTextLineSegment *seg;
147 return seg->body.mark.visible;
151 * gtk_text_mark_get_name:
152 * @mark: a #GtkTextMark
154 * Returns the mark name; returns NULL for anonymous marks.
156 * Return value: mark name
159 gtk_text_mark_get_name (GtkTextMark *mark)
161 GtkTextLineSegment *seg;
165 return seg->body.mark.name;
169 * gtk_text_mark_get_deleted:
170 * @mark: a #GtkTextMark
172 * Returns %TRUE if the mark has been removed from its buffer
173 * with gtk_text_buffer_delete_mark(). Marks can't be used
176 * Return value: whether the mark is deleted
179 gtk_text_mark_get_deleted (GtkTextMark *mark)
181 GtkTextLineSegment *seg;
183 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
190 return seg->body.mark.tree == NULL;
194 * gtk_text_mark_get_buffer:
195 * @mark: a #GtkTextMark
197 * Gets the buffer this mark is located inside,
198 * or NULL if the mark is deleted.
200 * Return value: the mark's #GtkTextBuffer
203 gtk_text_mark_get_buffer (GtkTextMark *mark)
205 GtkTextLineSegment *seg;
207 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
211 if (seg->body.mark.tree == NULL)
214 return _gtk_text_btree_get_buffer (seg->body.mark.tree);
218 * gtk_text_mark_get_left_gravity:
219 * @mark: a #GtkTextMark
223 * Return value: %TRUE if the mark has left gravity, %FALSE otherwise
226 gtk_text_mark_get_left_gravity (GtkTextMark *mark)
228 GtkTextLineSegment *seg;
230 g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
234 return seg->type == >k_text_left_mark_type;
238 * Macro that determines the size of a mark segment:
241 #define MSEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
242 + sizeof (GtkTextMarkBody)))
246 _gtk_mark_segment_new (GtkTextBTree *tree,
247 gboolean left_gravity,
250 GtkTextLineSegment *mark;
252 mark = (GtkTextLineSegment *) g_malloc0 (MSEG_SIZE);
253 mark->body.mark.name = g_strdup (name);
256 mark->type = >k_text_left_mark_type;
258 mark->type = >k_text_right_mark_type;
260 mark->byte_count = 0;
261 mark->char_count = 0;
263 mark->body.mark.obj = g_object_new (GTK_TYPE_TEXT_MARK, NULL);
264 mark->body.mark.obj->segment = mark;
266 mark->body.mark.tree = tree;
267 mark->body.mark.line = NULL;
270 mark->body.mark.visible = FALSE;
271 mark->body.mark.not_deleteable = FALSE;
276 static int mark_segment_delete_func (GtkTextLineSegment *segPtr,
279 static GtkTextLineSegment *mark_segment_cleanup_func (GtkTextLineSegment *segPtr,
281 static void mark_segment_check_func (GtkTextLineSegment *segPtr,
286 * The following structures declare the "mark" segment types.
287 * There are actually two types for marks, one with left gravity
288 * and one with right gravity. They are identical except for
289 * their gravity property.
292 GtkTextLineSegmentClass gtk_text_right_mark_type = {
294 FALSE, /* leftGravity */
295 NULL, /* splitFunc */
296 mark_segment_delete_func, /* deleteFunc */
297 mark_segment_cleanup_func, /* cleanupFunc */
298 NULL, /* lineChangeFunc */
299 mark_segment_check_func /* checkFunc */
302 GtkTextLineSegmentClass gtk_text_left_mark_type = {
304 TRUE, /* leftGravity */
305 NULL, /* splitFunc */
306 mark_segment_delete_func, /* deleteFunc */
307 mark_segment_cleanup_func, /* cleanupFunc */
308 NULL, /* lineChangeFunc */
309 mark_segment_check_func /* checkFunc */
313 *--------------------------------------------------------------
315 * mark_segment_delete_func --
317 * This procedure is invoked by the text B-tree code whenever
318 * a mark lies in a range of characters being deleted.
321 * Returns 1 to indicate that deletion has been rejected,
325 * Frees mark if tree is going away
327 *--------------------------------------------------------------
331 mark_segment_delete_func (GtkTextLineSegment *seg,
337 _gtk_text_btree_release_mark_segment (seg->body.mark.tree, seg);
345 *--------------------------------------------------------------
347 * mark_segment_cleanup_func --
349 * This procedure is invoked by the B-tree code whenever a
350 * mark segment is moved from one line to another.
356 * The line field of the segment gets updated.
358 *--------------------------------------------------------------
361 static GtkTextLineSegment *
362 mark_segment_cleanup_func (GtkTextLineSegment *seg,
365 /* not sure why Tk did this here and not in LineChangeFunc */
366 seg->body.mark.line = line;
371 *--------------------------------------------------------------
373 * mark_segment_check_func --
375 * This procedure is invoked by the B-tree code to perform
376 * consistency checks on mark segments.
382 * The procedure panics if it detects anything wrong with
385 *--------------------------------------------------------------
389 mark_segment_check_func (GtkTextLineSegment *seg,
392 if (seg->body.mark.line != line)
393 g_error ("mark_segment_check_func: seg->body.mark.line bogus");