* The PurpleIRCv3Connection object that this capabilities was created

* with.

*

*/

properties[PROP_CONNECTION] = g_param_spec_object(

"connection", "connection",

* For dynamically added capabilities see the `added` and `removed`

* signals.

*

*/

signals[SIG_READY] = g_signal_new_class_handler(

"ready",

*

* The value of @capability will be the same as the one that was requested.

*

*/

signals[SIG_ACK] = g_signal_new_class_handler(

"ack",

*

* The value of @capability will be the same as the one that was requested.

*

*/

signals[SIG_NAK] = g_signal_new_class_handler(

"nak",

* Emitted when all of the requested capabilities have been either ack'd or

* nak'd by the server.

*

*/

signals[SIG_DONE] = g_signal_new_class_handler(

"done",

* you can call #purple_ircv3_capabilities_lookup to see if the

* capabilities you're interested in have been added.

*

*/

signals[SIG_NEW] = g_signal_new_class_handler(

"new",

* #purple_ircv3_capabilities_lookup to see if the capabilities you're

* interested in have been removed.

*

*/

signals[SIG_DEL] = g_signal_new_class_handler(

"del",

*

* Dynamically registers the PurpleIRCv3Capabilities type.

*

*/

G_GNUC_INTERNAL void purple_ircv3_capabilities_register(GPluginNativePlugin *plugin);

*

* Returns: (transfer none): The connection instance.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

PurpleIRCv3Connection *purple_ircv3_capabilities_get_connection(PurpleIRCv3Capabilities *capabilities);

* `::ack` and `::nak` signals which will contain the contents of @capability

* that was passed in here.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_capabilities_request(PurpleIRCv3Capabilities *capabilities, const char *capability);

*

* Returns: The value of the capability named @name.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

const char *purple_ircv3_capabilities_lookup(PurpleIRCv3Capabilities *capabilities, const char *name, gboolean *found);

*

* Returns: %TRUE if @name was found and requested, %FALSE otherwise.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

gboolean purple_ircv3_capabilities_lookup_and_request(PurpleIRCv3Capabilities *capabilities, const char *name);

* call of `CAP END` until all capability negotiation has completed. This is

* necessary for SASL and may be necessary for other capabilities as well.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_capabilities_add_wait(PurpleIRCv3Capabilities *capabilities);

* This is necessary for SASL and may be necessary for other capabilities as

* well.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_capabilities_remove_wait(PurpleIRCv3Capabilities *capabilities);

* This is created during registration of the connection and is useful for

* troubleshooting or just reporting them to end users.

*

*/

properties[PROP_CAPABILITIES] = g_param_spec_object(

"capabilities", "capabilities",

* Whether or not the connection has finished the registration portion of

* the connection.

*

*/

properties[PROP_REGISTERED] = g_param_spec_boolean(

"registered", "registered",

* completed. Plugins can use this to perform additional actions before

* any channels are auto joined or similar.

*

*/

signals[SIG_REGISTRATION_COMPLETE] = g_signal_new_class_handler(

"registration-complete",

* command has its message contents replaced with just the CTCP parameters

* and sets the [property@Message:action] to %TRUE and then returns %TRUE.

*

*/

signals[SIG_CTCP_REQUEST] = g_signal_new_class_handler(

"ctcp-request",

* Handlers may modify @conversation or @message to depending on their

* needs.

*

*/

signals[SIG_CTCP_RESPONSE] = g_signal_new_class_handler(

"ctcp-response",

*

* Registers the dynamic type using @plugin.

*

*/

G_GNUC_INTERNAL void purple_ircv3_connection_register(GPluginNativePlugin *plugin);

* Returns: %TRUE if the request was handled and the message should not be

* echoed, otherwise %FALSE.

*

*/

G_GNUC_INTERNAL gboolean purple_ircv3_connection_emit_ctcp_request(PurpleIRCv3Connection *connection, PurpleConversation *conversation, PurpleMessage *message, const char *command, const char *parameters);

* Returns: %TRUE if the request was handled and the message should not be

* echoed, otherwise %FALSE.

*

*/

G_GNUC_INTERNAL gboolean purple_ircv3_connection_emit_ctcp_response(PurpleIRCv3Connection *connection, PurpleConversation *conversation, PurpleMessage *message, const char *command, const char *parameters);

*

* Returns: %TRUE if registration has been completed otherwise %FALSE.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

gboolean purple_ircv3_connection_get_registered(PurpleIRCv3Connection *connection);

*

* Adds a message to the status conversation/window for @connection.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_connection_add_status_message(PurpleIRCv3Connection *connection, PurpleIRCv3Message *message);

*

* Returns: %TRUE if @id is a channel otherwise %FALSE.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

gboolean purple_ircv3_connection_is_channel(PurpleIRCv3Connection *connection, const char *id);

*

* Returns: (transfer none) (nullable): The conversation.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

PurpleConversation *purple_ircv3_connection_find_or_create_conversation(PurpleIRCv3Connection *connection, const char *id);

*

* Returns: (transfer none) (nullable): The contact.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

PurpleContact *purple_ircv3_connection_find_or_create_contact(PurpleIRCv3Connection *connection, const char *nick);

*

* A constant representing the CTCP ACTION command.

*

*/

#define PURPLE_IRCV3_CTCP_ACTION ("ACTION") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* The delimiter used for CTCP messages.

*

*/

#define PURPLE_IRCV3_CTCP_DELIMITER (0x1) PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant representing the CTCP VERSION command.

*

*/

#define PURPLE_IRCV3_CTCP_VERSION ("VERSION") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %NICKLOCKED error.

*

*/

#define PURPLE_IRCV3_ERR_NICKLOCKED ("902") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLABORTED error.

*

*/

#define PURPLE_IRCV3_ERR_SASLABORTED ("906") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLALREADY error.

*

*/

#define PURPLE_IRCV3_ERR_SASLALREADY ("907") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLFAIL error.

*

*/

#define PURPLE_IRCV3_ERR_SASLFAIL ("904") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLTOOLONG error.

*

*/

#define PURPLE_IRCV3_ERR_SASLTOOLONG ("905") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %AUTHENTICATE message.

*

*/

#define PURPLE_IRCV3_MSG_AUTHENTICATE ("AUTHENTICATE") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %CAP message.

*

*/

#define PURPLE_IRCV3_MSG_CAP ("CAP") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %JOIN message.

*

*/

#define PURPLE_IRCV3_MSG_JOIN ("JOIN") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %NOTICE message.

*

*/

#define PURPLE_IRCV3_MSG_NOTICE ("NOTICE") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %PING message.

*

*/

#define PURPLE_IRCV3_MSG_PING ("PING") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %PRIVMSG message.

*

*/

#define PURPLE_IRCV3_MSG_PRIVMSG ("PRIVMSG") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %TOPIC message.

*

*/

#define PURPLE_IRCV3_MSG_TOPIC ("TOPIC") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %CREATED reply.

*

*/

#define PURPLE_IRCV3_RPL_CREATED ("003") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %ENDOFMOTD reply.

*

*/

#define PURPLE_IRCV3_RPL_ENDOFMOTD ("376") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LOGGEDIN reply.

*

*/

#define PURPLE_IRCV3_RPL_LOGGEDIN ("900") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LOGGEDOUT reply.

*

*/

#define PURPLE_IRCV3_RPL_LOGGEDOUT ("901") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LUSERCHANNELS reply.

*

*/

#define PURPLE_IRCV3_RPL_LUSERCHANNELS ("254") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LUSERCLIENT reply.

*

*/

#define PURPLE_IRCV3_RPL_LUSERCLIENT ("251") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LUSERME reply.

*

*/

#define PURPLE_IRCV3_RPL_LUSERME ("255") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LUSEROP reply.

*

*/

#define PURPLE_IRCV3_RPL_LUSEROP ("252") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %LUSERUNKNOWN reply.

*

*/

#define PURPLE_IRCV3_RPL_LUSERUNKNOWN ("253") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %MYINFO reply.

*

*/

#define PURPLE_IRCV3_RPL_MYINFO ("004") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %MOTD reply.

*

*/

#define PURPLE_IRCV3_RPL_MOTD ("372") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %MOTDSTART reply.

*

*/

#define PURPLE_IRCV3_RPL_MOTDSTART ("375") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %NOTOPIC reply.

*

*/

#define PURPLE_IRCV3_RPL_NOTOPIC ("331") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLMECHS reply.

*

*/

#define PURPLE_IRCV3_RPL_SASLMECHS ("908") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %SASLSUCCESS reply.

*

*/

#define PURPLE_IRCV3_RPL_SASLSUCCESS ("903") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %TOPIC reply.

*

*/

#define PURPLE_IRCV3_RPL_TOPIC ("332") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %WELCOME reply.

*

*/

#define PURPLE_IRCV3_RPL_WELCOME ("001") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* A constant for the IRC %YOURHOST reply.

*

*/

#define PURPLE_IRCV3_RPL_YOURHOST ("002") PURPLE_IRCV3_AVAILABLE_MACRO_IN_3_0

*

* Returns: %TRUE if the message was a CTCP message and %FALSE otherwise.

*

*/

G_GNUC_INTERNAL

gboolean purple_ircv3_ctcp_handle(PurpleIRCv3Connection *connection, PurpleConversation *conversation, PurpleMessage *message);

*

* Adds handlers for the CTCP commands that we support directly.

*

*/

G_GNUC_INTERNAL

void purple_ircv3_ctcp_add_default_handlers(PurpleIRCv3Connection *connection);

*

* Returns: (transfer full) (nullable): The result of stripping @text.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

char *purple_ircv3_formatting_strip(const char *text);

*

* This could be something like JOIN or a server reply numeric like 005.

*

*/

properties[PROP_COMMAND] = g_param_spec_string(

"command", "command",

*

* When serialized, the last item will be prefixed with a :.

*

*/

properties[PROP_PARAMS] = g_param_spec_boxed(

"params", "params",

* This could be a nickname, a full nick!ident@server, a server name, or

* %NULL.

*

*/

properties[PROP_SOURCE] = g_param_spec_string(

"source", "source",

* The [ircv3 message tags](https://ircv3.net/specs/extensions/message-tags)

* for the message.

*

*/

properties[PROP_TAGS] = g_param_spec_boxed(

"tags", "tags",

*

* Returns: (transfer full): The new message.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

PurpleIRCv3Message *purple_ircv3_message_new(const char *command);

*

* Returns: The command of the message.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

const char *purple_ircv3_message_get_command(PurpleIRCv3Message *message);

*

* Sets the command for @message to @command.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_message_set_command(PurpleIRCv3Message *message, const char *command);

*

* Returns: (transfer none) (nullable): The parameters from @message.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

GStrv purple_ircv3_message_get_params(PurpleIRCv3Message *message);

*

* Sets the parameters of @message to @params.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_message_set_params(PurpleIRCv3Message *message, GStrv params);

*

* Returns: (nullable): The source of @message.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

const char *purple_ircv3_message_get_source(PurpleIRCv3Message *message);

*

* Sets the source of @message to @source.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_message_set_source(PurpleIRCv3Message *message, const char *source);

* Returns: (transfer none) (element-type utf8 utf8) (nullable): The tags from

* @message.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

GHashTable *purple_ircv3_message_get_tags(PurpleIRCv3Message *message);

*

* Sets the tags of @message to @tags.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_message_set_tags(PurpleIRCv3Message *message, GHashTable *tags);

* Returns: %TRUE if the command was handled properly, otherwise %FALSE and

* @error may be set.

*

*/

PURPLE_IRCV3_AVAILABLE_TYPE_IN_3_0

typedef gboolean (*PurpleIRCv3MessageHandler)(PurpleIRCv3Message *message,

*

* Creates a new instance.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

PurpleIRCv3Parser *purple_ircv3_parser_new(void);

* Sets @handler to be called for any messages that @parser doesn't know how to

* handle.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_parser_set_fallback_handler(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler);

*

* Returns: %TRUE if the buffer was parsed correctly or %FALSE with @error set.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

gboolean purple_ircv3_parser_parse(PurpleIRCv3Parser *parser, const gchar *buffer, GError **error, gpointer data);

*

* Calls @handler every time @parser finds the command named @command.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_parser_add_handler(PurpleIRCv3Parser *parser, const char *command, PurpleIRCv3MessageHandler handler);

* Like [method@Parser.add_handler] but allows you to add multiple commands at

* once that share a handler.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_parser_add_handlers(PurpleIRCv3Parser *parser, PurpleIRCv3MessageHandler handler, ...) G_GNUC_NULL_TERMINATED;

*

* Adds all of the default handlers to @parser.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_parser_add_default_handlers(PurpleIRCv3Parser *parser);

*

* Registers the dynamic type using @plugin.

*

*/

G_GNUC_INTERNAL void purple_ircv3_protocol_register(GPluginNativePlugin *plugin);

* If the user or host aren't present in @source, but a return address is

* provided for them, that pointer will be set to %NULL.

*

*/

PURPLE_IRCV3_AVAILABLE_IN_ALL

void purple_ircv3_source_parse(const char *source, char **nick, char **user, char **host);

* A macro that evaluates to the current stable version of the IRCv3 protocol

* plugin, in a format that can be used by the C pre-processor.

*

*/

#define PURPLE_IRCV3_VERSION_CUR_STABLE \

(G_ENCODE_VERSION(PURPLE_MAJOR_VERSION, PURPLE_MINOR_VERSION))

* A macro that evaluates to the 3.0 version of the IRCv3 protocol plugin, in a

* format that can be used by the C pre-processor.

*

*/

#define PURPLE_IRCV3_VERSION_3_0 (G_ENCODE_VERSION(3, 0))