# object_default_t

# 概述

image
image

对象接口的缺省实现。

通用当作 map 数据结构使用,内部用有序数组保存所有属性,因此可以快速查找指定名称的属性。

示例

// 创建默认对象
tk_object_t *obj = object_default_create();

// 设置属性
tk_object_set_prop_str(obj, "name", "awplc");
tk_object_set_prop_int(obj, "age", 18);
tk_object_set_prop_double(obj, "weight", 60.5);

// 获取属性
ENSURE(tk_str_eq(tk_object_get_prop_str(obj, "name"), "awplc"));
ENSURE(tk_object_get_prop_int(obj, "age", 0) == 18);
ENSURE(tk_object_get_prop_double(obj, "weight", 0) == 60.5);

// 遍历属性
tk_object_foreach_prop(obj, visit_obj, NULL);

// 释放对象
TK_OBJECT_UNREF(obj);

# 函数

函数名称 说明
object_default_cast 转换为object_default对象。
object_default_clear_props 清除全部属性。
object_default_clone 克隆对象。
object_default_create 创建对象。
object_default_create_ex 创建对象。
object_default_find_prop 查找满足条件的属性,并返回它的值。
object_default_unref for script gc

# object_default_cast 函数

  • 函数功能:

转换为object_default对象。

  • 函数原型:
object_default_t* object_default_cast (tk_object_t* obj);
  • 参数说明:
参数 类型 说明
返回值 object_default_t* object_default对象。
obj tk_object_t* object_default对象。

# object_default_clear_props 函数

  • 函数功能:

清除全部属性。

  • 函数原型:
ret_t object_default_clear_props (tk_object_t* obj);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功,否则表示失败。
obj tk_object_t* 对象。

# object_default_clone 函数

  • 函数功能:

克隆对象。

  • 函数原型:
tk_object_t* object_default_clone (object_default_t* o);
  • 参数说明:
参数 类型 说明
返回值 tk_object_t* 返回object对象。
o object_default_t* 被克隆的对象。

# object_default_create 函数

  • 函数功能:

创建对象。

  • 函数原型:
tk_object_t* object_default_create ();
  • 参数说明:
参数 类型 说明
返回值 tk_object_t* 返回object对象。

# object_default_create_ex 函数

  • 函数功能:

创建对象。

  • 函数原型:
tk_object_t* object_default_create_ex (bool_t enable_path);
  • 参数说明:
参数 类型 说明
返回值 tk_object_t* 返回object对象。
enable_path bool_t 是否支持按路径访问属性。

# object_default_find_prop 函数

  • 函数功能:

查找满足条件的属性,并返回它的值。

  • 函数原型:
value_t* object_default_find_prop (tk_object_t* obj, tk_compare_t cmp, const void* data);
  • 参数说明:
参数 类型 说明
返回值 value_t* 返回属性的值。
obj tk_object_t* 对象。
cmp tk_compare_t 比较函数。
data const void* 要比较的数据。

# object_default_unref 函数

  • 函数功能:

for script gc

  • 函数原型:
ret_t object_default_unref (tk_object_t* obj);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功,否则表示失败。
obj tk_object_t* 对象。