devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 9 Actions Packages Projects 1 Releases Wiki Activity

Fix documentation so it does not cause warnings by parsers #33

Manually merged
jabber.developer merged 5 commits from docs/minor-fixes into master 2025-09-30 08:59:20 +00:00
Conversation 0 Commits 5 Files Changed 6 +1238 -1295
6 changed files with 1238 additions and 1295 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
.github/workflows/ci-api-docs.yml vendored Normal file
View File

@@ -0,0 +1,44 @@
name: CI API Docs
on:
push:
branches: [master]
paths:
- 'apidocs/**'
pull_request:
branches: [master]
paths:
- 'apidocs/**'
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
test-c-api-docs:
runs-on: ubuntu-latest
name: Test C API Documentation Generation
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends make doxygen
- name: Test C API docs generation
run: |
cd apidocs/c/
doxygen c-prof.conf
test-python-api-docs:
runs-on: ubuntu-latest
name: Test Python API Documentation Generation
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends make python3-sphinx
- name: Test Python API docs generation
run: |
cd apidocs/python/
sphinx-apidoc -f -o . src && make -j$(nproc) xml SPHINXOPTS="-W --keep-going -n"

40
.github/workflows/main.yml → .github/workflows/ci-code.yml vendored
View File

@@ -1,10 +1,18 @@
name: CI name: CI Code
on: on:
push: push:
branches: [master] branches: [master]
paths-ignore:
- 'docs/**'
- 'apidocs/**'
- 'README.md'
pull_request: pull_request:
branches: [master] branches: [master]
paths-ignore:
- 'docs/**'
- 'apidocs/**'
- 'README.md'
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -83,38 +91,10 @@ jobs:
continue-on-error: true continue-on-error: true
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: install dependencies - name: Install dependencies
run: | run: |
sudo apt update sudo apt update
sudo apt install -y --no-install-recommends codespell sudo apt install -y --no-install-recommends codespell
- name: Check spelling - name: Check spelling
run: | run: |
codespell codespell
test-c-api-docs:
runs-on: ubuntu-latest
name: Test C API Documentation Generation
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends make doxygen
- name: Test C API docs generation
run: |
cd apidocs/c/
doxygen c-prof.conf
test-python-api-docs:
runs-on: ubuntu-latest
name: Test Python API Documentation Generation
steps:
- uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends make python3-sphinx
- name: Test Python API docs generation
run: |
cd apidocs/python/
sphinx-apidoc -f -o . src && make -j$(nproc) xml SPHINXOPTS="-W --keep-going -n"

831
apidocs/c/profapi.h
View File

File diff suppressed because it is too large Load Diff

295
apidocs/c/profhooks.h
View File

@@ -1,220 +1,247 @@
/** @file /** @file profhooks.h
C Hooks. * @brief C Plugin Hooks for CProof.
*/ *
* This header defines optional callback hooks that CProof plugins can implement to
* handle events such as startup, shutdown, message processing, and presence updates in
* CProof, a console-based XMPP client. These hooks are called by CProof when the
* corresponding events occur, allowing plugins to customize behavior. All hooks are
* optional; plugins can define only the hooks they need, and CProof will automatically
* invoke them when appropriate.
*
* To use these hooks, define the functions in your plugin with the signatures provided
* in this header. For example, to handle the startup event:
*
* @code
* #include "profhooks.h"
* void prof_on_start(void) {
* // Handle CProof startup
* }
* @endcode
*
* For additional plugin functionality, such as displaying messages or registering
* commands, see the CProof API functions in profapi.h.
*
* @see profapi.h
*/
/** @mainpage CProof Plugins API and Hooks
* List of all API functions available to plugins: @ref profapi.h
* List of all hooks which plugins may implement: @ref profhooks.h
*/
/** /**
Called when a plugin is loaded, either when profanity is started, or when the /plugins load or /plugins install commands are called * Called when a plugin is loaded, either when CProof is started, or when the /plugins load or /plugins install commands are called
@param version the version of Profanity * @param version The version of CProof
@param status the package status of Profanity, "development" or "release" * @param status The package status of CProof, "development" or "release"
@param account_name account name of the currently logged in account, or NULL if not logged in * @param account_name Account name of the currently logged in account, or NULL if not logged in
@param fulljid the users full Jabber ID (barejid and resource) if logged in, NULL otherwise * @param fulljid The user's full Jabber ID (barejid and resource) if logged in, NULL otherwise
*/ */
void prof_init(const char * const version, const char * const status, const char *const account_name, const char *const fulljid); void prof_init(const char * const version, const char * const status, const char *const account_name, const char *const fulljid);
/** /**
Called when Profanity is started * Called when CProof is started
*/ */
void prof_on_start(void); void prof_on_start(void);
/** /**
Called when the user quits Profanity * Called when the user quits CProof
*/ */
void prof_on_shutdown(void); void prof_on_shutdown(void);
/** /**
Called when a plugin is unloaded with the /plugins unload command * Called when a plugin is unloaded with the /plugins unload command
*/ */
void prof_on_unload(void); void prof_on_unload(void);
/** /**
Called when the user connects with an account * Called when the user connects with an account
@param account_name account name of the account used for logging in * @param account_name Account name of the account used for logging in
@param fulljid the full Jabber ID (barejid and resource) of the account * @param fulljid The full Jabber ID (barejid and resource) of the account
*/ */
void prof_on_connect(const char * const account_name, const char * const fulljid); void prof_on_connect(const char * const account_name, const char * const fulljid);
/** /**
Called when the user disconnects an account * Called when the user disconnects an account
@param account_name account name of the account being disconnected * @param account_name Account name of the account being disconnected
@param fulljid the full Jabber ID (barejid and resource) of the account * @param fulljid The full Jabber ID (barejid and resource) of the account
*/ */
void prof_on_disconnect(const char * const account_name, const char * const fulljid); void prof_on_disconnect(const char * const account_name, const char * const fulljid);
/** /**
Called before a chat message is displayed * Called before a chat message is displayed
@param barejid Jabber ID of the message sender * @param barejid Jabber ID of the message sender
@param resource resource of the message sender * @param resource Resource of the message sender
@param message the received message * @param message The received message
@return the new message to display, or NULL to preserve the original message * @return The new message to display, or NULL to preserve the original message
*/ */
char* prof_pre_chat_message_display(const char * const barejid, const char *const resource, const char *message); char* prof_pre_chat_message_display(const char * const barejid, const char *const resource, const char *message);
/** /**
Called after a chat message is displayed * Called after a chat message is displayed
@param barejid Jabber ID of the message sender * @param barejid Jabber ID of the message sender
@param resource resource of the message sender * @param resource Resource of the message sender
@param message the received message * @param message The received message
*/ */
void prof_post_chat_message_display(const char * const barejid, const char *const resource, const char *message); void prof_post_chat_message_display(const char * const barejid, const char *const resource, const char *message);
/** /**
Called before a chat message is sent * Called before a chat message is sent
@param barejid Jabber ID of the message recipient * @param barejid Jabber ID of the message recipient
@param message the message to be sent * @param message The message to be sent
@return the modified or original message to send, or NULL to cancel sending of the message * @return The modified or original message to send, or NULL to cancel sending of the message
*/ */
char* prof_pre_chat_message_send(const char * const barejid, const char *message); char* prof_pre_chat_message_send(const char * const barejid, const char *message);
/** /**
Called after a chat message has been sent * Called after a chat message has been sent
@param barejid Jabber ID of the message recipient * @param barejid Jabber ID of the message recipient
@param message the sent message * @param message The sent message
*/ */
void prof_post_chat_message_send(const char * const barejid, const char *message); void prof_post_chat_message_send(const char * const barejid, const char *message);
/** /**
Called before a chat room message is displayed * Called before a chat room message is displayed
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of message sender * @param nick Nickname of message sender
@param message the received message * @param message The received message
@return the new message to display, or NULL to preserve the original message * @return The new message to display, or NULL to preserve the original message
*/ */
char* prof_pre_room_message_display(const char * const barejid, const char * const nick, const char *message); char* prof_pre_room_message_display(const char * const barejid, const char * const nick, const char *message);
/** /**
Called after a chat room message is displayed * Called after a chat room message is displayed
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of the message sender * @param nick Nickname of the message sender
@param message the received message * @param message The received message
*/ */
void prof_post_room_message_display(const char * const barejid, const char * const nick, const char *message); void prof_post_room_message_display(const char * const barejid, const char * const nick, const char *message);
/** /**
Called before a chat room message is sent * Called before a chat room message is sent
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param message the message to be sent * @param message The message to be sent
@return the modified or original message to send, or NULL to cancel sending of the message * @return The modified or original message to send, or NULL to cancel sending of the message
*/ */
char* prof_pre_room_message_send(const char * const barejid, const char *message); char* prof_pre_room_message_send(const char * const barejid, const char *message);
/** /**
Called after a chat room message has been sent * Called after a chat room message has been sent
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param message the sent message * @param message The sent message
*/ */
void prof_post_room_message_send(const char * const barejid, const char *message); void prof_post_room_message_send(const char * const barejid, const char *message);
/** /**
Called when the server sends a chat room history message * Called when the server sends a chat room history message
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of the message sender * @param nick Nickname of the message sender
@param message the message to be sent * @param message The message to be sent
@param timestamp time the message was originally sent to the room, in ISO8601 format * @param timestamp Time the message was originally sent to the room, in ISO8601 format
*/ */
void prof_on_room_history_message(const char * const barejid, const char *const nick, const char *const message, const char *const timestamp); void prof_on_room_history_message(const char * const barejid, const char *const nick, const char *const message, const char *const timestamp);
/** /**
Called before a private chat room message is displayed * Called before a private chat room message is displayed
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of message sender * @param nick Nickname of message sender
@param message the received message * @param message The received message
@return the new message to display, or NULL to preserve the original message * @return The new message to display, or NULL to preserve the original message
*/ */
char* prof_pre_priv_message_display(const char * const barejid, const char * const nick, const char *message); char* prof_pre_priv_message_display(const char * const barejid, const char * const nick, const char *message);
/** /**
Called after a private chat room message is displayed * Called after a private chat room message is displayed
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of the message sender * @param nick Nickname of the message sender
@param message the received message * @param message The received message
*/ */
void prof_post_priv_message_display(const char * const barejid, const char * const nick, const char *message); void prof_post_priv_message_display(const char * const barejid, const char * const nick, const char *message);
/** /**
Called before a private chat room message is sent * Called before a private chat room message is sent
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of message recipient * @param nick Nickname of message recipient
@param message the message to be sent * @param message The message to be sent
@return the modified or original message to send, or NULL to cancel sending of the message * @return The modified or original message to send, or NULL to cancel sending of the message
*/ */
char* prof_pre_priv_message_send(const char * const barejid, const char * const nick, const char *message); char* prof_pre_priv_message_send(const char * const barejid, const char * const nick, const char *message);
/** /**
Called after a private chat room message has been sent * Called after a private chat room message has been sent
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
@param nick nickname of the message recipient * @param nick Nickname of the message recipient
@param message the sent message * @param message The sent message
*/ */
void prof_post_priv_message_send(const char * const barejid, const char * const nick, const char *message); void prof_post_priv_message_send(const char * const barejid, const char * const nick, const char *message);
/** /**
Called before an XMPP message stanza is sent * Called before an XMPP message stanza is sent
@param stanza The stanza to send * @param stanza The stanza to send
@return The new stanza to send, or NULL to preserve the original stanza * @return The new stanza to send, or NULL to preserve the original stanza
*/ */
char* prof_on_message_stanza_send(const char *const stanza); char* prof_on_message_stanza_send(const char *const stanza);
/** /**
Called when an XMPP message stanza is received * Called when an XMPP message stanza is received
@param stanza The stanza received * @param stanza The stanza received
@return 1 if Profanity should continue to process the message stanza, 0 otherwise * @return 1 if CProof should continue to process the message stanza, 0 otherwise
*/ */
int prof_on_message_stanza_receive(const char *const stanza); int prof_on_message_stanza_receive(const char *const stanza);
/** /**
Called before an XMPP presence stanza is sent * Called before an XMPP presence stanza is sent
@param stanza The stanza to send * @param stanza The stanza to send
@return The new stanza to send, or NULL to preserve the original stanza * @return The new stanza to send, or NULL to preserve the original stanza
*/ */
char* prof_on_presence_stanza_send(const char *const stanza); char* prof_on_presence_stanza_send(const char *const stanza);
/** /**
Called when an XMPP presence stanza is received * Called when an XMPP presence stanza is received
@param stanza The stanza received * @param stanza The stanza received
@return 1 if Profanity should continue to process the presence stanza, 0 otherwise * @return 1 if CProof should continue to process the presence stanza, 0 otherwise
*/ */
int prof_on_presence_stanza_receive(const char *const stanza); int prof_on_presence_stanza_receive(const char *const stanza);
/** /**
Called before an XMPP iq stanza is sent * Called before an XMPP iq stanza is sent
@param stanza The stanza to send * @param stanza The stanza to send
@return The new stanza to send, or NULL to preserve the original stanza * @return The new stanza to send, or NULL to preserve the original stanza
*/ */
char* prof_on_iq_stanza_send(const char *const stanza); char* prof_on_iq_stanza_send(const char *const stanza);
/** /**
Called when an XMPP iq stanza is received * Called when an XMPP iq stanza is received
@param stanza The stanza received * @param stanza The stanza received
@return 1 if Profanity should continue to process the iq stanza, 0 otherwise * @return 1 if CProof should continue to process the iq stanza, 0 otherwise
*/ */
int prof_on_iq_stanza_receive(const char *const stanza); int prof_on_iq_stanza_receive(const char *const stanza);
/** /**
Called when a contact goes offline * Called when a contact goes offline
@param barejid Jabber ID of the contact * @param barejid Jabber ID of the contact
@param resource the resource being disconnected * @param resource The resource being disconnected
@param status the status message received with the offline presence, or NULL * @param status The status message received with the offline presence, or NULL
*/ */
void prof_on_contact_offline(const char *const barejid, const char *const resource, const char *const status); void prof_on_contact_offline(const char *const barejid, const char *const resource, const char *const status);
/** /**
Called when a presence notification is received from a contact * Called when a presence notification is received from a contact
@param barejid Jabber ID of the contact * @param barejid Jabber ID of the contact
@param resource the resource being disconnected * @param resource The resource being disconnected
@param presence presence of the contact, one of "chat", "online", "away", "xa" or "dnd" * @param presence Presence of the contact, one of "chat", "online", "away", "xa" or "dnd"
@param status the status message received with the presence, or NULL * @param status The status message received with the presence, or NULL
@param priority the priority associated with the resource * @param priority The priority associated with the resource
*/ */
void prof_on_contact_presence(const char *const barejid, const char *const resource, const char *const presence, const char *const status, const int priority); void prof_on_contact_presence(const char *const barejid, const char *const resource, const char *const presence, const char *const status, const int priority);
/** /**
Called when a chat window is focused * Called when a chat window is focused
@param barejid Jabber ID of the chat window recipient * @param barejid Jabber ID of the chat window recipient
*/ */
void prof_on_chat_win_focus(const char *const barejid); void prof_on_chat_win_focus(const char *const barejid);
/** /**
Called when a chat room window is focused * Called when a chat room window is focused
@param barejid Jabber ID of the room * @param barejid Jabber ID of the room
*/ */
void prof_on_room_win_focus(const char *const barejid); void prof_on_room_win_focus(const char *const barejid);

396
apidocs/python/src/plugin.py
View File

@@ -3,12 +3,14 @@ The plugin module defines optional callback functions that CProof plugins can
implement to handle events such as startup, shutdown, message processing, and implement to handle events such as startup, shutdown, message processing, and
presence updates. presence updates.
:: All functions are optional and are called by CProof when the corresponding event
occurs. You need to define them in your module and they will automatically be used
for callback events.
To utilize full functionality, such as the ``prof.cons_show`` function, see ``prof``
documentation and use::
import prof import prof
All functions are optional and are called by CProof when the corresponding event
occurs. String parameters and return values are Python 3 str types.
""" """
# Initialization and Lifecycle # Initialization and Lifecycle
@@ -20,18 +22,13 @@ def prof_init(version: str, status: str, account_name: str | None, fulljid: str
Called when CProof starts or when the plugin is loaded via the ``/plugins load`` Called when CProof starts or when the plugin is loaded via the ``/plugins load``
or ``/plugins install`` commands. or ``/plugins install`` commands.
Args: :param version: The version of CProof (e.g., ``"1.0.0"``).
version: The version of CProof (e.g., ``"1.0.0"``). :param status: The package status of CProof (``"development"`` or ``"release"``).
status: The package status of CProof (``"development"`` or ``"release"``). :param account_name: The account name of the logged-in user, or None if not logged in.
account_name: The account name of the logged-in user, or None if not logged in. :param fulljid: The full Jabber ID (barejid/resource) of the logged-in user, or None if not logged in.
fulljid: The full Jabber ID (barejid/resource) of the logged-in user, or None if not logged in. :return: None
Returns: Example::
None
Example:
::
def prof_init(version: str, status: str, account_name: str | None, fulljid: str | None) -> None: def prof_init(version: str, status: str, account_name: str | None, fulljid: str | None) -> None:
prof.cons_show(f"MyPlugin for CProof {version} ({status}) has been loaded, account: {account_name}") prof.cons_show(f"MyPlugin for CProof {version} ({status}) has been loaded, account: {account_name}")
@@ -43,15 +40,9 @@ def prof_on_start() -> None:
Use this to perform setup tasks that should occur at application startup. Use this to perform setup tasks that should occur at application startup.
Args: :return: None
None
Returns: Example::
None
Example:
::
def prof_on_start() -> None: def prof_on_start() -> None:
prof.cons_show("CProof has started...") prof.cons_show("CProof has started...")
@@ -63,15 +54,9 @@ def prof_on_shutdown() -> None:
Use this to perform cleanup tasks before the application exits. Use this to perform cleanup tasks before the application exits.
Args: :return: None
None
Returns: Example::
None
Example:
::
def prof_on_shutdown() -> None: def prof_on_shutdown() -> None:
prof.cons_show("CProof is shutting down...") prof.cons_show("CProof is shutting down...")
@@ -83,15 +68,9 @@ def prof_on_unload() -> None:
Use this to clean up plugin-specific resources. Use this to clean up plugin-specific resources.
Args: :return: None
None
Returns: Example::
None
Example:
::
def prof_on_unload() -> None: def prof_on_unload() -> None:
prof.cons_show("Plugin unloaded") prof.cons_show("Plugin unloaded")
@@ -101,16 +80,11 @@ def prof_on_unload() -> None:
def prof_on_connect(account_name: str, fulljid: str) -> None: def prof_on_connect(account_name: str, fulljid: str) -> None:
"""Called when a user connects to CProof with an account. """Called when a user connects to CProof with an account.
Args: :param account_name: The account name used for login.
account_name: The account name used for login. :param fulljid: The full Jabber ID (barejid/resource) of the connected account.
fulljid: The full Jabber ID (barejid/resource) of the connected account. :return: None
Returns: Example::
None
Example:
::
def prof_on_connect(account_name: str, fulljid: str) -> None: def prof_on_connect(account_name: str, fulljid: str) -> None:
prof.cons_show(f"Connected as {account_name} ({fulljid})") prof.cons_show(f"Connected as {account_name} ({fulljid})")
@@ -120,16 +94,11 @@ def prof_on_connect(account_name: str, fulljid: str) -> None:
def prof_on_disconnect(account_name: str, fulljid: str) -> None: def prof_on_disconnect(account_name: str, fulljid: str) -> None:
"""Called when a user disconnects an account from CProof. """Called when a user disconnects an account from CProof.
Args: :param account_name: The account name being disconnected.
account_name: The account name being disconnected. :param fulljid: The full Jabber ID (barejid/resource) of the disconnected account.
fulljid: The full Jabber ID (barejid/resource) of the disconnected account. :return: None
Returns: Example::
None
Example:
::
def prof_on_disconnect(account_name: str, fulljid: str) -> None: def prof_on_disconnect(account_name: str, fulljid: str) -> None:
prof.cons_show(f"Disconnected {account_name} ({fulljid})") prof.cons_show(f"Disconnected {account_name} ({fulljid})")
@@ -144,17 +113,12 @@ def prof_pre_chat_message_display(barejid: str, resource: str, message: str) ->
Allows the plugin to modify or cancel the message display. Allows the plugin to modify or cancel the message display.
Args: :param barejid: The Jabber ID of the message sender (e.g., ``bob@example.com``).
barejid: The Jabber ID of the message sender (e.g., ``bob@example.com``). :param resource: The sender's resource (e.g., ``laptop``).
resource: The sender's resource (e.g., ``laptop``). :param message: The received message.
message: The received message. :return: The modified message to display, or None to preserve the original.
Returns: Example::
str | None: The modified message to display, or None to preserve the original.
Example:
::
def prof_pre_chat_message_display(barejid: str, resource: str, message: str) -> str | None: def prof_pre_chat_message_display(barejid: str, resource: str, message: str) -> str | None:
new_message = f"{message} (from {barejid})" new_message = f"{message} (from {barejid})"
@@ -167,17 +131,12 @@ def prof_post_chat_message_display(barejid: str, resource: str, message: str) ->
Use this to perform actions after the message is shown. Use this to perform actions after the message is shown.
Args: :param barejid: The Jabber ID of the message sender (e.g., ``bob@example.com``).
barejid: The Jabber ID of the message sender (e.g., ``bob@example.com``). :param resource: The sender's resource (e.g., ``laptop``).
resource: The sender's resource (e.g., ``laptop``). :param message: The displayed message.
message: The displayed message. :return: None
Returns: Example::
None
Example:
::
def prof_post_chat_message_display(barejid: str, resource: str, message: str) -> None: def prof_post_chat_message_display(barejid: str, resource: str, message: str) -> None:
prof.cons_show(f"Displayed message from {barejid}/{resource}: {message}") prof.cons_show(f"Displayed message from {barejid}/{resource}: {message}")
@@ -189,16 +148,11 @@ def prof_pre_chat_message_send(barejid: str, message: str) -> str | None:
Allows the plugin to modify or cancel the message. Allows the plugin to modify or cancel the message.
Args: :param barejid: The Jabber ID of the recipient (e.g., ``bob@example.com``).
barejid: The Jabber ID of the recipient (e.g., ``bob@example.com``). :param message: The message to be sent.
message: The message to be sent. :return: The modified message to send, or None to cancel sending.
Returns: Example::
str | None: The modified message to send, or None to cancel sending.
Example:
::
def prof_pre_chat_message_send(barejid: str, message: str) -> str | None: def prof_pre_chat_message_send(barejid: str, message: str) -> str | None:
return f"{message} (sent by plugin)" return f"{message} (sent by plugin)"
@@ -210,16 +164,11 @@ def prof_post_chat_message_send(barejid: str, message: str) -> None:
Use this to log or react to sent messages. Use this to log or react to sent messages.
Args: :param barejid: The Jabber ID of the recipient (e.g., ``bob@example.com``).
barejid: The Jabber ID of the recipient (e.g., ``bob@example.com``). :param message: The sent message.
message: The sent message. :return: None
Returns: Example::
None
Example:
::
def prof_post_chat_message_send(barejid: str, message: str) -> None: def prof_post_chat_message_send(barejid: str, message: str) -> None:
prof.cons_show(f"Sent to {barejid}: {message}") prof.cons_show(f"Sent to {barejid}: {message}")
@@ -234,17 +183,12 @@ def prof_pre_room_message_display(barejid: str, nick: str, message: str) -> str
Allows the plugin to modify or cancel the message display. Allows the plugin to modify or cancel the message display.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message sender.
nick: The nickname of the message sender. :param message: The received message.
message: The received message. :return: The modified message to display, or None to preserve the original.
Returns: Example::
str | None: The modified message to display, or None to preserve the original.
Example:
::
def prof_pre_room_message_display(barejid: str, nick: str, message: str) -> str | None: def prof_pre_room_message_display(barejid: str, nick: str, message: str) -> str | None:
return f"{message} (from {nick})" return f"{message} (from {nick})"
@@ -256,17 +200,12 @@ def prof_post_room_message_display(barejid: str, nick: str, message: str) -> Non
Use this to perform actions after the message is shown. Use this to perform actions after the message is shown.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message sender.
nick: The nickname of the message sender. :param message: The displayed message.
message: The displayed message. :return: None
Returns: Example::
None
Example:
::
def prof_post_room_message_display(barejid: str, nick: str, message: str) -> None: def prof_post_room_message_display(barejid: str, nick: str, message: str) -> None:
prof.cons_show(f"Displayed in {barejid} from {nick}: {message}") prof.cons_show(f"Displayed in {barejid} from {nick}: {message}")
@@ -278,16 +217,11 @@ def prof_pre_room_message_send(barejid: str, message: str) -> str | None:
Allows the plugin to modify or cancel the message. Allows the plugin to modify or cancel the message.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param message: The message to be sent.
message: The message to be sent. :return: The modified message to send, or None to cancel sending.
Returns: Example::
str | None: The modified message to send, or None to cancel sending.
Example:
::
def prof_pre_room_message_send(barejid: str, message: str) -> str | None: def prof_pre_room_message_send(barejid: str, message: str) -> str | None:
return f"{message} (sent by plugin)" return f"{message} (sent by plugin)"
@@ -299,16 +233,11 @@ def prof_post_room_message_send(barejid: str, message: str) -> None:
Use this to log or react to sent messages. Use this to log or react to sent messages.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param message: The sent message.
message: The sent message. :return: None
Returns: Example::
None
Example:
::
def prof_post_room_message_send(barejid: str, message: str) -> None: def prof_post_room_message_send(barejid: str, message: str) -> None:
prof.cons_show(f"Sent to {barejid}: {message}") prof.cons_show(f"Sent to {barejid}: {message}")
@@ -318,18 +247,13 @@ def prof_post_room_message_send(barejid: str, message: str) -> None:
def prof_on_room_history_message(barejid: str, nick: str, message: str, timestamp: str) -> None: def prof_on_room_history_message(barejid: str, nick: str, message: str, timestamp: str) -> None:
"""Called when a chat room history message is received from the server. """Called when a chat room history message is received from the server.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message sender.
nick: The nickname of the message sender. :param message: The received message.
message: The received message. :param timestamp: The message's original send time in ISO 8601 format (e.g., ``2025-09-10T19:45:00Z``).
timestamp: The message's original send time in ISO 8601 format (e.g., ``2025-09-10T19:45:00Z``). :return: None
Returns: Example::
None
Example:
::
def prof_on_room_history_message(barejid: str, nick: str, message: str, timestamp: str) -> None: def prof_on_room_history_message(barejid: str, nick: str, message: str, timestamp: str) -> None:
prof.cons_show(f"History in {barejid} from {nick} at {timestamp}: {message}") prof.cons_show(f"History in {barejid} from {nick} at {timestamp}: {message}")
@@ -344,17 +268,12 @@ def prof_pre_priv_message_display(barejid: str, nick: str, message: str) -> str
Allows the plugin to modify or cancel the message display. Allows the plugin to modify or cancel the message display.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message sender.
nick: The nickname of the message sender. :param message: The received message.
message: The received message. :return: The modified message to display, or None to preserve the original.
Returns: Example::
str | None: The modified message to display, or None to preserve the original.
Example:
::
def prof_pre_priv_message_display(barejid: str, nick: str, message: str) -> str | None: def prof_pre_priv_message_display(barejid: str, nick: str, message: str) -> str | None:
return f"{message} (private from {nick})" return f"{message} (private from {nick})"
@@ -366,17 +285,12 @@ def prof_post_priv_message_display(barejid: str, nick: str, message: str) -> Non
Use this to perform actions after the message is shown. Use this to perform actions after the message is shown.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message sender.
nick: The nickname of the message sender. :param message: The displayed message.
message: The displayed message. :return: None
Returns: Example::
None
Example:
::
def prof_post_priv_message_display(barejid: str, nick: str, message: str) -> None: def prof_post_priv_message_display(barejid: str, nick: str, message: str) -> None:
prof.cons_show(f"Displayed private in {barejid} from {nick}: {message}") prof.cons_show(f"Displayed private in {barejid} from {nick}: {message}")
@@ -388,17 +302,12 @@ def prof_pre_priv_message_send(barejid: str, nick: str, message: str) -> str | N
Allows the plugin to modify or cancel the message. Allows the plugin to modify or cancel the message.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message recipient.
nick: The nickname of the message recipient. :param message: The message to be sent.
message: The message to be sent. :return: The modified message to send, or None to cancel sending.
Returns: Example::
str | None: The modified message to send, or None to cancel sending.
Example:
::
def prof_pre_priv_message_send(barejid: str, nick: str, message: str) -> str | None: def prof_pre_priv_message_send(barejid: str, nick: str, message: str) -> str | None:
return f"{message} (private to {nick})" return f"{message} (private to {nick})"
@@ -410,17 +319,12 @@ def prof_post_priv_message_send(barejid: str, nick: str, message: str) -> None:
Use this to log or react to sent messages. Use this to log or react to sent messages.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :param nick: The nickname of the message recipient.
nick: The nickname of the message recipient. :param message: The sent message.
message: The sent message. :return: None
Returns: Example::
None
Example:
::
def prof_post_priv_message_send(barejid: str, nick: str, message: str) -> None: def prof_post_priv_message_send(barejid: str, nick: str, message: str) -> None:
prof.cons_show(f"Sent private to {nick} in {barejid}: {message}") prof.cons_show(f"Sent private to {nick} in {barejid}: {message}")
@@ -435,15 +339,10 @@ def prof_on_message_stanza_send(stanza: str) -> str | None:
Allows the plugin to modify or cancel the stanza. Allows the plugin to modify or cancel the stanza.
Args: :param stanza: The XMPP message stanza to send.
stanza: The XMPP message stanza to send. :return: The modified stanza to send, or None to preserve the original.
Returns: Example::
str | None: The modified stanza to send, or None to preserve the original.
Example:
::
def prof_on_message_stanza_send(stanza: str) -> str | None: def prof_on_message_stanza_send(stanza: str) -> str | None:
prof.cons_show(f"Sending message stanza: {stanza}") prof.cons_show(f"Sending message stanza: {stanza}")
@@ -456,15 +355,10 @@ def prof_on_message_stanza_receive(stanza: str) -> bool:
Allows the plugin to control whether CProof processes the stanza. Allows the plugin to control whether CProof processes the stanza.
Args: :param stanza: The received XMPP message stanza.
stanza: The received XMPP message stanza. :return: True to allow CProof to process the stanza, False to block processing.
Returns: Example::
bool: True to allow CProof to process the stanza, False to block processing.
Example:
::
def prof_on_message_stanza_receive(stanza: str) -> bool: def prof_on_message_stanza_receive(stanza: str) -> bool:
prof.cons_show(f"Received message stanza: {stanza}") prof.cons_show(f"Received message stanza: {stanza}")
@@ -477,15 +371,10 @@ def prof_on_presence_stanza_send(stanza: str) -> str | None:
Allows the plugin to modify or cancel the stanza. Allows the plugin to modify or cancel the stanza.
Args: :param stanza: The XMPP presence stanza to send.
stanza: The XMPP presence stanza to send. :return: The modified stanza to send, or None to preserve the original.
Returns: Example::
str | None: The modified stanza to send, or None to preserve the original.
Example:
::
def prof_on_presence_stanza_send(stanza: str) -> str | None: def prof_on_presence_stanza_send(stanza: str) -> str | None:
prof.cons_show(f"Sending presence stanza: {stanza}") prof.cons_show(f"Sending presence stanza: {stanza}")
@@ -498,15 +387,10 @@ def prof_on_presence_stanza_receive(stanza: str) -> bool:
Allows the plugin to control whether CProof processes the stanza. Allows the plugin to control whether CProof processes the stanza.
Args: :param stanza: The received XMPP presence stanza.
stanza: The received XMPP presence stanza. :return: True to allow CProof to process the stanza, False to block processing.
Returns: Example::
bool: True to allow CProof to process the stanza, False to block processing.
Example:
::
def prof_on_presence_stanza_receive(stanza: str) -> bool: def prof_on_presence_stanza_receive(stanza: str) -> bool:
prof.cons_show(f"Received presence stanza: {stanza}") prof.cons_show(f"Received presence stanza: {stanza}")
@@ -519,15 +403,10 @@ def prof_on_iq_stanza_send(stanza: str) -> str | None:
Allows the plugin to modify or cancel the stanza. Allows the plugin to modify or cancel the stanza.
Args: :param stanza: The XMPP IQ stanza to send.
stanza: The XMPP IQ stanza to send. :return: The modified stanza to send, or None to preserve the original.
Returns: Example::
str | None: The modified stanza to send, or None to preserve the original.
Example:
::
def prof_on_iq_stanza_send(stanza: str) -> str | None: def prof_on_iq_stanza_send(stanza: str) -> str | None:
prof.cons_show(f"Sending IQ stanza: {stanza}") prof.cons_show(f"Sending IQ stanza: {stanza}")
@@ -540,15 +419,10 @@ def prof_on_iq_stanza_receive(stanza: str) -> bool:
Allows the plugin to control whether CProof processes the stanza. Allows the plugin to control whether CProof processes the stanza.
Args: :param stanza: The received XMPP IQ stanza.
stanza: The received XMPP IQ stanza. :return: True to allow CProof to process the stanza, False to block processing.
Returns: Example::
bool: True to allow CProof to process the stanza, False to block processing.
Example:
::
def prof_on_iq_stanza_receive(stanza: str) -> bool: def prof_on_iq_stanza_receive(stanza: str) -> bool:
prof.cons_show(f"Received IQ stanza: {stanza}") prof.cons_show(f"Received IQ stanza: {stanza}")
@@ -562,17 +436,12 @@ def prof_on_iq_stanza_receive(stanza: str) -> bool:
def prof_on_contact_offline(barejid: str, resource: str, status: str | None) -> None: def prof_on_contact_offline(barejid: str, resource: str, status: str | None) -> None:
"""Called when a contact goes offline. """Called when a contact goes offline.
Args: :param barejid: The Jabber ID of the contact (e.g., ``bob@example.com``).
barejid: The Jabber ID of the contact (e.g., ``bob@example.com``). :param resource: The resource being disconnected (e.g., ``laptop``).
resource: The resource being disconnected (e.g., ``laptop``). :param status: The status message received with the offline presence, or None.
status: The status message received with the offline presence, or None. :return: None
Returns: Example::
None
Example:
::
def prof_on_contact_offline(barejid: str, resource: str, status: str | None) -> None: def prof_on_contact_offline(barejid: str, resource: str, status: str | None) -> None:
prof.cons_show(f"{barejid}/{resource} went offline: {status or 'No status'}") prof.cons_show(f"{barejid}/{resource} went offline: {status or 'No status'}")
@@ -582,19 +451,14 @@ def prof_on_contact_offline(barejid: str, resource: str, status: str | None) ->
def prof_on_contact_presence(barejid: str, resource: str, presence: str, status: str | None, priority: int) -> None: def prof_on_contact_presence(barejid: str, resource: str, presence: str, status: str | None, priority: int) -> None:
"""Called when a presence notification is received from a contact. """Called when a presence notification is received from a contact.
Args: :param barejid: The Jabber ID of the contact (e.g., ``bob@example.com``).
barejid: The Jabber ID of the contact (e.g., ``bob@example.com``). :param resource: The resource of the contact (e.g., ``laptop``).
resource: The resource of the contact (e.g., ``laptop``). :param presence: The contact's presence (``"chat"``, ``"online"``, ``"away"``, ``"xa"``, or ``"dnd"``).
presence: The contact's presence (``"chat"``, ``"online"``, ``"away"``, ``"xa"``, or ``"dnd"``). :param status: The status message received with the presence, or None.
status: The status message received with the presence, or None. :param priority: The priority associated with the resource.
priority: The priority associated with the resource. :return: None
Returns: Example::
None
Example:
::
def prof_on_contact_presence(barejid: str, resource: str, presence: str, status: str | None, priority: int) -> None: def prof_on_contact_presence(barejid: str, resource: str, presence: str, status: str | None, priority: int) -> None:
prof.notify(f"{barejid} is {presence}", 5000, "Presence") prof.notify(f"{barejid} is {presence}", 5000, "Presence")
@@ -607,15 +471,10 @@ def prof_on_contact_presence(barejid: str, resource: str, presence: str, status:
def prof_on_chat_win_focus(barejid: str) -> None: def prof_on_chat_win_focus(barejid: str) -> None:
"""Called when a chat window is focused. """Called when a chat window is focused.
Args: :param barejid: The Jabber ID of the chat window recipient (e.g., ``bob@example.com``).
barejid: The Jabber ID of the chat window recipient (e.g., ``bob@example.com``). :return: None
Returns: Example::
None
Example:
::
def prof_on_chat_win_focus(barejid: str) -> None: def prof_on_chat_win_focus(barejid: str) -> None:
prof.cons_show(f"Focused chat window for {barejid}") prof.cons_show(f"Focused chat window for {barejid}")
@@ -625,17 +484,12 @@ def prof_on_chat_win_focus(barejid: str) -> None:
def prof_on_room_win_focus(barejid: str) -> None: def prof_on_room_win_focus(barejid: str) -> None:
"""Called when a chat room window is focused. """Called when a chat room window is focused.
Args: :param barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``).
barejid: The Jabber ID of the room (e.g., ``chat@conference.example.com``). :return: None
Returns: Example::
None
Example:
::
def prof_on_room_win_focus(barejid: str) -> None: def prof_on_room_win_focus(barejid: str) -> None:
prof.cons_show(f"Focused room window for {barejid}") prof.cons_show(f"Focused room window for {barejid}")
""" """
pass pass

927
apidocs/python/src/prof.py
View File

File diff suppressed because it is too large Load Diff