From 9727f9a6c1205f6f55574b62dbbb9146a9dbca15 Mon Sep 17 00:00:00 2001
From: John Cupitt <jcupitt@gmail.com>
Date: Thu, 22 Jan 2009 15:46:02 +0000
Subject: [PATCH] add nickname/description props to vipsobject

---
 ChangeLog                       |  1 +
 TODO                            |  4 ---
 include/vips/object.h           |  6 ++++
 libsrc/iofuncs/object.c         | 64 +++++++++++++++++++++++++++------
 libsrc/mosaicing/yafrsmooth.cpp |  2 +-
 5 files changed, 62 insertions(+), 15 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index f1ae7235..6487e75d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -30,6 +30,7 @@
 - IM_FREE() can do "const char*" variables
 - im_buf_t renamed as VipsBuf
 - added vips_object_to_string()
+- added "nickname" and "description" properties to VipsObject
 
 11/9/08 started 7.16.3
 - oop typo in manpage for im_project()
diff --git a/TODO b/TODO
index 8f90e6c8..caacba13 100644
--- a/TODO
+++ b/TODO
@@ -2,10 +2,6 @@
 
 - try making vips_add(), an operator as a class
 
-- nickname, description etc need to be properties so nip2 can read them
-
-  arg, they are class properties, argh, can we support these?
-
 - make a new package for "resample"? im_shrink & friends could go in there too
 
 - make a "deprecated" package too
diff --git a/include/vips/object.h b/include/vips/object.h
index 23d252f9..fd2b93c8 100644
--- a/include/vips/object.h
+++ b/include/vips/object.h
@@ -179,6 +179,12 @@ struct _VipsObject {
 	/* Table of argument instances for this class and any derived classes.
 	 */
 	VipsArgumentTable *argument_table;
+
+	/* Class properties (see below), duplicated in the instance so we can
+	 * get at them easily via the property system.
+	 */
+	char *nickname;
+	char *description;
 };
 
 struct _VipsObjectClass {
diff --git a/libsrc/iofuncs/object.c b/libsrc/iofuncs/object.c
index fe40e5d8..2218a8ce 100644
--- a/libsrc/iofuncs/object.c
+++ b/libsrc/iofuncs/object.c
@@ -55,6 +55,14 @@ enum {
 	SIG_LAST
 };
 
+/* Properties.
+ */
+enum {
+	PROP_NICKNAME,	/* Class properties as object props */
+	PROP_DESCRIPTION,
+	PROP_LAST
+};
+
 static guint vips_object_signals[SIG_LAST] = { 0 };
 
 G_DEFINE_ABSTRACT_TYPE( VipsObject, vips_object, G_TYPE_OBJECT );
@@ -718,27 +726,29 @@ transform_string_double( const GValue *src_value, GValue *dest_value )
 }
 
 static void
-vips_object_class_init( VipsObjectClass *class )
+vips_object_class_init( VipsObjectClass *object_class )
 {
-	GObjectClass *gobject_class = G_OBJECT_CLASS( class );
+	GObjectClass *gobject_class = G_OBJECT_CLASS( object_class );
+
+	GParamSpec *pspec;
 
 	gobject_class->dispose = vips_object_dispose;
 	gobject_class->finalize = vips_object_finalize;
 	gobject_class->set_property = vips_object_set_property;
 	gobject_class->get_property = vips_object_get_property;
 
-	class->build = vips_object_real_build;
-	class->changed = vips_object_real_changed;
-	class->print_class = vips_object_real_print_class;
-	class->print = vips_object_real_print;
-	class->nickname = "object";
-	class->description = _( "VIPS base class" );
+	object_class->build = vips_object_real_build;
+	object_class->changed = vips_object_real_changed;
+	object_class->print_class = vips_object_real_print_class;
+	object_class->print = vips_object_real_print;
+	object_class->nickname = "object";
+	object_class->description = _( "VIPS base class" );
 
 	/* Table of VipsArgumentClass ... we can just g_free() them.
 	 */
-	class->argument_table = g_hash_table_new_full( 
+	object_class->argument_table = g_hash_table_new_full( 
 		g_direct_hash, g_direct_equal, NULL, (GDestroyNotify) g_free );
-	class->argument_table_traverse = NULL;
+	object_class->argument_table_traverse = NULL;
 
 	vips_object_signals[SIG_CHANGED] = g_signal_new( "changed",
 		G_OBJECT_CLASS_TYPE( gobject_class ),
@@ -752,15 +762,49 @@ vips_object_class_init( VipsObjectClass *class )
 	 */
 	g_value_register_transform_func( G_TYPE_STRING, G_TYPE_DOUBLE,
 		transform_string_double );
+
+	/* Create properties.
+	 */
+	pspec = g_param_spec_string( "nickname", 
+		_( "Nickname" ),
+		_( "Class nickname" ),
+		"",
+		(GParamFlags) G_PARAM_READABLE );
+	g_object_class_install_property( gobject_class, 
+		PROP_NICKNAME, pspec );
+	vips_object_class_install_argument( object_class, pspec,
+		VIPS_ARGUMENT_SET_ONCE,
+		G_STRUCT_OFFSET( VipsObject, nickname ) );
+
+	pspec = g_param_spec_string( "description", 
+		_( "Description" ),
+		_( "Class description" ),
+		"",
+		(GParamFlags) G_PARAM_READABLE );
+	g_object_class_install_property( gobject_class, 
+		PROP_DESCRIPTION, pspec );
+	vips_object_class_install_argument( object_class, pspec,
+		VIPS_ARGUMENT_SET_ONCE,
+		G_STRUCT_OFFSET( VipsObject, description ) );
+
 }
 
 static void
 vips_object_init( VipsObject *object )
 {
+	VipsObjectClass *object_class = VIPS_OBJECT_GET_CLASS( object );
+
 #ifdef DEBUG
 	printf( "vips_object_init: " );
 	vips_object_print( object );
 #endif /*DEBUG*/
+
+	/* It'd be nice if this just copied a pointer rather than did a
+	 * strdup().
+	 */
+	g_object_set( object, 
+		"nickname", object_class->nickname,
+		"description", object_class->description, NULL );
 }
 
 void
diff --git a/libsrc/mosaicing/yafrsmooth.cpp b/libsrc/mosaicing/yafrsmooth.cpp
index 5b002959..3f10e9f4 100644
--- a/libsrc/mosaicing/yafrsmooth.cpp
+++ b/libsrc/mosaicing/yafrsmooth.cpp
@@ -131,7 +131,7 @@
 /* Properties.
  */
 enum {
-	PROP_SHARPENING = 1,
+	PROP_SHARPENING,
 	PROP_LAST
 };