157 lines
4.1 KiB
C
157 lines
4.1 KiB
C
/**
|
||
* File: idle.h
|
||
* Author: AWTK Develop Team
|
||
* Brief: idle manager
|
||
*
|
||
* Copyright (c) 2018 - 2023 Guangzhou ZHIYUAN Electronics Co.,Ltd.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* License file for more details.
|
||
*
|
||
*/
|
||
|
||
/**
|
||
* History:
|
||
* ================================================================
|
||
* 2018-04-19 Li XianJing <xianjimli@hotmail.com> created
|
||
*
|
||
*/
|
||
|
||
#ifndef TK_IDLE_H
|
||
#define TK_IDLE_H
|
||
|
||
#include "tkc/idle_manager.h"
|
||
|
||
BEGIN_C_DECLS
|
||
|
||
/**
|
||
* @class idle_t
|
||
* @annotation ["scriptable", "fake"]
|
||
*
|
||
* idle可以看作是duration为0的定时器。
|
||
*
|
||
* > idle可以用来实现一些异步处理。
|
||
*
|
||
* 示例：
|
||
*
|
||
* ```c
|
||
* static ret_t something_on_idle(const idle_info_t* info) {
|
||
* widget_t* widget = WIDGET(info->ctx);
|
||
* edit_t* edit = EDIT(widget);
|
||
* ...
|
||
* return RET_REMOVE;
|
||
* }
|
||
*
|
||
* ...
|
||
*
|
||
* idle_add(something_on_idle, edit);
|
||
*
|
||
* ```
|
||
*
|
||
* > 在非GUI线程请用idle\_queue。
|
||
*
|
||
*/
|
||
|
||
/**
|
||
* @method idle_add
|
||
* 增加一个idle。
|
||
* @annotation ["scriptable:custom", "static"]
|
||
* @param {idle_func_t} on_idle idle回调函数，回调函数返回RET_REPEAT，则下次继续执行，否则自动移出。
|
||
* @param {void*} ctx idle回调函数的上下文。
|
||
*
|
||
* @return {uint32_t} 返回idle的ID，0表示失败。
|
||
*/
|
||
uint32_t idle_add(idle_func_t on_idle, void* ctx);
|
||
|
||
/**
|
||
* @method idle_queue
|
||
* 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。
|
||
* @annotation ["static"]
|
||
* @param {idle_func_t} on_idle idle回调函数。
|
||
* @param {void*} ctx idle回调函数的上下文。
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_queue(idle_func_t on_idle, void* ctx);
|
||
|
||
/**
|
||
* @method idle_queue_ex
|
||
* 用于非GUI线程增加一个idle，本函数向主循环的事件队列中发送一个增加idle的请求。
|
||
* @annotation ["static"]
|
||
* @param {idle_func_t} on_idle idle回调函数。
|
||
* @param {void*} ctx idle回调函数的上下文。
|
||
* @param {tk_destroy_t} on_destroy 回调函数。
|
||
* @param {void*} on_destroy_ctx 回调函数上下文。
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_queue_ex(idle_func_t on_idle, void* ctx, tk_destroy_t on_destroy, void* on_destroy_ctx);
|
||
|
||
/**
|
||
* @method idle_remove
|
||
* 删除指定的idle。
|
||
* @annotation ["scriptable", "static"]
|
||
* @param {uint32_t} idle_id idleID。
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_remove(uint32_t idle_id);
|
||
|
||
/**
|
||
* @method idle_remove_all_by_ctx
|
||
* 根据上下文删除所有对应的idle。
|
||
* @annotation ["scriptable", "static"]
|
||
* @param {void*} ctx idle回调函数的上下文
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_remove_all_by_ctx(void* ctx);
|
||
|
||
/**
|
||
* @method idle_find
|
||
* 查找指定ID的idle。
|
||
* @param {uint32_t} idle_id idleID。
|
||
*
|
||
* @return {const idle_info_t*} 返回idle的信息。
|
||
*/
|
||
const idle_info_t* idle_find(uint32_t idle_id);
|
||
|
||
/**
|
||
* @method idle_set_on_destroy
|
||
* 设置一个回调函数，在idle被销毁时调用(方便脚本语言去释放回调函数)。
|
||
* @param {uint32_t} idle_id idleID。
|
||
* @param {tk_destroy_t} on_destroy 回调函数。
|
||
* @param {void*} on_destroy_ctx 回调函数上下文。
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_set_on_destroy(uint32_t idle_id, tk_destroy_t on_destroy, void* on_destroy_ctx);
|
||
|
||
/**
|
||
* @method idle_dispatch
|
||
* 调用全部idle的函数。
|
||
*
|
||
* @return {ret_t} 返回RET_OK表示成功，否则表示失败。
|
||
*/
|
||
ret_t idle_dispatch(void);
|
||
|
||
/**
|
||
* @method idle_count
|
||
* 返回idle的个数。
|
||
* @annotation ["static"]
|
||
*
|
||
* @return {uint32_t} 返回idle的个数。
|
||
*/
|
||
uint32_t idle_count(void);
|
||
|
||
/*internal use*/
|
||
bool_t idle_exist(idle_func_t on_idle, void* ctx);
|
||
ret_t idle_remove_all_by_ctx_and_type(uint32_t type, void* ctx);
|
||
uint32_t idle_add_with_type(idle_func_t on_idle, void* ctx, uint32_t type);
|
||
|
||
END_C_DECLS
|
||
|
||
#endif /*TK_IDLE_H*/
|