GObject參考手冊(10)--GObject的物件屬性
GObject的其中一個漂亮特性就是它那為物件屬性準備的通用get/set機制。當一個物件被例項化以後,物件的類初始化處理將用g_object_class_install_property來註冊物件的屬性(由gobject.c中實現)。
理解物件屬性是如何工作的最好就是看下面的例子:
/************************************************/ /* Implementation */ /************************************************/ enum { MAMAN_BAR_CONSTRUCT_NAME = 1, MAMAN_BAR_PAPA_NUMBER, }; static void maman_bar_instance_init (GTypeInstance *instance, gpointer g_class) { MamanBar *self = (MamanBar *)instance; } static void maman_bar_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec) { MamanBar *self = (MamanBar *) object; switch (property_id) { case MAMAN_BAR_CONSTRUCT_NAME: { g_free (self->priv->name); self->priv->name = g_value_dup_string (value); g_print ("maman: %s/n",self->priv->name); } break; case MAMAN_BAR_PAPA_NUMBER: { self->priv->papa_number = g_value_get_uchar (value); g_print ("papa: %u/n",self->priv->papa_number); } break; default: /* We don't have any other property... */ G_OBJECT_WARN_INVALID_PROPERTY_ID(object,property_id,pspec); break; } } static void maman_bar_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec) { MamanBar *self = (MamanBar *) object; switch (property_id) { case MAMAN_BAR_CONSTRUCT_NAME: { g_value_set_string (value, self->priv->name); } break; case MAMAN_BAR_PAPA_NUMBER: { g_value_set_uchar (value, self->priv->papa_number); } break; default: /* We don't have any other property... */ G_OBJECT_WARN_INVALID_PROPERTY_ID(object,property_id,pspec); break; } } static void maman_bar_class_init (gpointer g_class, gpointer g_class_data) { GObjectClass *gobject_class = G_OBJECT_CLASS (g_class); MamanBarClass *klass = MAMAN_BAR_CLASS (g_class); GParamSpec *pspec; gobject_class->set_property = maman_bar_set_property; gobject_class->get_property = maman_bar_get_property; pspec = g_param_spec_string ("maman-name", "Maman construct prop", "Set maman's name", "no-name-set" /* default value */, G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE); g_object_class_install_property (gobject_class, MAMAN_BAR_CONSTRUCT_NAME, pspec); pspec = g_param_spec_uchar ("papa-number", "Number of current Papa", "Set/Get papa's number", 0 /* minimum value */, 10 /* maximum value */, 2 /* default value */, G_PARAM_READWRITE); g_object_class_install_property (gobject_class, MAMAN_BAR_PAPA_NUMBER, pspec); } /************************************************/ /* Use */ /************************************************/ GObject *bar; GValue val = {0,}; bar = g_object_new (MAMAN_TYPE_SUBBAR, NULL); g_value_init (&val, G_TYPE_CHAR); g_value_set_char (&val, 11); g_object_set_property (G_OBJECT (bar), "papa-number", &val);
上面的例子看起來應該是簡單的,但是很多事情發生了:
g_object_set_property先確保相應名稱的屬性已經在bar的class_init處理函式中被註冊。如果是的話,它依次呼叫類繼承關係中的object_set_property,從底至頂,基礎型別用來找到註冊了這個屬性的類。接著它嘗試轉換使用者提供的GValue到屬性所關聯的GValue。
如果使用者提供了一個有符號的字元GValue,就像這裡所示,如果物件的屬性被註冊為一個無符號的整型,g_value_transform將會試著轉換輸入的有符號的字元到一個無符號的整型。當然,轉換是否成功取取決於可用的轉換函式。實際上,如果需要的時候,總會有相關的轉換函式可以用。
在轉型以後,GValue將被g_param_value_validata來驗證,以確保使用者儲存在GValue中的資料吻合由屬性的GParamSpea所描述的字元特性。在這裡,我們在class_init裡提供的GParamSpec有一個驗證函式來確保GValue包含了一個代表最小和最大邊界的GParamSpec。在上面的例子中,客戶端的GValue並沒有尊重規範(它設定為了11,而最大值是10)。因為這樣,所了g_object_set_property函式將返回一個錯誤。
如果使用者的GValue已經被設定成了一個可用的值,g_object_set_property將處理一下呼叫至物件的set_property的類方法。在這裡,因為我們在Foo的實現程式碼中並沒有過載這個函式,程式碼路徑將會跳到foo_set_property在收到g_object_class_install_property儲存了GParamSpec的param_id後。
一時已經用物件的set_property類方法來設定好屬性以後,程式碼路徑將呼叫g_object_nofity_queue_thaw使返回到g_object_set_property 。這個函式確保“notify”訊號”已經在物件例項完成改變屬性後被髮出,除非通知臺已經被g_object_free_notify所凍潔。
g_object_thaw_nofity可以被用來重新啟用通過“notify”訊號的屬性修改的通知中心。這是非常重要的,記住當屬性被改變時通知中心是否被凍結,“notify”訊號將會當在屬性改變的一睡意由通知中心所發出:沒有屬性改變會因“notify”所訊號。只有通過通知中心的凍結機制才能使訊號發身被延誤。
這聽起來像是一個無聊的任務每次設定GValues當我想需要一個屬性時。實際上我們僅僅很少這樣做。g_object_set_property和g_object_get_property一般是用來語言繫結的。對應用程式來說,有一個更簡單的方法,在下面描述。
同時修改多個屬性
我想這很有趣,我們可以通過g_object_set和g_object_set_valist函式來同時設定多個屬性值。客戶端程式碼可以被重寫為:
MamanBar *foo; foo = /* */; g_object_set (G_OBJECT (foo), "papa-number", 2, "maman-name", "test", NULL);
這個節省了我們管理用g_object_set_property來處理GValue的時間。在被修改時這個程式碼同樣會觸發每個屬性。
當然,_get的版本同樣是存在的:g_object_get和g_object-get_valist可以用來一次性得到很多屬性。
這些高階的方法有一個缺點──它們不提供一個返回值。在使用它們時,你需要注意這些引數型別和範圍 。(暫時不會了)
These high level functions have one drawback - they don’t provide a return result. One should pay attention to the argument types and ranges when using them. A know source of errors is to e.g. pass a gfloat instead of a gdouble and thus shifting all subsequent parameters by four bytes. Also forgetting the terminating NULL will lead to unexpected behaviour.
如果你認真看這章的話,現在你應該已經知道了g_object_new,g_object_newv和g_object_new_valist是如何工作的:它們解析使用者提供的變數數目和引數並當物件成功的建立以後,用這些引數呼叫g_object_set。當然,“notify”訊號同樣會在每個屬性改變後發射。