libkysdk-base/0000775000175000017500000000000015161635377012242 5ustar fengfenglibkysdk-base/man/0000775000175000017500000000000015161635377013015 5ustar fengfenglibkysdk-base/man/config/0000775000175000017500000000000015161635377014262 5ustar fengfenglibkysdk-base/man/config/kdk_config_freeall.30000664000175000017500000000363715161635377020147 0ustar fengfeng.TH "KDK_CONFIG_FREEALL" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_config_freeall \- 用于回收字符串列表 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "void kdk_config_freeall (char ** ptr)\fR [inline]\fP" .PP 用于回收字符串列表 .PP \fBParameters\fP .RS 4 \fIptr\fP 字符串列表 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是用于回收字符串列表 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key () and .BR kdk_conf_list_group (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3) and .BR kdk_conf_list_group (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_reload.30000664000175000017500000000374015161635377017456 0ustar fengfeng.TH "KDK_CONF_RELOAD" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_reload \- 重新载入配置文件 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "int kdk_conf_reload (int id)" .PP 重新载入配置文件 .PP \fBParameters\fP .RS 4 \fIid\fP 由kdk_conf_init返回的配置文件句柄 .RE .PP \fBReturns\fP .RS 4 int 成功返回0，失败返回错误码 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是重新载入配置文件 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_init.30000664000175000017500000000376615161635377017163 0ustar fengfeng.TH "KDK_CONF_INIT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_init \- 初始化配置文件 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "int kdk_conf_init (const char * confpath)" .PP 初始化配置文件 .PP \fBParameters\fP .RS 4 \fIconfpath\fP 配置文件的路径 .RE .PP \fBReturns\fP .RS 4 int 成功返回句柄号（非负值），失败返回错误码（负值） .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是初始化配置文件 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_destroy.30000664000175000017500000000366615161635377017710 0ustar fengfeng.TH "KDK_CONF_DESTROY" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_destroy \- 销毁指定的配置文件句柄 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "void kdk_conf_destroy (int id)" .PP 销毁指定的配置文件句柄 .PP \fBParameters\fP .RS 4 \fIid\fP 由kdk_conf_init返回的配置文件句柄 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是销毁指定的配置文件句柄 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_list_group.30000664000175000017500000000407015161635377020374 0ustar fengfeng.TH "KDK_CONF_LIST_GROUP" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_list_group \- 列举id对应配置文件的所有Group .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "char** const kdk_conf_list_group (int id)" .PP 列举id对应配置文件的所有Group，结尾以NULL指针表示 .PP \fBParameters\fP .RS 4 \fIid\fP 由kdk_conf_init返回的句柄值 .RE .PP \fBReturns\fP .RS 4 const char** const 以NULL结尾的字符串列表 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是列举id对应配置文件的所有Group .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/libkyconf.30000664000175000017500000000363415161635377016334 0ustar fengfeng.TH "LIBKYCONF" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkyconf \- KYSDK配置文件处理库，支持标准格式、XML(未实现)、JSON(未实现)的配置文件处理，包括配置文件的读与写操作 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .in +1c .ti -1c .RI "int \fBkdk_conf_init\fP (const char *confpath)" .br .RI "初始化配置文件 " .ti -1c .RI "void \fBkdk_conf_destroy\fP (int id)" .br .RI "销毁指定的配置文件句柄 " .ti -1c .RI "int \fBkdk_conf_reload\fP (int id)" .br .RI "重新载入配置文件 " .ti -1c .RI "const char * \fBkdk_conf_get_value\fP (int id, const char *group, const char *key)" .br .RI "获取指定配置项的值 " .ti -1c .RI "char **const \fBkdk_conf_list_key\fP (int id, const char *group)" .br .RI "列举id对应配置文件的指定Group下的key值，结尾以NULL指针表示 " .ti -1c .RI "char **const \fBkdk_conf_list_group\fP (int id)" .br .RI "列举id对应配置文件的所有Group，结尾以NULL指针表示 " .ti -1c .RI "void \fBkdk_config_freeall\fP (char **ptr)" .br .RI "用于回收字符串列表 " .in -1c .SH "Detailed Description" .PP KYSDK配置文件处理库，支持标准格式、XML(未实现)、JSON(未实现)的配置文件处理，包括配置文件的读与写操作 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_key (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_key (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_list_key.30000664000175000017500000000423215161635377020030 0ustar fengfeng.TH "KDK_CONF_LIST_KEY" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_list_key \- 列举id对应配置文件的指定Group下的key值 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "char** const kdk_conf_list_key (int id, const char * group)" .PP 列举id对应配置文件的指定Group下的key值，结尾以NULL指针表示 .PP \fBParameters\fP .RS 4 \fIid\fP 由kdk_conf_init返回的句柄值 .br \fIgroup\fP 需要列举的Group名称 .RE .PP \fBReturns\fP .RS 4 const char** const 以NULL结尾的字符串列表 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是列举id对应配置文件的指定Group下的key值 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_get_value (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_get_value (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/config/kdk_conf_get_value.30000664000175000017500000000421315161635377020157 0ustar fengfeng.TH "KDK_CONF_GET_VALUE" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_conf_get_value \- 获取指定配置项的值 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "const char* kdk_conf_get_value (int id, const char * group, const char * key)" .PP 获取指定配置项的值 .PP \fBParameters\fP .RS 4 \fIid\fP 由kdk_conf_init返回的配置文件句柄 .br \fIgroup\fP key所在的组名称 .br \fIkey\fP 配置项名称 .RE .PP \fBReturns\fP .RS 4 const char* 配置项所拥有的值，若key不存在，则返回一个空字符串 .RE .PP Link with \fI\-lkyconf\fP. .SH "Detailed Description" .PP 接口的主要功能是获取指定配置项的值 .SH EXAMPLES .EX #include #include #include int main() { char **keylist = NULL; int id = kdk_conf_init("struct.conf"); ASSERT_NOT_NULL(id, -1); char **grouplist = kdk_conf_list_group(id); ASSERT_NOT_NULL(grouplist, -1); char *tmpgroup; int index = 0; while ((tmpgroup = grouplist[index])) { printf("Group: %s\n", tmpgroup); keylist = kdk_conf_list_key(id, tmpgroup); ASSERT_NOT_NULL(keylist, -1); char *tmpkey; int k_index = 0; while ((tmpkey = keylist[k_index])) { const char *tmpval = kdk_conf_get_value(id, tmpgroup, tmpkey); printf("%s = %s\n", tmpkey , tmpval); k_index ++; } kdk_config_freeall(keylist); index ++; } kdk_conf_destroy(id); kdk_config_freeall(grouplist); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_conf_init (), .BR kdk_conf_destroy (), .BR kdk_conf_reload (), .BR kdk_conf_list_key (), .BR kdk_conf_list_group () and .BR kdk_config_freeall (). .SH "SEE ALSO" .BR kdk_conf_init (3), .BR kdk_conf_destroy (3), .BR kdk_conf_reload (3), .BR kdk_conf_list_key (3), .BR kdk_conf_list_group (3) and .BR kdk_config_freeall (3). .SH "Author" .PP Generated automatically by Doxygen for libkyconf.h from the source code\&. libkysdk-base/man/log/0000775000175000017500000000000015161635377013576 5ustar fengfenglibkysdk-base/man/log/kdk_logger_init.30000664000175000017500000000325115161635377017016 0ustar fengfeng.TH "KDK_LOGGER_INIT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_logger_init \- 初始化日志记录 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_logger_init (const char * ini)" .PP 初始化日志记录，也可以不调用该函数直接使用上方日志记录的宏，若以此方式运行，则程序会使用默认的日志配置文件 .PP \fBParameters\fP .RS 4 \fIini：日志配置文件路径，若传入NULL则会使用默认的日志配置文件\fP .RE .PP \fBReturns\fP .RS 4 int，0表示成功，非0表示失败 .RE .PP Link with \fI\-lkylog\fP. .SH "Detailed Description" .PP 接口的主要功能是初始化日志记录，也可以不调用该函数直接使用上方日志记录的宏，若以此方式运行，则程序会使用默认的日志配置文件 .SH EXAMPLES .EX #include #include int main(int argc , char** argv) { assert(kdk_logger_init("/home/szm/szm_bak/kylinos-src/base/libkysdk-base/src/log/test/logtest.conf") == 0); klog_calltrace(); klog_debug("Debug\n"); klog_info("Info\n"); klog_notice("Notice\n"); klog_warning("Warning\n"); klog_err("Error\n"); klog_crit("Crit\n"); klog_alert("Alert\n"); klog_emerg("Emerg\n"); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_logger_flush (), .BR kdk_logger_setdir () and .BR kdk_logger_set_autowrap (). .SH "SEE ALSO" .BR kdk_logger_flush (3), .BR kdk_logger_setdir (3) and .BR kdk_logger_set_autowrap (3). .SH "Author" .PP Generated automatically by Doxygen for libkylog.h from the source code\&. libkysdk-base/man/log/kdk_logger_setdir.30000664000175000017500000000305015161635377017342 0ustar fengfeng.TH "KDK_LOGGER_SETDIR" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_logger_setdir \- 设置日志的存储目录 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int int kdk_logger_setdir (const char * dpath)" .PP 设置日志的存储目录，若不设置，非root程序会被记录在~/\&.log下，root程序会被记录在/var/log下 .PP \fBParameters\fP .RS 4 \fIdpath\fP .RE .PP \fBReturns\fP .RS 4 int .RE .PP Link with \fI\-lkylog\fP. .SH "Detailed Description" .PP 接口的主要功能是设置日志的存储目录，若不设置，非root程序会被记录在~/.log下，root程序会被记录在/var/log下 .SH EXAMPLES .EX #include #include int main(int argc , char** argv) { assert(kdk_logger_init("/home/szm/szm_bak/kylinos-src/base/libkysdk-base/src/log/test/logtest.conf") == 0); assert(kdk_logger_setdir("/tmp") == 0); klog_calltrace(); klog_debug("Debug\n"); klog_info("Info\n"); klog_notice("Notice\n"); klog_warning("Warning\n"); klog_err("Error\n"); klog_crit("Crit\n"); klog_alert("Alert\n"); klog_emerg("Emerg\n"); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_logger_init (), .BR kdk_logger_flush () and .BR kdk_logger_set_autowrap (). .SH "SEE ALSO" .BR kdk_logger_init (3), .BR kdk_logger_flush (3) and .BR kdk_logger_set_autowrap (3). .SH "Author" .PP Generated automatically by Doxygen for libkylog.h from the source code\&. libkysdk-base/man/log/libkylog.30000664000175000017500000000705315161635377015503 0ustar fengfeng.TH "LIBKYLOG" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkylog \- KYSDK日志模块 .SH SYNOPSIS .SS "Macros" .in +1c .ti -1c .RI "#define \fBKLOG_TRACE\fP 8" .br .ti -1c .RI "#define \fBKLOG_DEBUG\fP 7" .br .ti -1c .RI "#define \fBKLOG_INFO\fP 6" .br .ti -1c .RI "#define \fBKLOG_NOTICE\fP 5" .br .ti -1c .RI "#define \fBKLOG_WARNING\fP 4" .br .ti -1c .RI "#define \fBKLOG_ERROR\fP 3" .br .ti -1c .RI "#define \fBKLOG_CRIT\fP 2" .br .ti -1c .RI "#define \fBKLOG_ALERT\fP 1" .br .ti -1c .RI "#define \fBKLOG_EMERG\fP 0" .br .ti -1c .RI "#define \fBklog_trace\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_TRACE , fmt , ##__VA_ARGS__))" .br .RI "在调用的位置自动输出一串日志，表明主调方函数被调用 " .ti -1c .RI "#define \fBklog_debug\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_DEBUG , fmt , ##__VA_ARGS__))" .br .RI "输出debug级别日志，不会自动添加换行符 " .ti -1c .RI "#define \fBklog_info\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_INFO , fmt , ##__VA_ARGS__))" .br .RI "输出info级别日志，不会自动添加换行符 " .ti -1c .RI "#define \fBklog_notice\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_NOTICE , fmt , ##__VA_ARGS__))" .br .RI "输出notice级别日志，不会自动添加换行符 " .ti -1c .RI "#define \fBklog_warning\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_WARNING , fmt , ##__VA_ARGS__))" .br .RI "输出warning级别日志，不会自动添加换行符 " .ti -1c .RI "#define \fBklog_err\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_ERROR , fmt , ##__VA_ARGS__))" .br .RI "输出error级别日志，不会自动添加换行符。 " .ti -1c .RI "#define \fBklog_crit\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_CRIT , fmt , ##__VA_ARGS__))" .br .RI "输出crit级别日志，不会自动添加换行符。该等级日志说明程序发生了重大问题，需要立即修复。 " .ti -1c .RI "#define \fBklog_alert\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_ALERT , fmt , ##__VA_ARGS__))" .br .RI "输出alert级别日志，不会自动添加换行符。该等级日志说明系统发生了极为严重的错误，需要立即修复。 " .ti -1c .RI "#define \fBklog_emerg\fP(fmt, \&.\&.\&.) (\fBklog\fP(KLOG_EMERG , fmt , ##__VA_ARGS__))" .br .RI "输出emerg级别日志，不会自动添加换行符。该等级日志说明系统发生了无法挽回的故障，必须立即停止。 " .in -1c .SS "Functions" .in +1c .ti -1c .RI "int \fBkdk_logger_init\fP (const char *ini)" .br .RI "初始化日志记录，也可以不调用该函数直接使用上方日志记录的宏，若以此方式运行，则程序会使用默认的日志配置文件 " .ti -1c .RI "void \fBkdk_logger_flush\fP () DESTRUCTOR" .br .RI "在异步写入的方式下，可以调用该函数手动将缓存区中的日志写入文件中 " .ti -1c .RI "int int \fBkdk_logger_setdir\fP (const char *dpath)" .br .RI "设置日志的存储目录，若不设置，非root程序会被记录在~/\&.log下，root程序会被记录在/var/log下 " .ti -1c .RI "void \fBkdk_logger_set_autowrap\fP (int autowarp)" .br .RI "设置日志输出自动换行 " .in -1c .SH "Detailed Description" .PP KYSDK日志模块 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_logger_init (), .BR kdk_logger_flush (), .BR kdk_logger_setdir () and .BR kdk_logger_set_autowrap (). .SH "SEE ALSO" .BR kdk_logger_init (3), .BR kdk_logger_flush (3), .BR kdk_logger_setdir (3) and .BR kdk_logger_set_autowrap (3). .SH "Author" .PP Generated automatically by Doxygen for libkylog.h from the source code\&. libkysdk-base/man/log/kdk_logger_flush.30000664000175000017500000000614615161635377017202 0ustar fengfeng.TH "KDK_LOGGER_FLUSH" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_logger_flush \- 在异步写入的方式下，可以调用该函数手动将缓存区中的日志写入文件中 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void kdk_logger_flush ()" .PP 在异步写入的方式下，可以调用该函数手动将缓存区中的日志写入文件中 .PP Link with \fI\-lkylog\fP. .SH "Detailed Description" .PP 接口的主要功能是在异步写入的方式下，可以调用该函数手动将缓存区中的日志写入文件中 .SH EXAMPLES .EX #include #include #include #include #include #include #include #include #include #include #include int stop = 0; int start = 0; pthread_mutex_t lock; unsigned int counts = 0; void stopHandler(int sig) { stop = 1; } void startTimer() { alarm(10); } void* startlog(void* arg) { while (!start); unsigned int count = 0; srand(time(NULL)); while (!stop) { int lvl = rand() % 8; switch (lvl) { case 0 :{ assert(klog_emerg("this is emerg count %d\n" , ++ count) == 0); }break; case 1 : { assert(klog_alert("this is alert count %d\n" , ++ count) == 0); }break; case 2:{ assert(klog_crit("this is crit count %d\n" , ++ count) == 0); }break; case 3:{ assert(klog_err("this is err count %d\n" , ++ count) == 0); }break; case 4:{ assert(klog_warning("this is warning count %d\n" , ++ count) == 0); }break; case 5:{ assert(klog_notice("this is notice count %d\n" , ++ count) == 0); }break; case 6:{ assert(klog_info("this is info count %d\n" , ++ count) == 0); }break; case 7:{ assert(klog_debug("this is debug count %d\n" , ++ count) == 0); }break; } } pthread_mutex_lock(&lock); counts += count; pthread_mutex_unlock(&lock); printf("共写入%d条日志\n" , count); return NULL; } int main(int argc , char** argv) { assert(kdk_logger_init("./logtest.conf") == 0); // //越界测试 // char msg[4096]; // memset(msg , 'F' , sizeof(char) * 4096); // klog_debug(msg); //压力测试 signal(SIGALRM, stopHandler); pthread_mutex_init(&lock, NULL); pthread_t children[7] = {0}; for (int i = 0; i < 7; i++) { pthread_create(&children[i], NULL, startlog, NULL); } start = 1; startTimer(); for (int i = 0; i < 7; i++) { pthread_join(children[i], NULL); } kdk_logger_flush(); pthread_mutex_lock(&lock); printf("所有线程写入总量：%u\n", counts); pthread_mutex_unlock(&lock); return system("cat /var/log/logtest.log | wc -l"); } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_logger_init (), .BR kdk_logger_setdir () and .BR kdk_logger_set_autowrap (). .SH "SEE ALSO" .BR kdk_logger_init (3), .BR kdk_logger_setdir (3) and .BR kdk_logger_set_autowrap (3). .SH "Author" .PP Generated automatically by Doxygen for libkylog.h from the source code\&. libkysdk-base/man/log/kdk_logger_set_autowrap.30000664000175000017500000000245615161635377020576 0ustar fengfeng.TH "KDK_LOGGER_SET_AUTOWRAP" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_logger_set_autowrap \- 设置日志输出自动换行 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void kdk_logger_set_autowrap (int autowarp)" .PP 设置日志输出自动换行 .PP \fBParameters\fP .RS 4 \fIautowarp\fP 1表示启用启动换行，0表示禁止自动换行 .RE .PP Link with \fI\-lkylog\fP. .SH "Detailed Description" .PP 接口的主要功能是设置日志输出自动换行 .SH EXAMPLES .EX #include #include int main(int argc , char** argv) { assert(kdk_logger_init("./logtest.conf") == 0); kdk_logger_set_autowrap(1); klog_calltrace(); klog_debug("Debug"); klog_info("Info"); klog_notice("Notice"); klog_warning("Warning"); klog_err("Error"); klog_crit("Crit"); klog_alert("Alert"); klog_emerg("Emerg"); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_logger_init (), .BR kdk_logger_flush () and .BR kdk_logger_setdir (). .SH "SEE ALSO" .BR kdk_logger_init (3), .BR kdk_logger_flush (3) and .BR kdk_logger_setdir (3). .SH "Author" .PP Generated automatically by Doxygen for libkylog.h from the source code\&. libkysdk-base/man/conf2/0000775000175000017500000000000015161635377014024 5ustar fengfenglibkysdk-base/man/conf2/kconf2.10000664000175000017500000000501315161635377015267 0ustar fengfeng.TH KCONF2 1 "2023" "Version 1.0" "KylinSoft Configuration Tool" .SH NAME kconf2 \- KylinSoft configuration management tool .SH SYNOPSIS .B kconf2 COMMAND [ARGS...] .SH DESCRIPTION .B kconf2 is a command-line tool for managing and manipulating configuration files. It allows users to view, modify, monitor, and reset schema-based configuration items. .SH COMMANDS .TP .B help [COMMAND] Show help information. If COMMAND is specified, show detailed help for that command. .TP .B list-keys SCHEMA[:VERSION] List all keys in the specified schema. .TP .B list-children SCHEMA[:VERSION] List all child objects in the specified schema. .TP .B list-recursively SCHEMA[:VERSION] Recursively list keys and values. If no SCHEMA is given, list all keys. .TP .B range SCHEMA[:VERSION] KEY Query the range of valid values for the key. .TP .B describe SCHEMA[:VERSION] KEY Query the description of the key. .TP .B get SCHEMA[:VERSION] KEY Get the value of the key. .TP .B set SCHEMA[:VERSION] KEY VALUE Set the value of the key. .TP .B reset SCHEMA[:VERSION] KEY Reset the key's value to its default. .TP .B writable SCHEMA[:VERSION] KEY Check if the key is writable. .TP .B monitor SCHEMA[:VERSION] [KEY] Watch for changes to the KEY. If no KEY is specified, all keys in the schema are monitored. Use ^C to stop monitoring. .TP .B reload Reload configuration file, retain user configuration. .TP .B save PATH Save user configuration in target folder. .TP .B list-schemas [APP] [VERSION] List installed schemas. If APP and VERSION are specified, only list matching schemas. .SH ARGUMENTS .TP .I SCHEMA The name of the schema .TP .I VERSION Specify the version of the schema .TP .I KEY Key in the schema .TP .I VALUE The value to set .TP .I PATH The destination folder path .TP .I APP The name of the application .SH EXAMPLES List all keys in a schema: .RS .nf kconf2 list-keys org.example.app .fi .RE Get a configuration value: .RS .nf kconf2 get org.example.app:key1 .fi .RE Set a configuration value: .RS .nf kconf2 set org.example.app:key1 newvalue .fi .RE Monitor a specific key for changes: .RS .nf kconf2 monitor org.example.app key1 .fi .RE Save user configuration: .RS .nf kconf2 save /home/user/configs .fi .RE .SH AUTHOR KylinSoft Co., Ltd. .SH COPYRIGHT Copyright (C) 2023, KylinSoft Co., Ltd. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.libkysdk-base/man/conf2/ini2yaml.10000664000175000017500000000405715161635377015640 0ustar fengfeng.TH INI2YAML 1 "2025-07-24" "v1.0" "User Commands" .SH NAME ini2yaml \- convert INI configuration files to YAML format .SH SYNOPSIS .B ini2yaml .RB [ \-h ] \fB\-f\fR \fISOURCE\fR .RB [ \-n \fIAPP_NAME\fR ] .RB [ \-v \fIVERSION\fR ] .RB [ \-p \fIPATH\fR ] .SH DESCRIPTION This program converts INI configuration files (with extensions .ini, .cf, or .conf) into YAML format. It can process either a single file or all valid files in a directory. Output is saved in the specified directory with YAML formatting. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Show help message and exit .TP \fB\-f\fR \fISOURCE\fR, \fB\-\-file\fR \fISOURCE\fR Specify input source (required). Can be either: .RS .IP \(bu 2 A single INI file (.ini, .cf, or .conf extension) .IP \(bu 2 A directory containing INI files .RE .TP \fB\-n\fR \fIAPP_NAME\fR, \fB\-\-name\fR \fIAPP_NAME\fR Specify application name for YAML metadata. Default: \fI'app'\fR .TP \fB\-v\fR \fIVERSION\fR, \fB\-\-version\fR \fIVERSION\fR Specify configuration version. Default: \fI'1.0.0'\fR .TP \fB\-p\fR \fIPATH\fR, \fB\-\-path\fR \fIPATH\fR Specify output directory. Default: \fI${HOME}/yaml\fR .SH PROCESSING DETAILS .IP \(bu 2 Converts each INI section to a YAML object .IP \(bu 2 Preserves option values while stripping surrounding quotes .IP \(bu 2 Adds metadata fields: .RS .RS \fI_default\fR: Original value from INI .br \fI_type\fR: Always 's' (string type) .RE .RE .IP \(bu 2 Output filename: \fI.yaml\fR .SH ENVIRONMENT .TP .B HOME Determines default output directory when \fB\-p\fR is not specified .SH EXAMPLES .TP Convert single file with defaults: .B ini2yaml \-f /etc/dput.cf .TP Convert directory with custom parameters: .B ini2yaml \-f ~/configs/ \-n myapp \-v 2.1.0 \-p /tmp/output .TP Process system configurations: .B ini2yaml \-f /etc/sysconfig/ \-n system_cfg .SH SEE ALSO .BR configparser (3python), .BR PyYAML (3python) .SH NOTES .IP \(bu 2 Nested INI sections are not supported .IP \(bu 2 All values are treated as strings .IP \(bu 2 Existing YAML files will be overwritten .SH AUTHOR Written for the UKUI project. libkysdk-base/man/conf2/conf2-compile.80000664000175000017500000000266515161635377016563 0ustar fengfeng.TH CONF2-COMPILE.SERVICE 8 "2025" "KylinSoft Co., Ltd." "System Administration" .SH NAME conf2-compile.service \- Configuration file compilation service .SH SYNOPSIS .B conf2-compile.service .SH DESCRIPTION .B conf2-compile.service is a systemd service unit that runs the conf2-compile program. This program is responsible for compiling YAML format configuration files into an SQLite database for use by other system components. .PP The service performs the following operations: .IP \[bu] 2 Reads YAML configuration files from system directories .IP \[bu] Parses configuration file contents .IP \[bu] Updates the SQLite database structure .IP \[bu] Stores the parsed configuration data into the .I /etc/kylin-config/user.db database .PP This service typically runs during system startup or after configuration file updates to ensure system configuration data is up-to-date. .SH OPTIONS This service does not accept any command-line arguments. All configuration is handled through predefined paths and logic in the source code. .SH FILES .TP .I /etc/kylin-config/user.db Target SQLite database file .TP .I /etc/kylin-config/ Default directory for YAML configuration files .SH SEE ALSO .BR systemd (1), .BR systemctl (1) .SH AUTHOR KylinSoft Co., Ltd. .SH COPYRIGHT Copyright \(co 2025, KylinSoft Co., Ltd. .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. libkysdk-base/man/conf2/conf2-sync-system.80000664000175000017500000000326215161635377017423 0ustar fengfeng.TH com.kylin.kysdk.SyncConfig.service 8 "2025" "KylinSoft Co., Ltd." "System Administration" .SH NAME com.kylin.kysdk.SyncConfig.service \- Conf2/GSettings configuration synchronization service .SH SYNOPSIS .B com.kylin.kysdk.SyncConfig.service .SH DESCRIPTION .B com.kylin.kysdk.SyncConfig.service is a systemd service unit that runs the conf2-sync-system program. This service is responsible for monitoring and synchronizing Conf2/GSettings configuration changes through D-Bus communication. .PP The service performs the following operations: .IP \[bu] 2 Monitors Conf2/GSettings configuration changes that require synchronization .IP \[bu] Initializes a D-Bus server on the system bus for configuration management .IP \[bu] Provides configuration synchronization capabilities through D-Bus interface .PP This service acts as a background daemon that ensures Conf2/GSettings configuration consistency and enables other system components to synchronize configuration changes via D-Bus. .SH OPTIONS This service does not accept any command-line arguments. All configuration is handled through predefined paths and logic in the source code. .SH D-BUS INTERFACE The service exposes configuration synchronization functionality through D-Bus, allowing other processes to request configuration synchronization operations. .SH FILES .TP D-Bus system bus connection for communication with other system components .SH SEE ALSO .BR systemd (1), .BR systemctl (1), .BR dbus (1) .SH AUTHOR KylinSoft Co., Ltd. .SH COPYRIGHT Copyright \(co 2024-2025, KylinSoft Co., Ltd. .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. libkysdk-base/man/conf2/health-check.10000664000175000017500000000337615161635377016437 0ustar fengfeng.TH CHECK_COMPAT 1 "2025-07-24" "v1.0" "Configuration Validation" .SH NAME check_compat \- detect incompatible configurations in conf2 module YAML files .SH SYNOPSIS .B check_compat \fB\-o\fR \fIOUTPUT_FILE\fR .RB [ \-h ] .SH DESCRIPTION This program scans conf2 module YAML files to identify incompatible configurations. It performs validation checks against conf2 module specifications and outputs detected issues to the specified results file. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Show help message and exit .TP \fB\-o\fR \fIOUTPUT_FILE\fR, \fB\-\-output\fR \fIOUTPUT_FILE\fR Specify output file path for validation results (required) .SH OPERATION The program: .IP 1. 4 Scans the current working directory and relevant system paths .IP 2. 4 Identifies conf2 module YAML configuration files .IP 3. 4 Validates configurations against compatibility rules .IP 4. 4 Writes detected issues to the specified output file .SH OUTPUT FORMAT The output file contains: .IP \(bu 2 List of incompatible configurations .IP \(bu 2 File paths where issues were detected .IP \(bu 2 Specific configuration keys causing incompatibilities .IP \(bu 2 Severity level for each issue .SH EXIT STATUS .TP .B 0 Success (no incompatible configurations found) .TP .B 1 Validation errors detected .TP .B 2 Execution error (invalid parameters or system issues) .SH EXAMPLES .TP Basic usage: .B check_compat \-o validation_results.txt .TP Check exit status: $ check_compat -o report.log .br $ echo $? .br 1 # indicates issues found .SH SEE ALSO .BR conf2 (1), .BR yamllint (1) .SH DIAGNOSTICS Output file will contain: .RS .PP ERROR: Incompatible setting detected in /etc/conf2/app.yaml .br Key: security.encryption_level .br Current value: legacy .br Required: modern .RE .SH AUTHOR UKUI Quality Assurance Team libkysdk-base/man/conf2/conf2-sync-session.80000664000175000017500000000323615161635377017563 0ustar fengfeng.TH com.kylin.kysdk.SyncConfig.desktop 8 "2025" "KylinSoft Co., Ltd." "System Administration" .SH NAME com.kylin.kysdk.SyncConfig.desktop \- Conf2/GSettings configuration synchronization service .SH SYNOPSIS .B com.kylin.kysdk.SyncConfig.desktop .SH DESCRIPTION .B com.kylin.kysdk.SyncConfig.desktop is a autostart session bus that runs the conf2-sync-session program. This service is responsible for monitoring and synchronizing Conf2/GSettings configuration changes through D-Bus communication. .PP The service performs the following operations: .IP \[bu] 2 Monitors Conf2/GSettings configuration changes that require synchronization .IP \[bu] Initializes a D-Bus server on the system bus for configuration management .IP \[bu] Provides configuration synchronization capabilities through D-Bus interface .PP This service acts as a background daemon that ensures Conf2/GSettings configuration consistency and enables other system components to synchronize configuration changes via D-Bus. .SH OPTIONS This service does not accept any command-line arguments. All configuration is handled through predefined paths and logic in the source code. .SH D-BUS INTERFACE The service exposes configuration synchronization functionality through D-Bus, allowing other processes to request configuration synchronization operations. .SH FILES .TP D-Bus session bus connection for communication with other system components .SH SEE ALSO .BR xdg (1), .BR dbus (1) .SH AUTHOR KylinSoft Co., Ltd. .SH COPYRIGHT Copyright \(co 2024-2025, KylinSoft Co., Ltd. .PP This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. libkysdk-base/man/conf2/gschema_xml2yaml.10000664000175000017500000000242715161635377017347 0ustar fengfeng.TH GSCHEMA2YAML 1 "2025-07-24" "v1.0" "User Commands" .SH NAME gschema2yaml \- convert gschema.xml files to YAML format .SH SYNOPSIS .B gschema2yaml .RB [ \-h ] \fB\-i\fR \fISCHEMA_ID\fR .RB [ \-v \fIVERSION\fR ] .RB [ \-p \fIPATH\fR ] .SH DESCRIPTION This program converts gschema.xml files into YAML format. It requires a schema identifier and allows customization of the output version and destination path. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Show this help message and exit .TP \fB\-i\fR \fISCHEMA_ID\fR, \fB\-\-id\fR \fISCHEMA_ID\fR Specify the gschema.xml ID (e.g., \fIorg.ukui.control-center\fR). This parameter is required. .TP \fB\-v\fR \fIVERSION\fR, \fB\-\-version\fR \fIVERSION\fR Specify configuration version for the YAML output (default: \fI2.0.0.0-0k0.0\fR) .TP \fB\-p\fR \fIPATH\fR, \fB\-\-path\fR \fIPATH\fR Specify output directory for YAML files (default: \fI${HOME}/yaml\fR) .SH ENVIRONMENT .TP .B HOME Determines the default output directory when \fB\-\-path\fR is not specified .SH EXAMPLES .TP Convert schema with default settings: .B gschema2yaml \-\-id org.ukui.example .TP Custom version and output path: .B gschema2yaml \-i org.ukui.demo \-v 3.1.0 \-p ~/custom_dir .SH SEE ALSO .BR gsettings (1), .BR glib-compile-schemas (1) .SH AUTHOR Written for the UKUI project. libkysdk-base/man/conf2/json2yaml.10000664000175000017500000000374515161635377016035 0ustar fengfeng.TH JSON2YAML 1 "2025-07-24" "v1.1" "Configuration Conversion" .SH NAME json2yaml \- convert JSON configuration files to conf2-compatible YAML format .SH SYNOPSIS .B json2yaml .RB [ \-h ] .RB [ \-o \fIOUTPUT_DIR\fR ] \fISOURCE\fR... .SH DESCRIPTION Converts JSON configuration files to YAML format compatible with conf2 modules. Processes individual JSON files or recursively converts all JSON files in directories. Output files retain original names with .yaml extension. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Show help message and exit .TP \fB\-o\fR \fIOUTPUT_DIR\fR, \fB\-\-output\fR \fIOUTPUT_DIR\fR Specify output directory (default: \fI~/yaml\fR) .TP \fISOURCE\fR... JSON file(s) or directory path(s) to process (at least one required) .SH CONVERSION RULES .IP \(bu 2 JSON objects become nested YAML structures .IP \(bu 2 All values gain metadata fields: .RS .RS \fI_default\fR: Original value .br \fI_type\fR: Type indicator (\fI's'\fR for scalar, \fI'as'\fR for arrays) .RE .RE .IP \(bu 2 Array values are converted to string representations .IP \(bu 2 Output version is fixed to \fI2.0.0.0-0k0.0\fR .SH OUTPUT .TP .B Files \fI.yaml\fR in output directory .TP .B Structure .RS .PP : \fI2.0.0.0-0k0.0\fR: : _default: _type: : ... .RE .SH ENVIRONMENT .TP .B HOME Used when default output directory (~/yaml) is specified .SH EXAMPLES .TP Convert single file: .B json2yaml /etc/app/config.json .TP Convert directory with custom output: .B json2yaml -o ~/converted /path/to/json_configs/ .TP Convert multiple sources: .B json2yaml file1.json file2.json ~/legacy_configs .SH EXIT STATUS .TP .B 0 Success .TP .B 1 Input errors (invalid files/paths) .TP .B 2 Processing errors .SH NOTES .IP \(bu 2 Original JSON arrays become string values in YAML .IP \(bu 2 Nested objects are preserved recursively .IP \(bu 2 Non-JSON files are skipped with warning .SH SEE ALSO .BR conf2 (1), .BR jq (1), .BR yq (1) .SH AUTHOR UKUI Configuration Tools Team libkysdk-base/man/diagnostics/0000775000175000017500000000000015161635377015324 5ustar fengfenglibkysdk-base/man/diagnostics/libkydiagnostics.30000664000175000017500000000174715161635377020763 0ustar fengfeng.TH "LIBKYDIAGNOSTICS" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkydiagnostics \- Used for uploading tracking data .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "int \fBkdk_buried_point\fP (char *appName, char *messageType, \fBKBuriedPoint\fP *data, int length)" .br .RI "Used for uploading tracking data " .in -1c .SH DATA STRUCTURES Structure \fBKBuriedPoint\fR is an array of buried data: \fBtypedef struct { .br const char *key; const char *value; .br } KBuriedPoint;\fP There are other members not documented here, which are only meant for libkydiagnostics internal use. .SH "Detailed Description" .PP Used for uploading tracking data .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_buried_point (). .SH "SEE ALSO" .BR kdk_buried_point (3). .SH "Author" .PP Generated automatically by Doxygen for libkydiagnostics.h from the source code\&. libkysdk-base/man/diagnostics/kdk_buried_point.30000664000175000017500000000275315161635377020733 0ustar fengfeng.TH "KDK_BURIED_POINT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_buried_point \- 上传埋点数据 .SH SYNOPSIS .br .PP \fB#include \fP .br .SS "Functions" .PP .SS "int kdk_buried_point (char * appName, char * messageType, \fBKBuriedPoint\fP * data, int length)" .PP 上传埋点数据 .PP \fBParameters\fP .RS 4 \fIappName\fP : 包名 .br \fImessageType\fP : 消息类型 .br \fIdata\fP : 埋点数据数组 .br typedef struct { .br const char *key; const char *value; .br } KBuriedPoint; .br \fIlength\fP : 数组长度 .RE .PP \fBReturn values\fP .RS 4 \fI0\fP : 成功 .br \fI-1\fP : 失败 .RE .PP Link with \fI\-lkydiagnostics\fP. .SH "Detailed Description" .PP 接口的主要功能是上传埋点数据 .SH EXAMPLES .EX #include #include "libkydiagnostics.h" int main(void) { char appName[] = "kylin-font-viewer"; char messageType[] = "FunctionType"; KBuriedPoint pt[2]; pt[0].key = "testkey"; pt[0].value = "testvalue"; pt[1].key = "testkey1"; pt[1].value = "testvalue1"; if (kdk_buried_point(appName , messageType , pt , 2)) { printf("buried point fail !\n"); return -1; } printf("buried point success !\n"); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. .SH "SEE ALSO" .BR libkydiagnostics (3). .SH "Author" .PP Generated automatically by Doxygen for libkydiagnostics.h from the source code\&. libkysdk-base/man/gsettings/0000775000175000017500000000000015161635377015024 5ustar fengfenglibkysdk-base/man/gsettings/kdk_settings_set_int.30000664000175000017500000000514315161635377021331 0ustar fengfeng.TH "KDK_SETTINGS_SET_INT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_set_int \- 设置gesettings指定int类型key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_settings_set_int (const char * schema_id, const char * key, int value)" .PP 设置gesettings指定int类型key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .br \fIvalue\fP key的值 .RE .PP \fBReturns\fP .RS 4 int 成功返回1，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是设置gesettings指定int类型key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/libkygsetting.30000664000175000017500000000414315161635377017771 0ustar fengfeng.TH "libkygsetting" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkygsetting \- KYSDK C语言Gsettings模块 .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "int \fBkdk_gsettings_set\fP (const char *schema_id, const char *key, const char *format,\&.\&.\&.)" .br .RI "设置gesettings指定key值 " .ti -1c .RI "int \fBkdk_settings_reset\fP (const char *schema_id, const char *key)" .br .RI "重置gesettings指定key值 " .ti -1c .RI "int \fBkdk_settings_set_string\fP (const char *schema_id, const char *key, const char *value)" .br .RI "设置gesettings指定string类型key值 " .ti -1c .RI "int \fBkdk_settings_set_int\fP (const char *schema_id, const char *key, int value)" .br .RI "设置gesettings指定int类型key值 " .ti -1c .RI "void * \fBkdk_gsettings_get\fP (const char *schema_id, const char *key, const char *format,\&.\&.\&.)" .br .RI "获取gesettings指定key值 " .ti -1c .RI "char * \fBkdk_settings_get_string\fP (const char *schema_id, const char *key)" .br .RI "获取gesettings指定string类型key值 " .ti -1c .RI "int \fBkdk_settings_get_int\fP (const char *schema_id, const char *key)" .br .RI "获取gesettings指定int类型key值 " .ti -1c .RI "double \fBkdk_settings_get_double\fP (const char *schema_id, const char *key)" .br .RI "获取gesettings指定double类型key值 " .in -1c .SH "Detailed Description" .PP KYSDK C语言Gsettings模块 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_settings_get_string.30000664000175000017500000000513015161635377022025 0ustar fengfeng.TH "KDK_SETTINGS_GET_STRING" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_get_string \- 获取gesettings指定string类型key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "char* kdk_settings_get_string (const char * schema_id, const char * key)" .PP 获取gesettings指定string类型key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .RE .PP \fBReturns\fP .RS 4 char* 成功返回key的值，失败返回NULL .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是获取gesettings指定string类型key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_settings_get_double.30000664000175000017500000000512715161635377021777 0ustar fengfeng.TH "KDK_SETTINGS_GET_DOUBLE" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_get_double \- 获取gesettings指定double类型key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "double kdk_settings_get_double (const char * schema_id, const char * key)" .PP 获取gesettings指定double类型key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .RE .PP \fBReturns\fP .RS 4 double 成功返回key的值，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是获取gesettings指定double类型key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string () and .BR kdk_settings_get_int (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3) and .BR kdk_settings_get_int (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_gsettings_get.30000664000175000017500000000531515161635377020613 0ustar fengfeng.TH "KDK_GSETTINGS_GET" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_gsettings_get \- 获取gesettings指定key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void* kdk_gsettings_get (const char * schema_id, const char * key, const char * format, \&.\&.\&.)" .PP 获取gesettings指定key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .br \fIformat\fP key 的类型，需要是 GVariant 支持的类型，除了可以使用基本的类型外，也可按照 GVariant 的方式组合类型 .RE .PP \fBReturns\fP .RS 4 GVariant key的值 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是获取gesettings指定key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_settings_get_int.30000664000175000017500000000510515161635377021313 0ustar fengfeng.TH "KDK_SETTINGS_GET_INT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_get_int \- 获取gesettings指定int类型key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_settings_get_int (const char * schema_id, const char * key)" .PP 获取gesettings指定int类型key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .RE .PP \fBReturns\fP .RS 4 int 成功返回key的值，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是获取gesettings指定int类型key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_gsettings_set.30000664000175000017500000000533215161635377020626 0ustar fengfeng.TH "KDK_GSETTINGS_SET" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_gsettings_set \- 设置gesettings指定key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_gsettings_set (const char * schema_id, const char * key, const char * format, \&.\&.\&.)" .PP 设置gesettings指定key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .br \fIformat\fP key 的类型，需要是 GVariant 支持的类型，除了可以使用基本的类型外，也可按照 GVariant 的方式组合类型 .RE .PP \fBReturns\fP .RS 4 int 成功返回1，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是设置gesettings指定key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_settings_reset (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_settings_reset (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_settings_reset.30000664000175000017500000000504015161635377021002 0ustar fengfeng.TH "KDK_SETTINGS_RESET" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_reset \- 重置gesettings指定key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_settings_reset (const char * schema_id, const char * key)" .PP 重置gesettings指定key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .RE .PP \fBReturns\fP .RS 4 int 成功返回1，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是重置gesettings指定key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_set_string (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_set_string (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/gsettings/kdk_settings_set_string.30000664000175000017500000000517015161635377022045 0ustar fengfeng.TH "KDK_SETTINGS_SET_STRING" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_settings_set_string \- 设置gesettings指定string类型key值 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_settings_set_string (const char * schema_id, const char * key, const char * value)" .PP 设置gesettings指定string类型key值 .PP \fBParameters\fP .RS 4 \fIschema_id\fP schema中的id .br \fIkey\fP key的名称 .br \fIvalue\fP key的值 .RE .PP \fBReturns\fP .RS 4 int 成功返回1，失败返回0 .RE .PP Link with \fI\-lkygsetting\fP. .SH "Detailed Description" .PP 接口的主要功能是设置gesettings指定string类型key值 .SH EXAMPLES .EX #include "libkygsetting.h" #include #include #include #include #include #include int main() { int ret = kdk_settings_reset("org.gnome.evolution-data-server.calendar", "notify-custom-snooze-minutes"); double a[] = {0.0,2.0}; size_t s = 2; // double **s = a; ret = kdk_gsettings_set("org.onboard.window", "docking-aspect-change-range", "ad", a, s); //当类型为数组时，请输入数组大小，size_t printf("%d\n", ret); ret = kdk_settings_set_string("org.gnome.evolution", "version", "3.36.1"); ret = kdk_settings_set_int("org.ukui.audio", "output-volume", 67); char* res = kdk_settings_get_string("org.gnome.evolution", "version"); printf("res = %s\n", res); int key = kdk_settings_get_int("org.ukui.audio", "output-volume"); printf("key = %d\n", key); bool enabled; GVariantIter iter; kdk_gsettings_get("org.ukui.control-center.notice", "blacklist", "as", &iter); printf("enable = %d\n", enabled); // printf("value = %d\n", value); // for (int i = 0; value[i]; i++) // { // printf("[%d]Get disk info error.\n", value[i]); // } double dde = kdk_settings_get_double("org.ukui.SettingsDaemon.plugins.xsettings", "scaling-factor"); printf("dde = %0.1f\n", dde); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_gsettings_set (), .BR kdk_settings_reset (), .BR kdk_settings_set_int (), .BR kdk_gsettings_get (), .BR kdk_settings_get_string (), .BR kdk_settings_get_int () and .BR kdk_settings_get_double (). .SH "SEE ALSO" .BR kdk_gsettings_set (3), .BR kdk_settings_reset (3), .BR kdk_settings_set_int (3), .BR kdk_gsettings_get (3), .BR kdk_settings_get_string (3), .BR kdk_settings_get_int (3) and .BR kdk_settings_get_double (3). .SH "Author" .PP Generated automatically by Doxygen for libkygsetting.h from the source code\&. libkysdk-base/man/utils/0000775000175000017500000000000015161635377014155 5ustar fengfenglibkysdk-base/man/utils/strstripblank.30000664000175000017500000000276115161635377017151 0ustar fengfeng.TH "STRSTRIPBLANK" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strstripblank \- 删除给定字符串前后的空格和水平制表符（tab） .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static void strstripblank (char * str)\fC [inline]\fP, \fC [static]\fP" .PP 删除给定字符串前后的空格和水平制表符（tab），注意该操作会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要修改的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是删除给定字符串前后的空格和水平制表符（tab），注意该操作会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/str2lower.30000664000175000017500000000273315161635377016211 0ustar fengfeng.TH "STR2LOWER" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME str2lower \- 将字符串中的所有大写字母转化为小写字母 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static void str2lower (char * str)\fC [inline]\fP, \fC [static]\fP" .PP 将字符串中的所有大写字母转化为小写字母；注意该操作会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要操作的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是将字符串中的所有大写字母转化为小写字母；注意该操作会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strskipspace.30000664000175000017500000000305615161635377016760 0ustar fengfeng.TH "STRSKIPSPACE" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strskipspace \- 跳过字符串前的所有空格、制表符、换行符 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static const char* strskipspace (const char * p)\fC [inline]\fP, \fC [static]\fP" .PP 跳过字符串前的所有空格、制表符、换行符；该操作不会修改原字符串 .PP \fBParameters\fP .RS 4 \fIp\fP 指向原字符串的指针 .RE .PP \fBReturns\fP .RS 4 const char* 指向跳过space后的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是跳过字符串前的所有空格、制表符、换行符；该操作不会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_skiplist_delete.30000664000175000017500000000533415161635377020637 0ustar fengfeng.TH "KYSDK_SKIPLIST_DELETE" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_skiplist_delete \- 删除key值对应的节点 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "int kysdk_skiplist_delete (\fBkysdk_skiplist\fP * list, int key)" .PP 删除key值对应的节点 .PP \fBParameters\fP .RS 4 \fIlist\fP 需要操作的链表 .br \fIkey\fP 键 .RE .PP \fBReturns\fP .RS 4 int, 成功删除返回0，失败返回-1 .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是删除key值对应的节点 .SH EXAMPLES .EX #include #include #include #include #include #define ARRAY_SIZE 20 int array[ARRAY_SIZE]; int del_flag[ARRAY_SIZE] = {0}; void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_delete(kysdk_skiplist *list) { for (int i = 0; i < ARRAY_SIZE; i ++) { if (random() % 2) { del_flag[i] = 1; kysdk_skiplist_delete(list, array[i]); printf("Deleted %d\n", array[i]); } } for (int i = 0; i < ARRAY_SIZE; i ++) { if (del_flag[i] && kysdk_skiplist_search(list, array[i]).num != -1) { printf("Skiplist delete test failed.\n"); return -1; } } printf("Skiplist order test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < ARRAY_SIZE; i ++) { array[i] = i; kysdk_skiplist_insert(list, i, (kysdk_listdata)i); printf("%d has been insert.\n", i); sleep(1); } print_list(list); int res = test_list_delete(list); print_list(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_insert () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_insert (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/strcounts.30000664000175000017500000000271315161635377016310 0ustar fengfeng.TH "STRCOUNTS" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strcounts \- 统计给定字符在字符串中出现的次数 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static size_t strcounts (const char * str, char ch)\fC [inline]\fP, \fC [static]\fP" .PP 统计给定字符在字符串中出现的次数 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIch\fP 需要统计的字符 .RE .PP \fBReturns\fP .RS 4 size_t 字符出现的次数 .RE .PP .PP Referenced by strsplit()\&. .SH "Detailed Description" .PP 接口的主要功能是判断str是否以postfix结尾；注意该函数区分大小写 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strsplit.30000664000175000017500000000345415161635377016133 0ustar fengfeng.TH "STRSPLIT" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strsplit \- 对原字符串以给定的分隔符进行分割 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static char** strsplit (char * str, char delim)\fC [inline]\fP, \fC [static]\fP" .PP 对原字符串以给定的分隔符进行分割，注意该函数会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要分割的字符串 .br \fIdelim\fP 分隔符 .RE .PP \fBReturns\fP .RS 4 char** 分割后的字符串列表，以NULL结尾。存储分割后所有字符串的字符串列表本身是由alloc申请的内存，因此当使用 完成后应当被free；而分割出来的各个字符串不是申请的内存，而是分别指向了原字符串中的特定位置，因此他们不需要被分别free .RE .PP .PP References strcounts()\&. .SH "Detailed Description" .PP 接口的主要功能是对原字符串以给定的分隔符进行分割，注意该函数会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith () and .BR strcounts (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3) and .BR strcounts (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strendwith.30000664000175000017500000000277615161635377016450 0ustar fengfeng.TH "STRENDWITH" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strendwith \- 判断str是否以postfix结尾；注意该函数区分大小写 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static int strendwith (const char * str, const char * postfix)\fC [inline]\fP, \fC [static]\fP" .PP 判断str是否以postfix结尾；注意该函数区分大小写 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIpostfix\fP 需要匹配的字符串后缀 .RE .PP \fBReturns\fP .RS 4 int 若str以postfix结尾，则返回0；否则返回1 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是判断str是否以postfix结尾；注意该函数区分大小写 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_skiplist_search.30000664000175000017500000000556215161635377020645 0ustar fengfeng.TH "KYSDK_SKIPLIST_SEARCH" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_skiplist_search \- 根据给定的key搜索data内容 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "kysdk_listdata kysdk_skiplist_search (\fBkysdk_skiplist\fP * list, int key)" .PP 根据给定的key搜索data内容 .PP \fBParameters\fP .RS 4 \fIlist\fP 需要操作的链表 .br \fIkey\fP 键 .RE .PP \fBReturns\fP .RS 4 kysdk_listdata， 当搜索的key不存在时，data\&.num值为-1 \fBtypedef union _kysdk_listdata { .br void *ptr; int num; .br } kysdk_listdata;\fP .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是根据给定的key搜索data内容 .SH EXAMPLES .EX #include #include #include #include #include #define ARRAY_SIZE 20 int array[ARRAY_SIZE]; int del_flag[ARRAY_SIZE] = {0}; void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_delete(kysdk_skiplist *list) { for (int i = 0; i < ARRAY_SIZE; i ++) { if (random() % 2) { del_flag[i] = 1; kysdk_skiplist_delete(list, array[i]); printf("Deleted %d\n", array[i]); } } for (int i = 0; i < ARRAY_SIZE; i ++) { if (del_flag[i] && kysdk_skiplist_search(list, array[i]).num != -1) { printf("Skiplist delete test failed.\n"); return -1; } } printf("Skiplist order test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < ARRAY_SIZE; i ++) { array[i] = i; kysdk_skiplist_insert(list, i, (kysdk_listdata)i); printf("%d has been insert.\n", i); sleep(1); } print_list(list); int res = test_list_delete(list); print_list(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_insert () and .BR kysdk_skiplist_delete (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_insert (3) and .BR kysdk_skiplist_delete (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/str2upper.30000664000175000017500000000273315161635377016214 0ustar fengfeng.TH "STR2UPPER" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME str2upper \- 将字符串中的所有小写字母转化为大写字母 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static void str2upper (char * str)\fC [inline]\fP, \fC [static]\fP" .PP 将字符串中的所有小写字母转化为大写字母；注意该操作会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要操作的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是将字符串中的所有小写字母转化为大写字母；注意该操作会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strfirstof.30000664000175000017500000000312515161635377016447 0ustar fengfeng.TH "STRFIRSTOF" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strfirstof \- 在给定的字符串中查找给定字符第一次出现的位置 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static int strfirstof (const char * str, char ch)\fC [inline]\fP, \fC [static]\fP" .PP 在给定的字符串中查找给定字符第一次出现的位置；计数从0开始 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIch\fP 需要查找的字符 .RE .PP \fBReturns\fP .RS 4 int 第一次出现的位置，若未找到给定的字符，则返回-1 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是在给定的字符串中查找给定字符第一次出现的位置；计数从0开始 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_destroy_skiplist.30000664000175000017500000000562715161635377021073 0ustar fengfeng.TH "KYSDK_DESTROY_SKIPLIST" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_destroy_skiplist \- 销毁跳表 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "void kysdk_destroy_skiplist (\fBkysdk_skiplist\fP * list)" .PP 销毁跳表，并回收所有分配的内存；注意data\&.ptr指向的内存（若存在）不会被释放 .PP \fBParameters\fP .RS 4 \fIlist\fP 跳表 .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是销毁跳表，并回收所有分配的内存；注意data\&.ptr指向的内存（若存在）不会被释放 .SH EXAMPLES .EX #include #include #include #include #include void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_search(kysdk_skiplist *list) { for (int i = 0; i < 5; i ++) { int target = random() % 50 + 1; kysdk_listdata data = kysdk_skiplist_search(list, target); printf("Searching for %d, data is %d\n", target, data.num); kysdk_skiplist_node *curnode = list->children[0]; short finded = 0; while (curnode) { if (curnode->key == target) { finded = 1; break; } curnode = curnode->next[0]; } if (finded && data.num == -1) { printf("Skiplist search test failed.\n"); return -1; } } printf("Skiplist search test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < 20; i ++) { int num = random() % 50 + 1; kysdk_listdata data; data.num = i; kysdk_skiplist_insert(list, num, data); printf("[%d] %d has been insert.\n", i, num); sleep(1); } print_list(list); int res = test_list_search(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_insert (), .BR kysdk_skiplist_delete () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_insert (3), .BR kysdk_skiplist_delete (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/strstrip.30000664000175000017500000000275615161635377016145 0ustar fengfeng.TH "STRSTRIP" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strstrip \- 对给定的字符串进行strip操作，删减字符串前后的指定字符 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static void str2lower (char * str)\fC [inline]\fP, \fC [static]\fP" .PP 将字符串中的所有大写字母转化为小写字母；注意该操作会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要操作的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是将字符串中的所有大写字母转化为小写字母；注意该操作会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strstartswith_nocase.30000664000175000017500000000302215161635377020533 0ustar fengfeng.TH "STRSTARTSWITH_NOCASE" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strstartswith_nocase \- 判断str是否以prefix开头；不区分大小写 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static int strstartswith_nocase (const char * str, const char * prefix)\fC [inline]\fP, \fC [static]\fP" .PP 判断str是否以prefix开头；不区分大小写 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIprefix\fP 需要匹配的字符串前缀 .RE .PP \fBReturns\fP .RS 4 int 若str以prefix开头，则返回0；否则返回1 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是判断str是否以prefix开头；不区分大小写 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strskipblank.30000664000175000017500000000306415161635377016753 0ustar fengfeng.TH "STRSKIPBLANK" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strskipblank \- 跳过字符串前的所有空格、制表符、换行符 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static const char* strskipblank (const char * p)\fC [inline]\fP, \fC [static]\fP" .PP 跳过字符串前的所有空格和水平制表符（tab）；该操作不会修改原字符串 .PP \fBParameters\fP .RS 4 \fIp\fP 指向原字符串的指针 .RE .PP \fBReturns\fP .RS 4 const char* 指向跳过space后的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是跳过字符串前的所有空格和水平制表符（tab）；该操作不会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/strstartswith.30000664000175000017500000000305615161635377017212 0ustar fengfeng.TH "STRSTARTSWITH" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strstartswith \- 判断str是否以prefix开头；注意该函数区分大小写 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static int strstartswith (const char * str, const char * prefix)\fC [inline]\fP, \fC [static]\fP" .PP 判断str是否以prefix开头；注意该函数区分大小写 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIprefix\fP 需要匹配的字符串前缀 .RE .PP \fBReturns\fP .RS 4 int 若str以prefix开头，则返回0；否则返回1 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是判断str是否以prefix开头；注意该函数区分大小写 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_create_skiplist.30000664000175000017500000000530515161635377020636 0ustar fengfeng.TH "KYSDK_CREATE_SKIPLIST" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_create_skiplist \- 创建跳表 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "\fBkysdk_skiplist\fP* kysdk_create_skiplist ()" .PP 创建跳表 .PP \fBReturns\fP .RS 4 kysdk_skiplist* .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是创建跳表 .SH EXAMPLES .EX #include #include #include #include #include void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_search(kysdk_skiplist *list) { for (int i = 0; i < 5; i ++) { int target = random() % 50 + 1; kysdk_listdata data = kysdk_skiplist_search(list, target); printf("Searching for %d, data is %d\n", target, data.num); kysdk_skiplist_node *curnode = list->children[0]; short finded = 0; while (curnode) { if (curnode->key == target) { finded = 1; break; } curnode = curnode->next[0]; } if (finded && data.num == -1) { printf("Skiplist search test failed.\n"); return -1; } } printf("Skiplist search test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < 20; i ++) { int num = random() % 50 + 1; kysdk_listdata data; data.num = i; kysdk_skiplist_insert(list, num, data); printf("[%d] %d has been insert.\n", i, num); sleep(1); } print_list(list); int res = test_list_search(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_insert (), .BR kysdk_skiplist_delete () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_insert (3), .BR kysdk_skiplist_delete (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/libkydatastruct.30000664000175000017500000000470115161635377017454 0ustar fengfeng.TH "LIBKYDATASTRUCT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkydatastruct \- 时间复杂度: 插入（平均）: O(log(n)) 删除（平均）: O(log(n)) 查找（平均）: O(log(n)) 空间复杂度: O(n) .SH SYNOPSIS .SS "Typedefs" .in +1c .ti -1c .RI "typedef struct \fB_kysdk_skiplist_node\fP \fBkysdk_skiplist_node\fP" \fBtypedef struct _kysdk_skiplist_node { .br int key; kysdk_listdata data; struct _kysdk_skiplist_node **next; .br } kysdk_skiplist_node;\fP .br .ti -1c .RI "typedef struct \fB_kysdk_skiplist\fP \fBkysdk_skiplist\fP" \fBtypedef struct _kysdk_skiplist { .br unsigned int counts; // 节点个数 unsigned int max_levels; // 最高层数 kysdk_skiplist_node **children; .br } kysdk_skiplist;\fP .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "\fBkysdk_skiplist\fP * \fBkysdk_create_skiplist\fP ()" .br .RI "创建跳表 " .ti -1c .RI "void \fBkysdk_destroy_skiplist\fP (\fBkysdk_skiplist\fP *list)" .br .RI "销毁跳表，并回收所有分配的内存；注意data\&.ptr指向的内存（若存在）不会被释放 " .ti -1c .RI "int \fBkysdk_skiplist_setmaxlevels\fP (\fBkysdk_skiplist\fP *list, unsigned int maxlevels)" .br .RI "设置跳表最高层数，该选项必须在跳表为空时使用 " .ti -1c .RI "int \fBkysdk_skiplist_insert\fP (\fBkysdk_skiplist\fP *list, int key, kysdk_listdata data)" .br .RI "插入节点 " .ti -1c .RI "int \fBkysdk_skiplist_delete\fP (\fBkysdk_skiplist\fP *list, int key)" .br .RI "删除key值对应的节点 " .ti -1c .RI "kysdk_listdata \fBkysdk_skiplist_search\fP (\fBkysdk_skiplist\fP *list, int key)" .br .RI "根据给定的key搜索data内容 " .in -1c .SH "Detailed Description" .PP 时间复杂度: 插入（平均）: O(log(n)) 删除（平均）: O(log(n)) 查找（平均）: O(log(n)) 空间复杂度: O(n) .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_insert (), .BR kysdk_skiplist_delete () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_insert (3), .BR kysdk_skiplist_delete (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/libkyutils.30000664000175000017500000000274415161635377016443 0ustar fengfeng.TH "LIBKYUTILS" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkyutils \- 单位进制转换组件 .SH SYNOPSIS .SS "Enumerations" .in +1c .ti -1c .RI "enum \fBKDKUtilsErrCode\fP { \fBKDK_NOERR\fP, \fBKDK_INVAILD_BASE\fP, \fBKDK_INVAILD_ARGUMENT\fP, \fBKDK_INVAILD_DATA_FORMAT\fP, \fBKDK_SYSTEM_UNKOWNERR\fP }" .br .ti -1c .RI "enum \fBKDKVolumeBaseType\fP { \fBKDK_KILOBYTE\fP = 1, \fBKDK_MEGABYTE\fP, \fBKDK_GIGABYTE\fP, \fBKDK_TERABYTE\fP, \fBKDK_PETABYTE\fP, \fBKDK_EXABYTE\fP, \fBKDK_KILO\fP, \fBKDK_MEGA\fP, \fBKDK_GIGA\fP, \fBKDK_TERA\fP, \fBKDK_PETA\fP, \fBKDK_EXA\fP }" .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "int \fBkdkVolumeBaseCharacterConvert\fP (const char *origin_data, \fBKDKVolumeBaseType\fP result_base, char *result_data)" .br .RI "字符格式单位进制转换 " .ti -1c .RI "int \fBkdkVolumeBaseNumericalConvert\fP (double origin_numerical, \fBKDKVolumeBaseType\fP origin_base, \fBKDKVolumeBaseType\fP result_base, double *result_numerical)" .br .RI "数字格式单位进制转换 " .in -1c .SH "Detailed Description" 单位进制转换组件 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdkVolumeBaseCharacterConvert () and .BR kdkVolumeBaseNumericalConvert (). .SH "SEE ALSO" .BR kdkVolumeBaseCharacterConvert (3) and .BR kdkVolumeBaseNumericalConvert (3). .SH "Author" .PP Generated automatically by Doxygen for kyutils.h from the source code\&. libkysdk-base/man/utils/kdkVolumeBaseCharacterConvert.30000664000175000017500000000347515161635377022164 0ustar fengfeng.TH "KDKVOLUMEBASECHARACTERCONVERT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdkVolumeBaseCharacterConvert \- 字符格式单位进制转换 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "int kdkVolumeBaseCharacterConvert (const char * origin_data, \fBKDKVolumeBaseType\fP result_base, char * result_data)" .PP 字符格式单位进制转换 .PP \fBParameters\fP .RS 4 \fIorigin_data\fP 原始字符类型的数据，以具体进制单位结束，如果没有，缺省为‘B’ .br \fIresult_base\fP 期望的结果进制单位 .br \fIresult_data\fP 转化进制后的字符数据，带进制单位 .RE .PP \fBReturns\fP .RS 4 int .RE .PP Link with \fI\-lkyutils\fP. .SH "Detailed Description" 接口的主要功能是单位进制转换组件 .SH EXAMPLES .EX #include "kyutils.h" #include #include int main() { int ret = 0; // 调用字符型数据单位转换接口 char origin_data [20] = "10000.24MB"; char result_data [50] = {0}; ret = kdkVolumeBaseCharacterConvert(origin_data, KDK_GIGABYTE, result_data); printf("%s\n", result_data); // 调用数字型数据单位转换接口 // 此例亦可说明，在低进制不足以向高进制转换时，进制保持不变 double origin_numberical = 100.24; double result_numberical; ret = kdkVolumeBaseNumericalConvert(origin_numberical, KDK_MEGABYTE, KDK_GIGABYTE, &result_numberical); printf("%.2f\n", result_numberical); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdkVolumeBaseNumericalConvert (). .SH "SEE ALSO" .BR kdkVolumeBaseNumericalConvert (3). .SH "Author" .PP Generated automatically by Doxygen for kyutils.h from the source code\&. libkysdk-base/man/utils/strstripspace.30000664000175000017500000000276315161635377017157 0ustar fengfeng.TH "STRSTRIPSPACE" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strstripspace \- 删除给定字符串前后的空格、制表符、换行符 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static void strstripspace (char * str)\fC [inline]\fP, \fC [static]\fP" .PP 删除给定字符串前后的空格、制表符、换行符，注意该操作会修改原字符串 .PP \fBParameters\fP .RS 4 \fIstr\fP 需要进行strip操作的字符串指针 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是删除给定字符串前后的空格、制表符、换行符，注意该操作会修改原字符串 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strlastof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strlastof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_skiplist_insert.30000664000175000017500000000556315161635377020705 0ustar fengfeng.TH "KYSDK_SKIPLIST_INSERT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_skiplist_insert \- 插入节点 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "int kysdk_skiplist_insert (\fBkysdk_skiplist\fP * list, int key, kysdk_listdata data)" .PP 插入节点 .PP \fBParameters\fP .RS 4 \fIlist\fP 需要操作的链表 .br \fIkey\fP 键 .br \fIdata\fP 数据 .RE .PP \fBReturns\fP .RS 4 int， 成功插入返回0，失败返回-1 .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是插入节点 .SH EXAMPLES .EX #include #include #include #include #include void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_search(kysdk_skiplist *list) { for (int i = 0; i < 5; i ++) { int target = random() % 50 + 1; kysdk_listdata data = kysdk_skiplist_search(list, target); printf("Searching for %d, data is %d\n", target, data.num); kysdk_skiplist_node *curnode = list->children[0]; short finded = 0; while (curnode) { if (curnode->key == target) { finded = 1; break; } curnode = curnode->next[0]; } if (finded && data.num == -1) { printf("Skiplist search test failed.\n"); return -1; } } printf("Skiplist search test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < 20; i ++) { int num = random() % 50 + 1; kysdk_listdata data; data.num = i; kysdk_skiplist_insert(list, num, data); printf("[%d] %d has been insert.\n", i, num); sleep(1); } print_list(list); int res = test_list_search(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_setmaxlevels (), .BR kysdk_skiplist_delete () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_setmaxlevels (3), .BR kysdk_skiplist_delete (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/utils/kdkVolumeBaseNumericalConvert.30000664000175000017500000000352015161635377022176 0ustar fengfeng.TH "KDKVOLUMEBASENUMERICALCONVERT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdkVolumeBaseNumericalConvert \- 数字格式单位进制转换 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "int kdkVolumeBaseNumericalConvert (double origin_numerical, \fBKDKVolumeBaseType\fP origin_base, \fBKDKVolumeBaseType\fP result_base, double * result_numerical)" .PP 数字格式单位进制转换 .PP \fBParameters\fP .RS 4 \fIorigin_numerical\fP 原始数字类型数据 .br \fIorigin_base\fP 原始的进制单位 .br \fIresult_base\fP 期望的进制单位 .br \fIresult_numerical\fP 期望进制下的数字类型数据 .RE .PP \fBReturns\fP .RS 4 int .RE .PP Link with \fI\-lkyutils\fP. .SH "Detailed Description" 接口的主要功能是数字格式单位进制转换 .SH EXAMPLES .EX #include "kyutils.h" #include #include int main() { int ret = 0; // 调用字符型数据单位转换接口 char origin_data [20] = "10000.24MB"; char result_data [50] = {0}; ret = kdkVolumeBaseCharacterConvert(origin_data, KDK_GIGABYTE, result_data); printf("%s\n", result_data); // 调用数字型数据单位转换接口 // 此例亦可说明，在低进制不足以向高进制转换时，进制保持不变 double origin_numberical = 100.24; double result_numberical; ret = kdkVolumeBaseNumericalConvert(origin_numberical, KDK_MEGABYTE, KDK_GIGABYTE, &result_numberical); printf("%.2f\n", result_numberical); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdkVolumeBaseCharacterConvert (). .SH "SEE ALSO" .BR kdkVolumeBaseCharacterConvert (3). .SH "Author" .PP Generated automatically by Doxygen for kyutils.h from the source code\&. libkysdk-base/man/utils/strlastof.30000664000175000017500000000314015161635377016260 0ustar fengfeng.TH "STRLASTOF" 3 "Sat Sep 23 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME strlastof \- 在给定的字符串中查找给定字符最后一次出现的位置 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "static int strlastof (const char * str, char ch)\fC [inline]\fP, \fC [static]\fP" .PP 在给定的字符串中查找给定字符最后一次出现的位置；计数从0开始 .PP \fBParameters\fP .RS 4 \fIstr\fP 原字符串 .br \fIch\fP 需要查找的字符 .RE .PP \fBReturns\fP .RS 4 int 最后一次出现的位置，若未找到给定的字符，则返回-1 .RE .PP .SH "Detailed Description" .PP 接口的主要功能是在给定的字符串中查找给定字符最后一次出现的位置；计数从0开始 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR strstrip (), .BR strstripspace (), .BR strstripblank (), .BR strskipspace (), .BR strskipblank (), .BR str2upper (), .BR str2lower (), .BR strfirstof (), .BR strstartswith (), .BR strstartswith_nocase (), .BR strendwith (), .BR strendwith_nocase (), .BR strcounts () and .BR strsplit (). .SH "SEE ALSO" .BR strstrip (3), .BR strstripspace (3), .BR strstripblank (3), .BR strskipspace (3), .BR strskipblank (3), .BR str2upper (3), .BR str2lower (3), .BR strfirstof (3), .BR strstartswith (3), .BR strstartswith_nocase (3), .BR strendwith (3), .BR strendwith_nocase (3), .BR strcounts (3) and .BR strsplit (3). .SH "Author" .PP Generated automatically by Doxygen for cstring-extension.h from the source code\&. libkysdk-base/man/utils/kysdk_skiplist_setmaxlevels.30000664000175000017500000000572415161635377022114 0ustar fengfeng.TH "KYSDK_SKIPLIST_SETMAXLEVELS" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kysdk_skiplist_setmaxlevels \- 设置跳表最高层数 .SH SYNOPSIS br .PP \fC#include \fP .br .SS "Functions" .SS "int kysdk_skiplist_setmaxlevels (\fBkysdk_skiplist\fP * list, unsigned int maxlevels)" .PP 设置跳表最高层数，该选项必须在跳表为空时使用 .PP \fBParameters\fP .RS 4 \fIlist\fP 需要修改的跳表 .br \fImaxlevels\fP 层数 .RE .PP \fBReturns\fP .RS 4 int 成功返回0，失败返回-1 .RE .PP Link with \fI\-lkydatastruct\fP. .SH "Detailed Description" .PP 接口的主要功能是设置跳表最高层数，该选项必须在跳表为空时使用 .SH EXAMPLES .EX #include #include #include #include #include void print_list(kysdk_skiplist *list) { for (int i = list->max_levels - 1; i >= 0; i --) { kysdk_skiplist_node *curnode = list->children[i]; printf("Level[%d]: ", i); while (curnode) { printf("%d->", curnode->key); curnode = curnode->next[i]; } printf("NULL\n"); } } int test_list_search(kysdk_skiplist *list) { for (int i = 0; i < 5; i ++) { int target = random() % 50 + 1; kysdk_listdata data = kysdk_skiplist_search(list, target); printf("Searching for %d, data is %d\n", target, data.num); kysdk_skiplist_node *curnode = list->children[0]; short finded = 0; while (curnode) { if (curnode->key == target) { finded = 1; break; } curnode = curnode->next[0]; } if (finded && data.num == -1) { printf("Skiplist search test failed.\n"); return -1; } } printf("Skiplist search test pass.\n"); return 0; } int main() { kysdk_skiplist *list = kysdk_create_skiplist(); kysdk_skiplist_setmaxlevels(list, 5); srand(time(NULL)); for (int i = 0; i < 20; i ++) { int num = random() % 50 + 1; kysdk_listdata data; data.num = i; kysdk_skiplist_insert(list, num, data); printf("[%d] %d has been insert.\n", i, num); sleep(1); } print_list(list); int res = test_list_search(list); kysdk_destroy_skiplist(list); return res; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kysdk_create_skiplist (), .BR kysdk_destroy_skiplist (), .BR kysdk_skiplist_insert (), .BR kysdk_skiplist_delete () and .BR kysdk_skiplist_search (). .SH "SEE ALSO" .BR kysdk_create_skiplist (3), .BR kysdk_destroy_skiplist (3), .BR kysdk_skiplist_insert (3), .BR kysdk_skiplist_delete (3) and .BR kysdk_skiplist_search (3). .SH "Author" .PP Generated automatically by Doxygen for skip_linklist.h from the source code\&. libkysdk-base/man/timer/0000775000175000017500000000000015161635377014135 5ustar fengfenglibkysdk-base/man/timer/kdk_timer_reset.30000664000175000017500000000522715161635377017402 0ustar fengfeng.TH "KDK_TIMER_SESET" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_timer_reset \- 重置定时器时间至intervalms .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void kdk_timer_reset (size_t timerfd, unsigned int intervalms)" .PP 重置定时器时间至intervalms，以毫秒为单位 .PP \fBParameters\fP .RS 4 \fItimerfd\fP 由kdk_timer_start返回的定时器ID .br \fIintervalms\fP 需要调整的时间间隔，以ms为单位 .RE .PP Link with \fI\-lkytimer\fP. .SH "Detailed Description" .PP 接口的主要功能是重置定时器时间至intervalms，以毫秒为单位 .SH EXAMPLES .EX #include #include #include #include #include #include #include void func(char* comment) { char date[32] = {0}; time_t now; time(&now); if (ctime_r(&now , date)) date[strlen(date) - 1] = '\0'; printf("[%s]这是%s\n" , date , comment); } void stop(size_t* fdpoll) { printf("开始停止定时器\n"); for (int i = 0 ; i < 10 ; i ++) { kdk_timer_stop(fdpoll[i]); } } int main() { assert(kdk_timer_init() == 0); //测试1 -- 基本功能 size_t fdpoll[10] = {0}; // for (int i = 1 ; i <= 10 ; i ++) // { // char* data = (char*)malloc(10); // assert(data); // sprintf(data , "%d号" , i); // fdpoll[i - 1] = kdk_timer_start(i * 1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, (void*)data , 1); // assert(fdpoll[i - 1]); // } kdk_timer_start(10000 , (time_handler)stop , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, (void*)fdpoll , 0); sleep(11); //测试3 -- 单次触发 printf("单次触发测试：\n"); kdk_timer_start(2000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "2号" , 0); sleep(5); //测试2 -- 重置定时器时间 printf("修改时间测试：\n"); int persec = kdk_timer_start(1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, "1号" , 0); int sec3 = kdk_timer_start(3000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "3号" , 0); sleep(2); kdk_timer_reset(sec3 , 4000); printf("sec3 时钟已被重置为4000ms\n"); sleep(10); printf("正在销毁定时器核心...\n"); kdk_timer_destroy(); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_init (), .BR kdk_timer_start (), .BR kdk_timer_stop () and .BR kdk_timer_destroy (). .SH "SEE ALSO" .BR kdk_timer_init (3), .BR kdk_timer_start (3), .BR kdk_timer_stop (3) and .BR kdk_timer_destroy (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/man/timer/kdk_timer_init.30000664000175000017500000000475115161635377017224 0ustar fengfeng.TH "KDK_TIMER_INIT" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_timer_init \- 初始化定时器核心组件 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "int kdk_timer_init ()" .PP 初始化定时器核心组件 .PP \fBReturns\fP .RS 4 int 成功返回0，失败返回错误码 .RE .PP Link with \fI\-lkytimer\fP. .SH "Detailed Description" .PP 接口的主要功能是初始化定时器核心组件 .SH EXAMPLES .EX #include #include #include #include #include #include #include void func(char* comment) { char date[32] = {0}; time_t now; time(&now); if (ctime_r(&now , date)) date[strlen(date) - 1] = '\0'; printf("[%s]这是%s\n" , date , comment); } void stop(size_t* fdpoll) { printf("开始停止定时器\n"); for (int i = 0 ; i < 10 ; i ++) { kdk_timer_stop(fdpoll[i]); } } int main() { assert(kdk_timer_init() == 0); //测试1 -- 基本功能 size_t fdpoll[10] = {0}; // for (int i = 1 ; i <= 10 ; i ++) // { // char* data = (char*)malloc(10); // assert(data); // sprintf(data , "%d号" , i); // fdpoll[i - 1] = kdk_timer_start(i * 1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, (void*)data , 1); // assert(fdpoll[i - 1]); // } kdk_timer_start(10000 , (time_handler)stop , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, (void*)fdpoll , 0); sleep(11); //测试3 -- 单次触发 printf("单次触发测试：\n"); kdk_timer_start(2000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "2号" , 0); sleep(5); //测试2 -- 重置定时器时间 printf("修改时间测试：\n"); int persec = kdk_timer_start(1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, "1号" , 0); int sec3 = kdk_timer_start(3000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "3号" , 0); sleep(2); kdk_timer_reset(sec3 , 4000); printf("sec3 时钟已被重置为4000ms\n"); sleep(10); printf("正在销毁定时器核心...\n"); kdk_timer_destroy(); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_start (), .BR kdk_timer_stop (), .BR kdk_timer_reset () and .BR kdk_timer_destroy (). .SH "SEE ALSO" .BR kdk_timer_start (3), .BR kdk_timer_stop (3), .BR kdk_timer_reset (3) and .BR kdk_timer_destroy (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/man/timer/libkytimer.30000664000175000017500000000467415161635377016407 0ustar fengfeng.TH "LIBKYTIMER" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME libkytimer \- KYSDK C语言定时器模块 .SH SYNOPSIS .SS "Classes" .SS "Typedefs" .in +1c .ti -1c .RI "typedef void *(* \fBtime_handler\fP) (void *user_data)" .br .ti -1c .RI "typedef struct \fB_KTimerNode\fP \fBKTimerNode\fP" .br .in -1c .SS "Enumerations" .in +1c .ti -1c .RI "enum \fBKTimerAttribute\fP { \fBKTIMER_SINGLESHOT\fP = 0, \fBKTIMER_PERIODIC\fP = 1, \fBKTIMER_NEVER\fP = 2 }" .br .ti -1c .RI "enum \fBKTimerType\fP { \fBKTIMER_ABSOLUTE\fP = 0, \fBKTIMER_RELATIVE\fP }" .br .in -1c .SS "Functions" .in +1c .ti -1c .RI "int \fBkdk_timer_init\fP ()" .br .RI "初始化定时器核心组件 " .ti -1c .RI "size_t \fBkdk_timer_start\fP (unsigned int intervalms, time_handler callback, KTimerAttribute attr, KTimerType type, void *userdata, int freeOnDelete)" .br .RI "启动一个定时器 " .ti -1c .RI "void \fBkdk_timer_stop\fP (size_t timerfd)" .br .RI "停止给定的定时器 " .ti -1c .RI "void \fBkdk_timer_reset\fP (size_t timerfd, unsigned int intervalms)" .br .RI "重置定时器时间至intervalms，以毫秒为单位 " .ti -1c .RI "void \fBkdk_timer_destroy\fP ()" .br .RI "销毁定时器核心 " .in -1c .SH DATA STRUCTURES \fBtypedef struct _KTimerNode { .br pthread_mutex_t lock; size_t fd; //序列号 time_handler callback; //到期后执行的函数 int freeOnDelete; //删除定时器时自动释放userdata void* userdata; //callback使用的参数，外部使用alloc分配内存，在delete定时器的时候会根据配置自动释放 unsigned int intervalms; //定时器间隔时间，单位毫秒 KTimerAttribute attr; //触发类型，单次触发或多次触发 KTimerType type; //时钟类型，绝对时间还是相对时间 struct _KTimerNode* next; .br } KTimerNode;\fP There are other members not documented here, which are only meant for libkytimer internal use. .SH "Detailed Description" .PP KYSDK C语言定时器模块 .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_init (), .BR kdk_timer_start (), .BR kdk_timer_stop (), .BR kdk_timer_reset () and .BR kdk_timer_destroy (). .SH "SEE ALSO" .BR kdk_timer_init (3), .BR kdk_timer_start (3), .BR kdk_timer_stop (3), .BR kdk_timer_reset (3) and .BR kdk_timer_destroy (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/man/timer/kdk_timer_stop.30000664000175000017500000000476215161635377017250 0ustar fengfeng.TH "KDK_TIMER_STOP" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_timer_stop \- 停止给定的定时器 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void kdk_timer_stop (size_t timerfd)" .PP 停止给定的定时器 .PP \fBParameters\fP .RS 4 \fItimerfd\fP 由kdk_timer_start返回的定时器ID .RE .PP Link with \fI\-lkytimer\fP. .SH "Detailed Description" .PP 接口的主要功能是停止给定的定时器 .SH EXAMPLES .EX #include #include #include #include #include #include #include void func(char* comment) { char date[32] = {0}; time_t now; time(&now); if (ctime_r(&now , date)) date[strlen(date) - 1] = '\0'; printf("[%s]这是%s\n" , date , comment); } void stop(size_t* fdpoll) { printf("开始停止定时器\n"); for (int i = 0 ; i < 10 ; i ++) { kdk_timer_stop(fdpoll[i]); } } int main() { assert(kdk_timer_init() == 0); //测试1 -- 基本功能 size_t fdpoll[10] = {0}; // for (int i = 1 ; i <= 10 ; i ++) // { // char* data = (char*)malloc(10); // assert(data); // sprintf(data , "%d号" , i); // fdpoll[i - 1] = kdk_timer_start(i * 1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, (void*)data , 1); // assert(fdpoll[i - 1]); // } kdk_timer_start(10000 , (time_handler)stop , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, (void*)fdpoll , 0); sleep(11); //测试3 -- 单次触发 printf("单次触发测试：\n"); kdk_timer_start(2000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "2号" , 0); sleep(5); //测试2 -- 重置定时器时间 printf("修改时间测试：\n"); int persec = kdk_timer_start(1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, "1号" , 0); int sec3 = kdk_timer_start(3000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "3号" , 0); sleep(2); kdk_timer_reset(sec3 , 4000); printf("sec3 时钟已被重置为4000ms\n"); sleep(10); printf("正在销毁定时器核心...\n"); kdk_timer_destroy(); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_init (), .BR kdk_timer_start (), .BR kdk_timer_reset () and .BR kdk_timer_destroy (). .SH "SEE ALSO" .BR kdk_timer_init (3), .BR kdk_timer_start (3), .BR kdk_timer_reset (3) and .BR kdk_timer_destroy (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/man/timer/kdk_timer_start.30000664000175000017500000000624215161635377017413 0ustar fengfeng.TH "KDK_TIMER_START" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_timer_start \- 启动一个定时器 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "size_t kdk_timer_start (unsigned int intervalms, time_handler callback, KTimerAttribute attr, KTimerType type, void * userdata, int freeOnDelete)" .PP 启动一个定时器 .PP \fBParameters\fP .RS 4 \fIintervalms\fP 定时器时间，以毫秒为单位 .br \fIcallback\fP 定时器到期后触发的回调函数指针 .br \fIattr\fP 定时器属性，KTIMER_SINGLESHOT表示一次性定时器；KTIMER_PERIODIC表示周期性定时器；KTIMER_NEVER表示不会被触发的定时器 .br \fItype\fP 定时器类型，KTIMER_ABSOLUTE表示绝对时间定时器，修改系统时间不会影响定时器的时间；KTIMER_RELATIVE表示相对时间定时器，修改系统时间会影响定时器时间 .br \fIuserdata\fP 指向用户数据的指针 .br \fIfreeOnDelete\fP [未启用] .RE .PP \fBReturns\fP .RS 4 size_t 定时器的ID .RE .PP Link with \fI\-lkytimer\fP. .SH "Detailed Description" .PP 接口的主要功能是启动一个定时器 .SH EXAMPLES .EX #include #include #include #include #include #include #include void func(char* comment) { char date[32] = {0}; time_t now; time(&now); if (ctime_r(&now , date)) date[strlen(date) - 1] = '\0'; printf("[%s]这是%s\n" , date , comment); } void stop(size_t* fdpoll) { printf("开始停止定时器\n"); for (int i = 0 ; i < 10 ; i ++) { kdk_timer_stop(fdpoll[i]); } } int main() { assert(kdk_timer_init() == 0); //测试1 -- 基本功能 size_t fdpoll[10] = {0}; // for (int i = 1 ; i <= 10 ; i ++) // { // char* data = (char*)malloc(10); // assert(data); // sprintf(data , "%d号" , i); // fdpoll[i - 1] = kdk_timer_start(i * 1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, (void*)data , 1); // assert(fdpoll[i - 1]); // } kdk_timer_start(10000 , (time_handler)stop , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, (void*)fdpoll , 0); sleep(11); //测试3 -- 单次触发 printf("单次触发测试：\n"); kdk_timer_start(2000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "2号" , 0); sleep(5); //测试2 -- 重置定时器时间 printf("修改时间测试：\n"); int persec = kdk_timer_start(1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, "1号" , 0); int sec3 = kdk_timer_start(3000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "3号" , 0); sleep(2); kdk_timer_reset(sec3 , 4000); printf("sec3 时钟已被重置为4000ms\n"); sleep(10); printf("正在销毁定时器核心...\n"); kdk_timer_destroy(); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_init (), .BR kdk_timer_stop (), .BR kdk_timer_reset () and .BR kdk_timer_destroy (). .SH "SEE ALSO" .BR kdk_timer_init (3), .BR kdk_timer_stop (3), .BR kdk_timer_reset (3) and .BR kdk_timer_destroy (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/man/timer/kdk_timer_destroy.30000664000175000017500000000461115161635377017745 0ustar fengfeng.TH "KDK_TIMER_DESTROY" 3 "Fri Sep 22 2023" "My Project" \" -*- nroff -*- .ad l .nh .SH NAME kdk_timer_destroy \- 销毁定时器核心 .SH SYNOPSIS .br .PP \fC#include \fP .br .SS "Functions" .SS "void kdk_timer_destroy ()" .PP 销毁定时器核心 .PP Link with \fI\-lkytimer\fP. .SH "Detailed Description" .PP 接口的主要功能是销毁定时器核心 .SH EXAMPLES .EX #include #include #include #include #include #include #include void func(char* comment) { char date[32] = {0}; time_t now; time(&now); if (ctime_r(&now , date)) date[strlen(date) - 1] = '\0'; printf("[%s]这是%s\n" , date , comment); } void stop(size_t* fdpoll) { printf("开始停止定时器\n"); for (int i = 0 ; i < 10 ; i ++) { kdk_timer_stop(fdpoll[i]); } } int main() { assert(kdk_timer_init() == 0); //测试1 -- 基本功能 size_t fdpoll[10] = {0}; // for (int i = 1 ; i <= 10 ; i ++) // { // char* data = (char*)malloc(10); // assert(data); // sprintf(data , "%d号" , i); // fdpoll[i - 1] = kdk_timer_start(i * 1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, (void*)data , 1); // assert(fdpoll[i - 1]); // } kdk_timer_start(10000 , (time_handler)stop , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, (void*)fdpoll , 0); sleep(11); //测试3 -- 单次触发 printf("单次触发测试：\n"); kdk_timer_start(2000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "2号" , 0); sleep(5); //测试2 -- 重置定时器时间 printf("修改时间测试：\n"); int persec = kdk_timer_start(1000 , (time_handler)func , KTIMER_PERIODIC , KTIMER_ABSOLUTE, "1号" , 0); int sec3 = kdk_timer_start(3000 , (time_handler)func , KTIMER_SINGLESHOT , KTIMER_ABSOLUTE, "3号" , 0); sleep(2); kdk_timer_reset(sec3 , 4000); printf("sec3 时钟已被重置为4000ms\n"); sleep(10); printf("正在销毁定时器核心...\n"); kdk_timer_destroy(); return 0; } .SH "CONFORMING TO" These functions are as per the withdrawn POSIX.1e draft specification. The following functions are Linux extensions: .BR kdk_timer_init (), .BR kdk_timer_start (), .BR kdk_timer_stop () and .BR kdk_timer_reset (). .SH "SEE ALSO" .BR kdk_timer_init (3), .BR kdk_timer_start (3), .BR kdk_timer_stop (3) and .BR kdk_timer_reset (3). .SH "Author" .PP Generated automatically by Doxygen for libkytimer.h from the source code\&. libkysdk-base/development-files/0000775000175000017500000000000015161635377015664 5ustar fengfenglibkysdk-base/development-files/kysdk-config.pc0000664000175000017500000000026615161635377020604 0ustar fengfengbase_version=3.0.1 Name: libkysdk-config Description: kysdk base layer config component Requires: kysdk-utils Version: 3.0.1 Cflags: -I/usr/include/kysdk/kysdk-base/ Libs: -lkyconf libkysdk-base/development-files/kysdk-diagnostics.pc0000664000175000017500000000023515161635377021642 0ustar fengfengName: libkysdk-diagnostics Description: kysdk base layer diagnostics component Version: 3.0.1 Cflags: -I/usr/include/kysdk/kysdk-base/ Libs: -lkydiagnostics libkysdk-base/development-files/kysdk-gsetting.pc0000664000175000017500000000026115161635377021156 0ustar fengfengName: libkysdk-gsetting Description: kysdk base layer gsettings component Requires: gtk+-3.0 glib-2.0 Version: 3.0.1 Libs: -lkygsetting Cflags: -I/usr/include/kysdk/kysdk-base/ libkysdk-base/development-files/kysdk-timer.pc0000664000175000017500000000024015161635377020447 0ustar fengfengName: libkysdk-timer Description: kysdk base layer time component Requires: kysdk-utils Version: 3.0.1 Cflags: -I/usr/include/kysdk/kysdk-base/ Libs: -lkytimer libkysdk-base/development-files/kysdk-base.pc0000664000175000017500000000033315161635377020244 0ustar fengfengbase_version=3.0.1 Name: libkysdk-base Description: kysdk base layer Requires: kysdk-log >= ${base_version} kysdk-config >= ${base_version} kysdk-timer >= ${base_version} kysdk-utils >= ${base_version} Version: 3.0.1 libkysdk-base/development-files/kysdk-log.pc0000664000175000017500000000026315161635377020115 0ustar fengfengName: libkysdk-log Description: kysdk base layer log component Requires: kysdk-config kysdk-utils libsystemd Version: 3.0.1 Cflags: -I/usr/include/kysdk/kysdk-base/ Libs: -lkylog libkysdk-base/development-files/kysdk-utils.pc0000664000175000017500000000023115161635377020467 0ustar fengfengName: libkysdk-utils Description: kysdk base layer utils component Version: 3.0.1 Cflags:-I/usr/include/kysdk/kysdk-base/ Libs: -lkydatastruct -lkyutils libkysdk-base/development-files/kysdk-conf2.pc0000664000175000017500000000017315161635377020343 0ustar fengfengName: libkysdk-conf2 Description: kysdk base conf2 Version: 3.0.1 Cflags: -I/usr/include/kysdk/kysdk-base/ Libs: -lkyconf2 libkysdk-base/CMakeLists.txt0000664000175000017500000000116015161635377015000 0ustar fengfengcmake_minimum_required(VERSION 3.5) project(kysdk-base) include(CMakePackageConfigHelpers) include(GNUInstallDirs) include_directories("${PROJECT_BINARY_DIR}") set (CMAKE_EXPORT_COMPILE_COMMANDS ON) set (CMAKE_SKIP_RPATH ON) if (NOT CMAKE_BUILD_TYPE) set(CMAKE_BUILD_TYPE Debug) endif() message("Build Type: ${CMAKE_BUILD_TYPE}") set (LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib) set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) # 设置 CMAKE_INSTALL_LIBDIR 变量 set (CMAKE_INSTALL_LIBDIR ${CMAKE_INSTALL_LIBDIR}) set (CMAKE_INSTALL_HEADER_DIR /usr/include/kysdk/kysdk-base) add_subdirectory(src) libkysdk-base/COPYING0000664000175000017500000001674315161635377013310 0ustar fengfeng GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. libkysdk-base/doxygen/0000775000175000017500000000000015161635377013717 5ustar fengfenglibkysdk-base/doxygen/doxy_config0000664000175000017500000033344615161635377016167 0ustar fengfeng# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "My Project" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = ./out # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is # Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = ./src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.h \ *.hpp \ *.java \ *.py # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = ./src/config/datatype.h \ ./src/config/gsettingsparse.h \ ./src/config/jsonparse.h \ ./src/config/structparse.h \ ./src/config/xmlparse.h \ ./src/diagnostics/buriedpoint.h \ ./src/log/core.h \ ./src/log/format.h \ ./src/log/klog_dump.h \ ./src/log/klog_mqueue.h \ ./src/log/write.h \ ./src/log/writeFile.h \ ./src/utils/kerr.h \ ./src/utils/sdkmarcos.h \ ./src/utils/data-structure/linklist/listdata.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */test/* \ */nlohmann/* \ */process/* \ */sample/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = ResolutionMethod \ AddressBus \ LockScreen # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = ./src/config/test \ ./src/diagnostics/test \ ./src/gsettings/test \ ./src/log/test \ ./src/timer/test \ ./src/utils/test # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = ./src #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files # were built. This is equivalent to specifying the "-p" option to a clang tool, # such as clang-check. These options will then be passed to the parser. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /