From a948d741d987b7c94487ec379484c7557c1ea98e Mon Sep 17 00:00:00 2001 From: James Booth Date: Wed, 10 Aug 2016 20:45:14 +0100 Subject: [PATCH] Rename plugin jid arguments --- apidocs/c/profhooks.h | 40 ++++++++++++------------ apidocs/python/src/plugin.py | 60 ++++++++++++++++++------------------ src/plugins/plugins.c | 56 ++++++++++++++++----------------- src/plugins/plugins.h | 28 ++++++++--------- 4 files changed, 92 insertions(+), 92 deletions(-) diff --git a/apidocs/c/profhooks.h b/apidocs/c/profhooks.h index faad271d..1630a66e 100644 --- a/apidocs/c/profhooks.h +++ b/apidocs/c/profhooks.h @@ -72,78 +72,78 @@ void prof_post_chat_message_send(const char * const barejid, const char *message /** Called before a chat room message is displayed -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of message sender @param message the received message @return the new message to display, or NULL to preserve the original message */ -char* prof_pre_room_message_display(const char * const room, const char * const nick, const char *message); +char* prof_pre_room_message_display(const char * const barejid, const char * const nick, const char *message); /** Called after a chat room message is displayed -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of the message sender @param message the received message */ -void prof_post_room_message_display(const char * const room, const char * const nick, const char *message); +void prof_post_room_message_display(const char * const barejid, const char * const nick, const char *message); /** Called before a chat room message is sent -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param message the message to be sent @return the new message to send, or NULL to preserve the original message */ -char* prof_pre_room_message_send(const char * const room, const char *message); +char* prof_pre_room_message_send(const char * const barejid, const char *message); /** Called after a chat room message has been sent -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param message the sent message */ -void prof_post_room_message_send(const char * const room, const char *message); +void prof_post_room_message_send(const char * const barejid, const char *message); /** Called when the server sends a chat room history message -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of the message sender @param message the message to be sent @param timestamp time the message was originally sent to the room, in ISO8601 format */ -void prof_on_room_history_message(const char * const room, const char *const nick, const char *const message, const char *const timestamp); +void prof_on_room_history_message(const char * const barejid, const char *const nick, const char *const message, const char *const timestamp); /** Called before a private chat room message is displayed -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of message sender @param message the received message @return the new message to display, or NULL to preserve the original message */ -char* prof_pre_priv_message_display(const char * const room, const char * const nick, const char *message); +char* prof_pre_priv_message_display(const char * const barejid, const char * const nick, const char *message); /** Called after a private chat room message is displayed -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of the message sender @param message the received message */ -void prof_post_priv_message_display(const char * const room, const char * const nick, const char *message); +void prof_post_priv_message_display(const char * const barejid, const char * const nick, const char *message); /** Called before a private chat room message is sent -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of message recipient @param message the message to be sent @return the new message to send, or NULL to preserve the original message */ -char* prof_pre_priv_message_send(const char * const room, const char * const nick, const char *message); +char* prof_pre_priv_message_send(const char * const barejid, const char * const nick, const char *message); /** Called after a private chat room message has been sent -@param room Jabber ID of the room +@param barejid Jabber ID of the room @param nick nickname of the message recipient @param message the sent message */ -void prof_post_priv_message_send(const char * const room, const char * const nick, const char *message); +void prof_post_priv_message_send(const char * const barejid, const char * const nick, const char *message); /** Called before an XMPP message stanza is sent @@ -213,6 +213,6 @@ void prof_on_chat_win_focus(const char *const barejid); /** Called when a chat room window is focussed -@param room Jabber ID of the room +@param barejid Jabber ID of the room */ -void prof_on_room_win_focus(const char *const room); +void prof_on_room_win_focus(const char *const barejid); diff --git a/apidocs/python/src/plugin.py b/apidocs/python/src/plugin.py index ff70b4a3..a9dac2cd 100644 --- a/apidocs/python/src/plugin.py +++ b/apidocs/python/src/plugin.py @@ -119,13 +119,13 @@ def prof_post_chat_message_send(barejid, message): pass -def prof_pre_room_message_display(room, nick, message): +def prof_pre_room_message_display(barejid, nick, message): """Called before a chat room message is displayed - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of message sender :param message: the received message - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode :return: the new message to display, or ``None`` to preserve the original message @@ -134,25 +134,25 @@ def prof_pre_room_message_display(room, nick, message): pass -def prof_post_room_message_display(room, nick, message): +def prof_post_room_message_display(barejid, nick, message): """Called after a chat room message is displayed - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of the message sender :param message: the received message - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode """ pass -def prof_pre_room_message_send(room, message): +def prof_pre_room_message_send(barejid, message): """Called before a chat room message is sent - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param message: the message to be sent - :type room: str or unicode + :type barejid: str or unicode :type message: str or unicode :return: the new message to send, or ``None`` to preserve the original message :rtype: str or unicode @@ -160,25 +160,25 @@ def prof_pre_room_message_send(room, message): pass -def prof_post_room_message_send(room, message): +def prof_post_room_message_send(barejid, message): """Called after a chat room message has been sent - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param message: the sent message - :type room: str or unicode + :type barejid: str or unicode :type message: str or unicode """ pass -def prof_on_room_history_message(room, nick, message, timestamp): +def prof_on_room_history_message(barejid, nick, message, timestamp): """Called when the server sends a chat room history message - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of the message sender :param message: the message to be sent :param timestamp: time the message was originally sent to the room, in ISO8601 format - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode :type timestamp: str or unicode @@ -186,13 +186,13 @@ def prof_on_room_history_message(room, nick, message, timestamp): pass -def prof_pre_priv_message_display(room, nick, message): +def prof_pre_priv_message_display(barejid, nick, message): """Called before a private chat room message is displayed - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of message sender :param message: the received message - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode :return: the new message to display, or ``None`` to preserve the original message @@ -201,26 +201,26 @@ def prof_pre_priv_message_display(room, nick, message): pass -def prof_post_priv_message_display(room, nick, message): +def prof_post_priv_message_display(barejid, nick, message): """Called after a private chat room message is displayed - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of the message sender :param message: the received message - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode """ pass -def prof_pre_priv_message_send(room, nick, message): +def prof_pre_priv_message_send(barejid, nick, message): """Called before a private chat room message is sent - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of message recipient :param message: the message to be sent - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode :return: the new message to send, or ``None`` to preserve the original message @@ -229,13 +229,13 @@ def prof_pre_priv_message_send(room, nick, message): pass -def prof_post_priv_message_send(room, nick, message): +def prof_post_priv_message_send(barejid, nick, message): """Called after a private chat room message has been sent - :param room: Jabber ID of the room + :param barejid: Jabber ID of the room :param nick: nickname of the message recipient :param message: the sent message - :type room: str or unicode + :type barejid: str or unicode :type nick: str or unicode :type message: str or unicode """ @@ -347,10 +347,10 @@ def prof_on_chat_win_focus(barejid): pass -def prof_on_room_win_focus(room): +def prof_on_room_win_focus(barejid): """Called when a chat room window is focussed - :param room: Jabber ID of the room - :type room: str or unicode + :param barejid: Jabber ID of the room + :type barejid: str or unicode """ pass diff --git a/src/plugins/plugins.c b/src/plugins/plugins.c index cdade652..0505be6d 100644 --- a/src/plugins/plugins.c +++ b/src/plugins/plugins.c @@ -359,7 +359,7 @@ plugins_on_disconnect(const char * const account_name, const char * const fullji } char* -plugins_pre_chat_message_display(const char * const jid, const char *message) +plugins_pre_chat_message_display(const char * const barejid, const char *message) { char *new_message = NULL; char *curr_message = strdup(message); @@ -368,7 +368,7 @@ plugins_pre_chat_message_display(const char * const jid, const char *message) GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - new_message = plugin->pre_chat_message_display(plugin, jid, curr_message); + new_message = plugin->pre_chat_message_display(plugin, barejid, curr_message); if (new_message) { free(curr_message); curr_message = strdup(new_message); @@ -382,20 +382,20 @@ plugins_pre_chat_message_display(const char * const jid, const char *message) } void -plugins_post_chat_message_display(const char * const jid, const char *message) +plugins_post_chat_message_display(const char * const barejid, const char *message) { GList *values = g_hash_table_get_values(plugins); GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->post_chat_message_display(plugin, jid, message); + plugin->post_chat_message_display(plugin, barejid, message); curr = g_list_next(curr); } g_list_free(values); } char* -plugins_pre_chat_message_send(const char * const jid, const char *message) +plugins_pre_chat_message_send(const char * const barejid, const char *message) { char *new_message = NULL; char *curr_message = strdup(message); @@ -404,7 +404,7 @@ plugins_pre_chat_message_send(const char * const jid, const char *message) GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - new_message = plugin->pre_chat_message_send(plugin, jid, curr_message); + new_message = plugin->pre_chat_message_send(plugin, barejid, curr_message); if (new_message) { free(curr_message); curr_message = strdup(new_message); @@ -418,20 +418,20 @@ plugins_pre_chat_message_send(const char * const jid, const char *message) } void -plugins_post_chat_message_send(const char * const jid, const char *message) +plugins_post_chat_message_send(const char * const barejid, const char *message) { GList *values = g_hash_table_get_values(plugins); GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->post_chat_message_send(plugin, jid, message); + plugin->post_chat_message_send(plugin, barejid, message); curr = g_list_next(curr); } g_list_free(values); } char* -plugins_pre_room_message_display(const char * const room, const char * const nick, const char *message) +plugins_pre_room_message_display(const char * const barejid, const char * const nick, const char *message) { char *new_message = NULL; char *curr_message = strdup(message); @@ -440,7 +440,7 @@ plugins_pre_room_message_display(const char * const room, const char * const nic GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - new_message = plugin->pre_room_message_display(plugin, room, nick, curr_message); + new_message = plugin->pre_room_message_display(plugin, barejid, nick, curr_message); if (new_message) { free(curr_message); curr_message = strdup(new_message); @@ -454,20 +454,20 @@ plugins_pre_room_message_display(const char * const room, const char * const nic } void -plugins_post_room_message_display(const char * const room, const char * const nick, const char *message) +plugins_post_room_message_display(const char * const barejid, const char * const nick, const char *message) { GList *values = g_hash_table_get_values(plugins); GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->post_room_message_display(plugin, room, nick, message); + plugin->post_room_message_display(plugin, barejid, nick, message); curr = g_list_next(curr); } g_list_free(values); } char* -plugins_pre_room_message_send(const char * const room, const char *message) +plugins_pre_room_message_send(const char * const barejid, const char *message) { char *new_message = NULL; char *curr_message = strdup(message); @@ -476,7 +476,7 @@ plugins_pre_room_message_send(const char * const room, const char *message) GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - new_message = plugin->pre_room_message_send(plugin, room, curr_message); + new_message = plugin->pre_room_message_send(plugin, barejid, curr_message); if (new_message) { free(curr_message); curr_message = strdup(new_message); @@ -490,20 +490,20 @@ plugins_pre_room_message_send(const char * const room, const char *message) } void -plugins_post_room_message_send(const char * const room, const char *message) +plugins_post_room_message_send(const char * const barejid, const char *message) { GList *values = g_hash_table_get_values(plugins); GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->post_room_message_send(plugin, room, message); + plugin->post_room_message_send(plugin, barejid, message); curr = g_list_next(curr); } g_list_free(values); } void -plugins_on_room_history_message(const char *const room, const char *const nick, const char *const message, +plugins_on_room_history_message(const char *const barejid, const char *const nick, const char *const message, GDateTime *timestamp) { char *timestamp_str = NULL; @@ -517,7 +517,7 @@ plugins_on_room_history_message(const char *const room, const char *const nick, GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->on_room_history_message(plugin, room, nick, message, timestamp_str); + plugin->on_room_history_message(plugin, barejid, nick, message, timestamp_str); curr = g_list_next(curr); } g_list_free(values); @@ -526,9 +526,9 @@ plugins_on_room_history_message(const char *const room, const char *const nick, } char* -plugins_pre_priv_message_display(const char * const jid, const char *message) +plugins_pre_priv_message_display(const char * const fulljid, const char *message) { - Jid *jidp = jid_create(jid); + Jid *jidp = jid_create(fulljid); char *new_message = NULL; char *curr_message = strdup(message); @@ -551,9 +551,9 @@ plugins_pre_priv_message_display(const char * const jid, const char *message) } void -plugins_post_priv_message_display(const char * const jid, const char *message) +plugins_post_priv_message_display(const char * const fulljid, const char *message) { - Jid *jidp = jid_create(jid); + Jid *jidp = jid_create(fulljid); GList *values = g_hash_table_get_values(plugins); GList *curr = values; @@ -568,9 +568,9 @@ plugins_post_priv_message_display(const char * const jid, const char *message) } char* -plugins_pre_priv_message_send(const char * const jid, const char * const message) +plugins_pre_priv_message_send(const char * const fulljid, const char * const message) { - Jid *jidp = jid_create(jid); + Jid *jidp = jid_create(fulljid); char *new_message = NULL; char *curr_message = strdup(message); @@ -593,9 +593,9 @@ plugins_pre_priv_message_send(const char * const jid, const char * const message } void -plugins_post_priv_message_send(const char * const jid, const char * const message) +plugins_post_priv_message_send(const char * const fulljid, const char * const message) { - Jid *jidp = jid_create(jid); + Jid *jidp = jid_create(fulljid); GList *values = g_hash_table_get_values(plugins); GList *curr = values; @@ -778,13 +778,13 @@ plugins_on_chat_win_focus(const char *const barejid) } void -plugins_on_room_win_focus(const char *const roomjid) +plugins_on_room_win_focus(const char *const barejid) { GList *values = g_hash_table_get_values(plugins); GList *curr = values; while (curr) { ProfPlugin *plugin = curr->data; - plugin->on_room_win_focus(plugin, roomjid); + plugin->on_room_win_focus(plugin, barejid); curr = g_list_next(curr); } g_list_free(values); diff --git a/src/plugins/plugins.h b/src/plugins/plugins.h index 4a324a5f..f3ed4082 100644 --- a/src/plugins/plugins.h +++ b/src/plugins/plugins.h @@ -117,22 +117,22 @@ void plugins_on_shutdown(void); void plugins_on_connect(const char *const account_name, const char *const fulljid); void plugins_on_disconnect(const char *const account_name, const char *const fulljid); -char* plugins_pre_chat_message_display(const char *const jid, const char *message); -void plugins_post_chat_message_display(const char *const jid, const char *message); -char* plugins_pre_chat_message_send(const char *const jid, const char *message); -void plugins_post_chat_message_send(const char *const jid, const char *message); +char* plugins_pre_chat_message_display(const char *const barejid, const char *message); +void plugins_post_chat_message_display(const char *const barejid, const char *message); +char* plugins_pre_chat_message_send(const char *const barejid, const char *message); +void plugins_post_chat_message_send(const char *const barejid, const char *message); -char* plugins_pre_room_message_display(const char *const room, const char *const nick, const char *message); -void plugins_post_room_message_display(const char *const room, const char *const nick, const char *message); -char* plugins_pre_room_message_send(const char *const room, const char *message); -void plugins_post_room_message_send(const char *const room, const char *message); -void plugins_on_room_history_message(const char *const room, const char *const nick, const char *const message, +char* plugins_pre_room_message_display(const char *const barejid, const char *const nick, const char *message); +void plugins_post_room_message_display(const char *const barejid, const char *const nick, const char *message); +char* plugins_pre_room_message_send(const char *const barejid, const char *message); +void plugins_post_room_message_send(const char *const barejid, const char *message); +void plugins_on_room_history_message(const char *const barejid, const char *const nick, const char *const message, GDateTime *timestamp); -char* plugins_pre_priv_message_display(const char *const jid, const char *message); -void plugins_post_priv_message_display(const char *const jid, const char *message); -char* plugins_pre_priv_message_send(const char *const jid, const char *const message); -void plugins_post_priv_message_send(const char *const jid, const char *const message); +char* plugins_pre_priv_message_display(const char *const fulljid, const char *message); +void plugins_post_priv_message_display(const char *const fulljid, const char *message); +char* plugins_pre_priv_message_send(const char *const fulljid, const char *const message); +void plugins_post_priv_message_send(const char *const fulljid, const char *const message); void plugins_win_process_line(char *win, const char *const line); void plugins_close_win(const char *const plugin_name, const char *const tag); @@ -151,7 +151,7 @@ void plugins_on_contact_presence(const char *const barejid, const char *const re const char *const status, const int priority); void plugins_on_chat_win_focus(const char *const barejid); -void plugins_on_room_win_focus(const char *const roomjid); +void plugins_on_room_win_focus(const char *const barejid); gboolean plugins_run_command(const char * const cmd); void plugins_run_timed(void);