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

refactor: move common to internal and update public api

Browse Source
This commit is contained in:
Francesco
2026-03-17 00:30:38 +01:00
parent 6ca04a9392
commit bb31304614
17 changed files with 284 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/common.h
-109
View File
@@ -1,109 +0,0 @@
#ifndef TGBOT_COMMON_H
#define TGBOT_COMMON_H
#include <curl/curl.h>
#include <stdint.h>
#define TOKEN_SIZE 128
#define API_SIZE 512
#define URL_LEN 1024
#define FIRSTNAME_SIZE 256
#define USERNAME_SIZE 32
#define CHAT_LASTNAME_SIZE 256
#define CHAT_TYPE_SIZE 32
#define CHAT_TEXT_SIZE 4096
/**
* @brief A structure used to get curl response.
*/
struct memory_buffer {
char *data;
size_t size;
};
/**
* @brief A structure to represent bot object.
*/
typedef struct tgbot {
char token[TOKEN_SIZE]; /**< Bot token. */
char api[API_SIZE]; /**< Bot API url. */
int32_t offset; /**< Bot offset. */
} tgbot_s;
/**
* @brief A structure to represent Bot information got from getMe API.
*/
typedef struct tgbot_me {
char first_name[FIRSTNAME_SIZE]; /**< Bot's first name. */
char username[USERNAME_SIZE]; /**< Bot's username. */
} tgbot_me_s;
/**
* @brief A structure to represent Update object.
*/
typedef struct tgbot_update {
int64_t update_id; /**< Update id. */
long message_id; /**< Message id. */
int64_t chat_id; /**< Chat id. */
char chat_first_name[FIRSTNAME_SIZE]; /**< Chat first name. */
char chat_last_name[CHAT_LASTNAME_SIZE]; /**< Chat last name. */
char chat_username[USERNAME_SIZE]; /**< Chat username. */
char chat_type[CHAT_TYPE_SIZE]; /**< Chat type (private/public). */
int32_t date; /**< Date in unix timestamp. */
char text[CHAT_TEXT_SIZE]; /**< Message text. */
} tgbot_update_s;
/**
* @brief A structure to represent CallbackQuery object.
*/
typedef struct tgbot_cbquery {
int64_t update_id;
long message_id;
int64_t chat_id;
char chat_username[USERNAME_SIZE];
int32_t date;
char text[CHAT_TEXT_SIZE];
char chat_instance[128];
char data[64]; /**> Callback data. */
} tgbot_cbquery_s;
/**
* @brief Callback function pointer.
*/
typedef void (*Callback)(tgbot_s *bot, tgbot_cbquery_s *query);
/**
* @brief An enum to represent error codes.
*/
enum tgbot_rc {
TGBOT_OK = 0,
TGBOT_INIT_ERROR,
TGBOT_REQUEST_ERROR,
TGBOT_GETUPDATES_ERROR,
TGBOT_GETME_ERROR,
TGBOT_SENDMESSAGE_ERROR,
TGBOT_EDITMESSAGETEXT_ERROR,
TGBOT_SENDDICE_ERROR,
TGBOT_TELEGRAM_OK_ERROR,
};
typedef enum tgbot_rc tgbot_rc;
enum tgbot_opt_type {
tgbot_opt_int,
tgbot_opt_int64,
tgbot_opt_string,
tgbot_opt_inlinekeyboard,
tgbot_opt_null,
};
typedef enum tgbot_opt_type tgbot_opt_type_e;
struct tgbot_option {
char key[32];
void *value;
tgbot_opt_type_e type;
};
typedef struct tgbot_option tgbot_option_s;
#endif
include/json.h
-11
View File
@@ -1,11 +0,0 @@
#ifndef TGBOT_JSON_H
#define TGBOT_JSON_H
#include "types.h"
#include <json-c/json.h>
json_object *json_builder(tgbot_option_s *options, size_t optionslen);
json_object *json_ikb_new(tgbot_inlinekeyboard_s *keyboard);
#endif
include/methods.h
+7 -7
View File
@@ -5,16 +5,16 @@
#include <json-c/json.h>
/* Retrieve update */
tgbot_rc tgbot_get_update(tgbot_s *bot, tgbot_update_s *update, Callback cbq_handler);
int tgbot_get_update(tgbot_s *bot, tgbot_update_s *update, Callback cbq_handler);
/* Methods */
tgbot_rc tgbot_get_me(const tgbot_s *bot, tgbot_me_s *me);
tgbot_rc tgbot_send_message(const tgbot_s *bot, int64_t chat_id, const char *text, const char *parse_mode,
tgbot_inlinekeyboard_s *reply_markup);
tgbot_rc tgbot_send_dice(const tgbot_s *bot, int64_t chat_id, const char *emoji);
int tgbot_get_me(const tgbot_s *bot, tgbot_me_s *me);
int tgbot_send_message(const tgbot_s *bot, int64_t chat_id, const char *text, const char *parse_mode,
tgbot_inlinekeyboard_s *reply_markup);
int tgbot_send_dice(const tgbot_s *bot, int64_t chat_id, const char *emoji);
/* Updating Methods */
tgbot_rc tgbot_edit_message_text(const tgbot_s *bot, int64_t chat_id, long message_id, const char *text,
tgbot_inlinekeyboard_s *keyboard);
int tgbot_edit_message_text(const tgbot_s *bot, int64_t chat_id, long message_id, const char *text,
tgbot_inlinekeyboard_s *keyboard);
#endif
include/parse.h
-11
View File
@@ -1,11 +0,0 @@
#ifndef TGBOT_PARSE_H
#define TGBOT_PARSE_H
#include "common.h"
#include <json-c/json.h>
tgbot_rc tgbot_parse_message(tgbot_s *bot, tgbot_update_s *update, json_object *result);
tgbot_rc tgbot_parse_cbquery(tgbot_s *bot, tgbot_cbquery_s *query, json_object *result, Callback cbq_handler);
#endif
include/tg_types.h
+49
View File
@@ -0,0 +1,49 @@
#ifndef TGBOT_TG_TYPES_H
#define TGBOT_TG_TYPES_H
#include "types.h"
/**
* @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_s *tgbot_inlinekb_new(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 0 on success.
*/
int tgbot_inlinekb_button(tgbot_inlinekeyboard_s *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_s *tgbot_inlinekb_button_at(tgbot_inlinekeyboard_s *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_inlinekb_free(tgbot_inlinekeyboard_s *keyboard);
#endif
include/tgbot.h
+2 -3
View File
@@ -1,9 +1,8 @@
#ifndef TGBOT_MAIN_H
#define TGBOT_MAIN_H
#include "common.h"
#include "methods.h"
#include "types.h"
#include <stdint.h>
/**
* @brief Create a new Bot object.
@@ -21,4 +20,4 @@ tgbot_s *tgbot_new(const char *token);
*/
void tgbot_free(tgbot_s *bot);
#endif // TGBOT_H
#endif
include/types.h
+83 -71
View File
@@ -1,71 +1,83 @@
#ifndef TGBOT_TYPES_H
#define TGBOT_TYPES_H
#include "common.h"
#define TEXT_SIZE 200
#define URL_SIZE 200
#define CB_DATA_SIZE 64
/**
* @brief Represents a single button on an inline keyboard.
*/
typedef struct tgbot_inlinekeyboardbutton {
char text[TEXT_SIZE]; /**< Text of the button. If empty, the button is ignored. */
char url[URL_SIZE]; /**< (Optional) URL to be opened when the button is pressed. */
char callback_data[CB_DATA_SIZE]; /**< (Optional) Data sent to the bot when the button is pressed. */
} tgbot_inlinekeyboardbutton_s;
/**
* @brief Represents an inline keyboard.
*/
typedef struct tgbot_inlinekeyboard {
size_t rows; /**< Number of rows in the keyboard. */
size_t columns; /**< Number of columns per row. */
tgbot_inlinekeyboardbutton_s *buttons; /**< Array of buttons. */
} tgbot_inlinekeyboard_s;
/**
* @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_s *tgbot_inlinekb_new(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_inlinekb_button(tgbot_inlinekeyboard_s *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_s *tgbot_inlinekb_button_at(tgbot_inlinekeyboard_s *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_inlinekb_free(tgbot_inlinekeyboard_s *keyboard);
#endif
#ifndef TGBOT_TYPES_H
#define TGBOT_TYPES_H
#include <stddef.h>
#include <stdint.h>
#define FIRSTNAME_SIZE 256
#define USERNAME_SIZE 32
#define CHAT_LASTNAME_SIZE 256
#define CHAT_TYPE_SIZE 32
#define CHAT_TEXT_SIZE 4096
/**
* @brief Telegram bot struct.
*/
typedef struct tgbot tgbot_s;
/**
* @brief A structure to represent Bot information got from getMe API.
*/
typedef struct tgbot_me {
char first_name[FIRSTNAME_SIZE]; /**< Bot's first name. */
char username[USERNAME_SIZE]; /**< Bot's username. */
} tgbot_me_s;
/**
* @brief A structure to represent Update object.
*/
typedef struct tgbot_update {
int64_t update_id; /**< Update id. */
long message_id; /**< Message id. */
int64_t chat_id; /**< Chat id. */
char chat_first_name[FIRSTNAME_SIZE]; /**< Chat first name. */
char chat_last_name[CHAT_LASTNAME_SIZE]; /**< Chat last name. */
char chat_username[USERNAME_SIZE]; /**< Chat username. */
char chat_type[CHAT_TYPE_SIZE]; /**< Chat type (private/public). */
int32_t date; /**< Date in unix timestamp. */
char text[CHAT_TEXT_SIZE]; /**< Message text. */
} tgbot_update_s;
/**
* @brief A structure to represent CallbackQuery object.
*/
typedef struct tgbot_cbquery {
int64_t update_id;
long message_id;
int64_t chat_id;
char chat_username[USERNAME_SIZE];
int32_t date;
char text[CHAT_TEXT_SIZE];
char chat_instance[128];
char data[64]; /**> Callback data. */
} tgbot_cbquery_s;
/**
* @brief Callback function pointer.
*/
typedef void (*Callback)(tgbot_s *bot, tgbot_cbquery_s *query);
#define TEXT_SIZE 200
#define URL_SIZE 200
#define CB_DATA_SIZE 64
/**
* @brief Represents a single button on an inline keyboard.
*/
typedef struct tgbot_inlinekeyboardbutton {
char text[TEXT_SIZE]; /**< Text of the button. If empty, the button is ignored. */
char url[URL_SIZE]; /**< (Optional) URL to be opened when the button is pressed. */
char callback_data[CB_DATA_SIZE]; /**< (Optional) Data sent to the bot when the button is pressed. */
} tgbot_inlinekeyboardbutton_s;
/**
* @brief Represents an inline keyboard.
*/
typedef struct tgbot_inlinekeyboard {
size_t rows; /**< Number of rows in the keyboard. */
size_t columns; /**< Number of columns per row. */
tgbot_inlinekeyboardbutton_s *buttons; /**< Array of buttons. */
} tgbot_inlinekeyboard_s;
#endif