gtktextchild.c 15.2 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
static GtkTextLineSegment *
Havoc Pennington's avatar
Havoc Pennington committed
77 78
pixbuf_segment_cleanup_func (GtkTextLineSegment *seg,
                             GtkTextLine        *line)
79 80 81 82 83 84
{
  /* nothing */
  return seg;
}

static int
85 86 87
pixbuf_segment_delete_func (GtkTextLineSegment *seg,
                            GtkTextLine        *line,
                            gboolean            tree_gone)
88
{
Havoc Pennington's avatar
Havoc Pennington committed
89
  if (seg->body.pixbuf.pixbuf)
Manish Singh's avatar
Manish Singh committed
90
    g_object_unref (seg->body.pixbuf.pixbuf);
91

92
  g_free (seg);
93 94 95 96 97

  return 0;
}

static void
98 99
pixbuf_segment_check_func (GtkTextLineSegment *seg,
                           GtkTextLine        *line)
100 101
{
  if (seg->next == NULL)
102
    g_error ("pixbuf segment is the last segment in a line");
103 104

  if (seg->byte_count != 3)
105 106
    g_error ("pixbuf segment has byte count of %d", seg->byte_count);

107
  if (seg->char_count != 1)
108
    g_error ("pixbuf segment has char count of %d", seg->char_count);
109 110 111
}


Matthias Clasen's avatar
Matthias Clasen committed
112
const GtkTextLineSegmentClass gtk_text_pixbuf_type = {
Havoc Pennington's avatar
Havoc Pennington committed
113
  "pixbuf",                          /* name */
114
  FALSE,                                            /* leftGravity */
115
  NULL,                                          /* splitFunc */
Havoc Pennington's avatar
Havoc Pennington committed
116 117
  pixbuf_segment_delete_func,                             /* deleteFunc */
  pixbuf_segment_cleanup_func,                            /* cleanupFunc */
118
  NULL,                                                    /* lineChangeFunc */
Havoc Pennington's avatar
Havoc Pennington committed
119
  pixbuf_segment_check_func                               /* checkFunc */
120 121 122

};

123 124
#define PIXBUF_SEG_SIZE ((unsigned) (G_STRUCT_OFFSET (GtkTextLineSegment, body) \
        + sizeof (GtkTextPixbuf)))
125 126

GtkTextLineSegment *
Havoc Pennington's avatar
Havoc Pennington committed
127
_gtk_pixbuf_segment_new (GdkPixbuf *pixbuf)
128 129 130
{
  GtkTextLineSegment *seg;

131
  seg = g_malloc (PIXBUF_SEG_SIZE);
132

Havoc Pennington's avatar
Havoc Pennington committed
133
  seg->type = &gtk_text_pixbuf_type;
134 135 136

  seg->next = NULL;

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

Havoc Pennington's avatar
Havoc Pennington committed
143
  seg->body.pixbuf.pixbuf = pixbuf;
144

Manish Singh's avatar
Manish Singh committed
145
  g_object_ref (pixbuf);
146

147 148
  return seg;
}
149 150 151 152 153 154 155


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

157 158 159 160 161 162 163 164
  return seg;
}

static int
child_segment_delete_func (GtkTextLineSegment *seg,
                           GtkTextLine       *line,
                           gboolean           tree_gone)
{
165 166
  GSList *tmp_list;
  GSList *copy;
167

168
  _gtk_text_btree_unregister_child_anchor (seg->body.child.obj);
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
  
  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);
      
      tmp_list = g_slist_next (tmp_list);
    }

  /* 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);  
  
194 195 196 197 198 199 200 201
  return 0;
}

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

  if (seg->byte_count != 3)
205 206
    g_error ("child segment has byte count of %d", seg->byte_count);

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

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

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

GtkTextLineSegment *
225
_gtk_widget_segment_new (GtkTextChildAnchor *anchor)
226 227 228 229 230 231 232 233 234
{
  GtkTextLineSegment *seg;

  seg = g_malloc (WIDGET_SEG_SIZE);

  seg->type = &gtk_text_child_type;

  seg->next = NULL;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

324
  object_class->finalize = gtk_text_child_anchor_finalize;
325 326
}

327 328 329 330 331 332 333 334 335 336
/**
 * 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().
 * 
 * Return value: a new #GtkTextChildAnchor
 **/
337 338 339
GtkTextChildAnchor*
gtk_text_child_anchor_new (void)
{
Manish Singh's avatar
Manish Singh committed
340
  return g_object_new (GTK_TYPE_TEXT_CHILD_ANCHOR, NULL);
341 342
}

343 344
static void
gtk_text_child_anchor_finalize (GObject *obj)
345
{
346 347 348 349 350
  GtkTextChildAnchor *anchor;
  GSList *tmp_list;
  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;
        }
363
      
364 365 366 367 368 369
      tmp_list = seg->body.child.widgets;
      while (tmp_list)
        {
          g_object_unref (tmp_list->data);
          tmp_list = g_slist_next (tmp_list);
        }
370
  
371
      g_slist_free (seg->body.child.widgets);
372
  
373 374
      g_free (seg);
    }
375

376
  anchor->segment = NULL;
377

Matthias Clasen's avatar
Matthias Clasen committed
378
  G_OBJECT_CLASS (gtk_text_child_anchor_parent_class)->finalize (obj);
379 380
}

381 382 383 384 385 386
/**
 * 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().
387 388 389
 *
 *
 * Return value: (element-type GtkWidget) (transfer container): list of widgets anchored at @anchor
390
 **/
391 392 393
GList*
gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
{
394
  GtkTextLineSegment *seg = anchor->segment;
395 396
  GList *list = NULL;
  GSList *iter;
397

398 399
  CHECK_IN_BUFFER_RETURN (anchor, NULL);
  
400
  g_return_val_if_fail (seg->type == &gtk_text_child_type, NULL);
401

402 403 404 405 406 407 408 409 410 411 412 413 414 415
  iter = seg->body.child.widgets;
  while (iter != NULL)
    {
      list = g_list_prepend (list, iter->data);

      iter = g_slist_next (iter);
    }

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

416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * 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
 * to use this function &mdash; otherwise all deleted child anchors
 * will also be finalized.
 * 
 * Return value: %TRUE if the child anchor has been deleted from its buffer
 **/
429 430 431
gboolean
gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor)
{
432
  GtkTextLineSegment *seg = anchor->segment;
433

434 435
  CHECK_IN_BUFFER_RETURN (anchor, TRUE);
  
436
  g_return_val_if_fail (seg->type == &gtk_text_child_type, TRUE);
437 438 439 440

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

441 442 443 444 445 446 447
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));
448

449 450
  CHECK_IN_BUFFER (anchor);
  
451 452 453 454 455 456 457 458 459 460 461 462 463
  _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));
464

465 466
  CHECK_IN_BUFFER (anchor);
  
467 468 469 470 471
  if (_gtk_anchored_child_get_layout (child))
    {
      gtk_text_child_anchor_queue_resize (anchor,
                                          _gtk_anchored_child_get_layout (child));
    }
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  
  _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));
487
  g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
488 489

  CHECK_IN_BUFFER (anchor);
490
  
491 492
  seg = anchor->segment;

493
  if (seg->body.child.tree == NULL)
494
    return;
495 496 497 498
  
  gtk_text_buffer_get_iter_at_child_anchor (layout->buffer,
                                            &start, anchor);
  end = start;
499
  gtk_text_iter_forward_char (&end);
500 501 502
  
  gtk_text_layout_invalidate (layout, &start, &end);
}
503

504 505 506 507 508 509 510 511 512
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);
}