StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Const-correctness for tox.c

Browse Source
This commit is contained in:
Marc Schütz 2014-06-30 22:06:59 +02:00
parent ece7e535f3
commit 53d731b4f1
4 changed files with 123 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
toxcore/Messenger.c
View File

@ -1114,7 +1114,7 @@ int del_groupchat(Messenger *m, int groupnumber)
* return length of name if success * return length of name if success
* return -1 if failure * return -1 if failure
*/ */
int m_group_peername(Messenger *m, int groupnumber, int peernumber, uint8_t *name) int m_group_peername(const Messenger *m, int groupnumber, int peernumber, uint8_t *name)
{ {
if ((unsigned int)groupnumber >= m->numchats) if ((unsigned int)groupnumber >= m->numchats)
return -1; return -1;

2
toxcore/Messenger.h
View File

@ -570,7 +570,7 @@ int del_groupchat(Messenger *m, int groupnumber);
* return length of name if success * return length of name if success
* return -1 if failure * return -1 if failure
*/ */
int m_group_peername(Messenger *m, int groupnumber, int peernumber, uint8_t *name); int m_group_peername(const Messenger *m, int groupnumber, int peernumber, uint8_t *name);
/* invite friendnumber to groupnumber /* invite friendnumber to groupnumber
* return 0 on success * return 0 on success

152
toxcore/tox.c
View File

@ -38,9 +38,9 @@ typedef struct Messenger Tox;
* Format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)] * Format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
* *
*/ */
void tox_get_address(Tox *tox, uint8_t *address) void tox_get_address(const Tox *tox, uint8_t *address)
{ {
Messenger *m = tox; const Messenger *m = tox;
getaddress(m, address); getaddress(m, address);
} }
@ -61,7 +61,7 @@ void tox_get_address(Tox *tox, uint8_t *address)
* (the nospam for that friend was set to the new one). * (the nospam for that friend was set to the new one).
* return FAERR_NOMEM if increasing the friend list size fails. * return FAERR_NOMEM if increasing the friend list size fails.
*/ */
int32_t tox_add_friend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length) int32_t tox_add_friend(Tox *tox, const uint8_t *address, const uint8_t *data, uint16_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return m_addfriend(m, address, data, length); return m_addfriend(m, address, data, length);
@ -81,9 +81,9 @@ int32_t tox_add_friend_norequest(Tox *tox, const uint8_t *client_id)
/* return the friend number associated to that client id. /* return the friend number associated to that client id.
* return -1 if no such friend. * return -1 if no such friend.
*/ */
int32_t tox_get_friend_number(Tox *tox, uint8_t *client_id) int32_t tox_get_friend_number(const Tox *tox, const uint8_t *client_id)
{ {
Messenger *m = tox; const Messenger *m = tox;
return getfriend_id(m, client_id); return getfriend_id(m, client_id);
} }
@ -93,9 +93,9 @@ int32_t tox_get_friend_number(Tox *tox, uint8_t *client_id)
* return 0 if success. * return 0 if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_get_client_id(Tox *tox, int32_t friendnumber, uint8_t *client_id) int tox_get_client_id(const Tox *tox, int32_t friendnumber, uint8_t *client_id)
{ {
Messenger *m = tox; const Messenger *m = tox;
return getclient_id(m, friendnumber, client_id); return getclient_id(m, friendnumber, client_id);
} }
@ -112,9 +112,9 @@ int tox_del_friend(Tox *tox, int32_t friendnumber)
* return 0 if friend is not connected to us (Offline). * return 0 if friend is not connected to us (Offline).
* return -1 on failure. * return -1 on failure.
*/ */
int tox_get_friend_connection_status(Tox *tox, int32_t friendnumber) int tox_get_friend_connection_status(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_friend_connectionstatus(m, friendnumber); return m_get_friend_connectionstatus(m, friendnumber);
} }
@ -123,9 +123,9 @@ int tox_get_friend_connection_status(Tox *tox, int32_t friendnumber)
* return 1 if friend exists. * return 1 if friend exists.
* return 0 if friend doesn't exist. * return 0 if friend doesn't exist.
*/ */
int tox_friend_exists(Tox *tox, int32_t friendnumber) int tox_friend_exists(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_friend_exists(m, friendnumber); return m_friend_exists(m, friendnumber);
} }
@ -144,7 +144,7 @@ uint32_t tox_send_message(Tox *tox, int32_t friendnumber, const uint8_t *message
return m_sendmessage(m, friendnumber, message, length); return m_sendmessage(m, friendnumber, message, length);
} }
uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid, uint8_t *message, uint32_t length) uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid, const uint8_t *message, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return m_sendmessage_withid(m, friendnumber, theid, message, length); return m_sendmessage_withid(m, friendnumber, theid, message, length);
@ -160,13 +160,13 @@ uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid,
* m_sendaction_withid will send an action message with the id of your choosing, * m_sendaction_withid will send an action message with the id of your choosing,
* however we can generate an id for you by calling plain m_sendaction. * however we can generate an id for you by calling plain m_sendaction.
*/ */
uint32_t tox_send_action(Tox *tox, int32_t friendnumber, uint8_t *action, uint32_t length) uint32_t tox_send_action(Tox *tox, int32_t friendnumber, const uint8_t *action, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return m_sendaction(m, friendnumber, action, length); return m_sendaction(m, friendnumber, action, length);
} }
uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid, uint8_t *action, uint32_t length) uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid, const uint8_t *action, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return m_sendaction_withid(m, friendnumber, theid, action, length); return m_sendaction_withid(m, friendnumber, theid, action, length);
@ -180,7 +180,7 @@ uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid,
* return 0 if success. * return 0 if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_set_name(Tox *tox, uint8_t *name, uint16_t length) int tox_set_name(Tox *tox, const uint8_t *name, uint16_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return setname(m, name, length); return setname(m, name, length);
@ -193,9 +193,9 @@ int tox_set_name(Tox *tox, uint8_t *name, uint16_t length)
* return length of the name. * return length of the name.
* return 0 on error. * return 0 on error.
*/ */
uint16_t tox_get_self_name(Tox *tox, uint8_t *name) uint16_t tox_get_self_name(const Tox *tox, uint8_t *name)
{ {
Messenger *m = tox; const Messenger *m = tox;
return getself_name(m, name); return getself_name(m, name);
} }
@ -205,24 +205,24 @@ uint16_t tox_get_self_name(Tox *tox, uint8_t *name)
* return length of name (with the NULL terminator) if success. * return length of name (with the NULL terminator) if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_get_name(Tox *tox, int32_t friendnumber, uint8_t *name) int tox_get_name(const Tox *tox, int32_t friendnumber, uint8_t *name)
{ {
Messenger *m = tox; const Messenger *m = tox;
return getname(m, friendnumber, name); return getname(m, friendnumber, name);
} }
/* returns the length of name on success. /* returns the length of name on success.
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_get_name_size(Tox *tox, int32_t friendnumber) int tox_get_name_size(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_name_size(m, friendnumber); return m_get_name_size(m, friendnumber);
} }
int tox_get_self_name_size(Tox *tox) int tox_get_self_name_size(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_self_name_size(m); return m_get_self_name_size(m);
} }
@ -231,7 +231,7 @@ int tox_get_self_name_size(Tox *tox)
* *
* return 0 on success, -1 on failure. * return 0 on success, -1 on failure.
*/ */
int tox_set_status_message(Tox *tox, uint8_t *status, uint16_t length) int tox_set_status_message(Tox *tox, const uint8_t *status, uint16_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return m_set_statusmessage(m, status, length); return m_set_statusmessage(m, status, length);
@ -246,15 +246,15 @@ int tox_set_user_status(Tox *tox, uint8_t status)
/* returns the length of status message on success. /* returns the length of status message on success.
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_get_status_message_size(Tox *tox, int32_t friendnumber) int tox_get_status_message_size(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_statusmessage_size(m, friendnumber); return m_get_statusmessage_size(m, friendnumber);
} }
int tox_get_self_status_message_size(Tox *tox) int tox_get_self_status_message_size(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_self_statusmessage_size(m); return m_get_self_statusmessage_size(m);
} }
@ -262,15 +262,15 @@ int tox_get_self_status_message_size(Tox *tox)
* Get the size you need to allocate from m_get_statusmessage_size. * Get the size you need to allocate from m_get_statusmessage_size.
* The self variant will copy our own status message. * The self variant will copy our own status message.
*/ */
int tox_get_status_message(Tox *tox, int32_t friendnumber, uint8_t *buf, uint32_t maxlen) int tox_get_status_message(const Tox *tox, int32_t friendnumber, uint8_t *buf, uint32_t maxlen)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_copy_statusmessage(m, friendnumber, buf, maxlen); return m_copy_statusmessage(m, friendnumber, buf, maxlen);
} }
int tox_get_self_status_message(Tox *tox, uint8_t *buf, uint32_t maxlen) int tox_get_self_status_message(const Tox *tox, uint8_t *buf, uint32_t maxlen)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_copy_self_statusmessage(m, buf, maxlen); return m_copy_self_statusmessage(m, buf, maxlen);
} }
@ -279,24 +279,24 @@ int tox_get_self_status_message(Tox *tox, uint8_t *buf, uint32_t maxlen)
* As above, the self variant will return our own USERSTATUS. * As above, the self variant will return our own USERSTATUS.
* If friendnumber is invalid, this shall return USERSTATUS_INVALID. * If friendnumber is invalid, this shall return USERSTATUS_INVALID.
*/ */
uint8_t tox_get_user_status(Tox *tox, int32_t friendnumber) uint8_t tox_get_user_status(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_userstatus(m, friendnumber); return m_get_userstatus(m, friendnumber);
} }
uint8_t tox_get_self_user_status(Tox *tox) uint8_t tox_get_self_user_status(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_self_userstatus(m); return m_get_self_userstatus(m);
} }
/* returns timestamp of last time friendnumber was seen online, or 0 if never seen. /* returns timestamp of last time friendnumber was seen online, or 0 if never seen.
* returns -1 on error. * returns -1 on error.
*/ */
uint64_t tox_get_last_online(Tox *tox, int32_t friendnumber) uint64_t tox_get_last_online(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_last_online(m, friendnumber); return m_get_last_online(m, friendnumber);
} }
@ -317,9 +317,9 @@ int tox_set_user_is_typing(Tox *tox, int32_t friendnumber, uint8_t is_typing)
* returns 0 if friend is not typing. * returns 0 if friend is not typing.
* returns 1 if friend is typing. * returns 1 if friend is typing.
*/ */
uint8_t tox_get_is_typing(Tox *tox, int32_t friendnumber) uint8_t tox_get_is_typing(const Tox *tox, int32_t friendnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_get_istyping(m, friendnumber); return m_get_istyping(m, friendnumber);
} }
@ -335,16 +335,16 @@ void tox_set_sends_receipts(Tox *tox, int32_t friendnumber, int yesno)
/* Return the number of friends in the instance m. /* Return the number of friends in the instance m.
* You should use this to determine how much memory to allocate * You should use this to determine how much memory to allocate
* for copy_friendlist. */ * for copy_friendlist. */
uint32_t tox_count_friendlist(Tox *tox) uint32_t tox_count_friendlist(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return count_friendlist(m); return count_friendlist(m);
} }
/* Return the number of online friends in the instance m. */ /* Return the number of online friends in the instance m. */
uint32_t tox_get_num_online_friends(Tox *tox) uint32_t tox_get_num_online_friends(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return get_num_online_friends(m); return get_num_online_friends(m);
} }
@ -353,9 +353,9 @@ uint32_t tox_get_num_online_friends(Tox *tox)
* Otherwise, returns the number of elements copied. * Otherwise, returns the number of elements copied.
* If the array was too small, the contents * If the array was too small, the contents
* of out_list will be truncated to list_size. */ * of out_list will be truncated to list_size. */
uint32_t tox_get_friendlist(Tox *tox, int32_t *out_list, uint32_t list_size) uint32_t tox_get_friendlist(const Tox *tox, int32_t *out_list, uint32_t list_size)
{ {
Messenger *m = tox; const Messenger *m = tox;
return copy_friendlist(m, out_list, list_size); return copy_friendlist(m, out_list, list_size);
} }
@ -468,9 +468,9 @@ void tox_callback_connection_status(Tox *tox, void (*function)(Messenger *tox, i
/* Functions to get/set the nospam part of the id. /* Functions to get/set the nospam part of the id.
*/ */
uint32_t tox_get_nospam(Tox *tox) uint32_t tox_get_nospam(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return get_nospam(&(m->fr)); return get_nospam(&(m->fr));
} }
@ -552,9 +552,9 @@ int tox_del_groupchat(Tox *tox, int groupnumber)
* return length of name if success * return length of name if success
* return -1 if failure * return -1 if failure
*/ */
int tox_group_peername(Tox *tox, int groupnumber, int peernumber, uint8_t *name) int tox_group_peername(const Tox *tox, int groupnumber, int peernumber, uint8_t *name)
{ {
Messenger *m = tox; const Messenger *m = tox;
return m_group_peername(m, groupnumber, peernumber, name); return m_group_peername(m, groupnumber, peernumber, name);
} }
/* invite friendnumber to groupnumber /* invite friendnumber to groupnumber
@ -571,7 +571,7 @@ int tox_invite_friend(Tox *tox, int32_t friendnumber, int groupnumber)
* returns group number on success * returns group number on success
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_join_groupchat(Tox *tox, int32_t friendnumber, uint8_t *friend_group_public_key) int tox_join_groupchat(Tox *tox, int32_t friendnumber, const uint8_t *friend_group_public_key)
{ {
Messenger *m = tox; Messenger *m = tox;
return join_groupchat(m, friendnumber, friend_group_public_key); return join_groupchat(m, friendnumber, friend_group_public_key);
@ -581,7 +581,7 @@ int tox_join_groupchat(Tox *tox, int32_t friendnumber, uint8_t *friend_group_pub
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_group_message_send(Tox *tox, int groupnumber, uint8_t *message, uint32_t length) int tox_group_message_send(Tox *tox, int groupnumber, const uint8_t *message, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return group_message_send(m, groupnumber, message, length); return group_message_send(m, groupnumber, message, length);
@ -591,7 +591,7 @@ int tox_group_message_send(Tox *tox, int groupnumber, uint8_t *message, uint32_t
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_group_action_send(Tox *tox, int groupnumber, uint8_t *action, uint32_t length) int tox_group_action_send(Tox *tox, int groupnumber, const uint8_t *action, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return group_action_send(m, groupnumber, action, length); return group_action_send(m, groupnumber, action, length);
@ -600,9 +600,9 @@ int tox_group_action_send(Tox *tox, int groupnumber, uint8_t *action, uint32_t l
/* Return the number of peers in the group chat on success. /* Return the number of peers in the group chat on success.
* return -1 on failure * return -1 on failure
*/ */
int tox_group_number_peers(Tox *tox, int groupnumber) int tox_group_number_peers(const Tox *tox, int groupnumber)
{ {
Messenger *m = tox; const Messenger *m = tox;
return group_number_peers(m, groupnumber); return group_number_peers(m, groupnumber);
} }
@ -616,19 +616,19 @@ int tox_group_number_peers(Tox *tox, int groupnumber)
* *
* return -1 on failure. * return -1 on failure.
*/ */
int tox_group_get_names(Tox *tox, int groupnumber, uint8_t names[][TOX_MAX_NAME_LENGTH], uint16_t lengths[], int tox_group_get_names(const Tox *tox, int groupnumber, uint8_t names[][TOX_MAX_NAME_LENGTH], uint16_t lengths[],
uint16_t length) uint16_t length)
{ {
Messenger *m = tox; const Messenger *m = tox;
return group_names(m, groupnumber, names, lengths, length); return group_names(m, groupnumber, names, lengths, length);
} }
/* Return the number of chats in the instance m. /* Return the number of chats in the instance m.
* You should use this to determine how much memory to allocate * You should use this to determine how much memory to allocate
* for copy_chatlist. */ * for copy_chatlist. */
uint32_t tox_count_chatlist(Tox *tox) uint32_t tox_count_chatlist(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return count_chatlist(m); return count_chatlist(m);
} }
@ -637,9 +637,9 @@ uint32_t tox_count_chatlist(Tox *tox)
* Otherwise, returns the number of elements copied. * Otherwise, returns the number of elements copied.
* If the array was too small, the contents * If the array was too small, the contents
* of out_list will be truncated to list_size. */ * of out_list will be truncated to list_size. */
uint32_t tox_get_chatlist(Tox *tox, int *out_list, uint32_t list_size) uint32_t tox_get_chatlist(const Tox *tox, int *out_list, uint32_t list_size)
{ {
Messenger *m = tox; const Messenger *m = tox;
return copy_chatlist(m, out_list, list_size); return copy_chatlist(m, out_list, list_size);
} }
@ -687,7 +687,7 @@ void tox_callback_file_data(Tox *tox, void (*function)(Messenger *tox, int32_t,
* return file number on success * return file number on success
* return -1 on failure * return -1 on failure
*/ */
int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, uint8_t *filename, uint16_t filename_length) int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, const uint8_t *filename, uint16_t filename_length)
{ {
Messenger *m = tox; Messenger *m = tox;
return new_filesender(m, friendnumber, filesize, filename, filename_length); return new_filesender(m, friendnumber, filesize, filename, filename_length);
@ -699,7 +699,7 @@ int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, uint8
* return -1 on failure * return -1 on failure
*/ */
int tox_file_send_control(Tox *tox, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t message_id, int tox_file_send_control(Tox *tox, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t message_id,
uint8_t *data, uint16_t length) const uint8_t *data, uint16_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return file_control(m, friendnumber, send_receive, filenumber, message_id, data, length); return file_control(m, friendnumber, send_receive, filenumber, message_id, data, length);
@ -709,7 +709,7 @@ int tox_file_send_control(Tox *tox, int32_t friendnumber, uint8_t send_receive,
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_file_send_data(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t *data, uint16_t length) int tox_file_send_data(Tox *tox, int32_t friendnumber, uint8_t filenumber, const uint8_t *data, uint16_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return file_data(m, friendnumber, filenumber, data, length); return file_data(m, friendnumber, filenumber, data, length);
@ -720,7 +720,7 @@ int tox_file_send_data(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8
* return size on success * return size on success
* return -1 on failure (currently will never return -1) * return -1 on failure (currently will never return -1)
*/ */
int tox_file_data_size(Tox *tox, int32_t friendnumber) int tox_file_data_size(const Tox *tox, int32_t friendnumber)
{ {
return MAX_CRYPTO_DATA_SIZE - 2; return MAX_CRYPTO_DATA_SIZE - 2;
} }
@ -732,16 +732,16 @@ int tox_file_data_size(Tox *tox, int32_t friendnumber)
* return number of bytes remaining to be sent/received on success * return number of bytes remaining to be sent/received on success
* return 0 on failure * return 0 on failure
*/ */
uint64_t tox_file_data_remaining(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t send_receive) uint64_t tox_file_data_remaining(const Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t send_receive)
{ {
Messenger *m = tox; const Messenger *m = tox;
return file_dataremaining(m, friendnumber, filenumber, send_receive); return file_dataremaining(m, friendnumber, filenumber, send_receive);
} }
/***************END OF FILE SENDING FUNCTIONS******************/ /***************END OF FILE SENDING FUNCTIONS******************/
/* TODO: expose this properly. */ /* TODO: expose this properly. */
static int tox_add_tcp_relay(Tox *tox, const char *address, uint8_t ipv6enabled, uint16_t port, uint8_t *public_key) static int tox_add_tcp_relay(Tox *tox, const char *address, uint8_t ipv6enabled, uint16_t port, const uint8_t *public_key)
{ {
Messenger *m = tox; Messenger *m = tox;
IP_Port ip_port_v64; IP_Port ip_port_v64;
@ -766,7 +766,7 @@ static int tox_add_tcp_relay(Tox *tox, const char *address, uint8_t ipv6enabled,
} }
int tox_bootstrap_from_address(Tox *tox, const char *address, int tox_bootstrap_from_address(Tox *tox, const char *address,
uint8_t ipv6enabled, uint16_t port, uint8_t *public_key) uint8_t ipv6enabled, uint16_t port, const uint8_t *public_key)
{ {
Messenger *m = tox; Messenger *m = tox;
tox_add_tcp_relay(tox, address, ipv6enabled, port, public_key); tox_add_tcp_relay(tox, address, ipv6enabled, port, public_key);
@ -776,9 +776,9 @@ int tox_bootstrap_from_address(Tox *tox, const char *address,
/* return 0 if we are not connected to the DHT. /* return 0 if we are not connected to the DHT.
* return 1 if we are. * return 1 if we are.
*/ */
int tox_isconnected(Tox *tox) int tox_isconnected(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return DHT_isconnected(m->dht); return DHT_isconnected(m->dht);
} }
@ -823,21 +823,21 @@ void tox_do(Tox *tox)
/* SAVING AND LOADING FUNCTIONS: */ /* SAVING AND LOADING FUNCTIONS: */
/* return size of the messenger data (for saving). */ /* return size of the messenger data (for saving). */
uint32_t tox_size(Tox *tox) uint32_t tox_size(const Tox *tox)
{ {
Messenger *m = tox; const Messenger *m = tox;
return messenger_size(m); return messenger_size(m);
} }
/* Save the messenger in data (must be allocated memory of size Messenger_size()). */ /* Save the messenger in data (must be allocated memory of size Messenger_size()). */
void tox_save(Tox *tox, uint8_t *data) void tox_save(const Tox *tox, uint8_t *data)
{ {
Messenger *m = tox; const Messenger *m = tox;
messenger_save(m, data); messenger_save(m, data);
} }
/* Load the messenger from data of size length. */ /* Load the messenger from data of size length. */
int tox_load(Tox *tox, uint8_t *data, uint32_t length) int tox_load(Tox *tox, const uint8_t *data, uint32_t length)
{ {
Messenger *m = tox; Messenger *m = tox;
return messenger_load(m, data, length); return messenger_load(m, data, length);

90
toxcore/tox.h
View File

@ -82,7 +82,7 @@ typedef struct Tox Tox;
/* return TOX_FRIEND_ADDRESS_SIZE byte address to give to others. /* return TOX_FRIEND_ADDRESS_SIZE byte address to give to others.
* format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)] * format: [client_id (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)]
*/ */
void tox_get_address(Tox *tox, uint8_t *address); void tox_get_address(const Tox *tox, uint8_t *address);
/* Add a friend. /* Add a friend.
* Set the data that will be sent along with friend request. * Set the data that will be sent along with friend request.
@ -100,7 +100,7 @@ void tox_get_address(Tox *tox, uint8_t *address);
* (the nospam for that friend was set to the new one). * (the nospam for that friend was set to the new one).
* return TOX_FAERR_NOMEM if increasing the friend list size fails. * return TOX_FAERR_NOMEM if increasing the friend list size fails.
*/ */
int32_t tox_add_friend(Tox *tox, uint8_t *address, uint8_t *data, uint16_t length); int32_t tox_add_friend(Tox *tox, const uint8_t *address, const uint8_t *data, uint16_t length);
/* Add a friend without sending a friendrequest. /* Add a friend without sending a friendrequest.
@ -111,14 +111,14 @@ int32_t tox_add_friend_norequest(Tox *tox, const uint8_t *client_id);
/* return the friend number associated to that client id. /* return the friend number associated to that client id.
return -1 if no such friend */ return -1 if no such friend */
int32_t tox_get_friend_number(Tox *tox, uint8_t *client_id); int32_t tox_get_friend_number(const Tox *tox, const uint8_t *client_id);
/* Copies the public key associated to that friend id into client_id buffer. /* Copies the public key associated to that friend id into client_id buffer.
* Make sure that client_id is of size CLIENT_ID_SIZE. * Make sure that client_id is of size CLIENT_ID_SIZE.
* return 0 if success. * return 0 if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_get_client_id(Tox *tox, int32_t friendnumber, uint8_t *client_id); int tox_get_client_id(const Tox *tox, int32_t friendnumber, uint8_t *client_id);
/* Remove a friend. /* Remove a friend.
* *
@ -133,14 +133,14 @@ int tox_del_friend(Tox *tox, int32_t friendnumber);
* return 0 if friend is not connected to us (Offline). * return 0 if friend is not connected to us (Offline).
* return -1 on failure. * return -1 on failure.
*/ */
int tox_get_friend_connection_status(Tox *tox, int32_t friendnumber); int tox_get_friend_connection_status(const Tox *tox, int32_t friendnumber);
/* Checks if there exists a friend with given friendnumber. /* Checks if there exists a friend with given friendnumber.
* *
* return 1 if friend exists. * return 1 if friend exists.
* return 0 if friend doesn't exist. * return 0 if friend doesn't exist.
*/ */
int tox_friend_exists(Tox *tox, int32_t friendnumber); int tox_friend_exists(const Tox *tox, int32_t friendnumber);
/* Send a text chat message to an online friend. /* Send a text chat message to an online friend.
* *
@ -157,7 +157,7 @@ int tox_friend_exists(Tox *tox, int32_t friendnumber);
* however we can generate an id for you by calling plain m_sendmessage. * however we can generate an id for you by calling plain m_sendmessage.
*/ */
uint32_t tox_send_message(Tox *tox, int32_t friendnumber, const uint8_t *message, uint32_t length); uint32_t tox_send_message(Tox *tox, int32_t friendnumber, const uint8_t *message, uint32_t length);
uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid, uint8_t *message, uint32_t length); uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid, const uint8_t *message, uint32_t length);
/* Send an action to an online friend. /* Send an action to an online friend.
* *
@ -173,8 +173,8 @@ uint32_t tox_send_message_withid(Tox *tox, int32_t friendnumber, uint32_t theid,
* m_sendaction_withid will send an action message with the id of your choosing, * m_sendaction_withid will send an action message with the id of your choosing,
* however we can generate an id for you by calling plain m_sendaction. * however we can generate an id for you by calling plain m_sendaction.
*/ */
uint32_t tox_send_action(Tox *tox, int32_t friendnumber, uint8_t *action, uint32_t length); uint32_t tox_send_action(Tox *tox, int32_t friendnumber, const uint8_t *action, uint32_t length);
uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid, uint8_t *action, uint32_t length); uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid, const uint8_t *action, uint32_t length);
/* Set our nickname. /* Set our nickname.
* name must be a string of maximum MAX_NAME_LENGTH length. * name must be a string of maximum MAX_NAME_LENGTH length.
@ -184,7 +184,7 @@ uint32_t tox_send_action_withid(Tox *tox, int32_t friendnumber, uint32_t theid,
* return 0 if success. * return 0 if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_set_name(Tox *tox, uint8_t *name, uint16_t length); int tox_set_name(Tox *tox, const uint8_t *name, uint16_t length);
/* /*
* Get your nickname. * Get your nickname.
@ -194,7 +194,7 @@ int tox_set_name(Tox *tox, uint8_t *name, uint16_t length);
* return length of name. * return length of name.
* return 0 on error. * return 0 on error.
*/ */
uint16_t tox_get_self_name(Tox *tox, uint8_t *name); uint16_t tox_get_self_name(const Tox *tox, uint8_t *name);
/* Get name of friendnumber and put it in name. /* Get name of friendnumber and put it in name.
* name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes. * name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes.
@ -202,13 +202,13 @@ uint16_t tox_get_self_name(Tox *tox, uint8_t *name);
* return length of name if success. * return length of name if success.
* return -1 if failure. * return -1 if failure.
*/ */
int tox_get_name(Tox *tox, int32_t friendnumber, uint8_t *name); int tox_get_name(const Tox *tox, int32_t friendnumber, uint8_t *name);
/* returns the length of name on success. /* returns the length of name on success.
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_get_name_size(Tox *tox, int32_t friendnumber); int tox_get_name_size(const Tox *tox, int32_t friendnumber);
int tox_get_self_name_size(Tox *tox); int tox_get_self_name_size(const Tox *tox);
/* Set our user status. /* Set our user status.
* *
@ -218,14 +218,14 @@ int tox_get_self_name_size(Tox *tox);
* returns 0 on success. * returns 0 on success.
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_set_status_message(Tox *tox, uint8_t *status, uint16_t length); int tox_set_status_message(Tox *tox, const uint8_t *status, uint16_t length);
int tox_set_user_status(Tox *tox, uint8_t userstatus); int tox_set_user_status(Tox *tox, uint8_t userstatus);
/* returns the length of status message on success. /* returns the length of status message on success.
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_get_status_message_size(Tox *tox, int32_t friendnumber); int tox_get_status_message_size(const Tox *tox, int32_t friendnumber);
int tox_get_self_status_message_size(Tox *tox); int tox_get_self_status_message_size(const Tox *tox);
/* Copy friendnumber's status message into buf, truncating if size is over maxlen. /* Copy friendnumber's status message into buf, truncating if size is over maxlen.
* Get the size you need to allocate from m_get_statusmessage_size. * Get the size you need to allocate from m_get_statusmessage_size.
@ -234,22 +234,22 @@ int tox_get_self_status_message_size(Tox *tox);
* returns the length of the copied data on success * returns the length of the copied data on success
* retruns -1 on failure. * retruns -1 on failure.
*/ */
int tox_get_status_message(Tox *tox, int32_t friendnumber, uint8_t *buf, uint32_t maxlen); int tox_get_status_message(const Tox *tox, int32_t friendnumber, uint8_t *buf, uint32_t maxlen);
int tox_get_self_status_message(Tox *tox, uint8_t *buf, uint32_t maxlen); int tox_get_self_status_message(const Tox *tox, uint8_t *buf, uint32_t maxlen);
/* return one of TOX_USERSTATUS values. /* return one of TOX_USERSTATUS values.
* Values unknown to your application should be represented as TOX_USERSTATUS_NONE. * Values unknown to your application should be represented as TOX_USERSTATUS_NONE.
* As above, the self variant will return our own TOX_USERSTATUS. * As above, the self variant will return our own TOX_USERSTATUS.
* If friendnumber is invalid, this shall return TOX_USERSTATUS_INVALID. * If friendnumber is invalid, this shall return TOX_USERSTATUS_INVALID.
*/ */
uint8_t tox_get_user_status(Tox *tox, int32_t friendnumber); uint8_t tox_get_user_status(const Tox *tox, int32_t friendnumber);
uint8_t tox_get_self_user_status(Tox *tox); uint8_t tox_get_self_user_status(const Tox *tox);
/* returns timestamp of last time friendnumber was seen online, or 0 if never seen. /* returns timestamp of last time friendnumber was seen online, or 0 if never seen.
* returns -1 on error. * returns -1 on error.
*/ */
uint64_t tox_get_last_online(Tox *tox, int32_t friendnumber); uint64_t tox_get_last_online(const Tox *tox, int32_t friendnumber);
/* Set our typing status for a friend. /* Set our typing status for a friend.
* You are responsible for turning it on or off. * You are responsible for turning it on or off.
@ -264,7 +264,7 @@ int tox_set_user_is_typing(Tox *tox, int32_t friendnumber, uint8_t is_typing);
* returns 0 if friend is not typing. * returns 0 if friend is not typing.
* returns 1 if friend is typing. * returns 1 if friend is typing.
*/ */
uint8_t tox_get_is_typing(Tox *tox, int32_t friendnumber); uint8_t tox_get_is_typing(const Tox *tox, int32_t friendnumber);
/* Sets whether we send read receipts for friendnumber. /* Sets whether we send read receipts for friendnumber.
* This function is not lazy, and it will fail if yesno is not (0 or 1). * This function is not lazy, and it will fail if yesno is not (0 or 1).
@ -274,17 +274,17 @@ void tox_set_sends_receipts(Tox *tox, int32_t friendnumber, int yesno);
/* Return the number of friends in the instance m. /* Return the number of friends in the instance m.
* You should use this to determine how much memory to allocate * You should use this to determine how much memory to allocate
* for copy_friendlist. */ * for copy_friendlist. */
uint32_t tox_count_friendlist(Tox *tox); uint32_t tox_count_friendlist(const Tox *tox);
/* Return the number of online friends in the instance m. */ /* Return the number of online friends in the instance m. */
uint32_t tox_get_num_online_friends(Tox *tox); uint32_t tox_get_num_online_friends(const Tox *tox);
/* Copy a list of valid friend IDs into the array out_list. /* Copy a list of valid friend IDs into the array out_list.
* If out_list is NULL, returns 0. * If out_list is NULL, returns 0.
* Otherwise, returns the number of elements copied. * Otherwise, returns the number of elements copied.
* If the array was too small, the contents * If the array was too small, the contents
* of out_list will be truncated to list_size. */ * of out_list will be truncated to list_size. */
uint32_t tox_get_friendlist(Tox *tox, int32_t *out_list, uint32_t list_size); uint32_t tox_get_friendlist(const Tox *tox, int32_t *out_list, uint32_t list_size);
/* Set the function that will be executed when a friend request is received. /* Set the function that will be executed when a friend request is received.
* Function format is function(Tox *tox, uint8_t * public_key, uint8_t * data, uint16_t length, void *userdata) * Function format is function(Tox *tox, uint8_t * public_key, uint8_t * data, uint16_t length, void *userdata)
@ -357,7 +357,7 @@ void tox_callback_connection_status(Tox *tox, void (*function)(Tox *tox, int32_t
/* Functions to get/set the nospam part of the id. /* Functions to get/set the nospam part of the id.
*/ */
uint32_t tox_get_nospam(Tox *tox); uint32_t tox_get_nospam(const Tox *tox);
void tox_set_nospam(Tox *tox, uint32_t nospam); void tox_set_nospam(Tox *tox, uint32_t nospam);
@ -417,7 +417,7 @@ int tox_del_groupchat(Tox *tox, int groupnumber);
* return length of name if success * return length of name if success
* return -1 if failure * return -1 if failure
*/ */
int tox_group_peername(Tox *tox, int groupnumber, int peernumber, uint8_t *name); int tox_group_peername(const Tox *tox, int groupnumber, int peernumber, uint8_t *name);
/* invite friendnumber to groupnumber /* invite friendnumber to groupnumber
* return 0 on success * return 0 on success
@ -430,24 +430,24 @@ int tox_invite_friend(Tox *tox, int32_t friendnumber, int groupnumber);
* returns group number on success * returns group number on success
* returns -1 on failure. * returns -1 on failure.
*/ */
int tox_join_groupchat(Tox *tox, int32_t friendnumber, uint8_t *friend_group_public_key); int tox_join_groupchat(Tox *tox, int32_t friendnumber, const uint8_t *friend_group_public_key);
/* send a group message /* send a group message
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_group_message_send(Tox *tox, int groupnumber, uint8_t *message, uint32_t length); int tox_group_message_send(Tox *tox, int groupnumber, const uint8_t *message, uint32_t length);
/* send a group action /* send a group action
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_group_action_send(Tox *tox, int groupnumber, uint8_t *action, uint32_t length); int tox_group_action_send(Tox *tox, int groupnumber, const uint8_t *action, uint32_t length);
/* Return the number of peers in the group chat on success. /* Return the number of peers in the group chat on success.
* return -1 on failure * return -1 on failure
*/ */
int tox_group_number_peers(Tox *tox, int groupnumber); int tox_group_number_peers(const Tox *tox, int groupnumber);
/* List all the peers in the group chat. /* List all the peers in the group chat.
* *
@ -459,20 +459,20 @@ int tox_group_number_peers(Tox *tox, int groupnumber);
* *
* return -1 on failure. * return -1 on failure.
*/ */
int tox_group_get_names(Tox *tox, int groupnumber, uint8_t names[][TOX_MAX_NAME_LENGTH], uint16_t lengths[], int tox_group_get_names(const Tox *tox, int groupnumber, uint8_t names[][TOX_MAX_NAME_LENGTH], uint16_t lengths[],
uint16_t length); uint16_t length);
/* Return the number of chats in the instance m. /* Return the number of chats in the instance m.
* You should use this to determine how much memory to allocate * You should use this to determine how much memory to allocate
* for copy_chatlist. */ * for copy_chatlist. */
uint32_t tox_count_chatlist(Tox *tox); uint32_t tox_count_chatlist(const Tox *tox);
/* Copy a list of valid chat IDs into the array out_list. /* Copy a list of valid chat IDs into the array out_list.
* If out_list is NULL, returns 0. * If out_list is NULL, returns 0.
* Otherwise, returns the number of elements copied. * Otherwise, returns the number of elements copied.
* If the array was too small, the contents * If the array was too small, the contents
* of out_list will be truncated to list_size. */ * of out_list will be truncated to list_size. */
uint32_t tox_get_chatlist(Tox *tox, int *out_list, uint32_t list_size); uint32_t tox_get_chatlist(const Tox *tox, int *out_list, uint32_t list_size);
/****************FILE SENDING FUNCTIONS*****************/ /****************FILE SENDING FUNCTIONS*****************/
@ -551,7 +551,7 @@ void tox_callback_file_data(Tox *tox, void (*function)(Tox *m, int32_t, uint8_t,
* return file number on success * return file number on success
* return -1 on failure * return -1 on failure
*/ */
int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, uint8_t *filename, uint16_t filename_length); int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, const uint8_t *filename, uint16_t filename_length);
/* Send a file control request. /* Send a file control request.
* *
@ -562,21 +562,21 @@ int tox_new_file_sender(Tox *tox, int32_t friendnumber, uint64_t filesize, uint8
* return -1 on failure * return -1 on failure
*/ */
int tox_file_send_control(Tox *tox, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t message_id, int tox_file_send_control(Tox *tox, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t message_id,
uint8_t *data, uint16_t length); const uint8_t *data, uint16_t length);
/* Send file data. /* Send file data.
* *
* return 0 on success * return 0 on success
* return -1 on failure * return -1 on failure
*/ */
int tox_file_send_data(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t *data, uint16_t length); int tox_file_send_data(Tox *tox, int32_t friendnumber, uint8_t filenumber, const uint8_t *data, uint16_t length);
/* Returns the recommended/maximum size of the filedata you send with tox_file_send_data() /* Returns the recommended/maximum size of the filedata you send with tox_file_send_data()
* *
* return size on success * return size on success
* return -1 on failure (currently will never return -1) * return -1 on failure (currently will never return -1)
*/ */
int tox_file_data_size(Tox *tox, int32_t friendnumber); int tox_file_data_size(const Tox *tox, int32_t friendnumber);
/* Give the number of bytes left to be sent/received. /* Give the number of bytes left to be sent/received.
* *
@ -585,7 +585,7 @@ int tox_file_data_size(Tox *tox, int32_t friendnumber);
* return number of bytes remaining to be sent/received on success * return number of bytes remaining to be sent/received on success
* return 0 on failure * return 0 on failure
*/ */
uint64_t tox_file_data_remaining(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t send_receive); uint64_t tox_file_data_remaining(const Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t send_receive);
/***************END OF FILE SENDING FUNCTIONS******************/ /***************END OF FILE SENDING FUNCTIONS******************/
@ -606,12 +606,12 @@ uint64_t tox_file_data_remaining(Tox *tox, int32_t friendnumber, uint8_t filenum
* returns 0 otherwise * returns 0 otherwise
*/ */
int tox_bootstrap_from_address(Tox *tox, const char *address, uint8_t ipv6enabled, int tox_bootstrap_from_address(Tox *tox, const char *address, uint8_t ipv6enabled,
uint16_t port, uint8_t *public_key); uint16_t port, const uint8_t *public_key);
/* return 0 if we are not connected to the DHT. /* return 0 if we are not connected to the DHT.
* return 1 if we are. * return 1 if we are.
*/ */
int tox_isconnected(Tox *tox); int tox_isconnected(const Tox *tox);
/* /*
* Run this function at startup. * Run this function at startup.
@ -645,17 +645,17 @@ void tox_do(Tox *tox);
/* SAVING AND LOADING FUNCTIONS: */ /* SAVING AND LOADING FUNCTIONS: */
/* return size of messenger data (for saving). */ /* return size of messenger data (for saving). */
uint32_t tox_size(Tox *tox); uint32_t tox_size(const Tox *tox);
/* Save the messenger in data (must be allocated memory of size Messenger_size()). */ /* Save the messenger in data (must be allocated memory of size Messenger_size()). */
void tox_save(Tox *tox, uint8_t *data); void tox_save(const Tox *tox, uint8_t *data);
/* Load the messenger from data of size length. /* Load the messenger from data of size length.
* *
* returns 0 on success * returns 0 on success
* returns -1 on failure * returns -1 on failure
*/ */
int tox_load(Tox *tox, uint8_t *data, uint32_t length); int tox_load(Tox *tox, const uint8_t *data, uint32_t length);
#ifdef __cplusplus #ifdef __cplusplus
} }