gamejolt.h

Go to the documentation of this file.

/************************************************************************/
#ifndef _GAMEJOLT_H_
#define _GAMEJOLT_H_
 
#include <stdbool.h>
#include <stdint.h>
 
enum gj_error {
    GJ_ERR_NONE      =  0,  
    GJ_ERR_PARAM     = -1,  
    GJ_ERR_REQUEST   = -2,  
    GJ_ERR_RECEPTION = -3,  
    GJ_ERR_RESPONSE  = -4,  
    GJ_ERR_PARSE     = -5   
};
 
enum gj_trophy_difficulty {
    GJ_TROPHY_TYPE_BRONZE = 0,  
    GJ_TROPHY_TYPE_SILVER,      
    GJ_TROPHY_TYPE_GOLD,        
    GJ_TROPHY_TYPE_PLATINUM,    
    GJ_TROPHY_TYPE_UNKNOWN      
};
 
enum gj_data_store_update_operation {
    GJ_OP_ADD = 0,  
    GJ_OP_SUBTRACT, 
    GJ_OP_MULTIPLY, 
    GJ_OP_DIVIDE,   
    GJ_OP_APPEND,   
    GJ_OP_PREPEND,  
    GJ_OP_MAX   
};
 
#define GJ_TROPHY_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(id,          string,            char*) \
    X_MACRO(title,       string,            char*) \
    X_MACRO(difficulty,  trophy_difficulty, enum gj_trophy_difficulty) \
    X_MACRO(description, string,            char*) \
    X_MACRO(image_url,   string,            char*) \
    X_MACRO(achieved,    string,            char*)
 
#define GJ_TIME_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(timestamp, string, char*) \
    X_MACRO(timezone,  string, char*) \
    X_MACRO(day,       string, char*) \
    X_MACRO(hour,      string, char*) \
    X_MACRO(minute,    string, char*) \
    X_MACRO(second,    string, char*)
 
#define GJ_SCORE_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(score,            string, char*) \
    X_MACRO(sort,             string, char*) \
    X_MACRO(extra_data,       string, char*) \
    X_MACRO(user,             string, char*) \
    X_MACRO(user_id,          string, char*) \
    X_MACRO(guest,            string, char*) \
    X_MACRO(stored,           string, char*) \
    X_MACRO(stored_timestamp, string, char*)
 
#define GJ_SCORE_TABLE_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(id,          string, char*) \
    X_MACRO(name,        string, char*) \
    X_MACRO(description, string, char*) \
    X_MACRO(primary,     bool_num, bool)
 
#define GJ_SCORE_GETRANK_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(message, string, char*) \
    X_MACRO(rank,    string, char*)
 
#define GJ_USER_RESPONSE_TABLE(X_MACRO) \
    X_MACRO(id,                       string, char*) \
    X_MACRO(type,                     string, char*) \
    X_MACRO(username,                 string, char*) \
    X_MACRO(avatar_url,               string, char*) \
    X_MACRO(signed_up,                string, char*) \
    X_MACRO(signed_up_timestamp,      string, char*) \
    X_MACRO(last_logged_in,           string, char*) \
    X_MACRO(last_logged_in_timestamp, string, char*) \
    X_MACRO(status,                   string, char*) \
    X_MACRO(developer_name,           string, char*) \
    X_MACRO(developer_website,        string, char*) \
    X_MACRO(developer_description,    string, char*)
 
#define X_AS_STRUCT(field, decoder, type) \
    type field;
 
struct gj_trophy {
    GJ_TROPHY_RESPONSE_TABLE(X_AS_STRUCT);
    bool secret;    
};
 
struct gj_time {
    GJ_TIME_RESPONSE_TABLE(X_AS_STRUCT);
};
 
struct gj_score {
    GJ_SCORE_RESPONSE_TABLE(X_AS_STRUCT);
};
 
struct gj_score_table {
    GJ_SCORE_TABLE_RESPONSE_TABLE(X_AS_STRUCT);
};
 
struct gj_user {
    GJ_USER_RESPONSE_TABLE(X_AS_STRUCT);
};
 
/************************************************************************/
bool gj_init(const char *endpoint, const char *game_id, const char *private_key,
        const char *username, const char *user_token, char *reply_buf,
        uint16_t buf_len, uint16_t tout_frames);
 
/************************************************************************/
enum gj_error gj_get_error(void);
 
/************************************************************************/
char *gj_trophies_fetch(bool achieved, const char *trophy_id);
 
/************************************************************************/
char *gj_trophy_get_next(char *pos, struct gj_trophy *trophy);
 
/************************************************************************/
bool gj_trophy_add_achieved(const char *trophy_id);
 
/************************************************************************/
bool gj_trophy_remove_achieved(const char *trophy_id);
 
/************************************************************************/
const char *gj_trophy_difficulty_str(enum gj_trophy_difficulty difficulty);
 
/************************************************************************/
bool gj_time(struct gj_time *time);
 
/************************************************************************/
char *gj_scores_fetch(const char *limit, const char *table_id,
        const char *guest, const char *better_than,
        const char *worse_than, bool only_user);
 
/************************************************************************/
char *gj_score_get_next(char *pos, struct gj_score *score);
 
/************************************************************************/
char *gj_scores_tables_fetch(void);
 
/************************************************************************/
char *gj_score_table_get_next(char *pos, struct gj_score_table *score_table);
 
/************************************************************************/
char *gj_scores_get_rank(const char *sort, const char *table_id);
 
/************************************************************************/
bool gj_scores_add(const char *score, const char *sort, const char *table_id,
        const char *guest, const char *extra_data);
 
/************************************************************************/
bool gj_data_store_set(const char *key, const char *data, bool user_store);
 
/************************************************************************/
char *gj_data_store_keys_fetch(const char *pattern, bool user_store);
 
/************************************************************************/
char *gj_data_store_key_next(char *pos, char **key);
 
/************************************************************************/
char *data_store_fetch(const char *key, bool user_store);
 
/************************************************************************/
char *gj_data_store_update(const char *key,
        enum gj_data_store_update_operation operation,
        const char *value, bool user_store);
 
/************************************************************************/
bool gj_data_store_remove(const char *key, bool user_store);
 
/************************************************************************/
bool gj_sessions_open(void);
 
/************************************************************************/
bool gj_sessions_ping(bool active);
 
/************************************************************************/
bool gj_sessions_check(const char *username, const char *user_token);
 
/************************************************************************/
bool gj_sessions_close(void);
 
/************************************************************************/
char *gj_users_fetch(const char *username, const char *user_id);
 
/************************************************************************/
char *gj_user_get_next(char *pos, struct gj_user *user);
 
/************************************************************************/
bool gj_users_auth(void);
 
/************************************************************************/
char *gj_friends_fetch(void);
 
/************************************************************************/
char *gj_friend_get_next(char *pos, char **user_id);
 
/************************************************************************/
char *gj_request(const char **path, uint8_t num_paths, const char **key,
        const char **value, uint8_t num_kv_pairs, uint32_t *out_len);
 
#endif /*_GAMEJOLT_H_*/