From 27088bd5d23daa7e042d525feeea5cc9def74a94 Mon Sep 17 00:00:00 2001 From: Albert Date: Tue, 11 Feb 2025 11:26:13 -0500 Subject: [PATCH] Adding webui_set_context and webui_get_context * webui_set_context * webui_get_context Inf: https://github.com/webui-dev/webui/issues/551 --- include/webui.h | 37 +++++++++++++++ src/webui.c | 121 ++++++++++++++++++++++++++++++++++++------------ 2 files changed, 128 insertions(+), 30 deletions(-) diff --git a/include/webui.h b/include/webui.h index cf67a2cc..e7466a4f 100644 --- a/include/webui.h +++ b/include/webui.h @@ -245,6 +245,43 @@ WEBUI_EXPORT size_t webui_get_new_window_id(void); */ WEBUI_EXPORT size_t webui_bind(size_t window, const char* element, void (*func)(webui_event_t* e)); +/** + * @brief Use this API after using `webui_bind()` to add any user data to it that can be + * read later using `webui_get_context()`. + * + * @param window The window number + * @param element The HTML element / JavaScript object + * @param context Any user data + * + * @example + * webui_bind(myWindow, "myFunction", myFunction); + * + * webui_set_context(myWindow, "myFunction", myData); + * + * void myFunction(webui_event_t* e) { + * void* myData = webui_get_context(e); + * } + */ +WEBUI_EXPORT void webui_set_context(size_t window, const char* element, void* context); + +/** + * @brief Get user data that is set using `webui_set_context()`. + * + * @param e The event struct + * + * @return Returns user data pointer. + * + * @example + * webui_bind(myWindow, "myFunction", myFunction); + * + * webui_set_context(myWindow, "myFunction", myData); + * + * void myFunction(webui_event_t* e) { + * void* myData = webui_get_context(e); + * } + */ +WEBUI_EXPORT void* webui_get_context(webui_event_t* e); + /** * @brief Get the recommended web browser ID to use. If you * are already using one, this function will return the same ID. diff --git a/src/webui.c b/src/webui.c index bb0e715b..c384a923 100644 --- a/src/webui.c +++ b/src/webui.c @@ -308,6 +308,7 @@ typedef struct _webui_window_t { size_t num; // Window number const char* html_elements[WEBUI_MAX_IDS]; bool has_all_events; + void* cb_context[WEBUI_MAX_IDS]; void(*cb[WEBUI_MAX_IDS])(webui_event_t* e); void(*cb_interface[WEBUI_MAX_IDS])(size_t, size_t, char* , size_t, size_t); bool ws_block; @@ -1730,6 +1731,59 @@ bool webui_show_browser(size_t window, const char* content, size_t browser) { return _webui_show(win, NULL, content, browser); } +void* webui_get_context(webui_event_t* e) { + + #ifdef WEBUI_LOG + printf("[User] webui_get_context()\n"); + #endif + + // Dereference + if (_webui_mutex_is_exit_now(WEBUI_MUTEX_NONE) || _webui.wins[e->window] == NULL) + return 0; + _webui_window_t* win = _webui.wins[e->window]; + + // Search + size_t cb_index = 0; + if (_webui_get_cb_index(win, e->element, &cb_index)) { + // Get context + #ifdef WEBUI_LOG + printf("[User] webui_get_context() -> Found context at %p\n", win->cb_context[cb_index]); + #endif + return win->cb_context[cb_index]; + } + + return NULL; +} + +void webui_set_context(size_t window, const char* element, void* context) { + + #ifdef WEBUI_LOG + printf("[User] webui_set_context([%zu])\n", window); + printf("[User] webui_set_context() -> Element: [%s]\n", element); + printf("[User] webui_set_context() -> Context: [%p]\n", context); + #endif + + // Initialization + _webui_init(); + + // Dereference + if (_webui_mutex_is_exit_now(WEBUI_MUTEX_NONE) || _webui.wins[window] == NULL) + return; + _webui_window_t* win = _webui.wins[window]; + + // Get bind Index + // We should use `webui_bind()` with NULL to make `webui_set_context()` + // works fine if user call it before or after `webui_bind()`. + size_t cb_index = webui_bind(window, element, NULL); + + // Set context + win->cb_context[cb_index] = context; + + #ifdef WEBUI_LOG + printf("[User] webui_set_context() -> Context saved at %zu\n", cb_index); + #endif +} + size_t webui_bind(size_t window, const char* element, void(*func)(webui_event_t* e)) { #ifdef WEBUI_LOG @@ -1746,41 +1800,48 @@ size_t webui_bind(size_t window, const char* element, void(*func)(webui_event_t* // Search size_t cb_index = 0; - bool exist = _webui_get_cb_index(win, element, &cb_index); + bool exist = _webui_get_cb_index(win, element, &cb_index); - // All events - if (_webui_is_empty(element)) { - win->has_all_events = true; - size_t index = (exist ? cb_index : _webui.cb_count++); - win->html_elements[index] = ""; - win->cb[index] = func; - #ifdef WEBUI_LOG - printf("[User] webui_bind() -> Save bind (all events) at %zu\n", index); - #endif - return index; - } - - // New bind - const char* element_cpy = (const char*)_webui_str_dup(element); + // Free old ID size_t index = (exist ? cb_index : _webui.cb_count++); - win->html_elements[index] = element_cpy; - win->cb[index] = func; - #ifdef WEBUI_LOG - printf("[User] webui_bind() -> Save bind at %zu\n", index); - #endif + _webui_free_mem((void*)win->html_elements[index]); - // Send to all connected clients the new binding ID - // Packet Protocol Format: + // All events binding + if (_webui_is_empty(element)) { + // Empty Element ID Binding (New / Update) + win->html_elements[index] = ""; + if (func != NULL) { + win->has_all_events = true; + win->cb[index] = func; + #ifdef WEBUI_LOG + printf("[User] webui_bind() -> Save bind (all events) at %zu\n", index); + #endif + } + return index; + } else { + // Non-empty Element ID Binding (New / Update) + const char* element_cpy = (const char*)_webui_str_dup(element); + win->html_elements[index] = element_cpy; + if (func != NULL) { + win->cb[index] = func; + #ifdef WEBUI_LOG + printf("[User] webui_bind() -> Save bind at %zu\n", index); + #endif - // [...] - // [CMD] - // [NewElement] - // Send the packet + // Send to all connected clients the new binding ID + // Packet Protocol Format: - _webui_send_all( - win, 0, WEBUI_CMD_ADD_ID, - element, _webui_strlen(element_cpy) - ); + // [...] + // [CMD] + // [NewElement] + // Send the packet + + _webui_send_all( + win, 0, WEBUI_CMD_ADD_ID, + element, _webui_strlen(element_cpy) + ); + } + } return index; }