francesco/tgbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docs

Browse Source
This commit is contained in:
Francesco
2025-05-21 17:44:24 +02:00
parent 35ca1f0eee
commit eebacd5fb9
3 changed files with 79 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
include/common.h
View File

@@ -5,7 +5,7 @@
#include <stdint.h> #include <stdint.h>
/** /**
* A structure used to get curl response * @brief A structure used to get curl response.
*/ */
struct memory_buffer { struct memory_buffer {
char *data; char *data;
@@ -13,43 +13,43 @@ struct memory_buffer {
}; };
/** /**
* A structure to represent bot object * @brief A structure to represent bot object.
*/ */
struct tgbot_t { struct tgbot_t {
char token[128]; /**< Bot token */ char token[128]; /**< Bot token. */
char api[512]; /**< Bot API url */ char api[512]; /**< Bot API url. */
int32_t offset; /**< Bot offset */ int32_t offset; /**< Bot offset. */
CURL *curl; /**< Curl object, used to send http requests */ CURL *curl; /**< Curl object, used to send http requests. */
}; };
typedef struct tgbot_t tgbot; typedef struct tgbot_t tgbot;
/** /**
* A structure to represent Bot information got from getMe API * @brief A structure to represent Bot information got from getMe API.
*/ */
struct tgbot_me_t { struct tgbot_me_t {
char first_name[256]; char first_name[256]; /**< Bot's first name. */
char username[32]; char username[32]; /**< Bot's username. */
}; };
typedef struct tgbot_me_t tgbot_me; typedef struct tgbot_me_t tgbot_me;
/** /**
* A structure to represent Update object * @brief A structure to represent Update object.
*/ */
struct tgbot_update_t { struct tgbot_update_t {
int64_t update_id; /**< Update id */ int64_t update_id; /**< Update id. */
long message_id; /**< Message id */ long message_id; /**< Message id. */
int64_t chat_id; /**< Chat id */ int64_t chat_id; /**< Chat id. */
char chat_first_name[256]; /**< Chat first name */ char chat_first_name[256]; /**< Chat first name. */
char chat_last_name[256]; /**< Chat last name */ char chat_last_name[256]; /**< Chat last name. */
char chat_username[32]; /**< Chat username */ char chat_username[32]; /**< Chat username. */
char chat_type[32]; /**< Chat type (private/public) */ char chat_type[32]; /**< Chat type (private/public). */
int32_t date; /**< Date in unix timestamp */ int32_t date; /**< Date in unix timestamp. */
char text[4096]; /**< Message text */ char text[4096]; /**< Message text. */
}; };
typedef struct tgbot_update_t tgbot_update; typedef struct tgbot_update_t tgbot_update;
/** /**
* A structure to represent CallbackQuery object * @brief A structure to represent CallbackQuery object.
*/ */
struct tgbot_cbquery_t { struct tgbot_cbquery_t {
int64_t update_id; int64_t update_id;
@@ -59,17 +59,17 @@ struct tgbot_cbquery_t {
int32_t date; int32_t date;
char text[4096]; char text[4096];
char chat_instance[128]; char chat_instance[128];
char data[64]; /**> Callback data */ char data[64]; /**> Callback data. */
}; };
typedef struct tgbot_cbquery_t tgbot_cbquery; typedef struct tgbot_cbquery_t tgbot_cbquery;
/** /**
* Callback function pointer * @brief Callback function pointer.
*/ */
typedef void (*Callback)(tgbot *bot, tgbot_cbquery *query); typedef void (*Callback)(tgbot *bot, tgbot_cbquery *query);
/** /**
* A structure to represent error codes * @brief A structure to represent error codes.
*/ */
enum tgbot_rc { enum tgbot_rc {
TGBOT_OK = 0, TGBOT_OK = 0,

14
include/tgbot.h
View File

@@ -6,15 +6,19 @@
#include "types.h" #include "types.h"
/** /**
* Initializes the Bot object * @brief Initializes the Bot object.
* @param[out] bot The Bot object *
* @param[in] token The Bot token (obtained from @BotFather) * @param[out] bot The Bot object.
* @param[in] token The Bot token (obtained from @BotFather).
*
* @return TGBOT_OK on success.
*/ */
tgbot_rc tgbot_init(tgbot *bot, char *token); tgbot_rc tgbot_init(tgbot *bot, char *token);
/** /**
* Cleans the memory * @brief Cleans the memory.
* @param bot The Bot object *
* @param[out] bot The Bot object.
*/ */
void tgbot_destroy(tgbot *bot); void tgbot_destroy(tgbot *bot);

54
include/types.h
View File

@@ -4,25 +4,65 @@
#include "common.h" #include "common.h"
/** /**
* A structure to represent keyboard's buttons * @brief Represents a single button on an inline keyboard.
*/ */
struct tgbot_inlinekeyboardbutton_t { struct tgbot_inlinekeyboardbutton_t {
char text[200]; /**< If this field is empty the button will be skipped */ char text[200]; /**< Text of the button. If empty, the button is ignored. */
char url[200]; /**< (Optional) URL of the button */ char url[200]; /**< (Optional) URL to be opened when the button is pressed. */
char callback_data[64]; /**< Callback data */ char callback_data[64]; /**< (Optional) Data sent to the bot when the button is pressed. */
}; };
typedef struct tgbot_inlinekeyboardbutton_t tgbot_inlinekeyboardbutton; typedef struct tgbot_inlinekeyboardbutton_t tgbot_inlinekeyboardbutton;
/**
* @brief Represents an inline keyboard.
*/
struct tgbot_inlinekeyboard_t { struct tgbot_inlinekeyboard_t {
size_t rows; size_t rows; /**< Number of rows in the keyboard. */
size_t columns; size_t columns; /**< Number of columns per row. */
struct tgbot_inlinekeyboardbutton_t *buttons; struct tgbot_inlinekeyboardbutton_t *buttons; /**< Array of buttons. */
}; };
typedef struct tgbot_inlinekeyboard_t tgbot_inlinekeyboard; typedef struct tgbot_inlinekeyboard_t tgbot_inlinekeyboard;
/**
* @brief Allocates a new inline keyboard.
*
* @param[in] rows Number of rows in the keyboard.
* @param[in] columns Number of columns in each row.
*
* @return The pointer to the keyboard or NULL on allocation failure.
*/
tgbot_inlinekeyboard *tgbot_new_inlinekeyboard(size_t rows, size_t columns); tgbot_inlinekeyboard *tgbot_new_inlinekeyboard(size_t rows, size_t columns);
/**
* @brief Adds or updates a button at the specified position in the keyboard.
*
* @param[out] keyboard Pointer to the keyboard to modify.
* @param[in] row Row index of the button (starting from 0).
* @param[in] column Column index of the button (starting from 0).
* @param[in] text Display text for the button.
* @param[in] url Optional URL for the button.
* @param[in] callback_data Optional callback data for the button.
*
* @return TGBOT_OK on success.
*/
tgbot_rc tgbot_inlinekeyboard_button(tgbot_inlinekeyboard *keyboard, size_t row, size_t column, const char *text, const char *url, const char *callback_data); tgbot_rc tgbot_inlinekeyboard_button(tgbot_inlinekeyboard *keyboard, size_t row, size_t column, const char *text, const char *url, const char *callback_data);
/**
* @brief Returns a pointer to the keyboard's button.
*
* @param[in] keyboard Keyboard.
* @param[in] row Row index of the button.
* @param[in] column Column index of the button.
*
* @return Pointer to the button, or NULL if the position is invalid.
*/
tgbot_inlinekeyboardbutton *tgbot_inlinekeyboard_button_at(tgbot_inlinekeyboard *keyboard, size_t row, size_t column); tgbot_inlinekeyboardbutton *tgbot_inlinekeyboard_button_at(tgbot_inlinekeyboard *keyboard, size_t row, size_t column);
/**
* @brief Frees all memory associated with the given inline keyboard.
*
* @param[in,out] keyboard Pointer to the keyboard structure to deallocate.
*/
void tgbot_destroy_inlinekeyboard(tgbot_inlinekeyboard *keyboard); void tgbot_destroy_inlinekeyboard(tgbot_inlinekeyboard *keyboard);
#endif #endif