@@ -20,13 +20,13 @@
typedef char * PROF_WIN_TAG ;
/** Function pointer for command callbacks, accepting an array of arguments. */
typedef void ( * CMD_CB ) ( char * * args ) ;
typedef void ( * CMD_CB ) ( char * * args ) ;
/** Function pointer for timed callbacks, accepting no arguments. */
typedef void ( * TIMED_CB ) ( void ) ;
typedef void ( * TIMED_CB ) ( void ) ;
/** Function pointer for window callbacks, accepting a window tag and input line. */
typedef void ( * WINDOW_CB ) ( PROF_WIN_TAG win , char * line ) ;
typedef void ( * WINDOW_CB ) ( PROF_WIN_TAG win , char * line ) ;
/** Highlights the console window in the status bar. */
void prof_cons_alert ( void ) ;
@@ -41,7 +41,7 @@ void prof_cons_alert(void);
* prof_cons_show("This will appear in the console window");
* @endcode
*/
int prof_cons_show ( const char * const message ) ;
int prof_cons_show ( const char * const message ) ;
/**
* Shows a message in the console with a specified theme.
@@ -57,7 +57,7 @@ int prof_cons_show(const char* const message);
* prof_cons_show_themed("myplugin", "text", NULL, "Plugin themed message");
* @endcode
*/
int prof_cons_show_themed ( const char * const group , const char * const item , const char * const def , const char * const message ) ;
int prof_cons_show_themed ( const char * const group , const char * const item , const char * const def , const char * const message ) ;
/**
* Shows a message indicating a command was used incorrectly.
@@ -69,7 +69,7 @@ int prof_cons_show_themed(const char* const group, const char* const item, const
* prof_cons_bad_cmd_usage("/mycommand");
* @endcode
*/
int prof_cons_bad_cmd_usage ( const char * const cmd ) ;
int prof_cons_bad_cmd_usage ( const char * const cmd ) ;
/**
* Registers a new command with help information and callback.
@@ -91,9 +91,9 @@ int prof_cons_bad_cmd_usage(const char* const cmd);
* prof_register_command("/newcommand", 1, 2, synopsis, "Example command", args, examples, my_function);
* @endcode
*/
void prof_register_command ( const char * command_name , int min_args , int max_args ,
char * * synopsis , const char * description , char * arguments [ ] [ 2 ] , char * * examples ,
CMD_CB callback ) ;
void prof_register_command ( const char * command_name , int min_args , int max_args ,
char * * synopsis , const char * description , char * arguments [ ] [ 2 ] , char * * examples ,
CMD_CB callback ) ;
/**
* Registers a function to be called periodically by CProof.
@@ -118,7 +118,7 @@ void prof_register_timed(TIMED_CB callback, int interval_seconds);
* prof_completer_add("/mycommand", items);
* @endcode
*/
void prof_completer_add ( const char * key , char * * items ) ;
void prof_completer_add ( const char * key , char * * items ) ;
/**
* Removes autocomplete values for a command or argument.
@@ -131,7 +131,7 @@ void prof_completer_add(const char* key, char** items);
* prof_completer_remove("/mycommand", items);
* @endcode
*/
void prof_completer_remove ( const char * key , char * * items ) ;
void prof_completer_remove ( const char * key , char * * items ) ;
/**
* Clears all autocomplete values for a command or argument.
@@ -142,7 +142,7 @@ void prof_completer_remove(const char* key, char** items);
* prof_completer_clear("/mycommand");
* @endcode
*/
void prof_completer_clear ( const char * key ) ;
void prof_completer_clear ( const char * key ) ;
/**
* Adds filepath autocompletion for a command or argument.
@@ -153,7 +153,7 @@ void prof_completer_clear(const char* key);
* prof_filepath_completer_add("/filecmd");
* @endcode
*/
void prof_filepath_completer_add ( const char * prefix ) ;
void prof_filepath_completer_add ( const char * prefix ) ;
/**
* Sends a desktop notification.
@@ -166,7 +166,7 @@ void prof_filepath_completer_add(const char* prefix);
* prof_notify("Example notification", 5000, "Example plugin");
* @endcode
*/
void prof_notify ( const char * message , int timeout_ms , const char * category ) ;
void prof_notify ( const char * message , int timeout_ms , const char * category ) ;
/**
* Sends a line of input to CProof to execute.
@@ -177,7 +177,7 @@ void prof_notify(const char* message, int timeout_ms, const char* category);
* prof_send_line("/who online");
* @endcode
*/
void prof_send_line ( char * line ) ;
void prof_send_line ( char * line ) ;
/**
* Gets the Jabber ID of the current chat recipient.
@@ -185,17 +185,6 @@ void prof_send_line(char* line);
*/
char * prof_get_current_recipient ( void ) ;
/**
* Gets the title of the current window as shown in the titlebar.
*
* Special cases:
* - MUC configuration window: Includes "config" and an asterisk if modified (e.g., "room@example.com config *").
* - vCard window: Includes the bare JID and an asterisk if modified (e.g., "vCard user@example.com *").
*
* @return A null-terminated string containing the window title. The caller must free the returned string.
*/
char * prof_get_current_window ( void ) ;
/**
* Gets the Jabber ID of the current chat room.
* @return The room Jabber ID (e.g., "metalchat@conference.example.com") or NULL if not in a room.
@@ -209,7 +198,7 @@ char* prof_get_current_muc(void);
int prof_current_win_is_console ( void ) ;
/**
* Gets the user' s nickname in the current chat room.
* Gets the user’ s nickname in the current chat room.
* @return The nickname (e.g., "eddie") or NULL if not in a room.
*/
char * prof_get_current_nick ( void ) ;
@@ -219,14 +208,14 @@ char* prof_get_current_nick(void);
* @param barejid The Jabber ID.
* @return The nickname (e.g., "eddie") or the barejid if not in the roster.
*/
char * prof_get_name_from_roster ( const char * barejid ) ;
char * prof_get_name_from_roster ( const char * barejid ) ;
/**
* Gets the barejid for a nickname from the roster.
* @param name The nickname.
* @return The barejid (e.g., "eddie@server.tld") or NULL if not in the roster.
*/
char * prof_get_barejid_from_roster ( const char * name ) ;
char * prof_get_barejid_from_roster ( const char * name ) ;
/**
* Gets nicknames of all occupants in the current chat room.
@@ -236,10 +225,10 @@ char** prof_get_current_occupants(void);
/**
* Gets the current nickname in a chat room.
* @param barejid The room' s Jabber ID.
* @param barejid The room’ s Jabber ID.
* @return The nickname.
*/
char * prof_get_room_nick ( const char * barejid ) ;
char * prof_get_room_nick ( const char * barejid ) ;
/**
* Logs a debug message to the CProof log.
@@ -250,7 +239,7 @@ char* prof_get_room_nick(const char* barejid);
* prof_log_debug("Debug message");
* @endcode
*/
void prof_log_debug ( const char * message ) ;
void prof_log_debug ( const char * message ) ;
/**
* Logs an info message to the CProof log.
@@ -261,7 +250,7 @@ void prof_log_debug(const char* message);
* prof_log_info("Info message");
* @endcode
*/
void prof_log_info ( const char * message ) ;
void prof_log_info ( const char * message ) ;
/**
* Logs a warning message to the CProof log.
@@ -272,7 +261,7 @@ void prof_log_info(const char* message);
* prof_log_warning("Warning message");
* @endcode
*/
void prof_log_warning ( const char * message ) ;
void prof_log_warning ( const char * message ) ;
/**
* Logs an error message to the CProof log.
@@ -283,7 +272,7 @@ void prof_log_warning(const char* message);
* prof_log_error("Error message");
* @endcode
*/
void prof_log_error ( const char * message ) ;
void prof_log_error ( const char * message ) ;
/**
* Creates a plugin window.
@@ -332,7 +321,7 @@ int prof_win_focus(PROF_WIN_TAG win);
* prof_win_show("My Plugin", "Message in plugin window");
* @endcode
*/
int prof_win_show ( PROF_WIN_TAG win , char * message ) ;
int prof_win_show ( PROF_WIN_TAG win , char * message ) ;
/**
* Shows a message in a plugin window with a specified theme.
@@ -349,7 +338,7 @@ int prof_win_show(PROF_WIN_TAG win, char* message);
* prof_win_show_themed("My Plugin", "myplugin", "text", NULL, "Themed message");
* @endcode
*/
int prof_win_show_themed ( PROF_WIN_TAG tag , char * group , char * key , char * def , char * message ) ;
int prof_win_show_themed ( PROF_WIN_TAG tag , char * group , char * key , char * def , char * message ) ;
/**
* Sends an XMPP stanza.
@@ -361,7 +350,7 @@ int prof_win_show_themed(PROF_WIN_TAG tag, char* group, char* key, char* def, ch
* prof_send_stanza("<iq to='juliet@capulet.lit' id='s2c1' type='get'><ping xmlns='urn:xmpp:ping'/></iq>");
* @endcode
*/
int prof_send_stanza ( char * stanza ) ;
int prof_send_stanza ( char * stanza ) ;
/**
* Gets a boolean setting.
@@ -376,7 +365,7 @@ int prof_send_stanza(char* stanza);
* prof_settings_boolean_get("myplugin", "notify", 0);
* @endcode
*/
int prof_settings_boolean_get ( char * group , char * key , int def ) ;
int prof_settings_boolean_get ( char * group , char * key , int def ) ;
/**
* Sets a boolean setting.
@@ -390,7 +379,7 @@ int prof_settings_boolean_get(char* group, char* key, int def);
* prof_settings_boolean_set("myplugin", "activate", 1);
* @endcode
*/
void prof_settings_boolean_set ( char * group , char * key , int value ) ;
void prof_settings_boolean_set ( char * group , char * key , int value ) ;
/**
* Gets a string setting.
@@ -405,7 +394,7 @@ void prof_settings_boolean_set(char* group, char* key, int value);
* prof_settings_string_get("myplugin", "prefix", "prefix-->");
* @endcode
*/
char * prof_settings_string_get ( char * group , char * key , char * def ) ;
char * prof_settings_string_get ( char * group , char * key , char * def ) ;
/**
* Sets a string setting.
@@ -419,7 +408,7 @@ char* prof_settings_string_get(char* group, char* key, char* def);
* prof_settings_string_set("myplugin", "prefix", "myplugin, ");
* @endcode
*/
void prof_settings_string_set ( char * group , char * key , char * value ) ;
void prof_settings_string_set ( char * group , char * key , char * value ) ;
/**
* Gets a string list setting, separated by semicolons.
@@ -433,7 +422,7 @@ void prof_settings_string_set(char* group, char* key, char* value);
* prof_settings_string_list_get("myplugin", "somelist");
* @endcode
*/
char * * prof_settings_string_list_get ( char * group , char * key ) ;
char * * prof_settings_string_list_get ( char * group , char * key ) ;
/**
* Adds an item to a string list setting.
@@ -448,7 +437,7 @@ char** prof_settings_string_list_get(char* group, char* key);
* prof_settings_string_list_add("myplugin", "somelist", "anelement");
* @endcode
*/
void prof_settings_string_list_add ( char * group , char * key , char * value ) ;
void prof_settings_string_list_add ( char * group , char * key , char * value ) ;
/**
* Removes an item from a string list setting.
@@ -463,7 +452,7 @@ void prof_settings_string_list_add(char* group, char* key, char* value);
* prof_settings_string_list_remove("myplugin", "somelist", "anelement");
* @endcode
*/
int prof_settings_string_list_remove ( char * group , char * key , char * value ) ;
int prof_settings_string_list_remove ( char * group , char * key , char * value ) ;
/**
* Clears all items from a string list setting.
@@ -477,7 +466,7 @@ int prof_settings_string_list_remove(char* group, char* key, char* value);
* prof_settings_string_list_clear("myplugin", "somelist");
* @endcode
*/
int prof_settings_string_list_clear ( char * group , char * key ) ;
int prof_settings_string_list_clear ( char * group , char * key ) ;
/**
* Gets an integer setting.
@@ -492,7 +481,7 @@ int prof_settings_string_list_clear(char* group, char* key);
* prof_settings_int_get("myplugin", "timeout", 10);
* @endcode
*/
int prof_settings_int_get ( char * group , char * key , int def ) ;
int prof_settings_int_get ( char * group , char * key , int def ) ;
/**
* Sets an integer setting.
@@ -506,7 +495,7 @@ int prof_settings_int_get(char* group, char* key, int def);
* prof_settings_int_set("myplugin", "timeout", 100);
* @endcode
*/
void prof_settings_int_set ( char * group , char * key , int value ) ;
void prof_settings_int_set ( char * group , char * key , int value ) ;
/**
* Triggers handling of an incoming message as if received by CProof.
@@ -519,10 +508,10 @@ void prof_settings_int_set(char* group, char* key, int value);
* prof_incoming_message("bob@server.org", "laptop", "Hello there");
* @endcode
*/
void prof_incoming_message ( char * barejid , char * resource , char * message ) ;
void prof_incoming_message ( char * barejid , char * resource , char * message ) ;
/**
* Adds a service discovery feature to CProof' s supported features.
* Adds a service discovery feature to CProof’ s supported features.
* Sends a presence update if a session is connected.
* @param feature The feature to add.
*
@@ -531,7 +520,7 @@ void prof_incoming_message(char* barejid, char* resource, char* message);
* prof_disco_add_feature("urn:xmpp:omemo:0:devicelist+notify");
* @endcode
*/
void prof_disco_add_feature ( char * feature ) ;
void prof_disco_add_feature ( char * feature ) ;
/**
* Ends an encrypted session with a user.
@@ -542,7 +531,7 @@ void prof_disco_add_feature(char* feature);
* prof_encryption_reset("alice@server.org");
* @endcode
*/
void prof_encryption_reset ( char * barejid ) ;
void prof_encryption_reset ( char * barejid ) ;
/**
* Sets the titlebar encryption indicator text for a recipient.
@@ -555,10 +544,10 @@ void prof_encryption_reset(char* barejid);
* prof_chat_set_titlebar_enctext("bob@example.com", "safe");
* @endcode
*/
int prof_chat_set_titlebar_enctext ( char * barejid , char * enctext ) ;
int prof_chat_set_titlebar_enctext ( char * barejid , char * enctext ) ;
/**
* Resets the titlebar encryption indicator for a recipient to CProof' s default.
* Resets the titlebar encryption indicator for a recipient to CProof’ s default.
* @param barejid Jabber ID of the recipient.
* @return 1 on success, 0 on failure.
*
@@ -567,7 +556,7 @@ int prof_chat_set_titlebar_enctext(char* barejid, char* enctext);
* prof_chat_unset_titlebar_enctext("bob@example.com");
* @endcode
*/
int prof_chat_unset_titlebar_enctext ( char * barejid ) ;
int prof_chat_unset_titlebar_enctext ( char * barejid ) ;
/**
* Sets the incoming message prefix character for a contact.
@@ -580,7 +569,7 @@ int prof_chat_unset_titlebar_enctext(char* barejid);
* prof_chat_set_incoming_char("kristine@example.com", "*");
* @endcode
*/
int prof_chat_set_incoming_char ( char * barejid , char * ch ) ;
int prof_chat_set_incoming_char ( char * barejid , char * ch ) ;
/**
* Resets the incoming message prefix character for a contact.
@@ -592,7 +581,7 @@ int prof_chat_set_incoming_char(char* barejid, char* ch);
* prof_chat_unset_incoming_char("kristine@example.com");
* @endcode
*/
int prof_chat_unset_incoming_char ( char * barejid ) ;
int prof_chat_unset_incoming_char ( char * barejid ) ;
/**
* Sets the outgoing message prefix character for a contact.
@@ -605,7 +594,7 @@ int prof_chat_unset_incoming_char(char* barejid);
* prof_chat_set_outgoing_char("david@example.com", "+");
* @endcode
*/
int prof_chat_set_outgoing_char ( char * barejid , char * ch ) ;
int prof_chat_set_outgoing_char ( char * barejid , char * ch ) ;
/**
* Resets the outgoing message prefix character for a contact.
@@ -617,7 +606,7 @@ int prof_chat_set_outgoing_char(char* barejid, char* ch);
* prof_chat_unset_outgoing_char("david@example.com");
* @endcode
*/
int prof_chat_unset_outgoing_char ( char * barejid ) ;
int prof_chat_unset_outgoing_char ( char * barejid ) ;
/**
* Sets the titlebar encryption indicator text for a room.
@@ -630,10 +619,10 @@ int prof_chat_unset_outgoing_char(char* barejid);
* prof_room_set_titlebar_enctext("generalchat@conference.service.com", "secret");
* @endcode
*/
int prof_room_set_titlebar_enctext ( char * roomjid , char * enctext ) ;
int prof_room_set_titlebar_enctext ( char * roomjid , char * enctext ) ;
/**
* Resets the titlebar encryption indicator for a room to CProof' s default.
* Resets the titlebar encryption indicator for a room to CProof’ s default.
* @param roomjid Jabber ID of the room.
* @return 1 on success, 0 on failure.
*
@@ -642,7 +631,7 @@ int prof_room_set_titlebar_enctext(char* roomjid, char* enctext);
* prof_room_unset_titlebar_enctext("generalchat@conference.service.com");
* @endcode
*/
int prof_room_unset_titlebar_enctext ( char * roomjid ) ;
int prof_room_unset_titlebar_enctext ( char * roomjid ) ;
/**
* Sets the message prefix character for a room.
@@ -655,7 +644,7 @@ int prof_room_unset_titlebar_enctext(char* roomjid);
* prof_room_set_message_char("ohnoes@conference.example.com", "^");
* @endcode
*/
int prof_room_set_message_char ( char * roomjid , char * ch ) ;
int prof_room_set_message_char ( char * roomjid , char * ch ) ;
/**
* Resets the message prefix character for a room.
@@ -667,7 +656,7 @@ int prof_room_set_message_char(char* roomjid, char* ch);
* prof_room_unset_message_char("ohnoes@conference.example.com");
* @endcode
*/
int prof_room_unset_message_char ( char * roomjid ) ;
int prof_room_unset_message_char ( char * roomjid ) ;
/**
* Shows a message in a chat window.
@@ -680,7 +669,7 @@ int prof_room_unset_message_char(char* roomjid);
* prof_chat_show("bob@server.org", "From a plugin in the chat window");
* @endcode
*/
int prof_chat_show ( char * barejid , char * message ) ;
int prof_chat_show ( char * barejid , char * message ) ;
/**
* Shows a message in a chat window with a theme and prefix character.
@@ -698,7 +687,7 @@ int prof_chat_show(char* barejid, char* message);
* prof_chat_show_themed("bob@server.org", "myplugin", "text", NULL, "!", "Themed message");
* @endcode
*/
int prof_chat_show_themed ( char * barejid , char * group , char * item , char * def , char * ch , char * message ) ;
int prof_chat_show_themed ( char * barejid , char * group , char * item , char * def , char * ch , char * message ) ;
/**
* Shows a message in a chat room window.
@@ -711,7 +700,7 @@ int prof_chat_show_themed(char* barejid, char* group, char* item, char* def, cha
* prof_room_show("chat@conference.example.com", "From a plugin in the chat room");
* @endcode
*/
int prof_room_show ( char * roomjid , char * message ) ;
int prof_room_show ( char * roomjid , char * message ) ;
/**
* Shows a message in a chat room window with a theme and prefix character.
@@ -729,4 +718,4 @@ int prof_room_show(char* roomjid, char* message);
* prof_room_show_themed("chat@conference.example.com", "myplugin", "text", NULL, "!", "Themed message");
* @endcode
*/
int prof_room_show_themed ( char * roomjid , char * group , char * item , char * def , char * ch , char * message ) ;
int prof_room_show_themed ( char * roomjid , char * group , char * item , char * def , char * ch , char * message ) ;