diff options
author | David Zeuthen <davidz@redhat.com> | 2008-12-21 02:07:59 -0500 |
---|---|---|
committer | David Zeuthen <davidz@redhat.com> | 2008-12-21 02:07:59 -0500 |
commit | cbe4be631310caf632bf2e41918f94790e7c6ebd (patch) | |
tree | 0bbe9c2840e74aff22cc8abcdb30c2b3a965d3a7 | |
parent | b2c75b6fa99a6a1d9b7252802fb4d2a9ceccba45 (diff) |
add docs for EggDBusMessage
-rw-r--r-- | docs/eggdbus/eggdbus-sections.txt | 8 | ||||
-rw-r--r-- | src/eggdbus/eggdbusmessage.c | 544 | ||||
-rw-r--r-- | src/eggdbus/eggdbusmessage.h | 8 | ||||
-rw-r--r-- | src/eggdbus/interface.c | 4 | ||||
-rw-r--r-- | src/tests/Makefile.am | 4 |
5 files changed, 538 insertions, 30 deletions
diff --git a/docs/eggdbus/eggdbus-sections.txt b/docs/eggdbus/eggdbus-sections.txt index 4cbeaef..0e8de2d 100644 --- a/docs/eggdbus/eggdbus-sections.txt +++ b/docs/eggdbus/eggdbus-sections.txt @@ -253,8 +253,8 @@ egg_dbus_message_append_signature_array egg_dbus_message_append_byte egg_dbus_message_append_int16 egg_dbus_message_append_uint16 -egg_dbus_message_append_int32 -egg_dbus_message_append_uint32 +egg_dbus_message_append_int +egg_dbus_message_append_uint egg_dbus_message_append_int64 egg_dbus_message_append_uint64 egg_dbus_message_append_boolean @@ -273,8 +273,8 @@ egg_dbus_message_extract_signature_array egg_dbus_message_extract_byte egg_dbus_message_extract_int16 egg_dbus_message_extract_uint16 -egg_dbus_message_extract_int32 -egg_dbus_message_extract_uint32 +egg_dbus_message_extract_int +egg_dbus_message_extract_uint egg_dbus_message_extract_int64 egg_dbus_message_extract_uint64 egg_dbus_message_extract_boolean diff --git a/src/eggdbus/eggdbusmessage.c b/src/eggdbus/eggdbusmessage.c index 2506a9c..866f499 100644 --- a/src/eggdbus/eggdbusmessage.c +++ b/src/eggdbus/eggdbusmessage.c @@ -38,6 +38,15 @@ #include <stdio.h> +/** + * SECTION:eggdbusmessage + * @title: EggDBusMessage + * @short_description: D-Bus Messages + * + * The #EggDBusMessage class is used for sending and receiving D-Bus messages. This class is + * only useful for language bindings. + */ + typedef struct { EggDBusConnection *connection; @@ -151,7 +160,7 @@ egg_dbus_message_set_property (GObject *object, break; case PROP_MESSAGE_TYPE: - priv->message_type = g_value_get_int (value); + priv->message_type = g_value_get_enum (value); break; case PROP_METHOD_NAME: @@ -207,7 +216,7 @@ egg_dbus_message_get_property (GObject *object, break; case PROP_MESSAGE_TYPE: - g_value_set_int (value, priv->message_type); + g_value_set_enum (value, priv->message_type); break; case PROP_OBJECT_PATH: @@ -338,17 +347,16 @@ egg_dbus_message_class_init (EggDBusMessageClass *klass) /* TODO: use flags instead */ g_object_class_install_property (gobject_class, PROP_MESSAGE_TYPE, - g_param_spec_int ("message-type", - "Message Type", - "The type of the message", - 0, - G_MAXINT, - 0, - G_PARAM_READWRITE | - G_PARAM_CONSTRUCT_ONLY | - G_PARAM_STATIC_NAME | - G_PARAM_STATIC_NICK | - G_PARAM_STATIC_BLURB)); + g_param_spec_enum ("message-type", + "Message Type", + "The type of the message", + EGG_TYPE_DBUS_MESSAGE_TYPE, + 0, + G_PARAM_READWRITE | + G_PARAM_CONSTRUCT_ONLY | + G_PARAM_STATIC_NAME | + G_PARAM_STATIC_NICK | + G_PARAM_STATIC_BLURB)); g_object_class_install_property (gobject_class, PROP_OBJECT_PATH, @@ -470,6 +478,14 @@ egg_dbus_message_class_init (EggDBusMessageClass *klass) G_PARAM_STATIC_BLURB)); } +/** + * egg_dbus_message_new_for_method_reply: + * @reply_to: The message to reply to. + * + * Creates a new message representing a reply to another message. + * + * Returns: A #EggDBusMessage. Free with g_object_unref(). + **/ EggDBusMessage * egg_dbus_message_new_for_method_reply (EggDBusMessage *reply_to) { @@ -488,6 +504,16 @@ egg_dbus_message_new_for_method_reply (EggDBusMessage *reply_to) NULL)); } +/** + * egg_dbus_message_new_for_method_error_reply: + * @reply_to: The message to reply to. + * @error_name: D-Bus error name. + * @error_message: D-Bus error message. + * + * Creates a new error message in reply to another message. + * + * Returns: A #EggDBusMessage. Free with g_object_unref(). + **/ EggDBusMessage * egg_dbus_message_new_for_method_error_reply (EggDBusMessage *reply_to, const gchar *error_name, @@ -508,6 +534,14 @@ egg_dbus_message_new_for_method_error_reply (EggDBusMessage *reply_to, NULL)); } +/** + * egg_dbus_message_get_connection: + * @message: A #EggDBusMessage. + * + * Gets the connection that @message is associated with. + * + * Returns: The connection that @message is associated with. Do not free, the connection is owned by @message. + **/ EggDBusConnection * egg_dbus_message_get_connection (EggDBusMessage *message) { @@ -521,6 +555,14 @@ egg_dbus_message_get_connection (EggDBusMessage *message) } +/** + * egg_dbus_message_get_message_type: + * @message: A #EggDBusMessage. + * + * The type of the message. + * + * Returns: A value from the #EggDBusMessageType enumeration. + **/ EggDBusMessageType egg_dbus_message_get_message_type (EggDBusMessage *message) { @@ -533,6 +575,14 @@ egg_dbus_message_get_message_type (EggDBusMessage *message) return priv->message_type; } +/** + * egg_dbus_message_get_object_path: + * @message: A #EggDBusMessage. + * + * Gets the object path of the message. + * + * Returns: The object path of @message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_object_path (EggDBusMessage *message) { @@ -547,6 +597,14 @@ egg_dbus_message_get_object_path (EggDBusMessage *message) return priv->object_path; } +/** + * egg_dbus_message_get_interface_name: + * @message: A #EggDBusMessage. + * + * Gets the interface name of the message. + * + * Returns: The intername name of @message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_interface_name (EggDBusMessage *message) { @@ -561,6 +619,14 @@ egg_dbus_message_get_interface_name (EggDBusMessage *message) return priv->interface_name; } +/** + * egg_dbus_message_get_method_name: + * @message: A #EggDBusMessage. + * + * Gets the method name of the message. + * + * Returns: The method name of the message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_method_name (EggDBusMessage *message) { @@ -574,6 +640,14 @@ egg_dbus_message_get_method_name (EggDBusMessage *message) return priv->method_name; } +/** + * egg_dbus_message_get_signal_name: + * @message: A #EggDBusMessage. + * + * Gets the signal name of the message. + * + * Returns: The signal name of the message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_signal_name (EggDBusMessage *message) { @@ -587,6 +661,14 @@ egg_dbus_message_get_signal_name (EggDBusMessage *message) return priv->signal_name; } +/** + * egg_dbus_message_get_in_reply_to: + * @message: A #EggDBusMessage. + * + * Gets the message that @message is a reply to. + * + * Returns: A #EggDBusMessage. Do not free, the value is owned by @message. + **/ EggDBusMessage * egg_dbus_message_get_in_reply_to (EggDBusMessage *message) { @@ -601,6 +683,14 @@ egg_dbus_message_get_in_reply_to (EggDBusMessage *message) return priv->in_reply_to; } +/** + * egg_dbus_message_get_sender: + * @message: A #EggDBusMessage. + * + * Gets the sender of the message. + * + * Returns: The sender of the message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_sender (EggDBusMessage *message) { @@ -615,6 +705,14 @@ egg_dbus_message_get_sender (EggDBusMessage *message) return priv->sender; } +/** + * egg_dbus_message_get_destination: + * @message: A #EggDBusMessage. + * + * Gets the destination of the message. + * + * Returns: The destination of the message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_destination (EggDBusMessage *message) { @@ -629,6 +727,14 @@ egg_dbus_message_get_destination (EggDBusMessage *message) return priv->destination; } +/** + * egg_dbus_message_get_signature: + * @message: A #EggDBusMessage. + * + * Gets the signature of the message. + * + * Returns: The signature of the message. Do not free, the value is owned by @message. + **/ const gchar * egg_dbus_message_get_signature (EggDBusMessage *message) { @@ -681,6 +787,16 @@ ensure_write_iter (EggDBusMessage *message) /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_message_append_string: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a string to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_string (EggDBusMessage *message, const gchar *value, @@ -692,6 +808,16 @@ egg_dbus_message_append_string (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_STRING_AS_STRING, error); } +/** + * egg_dbus_message_append_object_path: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends an object path to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_object_path (EggDBusMessage *message, const gchar *value, @@ -703,6 +829,16 @@ egg_dbus_message_append_object_path (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_OBJECT_PATH_AS_STRING, error); } +/** + * egg_dbus_message_append_signature: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a D-Bus signature to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_signature (EggDBusMessage *message, const gchar *value, @@ -714,6 +850,16 @@ egg_dbus_message_append_signature (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_SIGNATURE_AS_STRING, error); } +/** + * egg_dbus_message_append_string_array: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a %NULL-terminated string array to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_string_array (EggDBusMessage *message, gchar **value, @@ -725,6 +871,16 @@ egg_dbus_message_append_string_array (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_STRING_AS_STRING, error); } +/** + * egg_dbus_message_append_object_path_array: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a %NULL-terminated object path array to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_object_path_array (EggDBusMessage *message, gchar **value, @@ -736,6 +892,16 @@ egg_dbus_message_append_object_path_array (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_OBJECT_PATH_AS_STRING, error); } +/** + * egg_dbus_message_append_signature_array: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a %NULL-terminated D-Bus signature array to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_signature_array (EggDBusMessage *message, gchar **value, @@ -747,6 +913,16 @@ egg_dbus_message_append_signature_array (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_ARRAY_AS_STRING DBUS_TYPE_SIGNATURE_AS_STRING, error); } +/** + * egg_dbus_message_append_byte: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #guchar to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_byte (EggDBusMessage *message, guchar value, @@ -758,6 +934,16 @@ egg_dbus_message_append_byte (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_BYTE_AS_STRING, error); } +/** + * egg_dbus_message_append_int16: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #gint16 to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_int16 (EggDBusMessage *message, gint16 value, @@ -769,6 +955,16 @@ egg_dbus_message_append_int16 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_INT16_AS_STRING, error); } +/** + * egg_dbus_message_append_uint16: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #guint16 to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_uint16 (EggDBusMessage *message, guint16 value, @@ -780,8 +976,18 @@ egg_dbus_message_append_uint16 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_UINT16_AS_STRING, error); } +/** + * egg_dbus_message_append_int: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #gint to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean -egg_dbus_message_append_int32 (EggDBusMessage *message, +egg_dbus_message_append_int (EggDBusMessage *message, gint value, GError **error) { @@ -791,8 +997,18 @@ egg_dbus_message_append_int32 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_INT32_AS_STRING, error); } +/** + * egg_dbus_message_append_uint: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #guint to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean -egg_dbus_message_append_uint32 (EggDBusMessage *message, +egg_dbus_message_append_uint (EggDBusMessage *message, guint value, GError **error) { @@ -802,6 +1018,16 @@ egg_dbus_message_append_uint32 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_UINT32_AS_STRING, error); } +/** + * egg_dbus_message_append_int64: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #gint64 to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_int64 (EggDBusMessage *message, gint64 value, @@ -813,6 +1039,16 @@ egg_dbus_message_append_int64 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_INT64_AS_STRING, error); } +/** + * egg_dbus_message_append_uint64: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #guint64 to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_uint64 (EggDBusMessage *message, guint64 value, @@ -824,6 +1060,16 @@ egg_dbus_message_append_uint64 (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_UINT64_AS_STRING, error); } +/** + * egg_dbus_message_append_boolean: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #gboolean to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_boolean (EggDBusMessage *message, gboolean value, @@ -835,6 +1081,16 @@ egg_dbus_message_append_boolean (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_BOOLEAN_AS_STRING, error); } +/** + * egg_dbus_message_append_double: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @error: Return location for error. + * + * Appends a #gdouble to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_double (EggDBusMessage *message, gdouble value, @@ -846,6 +1102,17 @@ egg_dbus_message_append_double (EggDBusMessage *message, return egg_dbus_message_append_gvalue (message, &val, DBUS_TYPE_DOUBLE_AS_STRING, error); } +/** + * egg_dbus_message_append_seq: + * @message: A #EggDBusMessage. + * @seq: Sequence to append to @message. + * @element_signature: D-Bus signature of elements in @seq. + * @error: Return location for error. + * + * Appends a #EggDBusSeq to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_seq (EggDBusMessage *message, EggDBusArraySeq *seq, @@ -863,6 +1130,18 @@ egg_dbus_message_append_seq (EggDBusMessage *message, return ret; } +/** + * egg_dbus_message_append_map: + * @message: A #EggDBusMessage. + * @map: Map to append to @message. + * @key_signature: D-Bus signature of keys in @map. + * @value_signature: D-Bus signature of values in @map. + * @error: Return location for error. + * + * Appends a #EggDBusMap to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_map (EggDBusMessage *message, EggDBusHashMap *map, @@ -881,6 +1160,16 @@ egg_dbus_message_append_map (EggDBusMessage *message, return ret; } +/** + * egg_dbus_message_append_structure: + * @message: A #EggDBusMessage. + * @structure: Structure to append to @message. + * @error: Return location for error. + * + * Appends a #EggDBusStructure to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_structure (EggDBusMessage *message, EggDBusStructure *structure, @@ -895,6 +1184,16 @@ egg_dbus_message_append_structure (EggDBusMessage *message, error); } +/** + * egg_dbus_message_append_variant: + * @message: A #EggDBusMessage. + * @variant: Variant to append to @message. + * @error: Return location for error. + * + * Appends a #EggDBusVariant to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_variant (EggDBusMessage *message, EggDBusVariant *variant, @@ -910,6 +1209,17 @@ egg_dbus_message_append_variant (EggDBusMessage *message, } +/** + * egg_dbus_message_append_gvalue: + * @message: A #EggDBusMessage. + * @value: Value to append to @message. + * @signature: D-Bus signature of @value. + * @error: Return location for error. + * + * Appends a #GValue to @message. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_append_gvalue (EggDBusMessage *message, const GValue *value, @@ -932,6 +1242,16 @@ egg_dbus_message_append_gvalue (EggDBusMessage *message, /* ---------------------------------------------------------------------------------------------------- */ +/** + * egg_dbus_message_extract_string: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a string from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_string (EggDBusMessage *message, gchar **out_value, @@ -947,6 +1267,16 @@ egg_dbus_message_extract_string (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_object_path: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts an object path from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_object_path (EggDBusMessage *message, gchar **out_value, @@ -962,6 +1292,16 @@ egg_dbus_message_extract_object_path (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_signature: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a D-Bus signature from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_signature (EggDBusMessage *message, gchar **out_value, @@ -978,6 +1318,16 @@ egg_dbus_message_extract_signature (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_string_array: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts an array of strings from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_string_array (EggDBusMessage *message, gchar ***out_value, @@ -993,6 +1343,16 @@ egg_dbus_message_extract_string_array (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_object_path_array: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts an array of object paths from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_object_path_array (EggDBusMessage *message, gchar ***out_value, @@ -1008,6 +1368,16 @@ egg_dbus_message_extract_object_path_array (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_signature_array: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts an array of D-Bus signatures from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_signature_array (EggDBusMessage *message, gchar ***out_value, @@ -1023,6 +1393,16 @@ egg_dbus_message_extract_signature_array (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_byte: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #guchar from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_byte (EggDBusMessage *message, guchar *out_value, @@ -1039,6 +1419,16 @@ egg_dbus_message_extract_byte (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_int16: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #gint16 from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_int16 (EggDBusMessage *message, gint16 *out_value, @@ -1055,6 +1445,16 @@ egg_dbus_message_extract_int16 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_uint16: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #guint16 from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_uint16 (EggDBusMessage *message, guint16 *out_value, @@ -1071,8 +1471,18 @@ egg_dbus_message_extract_uint16 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_int: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #gint from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean -egg_dbus_message_extract_int32 (EggDBusMessage *message, +egg_dbus_message_extract_int (EggDBusMessage *message, gint *out_value, GError **error) { @@ -1087,8 +1497,18 @@ egg_dbus_message_extract_int32 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_uint: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #guint from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean -egg_dbus_message_extract_uint32 (EggDBusMessage *message, +egg_dbus_message_extract_uint (EggDBusMessage *message, guint *out_value, GError **error) { @@ -1103,6 +1523,16 @@ egg_dbus_message_extract_uint32 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_int64: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #gint64 from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_int64 (EggDBusMessage *message, gint64 *out_value, @@ -1119,6 +1549,16 @@ egg_dbus_message_extract_int64 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_uint64: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #guint64 from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_uint64 (EggDBusMessage *message, guint64 *out_value, @@ -1135,6 +1575,16 @@ egg_dbus_message_extract_uint64 (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_boolean: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #gboolean from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_boolean (EggDBusMessage *message, gboolean *out_value, @@ -1151,6 +1601,16 @@ egg_dbus_message_extract_boolean (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_double: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts a #gdouble from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_double (EggDBusMessage *message, gdouble *out_value, @@ -1167,6 +1627,16 @@ egg_dbus_message_extract_double (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_seq: + * @message: A #EggDBusMessage. + * @out_seq: Return location for extracted sequence or %NULL. + * @error: Return location for error. + * + * Extracts a #EggDBusSequence from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_seq (EggDBusMessage *message, EggDBusArraySeq **out_seq, @@ -1182,6 +1652,16 @@ egg_dbus_message_extract_seq (EggDBusMessage *message, return TRUE; } +/** + * egg_dbus_message_extract_map: + * @message: A #EggDBusMessage. + * @out_map: Return location for extracted map or %NULL. + * @error: Return location for error. + * + * Extracts a #EggDBusHashMap from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_map (EggDBusMessage *message, EggDBusHashMap **out_map, @@ -1198,6 +1678,16 @@ egg_dbus_message_extract_map (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_structure: + * @message: A #EggDBusMessage. + * @out_structure: Return location for extracted structure or %NULL. + * @error: Return location for error. + * + * Extracts a #EggDBusStructure from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_structure (EggDBusMessage *message, EggDBusStructure **out_structure, @@ -1214,6 +1704,16 @@ egg_dbus_message_extract_structure (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_variant: + * @message: A #EggDBusMessage. + * @out_variant: Return location for extracted variant or %NULL. + * @error: Return location for error. + * + * Extracts a #EggDBusVariant from @message and moves on to the next element. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_variant (EggDBusMessage *message, EggDBusVariant **out_variant, @@ -1230,6 +1730,16 @@ egg_dbus_message_extract_variant (EggDBusMessage *message, } +/** + * egg_dbus_message_extract_gvalue: + * @message: A #EggDBusMessage. + * @out_value: Return location for extracted value or %NULL. + * @error: Return location for error. + * + * Extracts the next complete complete type from @message as a #GValue. + * + * Returns: %TRUE unless @error is set. + **/ gboolean egg_dbus_message_extract_gvalue (EggDBusMessage *message, GValue *out_value, diff --git a/src/eggdbus/eggdbusmessage.h b/src/eggdbus/eggdbusmessage.h index 625ba60..a51b657 100644 --- a/src/eggdbus/eggdbusmessage.h +++ b/src/eggdbus/eggdbusmessage.h @@ -135,11 +135,11 @@ gboolean egg_dbus_message_append_uint16 (EggDBusMessage *mes guint16 value, GError **error); -gboolean egg_dbus_message_append_int32 (EggDBusMessage *message, +gboolean egg_dbus_message_append_int (EggDBusMessage *message, gint value, GError **error); -gboolean egg_dbus_message_append_uint32 (EggDBusMessage *message, +gboolean egg_dbus_message_append_uint (EggDBusMessage *message, guint value, GError **error); @@ -221,11 +221,11 @@ gboolean egg_dbus_message_extract_uint16 (EggDBusMessage *m guint16 *out_value, GError **error); -gboolean egg_dbus_message_extract_int32 (EggDBusMessage *message, +gboolean egg_dbus_message_extract_int (EggDBusMessage *message, gint *out_value, GError **error); -gboolean egg_dbus_message_extract_uint32 (EggDBusMessage *message, +gboolean egg_dbus_message_extract_uint (EggDBusMessage *message, guint *out_value, GError **error); diff --git a/src/eggdbus/interface.c b/src/eggdbus/interface.c index 1ed1cfb..5cd5323 100644 --- a/src/eggdbus/interface.c +++ b/src/eggdbus/interface.c @@ -1104,7 +1104,7 @@ append_args (const EggDBusInterfaceArgInfo *args, } else if (arg->signature[0] == DBUS_TYPE_INT32) { - g_print ("%s_int32 (%s, %s, %s)", + g_print ("%s_int (%s, %s, %s)", operation_str, message_name, arg_str, @@ -1112,7 +1112,7 @@ append_args (const EggDBusInterfaceArgInfo *args, } else if (arg->signature[0] == DBUS_TYPE_UINT32) { - g_print ("%s_uint32 (%s, %s, %s)", + g_print ("%s_uint (%s, %s, %s)", operation_str, message_name, arg_str, diff --git a/src/tests/Makefile.am b/src/tests/Makefile.am index e26641e..eea4b4f 100644 --- a/src/tests/Makefile.am +++ b/src/tests/Makefile.am @@ -41,9 +41,7 @@ BUILT_SOURCES = \ testbindingsmarshal.list \ $(NULL) -# $(BUILT_SOURCES) : Makefile.am $(top_builddir)/src/eggdbus/eggdbus-binding-tool com.example.Frob.xml com.example.Tweak.xml com.example.Twiddle.xml - -$(BUILT_SOURCES) : Makefile.am com.example.Frob.xml com.example.Tweak.xml com.example.Twiddle.xml + $(BUILT_SOURCES) : Makefile.am $(top_builddir)/src/eggdbus/eggdbus-binding-tool com.example.Frob.xml com.example.Tweak.xml com.example.Twiddle.xml EGG_DBUS_GENMARSHAL=$(top_builddir)/src/eggdbus/eggdbus-glib-genmarshal $(top_builddir)/src/eggdbus/eggdbus-binding-tool \ --namespace "Test" \ --dbus-namespace "com.example" \ |