gtktextmark.c 16 KB
Newer Older
1
/* gtktextmark.c - mark segments
2
 *
3 4
 * Copyright (c) 1994 The Regents of the University of California.
 * Copyright (c) 1994-1997 Sun Microsystems, Inc.
5 6
 * Copyright (c) 2000      Red Hat, Inc.
 * Tk -> Gtk port by Havoc Pennington <hp@redhat.com>
7
 *
8 9 10 11
 * This software is copyrighted by the Regents of the University of
 * California, Sun Microsystems, Inc., and other parties.  The
 * following terms apply to all files associated with the software
 * unless explicitly disclaimed in individual files.
12
 *
13 14 15 16 17 18 19 20 21
 * The authors hereby grant permission to use, copy, modify,
 * distribute, and license this software and its documentation for any
 * purpose, provided that existing copyright notices are retained in
 * all copies and that this notice is included verbatim in any
 * distributions. No written agreement, license, or royalty fee is
 * required for any of the authorized uses.  Modifications to this
 * software may be copyrighted by their authors and need not follow
 * the licensing terms described here, provided that the new terms are
 * clearly indicated on the first page of each file where they apply.
22
 *
23 24 25 26 27
 * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
 * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
 * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
28
 *
29 30 31 32 33 34
 * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
 * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
 * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
 * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
35
 *
36 37 38 39 40 41 42 43 44 45 46
 * GOVERNMENT USE: If you are acquiring this software on behalf of the
 * U.S. government, the Government shall have only "Restricted Rights"
 * in the software and related documentation as defined in the Federal
 * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
 * are acquiring the software on behalf of the Department of Defense,
 * the software shall be classified as "Commercial Computer Software"
 * and the Government shall have only "Restricted Rights" as defined
 * in Clause 252.227-7013 (c) (1) of DFARs.  Notwithstanding the
 * foregoing, the authors grant the U.S. Government and others acting
 * in its behalf permission to use and distribute the software in
 * accordance with the terms specified in this license.
47
 *
48 49
 */

50
#define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
51
#include "config.h"
52
#include "gtktextbtree.h"
53
#include "gtkprivate.h"
54
#include "gtkintl.h"
55

56

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
/**
 * SECTION:gtktextmark
 * @Short_description: A position in the buffer preserved across buffer modifications
 * @Title: GtkTextMark
 *
 * You may wish to begin by reading the <link linkend="TextWidget">text widget
 * conceptual overview</link> which gives an overview of all the objects and data
 * types related to the text widget and how they work together.
 *
 * A #GtkTextMark is like a bookmark in a text buffer; it preserves a position in
 * the text. You can convert the mark to an iterator using
 * gtk_text_buffer_get_iter_at_mark(). Unlike iterators, marks remain valid across
 * buffer mutations, because their behavior is defined when text is inserted or
 * deleted. When text containing a mark is deleted, the mark remains in the
 * position originally occupied by the deleted text. When text is inserted at a
 * mark, a mark with <firstterm>left gravity</firstterm> will be moved to the
 * beginning of the newly-inserted text, and a mark with <firstterm>right
 * gravity</firstterm> will be moved to the end.
 *
 * <footnote>
 * "left" and "right" here refer to logical direction (left is the toward the start
 * of the buffer); in some languages such as Hebrew the logically-leftmost text is
 * not actually on the left when displayed.
 * </footnote>
 *
 * Marks are reference counted, but the reference count only controls the validity
 * of the memory; marks can be deleted from the buffer at any time with
 * gtk_text_buffer_delete_mark(). Once deleted from the buffer, a mark is
 * essentially useless.
 *
 * Marks optionally have names; these can be convenient to avoid passing the
 * #GtkTextMark object around.
 *
 * Marks are typically created using the gtk_text_buffer_create_mark() function.
 */


94 95 96 97 98 99 100 101 102 103 104
static void gtk_text_mark_set_property (GObject         *object,
				        guint            prop_id,
					const GValue    *value,
					GParamSpec      *pspec);
static void gtk_text_mark_get_property (GObject         *object,
					guint            prop_id,
					GValue          *value,
					GParamSpec      *pspec);
static void gtk_text_mark_finalize     (GObject         *object);

static GtkTextLineSegment *gtk_mark_segment_new (GtkTextMark *mark_obj);
105

Matthias Clasen's avatar
Matthias Clasen committed
106
G_DEFINE_TYPE (GtkTextMark, gtk_text_mark, G_TYPE_OBJECT)
107

108 109 110 111 112
enum {
  PROP_0,
  PROP_NAME,
  PROP_LEFT_GRAVITY
};
113

114 115
static void
gtk_text_mark_class_init (GtkTextMarkClass *klass)
116
{
117
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
118

119
  object_class->finalize = gtk_text_mark_finalize;
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
  object_class->set_property = gtk_text_mark_set_property;
  object_class->get_property = gtk_text_mark_get_property;

  g_object_class_install_property (object_class,
                                   PROP_NAME,
                                   g_param_spec_string ("name",
                                                        P_("Name"),
                                                        P_("Mark name"),
                                                        NULL,
                                                        GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));

  g_object_class_install_property (object_class,
                                   PROP_LEFT_GRAVITY,
                                   g_param_spec_boolean ("left-gravity",
                                                         P_("Left gravity"),
                                                         P_("Whether the mark has left gravity"),
                                                         FALSE,
                                                         GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
}

static void
gtk_text_mark_init (GtkTextMark *mark)
{
  mark->segment = gtk_mark_segment_new (mark);
144 145
}

146 147
static void
gtk_text_mark_finalize (GObject *obj)
148
{
149
  GtkTextMark *mark;
150 151
  GtkTextLineSegment *seg;

152
  mark = GTK_TEXT_MARK (obj);
153

154
  seg = mark->segment;
155

156 157 158 159 160 161
  if (seg)
    {
      if (seg->body.mark.tree != NULL)
        g_warning ("GtkTextMark being finalized while still in the buffer; "
                   "someone removed a reference they didn't own! Crash "
                   "impending");
162

163 164 165 166 167
      g_free (seg->body.mark.name);
      g_free (seg);

      mark->segment = NULL;
    }
168 169

  /* chain parent_class' handler */
Matthias Clasen's avatar
Matthias Clasen committed
170
  G_OBJECT_CLASS (gtk_text_mark_parent_class)->finalize (obj);
171 172
}

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
static void
gtk_text_mark_set_property (GObject      *object,
			    guint         prop_id,
			    const GValue *value,
			    GParamSpec   *pspec)
{
  gchar *tmp;
  GtkTextMark *mark = GTK_TEXT_MARK (object);
  GtkTextLineSegment *seg = mark->segment;

  switch (prop_id)
    {
    case PROP_NAME:
      tmp = seg->body.mark.name;
      seg->body.mark.name = g_value_dup_string (value);
      g_free (tmp);
      break;

    case PROP_LEFT_GRAVITY:
      if (g_value_get_boolean (value))
	seg->type = &gtk_text_left_mark_type;
      else
	seg->type = &gtk_text_right_mark_type;
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
gtk_text_mark_get_property (GObject    *object,
			    guint       prop_id,
			    GValue     *value,
			    GParamSpec *pspec)
{
  GtkTextMark *mark = GTK_TEXT_MARK (object);

  switch (prop_id)
    {
    case PROP_NAME:
      g_value_set_string (value, gtk_text_mark_get_name (mark));
      break;

    case PROP_LEFT_GRAVITY:
      g_value_set_boolean (value, gtk_text_mark_get_left_gravity (mark));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

/**
 * gtk_text_mark_new:
228
 * @name: (allow-none): mark name or %NULL
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
 * @left_gravity: whether the mark should have left gravity
 *
 * Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
 * If @name is %NULL, the mark is anonymous; otherwise, the mark can be 
 * retrieved by name using gtk_text_buffer_get_mark(). If a mark has left 
 * gravity, and text is inserted at the mark's current location, the mark 
 * will be moved to the left of the newly-inserted text. If the mark has 
 * right gravity (@left_gravity = %FALSE), the mark will end up on the 
 * right of newly-inserted text. The standard left-to-right cursor is a 
 * mark with right gravity (when you type, the cursor stays on the right
 * side of the text you're typing).
 *
 * Return value: new #GtkTextMark
 *
 * Since: 2.12
 **/
GtkTextMark *
gtk_text_mark_new (const gchar *name,
		   gboolean     left_gravity)
{
  return g_object_new (GTK_TYPE_TEXT_MARK,
		       "name", name,
		       "left-gravity", left_gravity,
		       NULL);
}

255
/**
256
 * gtk_text_mark_get_visible:
257 258 259
 * @mark: a #GtkTextMark
 * 
 * Returns %TRUE if the mark is visible (i.e. a cursor is displayed
Matthias Clasen's avatar
Matthias Clasen committed
260
 * for it).
261 262 263
 * 
 * Return value: %TRUE if visible
 **/
264
gboolean
265
gtk_text_mark_get_visible (GtkTextMark *mark)
266 267 268
{
  GtkTextLineSegment *seg;

269 270 271 272 273
  seg = mark->segment;

  return seg->body.mark.visible;
}

274 275 276 277 278 279 280 281
/**
 * gtk_text_mark_get_name:
 * @mark: a #GtkTextMark
 * 
 * Returns the mark name; returns NULL for anonymous marks.
 * 
 * Return value: mark name
 **/
282 283 284 285 286 287 288 289
const char *
gtk_text_mark_get_name (GtkTextMark *mark)
{
  GtkTextLineSegment *seg;

  seg = mark->segment;

  return seg->body.mark.name;
290 291
}

292 293 294 295 296
/**
 * gtk_text_mark_get_deleted:
 * @mark: a #GtkTextMark
 * 
 * Returns %TRUE if the mark has been removed from its buffer
297 298
 * with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark()
 * for a way to add it to a buffer again.
299 300 301
 * 
 * Return value: whether the mark is deleted
 **/
302
gboolean
303
gtk_text_mark_get_deleted (GtkTextMark *mark)
304 305
{
  GtkTextLineSegment *seg;
306

307
  g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
308

309 310 311 312
  seg = mark->segment;

  if (seg == NULL)
    return TRUE;
313

314 315 316
  return seg->body.mark.tree == NULL;
}

317 318 319 320 321
/**
 * gtk_text_mark_get_buffer:
 * @mark: a #GtkTextMark
 * 
 * Gets the buffer this mark is located inside,
Matthias Clasen's avatar
Matthias Clasen committed
322
 * or %NULL if the mark is deleted.
323 324
 *
 * Return value: (transfer none): the mark's #GtkTextBuffer
325 326 327 328 329 330
 **/
GtkTextBuffer*
gtk_text_mark_get_buffer (GtkTextMark *mark)
{
  GtkTextLineSegment *seg;

331
  g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), NULL);
332 333 334 335 336 337

  seg = mark->segment;

  if (seg->body.mark.tree == NULL)
    return NULL;
  else
338
    return _gtk_text_btree_get_buffer (seg->body.mark.tree);
339 340
}

341 342 343 344
/**
 * gtk_text_mark_get_left_gravity:
 * @mark: a #GtkTextMark
 * 
345
 * Determines whether the mark has left gravity.
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
 * 
 * Return value: %TRUE if the mark has left gravity, %FALSE otherwise
 **/
gboolean
gtk_text_mark_get_left_gravity (GtkTextMark *mark)
{
  GtkTextLineSegment *seg;

  g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
  
  seg = mark->segment;

  return seg->type == &gtk_text_left_mark_type;
}

361 362 363 364
/*
 * Macro that determines the size of a mark segment:
 */

365 366
#define MSEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
        + sizeof (GtkTextMarkBody)))
367 368


369 370
static GtkTextLineSegment *
gtk_mark_segment_new (GtkTextMark *mark_obj)
371 372 373
{
  GtkTextLineSegment *mark;

374
  mark = (GtkTextLineSegment *) g_malloc0 (MSEG_SIZE);
375 376
  mark->body.mark.name = NULL;
  mark->type = &gtk_text_right_mark_type;
377

378 379 380
  mark->byte_count = 0;
  mark->char_count = 0;

381 382
  mark->body.mark.obj = mark_obj;
  mark_obj->segment = mark;
383

384
  mark->body.mark.tree = NULL;
385 386 387 388
  mark->body.mark.line = NULL;
  mark->next = NULL;

  mark->body.mark.visible = FALSE;
389
  mark->body.mark.not_deleteable = FALSE;
390

391 392 393
  return mark;
}

394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
void
_gtk_mark_segment_set_tree (GtkTextLineSegment *mark,
			    GtkTextBTree       *tree)
{
  g_assert (mark->body.mark.tree == NULL);
  g_assert (mark->body.mark.obj != NULL);

  mark->byte_count = 0;
  mark->char_count = 0;

  mark->body.mark.tree = tree;
  mark->body.mark.line = NULL;
  mark->next = NULL;

  mark->body.mark.not_deleteable = FALSE;
}

411 412 413 414 415 416 417 418
static int                 mark_segment_delete_func  (GtkTextLineSegment *segPtr,
                                                      GtkTextLine        *line,
                                                      int                 treeGone);
static GtkTextLineSegment *mark_segment_cleanup_func (GtkTextLineSegment *segPtr,
                                                      GtkTextLine        *line);
static void                mark_segment_check_func   (GtkTextLineSegment *segPtr,
                                                      GtkTextLine        *line);

419 420 421 422 423 424 425 426

/*
 * The following structures declare the "mark" segment types.
 * There are actually two types for marks, one with left gravity
 * and one with right gravity.  They are identical except for
 * their gravity property.
 */

Matthias Clasen's avatar
Matthias Clasen committed
427
const GtkTextLineSegmentClass gtk_text_right_mark_type = {
428 429 430 431 432 433 434
  "mark",                                               /* name */
  FALSE,                                                /* leftGravity */
  NULL,                                         /* splitFunc */
  mark_segment_delete_func,                             /* deleteFunc */
  mark_segment_cleanup_func,                            /* cleanupFunc */
  NULL,                                         /* lineChangeFunc */
  mark_segment_check_func                               /* checkFunc */
435 436
};

Matthias Clasen's avatar
Matthias Clasen committed
437
const GtkTextLineSegmentClass gtk_text_left_mark_type = {
438 439 440 441 442 443 444
  "mark",                                               /* name */
  TRUE,                                         /* leftGravity */
  NULL,                                         /* splitFunc */
  mark_segment_delete_func,                             /* deleteFunc */
  mark_segment_cleanup_func,                            /* cleanupFunc */
  NULL,                                         /* lineChangeFunc */
  mark_segment_check_func                               /* checkFunc */
445 446 447 448 449 450 451
};

/*
 *--------------------------------------------------------------
 *
 * mark_segment_delete_func --
 *
452 453
 *      This procedure is invoked by the text B-tree code whenever
 *      a mark lies in a range of characters being deleted.
454 455
 *
 * Results:
Havoc Pennington's avatar
Havoc Pennington committed
456 457
 *      Returns 1 to indicate that deletion has been rejected,
 *      or 0 otherwise
458 459
 *
 * Side effects:
Havoc Pennington's avatar
Havoc Pennington committed
460
 *      Frees mark if tree is going away
461 462 463 464
 *
 *--------------------------------------------------------------
 */

465
static gboolean
Havoc Pennington's avatar
Havoc Pennington committed
466
mark_segment_delete_func (GtkTextLineSegment *seg,
467 468
                          GtkTextLine        *line,
                          gboolean            tree_gone)
469
{
Havoc Pennington's avatar
Havoc Pennington committed
470 471 472 473 474 475 476
  if (tree_gone)
    {
      _gtk_text_btree_release_mark_segment (seg->body.mark.tree, seg);
      return FALSE;
    }
  else
    return TRUE;
477
}
478

479 480 481 482 483
/*
 *--------------------------------------------------------------
 *
 * mark_segment_cleanup_func --
 *
484 485
 *      This procedure is invoked by the B-tree code whenever a
 *      mark segment is moved from one line to another.
486 487
 *
 * Results:
488
 *      None.
489 490
 *
 * Side effects:
491
 *      The line field of the segment gets updated.
492 493 494 495 496
 *
 *--------------------------------------------------------------
 */

static GtkTextLineSegment *
497 498
mark_segment_cleanup_func (GtkTextLineSegment *seg,
                           GtkTextLine        *line)
499
{
500 501 502
  /* not sure why Tk did this here and not in LineChangeFunc */
  seg->body.mark.line = line;
  return seg;
503 504 505 506 507 508 509
}

/*
 *--------------------------------------------------------------
 *
 * mark_segment_check_func --
 *
510 511
 *      This procedure is invoked by the B-tree code to perform
 *      consistency checks on mark segments.
512 513
 *
 * Results:
514
 *      None.
515 516
 *
 * Side effects:
517 518
 *      The procedure panics if it detects anything wrong with
 *      the mark.
519 520 521 522 523
 *
 *--------------------------------------------------------------
 */

static void
524 525
mark_segment_check_func (GtkTextLineSegment *seg,
                         GtkTextLine        *line)
526
{
527
  if (seg->body.mark.line != line)
528
    g_error ("mark_segment_check_func: seg->body.mark.line bogus");
529
}