pidgin/pidgin

Create PurpleConnectionUiOps.report_disconnect_reason and
cpw.resiak.disconnectreason
2007-09-17, Will Thompson
bb30dff3da21
Parents 0e840b026c82
Children 49979e453876
Create PurpleConnectionUiOps.report_disconnect_reason and
purple_connection_error_reason; turn purple_connection_error into a stub
which calls purple_connection_error_reason.
2 files changed, 55 insertions(+), 6 deletions(-)
  • +20 -5
    libpurple/connection.c
  • +35 -1
    libpurple/connection.h
    • --- a/libpurple/connection.c Mon Sep 17 15:05:36 2007 +0000
    +++ b/libpurple/connection.c Mon Sep 17 15:23:29 2007 +0000
    @@ -487,23 +487,38 @@
    void
    purple_connection_error(PurpleConnection *gc, const char *text)
    {
    + purple_connection_error_reason (gc, PURPLE_REASON_OTHER_ERROR, text);
    +}
    +
    +void
    +purple_connection_error_reason (PurpleConnection *gc,
    + PurpleDisconnectReason reason,
    + const char *description)
    +{
    PurpleConnectionUiOps *ops;
    g_return_if_fail(gc != NULL);
    - if (text == NULL) {
    - purple_debug_error("connection", "purple_connection_error: check `text != NULL' failed\n");
    - text = _("Unknown error");
    + if (description == NULL) {
    + purple_debug_error("connection", "purple_connection_error_reason: check `description != NULL' failed\n");
    + description = _("Unknown error");
    }
    + g_assert (reason >= 0 && reason < PURPLE_NUM_REASONS);
    +
    /* If we've already got one error, we don't need any more */
    if (gc->disconnect_timeout)
    return;
    ops = purple_connections_get_ui_ops();
    - if (ops != NULL && ops->report_disconnect != NULL)
    - ops->report_disconnect(gc, text);
    + if (ops != NULL)
    + {
    + if (ops->report_disconnect_reason != NULL)
    + ops->report_disconnect_reason (gc, reason, description);
    + if (ops->report_disconnect != NULL)
    + ops->report_disconnect (gc, description);
    + }
    gc->disconnect_timeout = purple_timeout_add(0, purple_connection_disconnect_cb,
    purple_connection_get_account(gc));
    --- a/libpurple/connection.h Mon Sep 17 15:05:36 2007 +0000
    +++ b/libpurple/connection.h Mon Sep 17 15:23:29 2007 +0000
    @@ -119,11 +119,13 @@
    * the UI of what is happening, as well as which @a step out of @a
    * step_count has been reached (which might be displayed as a progress
    * bar).
    + * @see #purple_connection_update_progress
    */
    void (*connect_progress)(PurpleConnection *gc,
    const char *text,
    size_t step,
    size_t step_count);
    +
    /** Called when a connection is established (just before the
    * @ref signed-on signal).
    */
    @@ -132,17 +134,23 @@
    * and @ref signed-off signals).
    */
    void (*disconnected)(PurpleConnection *gc);
    +
    /** Used to display connection-specific notices. (Pidgin's Gtk user
    * interface implements this as a no-op; #purple_connection_notice(),
    * which uses this operation, is not used by any of the protocols
    * shipped with libpurple.)
    */
    void (*notice)(PurpleConnection *gc, const char *text);
    +
    /** Called when an error causes a connection to be disconnected.
    * Called before #disconnected.
    * @param text a localized error message.
    + * @see #purple_connection_error
    + * @deprecated in favour of
    + * #PurpleConnectionUiOps.report_disconnect_reason.
    */
    void (*report_disconnect)(PurpleConnection *gc, const char *text);
    +
    /** Called when libpurple discovers that the computer's network
    * connection is active. On Linux, this uses Network Manager if
    * available; on Windows, it uses Win32's network change notification
    @@ -154,10 +162,21 @@
    */
    void (*network_disconnected)();
    + /** Called when a connection is disconnected, whether due to an
    + * error or to user request. Called before #disconnected.
    + * @param reason why the connection ended, if known, or
    + * PURPLE_REASON_OTHER_ERROR, if not.
    + * @param text a localized message describing the disconnection
    + * in more detail to the user.
    + * @see #purple_connection_error_reason
    + */
    + void (*report_disconnect_reason)(PurpleConnection *gc,
    + PurpleDisconnectReason reason,
    + const char *text);
    +
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    - void (*_purple_reserved4)(void);
    } PurpleConnectionUiOps;
    struct _PurpleConnection
    @@ -335,9 +354,24 @@
    *
    * @param gc The connection.
    * @param reason The error text.
    + * @deprecated in favour of #purple_connection_error_reason. Calling
    + * @c purple_connection_error(gc, text) is equivalent to calling
    + * @c purple_connection_error_reason(gc, PURPLE_REASON_OTHER_ERROR, text).
    */
    void purple_connection_error(PurpleConnection *gc, const char *reason);
    +/**
    + * Closes a connection with an error and an optional description of the
    + * error.
    + *
    + * @param reason why the connection is closing.
    + * @param description a localized description of the error.
    + */
    +void
    +purple_connection_error_reason (PurpleConnection *gc,
    + PurpleDisconnectReason reason,
    + const char *description);
    +
    /*@}*/
    /**************************************************************************/