path: root/src/plugins/python_plugins.h

/*
 * python_plugins.h
 * vim: expandtab:ts=4:sts=4:sw=4
 *
 * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
 *
 * This file is part of Profanity.
 *
 * Profanity 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 3 of the License, or
 * (at your option) any later version.
 *
 * Profanity 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 Profanity.  If not, see <https://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link the code of portions of this program with the OpenSSL library under
 * certain conditions as described in each individual source file, and
 * distribute linked combinations including the two.
 *
 * You must obey the GNU General Public License in all respects for all of the
 * code used other than OpenSSL. If you modify file(s) with this exception, you
 * may extend this exception to your version of the file(s), but you are not
 * obligated to do so. If you do not wish to do so, delete this exception
 * statement from your version. If you delete this exception statement from all
 * source files in the program, then also delete it here.
 *
 */

#ifndef PLUGINS_PYTHON_PLUGINS_H
#define PLUGINS_PYTHON_PLUGINS_H

#include "plugins/plugins.h"

ProfPlugin* python_plugin_create(const char* const filename);
void python_plugin_destroy(ProfPlugin* plugin);
void python_check_error(void);
void allow_python_threads();
void disable_python_threads();

const char* python_get_version_string(void);
gchar* python_get_version_number(void);

void python_init_hook(ProfPlugin* plugin, const char* const version, const char* const status,
                      const char* const account_name, const char* const fulljid);

gboolean python_contains_hook(ProfPlugin* plugin, const char* const hook);

void python_on_start_hook(ProfPlugin* plugin);
void python_on_shutdown_hook(ProfPlugin* plugin);
void python_on_unload_hook(ProfPlugin* plugin);
void python_on_connect_hook(ProfPlugin* plugin, const char* const account_name, const char* const fulljid);
void python_on_disconnect_hook(ProfPlugin* plugin, const char* const account_name, const char* const fulljid);

char* python_pre_chat_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const resource, const char* message);
void python_post_chat_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const resource, const char* message);
char* python_pre_chat_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* message);
void python_post_chat_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* message);

char* python_pre_room_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                           const char* message);
void python_post_room_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                           const char* message);
char* python_pre_room_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* message);
void python_post_room_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* message);
void python_on_room_history_message_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                         const char* const message, const char* const timestamp);

char* python_pre_priv_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                           const char* message);
void python_post_priv_message_display_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                           const char* message);
char* python_pre_priv_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                        const char* const message);
void python_post_priv_message_send_hook(ProfPlugin* plugin, const char* const barejid, const char* const nick,
                                        const char* const message);

char* python_on_message_stanza_send_hook(ProfPlugin* plugin, const char* const text);
gboolean python_on_message_stanza_receive_hook(ProfPlugin* plugin, const char* const text);
char* python_on_presence_stanza_send_hook(ProfPlugin* plugin, const char* const text);
gboolean python_on_presence_stanza_receive_hook(ProfPlugin* plugin, const char* const text);
char* python_on_iq_stanza_send_hook(ProfPlugin* plugin, const char* const text);
gboolean python_on_iq_stanza_receive_hook(ProfPlugin* plugin, const char* const text);

void python_on_contact_offline_hook(ProfPlugin* plugin, const char* const barejid, const char* const resource,
                                    const char* const status);
void python_on_contact_presence_hook(ProfPlugin* plugin, const char* const barejid, const char* const resource,
                                     const char* const presence, const char* const status, const int priority);

void python_on_chat_win_focus_hook(ProfPlugin* plugin, const char* const barejid);
void python_on_room_win_focus_hook(ProfPlugin* plugin, const char* const barejid);

#endif