mirror of
https://gitee.com/zlgopen/awtk.git
synced 2024-12-01 19:49:11 +08:00
update docs
This commit is contained in:
lixianjing
parent
bc0a980207
commit
ab4215cc29
@ -41,7 +41,7 @@ XmlParser* xml_parser_create ();
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_parser_destroy (XmlParser* thiz);
|
||||
void xml_parser_destroy (XmlParser* parser);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -49,7 +49,7 @@ void xml_parser_destroy (XmlParser* thiz);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| thiz | XmlParser* | parser对象。 |
|
||||
| parser | XmlParser* | parser对象。 |
|
||||
#### xml\_parser\_parse 函数
|
||||
-----------------------
|
||||
|
||||
@ -60,7 +60,7 @@ void xml_parser_destroy (XmlParser* thiz);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_parser_parse (XmlParser* thiz, const char* xml, int length);
|
||||
void xml_parser_parse (XmlParser* parser, const char* xml, int length);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -68,7 +68,7 @@ void xml_parser_parse (XmlParser* thiz, const char* xml, int length);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| thiz | XmlParser* | parser对象。 |
|
||||
| parser | XmlParser* | parser对象。 |
|
||||
| xml | const char* | 数据。 |
|
||||
| length | int | 数据长度。 |
|
||||
#### xml\_parser\_parse\_file 函数
|
||||
@ -81,7 +81,7 @@ void xml_parser_parse (XmlParser* thiz, const char* xml, int length);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_parser_parse_file (XmlParser* thiz, const char* filename);
|
||||
void xml_parser_parse_file (XmlParser* parser, const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -89,7 +89,7 @@ void xml_parser_parse_file (XmlParser* thiz, const char* filename);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| thiz | XmlParser* | parser对象。 |
|
||||
| parser | XmlParser* | parser对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### xml\_parser\_set\_builder 函数
|
||||
-----------------------
|
||||
@ -101,7 +101,7 @@ void xml_parser_parse_file (XmlParser* thiz, const char* filename);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_parser_set_builder (XmlParser* thiz, XmlBuilder* builder);
|
||||
void xml_parser_set_builder (XmlParser* parser, XmlBuilder* builder);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -109,7 +109,7 @@ void xml_parser_set_builder (XmlParser* thiz, XmlBuilder* builder);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| thiz | XmlParser* | parser对象。 |
|
||||
| parser | XmlParser* | parser对象。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
#### xml\_parser\_set\_trim\_text 函数
|
||||
-----------------------
|
||||
@ -118,12 +118,12 @@ void xml_parser_set_builder (XmlParser* thiz, XmlBuilder* builder);
|
||||
|
||||
> <p id="XmlParser_xml_parser_set_trim_text">设置是否去掉文本两端的空白字符。
|
||||
|
||||
> 默认值为去掉文本两端的空白字符，如果不x希望去掉，调用本函数设置为FALSE。
|
||||
> 默认值为去掉文本两端的空白字符，如果不希望去掉，调用本函数设置为FALSE。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_parser_set_trim_text (XmlParser* thiz, bool_t trim_text);
|
||||
void xml_parser_set_trim_text (XmlParser* parser, bool_t trim_text);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -131,5 +131,5 @@ void xml_parser_set_trim_text (XmlParser* thiz, bool_t trim_text);
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| thiz | XmlParser* | parser对象。 |
|
||||
| parser | XmlParser* | parser对象。 |
|
||||
| trim\_text | bool\_t | 是否去掉文本两端的空白字符。 |
|
||||
|
||||
@ -8,6 +8,7 @@ action线程池。
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#action_thread_pool_t_action_thread_pool_create">action\_thread\_pool\_create</a> | 创建action_thread_pool对象。 |
|
||||
| <a href="#action_thread_pool_t_action_thread_pool_create">action\_thread\_pool\_create</a> | 创建action_thread_pool对象。 |
|
||||
| <a href="#action_thread_pool_t_action_thread_pool_destroy">action\_thread\_pool\_destroy</a> | 销毁。 |
|
||||
| <a href="#action_thread_pool_t_action_thread_pool_exec">action\_thread\_pool\_exec</a> | 执行action。 |
|
||||
### 属性
|
||||
@ -17,6 +18,8 @@ action线程池。
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#action_thread_pool_t_max_thread_nr">max\_thread\_nr</a> | uint32\_t | 最大线程数。 |
|
||||
| <a href="#action_thread_pool_t_min_idle_nr">min\_idle\_nr</a> | uint32\_t | 最小空闲线程数 |
|
||||
| <a href="#action_thread_pool_t_priority">priority</a> | tk\_thread\_priority\_t | 线程池中的线程优先级 |
|
||||
| <a href="#action_thread_pool_t_stack_size">stack\_size</a> | uint32\_t | 线程池中的线程栈大小 |
|
||||
#### action\_thread\_pool\_create 函数
|
||||
-----------------------
|
||||
|
||||
@ -37,6 +40,28 @@ action_thread_pool_t* action_thread_pool_create (uint16_t max_thread_nr, uint16_
|
||||
| 返回值 | action\_thread\_pool\_t* | action\_thread\_pool对象。 |
|
||||
| max\_thread\_nr | uint16\_t | 最大线程数。 |
|
||||
| min\_idle\_nr | uint16\_t | 最小空闲线程数。 |
|
||||
#### action\_thread\_pool\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="action_thread_pool_t_action_thread_pool_create">创建action_thread_pool对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
action_thread_pool_t* action_thread_pool_create (uint16_t max_thread_nr, uint16_t min_idle_nr, uint32_t stack_size, tk_thread_priority_t priority);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | action\_thread\_pool\_t* | action\_thread\_pool对象。 |
|
||||
| max\_thread\_nr | uint16\_t | 最大线程数。 |
|
||||
| min\_idle\_nr | uint16\_t | 最小空闲线程数。 |
|
||||
| stack\_size | uint32\_t | 栈的大小。 |
|
||||
| priority | tk\_thread\_priority\_t | 优先级 |
|
||||
#### action\_thread\_pool\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -96,3 +121,23 @@ ret_t action_thread_pool_exec (action_thread_pool_t* thread_pool, qaction_t* act
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### priority 属性
|
||||
-----------------------
|
||||
> <p id="action_thread_pool_t_priority">线程池中的线程优先级
|
||||
|
||||
* 类型：tk\_thread\_priority\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### stack\_size 属性
|
||||
-----------------------
|
||||
> <p id="action_thread_pool_t_stack_size">线程池中的线程栈大小
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
|
||||
@ -10,6 +10,8 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#action_thread_t_action_thread_create">action\_thread\_create</a> | 创建action_thread对象。 |
|
||||
| <a href="#action_thread_t_action_thread_create">action\_thread\_create</a> | 创建action_thread对象。 |
|
||||
| <a href="#action_thread_t_action_thread_create_with_queue">action\_thread\_create\_with\_queue</a> | 创建action_thread对象。 |
|
||||
| <a href="#action_thread_t_action_thread_create_with_queue">action\_thread\_create\_with\_queue</a> | 创建action_thread对象。 |
|
||||
| <a href="#action_thread_t_action_thread_destroy">action\_thread\_destroy</a> | 销毁。 |
|
||||
| <a href="#action_thread_t_action_thread_exec">action\_thread\_exec</a> | 让线程执行action。 |
|
||||
@ -41,6 +43,27 @@ action_thread_t* action_thread_create ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | action\_thread\_t* | action\_thread对象。 |
|
||||
#### action\_thread\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="action_thread_t_action_thread_create">创建action_thread对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
action_thread_t* action_thread_create (const char* name, uint32_t stack_size, tk_thread_priority_t priority);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | action\_thread\_t* | action\_thread对象。 |
|
||||
| name | const char* | 名称。 |
|
||||
| stack\_size | uint32\_t | 栈的大小。 |
|
||||
| priority | tk\_thread\_priority\_t | 优先级。 |
|
||||
#### action\_thread\_create\_with\_queue 函数
|
||||
-----------------------
|
||||
|
||||
@ -60,6 +83,28 @@ action_thread_t* action_thread_create_with_queue (waitable_action_queue_t* queue
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | action\_thread\_t* | action\_thread对象。 |
|
||||
| queue | waitable\_action\_queue\_t* | queue对象。 |
|
||||
#### action\_thread\_create\_with\_queue 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="action_thread_t_action_thread_create_with_queue">创建action_thread对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
action_thread_t* action_thread_create_with_queue (waitable_action_queue_t* queue, const char* name, uint32_t stack_size, tk_thread_priority_t priority);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | action\_thread\_t* | action\_thread对象。 |
|
||||
| queue | waitable\_action\_queue\_t* | queue对象。 |
|
||||
| name | const char* | 名称。 |
|
||||
| stack\_size | uint32\_t | 栈的大小。 |
|
||||
| priority | tk\_thread\_priority\_t | 优先级。 |
|
||||
#### action\_thread\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -14,4 +14,5 @@
|
||||
| ASSET\_TYPE\_XML | XML数据资源。 |
|
||||
| ASSET\_TYPE\_STRINGS | 字符串数据资源。 |
|
||||
| ASSET\_TYPE\_SCRIPT | JS等脚本资源。 |
|
||||
| ASSET\_TYPE\_FLOW | 流图资源。 |
|
||||
| ASSET\_TYPE\_DATA | 其它数据资源。 |
|
||||
|
||||
84
docs/manual/assets_event_t.md
Normal file
84
docs/manual/assets_event_t.md
Normal file
@ -0,0 +1,84 @@
|
||||
## assets\_event\_t
|
||||
### 概述
|
||||
|
||||
|
||||
资源事件，由资源管理器触发。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="assets_event_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#assets_event_t_event_from_name">event\_from\_name</a> | 将事件名转换成事件的值。 |
|
||||
| <a href="#assets_event_t_window_event_init">window\_event\_init</a> | 初始化事件。 |
|
||||
### 属性
|
||||
<p id="assets_event_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#assets_event_t_asset_info">asset\_info</a> | asset\_info\_t* | 触发事件的资源对象 |
|
||||
| <a href="#assets_event_t_type">type</a> | asset\_type\_t | 触发事件的资源类型 |
|
||||
#### event\_from\_name 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="assets_event_t_event_from_name">将事件名转换成事件的值。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t event_from_name (const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回事件的值。 |
|
||||
| name | const char* | 事件名。 |
|
||||
#### window\_event\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="assets_event_t_window_event_init">初始化事件。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
event_t* window_event_init (window_event_t* event, assets_manager_t* am, uint32_t type, asset_type_t asset_type, asset_info_t* asset_info);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | event\_t* | event对象。 |
|
||||
| event | window\_event\_t* | event对象。 |
|
||||
| am | assets\_manager\_t* | 事件目标资源管理器。 |
|
||||
| type | uint32\_t | 事件类型。 |
|
||||
| asset\_type | asset\_type\_t | 资源类型。 |
|
||||
| asset\_info | asset\_info\_t* | 资源对象。 |
|
||||
#### asset\_info 属性
|
||||
-----------------------
|
||||
> <p id="assets_event_t_asset_info">触发事件的资源对象
|
||||
|
||||
* 类型：asset\_info\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
> <p id="assets_event_t_type">触发事件的资源类型
|
||||
|
||||
* 类型：asset\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
@ -1,5 +1,7 @@
|
||||
## assets\_manager\_t
|
||||
### 概述
|
||||
|
||||
|
||||
资源管理器。
|
||||
这里的资源管理器并非Windows下的文件浏览器，而是负责对各种资源，比如字体、主题、图片、界面数据、字符串和其它数据的进行集中管理的组件。引入资源管理器的目的有以下几个：
|
||||
|
||||
|
||||
@ -15,7 +15,6 @@
|
||||
| <a href="#clip_board_t_clip_board_set">clip\_board\_set</a> | 设置缺省的剪切板对象。 |
|
||||
| <a href="#clip_board_t_clip_board_set_data">clip\_board\_set\_data</a> | 设置数据到剪切板中。 |
|
||||
| <a href="#clip_board_t_clip_board_set_text">clip\_board\_set\_text</a> | 设置文本(UTF8)数据到剪切板。 |
|
||||
| <a href="#clip_board_t_data_reader_asset_create">data\_reader\_asset\_create</a> | 创建基于asset的data reader。 |
|
||||
#### clip\_board 函数
|
||||
-----------------------
|
||||
|
||||
@ -172,22 +171,3 @@ ret_t clip_board_set_text (const char* text);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| text | const char* | 文本。 |
|
||||
#### data\_reader\_asset\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="clip_board_t_data_reader_asset_create">创建基于asset的data reader。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_reader_t* data_reader_asset_create (const char* assetname);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_reader\_t* | 返回data reader对象。 |
|
||||
| assetname | const char* | 资源的名称。 |
|
||||
|
||||
@ -320,7 +320,7 @@ ret_t combo_box_reset_options (widget_t* widget);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t combo_box_set_custom_open_popup (widget_t* widget, combo_box_custom_open_popup_t open_popup);
|
||||
ret_t combo_box_set_custom_open_popup (widget_t* widget, combo_box_custom_open_popup_t open_popup, combo_box_custom_on_layout_combobox_popup_t on_layout_combobox_popup);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -330,6 +330,7 @@ ret_t combo_box_set_custom_open_popup (widget_t* widget, combo_box_custom_open_p
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | combo\_box对象。 |
|
||||
| open\_popup | combo\_box\_custom\_open\_popup\_t | 回调函数。 |
|
||||
| on\_layout\_combobox\_popup | combo\_box\_custom\_on\_layout\_combobox\_popup\_t | layout 的回调函数。 |
|
||||
#### combo\_box\_set\_item\_height 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -9,14 +9,33 @@ conf ini对象。
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_ini_t_conf_ini_load">conf\_ini\_load</a> | |
|
||||
| <a href="#conf_ini_t_conf_ini_create">conf\_ini\_create</a> | 创建一个空的conf对象。 |
|
||||
| <a href="#conf_ini_t_conf_ini_load">conf\_ini\_load</a> | 从指定URL加载INI对象。 |
|
||||
| <a href="#conf_ini_t_conf_ini_save_as">conf\_ini\_save\_as</a> | 将doc对象保存到指定URL。 |
|
||||
#### conf\_ini\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_ini_t_conf_ini_create">创建一个空的conf对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_ini_create ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
#### conf\_ini\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_ini_t_conf_ini_load">
|
||||
> <p id="conf_ini_t_conf_ini_load">从指定URL加载INI对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
@ -9,14 +9,33 @@ conf json对象。
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | |
|
||||
| <a href="#conf_json_t_conf_json_create">conf\_json\_create</a> | 创建一个空的conf对象。 |
|
||||
| <a href="#conf_json_t_conf_json_load">conf\_json\_load</a> | 从指定URL加载JSON对象。 |
|
||||
| <a href="#conf_json_t_conf_json_save_as">conf\_json\_save\_as</a> | 将doc对象保存到指定URL。 |
|
||||
#### conf\_json\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_json_create">创建一个空的conf对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_json_create ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
#### conf\_json\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_json_t_conf_json_load">
|
||||
> <p id="conf_json_t_conf_json_load">从指定URL加载JSON对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
@ -9,14 +9,33 @@ conf json对象。
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#conf_ubjson_t_conf_ubjson_load">conf\_ubjson\_load</a> | |
|
||||
| <a href="#conf_ubjson_t_conf_ubjson_create">conf\_ubjson\_create</a> | 创建一个空的conf对象。 |
|
||||
| <a href="#conf_ubjson_t_conf_ubjson_load">conf\_ubjson\_load</a> | 从指定URL加载UBJSON对象。 |
|
||||
| <a href="#conf_ubjson_t_conf_ubjson_save_as">conf\_ubjson\_save\_as</a> | 将doc对象保存到指定URL。 |
|
||||
#### conf\_ubjson\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_ubjson_t_conf_ubjson_create">创建一个空的conf对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* conf_ubjson_create ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回配置对象。 |
|
||||
#### conf\_ubjson\_load 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="conf_ubjson_t_conf_ubjson_load">
|
||||
> <p id="conf_ubjson_t_conf_ubjson_load">从指定URL加载UBJSON对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
|
||||
138
docs/manual/crc_t.md
Normal file
138
docs/manual/crc_t.md
Normal file
@ -0,0 +1,138 @@
|
||||
## crc\_t
|
||||
### 概述
|
||||
crc相关函数。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="crc_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#crc_t_tk_chksum">tk\_chksum</a> | 计算检验和。 |
|
||||
| <a href="#crc_t_tk_chksum_byte">tk\_chksum\_byte</a> | 计算单子节的检验和。 |
|
||||
| <a href="#crc_t_tk_crc16">tk\_crc16</a> | 计算crc16。 |
|
||||
| <a href="#crc_t_tk_crc16_byte">tk\_crc16\_byte</a> | 计算单子节的crc16。 |
|
||||
| <a href="#crc_t_tk_crc32">tk\_crc32</a> | 计算crc32。 |
|
||||
| <a href="#crc_t_tk_crc32_byte">tk\_crc32\_byte</a> | 计算单子节的crc32。 |
|
||||
#### tk\_chksum 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_chksum">计算检验和。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint16_t tk_chksum (uint16_t sum, const uint8_t* data, int size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint16\_t | 返回计算结果。 |
|
||||
| sum | uint16\_t | 初始值(一般用INITCHECKSUM) |
|
||||
| data | const uint8\_t* | 数据。 |
|
||||
| size | int | 数据长度。 |
|
||||
#### tk\_chksum\_byte 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_chksum_byte">计算单子节的检验和。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint16_t tk_chksum_byte (uint16_t sum, uint8_t data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint16\_t | 返回计算结果。 |
|
||||
| sum | uint16\_t | 初始值(一般用0，或者之前的值) |
|
||||
| data | uint8\_t | 数据。 |
|
||||
#### tk\_crc16 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_crc16">计算crc16。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint16_t tk_crc16 (uint16_t crc, const uint8_t* data, int size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint16\_t | 返回计算结果。 |
|
||||
| crc | uint16\_t | 初始值(一般用PPPINITFCS16) |
|
||||
| data | const uint8\_t* | 数据。 |
|
||||
| size | int | 数据长度。 |
|
||||
#### tk\_crc16\_byte 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_crc16_byte">计算单子节的crc16。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint16_t tk_crc16_byte (uint16_t crc, uint8_t data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint16\_t | 返回计算结果。 |
|
||||
| crc | uint16\_t | 初始值(一般用PPPINITFCS16，或者之前的值) |
|
||||
| data | uint8\_t | 数据。 |
|
||||
#### tk\_crc32 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_crc32">计算crc32。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t tk_crc32 (uint32_t crc, const uint8_t* data, int size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回计算结果。 |
|
||||
| crc | uint32\_t | 初始值(一般用PPPINITFCS32) |
|
||||
| data | const uint8\_t* | 数据。 |
|
||||
| size | int | 数据长度。 |
|
||||
#### tk\_crc32\_byte 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="crc_t_tk_crc32_byte">计算单子节的crc32。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t tk_crc32_byte (uint32_t crc, uint8_t data);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回计算结果。 |
|
||||
| crc | uint32\_t | 初始值(一般用PPPINITFCS32，或者之前的值) |
|
||||
| data | uint8\_t | 数据。 |
|
||||
@ -86,14 +86,14 @@ void* darray_bsearch (darray_t* darray, tk_compare_t cmp, void* ctx);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int darray_bsearch_index (darray_t* darray, tk_compare_t cmp, void* ctx);
|
||||
int32_t darray_bsearch_index (darray_t* darray, tk_compare_t cmp, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 如果找到，返回满足条件的对象的位置，否则返回-1。 |
|
||||
| 返回值 | int32\_t | 如果找到，返回满足条件的对象的位置，否则返回-1。 |
|
||||
| darray | darray\_t* | 数组对象。 |
|
||||
| cmp | tk\_compare\_t | 比较函数，为NULL则使用内置的比较函数。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
@ -256,14 +256,14 @@ ret_t darray_find_all (darray_t* darray, tk_compare_t cmp, void* ctx, darray_t*
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int darray_find_index (darray_t* darray, void* ctx);
|
||||
int32_t darray_find_index (darray_t* darray, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 如果找到，返回满足条件的对象的位置，否则返回-1。 |
|
||||
| 返回值 | int32\_t | 如果找到，返回满足条件的对象的位置，否则返回-1。 |
|
||||
| darray | darray\_t* | 数组对象。 |
|
||||
| ctx | void* | 比较函数的上下文。 |
|
||||
#### darray\_foreach 函数
|
||||
@ -336,7 +336,7 @@ void* darray_head (darray_t* darray);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
darray_t* darray_init (darray_t* darray, uint32_t* capacity, tk_destroy_t destroy, tk_compare_t compare);
|
||||
darray_t* darray_init (darray_t* darray, uint32_t capacity, tk_destroy_t destroy, tk_compare_t compare);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -345,7 +345,7 @@ darray_t* darray_init (darray_t* darray, uint32_t* capacity, tk_destroy_t destro
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | darray\_t* | 数组对象。 |
|
||||
| darray | darray\_t* | 数组对象。 |
|
||||
| capacity | uint32\_t* | 数组的初始容量。 |
|
||||
| capacity | uint32\_t | 数组的初始容量。 |
|
||||
| destroy | tk\_destroy\_t | 元素销毁函数。 |
|
||||
| compare | tk\_compare\_t | 元素比较函数。 |
|
||||
#### darray\_pop 函数
|
||||
|
||||
59
docs/manual/data_reader_asset_t.md
Normal file
59
docs/manual/data_reader_asset_t.md
Normal file
@ -0,0 +1,59 @@
|
||||
## data\_reader\_asset\_t
|
||||
### 概述
|
||||
|
||||
|
||||
基于资源实现的 data_reader。通过 data_reader_factory 创建 reader 时，URL的格式如下(请用函数data_reader_asset_build_url生成)：
|
||||
|
||||
```
|
||||
asset://type/name
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_reader_asset_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_reader_asset_t_data_reader_asset_build_url">data\_reader\_asset\_build\_url</a> | 构造内存URL。 |
|
||||
| <a href="#data_reader_asset_t_data_reader_asset_create">data\_reader\_asset\_create</a> | 创建基于asset的data reader。 |
|
||||
#### data\_reader\_asset\_build\_url 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_asset_t_data_reader_asset_build_url">构造内存URL。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* data_reader_asset_build_url (const char* name, asset_type_t type, char* url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回URL。 |
|
||||
| name | const char* | 资源的名称。 |
|
||||
| type | asset\_type\_t | 资源的类型。 |
|
||||
| url | char* | 生成的URL。 |
|
||||
#### data\_reader\_asset\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_asset_t_data_reader_asset_create">创建基于asset的data reader。
|
||||
|
||||
> 不要直接调用，而是注册到 data\_reader\_factory后，通过data\_reader\_factory调用。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_reader_t* data_reader_asset_create (const char* assetname);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_reader\_t* | 返回data reader对象。 |
|
||||
| assetname | const char* | 资源的名称。 |
|
||||
@ -13,7 +13,6 @@ data reader工厂。
|
||||
| <a href="#data_reader_factory_t_data_reader_factory_destroy">data\_reader\_factory\_destroy</a> | 析构并释放data reader工厂对象。 |
|
||||
| <a href="#data_reader_factory_t_data_reader_factory_register">data\_reader\_factory\_register</a> | 注册data reader创建函数。 |
|
||||
| <a href="#data_reader_factory_t_data_reader_factory_set">data\_reader\_factory\_set</a> | 设置缺省的data reader工厂对象。 |
|
||||
| <a href="#data_reader_factory_t_data_reader_file_create">data\_reader\_file\_create</a> | 创建基于文件的data reader。 |
|
||||
#### data\_reader\_factory 函数
|
||||
-----------------------
|
||||
|
||||
@ -129,22 +128,3 @@ ret_t data_reader_factory_set (data_reader_factory_t* factory);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| factory | data\_reader\_factory\_t* | data reader工厂对象。 |
|
||||
#### data\_reader\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_factory_t_data_reader_file_create">创建基于文件的data reader。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_reader_t* data_reader_file_create (const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_reader\_t* | 返回data reader对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
|
||||
36
docs/manual/data_reader_file_t.md
Normal file
36
docs/manual/data_reader_file_t.md
Normal file
@ -0,0 +1,36 @@
|
||||
## data\_reader\_file\_t
|
||||
### 概述
|
||||
|
||||
|
||||
基于文件实现的 data_reader。通过 data_reader_factory 创建 reader 时，URL的格式如下(请用函数data_reader_file_build_url生成)：
|
||||
|
||||
```
|
||||
file://filename
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_reader_file_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_reader_file_t_data_reader_file_create">data\_reader\_file\_create</a> | 创建基于文件的data reader。 |
|
||||
#### data\_reader\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_file_t_data_reader_file_create">创建基于文件的data reader。
|
||||
> 不要直接调用，而是注册到 data\_reader\_factory后，通过data\_reader\_factory调用。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_reader_t* data_reader_file_create (const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_reader\_t* | 返回data reader对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
59
docs/manual/data_reader_mem_t.md
Normal file
59
docs/manual/data_reader_mem_t.md
Normal file
@ -0,0 +1,59 @@
|
||||
## data\_reader\_mem\_t
|
||||
### 概述
|
||||
|
||||
|
||||
基于内存实现的 data_reader。通过 data_reader_factory 创建 reader 时，URL的格式如下(请用函数data_reader_mem_build_url生成)：
|
||||
|
||||
```
|
||||
mem://addr:size
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_reader_mem_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_reader_mem_t_data_reader_mem_build_url">data\_reader\_mem\_build\_url</a> | 构造内存URL。 |
|
||||
| <a href="#data_reader_mem_t_data_reader_mem_create">data\_reader\_mem\_create</a> | 创建基于内存的 data reader。 |
|
||||
#### data\_reader\_mem\_build\_url 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_mem_t_data_reader_mem_build_url">构造内存URL。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* data_reader_mem_build_url (mem_t* mem, uint32_t size, char* url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回URL。 |
|
||||
| mem | mem\_t* | 内存的地址。 |
|
||||
| size | uint32\_t | 内存的长度。 |
|
||||
| url | char* | 生成的URL。 |
|
||||
#### data\_reader\_mem\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_reader_mem_t_data_reader_mem_create">创建基于内存的 data reader。
|
||||
|
||||
> 不要直接调用，而是注册到 data\_reader\_factory后，通过data\_reader\_factory调用。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_reader_t* data_reader_mem_create (const char* memname);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_reader\_t* | 返回data reader对象。 |
|
||||
| memname | const char* | 内存地址和大小的字符串格式表示 。 |
|
||||
@ -2,7 +2,7 @@
|
||||
### 概述
|
||||
数据读取接口。
|
||||
|
||||
>用于抽象flash等外部设备。
|
||||
>对可读的媒介，如内存、文件、flash、资源和其它媒介提供一个统一的读取接口。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_reader_t_methods">
|
||||
|
||||
@ -13,7 +13,6 @@ data writer工厂。
|
||||
| <a href="#data_writer_factory_t_data_writer_factory_destroy">data\_writer\_factory\_destroy</a> | 析构并释放data writer工厂对象。 |
|
||||
| <a href="#data_writer_factory_t_data_writer_factory_register">data\_writer\_factory\_register</a> | 注册data writer创建函数。 |
|
||||
| <a href="#data_writer_factory_t_data_writer_factory_set">data\_writer\_factory\_set</a> | 设置缺省的data writer工厂对象。 |
|
||||
| <a href="#data_writer_factory_t_data_writer_file_create">data\_writer\_file\_create</a> | 创建基于文件的data writer。 |
|
||||
#### data\_writer\_factory 函数
|
||||
-----------------------
|
||||
|
||||
@ -129,22 +128,3 @@ ret_t data_writer_factory_set (data_writer_factory_t* factory);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| factory | data\_writer\_factory\_t* | data writer工厂对象。 |
|
||||
#### data\_writer\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_factory_t_data_writer_file_create">创建基于文件的data writer。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_writer_t* data_writer_file_create (const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_writer\_t* | 返回data writer对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
|
||||
37
docs/manual/data_writer_file_t.md
Normal file
37
docs/manual/data_writer_file_t.md
Normal file
@ -0,0 +1,37 @@
|
||||
## data\_writer\_file\_t
|
||||
### 概述
|
||||
|
||||
|
||||
基于文件实现的 data_writer。通过 data_writer_factory 创建 writer 时，URL的格式如下：
|
||||
|
||||
```
|
||||
file://filename
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_writer_file_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_writer_file_t_data_writer_file_create">data\_writer\_file\_create</a> | 创建基于文件的data writer。 |
|
||||
#### data\_writer\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_file_t_data_writer_file_create">创建基于文件的data writer。
|
||||
|
||||
> 不要直接调用，而是注册到 data\_writer\_factory后，通过data\_writer\_factory调用
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_writer_t* data_writer_file_create (const char* filename);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_writer\_t* | 返回data writer对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
@ -2,7 +2,7 @@
|
||||
### 概述
|
||||
数据写入接口。
|
||||
|
||||
>用于抽象flash等外部设备。
|
||||
>对可写的媒介，如内存、文件、flash和其它媒介提供一个统一的写入接口。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_writer_t_methods">
|
||||
|
||||
58
docs/manual/data_writer_wbuffer_t.md
Normal file
58
docs/manual/data_writer_wbuffer_t.md
Normal file
@ -0,0 +1,58 @@
|
||||
## data\_writer\_wbuffer\_t
|
||||
### 概述
|
||||
|
||||
|
||||
基于内存实现的 data_writer。通过 data_writer_factory 创建 writer 时，URL的格式如下(请用函数data_writer_wbuffer_build_url生成)：
|
||||
|
||||
```
|
||||
wbuffer://addr
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="data_writer_wbuffer_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#data_writer_wbuffer_t_data_writer_wbuffer_build_url">data\_writer\_wbuffer\_build\_url</a> | 构造wbuffer的URL。 |
|
||||
| <a href="#data_writer_wbuffer_t_data_writer_wbuffer_create">data\_writer\_wbuffer\_create</a> | 创建基于wbuffer的data writer。 |
|
||||
#### data\_writer\_wbuffer\_build\_url 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_wbuffer_t_data_writer_wbuffer_build_url">构造wbuffer的URL。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* data_writer_wbuffer_build_url (wbuffer_t* wbuffer, char* url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回URL。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| url | char* | 生成的URL。 |
|
||||
#### data\_writer\_wbuffer\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="data_writer_wbuffer_t_data_writer_wbuffer_create">创建基于wbuffer的data writer。
|
||||
|
||||
> 不要直接调用，而是注册到 data\_writer\_factory后，通过data\_writer\_factory调用
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
data_writer_t* data_writer_wbuffer_create (const char* wbuffer_name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | data\_writer\_t* | 返回data writer对象。 |
|
||||
| wbuffer\_name | const char* | wbuffer地址的字符串格式表示 。 |
|
||||
@ -21,6 +21,13 @@
|
||||
| <a href="#date_time_t_date_time_init">date\_time\_init</a> | 初始为当前日期和时间。 |
|
||||
| <a href="#date_time_t_date_time_is_leap">date\_time\_is\_leap</a> | 是否是闰年。 |
|
||||
| <a href="#date_time_t_date_time_set">date\_time\_set</a> | 设置当前时间。 |
|
||||
| <a href="#date_time_t_date_time_set_day">date\_time\_set\_day</a> | 设置日。 |
|
||||
| <a href="#date_time_t_date_time_set_hour">date\_time\_set\_hour</a> | 设置小时。 |
|
||||
| <a href="#date_time_t_date_time_set_minute">date\_time\_set\_minute</a> | 设置分钟。 |
|
||||
| <a href="#date_time_t_date_time_set_month">date\_time\_set\_month</a> | 设置月。 |
|
||||
| <a href="#date_time_t_date_time_set_second">date\_time\_set\_second</a> | 设置秒。 |
|
||||
| <a href="#date_time_t_date_time_set_year">date\_time\_set\_year</a> | 设置年。 |
|
||||
| <a href="#date_time_t_date_time_to_time">date\_time\_to\_time</a> | 转换成time。 |
|
||||
### 属性
|
||||
<p id="date_time_t_properties">
|
||||
|
||||
@ -267,6 +274,145 @@ ret_t date_time_set (date_time_t* dt);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
#### date\_time\_set\_day 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_day">设置日。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_day (date_time_t* dt, uint32_t day);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| day | uint32\_t | 日。 |
|
||||
#### date\_time\_set\_hour 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_hour">设置小时。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_hour (date_time_t* dt, uint32_t hour);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| hour | uint32\_t | 小时。 |
|
||||
#### date\_time\_set\_minute 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_minute">设置分钟。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_minute (date_time_t* dt, uint32_t minute);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| minute | uint32\_t | 分钟。 |
|
||||
#### date\_time\_set\_month 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_month">设置月。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_month (date_time_t* dt, uint32_t month);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| month | uint32\_t | 月。 |
|
||||
#### date\_time\_set\_second 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_second">设置秒。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_second (date_time_t* dt, uint32_t second);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| second | uint32\_t | 秒。 |
|
||||
#### date\_time\_set\_year 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_set_year">设置年。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t date_time_set_year (date_time_t* dt, uint32_t year);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
| year | uint32\_t | 年。 |
|
||||
#### date\_time\_to\_time 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="date_time_t_date_time_to_time">转换成time。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint64_t date_time_to_time (date_time_t* dt);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint64\_t | 返回time。 |
|
||||
| dt | date\_time\_t* | date\_time对象。 |
|
||||
#### day 属性
|
||||
-----------------------
|
||||
> <p id="date_time_t_day">日(1-31)。
|
||||
|
||||
@ -366,7 +366,7 @@ ret_t emitter_off_by_tag (emitter_t* emitter, uint32_t tag);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t emitter_on (emitter_t* emitter, event_type_t type, event_func_t on_event, void* ctx);
|
||||
uint32_t emitter_on (emitter_t* emitter, event_type_t etype, event_func_t handler, void* ctx);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -375,8 +375,8 @@ uint32_t emitter_on (emitter_t* emitter, event_type_t type, event_func_t on_even
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回id，用于emitter\_off。 |
|
||||
| emitter | emitter\_t* | emitter对象。 |
|
||||
| type | event\_type\_t | 事件类型。 |
|
||||
| on\_event | event\_func\_t | 事件处理函数。 |
|
||||
| etype | event\_type\_t | 事件类型。 |
|
||||
| handler | event\_func\_t | 事件处理函数。 |
|
||||
| ctx | void* | 事件处理函数上下文。 |
|
||||
#### emitter\_on\_with\_tag 函数
|
||||
-----------------------
|
||||
|
||||
@ -88,6 +88,10 @@
|
||||
| EVT\_SCROLL\_END | scroll view结束滚动(event\_t)。 |
|
||||
| EVT\_MULTI\_GESTURE | 多点触摸手势(multi\_gesture\_event\_t)。 |
|
||||
| EVT\_PAGE\_CHANGED | 页面改变了(event\_t)。 |
|
||||
| EVT\_ASSET\_MANAGER\_LOAD\_ASSET | 资源管理加载某个资源(assets\_event\_t)。 |
|
||||
| EVT\_ASSET\_MANAGER\_UNLOAD\_ASSET | 资源管理卸载某个资源(assets\_event\_t)。 |
|
||||
| EVT\_ASSET\_MANAGER\_CLEAR\_CACHE | 资源管理移除同种资源缓存(assets\_event\_t)。 |
|
||||
| EVT\_TIMER | 定时器(event\_t)。 |
|
||||
| EVT\_REQ\_START | event queue其它请求编号起始值。 |
|
||||
| EVT\_USER\_START | 用户定义事件起始值。 |
|
||||
| EVT\_NONE | 无效事件名称。 |
|
||||
|
||||
@ -13,6 +13,27 @@ stb主要用于加载矢量字体(如truetype)，它功能强大，体积小巧
|
||||
| -------- | ------------ |
|
||||
| <a href="#font_loader_stb_t_font_loader_stb">font\_loader\_stb</a> | 获取stb字体加载器对象。 |
|
||||
| <a href="#font_loader_stb_t_font_stb_create">font\_stb\_create</a> | 创建stb字体对象。 |
|
||||
| <a href="#font_loader_stb_t_fscript_app_conf_register">fscript\_app\_conf\_register</a> | 注册app_conf函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_array_register">fscript\_array\_register</a> | 注册typed array函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_bits_register">fscript\_bits\_register</a> | 注册数学函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_crc_register">fscript\_crc\_register</a> | 注册crc16/crc32/cksum等函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_date_time_register">fscript\_date\_time\_register</a> | 注册date time函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_endian_register">fscript\_endian\_register</a> | 注册大端小断转换函数等函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_ext_init">fscript\_ext\_init</a> | 注册扩展函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_fs_register">fscript\_fs\_register</a> | 注册文件系统函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_iostream_file_register">fscript\_iostream\_file\_register</a> | 注册iostream_file相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_iostream_inet_register">fscript\_iostream\_inet\_register</a> | 注册iostream_inet相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_iostream_register">fscript\_iostream\_register</a> | 注册iostream相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_iostream_serial_register">fscript\_iostream\_serial\_register</a> | 注册iostream_serial相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_istream_register">fscript\_istream\_register</a> | 注册istream相关等函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_json_register">fscript\_json\_register</a> | 注册json函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_math_register">fscript\_math\_register</a> | 注册数学函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_object_register">fscript\_object\_register</a> | 注册object函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_ostream_register">fscript\_ostream\_register</a> | 注册ostream相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_rbuffer_register">fscript\_rbuffer\_register</a> | 注册rbuffer相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_typed_array_register">fscript\_typed\_array\_register</a> | 注册typed array函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_wbuffer_register">fscript\_wbuffer\_register</a> | 注册wbuffer相关函数。 |
|
||||
| <a href="#font_loader_stb_t_fscript_widget_register">fscript\_widget\_register</a> | 注册widget函数。 |
|
||||
#### font\_loader\_stb 函数
|
||||
-----------------------
|
||||
|
||||
@ -52,3 +73,381 @@ font_t* font_stb_create (const char* name, const uint8_t* buff , uint32_t size);
|
||||
| name | const char* | 字体名称。 |
|
||||
| | const uint8\_t* buff | 。 |
|
||||
| size | uint32\_t | 字体数据长度。 |
|
||||
#### fscript\_app\_conf\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_app_conf_register">注册app_conf函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_app_conf_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_array\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_array_register">注册typed array函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_array_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_bits\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_bits_register">注册数学函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_bits_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_crc\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_crc_register">注册crc16/crc32/cksum等函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_crc_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_date\_time\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_date_time_register">注册date time函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_date_time_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_endian\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_endian_register">注册大端小断转换函数等函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_endian_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_ext\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_ext_init">注册扩展函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_ext_init ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_fs\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_fs_register">注册文件系统函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_fs_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_iostream\_file\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_iostream_file_register">注册iostream_file相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_iostream_file_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_iostream\_inet\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_iostream_inet_register">注册iostream_inet相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_iostream_inet_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_iostream\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_iostream_register">注册iostream相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_iostream_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_iostream\_serial\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_iostream_serial_register">注册iostream_serial相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_iostream_serial_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_istream\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_istream_register">注册istream相关等函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_istream_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_json\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_json_register">注册json函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_json_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_math\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_math_register">注册数学函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_math_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_object\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_object_register">注册object函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_object_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_ostream\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_ostream_register">注册ostream相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_ostream_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_rbuffer\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_rbuffer_register">注册rbuffer相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_rbuffer_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_typed\_array\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_typed_array_register">注册typed array函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_typed_array_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_wbuffer\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_wbuffer_register">注册wbuffer相关函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_wbuffer_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### fscript\_widget\_register 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="font_loader_stb_t_fscript_widget_register">注册widget函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_widget_register ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
|
||||
@ -27,6 +27,7 @@ fs_file_close(fp);
|
||||
| <a href="#fs_file_t_fs_file_eof">fs\_file\_eof</a> | 判断文件是否结束。 |
|
||||
| <a href="#fs_file_t_fs_file_printf">fs\_file\_printf</a> | 写入文件。 |
|
||||
| <a href="#fs_file_t_fs_file_read">fs\_file\_read</a> | 读取文件。 |
|
||||
| <a href="#fs_file_t_fs_file_read_line">fs\_file\_read\_line</a> | 读取一行文本。 |
|
||||
| <a href="#fs_file_t_fs_file_seek">fs\_file\_seek</a> | 定位读写指针到指定的位置。 |
|
||||
| <a href="#fs_file_t_fs_file_size">fs\_file\_size</a> | 获取文件大小。 |
|
||||
| <a href="#fs_file_t_fs_file_stat">fs\_file\_stat</a> | 获取文件信息。 |
|
||||
@ -113,6 +114,28 @@ int32_t fs_file_read (fs_file_t* file, void* buffer, uint32_t size);
|
||||
| file | fs\_file\_t* | 文件对象。 |
|
||||
| buffer | void* | 用于返回数据的缓冲区。 |
|
||||
| size | uint32\_t | 缓冲区大小。 |
|
||||
#### fs\_file\_read\_line 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_file_t_fs_file_read_line">读取一行文本。
|
||||
> 需要用二进制格式打开，否则Windows下，系统会修改换行符。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t fs_file_read_line (fs_file_t* file, char* buffer, uint32_t size);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回实际读取的字节数。 |
|
||||
| file | fs\_file\_t* | 文件对象。 |
|
||||
| buffer | char* | 用于返回数据的缓冲区。 |
|
||||
| size | uint32\_t | 缓冲区大小。 |
|
||||
#### fs\_file\_seek 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -13,7 +13,10 @@
|
||||
| <a href="#fs_t_file_read_part">file\_read\_part</a> | 从某个位置读取文件。 |
|
||||
| <a href="#fs_t_file_remove">file\_remove</a> | 刪除文件。 |
|
||||
| <a href="#fs_t_file_write">file\_write</a> | 写入文件。 |
|
||||
| <a href="#fs_t_fs_build_user_storage_file_name">fs\_build\_user\_storage\_file\_name</a> | 生成一个保存数据文件的完整路径的文件名。 |
|
||||
| <a href="#fs_t_fs_change_dir">fs\_change\_dir</a> | 修改当前目录。 |
|
||||
| <a href="#fs_t_fs_create_dir">fs\_create\_dir</a> | 创建目录。 |
|
||||
| <a href="#fs_t_fs_create_dir_r">fs\_create\_dir\_r</a> | 递归创建目录。 |
|
||||
| <a href="#fs_t_fs_dir_exist">fs\_dir\_exist</a> | 判断目录是否存在。 |
|
||||
| <a href="#fs_t_fs_dir_rename">fs\_dir\_rename</a> | 目录重命名。 |
|
||||
| <a href="#fs_t_fs_file_exist">fs\_file\_exist</a> | 判断文件是否存在。 |
|
||||
@ -22,10 +25,12 @@
|
||||
| <a href="#fs_t_fs_get_disk_info">fs\_get\_disk\_info</a> | 获取文件系统信息。 |
|
||||
| <a href="#fs_t_fs_get_exe">fs\_get\_exe</a> | 获取可执行文件所在目录。 |
|
||||
| <a href="#fs_t_fs_get_file_size">fs\_get\_file\_size</a> | 获取文件大小。 |
|
||||
| <a href="#fs_t_fs_get_temp_path">fs\_get\_temp\_path</a> | 获取临时目录。 |
|
||||
| <a href="#fs_t_fs_get_user_storage_path">fs\_get\_user\_storage\_path</a> | 获取home目录或者应用程序可以写入数据的目录。 |
|
||||
| <a href="#fs_t_fs_open_dir">fs\_open\_dir</a> | 打开目录。 |
|
||||
| <a href="#fs_t_fs_open_file">fs\_open\_file</a> | 打开文件。 |
|
||||
| <a href="#fs_t_fs_remove_dir">fs\_remove\_dir</a> | 刪除目录。 |
|
||||
| <a href="#fs_t_fs_remove_dir_r">fs\_remove\_dir\_r</a> | 递归刪除目录。 |
|
||||
| <a href="#fs_t_fs_remove_file">fs\_remove\_file</a> | 刪除文件。 |
|
||||
| <a href="#fs_t_fs_stat">fs\_stat</a> | 获取文件信息。 |
|
||||
| <a href="#fs_t_os_fs">os\_fs</a> | 获取缺省的文件系统对象。 |
|
||||
@ -149,6 +154,47 @@ ret_t file_write (const char* name, const void* buffer, uint32_t size);
|
||||
| name | const char* | 文件名。 |
|
||||
| buffer | const void* | 数据缓冲区。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
#### fs\_build\_user\_storage\_file\_name 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_t_fs_build_user_storage_file_name">生成一个保存数据文件的完整路径的文件名。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fs_build_user_storage_file_name (char* filename, const char* appname, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| filename | char* | 用于返回完整路径的文件名。 |
|
||||
| appname | const char* | 应用程序的名称。 |
|
||||
| name | const char* | 文件名(不包括路径)。 |
|
||||
#### fs\_change\_dir 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_t_fs_change_dir">修改当前目录。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fs_change_dir (fs_t* fs, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fs | fs\_t* | 文件系统对象，一般赋值为os\_fs()。 |
|
||||
| name | const char* | 目录名称。 |
|
||||
#### fs\_create\_dir 函数
|
||||
-----------------------
|
||||
|
||||
@ -164,6 +210,26 @@ ret_t fs_create_dir (fs_t* fs, const char* name);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fs | fs\_t* | 文件系统对象，一般赋值为os\_fs()。 |
|
||||
| name | const char* | 目录名称。 |
|
||||
#### fs\_create\_dir\_r 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_t_fs_create_dir_r">递归创建目录。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fs_create_dir_r (fs_t* fs, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
@ -333,6 +399,26 @@ ret_t fs_get_file_size (fs_t* fs, const char* name);
|
||||
| 返回值 | ret\_t | 返回不是-1表示成功，否则表示失败。 |
|
||||
| fs | fs\_t* | 文件系统对象，一般赋值为os\_fs()。 |
|
||||
| name | const char* | 文件名。 |
|
||||
#### fs\_get\_temp\_path 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_t_fs_get_temp_path">获取临时目录。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fs_get_temp_path (fs_t* fs, char* path);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fs | fs\_t* | 文件系统对象，一般赋值为os\_fs()。 |
|
||||
| path | char* | 保存路径。 |
|
||||
#### fs\_get\_user\_storage\_path 函数
|
||||
-----------------------
|
||||
|
||||
@ -409,6 +495,26 @@ ret_t fs_remove_dir (fs_t* fs, const char* name);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fs | fs\_t* | 文件系统对象，一般赋值为os\_fs()。 |
|
||||
| name | const char* | 目录名称。 |
|
||||
#### fs\_remove\_dir\_r 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fs_t_fs_remove_dir_r">递归刪除目录。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fs_remove_dir_r (fs_t* fs, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
|
||||
@ -8,13 +8,14 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#fscript_t_fscript_create">fscript\_create</a> | 创建引擎对象。 |
|
||||
| <a href="#fscript_t_fscript_create">fscript\_create</a> | 创建引擎对象，并解析代码。 |
|
||||
| <a href="#fscript_t_fscript_destroy">fscript\_destroy</a> | 销毁引擎对象。 |
|
||||
| <a href="#fscript_t_fscript_eval">fscript\_eval</a> | 执行一段脚本。 |
|
||||
| <a href="#fscript_t_fscript_exec">fscript\_exec</a> | |
|
||||
| <a href="#fscript_t_fscript_exec">fscript\_exec</a> | 执行解析后的代码。 |
|
||||
| <a href="#fscript_t_fscript_global_deinit">fscript\_global\_deinit</a> | 全局释放。 |
|
||||
| <a href="#fscript_t_fscript_global_init">fscript\_global\_init</a> | 全局初始化。 |
|
||||
| <a href="#fscript_t_fscript_register_func">fscript\_register\_func</a> | 注册全局自定义函数。 |
|
||||
| <a href="#fscript_t_fscript_set_error">fscript\_set\_error</a> | 用于扩展函数设置遇到的错误。 |
|
||||
### 属性
|
||||
<p id="fscript_t_properties">
|
||||
|
||||
@ -28,7 +29,7 @@
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fscript_t_fscript_create">创建引擎对象。
|
||||
> <p id="fscript_t_fscript_create">创建引擎对象，并解析代码。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -88,7 +89,7 @@ ret_t fscript_eval (object_t* obj, const char* script, value_t* result);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fscript_t_fscript_exec">
|
||||
> <p id="fscript_t_fscript_exec">执行解析后的代码。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -159,6 +160,28 @@ ret_t fscript_register_func (const char* name, fscript_func_t* func);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| name | const char* | 函数名(无需加函数前缀)。 |
|
||||
| func | fscript\_func\_t* | 函数指针。 |
|
||||
#### fscript\_set\_error 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="fscript_t_fscript_set_error">用于扩展函数设置遇到的错误。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t fscript_set_error (fscript_t* fscript, ret_t code, const char* func, const char* message);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| fscript | fscript\_t* | 脚本引擎对象。 |
|
||||
| code | ret\_t | 错误码。 |
|
||||
| func | const char* | 函数名。 |
|
||||
| message | const char* | 错误消息。 |
|
||||
#### fast\_vars 属性
|
||||
-----------------------
|
||||
> <p id="fscript_t_fast_vars">快速访问变量。在脚本可以用a/b/c/d来访问，需要优化时使用。
|
||||
|
||||
@ -57,12 +57,12 @@ image_value_set_value(image_value, 100);
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#image_value_t_click_add_delta">click\_add\_delta</a> | float\_t | 点击时加上一个增量。 |
|
||||
| <a href="#image_value_t_click_add_delta">click\_add\_delta</a> | double | 点击时加上一个增量。 |
|
||||
| <a href="#image_value_t_format">format</a> | char* | 数值到字符串转换时的格式，缺省为"%d"。 |
|
||||
| <a href="#image_value_t_image">image</a> | char* | 图片名称的前缀。 |
|
||||
| <a href="#image_value_t_max">max</a> | float\_t | 最大值(如果设置了click\_add\_delta，到达最大值后回到最小值)。 |
|
||||
| <a href="#image_value_t_min">min</a> | float\_t | 最小值(如果设置了click\_add\_delta，到达最小值后回到最大值)。 |
|
||||
| <a href="#image_value_t_value">value</a> | float\_t | 值。 |
|
||||
| <a href="#image_value_t_max">max</a> | double | 最大值(如果设置了click\_add\_delta，到达最大值后回到最小值)。 |
|
||||
| <a href="#image_value_t_min">min</a> | double | 最小值(如果设置了click\_add\_delta，到达最小值后回到最大值)。 |
|
||||
| <a href="#image_value_t_value">value</a> | double | 值。 |
|
||||
### 事件
|
||||
<p id="image_value_t_events">
|
||||
|
||||
@ -122,7 +122,7 @@ widget_t* image_value_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t image_value_set_click_add_delta (widget_t* widget, float_t delta);
|
||||
ret_t image_value_set_click_add_delta (widget_t* widget, double delta);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -131,7 +131,7 @@ ret_t image_value_set_click_add_delta (widget_t* widget, float_t delta);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
| delta | float\_t | 增量。 |
|
||||
| delta | double | 增量。 |
|
||||
#### image\_value\_set\_format 函数
|
||||
-----------------------
|
||||
|
||||
@ -182,7 +182,7 @@ ret_t image_value_set_image (widget_t* widget, const char* image);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t image_value_set_max (widget_t* widget, float_t max);
|
||||
ret_t image_value_set_max (widget_t* widget, double max);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -191,7 +191,7 @@ ret_t image_value_set_max (widget_t* widget, float_t max);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_max对象。 |
|
||||
| max | float\_t | 最大值。 |
|
||||
| max | double | 最大值。 |
|
||||
#### image\_value\_set\_min 函数
|
||||
-----------------------
|
||||
|
||||
@ -202,7 +202,7 @@ ret_t image_value_set_max (widget_t* widget, float_t max);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t image_value_set_min (widget_t* widget, float_t min);
|
||||
ret_t image_value_set_min (widget_t* widget, double min);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -211,7 +211,7 @@ ret_t image_value_set_min (widget_t* widget, float_t min);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_min对象。 |
|
||||
| min | float\_t | 最小值。 |
|
||||
| min | double | 最小值。 |
|
||||
#### image\_value\_set\_value 函数
|
||||
-----------------------
|
||||
|
||||
@ -222,7 +222,7 @@ ret_t image_value_set_min (widget_t* widget, float_t min);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t image_value_set_value (widget_t* widget, float_t value);
|
||||
ret_t image_value_set_value (widget_t* widget, double value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -231,12 +231,12 @@ ret_t image_value_set_value (widget_t* widget, float_t value);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | image\_value对象。 |
|
||||
| value | float\_t | 值。 |
|
||||
| value | double | 值。 |
|
||||
#### click\_add\_delta 属性
|
||||
-----------------------
|
||||
> <p id="image_value_t_click_add_delta">点击时加上一个增量。
|
||||
|
||||
* 类型：float\_t
|
||||
* 类型：double
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
@ -284,7 +284,7 @@ ret_t image_value_set_value (widget_t* widget, float_t value);
|
||||
-----------------------
|
||||
> <p id="image_value_t_max">最大值(如果设置了click\_add\_delta，到达最大值后回到最小值)。
|
||||
|
||||
* 类型：float\_t
|
||||
* 类型：double
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
@ -300,7 +300,7 @@ ret_t image_value_set_value (widget_t* widget, float_t value);
|
||||
-----------------------
|
||||
> <p id="image_value_t_min">最小值(如果设置了click\_add\_delta，到达最小值后回到最大值)。
|
||||
|
||||
* 类型：float\_t
|
||||
* 类型：double
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
@ -316,7 +316,7 @@ ret_t image_value_set_value (widget_t* widget, float_t value);
|
||||
-----------------------
|
||||
> <p id="image_value_t_value">值。
|
||||
|
||||
* 类型：float\_t
|
||||
* 类型：double
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
|
||||
BIN
docs/manual/images/assets_event_t_0.png
Normal file
BIN
docs/manual/images/assets_event_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/manual/images/assets_manager_t_0.png
Normal file
BIN
docs/manual/images/assets_manager_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
BIN
docs/manual/images/data_reader_asset_t_0.png
Normal file
BIN
docs/manual/images/data_reader_asset_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.4 KiB |
BIN
docs/manual/images/data_reader_file_t_0.png
Normal file
BIN
docs/manual/images/data_reader_file_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
BIN
docs/manual/images/data_reader_mem_t_0.png
Normal file
BIN
docs/manual/images/data_reader_mem_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.3 KiB |
BIN
docs/manual/images/data_writer_file_t_0.png
Normal file
BIN
docs/manual/images/data_writer_file_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
BIN
docs/manual/images/data_writer_wbuffer_t_0.png
Normal file
BIN
docs/manual/images/data_writer_wbuffer_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
BIN
docs/manual/images/object_date_time_t_0.png
Normal file
BIN
docs/manual/images/object_date_time_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.7 KiB |
BIN
docs/manual/images/object_rbuffer_t_0.png
Normal file
BIN
docs/manual/images/object_rbuffer_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.5 KiB |
BIN
docs/manual/images/object_typed_array_t_0.png
Normal file
BIN
docs/manual/images/object_typed_array_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.1 KiB |
BIN
docs/manual/images/object_wbuffer_t_0.png
Normal file
BIN
docs/manual/images/object_wbuffer_t_0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.6 KiB |
@ -16,9 +16,16 @@
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#input_engine_t_input_engine_add_candidate">input\_engine\_add\_candidate</a> | 给输入法引擎对象加入一个候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_add_candidates_from_char">input\_engine\_add\_candidates\_from\_char</a> | 根据字符类型给输入法引擎对象加入所有符合的候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_add_candidates_from_string">input\_engine\_add\_candidates\_from\_string</a> | 根据字符串给输入法引擎对象加入所有符合的候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_create">input\_engine\_create</a> | 创建输入法引擎对象。 |
|
||||
| <a href="#input_engine_t_input_engine_deinit">input\_engine\_deinit</a> | 释放输入法引擎对象。 |
|
||||
| <a href="#input_engine_t_input_engine_destroy">input\_engine\_destroy</a> | 销毁输入法引擎对象。 |
|
||||
| <a href="#input_engine_t_input_engine_dispatch_candidates">input\_engine\_dispatch\_candidates</a> | 请求显示候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_init">input\_engine\_init</a> | 初始化输入法引擎对象。 |
|
||||
| <a href="#input_engine_t_input_engine_input">input\_engine\_input</a> | 输入新的按键，并更新候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_reset_candidates">input\_engine\_reset\_candidates</a> | 重置输入法引擎对象。 |
|
||||
| <a href="#input_engine_t_input_engine_reset_input">input\_engine\_reset\_input</a> | 清除所有输入的按键组合和候选字。 |
|
||||
| <a href="#input_engine_t_input_engine_search">input\_engine\_search</a> | 根据按键组合，更新候选字，并通过输入法对象提交候选字和pre候选字。 |
|
||||
### 属性
|
||||
@ -26,6 +33,70 @@
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
#### input\_engine\_add\_candidate 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_add_candidate">给输入法引擎对象加入一个候选字。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_add_candidate (input_engine_t* engine);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
#### input\_engine\_add\_candidates\_from\_char 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_add_candidates_from_char">根据字符类型给输入法引擎对象加入所有符合的候选字。
|
||||
备注：搜索表是二维数组，需要通过参数 c 来确定使用具体行数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_add_candidates_from_char (input_engine_t* engine, const wchar_t** table, char c);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
| table | const wchar\_t** | 输入法搜索表。 |
|
||||
| c | char | 需要显示查询的字符。 |
|
||||
#### input\_engine\_add\_candidates\_from\_string 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_add_candidates_from_string">根据字符串给输入法引擎对象加入所有符合的候选字。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_add_candidates_from_string (input_engine_t* engine, const table_entry_t* items, uint32_t items_nr, const char* key, bool_t exact);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
| items | const table\_entry\_t* | 输入法搜索表。 |
|
||||
| items\_nr | uint32\_t | 输入法搜索表长度。 |
|
||||
| key | const char* | 需要显示查询的字符。 |
|
||||
| exact | bool\_t | 是否只查询完全匹配的字符串。 |
|
||||
#### input\_engine\_create 函数
|
||||
-----------------------
|
||||
|
||||
@ -45,6 +116,25 @@ input_engine_t* input_engine_create (input_method_t* im);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | input\_engine\_t* | 返回输入法引擎对象。 |
|
||||
| im | input\_method\_t* | 输入法对象。 |
|
||||
#### input\_engine\_deinit 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_deinit">释放输入法引擎对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_deinit (input_engine_t* engine);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
#### input\_engine\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
@ -60,6 +150,45 @@ ret_t input_engine_destroy (input_engine_t* engine);
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
#### input\_engine\_dispatch\_candidates 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_dispatch_candidates">请求显示候选字。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_dispatch_candidates (input_engine_t* engine, int32_t selected);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
| selected | int32\_t | 缺省选中候选字的序数。 |
|
||||
#### input\_engine\_init 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_init">初始化输入法引擎对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_init (input_engine_t* engine);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
@ -84,6 +213,25 @@ ret_t input_engine_input (input_engine_t* engine, int key);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
| key | int | 键值。 |
|
||||
#### input\_engine\_reset\_candidates 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="input_engine_t_input_engine_reset_candidates">重置输入法引擎对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t input_engine_reset_candidates (input_engine_t* engine);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| engine | input\_engine\_t* | 输入法引擎对象。 |
|
||||
#### input\_engine\_reset\_input 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
79
docs/manual/mmap_t.md
Normal file
79
docs/manual/mmap_t.md
Normal file
@ -0,0 +1,79 @@
|
||||
## mmap\_t
|
||||
### 概述
|
||||
把文件内容映射到内存。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="mmap_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#mmap_t_mmap_create">mmap\_create</a> | 初始化mmap对象。 |
|
||||
| <a href="#mmap_t_mmap_destroy">mmap\_destroy</a> | 销毁mmap。 |
|
||||
### 属性
|
||||
<p id="mmap_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#mmap_t_data">data</a> | void* | 内存地址。 |
|
||||
| <a href="#mmap_t_size">size</a> | uint32\_t | 数据长度。 |
|
||||
#### mmap\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="mmap_t_mmap_create">初始化mmap对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
mmap_t* mmap_create (mmap_t* mmap, const char* filename, bool_t writable, bool_t shared);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | mmap\_t* | mmap对象本身。 |
|
||||
| mmap | mmap\_t* | mmap对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
| writable | bool\_t | 是否可写。 |
|
||||
| shared | bool\_t | 是否共享。 |
|
||||
#### mmap\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="mmap_t_mmap_destroy">销毁mmap。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t mmap_destroy (mmap_t* mmap);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| mmap | mmap\_t* | mmap对象。 |
|
||||
#### data 属性
|
||||
-----------------------
|
||||
> <p id="mmap_t_data">内存地址。
|
||||
|
||||
* 类型：void*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### size 属性
|
||||
-----------------------
|
||||
> <p id="mmap_t_size">数据长度。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
@ -17,9 +17,7 @@
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#multi_gesture_event_t_distance">distance</a> | float | 两点间的距离增量。(-1,0)表示缩小，(0-1)表示增加。 |
|
||||
| <a href="#multi_gesture_event_t_fingers">fingers</a> | uint32\_t | 本事件用到手指数。 |
|
||||
| <a href="#multi_gesture_event_t_rotation">rotation</a> | float | 旋转角度(幅度)增量。 |
|
||||
| <a href="#multi_gesture_event_t_touch_id">touch\_id</a> | int64\_t | touch device id。 |
|
||||
| <a href="#multi_gesture_event_t_rotation">rotation</a> | float | 旋转角度(幅度)增量。（单位弧度） |
|
||||
| <a href="#multi_gesture_event_t_x">x</a> | xy\_t | 中心点x坐标。 |
|
||||
| <a href="#multi_gesture_event_t_y">y</a> | xy\_t | 中心点y坐标。 |
|
||||
#### multi\_gesture\_event\_cast 函数
|
||||
@ -51,7 +49,7 @@ multi_gesture_event_t* multi_gesture_event_cast (event_t* event);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
event_t* multi_gesture_event_init (multi_gesture_event_t* event, void* target, uint32_t touch_id, int32_t x, int32_t y, float rotation, float distance, uint32_t fingers);
|
||||
event_t* multi_gesture_event_init (multi_gesture_event_t* event, void* target, int32_t x, int32_t y, float rotation, float distance);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -61,29 +59,16 @@ event_t* multi_gesture_event_init (multi_gesture_event_t* event, void* target, u
|
||||
| 返回值 | event\_t* | event对象。 |
|
||||
| event | multi\_gesture\_event\_t* | event对象。 |
|
||||
| target | void* | 事件目标。 |
|
||||
| touch\_id | uint32\_t | touch device id。 |
|
||||
| x | int32\_t | x的值。 |
|
||||
| y | int32\_t | y的值。 |
|
||||
| rotation | float | 旋转角度(幅度)增量。 |
|
||||
| distance | float | 两点间的距离增量。(-1,0)表示缩小，(0-1)表示增加。 |
|
||||
| fingers | uint32\_t | 本事件用到手指数。 |
|
||||
#### distance 属性
|
||||
-----------------------
|
||||
> <p id="multi_gesture_event_t_distance">两点间的距离增量。(-1,0)表示缩小，(0-1)表示增加。
|
||||
|
||||
* 类型：float
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### fingers 属性
|
||||
-----------------------
|
||||
> <p id="multi_gesture_event_t_fingers">本事件用到手指数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
@ -91,21 +76,10 @@ event_t* multi_gesture_event_init (multi_gesture_event_t* event, void* target, u
|
||||
| 可脚本化 | 是 |
|
||||
#### rotation 属性
|
||||
-----------------------
|
||||
> <p id="multi_gesture_event_t_rotation">旋转角度(幅度)增量。
|
||||
> <p id="multi_gesture_event_t_rotation">旋转角度(幅度)增量。（单位弧度）
|
||||
|
||||
* 类型：float
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可脚本化 | 是 |
|
||||
#### touch\_id 属性
|
||||
-----------------------
|
||||
> <p id="multi_gesture_event_t_touch_id">touch device id。
|
||||
|
||||
* 类型：int64\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -17,15 +17,21 @@
|
||||
| <a href="#object_array_t_object_array_clear_props">object\_array\_clear\_props</a> | 清除全部属性。 |
|
||||
| <a href="#object_array_t_object_array_clone">object\_array\_clone</a> | 克隆对象。 |
|
||||
| <a href="#object_array_t_object_array_create">object\_array\_create</a> | 创建对象。 |
|
||||
| <a href="#object_array_t_object_array_get">object\_array\_get</a> | 获取指定序数的元素。 |
|
||||
| <a href="#object_array_t_object_array_insert">object\_array\_insert</a> | 在指定位置插入一个元素。 |
|
||||
| <a href="#object_array_t_object_array_pop">object\_array\_pop</a> | 弹出一个元素。 |
|
||||
| <a href="#object_array_t_object_array_push">object\_array\_push</a> | 追加一个元素。 |
|
||||
| <a href="#object_array_t_object_array_remove">object\_array\_remove</a> | 在指定位置删除一个元素。 |
|
||||
| <a href="#object_array_t_object_array_set">object\_array\_set</a> | 设置指定序数的元素。 |
|
||||
| <a href="#object_array_t_object_array_unref">object\_array\_unref</a> | for script gc |
|
||||
### 属性
|
||||
<p id="object_array_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_array_t_capacity">capacity</a> | uint32\_t | 属性数组的容量。 |
|
||||
| <a href="#object_array_t_props">props</a> | value\_t | 属性数组。 |
|
||||
| <a href="#object_array_t_props_capacity">props\_capacity</a> | uint32\_t | 属性数组的容量。 |
|
||||
| <a href="#object_array_t_props_size">props\_size</a> | uint32\_t | 属性个数。 |
|
||||
| <a href="#object_array_t_size">size</a> | uint32\_t | 属性个数。 |
|
||||
#### object\_array\_clear\_props 函数
|
||||
-----------------------
|
||||
|
||||
@ -82,6 +88,129 @@ object_t* object_array_create ();
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
#### object\_array\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_get">获取指定序数的元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_get (object_t* obj, uint32_t i, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 数组对象。 |
|
||||
| i | uint32\_t | 序数。 |
|
||||
| v | value\_t* | 返回的元素。 |
|
||||
#### object\_array\_insert 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_insert">在指定位置插入一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_insert (object_t* obj, uint32_t index, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 对象。 |
|
||||
| index | uint32\_t | 位置。 |
|
||||
| v | const value\_t* | 值。 |
|
||||
#### object\_array\_pop 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_pop">弹出一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_pop (object_t* obj, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 对象。 |
|
||||
| v | value\_t* | 返回值。 |
|
||||
#### object\_array\_push 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_push">追加一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_push (object_t* obj, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 对象。 |
|
||||
| v | const value\_t* | 值。 |
|
||||
#### object\_array\_remove 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_remove">在指定位置删除一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_remove (object_t* obj, uint32_t index);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 对象。 |
|
||||
| index | uint32\_t | 位置。 |
|
||||
#### object\_array\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_array_t_object_array_set">设置指定序数的元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t object_array_set (object_t* obj, uint32_t i, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 数组对象。 |
|
||||
| i | uint32\_t | 序数。 |
|
||||
| v | const value\_t* | 元素。 |
|
||||
#### object\_array\_unref 函数
|
||||
-----------------------
|
||||
|
||||
@ -101,6 +230,16 @@ ret_t object_array_unref (object_t* obj);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| obj | object\_t* | 对象。 |
|
||||
#### capacity 属性
|
||||
-----------------------
|
||||
> <p id="object_array_t_capacity">属性数组的容量。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### props 属性
|
||||
-----------------------
|
||||
> <p id="object_array_t_props">属性数组。
|
||||
@ -111,19 +250,9 @@ ret_t object_array_unref (object_t* obj);
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### props\_capacity 属性
|
||||
#### size 属性
|
||||
-----------------------
|
||||
> <p id="object_array_t_props_capacity">属性数组的容量。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### props\_size 属性
|
||||
-----------------------
|
||||
> <p id="object_array_t_props_size">属性个数。
|
||||
> <p id="object_array_t_size">属性个数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
|
||||
46
docs/manual/object_date_time_t.md
Normal file
46
docs/manual/object_date_time_t.md
Normal file
@ -0,0 +1,46 @@
|
||||
## object\_date\_time\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将date_time包装成object。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="object_date_time_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#object_date_time_t_object_date_time_create">object\_date\_time\_create</a> | 创建对象。 |
|
||||
### 属性
|
||||
<p id="object_date_time_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_date_time_t_dt">dt</a> | date\_time\_t* | date time对象。 |
|
||||
#### object\_date\_time\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_date_time_t_object_date_time_create">创建对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_date_time_create ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
#### dt 属性
|
||||
-----------------------
|
||||
> <p id="object_date_time_t_dt">date time对象。
|
||||
|
||||
* 类型：date\_time\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
48
docs/manual/object_rbuffer_t.md
Normal file
48
docs/manual/object_rbuffer_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## object\_rbuffer\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将rbuffer包装成object。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="object_rbuffer_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#object_rbuffer_t_object_rbuffer_create">object\_rbuffer\_create</a> | 创建rbuffer对象。 |
|
||||
### 属性
|
||||
<p id="object_rbuffer_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_rbuffer_t_rbuffer">rbuffer</a> | rbuffer\_t* | rbuffer对象。 |
|
||||
#### object\_rbuffer\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_rbuffer_t_object_rbuffer_create">创建rbuffer对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_rbuffer_create (const uint8_t* data, uint16_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
| data | const uint8\_t* | 缓冲区。 |
|
||||
| capacity | uint16\_t | 缓冲区的容量。 |
|
||||
#### rbuffer 属性
|
||||
-----------------------
|
||||
> <p id="object_rbuffer_t_rbuffer">rbuffer对象。
|
||||
|
||||
* 类型：rbuffer\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
48
docs/manual/object_typed_array_t.md
Normal file
48
docs/manual/object_typed_array_t.md
Normal file
@ -0,0 +1,48 @@
|
||||
## object\_typed\_array\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将typed_array包装成object。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="object_typed_array_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#object_typed_array_t_object_typed_array_create">object\_typed\_array\_create</a> | 创建对象。 |
|
||||
### 属性
|
||||
<p id="object_typed_array_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_typed_array_t_arr">arr</a> | typed\_array\_t* | typed array对象。 |
|
||||
#### object\_typed\_array\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_typed_array_t_object_typed_array_create">创建对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_typed_array_create (value_type_t type, uint32_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
| type | value\_type\_t | 元素的类型。 |
|
||||
| capacity | uint32\_t | 数组的初始容量(元素个数)。 |
|
||||
#### arr 属性
|
||||
-----------------------
|
||||
> <p id="object_typed_array_t_arr">typed array对象。
|
||||
|
||||
* 类型：typed\_array\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
67
docs/manual/object_wbuffer_t.md
Normal file
67
docs/manual/object_wbuffer_t.md
Normal file
@ -0,0 +1,67 @@
|
||||
## object\_wbuffer\_t
|
||||
### 概述
|
||||
|
||||
|
||||
将wbuffer包装成object。
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="object_wbuffer_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#object_wbuffer_t_object_wbuffer_create">object\_wbuffer\_create</a> | 创建wbuffer对象。 |
|
||||
| <a href="#object_wbuffer_t_object_wbuffer_create_extendable">object\_wbuffer\_create\_extendable</a> | 创建可扩展的wbuffer对象。 |
|
||||
### 属性
|
||||
<p id="object_wbuffer_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#object_wbuffer_t_wbuffer">wbuffer</a> | wbuffer\_t* | wbuffer对象。 |
|
||||
#### object\_wbuffer\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_wbuffer_t_object_wbuffer_create">创建wbuffer对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_wbuffer_create (uint8_t* data, uint16_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
| data | uint8\_t* | 缓冲区。 |
|
||||
| capacity | uint16\_t | 缓冲区的容量。 |
|
||||
#### object\_wbuffer\_create\_extendable 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="object_wbuffer_t_object_wbuffer_create_extendable">创建可扩展的wbuffer对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
object_t* object_wbuffer_create_extendable ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | object\_t* | 返回object对象。 |
|
||||
#### wbuffer 属性
|
||||
-----------------------
|
||||
> <p id="object_wbuffer_t_wbuffer">wbuffer对象。
|
||||
|
||||
* 类型：wbuffer\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
@ -48,12 +48,14 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| -------- | ------------ |
|
||||
| <a href="#overlay_t_overlay_cast">overlay\_cast</a> | 转换为overlay对象(供脚本语言使用)。 |
|
||||
| <a href="#overlay_t_overlay_create">overlay\_create</a> | 创建overlay对象 |
|
||||
| <a href="#overlay_t_overlay_set_always_on_top">overlay\_set\_always\_on\_top</a> | 设置是否总是在最上面。 |
|
||||
| <a href="#overlay_t_overlay_set_click_through">overlay\_set\_click\_through</a> | 设置是否启用点击穿透。 |
|
||||
### 属性
|
||||
<p id="overlay_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#overlay_t_always_on_top">always\_on\_top</a> | bool\_t | 是否总在最上面。 |
|
||||
| <a href="#overlay_t_click_through">click\_through</a> | bool\_t | 点击穿透。点击没有子控件的位置，是否穿透到底层窗口。 |
|
||||
#### overlay\_cast 函数
|
||||
-----------------------
|
||||
@ -97,6 +99,26 @@ widget_t* overlay_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
|
||||
| y | xy\_t | y坐标 |
|
||||
| w | wh\_t | 宽度 |
|
||||
| h | wh\_t | 高度 |
|
||||
#### overlay\_set\_always\_on\_top 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="overlay_t_overlay_set_always_on_top">设置是否总是在最上面。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t overlay_set_always_on_top (widget_t* widget, bool_t always_on_top);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| always\_on\_top | bool\_t | 是否总是在最上面。 |
|
||||
#### overlay\_set\_click\_through 函数
|
||||
-----------------------
|
||||
|
||||
@ -117,6 +139,24 @@ ret_t overlay_set_click_through (widget_t* widget, bool_t click_through);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| click\_through | bool\_t | 是否启用点击穿透。 |
|
||||
#### always\_on\_top 属性
|
||||
-----------------------
|
||||
> <p id="overlay_t_always_on_top">是否总在最上面。
|
||||
|
||||
缺省不启用。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### click\_through 属性
|
||||
-----------------------
|
||||
> <p id="overlay_t_click_through">点击穿透。点击没有子控件的位置，是否穿透到底层窗口。
|
||||
|
||||
@ -48,6 +48,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| <a href="#progress_bar_t_progress_bar_create">progress\_bar\_create</a> | 创建progress_bar对象 |
|
||||
| <a href="#progress_bar_t_progress_bar_get_percent">progress\_bar\_get\_percent</a> | 获取进度百分比。 |
|
||||
| <a href="#progress_bar_t_progress_bar_set_max">progress\_bar\_set\_max</a> | 设置最大值。 |
|
||||
| <a href="#progress_bar_t_progress_bar_set_reverse">progress\_bar\_set\_reverse</a> | 设置进度条是否反向。 |
|
||||
| <a href="#progress_bar_t_progress_bar_set_show_text">progress\_bar\_set\_show\_text</a> | 设置进度条的是否显示文本。 |
|
||||
| <a href="#progress_bar_t_progress_bar_set_value">progress\_bar\_set\_value</a> | 设置进度条的进度。 |
|
||||
| <a href="#progress_bar_t_progress_bar_set_vertical">progress\_bar\_set\_vertical</a> | 设置进度条的方向。 |
|
||||
@ -57,6 +58,7 @@ default](https://github.com/zlgopen/awtk/blob/master/design/default/styles/defau
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#progress_bar_t_max">max</a> | float\_t | 最大值(缺省为100)。 |
|
||||
| <a href="#progress_bar_t_reverse">reverse</a> | bool\_t | 是否反向显示。如果为TRUE，水平方向从右向左表示增加，垂直方向从上到下表示增加。 |
|
||||
| <a href="#progress_bar_t_show_text">show\_text</a> | bool\_t | 是否显示文本。 |
|
||||
| <a href="#progress_bar_t_value">value</a> | float\_t | 进度条的值[0-max]。 |
|
||||
| <a href="#progress_bar_t_vertical">vertical</a> | bool\_t | 进度条的是否为垂直方向。 |
|
||||
@ -150,6 +152,26 @@ ret_t progress_bar_set_max (widget_t* widget, uint32_t max);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| max | uint32\_t | 最大值。 |
|
||||
#### progress\_bar\_set\_reverse 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="progress_bar_t_progress_bar_set_reverse">设置进度条是否反向。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t progress_bar_set_reverse (widget_t* widget, bool_t reverse);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| reverse | bool\_t | 是否反向。 |
|
||||
#### progress\_bar\_set\_show\_text 函数
|
||||
-----------------------
|
||||
|
||||
@ -216,6 +238,22 @@ ret_t progress_bar_set_vertical (widget_t* widget, bool_t vertical);
|
||||
|
||||
* 类型：float\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### reverse 属性
|
||||
-----------------------
|
||||
> <p id="progress_bar_t_reverse">是否反向显示。如果为TRUE，水平方向从右向左表示增加，垂直方向从上到下表示增加。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
|
||||
@ -28,11 +28,14 @@ rbuffer_read_string(&rbuffer, &str);
|
||||
| <a href="#rbuffer_t_rbuffer_peek_uint32">rbuffer\_peek\_uint32</a> | 读取uint32数据，但不改变cursor的位置。 |
|
||||
| <a href="#rbuffer_t_rbuffer_peek_uint8">rbuffer\_peek\_uint8</a> | 读取uint8数据，但不改变cursor的位置。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_binary">rbuffer\_read\_binary</a> | 读取指定长度的二进制数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_double">rbuffer\_read\_double</a> | 读取double数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_float">rbuffer\_read\_float</a> | 读取float数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_string">rbuffer\_read\_string</a> | 读取字符串。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint16">rbuffer\_read\_uint16</a> | 读取uint16数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint32">rbuffer\_read\_uint32</a> | 读取uint32数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint64">rbuffer\_read\_uint64</a> | 读取uint64数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_read_uint8">rbuffer\_read\_uint8</a> | 读取uint8数据。 |
|
||||
| <a href="#rbuffer_t_rbuffer_rewind">rbuffer\_rewind</a> | 重置当前读取位置。 |
|
||||
| <a href="#rbuffer_t_rbuffer_skip">rbuffer\_skip</a> | 跳过指定的长度。 |
|
||||
### 属性
|
||||
<p id="rbuffer_t_properties">
|
||||
@ -163,6 +166,26 @@ ret_t rbuffer_read_binary (rbuffer_t* rbuffer, void* data, uint32_t size);
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| data | void* | 返回读取的数据。 |
|
||||
| size | uint32\_t | 读取的数据长度。 |
|
||||
#### rbuffer\_read\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rbuffer_t_rbuffer_read_double">读取double数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t rbuffer_read_double (rbuffer_t* rbuffer, double* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | double* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_float 函数
|
||||
-----------------------
|
||||
|
||||
@ -173,7 +196,7 @@ ret_t rbuffer_read_binary (rbuffer_t* rbuffer, void* data, uint32_t size);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t rbuffer_read_float (rbuffer_t* rbuffer, float_t* value);
|
||||
ret_t rbuffer_read_float (rbuffer_t* rbuffer, float* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -182,7 +205,7 @@ ret_t rbuffer_read_float (rbuffer_t* rbuffer, float_t* value);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | float\_t* | 返回读取的数据。 |
|
||||
| value | float* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_string 函数
|
||||
-----------------------
|
||||
|
||||
@ -243,6 +266,26 @@ ret_t rbuffer_read_uint32 (rbuffer_t* rbuffer, uint32_t* value);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | uint32\_t* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_uint64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rbuffer_t_rbuffer_read_uint64">读取uint64数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t rbuffer_read_uint64 (rbuffer_t* rbuffer, uint64_t* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | uint64\_t* | 返回读取的数据。 |
|
||||
#### rbuffer\_read\_uint8 函数
|
||||
-----------------------
|
||||
|
||||
@ -263,6 +306,24 @@ ret_t rbuffer_read_uint8 (rbuffer_t* rbuffer, uint8_t* value);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| rbuffer | rbuffer\_t* | rbuffer对象。 |
|
||||
| value | uint8\_t* | 返回读取的数据。 |
|
||||
#### rbuffer\_rewind 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="rbuffer_t_rbuffer_rewind">重置当前读取位置。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t rbuffer_rewind ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### rbuffer\_skip 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -45,6 +45,7 @@ widget_t* scroll_view = scroll_view_create(win, 0, 0, 0, 0);
|
||||
| <a href="#scroll_view_t_scroll_view_scroll_delta_to">scroll\_view\_scroll\_delta\_to</a> | 滚动到指定的偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_scroll_to">scroll\_view\_scroll\_to</a> | 滚动到指定的偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_offset">scroll\_view\_set\_offset</a> | 设置偏移量。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_snap_to_page">scroll\_view\_set\_snap\_to\_page</a> | 设置滚动时offset是否按页面对齐。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_speed_scale">scroll\_view\_set\_speed\_scale</a> | 设置偏移速度比例。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_virtual_h">scroll\_view\_set\_virtual\_h</a> | 设置虚拟高度。 |
|
||||
| <a href="#scroll_view_t_scroll_view_set_virtual_w">scroll\_view\_set\_virtual\_w</a> | 设置虚拟宽度。 |
|
||||
@ -55,6 +56,7 @@ widget_t* scroll_view = scroll_view_create(win, 0, 0, 0, 0);
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#scroll_view_t_snap_to_page">snap\_to\_page</a> | bool\_t | 滚动时offset是否按页面对齐。 |
|
||||
| <a href="#scroll_view_t_virtual_h">virtual\_h</a> | wh\_t | 虚拟高度。 |
|
||||
| <a href="#scroll_view_t_virtual_w">virtual\_w</a> | wh\_t | 虚拟宽度。 |
|
||||
| <a href="#scroll_view_t_xoffset">xoffset</a> | int32\_t | x偏移量。 |
|
||||
@ -178,6 +180,26 @@ ret_t scroll_view_set_offset (widget_t* widget, int32_t xoffset, int32_t yoffset
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| xoffset | int32\_t | x偏移量。 |
|
||||
| yoffset | int32\_t | y偏移量。 |
|
||||
#### scroll\_view\_set\_snap\_to\_page 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="scroll_view_t_scroll_view_set_snap_to_page">设置滚动时offset是否按页面对齐。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t scroll_view_set_snap_to_page (widget_t* widget, bool_t snap_to_page);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| snap\_to\_page | bool\_t | 是否按页面对齐。 |
|
||||
#### scroll\_view\_set\_speed\_scale 函数
|
||||
-----------------------
|
||||
|
||||
@ -197,8 +219,8 @@ ret_t scroll_view_set_speed_scale (widget_t* widget, float_t xspeed_scale, float
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| xspeed\_scale | float\_t | x偏移速度比例。。 |
|
||||
| yspeed\_scale | float\_t | y偏移速度比例。。 |
|
||||
| xspeed\_scale | float\_t | x偏移速度比例。 |
|
||||
| yspeed\_scale | float\_t | y偏移速度比例。 |
|
||||
#### scroll\_view\_set\_virtual\_h 函数
|
||||
-----------------------
|
||||
|
||||
@ -279,6 +301,22 @@ ret_t scroll_view_set_yslidable (widget_t* widget, bool_t yslidable);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 控件对象。 |
|
||||
| yslidable | bool\_t | 是否允许滑动。 |
|
||||
#### snap\_to\_page 属性
|
||||
-----------------------
|
||||
> <p id="scroll_view_t_snap_to_page">滚动时offset是否按页面对齐。
|
||||
|
||||
* 类型：bool\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
| 可持久化 | 是 |
|
||||
| 可脚本化 | 是 |
|
||||
| 可在IDE中设置 | 是 |
|
||||
| 可在XML中设置 | 是 |
|
||||
| 可通过widget\_get\_prop读取 | 是 |
|
||||
| 可通过widget\_set\_prop修改 | 是 |
|
||||
#### virtual\_h 属性
|
||||
-----------------------
|
||||
> <p id="scroll_view_t_virtual_h">虚拟高度。
|
||||
|
||||
@ -54,7 +54,8 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| -------- | ------------ |
|
||||
| <a href="#slide_view_t_slide_view_cast">slide\_view\_cast</a> | 转换为slide_view对象(供脚本语言使用)。 |
|
||||
| <a href="#slide_view_t_slide_view_create">slide\_view\_create</a> | 创建slide_view对象 |
|
||||
| <a href="#slide_view_t_slide_view_set_active">slide\_view\_set\_active</a> | 设置当前页的序号。 |
|
||||
| <a href="#slide_view_t_slide_view_set_active">slide\_view\_set\_active</a> | 设置当前页的序号(默认启用动画)。 |
|
||||
| <a href="#slide_view_t_slide_view_set_active_ex">slide\_view\_set\_active\_ex</a> | 设置当前页的序号。 |
|
||||
| <a href="#slide_view_t_slide_view_set_anim_hint">slide\_view\_set\_anim\_hint</a> | 设置页面切换动画。 |
|
||||
| <a href="#slide_view_t_slide_view_set_auto_play">slide\_view\_set\_auto\_play</a> | 设置为自动播放模式。 |
|
||||
| <a href="#slide_view_t_slide_view_set_loop">slide\_view\_set\_loop</a> | 设置循环切换模式。 |
|
||||
@ -122,7 +123,7 @@ widget_t* slide_view_create (widget_t* parent, xy_t x, xy_t y, wh_t w, wh_t h);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="slide_view_t_slide_view_set_active">设置当前页的序号。
|
||||
> <p id="slide_view_t_slide_view_set_active">设置当前页的序号(默认启用动画)。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -137,6 +138,27 @@ ret_t slide_view_set_active (widget_t* widget, uint32_t index);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | slide\_view对象。 |
|
||||
| index | uint32\_t | 当前页的序号。 |
|
||||
#### slide\_view\_set\_active\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="slide_view_t_slide_view_set_active_ex">设置当前页的序号。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t slide_view_set_active_ex (widget_t* widget, uint32_t index, bool_t animate);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | slide\_view对象。 |
|
||||
| index | uint32\_t | 当前页的序号。 |
|
||||
| animate | bool\_t | 是否启用动画。 |
|
||||
#### slide\_view\_set\_anim\_hint 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -36,6 +36,7 @@ str_reset(&s);
|
||||
| <a href="#str_t_str_clear">str\_clear</a> | 清除字符串内容。 |
|
||||
| <a href="#str_t_str_decode_xml_entity">str\_decode\_xml\_entity</a> | 对XML基本的entity进行解码，目前仅支持<>"a;&。 |
|
||||
| <a href="#str_t_str_decode_xml_entity_with_len">str\_decode\_xml\_entity\_with\_len</a> | 对XML基本的entity进行解码，目前仅支持<>"a;&。 |
|
||||
| <a href="#str_t_str_encode_hex">str\_encode\_hex</a> | 把二进制的数据编码成16进制格式的字符串。 |
|
||||
| <a href="#str_t_str_end_with">str\_end\_with</a> | 判断字符串是否以指定的子串结尾。 |
|
||||
| <a href="#str_t_str_eq">str\_eq</a> | 判断两个字符串是否相等。 |
|
||||
| <a href="#str_t_str_expand_vars">str\_expand\_vars</a> | 将字符串中的变量展开为obj中对应的属性值。 |
|
||||
@ -369,6 +370,28 @@ ret_t str_decode_xml_entity_with_len (str_t* str, char* text, uint32_t len);
|
||||
| str | str\_t* | str对象。 |
|
||||
| text | char* | 要解码的XML文本。 |
|
||||
| len | uint32\_t | 字符串长度。 |
|
||||
#### str\_encode\_hex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="str_t_str_encode_hex">把二进制的数据编码成16进制格式的字符串。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t str_encode_hex (str_t* str, const uint8_t* data, uint32_t size, const char* format);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| str | str\_t* | str对象。 |
|
||||
| data | const uint8\_t* | 数据。 |
|
||||
| size | uint32\_t | 数据长度。 |
|
||||
| format | const char* | 格式(如:"%02x" 表示生成小写) |
|
||||
#### str\_end\_with 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ https://github.com/zlgopen/awtk/blob/master/design/default/styles/default.xml#L4
|
||||
| <a href="#text_selector_t_loop_options">loop\_options</a> | bool\_t | 是否循环选项(缺省为FALSE)。 |
|
||||
| <a href="#text_selector_t_options">options</a> | char* | 设置可选项(冒号分隔值和文本，分号分隔选项，如:1:red;2:green;3:blue)。 |
|
||||
| <a href="#text_selector_t_selected_index">selected\_index</a> | int32\_t | 当前选中的选项。 |
|
||||
| <a href="#text_selector_t_visible_nr">visible\_nr</a> | uint32\_t | 可见的选项数量(只能是3或者5，缺省为5)。 |
|
||||
| <a href="#text_selector_t_visible_nr">visible\_nr</a> | uint32\_t | 可见的选项数量(只能是1或者3或者5，缺省为5)。 |
|
||||
| <a href="#text_selector_t_yspeed_scale">yspeed\_scale</a> | float\_t | y偏移速度比例。 |
|
||||
### 事件
|
||||
<p id="text_selector_t_events">
|
||||
|
||||
@ -8,6 +8,7 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_dl_t_tk_dl_close">tk\_dl\_close</a> | 关闭dl对象。 |
|
||||
| <a href="#tk_dl_t_tk_dl_error">tk\_dl\_error</a> | 获取最后的错误信息。 |
|
||||
| <a href="#tk_dl_t_tk_dl_open">tk\_dl\_open</a> | 打开动态链接库。 |
|
||||
| <a href="#tk_dl_t_tk_dl_sym">tk\_dl\_sym</a> | 获取指定名称函数的地址。 |
|
||||
#### tk\_dl\_close 函数
|
||||
@ -29,6 +30,24 @@ ret_t tk_dl_close (tk_dl_t* dl);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| dl | tk\_dl\_t* | dl对象。 |
|
||||
#### tk\_dl\_error 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_dl_t_tk_dl_error">获取最后的错误信息。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* tk_dl_error ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回error message. |
|
||||
#### tk\_dl\_open 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_istream_file_t_tk_istream_file_create">tk\_istream\_file\_create</a> | 创建istream对象。 |
|
||||
| <a href="#tk_istream_file_t_tk_istream_file_create_ex">tk\_istream\_file\_create\_ex</a> | 创建istream对象。 |
|
||||
#### tk\_istream\_file\_create 函数
|
||||
-----------------------
|
||||
|
||||
@ -29,3 +30,23 @@ tk_istream_t* tk_istream_file_create (const char* filename);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_istream\_t* | 返回istream对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
#### tk\_istream\_file\_create\_ex 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_istream_file_t_tk_istream_file_create_ex">创建istream对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
tk_istream_t* tk_istream_file_create_ex (const char* filename, const char* mode);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | tk\_istream\_t* | 返回istream对象。 |
|
||||
| filename | const char* | 文件名。 |
|
||||
| mode | const char* | 模式。 |
|
||||
|
||||
@ -11,6 +11,7 @@
|
||||
| -------- | ------------ |
|
||||
| <a href="#tk_ostream_t_tk_ostream_flush">tk\_ostream\_flush</a> | 刷新数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_seek">tk\_ostream\_seek</a> | 设置偏移量。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_tell">tk\_ostream\_tell</a> | 获取当前读取位置。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write">tk\_ostream\_write</a> | 写入数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write_byte">tk\_ostream\_write\_byte</a> | 写入一个字节的数据。 |
|
||||
| <a href="#tk_ostream_t_tk_ostream_write_len">tk\_ostream\_write\_len</a> | 写入指定长度的数据。 |
|
||||
@ -53,6 +54,25 @@ ret_t tk_ostream_seek (tk_ostream_t* stream, uint32_t offset);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| stream | tk\_ostream\_t* | ostream对象。 |
|
||||
| offset | uint32\_t | 偏移量。 |
|
||||
#### tk\_ostream\_tell 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_ostream_t_tk_ostream_tell">获取当前读取位置。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_ostream_tell (tk_ostream_t* stream);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回负数表示失败，否则返回当前读取位置。 |
|
||||
| stream | tk\_ostream\_t* | ostream对象。 |
|
||||
#### tk\_ostream\_write 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -10,6 +10,7 @@
|
||||
| <a href="#tk_thread_t_tk_thread_create">tk\_thread\_create</a> | 创建thread对象。 |
|
||||
| <a href="#tk_thread_t_tk_thread_destroy">tk\_thread\_destroy</a> | 销毁thread对象。 |
|
||||
| <a href="#tk_thread_t_tk_thread_get_args">tk\_thread\_get\_args</a> | 获取线程的参数。 |
|
||||
| <a href="#tk_thread_t_tk_thread_get_priority_from_platform">tk\_thread\_get\_priority\_from\_platform</a> | 获取平台相关的优先级 |
|
||||
| <a href="#tk_thread_t_tk_thread_join">tk\_thread\_join</a> | 等待线程退出。 |
|
||||
| <a href="#tk_thread_t_tk_thread_self">tk\_thread\_self</a> | 获取当前线程的原生句柄。 |
|
||||
| <a href="#tk_thread_t_tk_thread_set_name">tk\_thread\_set\_name</a> | 设置线程的名称。 |
|
||||
@ -75,6 +76,28 @@ void* tk_thread_get_args (tk_thread_t* thread);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void* | 返回线程的参数。 |
|
||||
| thread | tk\_thread\_t* | thread对象。 |
|
||||
#### tk\_thread\_get\_priority\_from\_platform 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="tk_thread_t_tk_thread_get_priority_from_platform">获取平台相关的优先级
|
||||
|
||||
> 部分平台支持。
|
||||
> 根据 AWTK 通用优先级枚举获取平台相关的优先级
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int32_t tk_thread_get_priority_from_platform (tk_thread_priority_t priority);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int32\_t | 返回平台相关的优先级。 |
|
||||
| priority | tk\_thread\_priority\_t | 优先级。 |
|
||||
#### tk\_thread\_join 函数
|
||||
-----------------------
|
||||
|
||||
@ -147,7 +170,7 @@ ret_t tk_thread_set_name (tk_thread_t* thread, const char* name);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t tk_thread_set_priority (tk_thread_t* thread, uint32_t priority);
|
||||
ret_t tk_thread_set_priority (tk_thread_t* thread, tk_thread_priority_t priority);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -156,7 +179,7 @@ ret_t tk_thread_set_priority (tk_thread_t* thread, uint32_t priority);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| thread | tk\_thread\_t* | thread对象。 |
|
||||
| priority | uint32\_t | 优先级。 |
|
||||
| priority | tk\_thread\_priority\_t | 优先级。 |
|
||||
#### tk\_thread\_set\_stack\_size 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
311
docs/manual/typed_array_t.md
Normal file
311
docs/manual/typed_array_t.md
Normal file
@ -0,0 +1,311 @@
|
||||
## typed\_array\_t
|
||||
### 概述
|
||||
带类型的动态数组，根据元素个数动态调整数组的容量。
|
||||
|
||||
示例：
|
||||
|
||||
```c
|
||||
value_t v;
|
||||
typed_array_t* typed_array = typed_array_create(VALUE_TYPE_INT, 10);
|
||||
typed_array_push(a, value_set_int(&v, 123));
|
||||
typed_array_push(a, value_set_int(&v, 234));
|
||||
...
|
||||
typed_array_destroy(typed_array);
|
||||
```
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="typed_array_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#typed_array_t_typed_array_clear">typed\_array\_clear</a> | 清除全部元素。 |
|
||||
| <a href="#typed_array_t_typed_array_create">typed\_array\_create</a> | 创建typed_array对象。 |
|
||||
| <a href="#typed_array_t_typed_array_destroy">typed\_array\_destroy</a> | 销毁typed_array对象。 |
|
||||
| <a href="#typed_array_t_typed_array_extend">typed\_array\_extend</a> | 扩展typed_array到指定容量。 |
|
||||
| <a href="#typed_array_t_typed_array_get">typed\_array\_get</a> | 获取指定序数的元素。 |
|
||||
| <a href="#typed_array_t_typed_array_insert">typed\_array\_insert</a> | 在指定序数插入元素。 |
|
||||
| <a href="#typed_array_t_typed_array_pop">typed\_array\_pop</a> | 弹出最后一个元素。 |
|
||||
| <a href="#typed_array_t_typed_array_push">typed\_array\_push</a> | 在尾巴追加一个元素。 |
|
||||
| <a href="#typed_array_t_typed_array_remove">typed\_array\_remove</a> | 删除指定位置的元素。 |
|
||||
| <a href="#typed_array_t_typed_array_set">typed\_array\_set</a> | 设置指定序数的元素。 |
|
||||
| <a href="#typed_array_t_typed_array_tail">typed\_array\_tail</a> | 返回最后一个元素。 |
|
||||
### 属性
|
||||
<p id="typed_array_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#typed_array_t_capacity">capacity</a> | uint32\_t | 数组的容量大小。 |
|
||||
| <a href="#typed_array_t_data">data</a> | uint8\_t* | 数组中的元素。 |
|
||||
| <a href="#typed_array_t_element_size">element\_size</a> | uint32\_t | 单个元素的大小。 |
|
||||
| <a href="#typed_array_t_size">size</a> | uint32\_t | 数组中元素的个数。 |
|
||||
| <a href="#typed_array_t_type">type</a> | value\_type\_t | 元素的类型。 |
|
||||
#### typed\_array\_clear 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_clear">清除全部元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_clear (typed_array_t* typed_array);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
#### typed\_array\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_create">创建typed_array对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
typed_array_t* typed_array_create (value_type_t type, uint32_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | typed\_array\_t* | 数组对象。 |
|
||||
| type | value\_type\_t | 元素的类型。 |
|
||||
| capacity | uint32\_t | 数组的初始容量(元素个数)。 |
|
||||
#### typed\_array\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_destroy">销毁typed_array对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_destroy (typed_array_t* typed_array);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
#### typed\_array\_extend 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_extend">扩展typed_array到指定容量。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_extend (value_type_t type, uint32_t capacity);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| type | value\_type\_t | 元素的类型。 |
|
||||
| capacity | uint32\_t | 数组的容量(元素个数)。 |
|
||||
#### typed\_array\_get 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_get">获取指定序数的元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_get (typed_array_t* typed_array, uint32_t index, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| index | uint32\_t | 序数。 |
|
||||
| v | value\_t* | 返回的元素。 |
|
||||
#### typed\_array\_insert 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_insert">在指定序数插入元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_insert (typed_array_t* typed_array, uint32_t index, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| index | uint32\_t | 序数。 |
|
||||
| v | const value\_t* | 元素。 |
|
||||
#### typed\_array\_pop 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_pop">弹出最后一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void* typed_array_pop (typed_array_t* typed_array);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void* | 成功返回最后一个元素，失败返回NULL。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
#### typed\_array\_push 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_push">在尾巴追加一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_push (typed_array_t* typed_array, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| v | const value\_t* | 待追加的元素。 |
|
||||
#### typed\_array\_remove 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_remove">删除指定位置的元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_remove (typed_array_t* typed_array, uint32_t index);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| index | uint32\_t | 位置序数。 |
|
||||
#### typed\_array\_set 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_set">设置指定序数的元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_set (typed_array_t* typed_array, uint32_t index, const value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| index | uint32\_t | 序数。 |
|
||||
| v | const value\_t* | 元素。 |
|
||||
#### typed\_array\_tail 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="typed_array_t_typed_array_tail">返回最后一个元素。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t typed_array_tail (typed_array_t* typed_array, value_t* v);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| typed\_array | typed\_array\_t* | 数组对象。 |
|
||||
| v | value\_t* | 返回的元素。 |
|
||||
#### capacity 属性
|
||||
-----------------------
|
||||
> <p id="typed_array_t_capacity">数组的容量大小。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### data 属性
|
||||
-----------------------
|
||||
> <p id="typed_array_t_data">数组中的元素。
|
||||
|
||||
* 类型：uint8\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### element\_size 属性
|
||||
-----------------------
|
||||
> <p id="typed_array_t_element_size">单个元素的大小。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### size 属性
|
||||
-----------------------
|
||||
> <p id="typed_array_t_size">数组中元素的个数。
|
||||
|
||||
* 类型：uint32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### type 属性
|
||||
-----------------------
|
||||
> <p id="typed_array_t_type">元素的类型。
|
||||
|
||||
* 类型：value\_type\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
300
docs/manual/url_t.md
Normal file
300
docs/manual/url_t.md
Normal file
@ -0,0 +1,300 @@
|
||||
## url\_t
|
||||
### 概述
|
||||
URL
|
||||
----------------------------------
|
||||
### 函数
|
||||
<p id="url_t_methods">
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#url_t_url_create">url\_create</a> | 创建URL对象。 |
|
||||
| <a href="#url_t_url_destroy">url\_destroy</a> | 销毁url对象。 |
|
||||
| <a href="#url_t_url_get_param">url\_get\_param</a> | 获取参数。 |
|
||||
| <a href="#url_t_url_set_host">url\_set\_host</a> | 设置主机名。 |
|
||||
| <a href="#url_t_url_set_param">url\_set\_param</a> | 设置参数。 |
|
||||
| <a href="#url_t_url_set_password">url\_set\_password</a> | 设置密码。 |
|
||||
| <a href="#url_t_url_set_path">url\_set\_path</a> | 设置路径。 |
|
||||
| <a href="#url_t_url_set_port">url\_set\_port</a> | 设置端口。 |
|
||||
| <a href="#url_t_url_set_schema">url\_set\_schema</a> | 设置schema。 |
|
||||
| <a href="#url_t_url_set_user_name">url\_set\_user\_name</a> | 设置用户名。 |
|
||||
### 属性
|
||||
<p id="url_t_properties">
|
||||
|
||||
| 属性名称 | 类型 | 说明 |
|
||||
| -------- | ----- | ------------ |
|
||||
| <a href="#url_t_host">host</a> | char* | 主机名。 |
|
||||
| <a href="#url_t_params">params</a> | object\_t* | 参数集合。 |
|
||||
| <a href="#url_t_password">password</a> | char* | 密码。 |
|
||||
| <a href="#url_t_path">path</a> | char* | 路径。 |
|
||||
| <a href="#url_t_port">port</a> | int32\_t | 端口。 |
|
||||
| <a href="#url_t_schema">schema</a> | char* | schema。 |
|
||||
| <a href="#url_t_user_name">user\_name</a> | char* | 用户名。 |
|
||||
#### url\_create 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_create">创建URL对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
url_t* url_create (const char* surl);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | url\_t* | 返回URL对象。 |
|
||||
| surl | const char* | 字符串格式的URL。 |
|
||||
#### url\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_destroy">销毁url对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_destroy (url_t* url);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
#### url\_get\_param 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_get_param">获取参数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
const char* url_get_param (url_t* url, const char* name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | const char* | 返回指定参数名的参数值。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
#### url\_set\_host 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_host">设置主机名。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_host (url_t* url, const char* host);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| host | const char* | 主机名。 |
|
||||
#### url\_set\_param 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_param">设置参数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_param (url_t* url, const char* name, const char* value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| name | const char* | 参数名。 |
|
||||
| value | const char* | 参数值。 |
|
||||
#### url\_set\_password 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_password">设置密码。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_password (url_t* url, const char* password);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| password | const char* | 密码。 |
|
||||
#### url\_set\_path 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_path">设置路径。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_path (url_t* url, const char* path);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| path | const char* | 路径。 |
|
||||
#### url\_set\_port 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_port">设置端口。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_port (url_t* url, int32_t port);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| port | int32\_t | 端口。 |
|
||||
#### url\_set\_schema 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_schema">设置schema。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_schema (url_t* url, const char* schema);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| schema | const char* | schema。 |
|
||||
#### url\_set\_user\_name 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="url_t_url_set_user_name">设置用户名。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t url_set_user_name (url_t* url, const char* user_name);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| url | url\_t* | url对象。 |
|
||||
| user\_name | const char* | 用户名。 |
|
||||
#### host 属性
|
||||
-----------------------
|
||||
> <p id="url_t_host">主机名。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### params 属性
|
||||
-----------------------
|
||||
> <p id="url_t_params">参数集合。
|
||||
|
||||
* 类型：object\_t*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### password 属性
|
||||
-----------------------
|
||||
> <p id="url_t_password">密码。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### path 属性
|
||||
-----------------------
|
||||
> <p id="url_t_path">路径。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### port 属性
|
||||
-----------------------
|
||||
> <p id="url_t_port">端口。
|
||||
|
||||
* 类型：int32\_t
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### schema 属性
|
||||
-----------------------
|
||||
> <p id="url_t_schema">schema。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
#### user\_name 属性
|
||||
-----------------------
|
||||
> <p id="url_t_user_name">用户名。
|
||||
|
||||
* 类型：char*
|
||||
|
||||
| 特性 | 是否支持 |
|
||||
| -------- | ----- |
|
||||
| 可直接读取 | 是 |
|
||||
| 可直接修改 | 否 |
|
||||
@ -17,10 +17,11 @@
|
||||
| <a href="#utils_t_pointer_compare">pointer\_compare</a> | 指针比较。 |
|
||||
| <a href="#utils_t_tk_atob">tk\_atob</a> | 将字符串转换为布尔类型。 |
|
||||
| <a href="#utils_t_tk_atof">tk\_atof</a> | 将字符串转换为浮点类型。 |
|
||||
| <a href="#utils_t_tk_atoi">tk\_atoi</a> | 将字符串转换为整形。 |
|
||||
| <a href="#utils_t_tk_atoi">tk\_atoi</a> | 将字符串转换为整型数。 |
|
||||
| <a href="#utils_t_tk_atol">tk\_atol</a> | 将字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_ftoa">tk\_ftoa</a> | 将浮点型转换为字符串。 |
|
||||
| <a href="#utils_t_tk_is_valid_name">tk\_is\_valid\_name</a> | 判断是否是有效的属性名。 |
|
||||
| <a href="#utils_t_tk_itoa">tk\_itoa</a> | 将整形转换为字符串。 |
|
||||
| <a href="#utils_t_tk_itoa">tk\_itoa</a> | 将整型转换为字符串。 |
|
||||
| <a href="#utils_t_tk_memcpy16">tk\_memcpy16</a> | 拷贝数据2字节。 |
|
||||
| <a href="#utils_t_tk_memcpy32">tk\_memcpy32</a> | 拷贝数据4字节。 |
|
||||
| <a href="#utils_t_tk_memset16">tk\_memset16</a> | 设置数据2字节。 |
|
||||
@ -43,14 +44,16 @@
|
||||
| <a href="#utils_t_tk_strdup">tk\_strdup</a> | 字符串拷贝函数。 |
|
||||
| <a href="#utils_t_tk_strlen">tk\_strlen</a> | 获取字符串的长度。str为空时返回0。 |
|
||||
| <a href="#utils_t_tk_strncpy">tk\_strncpy</a> | 将src所指向的字符串复制到dst，最多复制len个字符串，并在[len]位置添加'\0'。 |
|
||||
| <a href="#utils_t_tk_strncpy_s">tk\_strncpy\_s</a> | 将src所指向的字符串复制到dst，最多复制min(dst_len-1, src_len)个字符串，并在[len]位置添加'\0'。 |
|
||||
| <a href="#utils_t_tk_strndup">tk\_strndup</a> | 字符串拷贝函数，最多复制len个字符串。 |
|
||||
| <a href="#utils_t_tk_strtol">tk\_strtol</a> | 将字符串转换为长整形。 |
|
||||
| <a href="#utils_t_tk_strtol">tk\_strtol</a> | 将字符串转换为长整型。 |
|
||||
| <a href="#utils_t_tk_strtoll">tk\_strtoll</a> | 将字符串转换为长整型。 |
|
||||
| <a href="#utils_t_tk_under_score_to_camel">tk\_under\_score\_to\_camel</a> | 将下划线名字转成驼峰名字。 |
|
||||
| <a href="#utils_t_tk_vsnprintf">tk\_vsnprintf</a> | 将可变参数ap按照format格式化字符串，并将字符串复制到str中。 |
|
||||
| <a href="#utils_t_tk_watob">tk\_watob</a> | 将宽字符串转换为布尔类型。 |
|
||||
| <a href="#utils_t_tk_watof">tk\_watof</a> | 将宽字符串转换为浮点类型。 |
|
||||
| <a href="#utils_t_tk_watoi">tk\_watoi</a> | 将宽字符串转换为整形。 |
|
||||
| <a href="#utils_t_tk_watoi_n">tk\_watoi\_n</a> | 将宽字符串转换为整形。 |
|
||||
| <a href="#utils_t_tk_watoi">tk\_watoi</a> | 将宽字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_watoi_n">tk\_watoi\_n</a> | 将宽字符串转换为整型。 |
|
||||
| <a href="#utils_t_tk_wstr_count_c">tk\_wstr\_count\_c</a> | 统计UCS字符串中某个字符出现的次数。 |
|
||||
| <a href="#utils_t_tk_wstr_dup_utf8">tk\_wstr\_dup\_utf8</a> | 将utf8字符串拷贝为UCS字符串。 |
|
||||
| <a href="#utils_t_tk_wstrdup">tk\_wstrdup</a> | 宽字符串拷贝函数。 |
|
||||
@ -261,7 +264,7 @@ double tk_atof (const char* str);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_atoi">将字符串转换为整形。
|
||||
> <p id="utils_t_tk_atoi">将字符串转换为整型数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -273,8 +276,27 @@ int tk_atoi (const char* str);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回转换后的整形。 |
|
||||
| str | const char* | 要转换为整形的字符串。 |
|
||||
| 返回值 | int | 返回转换后的整型。 |
|
||||
| str | const char* | 要转换为整型数的字符串。 |
|
||||
#### tk\_atol 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_atol">将字符串转换为整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int tk_atol (const char* str);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回转换后的整型。 |
|
||||
| str | const char* | 要转换为整型的字符串。 |
|
||||
#### tk\_ftoa 函数
|
||||
-----------------------
|
||||
|
||||
@ -320,7 +342,7 @@ bool_t tk_is_valid_name (const char* name);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_itoa">将整形转换为字符串。
|
||||
> <p id="utils_t_tk_itoa">将整型转换为字符串。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -335,7 +357,7 @@ const char* tk_itoa (char* str, int len, int n);
|
||||
| 返回值 | const char* | 返回字符串。 |
|
||||
| str | char* | 保存字符串缓冲区。 |
|
||||
| len | int | 缓冲区大小。 |
|
||||
| n | int | 要转换的整形。 |
|
||||
| n | int | 要转换的整型。 |
|
||||
#### tk\_memcpy16 函数
|
||||
-----------------------
|
||||
|
||||
@ -784,8 +806,30 @@ char* tk_strncpy (char* dst, const char* src, size_t len);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char* | 返回目标字符串。 |
|
||||
| dst | char* | 目标字符串。 |
|
||||
| src | const char* | 原字符串。 |
|
||||
| src | const char* | 源字符串。 |
|
||||
| len | size\_t | 要复制的字符串个数。 |
|
||||
#### tk\_strncpy\_s 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_strncpy_s">将src所指向的字符串复制到dst，最多复制min(dst_len-1, src_len)个字符串，并在[len]位置添加'\0'。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
char* tk_strncpy_s (char* dst, size_t dst_len, const char* src, size_t src_len);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | char* | 返回目标字符串。 |
|
||||
| dst | char* | 目标字符串。 |
|
||||
| dst\_len | size\_t | 目标字符串内存长度。 |
|
||||
| src | const char* | 源字符串。 |
|
||||
| src\_len | size\_t | 要复制的字符串个数。 |
|
||||
#### tk\_strndup 函数
|
||||
-----------------------
|
||||
|
||||
@ -811,7 +855,7 @@ char* tk_strndup (const char* str, uint32_t len);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_strtol">将字符串转换为长整形。
|
||||
> <p id="utils_t_tk_strtol">将字符串转换为长整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -823,8 +867,29 @@ long tk_strtol (const char* str, const char** end, int base);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | long | 返回转换后的长整形。 |
|
||||
| str | const char* | 要转换为长整形的字符串。 |
|
||||
| 返回值 | long | 返回转换后的长整型。 |
|
||||
| str | const char* | 要转换为长整型的字符串。 |
|
||||
| end | const char** | 对类型char*的对象的引用。 |
|
||||
| base | int | 基数。 |
|
||||
#### tk\_strtoll 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_strtoll">将字符串转换为长整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
int64_t tk_strtoll (const char* str, const char** end, int base);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int64\_t | 返回转换后的长整型。 |
|
||||
| str | const char* | 要转换为长整型的字符串。 |
|
||||
| end | const char** | 对类型char*的对象的引用。 |
|
||||
| base | int | 基数。 |
|
||||
#### tk\_under\_score\_to\_camel 函数
|
||||
@ -913,7 +978,7 @@ double tk_watof (const wchar_t* str);
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_watoi">将宽字符串转换为整形。
|
||||
> <p id="utils_t_tk_watoi">将宽字符串转换为整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -925,14 +990,14 @@ int tk_watoi (const wchar_t* str);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回转换后的整形。 |
|
||||
| str | const wchar\_t* | 要转换为整形的宽字符串。 |
|
||||
| 返回值 | int | 返回转换后的整型。 |
|
||||
| str | const wchar\_t* | 要转换为整型的宽字符串。 |
|
||||
#### tk\_watoi\_n 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="utils_t_tk_watoi_n">将宽字符串转换为整形。
|
||||
> <p id="utils_t_tk_watoi_n">将宽字符串转换为整型。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
@ -944,8 +1009,8 @@ int tk_watoi_n (const wchar_t* str, uint32_t len);
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | int | 返回转换后的整形。 |
|
||||
| str | const wchar\_t* | 要转换为整形的宽字符串。 |
|
||||
| 返回值 | int | 返回转换后的整型。 |
|
||||
| str | const wchar\_t* | 要转换为整型的宽字符串。 |
|
||||
| len | uint32\_t | 字符串长度。 |
|
||||
#### tk\_wstr\_count\_c 函数
|
||||
-----------------------
|
||||
|
||||
@ -64,6 +64,7 @@ value_set_int(&v, 100);
|
||||
| <a href="#value_t_value_str">value\_str</a> | 获取类型为字符串的值。 |
|
||||
| <a href="#value_t_value_str_ex">value\_str\_ex</a> | 获取类型为字符串的值。 |
|
||||
| <a href="#value_t_value_token">value\_token</a> | 获取token的值。 |
|
||||
| <a href="#value_t_value_type_size">value\_type\_size</a> | 获取指定类型数据大小。 |
|
||||
| <a href="#value_t_value_ubjson">value\_ubjson</a> | 获取为ubjson的值。 |
|
||||
| <a href="#value_t_value_uint16">value\_uint16</a> | 获取类型为uint16的值。 |
|
||||
| <a href="#value_t_value_uint32">value\_uint32</a> | 获取类型为uint32的值。 |
|
||||
@ -1017,6 +1018,25 @@ uint32_t value_token (value_t* v);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 值。 |
|
||||
| v | value\_t* | value对象。 |
|
||||
#### value\_type\_size 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="value_t_value_type_size">获取指定类型数据大小。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
uint32_t value_type_size (value_type_t type);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | uint32\_t | 返回对应数据类型的长度。 |
|
||||
| type | value\_type\_t | 类型。 |
|
||||
#### value\_ubjson 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -37,12 +37,15 @@ wbuffer_deinit(&wbuffer);
|
||||
| <a href="#wbuffer_t_wbuffer_has_room">wbuffer\_has\_room</a> | 是否还有空间。 |
|
||||
| <a href="#wbuffer_t_wbuffer_init">wbuffer\_init</a> | 初始wbuffer对象。 |
|
||||
| <a href="#wbuffer_t_wbuffer_init_extendable">wbuffer\_init\_extendable</a> | 初始wbuffer对象，容量不够时是否支持自动扩展，使用完成后需要调用wbuffer\_deinit释放资源。 |
|
||||
| <a href="#wbuffer_t_wbuffer_rewind">wbuffer\_rewind</a> | 重置当前写入位置。 |
|
||||
| <a href="#wbuffer_t_wbuffer_skip">wbuffer\_skip</a> | 跳过指定的长度。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_binary">wbuffer\_write\_binary</a> | 写入指定长度的二进制数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_double">wbuffer\_write\_double</a> | 写入double数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_float">wbuffer\_write\_float</a> | 写入float数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_string">wbuffer\_write\_string</a> | 写入字符串。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint16">wbuffer\_write\_uint16</a> | 写入uint16数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint32">wbuffer\_write\_uint32</a> | 写入uint32数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint64">wbuffer\_write\_uint64</a> | 写入uint64数据。 |
|
||||
| <a href="#wbuffer_t_wbuffer_write_uint8">wbuffer\_write\_uint8</a> | 写入uint8数据。 |
|
||||
### 属性
|
||||
<p id="wbuffer_t_properties">
|
||||
@ -152,6 +155,24 @@ wbuffer_t* wbuffer_init_extendable (wbuffer_t* wbuffer);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | wbuffer\_t* | wbuffer对象本身。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
#### wbuffer\_rewind 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wbuffer_t_wbuffer_rewind">重置当前写入位置。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wbuffer_rewind ();
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
#### wbuffer\_skip 函数
|
||||
-----------------------
|
||||
|
||||
@ -193,6 +214,26 @@ ret_t wbuffer_write_binary (wbuffer_t* wbuffer, void* data, uint32_t size);
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| data | void* | 要写入的数据。 |
|
||||
| size | uint32\_t | 要写入的数据长度。 |
|
||||
#### wbuffer\_write\_double 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wbuffer_t_wbuffer_write_double">写入double数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wbuffer_write_double (wbuffer_t* wbuffer, double value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | double | 要写入的数据。 |
|
||||
#### wbuffer\_write\_float 函数
|
||||
-----------------------
|
||||
|
||||
@ -203,7 +244,7 @@ ret_t wbuffer_write_binary (wbuffer_t* wbuffer, void* data, uint32_t size);
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wbuffer_write_float (wbuffer_t* wbuffer, float_t value);
|
||||
ret_t wbuffer_write_float (wbuffer_t* wbuffer, float value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
@ -212,7 +253,7 @@ ret_t wbuffer_write_float (wbuffer_t* wbuffer, float_t value);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | float\_t | 要写入的数据。 |
|
||||
| value | float | 要写入的数据。 |
|
||||
#### wbuffer\_write\_string 函数
|
||||
-----------------------
|
||||
|
||||
@ -273,6 +314,26 @@ ret_t wbuffer_write_uint32 (wbuffer_t* wbuffer, uint32_t value);
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | uint32\_t | 要写入的数据。 |
|
||||
#### wbuffer\_write\_uint64 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="wbuffer_t_wbuffer_write_uint64">写入uint64数据。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t wbuffer_write_uint64 (wbuffer_t* wbuffer, uint64_t value);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| wbuffer | wbuffer\_t* | wbuffer对象。 |
|
||||
| value | uint64\_t | 要写入的数据。 |
|
||||
#### wbuffer\_write\_uint8 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -12,6 +12,7 @@
|
||||
| WIDGET\_PROP\_W | 宽度。 |
|
||||
| WIDGET\_PROP\_H | 高度。 |
|
||||
| WIDGET\_PROP\_INPUTING | inputing。 |
|
||||
| WIDGET\_PROP\_ALWAYS\_ON\_TOP | always on top。 |
|
||||
| WIDGET\_PROP\_CARET\_X | caret x。 |
|
||||
| WIDGET\_PROP\_CARET\_Y | caret y。 |
|
||||
| WIDGET\_PROP\_DIRTY\_RECT\_TOLERANCE | 脏矩形超出控件本身大小的最大范围。 |
|
||||
@ -38,6 +39,7 @@
|
||||
| WIDGET\_PROP\_CLOSABLE | 是否可以关闭。 |
|
||||
| WIDGET\_PROP\_POINTER\_CURSOR | 鼠标指针。 |
|
||||
| WIDGET\_PROP\_VALUE | 值。 |
|
||||
| WIDGET\_PROP\_REVERSE | 进度条反向显示。 |
|
||||
| WIDGET\_PROP\_LENGTH | 长度。 |
|
||||
| WIDGET\_PROP\_LINE\_WRAP | 自动换行。 |
|
||||
| WIDGET\_PROP\_WORD\_WRAP | 是否允许单词中换行。 |
|
||||
@ -145,7 +147,7 @@
|
||||
| WIDGET\_PROP\_FOCUSED | 是否为焦点控件。 |
|
||||
| WIDGET\_PROP\_FOCUS | (过时请用focused)。 |
|
||||
| WIDGET\_PROP\_FOCUSABLE | 是否支持焦点停留。 |
|
||||
| WIDGET\_PROP\_WITH\_FOCUS\_STATE | 是否支持焦点状态(如果希望style支持焦点状态，但有不希望焦点停留，可用本属性)。 |
|
||||
| WIDGET\_PROP\_WITH\_FOCUS\_STATE | 是否支持焦点状态(如果希望style支持焦点状态，但又不希望焦点停留，可用本属性)。 |
|
||||
| WIDGET\_PROP\_MOVE\_FOCUS\_PREV\_KEY | 将焦点移到前一个的键值。 |
|
||||
| WIDGET\_PROP\_MOVE\_FOCUS\_NEXT\_KEY | 将焦点移到后一个的键值。 |
|
||||
| WIDGET\_PROP\_MOVE\_FOCUS\_UP\_KEY | 将焦点向上移动的键值。 |
|
||||
|
||||
@ -16,6 +16,7 @@
|
||||
| <a href="#window_manager_t_window_manager_begin_wait_pointer_cursor">window\_manager\_begin\_wait\_pointer\_cursor</a> | 开始等待鼠标指针。 |
|
||||
| <a href="#window_manager_t_window_manager_cast">window\_manager\_cast</a> | 转换为window_manager对象(供脚本语言使用)。 |
|
||||
| <a href="#window_manager_t_window_manager_close_all">window\_manager\_close\_all</a> | 关闭全部窗口。 |
|
||||
| <a href="#window_manager_t_window_manager_close_window_force">window\_manager\_close\_window\_force</a> | 强制立即关闭窗口。 |
|
||||
| <a href="#window_manager_t_window_manager_dispatch_input_event">window\_manager\_dispatch\_input\_event</a> | 分发输入事件。 |
|
||||
| <a href="#window_manager_t_window_manager_dispatch_native_window_event">window\_manager\_dispatch\_native\_window\_event</a> | 处理native window事件。 |
|
||||
| <a href="#window_manager_t_window_manager_end_wait_pointer_cursor">window\_manager\_end\_wait\_pointer\_cursor</a> | 结束等待鼠标指针。 |
|
||||
@ -180,6 +181,28 @@ ret_t window_manager_close_all (widget_t* widget);
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 窗口管理器对象。 |
|
||||
#### window\_manager\_close\_window\_force 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="window_manager_t_window_manager_close_window_force">强制立即关闭窗口。
|
||||
|
||||
> 本函数不会执行窗口动画。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
ret_t window_manager_close_window_force (widget_t* widget, widget_t* window);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
|
||||
| widget | widget\_t* | 窗口管理器对象。 |
|
||||
| window | widget\_t* | 窗口对象。 |
|
||||
#### window\_manager\_dispatch\_input\_event 函数
|
||||
-----------------------
|
||||
|
||||
|
||||
@ -7,7 +7,33 @@ xml builder interface
|
||||
|
||||
| 函数名称 | 说明 |
|
||||
| -------- | ------------ |
|
||||
| <a href="#xml_builder_t_xml_builder_destroy">xml\_builder\_destroy</a> | 销毁builder对象。 |
|
||||
| <a href="#xml_builder_t_xml_builder_get_attr">xml\_builder\_get\_attr</a> | 获取属性。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_comment">xml\_builder\_on\_comment</a> | 解析到注释时调用本函数。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_end">xml\_builder\_on\_end</a> | 解析到tag结束时调用本函数。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_error">xml\_builder\_on\_error</a> | 解析遇到错误时调用本函数。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_pi">xml\_builder\_on\_pi</a> | 解析到处理指令时调用本函数。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_start">xml\_builder\_on\_start</a> | 解析到tag开始时调用本函数。 |
|
||||
| <a href="#xml_builder_t_xml_builder_on_text">xml\_builder\_on\_text</a> | 解析到文本时调用本函数。 |
|
||||
#### xml\_builder\_destroy 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_destroy">销毁builder对象。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_destroy (XmlBuilder* builder);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
#### xml\_builder\_get\_attr 函数
|
||||
-----------------------
|
||||
|
||||
@ -28,3 +54,129 @@ const char* xml_builder_get_attr (const char** attrs, const char* attr);
|
||||
| 返回值 | const char* | 返回属性的值。 |
|
||||
| attrs | const char** | 属性列表。 |
|
||||
| attr | const char* | 属性名。 |
|
||||
#### xml\_builder\_on\_comment 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_comment">解析到注释时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_comment (XmlBuilder* builder, const char* text, size_t length);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| text | const char* | 注释。 |
|
||||
| length | size\_t | 注释长度。 |
|
||||
#### xml\_builder\_on\_end 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_end">解析到tag结束时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_end (XmlBuilder* builder, const char* tag);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| tag | const char* | tag名称。 |
|
||||
#### xml\_builder\_on\_error 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_error">解析遇到错误时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_error (XmlBuilder* builder, int line, int col, const char* message);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| line | int | 出现错误的行。 |
|
||||
| col | int | 出现错误的列。 |
|
||||
| message | const char* | 错误信息。 |
|
||||
#### xml\_builder\_on\_pi 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_pi">解析到处理指令时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_pi (XmlBuilder* builder, const char* tag, const char** attrs);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| tag | const char* | tag名称。 |
|
||||
| attrs | const char** | 属性列表。 |
|
||||
#### xml\_builder\_on\_start 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_start">解析到tag开始时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_start (XmlBuilder* builder, const char* tag, const char** attrs);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| tag | const char* | tag名称。 |
|
||||
| attrs | const char** | 属性列表。 |
|
||||
#### xml\_builder\_on\_text 函数
|
||||
-----------------------
|
||||
|
||||
* 函数功能：
|
||||
|
||||
> <p id="xml_builder_t_xml_builder_on_text">解析到文本时调用本函数。
|
||||
|
||||
* 函数原型：
|
||||
|
||||
```
|
||||
void xml_builder_on_text (XmlBuilder* builder, const char* text, size_t length);
|
||||
```
|
||||
|
||||
* 参数说明：
|
||||
|
||||
| 参数 | 类型 | 说明 |
|
||||
| -------- | ----- | --------- |
|
||||
| 返回值 | void | 返回无。 |
|
||||
| builder | XmlBuilder* | builder对象。 |
|
||||
| text | const char* | 文本。 |
|
||||
| length | size\_t | 文本长度。 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user