gtktextmark.c 11.1 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 52
#include "gtktextbtree.h"

Havoc Pennington's avatar
Havoc Pennington committed
53 54 55 56 57 58 59 60 61
static void gtk_text_mark_init       (GtkTextMark      *mark);
static void gtk_text_mark_class_init (GtkTextMarkClass *klass);
static void gtk_text_mark_finalize   (GObject          *obj);


static gpointer parent_class = NULL;

GType
gtk_text_mark_get_type (void)
62
{
Havoc Pennington's avatar
Havoc Pennington committed
63
  static GType object_type = 0;
64

Havoc Pennington's avatar
Havoc Pennington committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78
  if (!object_type)
    {
      static const GTypeInfo object_info =
      {
        sizeof (GtkTextMarkClass),
        (GBaseInitFunc) NULL,
        (GBaseFinalizeFunc) NULL,
        (GClassInitFunc) gtk_text_mark_class_init,
        NULL,           /* class_finalize */
        NULL,           /* class_data */
        sizeof (GtkTextMark),
        0,              /* n_preallocs */
        (GInstanceInitFunc) gtk_text_mark_init,
      };
79

Manish Singh's avatar
Manish Singh committed
80
      object_type = g_type_register_static (G_TYPE_OBJECT, "GtkTextMark",
81
                                            &object_info, 0);
Havoc Pennington's avatar
Havoc Pennington committed
82
    }
83

Havoc Pennington's avatar
Havoc Pennington committed
84 85
  return object_type;
}
86

Havoc Pennington's avatar
Havoc Pennington committed
87 88 89 90
static void
gtk_text_mark_init (GtkTextMark *mark)
{
  mark->segment = NULL;
91 92
}

Havoc Pennington's avatar
Havoc Pennington committed
93 94
static void
gtk_text_mark_class_init (GtkTextMarkClass *klass)
95
{
Havoc Pennington's avatar
Havoc Pennington committed
96
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
97

Havoc Pennington's avatar
Havoc Pennington committed
98
  parent_class = g_type_class_peek_parent (klass);
99

Havoc Pennington's avatar
Havoc Pennington committed
100
  object_class->finalize = gtk_text_mark_finalize;
101 102
}

Havoc Pennington's avatar
Havoc Pennington committed
103 104
static void
gtk_text_mark_finalize (GObject *obj)
105
{
Havoc Pennington's avatar
Havoc Pennington committed
106
  GtkTextMark *mark;
107 108
  GtkTextLineSegment *seg;

Havoc Pennington's avatar
Havoc Pennington committed
109
  mark = GTK_TEXT_MARK (obj);
110

Havoc Pennington's avatar
Havoc Pennington committed
111
  seg = mark->segment;
112

Havoc Pennington's avatar
Havoc Pennington committed
113 114 115 116 117 118
  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");
119

Havoc Pennington's avatar
Havoc Pennington committed
120 121 122 123 124
      g_free (seg->body.mark.name);
      g_free (seg);

      mark->segment = NULL;
    }
125 126 127

  /* chain parent_class' handler */
  G_OBJECT_CLASS (parent_class)->finalize (obj);
128 129
}

130
/**
131
 * gtk_text_mark_get_visible:
132 133 134 135 136 137 138
 * @mark: a #GtkTextMark
 * 
 * Returns %TRUE if the mark is visible (i.e. a cursor is displayed
 * for it)
 * 
 * Return value: %TRUE if visible
 **/
Havoc Pennington's avatar
Havoc Pennington committed
139
gboolean
140
gtk_text_mark_get_visible (GtkTextMark *mark)
141 142 143
{
  GtkTextLineSegment *seg;

Havoc Pennington's avatar
Havoc Pennington committed
144 145 146 147 148
  seg = mark->segment;

  return seg->body.mark.visible;
}

149 150 151 152 153 154 155 156
/**
 * gtk_text_mark_get_name:
 * @mark: a #GtkTextMark
 * 
 * Returns the mark name; returns NULL for anonymous marks.
 * 
 * Return value: mark name
 **/
Havoc Pennington's avatar
Havoc Pennington committed
157 158 159 160 161 162 163 164
const char *
gtk_text_mark_get_name (GtkTextMark *mark)
{
  GtkTextLineSegment *seg;

  seg = mark->segment;

  return seg->body.mark.name;
165 166
}

167 168 169 170 171 172 173 174 175 176
/**
 * gtk_text_mark_get_deleted:
 * @mark: a #GtkTextMark
 * 
 * Returns %TRUE if the mark has been removed from its buffer
 * with gtk_text_buffer_delete_mark(). Marks can't be used
 * once deleted.
 * 
 * Return value: whether the mark is deleted
 **/
177
gboolean
178
gtk_text_mark_get_deleted (GtkTextMark *mark)
179 180
{
  GtkTextLineSegment *seg;
181

182
  g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), FALSE);
183

Havoc Pennington's avatar
Havoc Pennington committed
184 185 186 187
  seg = mark->segment;

  if (seg == NULL)
    return TRUE;
188

189 190 191
  return seg->body.mark.tree == NULL;
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205
/**
 * gtk_text_mark_get_buffer:
 * @mark: a #GtkTextMark
 * 
 * Gets the buffer this mark is located inside,
 * or NULL if the mark is deleted.
 * 
 * Return value: the mark's #GtkTextBuffer
 **/
GtkTextBuffer*
gtk_text_mark_get_buffer (GtkTextMark *mark)
{
  GtkTextLineSegment *seg;

206
  g_return_val_if_fail (GTK_IS_TEXT_MARK (mark), NULL);
207 208 209 210 211 212

  seg = mark->segment;

  if (seg->body.mark.tree == NULL)
    return NULL;
  else
213
    return _gtk_text_btree_get_buffer (seg->body.mark.tree);
214 215
}

216 217 218 219
/**
 * gtk_text_mark_get_left_gravity:
 * @mark: a #GtkTextMark
 * 
220
 * Determines whether the mark has left gravity.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
 * 
 * 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;
}

236 237 238 239
/*
 * Macro that determines the size of a mark segment:
 */

240 241
#define MSEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
        + sizeof (GtkTextMarkBody)))
242 243 244


GtkTextLineSegment*
Havoc Pennington's avatar
Havoc Pennington committed
245 246 247
_gtk_mark_segment_new (GtkTextBTree *tree,
                       gboolean      left_gravity,
                       const gchar  *name)
248 249 250
{
  GtkTextLineSegment *mark;

251 252
  mark = (GtkTextLineSegment *) g_malloc0 (MSEG_SIZE);
  mark->body.mark.name = g_strdup (name);
253 254 255 256 257

  if (left_gravity)
    mark->type = &gtk_text_left_mark_type;
  else
    mark->type = &gtk_text_right_mark_type;
258

259 260 261
  mark->byte_count = 0;
  mark->char_count = 0;

Havoc Pennington's avatar
Havoc Pennington committed
262 263
  mark->body.mark.obj = g_object_new (GTK_TYPE_TEXT_MARK, NULL);
  mark->body.mark.obj->segment = mark;
264

265 266 267 268 269
  mark->body.mark.tree = tree;
  mark->body.mark.line = NULL;
  mark->next = NULL;

  mark->body.mark.visible = FALSE;
270
  mark->body.mark.not_deleteable = FALSE;
271

272 273 274
  return mark;
}

275 276 277 278 279 280 281 282
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);

283 284 285 286 287 288 289 290 291

/*
 * 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.
 */

GtkTextLineSegmentClass gtk_text_right_mark_type = {
292 293 294 295 296 297 298
  "mark",                                               /* name */
  FALSE,                                                /* leftGravity */
  NULL,                                         /* splitFunc */
  mark_segment_delete_func,                             /* deleteFunc */
  mark_segment_cleanup_func,                            /* cleanupFunc */
  NULL,                                         /* lineChangeFunc */
  mark_segment_check_func                               /* checkFunc */
299 300 301
};

GtkTextLineSegmentClass gtk_text_left_mark_type = {
302 303 304 305 306 307 308
  "mark",                                               /* name */
  TRUE,                                         /* leftGravity */
  NULL,                                         /* splitFunc */
  mark_segment_delete_func,                             /* deleteFunc */
  mark_segment_cleanup_func,                            /* cleanupFunc */
  NULL,                                         /* lineChangeFunc */
  mark_segment_check_func                               /* checkFunc */
309 310 311 312 313 314 315
};

/*
 *--------------------------------------------------------------
 *
 * mark_segment_delete_func --
 *
316 317
 *      This procedure is invoked by the text B-tree code whenever
 *      a mark lies in a range of characters being deleted.
318 319
 *
 * Results:
Havoc Pennington's avatar
Havoc Pennington committed
320 321
 *      Returns 1 to indicate that deletion has been rejected,
 *      or 0 otherwise
322 323
 *
 * Side effects:
Havoc Pennington's avatar
Havoc Pennington committed
324
 *      Frees mark if tree is going away
325 326 327 328
 *
 *--------------------------------------------------------------
 */

329
static gboolean
Havoc Pennington's avatar
Havoc Pennington committed
330
mark_segment_delete_func (GtkTextLineSegment *seg,
331 332
                          GtkTextLine        *line,
                          gboolean            tree_gone)
333
{
Havoc Pennington's avatar
Havoc Pennington committed
334 335 336 337 338 339 340
  if (tree_gone)
    {
      _gtk_text_btree_release_mark_segment (seg->body.mark.tree, seg);
      return FALSE;
    }
  else
    return TRUE;
341
}
342

343 344 345 346 347
/*
 *--------------------------------------------------------------
 *
 * mark_segment_cleanup_func --
 *
348 349
 *      This procedure is invoked by the B-tree code whenever a
 *      mark segment is moved from one line to another.
350 351
 *
 * Results:
352
 *      None.
353 354
 *
 * Side effects:
355
 *      The line field of the segment gets updated.
356 357 358 359 360
 *
 *--------------------------------------------------------------
 */

static GtkTextLineSegment *
361 362
mark_segment_cleanup_func (GtkTextLineSegment *seg,
                           GtkTextLine        *line)
363
{
364 365 366
  /* not sure why Tk did this here and not in LineChangeFunc */
  seg->body.mark.line = line;
  return seg;
367 368 369 370 371 372 373
}

/*
 *--------------------------------------------------------------
 *
 * mark_segment_check_func --
 *
374 375
 *      This procedure is invoked by the B-tree code to perform
 *      consistency checks on mark segments.
376 377
 *
 * Results:
378
 *      None.
379 380
 *
 * Side effects:
381 382
 *      The procedure panics if it detects anything wrong with
 *      the mark.
383 384 385 386 387
 *
 *--------------------------------------------------------------
 */

static void
388 389
mark_segment_check_func (GtkTextLineSegment *seg,
                         GtkTextLine        *line)
390
{
391
  if (seg->body.mark.line != line)
392
    g_error ("mark_segment_check_func: seg->body.mark.line bogus");
393
}