protocols/ircv3/purpleircv3connection.h

/*
 * Purple - Internet Messaging Library
 * Copyright (C) Pidgin Developers <devel@pidgin.im>
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this library; if not, see <https://www.gnu.org/licenses/>.
 */

#if !defined(PURPLE_IRCV3_GLOBAL_HEADER_INSIDE) && \
    !defined(PURPLE_IRCV3_COMPILATION)
# error "only <libpurple/protocols/ircv3.h> may be included directly"
#endif

#ifndef PURPLE_IRCV3_CONNECTION_H
#define PURPLE_IRCV3_CONNECTION_H

#include <glib.h>
#include <glib-object.h>

#include <gplugin.h>
#include <gplugin-native.h>

#include <purple.h>

#include "purpleircv3version.h"

G_BEGIN_DECLS

#define PURPLE_IRCV3_TYPE_CONNECTION (purple_ircv3_connection_get_type())

PURPLE_IRCV3_AVAILABLE_IN_ALL
G_DECLARE_DERIVABLE_TYPE(PurpleIRCv3Connection, purple_ircv3_connection,
                         PURPLE_IRCV3, CONNECTION, PurpleConnection)

#include "purpleircv3capabilities.h"
#include "purpleircv3message.h"

struct _PurpleIRCv3ConnectionClass {
	/*< private >*/
	PurpleConnectionClass parent;

	/*< private >*/
	gpointer reserved[8];
};

/**
 * purple_ircv3_connection_register: (skip)
 * @plugin: The GTypeModule
 *
 * Registers the dynamic type using @plugin.
 *
 * Since: 3.0
 */
G_GNUC_INTERNAL void purple_ircv3_connection_register(GPluginNativePlugin *plugin);

/**
 * purple_ircv3_connection_emit_ctcp_request:
 * @connection: The instance.
 * @conversation: The conversation.
 * @message: The message.
 * @command: The CTCP command.
 * @parameters: (nullable): The CTCP parameters.
 *
 * Emits the [signal@Connection:ctcp-request] signal with the given @command
 * and @parameters which originated from @message in @conversation.
 *
 * The message may be modified by a signal handler. For example, the default
 * handler will output an internationalized string that describes what command
 * was requested.
 *
 * Returns: %TRUE if the request was handled and the message should not be
 *          echoed, otherwise %FALSE.
 *
 * Since: 3.0
 */
G_GNUC_INTERNAL gboolean purple_ircv3_connection_emit_ctcp_request(PurpleIRCv3Connection *connection, PurpleConversation *conversation, PurpleMessage *message, const char *command, const char *parameters);

/**
 * purple_ircv3_connection_emit_ctcp_response:
 * @connection: The instance.
 * @conversation: The conversation.
 * @message: The message.
 * @command: The CTCP command.
 * @parameters: (nullable): The CTCP parameters.
 *
 * Emits the [signal@Connection:ctcp-response] signal with the given @command
 * and @parameters which originated from @message in @conversation.
 *
 * The message may be modified by a signal handler. For example, the default
 * handler will output an internationalized string that describes what the
 * response was.
 *
 * Returns: %TRUE if the request was handled and the message should not be
 *          echoed, otherwise %FALSE.
 *
 * Since: 3.0
 */
G_GNUC_INTERNAL gboolean purple_ircv3_connection_emit_ctcp_response(PurpleIRCv3Connection *connection, PurpleConversation *conversation, PurpleMessage *message, const char *command, const char *parameters);

/**
 * purple_ircv3_connection_writef:
 * @connection: The instance.
 * @format: The format string.
 * @...: The arguments for @format.
 *
 * Similar to C `printf()` but writes the format string out to @connection.
 *
 * This will add the proper line termination, so you do not need to worry about
 * that.
 */
void purple_ircv3_connection_writef(PurpleIRCv3Connection *connection, const char *format, ...) G_GNUC_PRINTF(2, 3);

/**
 * purple_ircv3_connection_get_capabilities:
 * @connection: The instance.
 *
 * Gets the list of capabilities that the server supplied during registration.
 *
 * Returns: (transfer none): The list of capabilities that the server supports.
 */
PurpleIRCv3Capabilities *purple_ircv3_connection_get_capabilities(PurpleIRCv3Connection *connection);

/**
 * purple_ircv3_connection_get_registered:
 * @connection: The instance.
 *
 * Gets whether or not the connection has finished the registration process.
 *
 * Returns: %TRUE if registration has been completed otherwise %FALSE.
 *
 * Since: 3.0
 */
PURPLE_IRCV3_AVAILABLE_IN_ALL
gboolean purple_ircv3_connection_get_registered(PurpleIRCv3Connection *connection);

/**
 * purple_ircv3_connection_add_status_message:
 * @connection: The instance.
 * @message: The message.
 *
 * Adds a message to the status conversation/window for @connection.
 *
 * Since: 3.0
 */
PURPLE_IRCV3_AVAILABLE_IN_ALL
void purple_ircv3_connection_add_status_message(PurpleIRCv3Connection *connection, PurpleIRCv3Message *message);

/**
 * purple_ircv3_connection_is_channel:
 * @connection: The instance.
 * @id: The id to check.
 *
 * Checks if @id is a channel.
 *
 * Right now this just checks if @id starts with a `#` but in the future this
 * will be updated to check all channel prefixes that the connection supports.
 *
 * Returns: %TRUE if @id is a channel otherwise %FALSE.
 *
 * Since: 3.0
 */
PURPLE_IRCV3_AVAILABLE_IN_ALL
gboolean purple_ircv3_connection_is_channel(PurpleIRCv3Connection *connection, const char *id);

/**
 * purple_ircv3_connection_find_or_create_conversation:
 * @connection: The instance.
 * @id: The id of the conversation.
 *
 * Looks for an existing conversation belonging to @connection and returns it
 * if found. If not found a new conversation will be created.
 *
 * This will only ever return %NULL if @connection is invalid or @id is %NULL.
 *
 * Note that ownership of the conversation remains with the default
 * [class@Purple.ConversationManager].
 *
 * Returns: (transfer none) (nullable): The conversation.
 *
 * Since: 3.0
 */
PURPLE_IRCV3_AVAILABLE_IN_ALL
PurpleConversation *purple_ircv3_connection_find_or_create_conversation(PurpleIRCv3Connection *connection, const char *id);

/**
 * purple_ircv3_connection_find_or_create_contact:
 * @connection: The instance.
 * @nick: The nickname of the user.
 *
 * Looks for an existing contact belonging to @connection and returns it if
 * found. If not a new contact will be created.
 *
 * This will only ever return %NULL if @connection is invalid or @nick is
 * %NULL.
 *
 * Note that the ownership of the contact remains with the default
 * [class@Purple.ContactManager].
 *
 * Returns: (transfer none) (nullable): The contact.
 *
 * Since: 3.0
 */
PURPLE_IRCV3_AVAILABLE_IN_ALL
PurpleContact *purple_ircv3_connection_find_or_create_contact(PurpleIRCv3Connection *connection, const char *nick);

G_END_DECLS

#endif /* PURPLE_IRCV3_CONNECTION_H */