ZLMediaKit/api/include/mk_util.h
xiongziliang dc8508c58f 完善c sdk对象描述元信息,防止隐式指针转换错误
void* 类型指针很容易存在隐式转换错误,用户无法察觉
2023-02-26 21:45:14 +08:00

157 lines
4.4 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright (c) 2016 The ZLMediaKit project authors. All Rights Reserved.
*
* This file is part of ZLMediaKit(https://github.com/xia-chu/ZLMediaKit).
*
* Use of this source code is governed by MIT license that can be found in the
* LICENSE file in the root of the source tree. All contributing project authors
* may be found in the AUTHORS file in the root of the source tree.
*/
#ifndef MK_UTIL_H
#define MK_UTIL_H
#include <stdlib.h>
#include "mk_common.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* 释放mk api内部malloc的资源
*/
API_EXPORT void API_CALL mk_free(void *ptr);
/**
* 获取本程序可执行文件路径
* @return 文件路径使用完后需要自己mk_free
*/
API_EXPORT char* API_CALL mk_util_get_exe_path();
/**
* 获取本程序可执行文件相同目录下文件的绝对路径
* @param relative_path 同目录下文件的路径相对,可以为null
* @return 文件路径使用完后需要自己mk_free
*/
API_EXPORT char* API_CALL mk_util_get_exe_dir(const char *relative_path);
/**
* 获取unix标准的系统时间戳
* @return 当前系统时间戳
*/
API_EXPORT uint64_t API_CALL mk_util_get_current_millisecond();
/**
* 获取时间字符串
* @param fmt 时间格式,譬如%Y-%m-%d %H:%M:%S
* @return 时间字符串使用完后需要自己mk_free
*/
API_EXPORT char* API_CALL mk_util_get_current_time_string(const char *fmt);
/**
* 打印二进制为字符串
* @param buf 二进制数据
* @param len 数据长度
* @return 可打印的调试信息使用完后需要自己mk_free
*/
API_EXPORT char* API_CALL mk_util_hex_dump(const void *buf, int len);
///////////////////////////////////////////mk ini/////////////////////////////////////////////
typedef struct mk_ini_t *mk_ini;
/**
* 创建ini配置对象
*/
API_EXPORT mk_ini API_CALL mk_ini_create();
/**
* 返回全局默认ini配置
* @return 全局默认ini配置请勿用mk_ini_release释放它
*/
API_EXPORT mk_ini API_CALL mk_ini_default();
/**
* 加载ini配置文件内容
* @param ini ini对象
* @param str 配置文件内容
*/
API_EXPORT void API_CALL mk_ini_load_string(mk_ini ini, const char *str);
/**
* 加载ini配置文件
* @param ini ini对象
* @param file 配置文件路径
*/
API_EXPORT void API_CALL mk_ini_load_file(mk_ini ini, const char *file);
/**
* 销毁ini配置对象
*/
API_EXPORT void API_CALL mk_ini_release(mk_ini ini);
/**
* 添加或覆盖配置项
* @param ini 配置对象
* @param key 配置名两段式field.key
* @param value 配置值
*/
API_EXPORT void API_CALL mk_ini_set_option(mk_ini ini, const char *key, const char *value);
API_EXPORT void API_CALL mk_ini_set_option_int(mk_ini ini, const char *key, int value);
/**
* 获取配置项
* @param ini 配置对象
* @param key 配置名两段式field.key
* @return 配置不存在返回NULL否则返回配置值
*/
API_EXPORT const char *API_CALL mk_ini_get_option(mk_ini ini, const char *key);
/**
* 删除配置项
* @param ini 配置对象
* @param key 配置名两段式field.key
* @return 1: 成功0: 该配置不存在
*/
API_EXPORT int API_CALL mk_ini_del_option(mk_ini ini, const char *key);
/**
* 导出为配置文件内容
* @param ini 配置对象
* @return 配置文件内容字符串用完后需要自行mk_free
*/
API_EXPORT char *API_CALL mk_ini_dump_string(mk_ini ini);
/**
* 导出配置文件到文件
* @param ini 配置对象
* @param file 配置文件路径
*/
API_EXPORT void API_CALL mk_ini_dump_file(mk_ini ini, const char *file);
///////////////////////////////////////////日志/////////////////////////////////////////////
/**
* 打印日志
* @param level 日志级别,支持0~4
* @param file __FILE__
* @param function __FUNCTION__
* @param line __LINE__
* @param fmt printf类型的格式控制字符串
* @param ... 不定长参数
*/
API_EXPORT void API_CALL mk_log_printf(int level, const char *file, const char *function, int line, const char *fmt, ...);
// 以下宏可以替换printf使用
#define log_printf(lev, ...) mk_log_printf(lev, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
#define log_trace(...) log_printf(0, ##__VA_ARGS__)
#define log_debug(...) log_printf(1, ##__VA_ARGS__)
#define log_info(...) log_printf(2, ##__VA_ARGS__)
#define log_warn(...) log_printf(3, ##__VA_ARGS__)
#define log_error(...) log_printf(4, ##__VA_ARGS__)
#ifdef __cplusplus
}
#endif
#endif //MK_UTIL_H