HGKeeper

Make PurplePluginProtocolInfo definitions consistent
release-2.x.y
2020-05-20, David Woodhouse

159344ba2a49

Make PurplePluginProtocolInfo definitions consistent

Since we can't use C99 structure initialisers, we have to manually add
new NULL fields to all protocols whenever we extend the structure.

Make it slightly easier to script that, by making the current last
field (get_cb_alias) consistent in all cases. In particular, there's
no reason *not* to have the trailing comma, as most already do.

Now I can add a new field to the PRPL by doing something like this...

PROTOFILES=`grep -rl '[A-Za-z_][A-Za-z0-9_]*,[[:space:]]*/\* get_cb_alias \*/' libpurple/protocols/ `
sed '/\/\* get_cb_alias \*\//{p;s/[A-Za-z_][A-Za-

/** @page xfer-signals File Transfer Signals

@signals

@signal file-recv-accept

@signal file-recv-start

@signal file-recv-cancel

@signal file-recv-complete

@signal file-recv-request

@signal file-send-accept

@signal file-send-start

@signal file-send-cancel

@signal file-send-complete

@endsignals

@see ft.h

<hr>

@signaldef file-recv-accept

@signalproto

void (*file_recv_accept)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an incoming file transfer has been accepted.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-recv-start

@signalproto

void (*file_recv_start)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an incoming file transfer has been started.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-recv-cancel

@signalproto

void (*file_recv_cancel)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an incoming file transfer has been canceled.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-recv-complete

@signalproto

void (*file_recv_complete)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an incoming file transfer has been completed.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-recv-request

@signalproto

void (*file_recv_request)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted before the user is prompted for an incoming file-transfer.

Plugins can intercept the signal to auto-accept/auto-reject the

requests. To auto-accept the file transfer, use

purple_xfer_request_accepted(). To auto-reject, set the status of the

xfer to PURPLE_XFER_STATUS_CANCEL_LOCAL.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-send-accept

@signalproto

void (*file_send_accept)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an outgoing file transfer has been accepted.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-send-start

@signalproto

void (*file_send_start)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an outgoing file transfer has started.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-send-cancel

@signalproto

void (*file_send_cancel)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an outgoing file transfer has been canceled.

@param xfer The file transfer

@param data User data

@endsignaldef

@signaldef file-send-complete

@signalproto

void (*file_send_complete)(PurpleXfer *xfer, gpointer data);

@endsignalproto

@signaldesc

Emitted when an outgoing file transfer has been completed.

@param xfer The file transfer

@param data User data

@endsignaldef

// vim: syntax=c.doxygen tw=75 et

pidgin/pidgin