gtktextchild.c 15.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/* gtktextchild.c - child pixmaps and widgets
 *
 * Copyright (c) 1994 The Regents of the University of California.
 * Copyright (c) 1994-1997 Sun Microsystems, Inc.
 * Copyright (c) 2000      Red Hat, Inc.
 * Tk -> Gtk port by Havoc Pennington <hp@redhat.com>
 *
 * 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 35 36 37 38 39 40 41 42 43 44 45 46
 * 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.
 *
 * 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 53
#include "gtktextchild.h"
#include "gtktextbtree.h"
54
#include "gtktextlayout.h"
55
#include "gtkintl.h"
56

57 58 59 60 61
#define CHECK_IN_BUFFER(anchor)                                         \
  G_STMT_START {                                                        \
    if ((anchor)->segment == NULL)                                      \
      {                                                                 \
        g_warning ("%s: GtkTextChildAnchor hasn't been in a buffer yet",\
62
                   G_STRFUNC);                                          \
63
      }                                                                 \
64 65
  } G_STMT_END

66 67 68 69 70
#define CHECK_IN_BUFFER_RETURN(anchor, val)                             \
  G_STMT_START {                                                        \
    if ((anchor)->segment == NULL)                                      \
      {                                                                 \
        g_warning ("%s: GtkTextChildAnchor hasn't been in a buffer yet",\
71
                   G_STRFUNC);                                          \
72 73
        return (val);                                                   \
      }                                                                 \
74
  } G_STMT_END
75

76 77 78 79 80 81
#define PIXBUF_SEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
        + sizeof (GtkTextPixbuf)))

#define WIDGET_SEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
        + sizeof (GtkTextChildBody)))

82
static GtkTextLineSegment *
Havoc Pennington's avatar
Havoc Pennington committed
83 84
pixbuf_segment_cleanup_func (GtkTextLineSegment *seg,
                             GtkTextLine        *line)
85 86 87 88 89 90
{
  /* nothing */
  return seg;
}

static int
91 92 93
pixbuf_segment_delete_func (GtkTextLineSegment *seg,
                            GtkTextLine        *line,
                            gboolean            tree_gone)
94
{
Havoc Pennington's avatar
Havoc Pennington committed
95
  if (seg->body.pixbuf.pixbuf)
Manish Singh's avatar
Manish Singh committed
96
    g_object_unref (seg->body.pixbuf.pixbuf);
97

98
  g_slice_free1 (PIXBUF_SEG_SIZE, seg);
99 100 101 102 103

  return 0;
}

static void
104 105
pixbuf_segment_check_func (GtkTextLineSegment *seg,
                           GtkTextLine        *line)
106 107
{
  if (seg->next == NULL)
108
    g_error ("pixbuf segment is the last segment in a line");
109

110
  if (seg->byte_count != GTK_TEXT_UNKNOWN_CHAR_UTF8_LEN)
111 112
    g_error ("pixbuf segment has byte count of %d", seg->byte_count);

113
  if (seg->char_count != 1)
114
    g_error ("pixbuf segment has char count of %d", seg->char_count);
115 116 117
}


Matthias Clasen's avatar
Matthias Clasen committed
118
const GtkTextLineSegmentClass gtk_text_pixbuf_type = {
Havoc Pennington's avatar
Havoc Pennington committed
119
  "pixbuf",                          /* name */
120
  FALSE,                                            /* leftGravity */
121
  NULL,                                          /* splitFunc */
Havoc Pennington's avatar
Havoc Pennington committed
122 123
  pixbuf_segment_delete_func,                             /* deleteFunc */
  pixbuf_segment_cleanup_func,                            /* cleanupFunc */
124
  NULL,                                                    /* lineChangeFunc */
Havoc Pennington's avatar
Havoc Pennington committed
125
  pixbuf_segment_check_func                               /* checkFunc */
126 127 128 129

};

GtkTextLineSegment *
Havoc Pennington's avatar
Havoc Pennington committed
130
_gtk_pixbuf_segment_new (GdkPixbuf *pixbuf)
131 132 133
{
  GtkTextLineSegment *seg;

134
  seg = g_slice_alloc (PIXBUF_SEG_SIZE);
135

Havoc Pennington's avatar
Havoc Pennington committed
136
  seg->type = &gtk_text_pixbuf_type;
137 138 139

  seg->next = NULL;

140 141 142 143
  /* We convert to the 0xFFFC "unknown character",
   * a 3-byte sequence in UTF-8.
   */
  seg->byte_count = GTK_TEXT_UNKNOWN_CHAR_UTF8_LEN;
144
  seg->char_count = 1;
145

Havoc Pennington's avatar
Havoc Pennington committed
146
  seg->body.pixbuf.pixbuf = pixbuf;
147

Manish Singh's avatar
Manish Singh committed
148
  g_object_ref (pixbuf);
149

150 151
  return seg;
}
152 153 154 155 156 157 158


static GtkTextLineSegment *
child_segment_cleanup_func (GtkTextLineSegment *seg,
                            GtkTextLine        *line)
{
  seg->body.child.line = line;
159

160 161 162 163 164 165 166 167
  return seg;
}

static int
child_segment_delete_func (GtkTextLineSegment *seg,
                           GtkTextLine       *line,
                           gboolean           tree_gone)
{
168 169
  GSList *tmp_list;
  GSList *copy;
170

171
  _gtk_text_btree_unregister_child_anchor (seg->body.child.obj);
172 173 174 175 176 177 178 179 180 181 182 183 184
  
  seg->body.child.tree = NULL;
  seg->body.child.line = NULL;

  /* avoid removing widgets while walking the list */
  copy = g_slist_copy (seg->body.child.widgets);
  tmp_list = copy;
  while (tmp_list != NULL)
    {
      GtkWidget *child = tmp_list->data;

      gtk_widget_destroy (child);
      
185
      tmp_list = tmp_list->next;
186 187 188 189 190 191 192 193 194 195 196
    }

  /* On removal from the widget's parents (GtkTextView),
   * the widget should have been removed from the anchor.
   */
  g_assert (seg->body.child.widgets == NULL);

  g_slist_free (copy);
  
  _gtk_widget_segment_unref (seg);  
  
197 198 199 200 201 202 203 204
  return 0;
}

static void
child_segment_check_func (GtkTextLineSegment *seg,
                          GtkTextLine        *line)
{
  if (seg->next == NULL)
205
    g_error ("child segment is the last segment in a line");
206

207
  if (seg->byte_count != GTK_TEXT_UNKNOWN_CHAR_UTF8_LEN)
208 209
    g_error ("child segment has byte count of %d", seg->byte_count);

210
  if (seg->char_count != 1)
211
    g_error ("child segment has char count of %d", seg->char_count);
212 213
}

Matthias Clasen's avatar
Matthias Clasen committed
214
const GtkTextLineSegmentClass gtk_text_child_type = {
215 216 217 218 219 220 221 222 223 224
  "child-widget",                                        /* name */
  FALSE,                                                 /* leftGravity */
  NULL,                                                  /* splitFunc */
  child_segment_delete_func,                             /* deleteFunc */
  child_segment_cleanup_func,                            /* cleanupFunc */
  NULL,                                                  /* lineChangeFunc */
  child_segment_check_func                               /* checkFunc */
};

GtkTextLineSegment *
225
_gtk_widget_segment_new (GtkTextChildAnchor *anchor)
226 227 228
{
  GtkTextLineSegment *seg;

229
  seg = g_slice_alloc (WIDGET_SEG_SIZE);
230 231 232 233 234

  seg->type = &gtk_text_child_type;

  seg->next = NULL;

235 236 237 238
  /* We convert to the 0xFFFC "unknown character",
   * a 3-byte sequence in UTF-8.
   */
  seg->byte_count = GTK_TEXT_UNKNOWN_CHAR_UTF8_LEN;
239
  seg->char_count = 1;
240

241
  seg->body.child.obj = anchor;
242
  seg->body.child.obj->segment = seg;
243 244 245
  seg->body.child.widgets = NULL;
  seg->body.child.tree = NULL;
  seg->body.child.line = NULL;
246

Manish Singh's avatar
Manish Singh committed
247
  g_object_ref (anchor);
248
  
249 250 251 252
  return seg;
}

void
Havoc Pennington's avatar
Havoc Pennington committed
253
_gtk_widget_segment_add    (GtkTextLineSegment *widget_segment,
254
                            GtkWidget          *child)
255
{
256
  g_return_if_fail (widget_segment->type == &gtk_text_child_type);
257
  g_return_if_fail (widget_segment->body.child.tree != NULL);
258

Manish Singh's avatar
Manish Singh committed
259
  g_object_ref (child);
260
  
261 262 263 264 265 266
  widget_segment->body.child.widgets =
    g_slist_prepend (widget_segment->body.child.widgets,
                     child);
}

void
Havoc Pennington's avatar
Havoc Pennington committed
267
_gtk_widget_segment_remove (GtkTextLineSegment *widget_segment,
268
                            GtkWidget          *child)
269
{
270
  g_return_if_fail (widget_segment->type == &gtk_text_child_type);
271
  
272 273 274 275
  widget_segment->body.child.widgets =
    g_slist_remove (widget_segment->body.child.widgets,
                    child);

Manish Singh's avatar
Manish Singh committed
276
  g_object_unref (child);
277 278 279
}

void
Havoc Pennington's avatar
Havoc Pennington committed
280
_gtk_widget_segment_ref (GtkTextLineSegment *widget_segment)
281
{
282
  g_assert (widget_segment->type == &gtk_text_child_type);
283

Manish Singh's avatar
Manish Singh committed
284
  g_object_ref (widget_segment->body.child.obj);
285 286 287
}

void
Havoc Pennington's avatar
Havoc Pennington committed
288
_gtk_widget_segment_unref (GtkTextLineSegment *widget_segment)
289
{
290
  g_assert (widget_segment->type == &gtk_text_child_type);
291

Manish Singh's avatar
Manish Singh committed
292
  g_object_unref (widget_segment->body.child.obj);
293
}
294

295 296 297
GtkTextLayout*
_gtk_anchored_child_get_layout (GtkWidget *child)
{
298
  return g_object_get_data (G_OBJECT (child), "gtk-text-child-anchor-layout");  
299
}
300

301 302 303 304
static void
_gtk_anchored_child_set_layout (GtkWidget     *child,
                                GtkTextLayout *layout)
{
305
  g_object_set_data (G_OBJECT (child),
306
                     I_("gtk-text-child-anchor-layout"),
307
                     layout);  
308 309
}
     
Matthias Clasen's avatar
Matthias Clasen committed
310
static void gtk_text_child_anchor_finalize (GObject *obj);
311

Matthias Clasen's avatar
Matthias Clasen committed
312
G_DEFINE_TYPE (GtkTextChildAnchor, gtk_text_child_anchor, G_TYPE_OBJECT)
313

314 315
static void
gtk_text_child_anchor_init (GtkTextChildAnchor *child_anchor)
316
{
317 318
  child_anchor->segment = NULL;
}
319

320 321 322 323
static void
gtk_text_child_anchor_class_init (GtkTextChildAnchorClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
324

325
  object_class->finalize = gtk_text_child_anchor_finalize;
326 327
}

328 329 330 331 332 333 334 335
/**
 * gtk_text_child_anchor_new:
 * 
 * Creates a new #GtkTextChildAnchor. Usually you would then insert
 * it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
 * To perform the creation and insertion in one step, use the
 * convenience function gtk_text_buffer_create_child_anchor().
 * 
336
 * Returns: a new #GtkTextChildAnchor
337
 **/
338 339 340
GtkTextChildAnchor*
gtk_text_child_anchor_new (void)
{
Manish Singh's avatar
Manish Singh committed
341
  return g_object_new (GTK_TYPE_TEXT_CHILD_ANCHOR, NULL);
342 343
}

344 345
static void
gtk_text_child_anchor_finalize (GObject *obj)
346
{
347 348 349 350
  GtkTextChildAnchor *anchor;
  GtkTextLineSegment *seg;
  
  anchor = GTK_TEXT_CHILD_ANCHOR (obj);
351

352 353
  seg = anchor->segment;
  
354
  if (seg)
355
    {
356 357 358 359 360 361 362
      if (seg->body.child.tree != NULL)
        {
          g_warning ("Someone removed a reference to a GtkTextChildAnchor "
                     "they didn't own; the anchor is still in the text buffer "
                     "and the refcount is 0.");
          return;
        }
Matthias Clasen's avatar
Matthias Clasen committed
363 364

      g_slist_free_full (seg->body.child.widgets, g_object_unref);
365 366

      g_slice_free1 (WIDGET_SEG_SIZE, seg);
367
    }
368

369
  anchor->segment = NULL;
370

Matthias Clasen's avatar
Matthias Clasen committed
371
  G_OBJECT_CLASS (gtk_text_child_anchor_parent_class)->finalize (obj);
372 373
}

374 375 376 377 378 379
/**
 * gtk_text_child_anchor_get_widgets:
 * @anchor: a #GtkTextChildAnchor
 * 
 * Gets a list of all widgets anchored at this child anchor.
 * The returned list should be freed with g_list_free().
380 381
 *
 *
382
 * Returns: (element-type GtkWidget) (transfer container): list of widgets anchored at @anchor
383
 **/
384 385 386
GList*
gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
{
387
  GtkTextLineSegment *seg = anchor->segment;
388 389
  GList *list = NULL;
  GSList *iter;
390

391 392
  CHECK_IN_BUFFER_RETURN (anchor, NULL);
  
393
  g_return_val_if_fail (seg->type == &gtk_text_child_type, NULL);
394

395 396 397 398 399
  iter = seg->body.child.widgets;
  while (iter != NULL)
    {
      list = g_list_prepend (list, iter->data);

400
      iter = iter->next;
401 402 403 404 405 406 407 408
    }

  /* Order is not relevant, so we don't need to reverse the list
   * again.
   */
  return list;
}

409 410 411 412 413 414 415 416
/**
 * gtk_text_child_anchor_get_deleted:
 * @anchor: a #GtkTextChildAnchor
 * 
 * Determines whether a child anchor has been deleted from
 * the buffer. Keep in mind that the child anchor will be
 * unreferenced when removed from the buffer, so you need to
 * hold your own reference (with g_object_ref()) if you plan
417
 * to use this function — otherwise all deleted child anchors
418 419
 * will also be finalized.
 * 
420
 * Returns: %TRUE if the child anchor has been deleted from its buffer
421
 **/
422 423 424
gboolean
gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor)
{
425
  GtkTextLineSegment *seg = anchor->segment;
426

427 428
  CHECK_IN_BUFFER_RETURN (anchor, TRUE);
  
429
  g_return_val_if_fail (seg->type == &gtk_text_child_type, TRUE);
430 431 432 433

  return seg->body.child.tree == NULL;
}

434 435 436 437 438 439 440
void
gtk_text_child_anchor_register_child (GtkTextChildAnchor *anchor,
                                      GtkWidget          *child,
                                      GtkTextLayout      *layout)
{
  g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
  g_return_if_fail (GTK_IS_WIDGET (child));
441

442 443
  CHECK_IN_BUFFER (anchor);
  
444 445 446 447 448 449 450 451 452 453 454 455 456
  _gtk_anchored_child_set_layout (child, layout);
  
  _gtk_widget_segment_add (anchor->segment, child);

  gtk_text_child_anchor_queue_resize (anchor, layout);
}

void
gtk_text_child_anchor_unregister_child (GtkTextChildAnchor *anchor,
                                        GtkWidget          *child)
{
  g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
  g_return_if_fail (GTK_IS_WIDGET (child));
457

458 459
  CHECK_IN_BUFFER (anchor);
  
460 461 462 463 464
  if (_gtk_anchored_child_get_layout (child))
    {
      gtk_text_child_anchor_queue_resize (anchor,
                                          _gtk_anchored_child_get_layout (child));
    }
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
  
  _gtk_anchored_child_set_layout (child, NULL);
  
  _gtk_widget_segment_remove (anchor->segment, child);
}

void
gtk_text_child_anchor_queue_resize (GtkTextChildAnchor *anchor,
                                    GtkTextLayout      *layout)
{
  GtkTextIter start;
  GtkTextIter end;
  GtkTextLineSegment *seg;
  
  g_return_if_fail (GTK_IS_TEXT_CHILD_ANCHOR (anchor));
480
  g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
481 482

  CHECK_IN_BUFFER (anchor);
483
  
484 485
  seg = anchor->segment;

486
  if (seg->body.child.tree == NULL)
487
    return;
488 489 490 491
  
  gtk_text_buffer_get_iter_at_child_anchor (layout->buffer,
                                            &start, anchor);
  end = start;
492
  gtk_text_iter_forward_char (&end);
493 494 495
  
  gtk_text_layout_invalidate (layout, &start, &end);
}
496

497 498 499 500 501 502 503 504 505
void
gtk_text_anchored_child_set_layout (GtkWidget     *child,
                                    GtkTextLayout *layout)
{
  g_return_if_fail (GTK_IS_WIDGET (child));
  g_return_if_fail (layout == NULL || GTK_IS_TEXT_LAYOUT (layout));
  
  _gtk_anchored_child_set_layout (child, layout);
}