Add type annotations in the C interface

Author: Doy-lee

include/session/config/pro.h

@@ -48,7 +48,7 @@ typedef struct pro_config {
 ///
 /// Outputs:
 /// - `bytes32` -- The 32 byte hash calculated from the proof
-LIBSESSION_EXPORT bytes32 pro_proof_hash(pro_proof const* proof);
+LIBSESSION_EXPORT bytes32 pro_proof_hash(pro_proof const* proof) NON_NULL_ARG(1);
 
 /// API: pro/pro_proof_verify_signature
 ///
@@ -64,7 +64,8 @@ LIBSESSION_EXPORT bytes32 pro_proof_hash(pro_proof const* proof);
 /// Outputs:
 /// - `bool` -- True if verified, false otherwise
 LIBSESSION_EXPORT bool pro_proof_verify_signature(
-        pro_proof const* proof, uint8_t const* verify_pubkey, size_t verify_pubkey_len);
+        pro_proof const* proof, uint8_t const* verify_pubkey, size_t verify_pubkey_len)
+        NON_NULL_ARG(1, 2);
 
 /// API: pro/pro_proof_verify_message
 ///
@@ -87,7 +88,7 @@ LIBSESSION_EXPORT bool pro_proof_verify_message(
         uint8_t const* sig,
         size_t sig_len,
         uint8_t const* msg,
-        size_t msg_len);
+        size_t msg_len) NON_NULL_ARG(1, 2, 4);
 
 /// API: pro/pro_proof_is_active
 ///
@@ -100,7 +101,8 @@ LIBSESSION_EXPORT bool pro_proof_verify_message(
 ///
 /// Outputs:
 /// - `bool` -- True if expired, false otherwise
-LIBSESSION_EXPORT bool pro_proof_is_active(pro_proof const* proof, uint64_t unix_ts_s);
+LIBSESSION_EXPORT bool pro_proof_is_active(pro_proof const* proof, uint64_t unix_ts_s)
+        NON_NULL_ARG(1);
 
 /// API: pro/pro_proof_status
 ///
@@ -133,7 +135,8 @@ LIBSESSION_EXPORT PRO_STATUS pro_proof_status(
         const uint8_t* verify_pubkey,
         size_t verify_pubkey_len,
         uint64_t unix_ts_s,
-        const pro_signed_message* signed_msg);
+        OPTIONAL const pro_signed_message* signed_msg)
+        NON_NULL_ARG(1, 2);
 
 /// API: pro/pro_proof_from_pro_backend_response
 ///
@@ -143,7 +146,8 @@ LIBSESSION_EXPORT PRO_STATUS pro_proof_status(
 /// Inputs:
 /// - `response` -- Response from the Pro Backend containing the proof information
 LIBSESSION_EXPORT pro_proof pro_proof_from_pro_backend_response(
-        struct session_pro_backend_add_pro_payment_or_get_pro_proof_response* response);
+        struct session_pro_backend_add_pro_payment_or_get_pro_proof_response* response)
+        NON_NULL_ARG(1);
 
 /// API: pro/pro_verify
 ///
@@ -160,7 +164,8 @@ LIBSESSION_EXPORT pro_proof pro_proof_from_pro_backend_response(
 /// Outputs:
 /// - `bytes32` -- The 32 byte hash calculated from the proof
 LIBSESSION_EXPORT bool pro_config_verify_signature(
-        pro_config const* pro, uint8_t const* verify_pubkey, size_t verify_pubkey_len);
+        pro_config const* pro, uint8_t const* verify_pubkey, size_t verify_pubkey_len)
+        NON_NULL_ARG(1, 2);
 
 #ifdef __cplusplus
 }  // extern "C"

include/session/pro_backend.h

@@ -177,7 +177,7 @@ session_pro_backend_add_pro_payment_request_build_sigs(
         const uint8_t* rotating_privkey,
         size_t rotating_privkey_len,
         const uint8_t* payment_token_hash,
-        size_t payment_token_hash_len);
+        size_t payment_token_hash_len) NON_NULL_ARG(2, 4, 6);
 
 /// API: session_pro_backend/get_pro_proof_request_build_sigs
 ///
@@ -206,7 +206,7 @@ session_pro_backend_master_rotating_signatures session_pro_backend_get_pro_proof
         size_t master_privkey_len,
         const uint8_t* rotating_privkey,
         size_t rotating_privkey_len,
-        uint64_t unix_ts_s);
+        uint64_t unix_ts_s) NON_NULL_ARG(2, 4);
 
 /// API: session_pro_backend/get_pro_payments_request_build_sig
 ///
@@ -232,7 +232,7 @@ session_pro_backend_signature session_pro_backend_get_pro_payments_request_build
         const uint8_t* master_privkey,
         size_t master_privkey_len,
         uint64_t unix_ts_s,
-        uint32_t page);
+        uint32_t page) NON_NULL_ARG(2);
 
 /// API: session_pro_backend/add_pro_payment_request_to_json
 ///

include/session/session_protocol.h

@@ -141,7 +141,7 @@ typedef struct session_protocol_pro_features_for_msg {
 /// - `codepoint_count` -- Counts the number of unicode codepoints that were in the message.
 LIBSESSION_EXPORT
 session_protocol_pro_features_for_msg session_protocol_pro_features_for_utf8(
-        char const* utf8, size_t utf8_size, PRO_EXTRA_FEATURES extra);
+        char const* utf8, size_t utf8_size, PRO_EXTRA_FEATURES extra) NON_NULL_ARG(1);
 
 /// API: session_protocol/session_protocol_get_pro_features_for_utf16
 ///
@@ -164,7 +164,7 @@ session_protocol_pro_features_for_msg session_protocol_pro_features_for_utf8(
 /// - `codepoint_count` -- Counts the number of unicode codepoints that were in the message.
 LIBSESSION_EXPORT
 session_protocol_pro_features_for_msg session_protocol_pro_features_for_utf16(
-        uint16_t const* utf16, size_t utf16_size, PRO_EXTRA_FEATURES extra);
+        uint16_t const* utf16, size_t utf16_size, PRO_EXTRA_FEATURES extra) NON_NULL_ARG(1);
 
 /// API: session_protocol_encrypt_for_1o1
 ///
@@ -218,9 +218,9 @@ session_protocol_encrypted_for_destination session_protocol_encrypt_for_1o1(
         size_t ed25519_privkey_len,
         uint64_t sent_timestamp_ms,
         const bytes33* recipient_pubkey,
-        const bytes64* pro_sig,
-        char* error,
-        size_t error_len);
+        OPTIONAL const bytes64* pro_sig,
+        OPTIONAL char* error,
+        size_t error_len) NON_NULL_ARG(1, 3, 6);
 
 /// API: session_protocol_encrypt_for_community_inbox
 ///
@@ -279,9 +279,9 @@ session_protocol_encrypted_for_destination session_protocol_encrypt_for_communit
         uint64_t sent_timestamp_ms,
         const bytes33* recipient_pubkey,
         const bytes32* community_pubkey,
-        const bytes64* pro_sig,
-        char* error,
-        size_t error_len);
+        OPTIONAL const bytes64* pro_sig,
+        OPTIONAL char* error,
+        size_t error_len) NON_NULL_ARG(1, 3, 6, 7);
 
 /// API: session_protocol_encrypt_for_group
 ///
@@ -305,7 +305,7 @@ session_protocol_encrypted_for_destination session_protocol_encrypt_for_communit
 /// - `sent_timestamp_ms` -- The timestamp to assign to the message envelope, in milliseconds.
 /// - `group_ed25519_pubkey` -- The group's public key (33 bytes) for encryption with a 0x03 prefix.
 /// - `group_ed25519_privkey` -- The group's private key (32 bytes) for groups v2 messages,
-/// typically
+///   typically
 ///   the latest encryption key for the group (e.g., Keys::group_enc_key).
 /// - `pro_sig` -- Optional signature over the unencrypted plaintext with the user's Session Pro
 ///   rotating public key, if using Session Pro features. If provided, the corresponding proof must
@@ -342,8 +342,8 @@ session_protocol_encrypted_for_destination session_protocol_encrypt_for_group(
         const bytes33* group_ed25519_pubkey,
         const bytes32* group_ed25519_privkey,
         const bytes64* pro_sig,
-        char* error,
-        size_t error_len);
+        OPTIONAL char* error,
+        size_t error_len) NON_NULL_ARG(1, 3, 6, 7, 8);
 
 /// API: session_protocol/session_protocol_encrypt_for_destination
 ///
@@ -392,8 +392,8 @@ session_protocol_encrypted_for_destination session_protocol_encrypt_for_destinat
         const void* ed25519_privkey,
         size_t ed25519_privkey_len,
         const session_protocol_destination* dest,
-        char* error,
-        size_t error_len);
+        OPTIONAL char* error,
+        size_t error_len) NON_NULL_ARG(1, 3, 5);
 
 /// API: session_protocol/session_protocol_encrypt_for_destination_free
 ///
@@ -486,8 +486,8 @@ session_protocol_decrypted_envelope session_protocol_decrypt_envelope(
         uint64_t unix_ts,
         const void* pro_backend_pubkey,
         size_t pro_backend_pubkey_len,
-        char* error,
-        size_t error_len);
+        OPTIONAL char* error,
+        size_t error_len) NON_NULL_ARG(1, 2, 5);
 
 /// API: session_protocol/session_protocol_decrypt_envelope_free
 ///

include/session/types.h

@@ -7,6 +7,13 @@
 extern "C" {
 #endif
 
+#define OPTIONAL
+#if defined(_MSC_VER)
+  #define NON_NULL_ARG(...)
+#else
+  #define NON_NULL_ARG(...) __attribute__((nonnull(__VA_ARGS__)))
+#endif
+
 /// C friendly buffer structure that is a pointer and length to a span of bytes.
 struct span_u8 {
     uint8_t* data;