]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktextchild.c
treeview: fix a critical warning
[~andy/gtk] / gtk / gtktextchild.c
index 2baac103300d5c006a7d69da5d7d6f0cbed052b0..dd7d3a49061766733c874e156479ab1716926da0 100644 (file)
  *
  */
 
+#define GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
+#include "config.h"
 #include "gtktextchild.h"
 #include "gtktextbtree.h"
+#include "gtktextlayout.h"
+#include "gtkintl.h"
+
+#define CHECK_IN_BUFFER(anchor)                                         \
+  G_STMT_START {                                                        \
+    if ((anchor)->segment == NULL)                                      \
+      {                                                                 \
+        g_warning ("%s: GtkTextChildAnchor hasn't been in a buffer yet",\
+                   G_STRFUNC);                                          \
+      }                                                                 \
+  } G_STMT_END
+
+#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",\
+                   G_STRFUNC);                                          \
+        return (val);                                                   \
+      }                                                                 \
+  } G_STMT_END
 
 static GtkTextLineSegment *
 pixbuf_segment_cleanup_func (GtkTextLineSegment *seg,
@@ -64,7 +87,7 @@ pixbuf_segment_delete_func (GtkTextLineSegment *seg,
                             gboolean            tree_gone)
 {
   if (seg->body.pixbuf.pixbuf)
-    g_object_unref (G_OBJECT (seg->body.pixbuf.pixbuf));
+    g_object_unref (seg->body.pixbuf.pixbuf);
 
   g_free (seg);
 
@@ -86,7 +109,7 @@ pixbuf_segment_check_func (GtkTextLineSegment *seg,
 }
 
 
-GtkTextLineSegmentClass gtk_text_pixbuf_type = {
+const GtkTextLineSegmentClass gtk_text_pixbuf_type = {
   "pixbuf",                          /* name */
   FALSE,                                            /* leftGravity */
   NULL,                                          /* splitFunc */
@@ -111,13 +134,15 @@ _gtk_pixbuf_segment_new (GdkPixbuf *pixbuf)
 
   seg->next = NULL;
 
-  seg->byte_count = 3; /* We convert to the 0xFFFD "unknown character",
-                          a 3-byte sequence in UTF-8 */
+  /* We convert to the 0xFFFC "unknown character",
+   * a 3-byte sequence in UTF-8.
+   */
+  seg->byte_count = GTK_TEXT_UNKNOWN_CHAR_UTF8_LEN;
   seg->char_count = 1;
 
   seg->body.pixbuf.pixbuf = pixbuf;
 
-  g_object_ref (G_OBJECT (pixbuf));
+  g_object_ref (pixbuf);
 
   return seg;
 }
@@ -137,8 +162,35 @@ child_segment_delete_func (GtkTextLineSegment *seg,
                            GtkTextLine       *line,
                            gboolean           tree_gone)
 {
-  _gtk_widget_segment_unref (seg);
+  GSList *tmp_list;
+  GSList *copy;
 
+  _gtk_text_btree_unregister_child_anchor (seg->body.child.obj);
+  
+  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);  
+  
   return 0;
 }
 
@@ -156,7 +208,7 @@ child_segment_check_func (GtkTextLineSegment *seg,
     g_error ("child segment has char count of %d", seg->char_count);
 }
 
-GtkTextLineSegmentClass gtk_text_child_type = {
+const GtkTextLineSegmentClass gtk_text_child_type = {
   "child-widget",                                        /* name */
   FALSE,                                                 /* leftGravity */
   NULL,                                                  /* splitFunc */
@@ -170,7 +222,7 @@ GtkTextLineSegmentClass gtk_text_child_type = {
         + sizeof (GtkTextChildBody)))
 
 GtkTextLineSegment *
-_gtk_widget_segment_new (void)
+_gtk_widget_segment_new (GtkTextChildAnchor *anchor)
 {
   GtkTextLineSegment *seg;
 
@@ -180,16 +232,19 @@ _gtk_widget_segment_new (void)
 
   seg->next = NULL;
 
-  seg->byte_count = 3; /* We convert to the 0xFFFD "unknown character",
+  seg->byte_count = 3; /* We convert to the 0xFFFC "unknown character",
                         * a 3-byte sequence in UTF-8
                         */
   seg->char_count = 1;
 
-  seg->body.child.ref_count = 1;
+  seg->body.child.obj = anchor;
+  seg->body.child.obj->segment = seg;
   seg->body.child.widgets = NULL;
   seg->body.child.tree = NULL;
   seg->body.child.line = NULL;
 
+  g_object_ref (anchor);
+  
   return seg;
 }
 
@@ -197,94 +252,152 @@ void
 _gtk_widget_segment_add    (GtkTextLineSegment *widget_segment,
                             GtkWidget          *child)
 {
-  g_assert (widget_segment->type = &gtk_text_child_type);
+  g_return_if_fail (widget_segment->type == &gtk_text_child_type);
+  g_return_if_fail (widget_segment->body.child.tree != NULL);
 
+  g_object_ref (child);
+  
   widget_segment->body.child.widgets =
     g_slist_prepend (widget_segment->body.child.widgets,
                      child);
-
-  g_object_ref (G_OBJECT (child));
 }
 
 void
 _gtk_widget_segment_remove (GtkTextLineSegment *widget_segment,
                             GtkWidget          *child)
 {
-  g_assert (widget_segment->type = &gtk_text_child_type);
-
+  g_return_if_fail (widget_segment->type == &gtk_text_child_type);
+  
   widget_segment->body.child.widgets =
     g_slist_remove (widget_segment->body.child.widgets,
                     child);
 
-  g_object_unref (G_OBJECT (child));
+  g_object_unref (child);
 }
 
 void
 _gtk_widget_segment_ref (GtkTextLineSegment *widget_segment)
 {
-  g_assert (widget_segment->type = &gtk_text_child_type);
+  g_assert (widget_segment->type == &gtk_text_child_type);
 
-  widget_segment->body.child.ref_count += 1;
+  g_object_ref (widget_segment->body.child.obj);
 }
 
 void
 _gtk_widget_segment_unref (GtkTextLineSegment *widget_segment)
 {
-  g_assert (widget_segment->type = &gtk_text_child_type);
-
-  widget_segment->body.child.ref_count -= 1;
+  g_assert (widget_segment->type == &gtk_text_child_type);
 
-  if (widget_segment->body.child.ref_count == 0)
-    {
-      GSList *tmp_list;
-
-      if (widget_segment->body.child.tree == NULL)
-        g_warning ("widget segment destroyed while still in btree");
+  g_object_unref (widget_segment->body.child.obj);
+}
 
-      tmp_list = widget_segment->body.child.widgets;
-      while (tmp_list)
-        {
-          g_object_unref (G_OBJECT (tmp_list->data));
+GtkTextLayout*
+_gtk_anchored_child_get_layout (GtkWidget *child)
+{
+  return g_object_get_data (G_OBJECT (child), "gtk-text-child-anchor-layout");  
+}
 
-          tmp_list = g_slist_next (tmp_list);
-        }
+static void
+_gtk_anchored_child_set_layout (GtkWidget     *child,
+                                GtkTextLayout *layout)
+{
+  g_object_set_data (G_OBJECT (child),
+                     I_("gtk-text-child-anchor-layout"),
+                     layout);  
+}
+     
+static void gtk_text_child_anchor_finalize (GObject *obj);
 
-      g_slist_free (widget_segment->body.child.widgets);
+G_DEFINE_TYPE (GtkTextChildAnchor, gtk_text_child_anchor, G_TYPE_OBJECT)
 
-      g_free (widget_segment);
-    }
+static void
+gtk_text_child_anchor_init (GtkTextChildAnchor *child_anchor)
+{
+  child_anchor->segment = NULL;
 }
 
-void
-gtk_text_child_anchor_ref (GtkTextChildAnchor *anchor)
+static void
+gtk_text_child_anchor_class_init (GtkTextChildAnchorClass *klass)
 {
-  GtkTextLineSegment *seg = (GtkTextLineSegment *) anchor;
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
 
-  g_return_if_fail (seg->type = &gtk_text_child_type);
-  g_return_if_fail (seg->body.child.ref_count > 0);
+  object_class->finalize = gtk_text_child_anchor_finalize;
+}
 
-  _gtk_widget_segment_ref (seg);
+/**
+ * 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
+ **/
+GtkTextChildAnchor*
+gtk_text_child_anchor_new (void)
+{
+  return g_object_new (GTK_TYPE_TEXT_CHILD_ANCHOR, NULL);
 }
 
-void
-gtk_text_child_anchor_unref (GtkTextChildAnchor *anchor)
+static void
+gtk_text_child_anchor_finalize (GObject *obj)
 {
-  GtkTextLineSegment *seg = (GtkTextLineSegment *) anchor;
+  GtkTextChildAnchor *anchor;
+  GSList *tmp_list;
+  GtkTextLineSegment *seg;
+  
+  anchor = GTK_TEXT_CHILD_ANCHOR (obj);
+
+  seg = anchor->segment;
+  
+  if (seg)
+    {
+      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;
+        }
+      
+      tmp_list = seg->body.child.widgets;
+      while (tmp_list)
+        {
+          g_object_unref (tmp_list->data);
+          tmp_list = g_slist_next (tmp_list);
+        }
+  
+      g_slist_free (seg->body.child.widgets);
+  
+      g_free (seg);
+    }
 
-  g_return_if_fail (seg->type = &gtk_text_child_type);
-  g_return_if_fail (seg->body.child.ref_count > 0);
+  anchor->segment = NULL;
 
-  _gtk_widget_segment_unref (seg);
+  G_OBJECT_CLASS (gtk_text_child_anchor_parent_class)->finalize (obj);
 }
 
+/**
+ * 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().
+ *
+ *
+ * Return value: (element-type GtkWidget) (transfer container): list of widgets anchored at @anchor
+ **/
 GList*
 gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
 {
-  GtkTextLineSegment *seg = (GtkTextLineSegment *) anchor;
+  GtkTextLineSegment *seg = anchor->segment;
   GList *list = NULL;
   GSList *iter;
 
-  g_return_val_if_fail (seg->type = &gtk_text_child_type, NULL);
+  CHECK_IN_BUFFER_RETURN (anchor, NULL);
+  
+  g_return_val_if_fail (seg->type == &gtk_text_child_type, NULL);
 
   iter = seg->body.child.widgets;
   while (iter != NULL)
@@ -300,15 +413,100 @@ gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
   return list;
 }
 
+/**
+ * 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 — otherwise all deleted child anchors
+ * will also be finalized.
+ * 
+ * Return value: %TRUE if the child anchor has been deleted from its buffer
+ **/
 gboolean
 gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor)
 {
-  GtkTextLineSegment *seg = (GtkTextLineSegment *) anchor;
+  GtkTextLineSegment *seg = anchor->segment;
 
-  g_return_val_if_fail (seg->type = &gtk_text_child_type, TRUE);
+  CHECK_IN_BUFFER_RETURN (anchor, TRUE);
+  
+  g_return_val_if_fail (seg->type == &gtk_text_child_type, TRUE);
 
   return seg->body.child.tree == NULL;
 }
 
+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));
+
+  CHECK_IN_BUFFER (anchor);
+  
+  _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));
+
+  CHECK_IN_BUFFER (anchor);
+  
+  if (_gtk_anchored_child_get_layout (child))
+    {
+      gtk_text_child_anchor_queue_resize (anchor,
+                                          _gtk_anchored_child_get_layout (child));
+    }
+  
+  _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));
+  g_return_if_fail (GTK_IS_TEXT_LAYOUT (layout));
+
+  CHECK_IN_BUFFER (anchor);
+  
+  seg = anchor->segment;
+
+  if (seg->body.child.tree == NULL)
+    return;
+  
+  gtk_text_buffer_get_iter_at_child_anchor (layout->buffer,
+                                            &start, anchor);
+  end = start;
+  gtk_text_iter_forward_char (&end);
+  
+  gtk_text_layout_invalidate (layout, &start, &end);
+}
 
+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);
+}