ApiDSL'ing old group chats (now: conference).

1 files changed, 251 insertions, 15 deletions

diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h
index d14e48ba..cd802a94 100644
--- a/other/apidsl/tox.in.h
+++ b/other/apidsl/tox.in.h
@@ -1470,7 +1470,8 @@ namespace friend {
      *   containing the message text.
      * @param length Length of the message to be sent.
      */
-    uint32_t message(uint32_t friend_number, MESSAGE_TYPE type, const uint8_t[length <= MAX_MESSAGE_LENGTH] message) {
+    uint32_t message(uint32_t friend_number, MESSAGE_TYPE type,
+                     const uint8_t[length <= MAX_MESSAGE_LENGTH] message) {
       NULL,
       /**
        * The friend number did not designate a valid friend.
@@ -1537,8 +1538,8 @@ namespace friend {
      * @param length The size of the message byte array.
      */
     typedef void(const uint8_t[PUBLIC_KEY_SIZE] public_key
-        //, uint32_t time_delta
-        , const uint8_t[length <= MAX_MESSAGE_LENGTH] message);
+                 //, uint32_t time_delta
+                 , const uint8_t[length <= MAX_MESSAGE_LENGTH] message);
   }
 
 
@@ -1555,8 +1556,9 @@ namespace friend {
      * @see ${event request} for more information on time_delta.
      */
     typedef void(uint32_t friend_number
-        //, uint32_t time_delta
-        , MESSAGE_TYPE type, const uint8_t[length <= MAX_MESSAGE_LENGTH] message);
+                 //, uint32_t time_delta
+                 , MESSAGE_TYPE type,
+                 const uint8_t[length <= MAX_MESSAGE_LENGTH] message);
   }
 
 }
@@ -1766,8 +1768,10 @@ namespace file {
    *
    * @return true on success.
    */
-  const bool get_file_id(uint32_t friend_number, uint32_t file_number, uint8_t[FILE_ID_LENGTH] file_id)
-      with error for get;
+  uint8_t[FILE_ID_LENGTH] file_id {
+    get(uint32_t friend_number, uint32_t file_number)
+        with error for get;
+  }
 
 }
 
@@ -1830,7 +1834,7 @@ namespace file {
    *   unknown or streaming.
    * @param file_id A file identifier of length $FILE_ID_LENGTH that can be used to
    *   uniquely identify file transfers across core restarts. If NULL, a random one will
-   *   be generated by core. It can then be obtained by using $get_file_id().
+   *   be generated by core. It can then be obtained by using ${file_id.get}().
    * @param filename Name of the file. Does not need to be the actual name. This
    *   name will be sent along with the file send request.
    * @param filename_length Size in bytes of the filename.
@@ -2019,12 +2023,245 @@ namespace file {
  *
  ******************************************************************************/
 
+error for conference {
+  /**
+   * Some error occurred.
+   */
+  FAILURE,
+}
+
+namespace conference {
 
-/******************************************************************************
- *
- * :: Group chat message sending and receiving
- *
- ******************************************************************************/
+  /**
+   * Conference types for the ${event invite} event.
+   */
+  enum class TYPE {
+    /**
+     * Text-only conferences that must be accepted with the $join function.
+     */
+    TEXT,
+    /**
+     * Video conference. The function to accept these is in toxav.
+     */
+    AV,
+  }
+
+
+  /**
+   * This event is triggered when the client is invited to join a conference.
+   */
+  event invite {
+    /**
+     * The invitation will remain valid until the inviting friend goes offline
+     * or exits the conference.
+     *
+     * @param friend_number The friend who invited us.
+     * @param type The conference type (text only or audio/video).
+     * @param cookie A piece of data of variable length required to join the
+     *   conference.
+     * @param length The length of the cookie.
+     */
+    typedef void(uint32_t friend_number, TYPE type, const uint8_t[length] cookie);
+  }
+
+
+  /**
+   * Set the callback for group messages.
+   */
+  event message {
+    /**
+     * TODO
+     */
+    typedef void(uint32_t group_number, uint32_t peer_number, MESSAGE_TYPE type,
+                 const uint8_t[length] message);
+  }
+
+
+  /**
+   * Set callback function for title changes.
+   *
+   * if peer_number == UINT32_MAX, then author is unknown (e.g. initial joining the group)
+   */
+  event title {
+    /**
+     * TODO
+     */
+    typedef void(uint32_t group_number, uint32_t peer_number, const uint8_t[length] title);
+  }
+
+
+  // rename CHANGE to something different that is a good prefix for the three
+  // things below.
+  enum class CHANGE {
+    PEER_ADD, // JOINED?
+    PEER_DEL, // PARTED?
+    PEER_NAME, // NAME_CHANGE?
+  }
+
+  /**
+   * Set callback function for peer name list changes.
+   *
+   * It gets called every time the name list changes(new peer/name, deleted peer)
+   */
+  event namelist_change {
+    /**
+     * TODO
+     */
+    typedef void(uint32_t group_number, uint32_t peer_number, CHANGE change);
+  }
+
+
+  /**
+   * Creates a new groupchat.
+   *
+   * @return the group number.
+   */
+  uint32_t new()
+      with error for conference;
+
+  /**
+   * Delete a groupchat.
+   *
+   * @return true on success.
+   */
+  bool delete(uint32_t group_number)
+      with error for conference;
+
+
+  namespace peer {
+
+    /**
+     * Return the number of peers in the group chat.
+     */
+    const uint32_t count(uint32_t group_number)
+        with error for conference;
+
+    uint8_t[size] name {
+      size(uint32_t group_number, uint32_t peer_number)
+          with error for conference;
+
+      /**
+       * Copy the name of peer_number who is in group_number to name.
+       * name must be at least $MAX_NAME_LENGTH long.
+       *
+       * return length of name if success
+       * return -1 if failure
+       */
+      get(uint32_t group_number, uint32_t peer_number)
+          with error for conference;
+    }
+
+    /**
+     * Copy the public key of peer_number who is in group_number to public_key.
+     * public_key must be $PUBLIC_KEY_SIZE long.
+     *
+     * returns 0 on success
+     * returns -1 on failure
+     */
+    uint8_t[PUBLIC_KEY_SIZE] public_key {
+      get(uint32_t group_number, uint32_t peer_number)
+          with error for conference;
+    }
+
+    /**
+     * Check if the current peer_number corresponds to ours.
+     *
+     * return 1 if the peer_number corresponds to ours.
+     * return 0 on failure.
+     */
+    const bool number_is_ours(uint32_t group_number, uint32_t peer_number);
+
+  }
+
+
+  /**
+   * invite friend_number to group_number
+   * return 0 on success
+   * return -1 on failure
+   */
+  bool invite(uint32_t friend_number, uint32_t group_number)
+      with error for conference;
+
+
+  /**
+   * Join a group (you need to have been invited first.) using cookie of length obtained
+   * in the group invite callback.
+   *
+   * returns group number on success
+   * returns -1 on failure.
+   */
+  uint32_t join(uint32_t friend_number, const uint8_t[length] cookie)
+      with error for conference;
+
+
+  namespace send {
+
+    /**
+     * send a group message
+     * return 0 on success
+     * return -1 on failure
+     */
+    bool message(uint32_t group_number, MESSAGE_TYPE type, const uint8_t[length] message)
+        with error for conference;
+
+  }
+
+
+  uint8_t[length <= MAX_NAME_LENGTH] title {
+    size(uint32_t group_number)
+        with error for conference;
+
+    /**
+     * Get group title from group_number and put it in title.
+     * title needs to be a valid memory location with a max_length size of at least MAX_NAME_LENGTH (128) bytes.
+     *
+     *  return length of copied title if success.
+     *  return -1 if failure.
+     */
+    get(uint32_t group_number)
+        with error for conference;
+
+    /**
+     * set the group's title, limited to MAX_NAME_LENGTH
+     * return 0 on success
+     * return -1 on failure
+     */
+    set(uint32_t group_number)
+        with error for conference;
+  }
+
+
+  uint32_t[size] chatlist {
+    /**
+     * Return the number of chats in the instance m.
+     * You should use this to determine how much memory to allocate
+     * for copy_chatlist.
+     */
+    size();
+
+    /**
+     * Copy a list of valid chat IDs into the array out_list.
+     * If out_list is NULL, returns 0.
+     * Otherwise, returns the number of elements copied.
+     * If the array was too small, the contents
+     * of out_list will be truncated to list_size.
+     */
+    get();
+  }
+
+
+  /**
+   * return the type of groupchat ($TYPE) that group_number is.
+   *
+   * return -1 on failure.
+   * return type on success.
+   */
+  TYPE type {
+    get(uint32_t group_number)
+        with error for conference;
+  }
+
+}
 
 
 /*******************************************************************************
@@ -2188,11 +2425,10 @@ inline namespace self {
 
 }
 
+
 } // class tox
 
 %{
-#include "tox_group.h"
-
 #ifdef __cplusplus
 }
 #endif