平台相关接口

详细描述

提供跨平台的与平台相关函数，包括文件操作、环境检测、动态库加载、界面操作等。

命名空间
namespace	ast::fs_simple
namespace	ast::posix

类
class	ast::GUIInterface

枚举
enum	ast::EEndian { ast::eLittleEndian , ast::eBigEndian }

函数
EEndian	ast::aGetEndian ()
bool	ast::aIsCI ()
bool	ast::aIsGithubCI ()
bool	ast::aIsGitlabCI ()
StringView	ast::aProjectName ()
bool	ast::aIsTerminal (FILE *file)
bool	ast::aIsFile (FILE *file)
bool	ast::aStdInIsTerminal ()
bool	ast::aStdInIsFile ()
bool	ast::aStdOutIsTerminal ()
bool	ast::aStdOutIsFile ()
bool	ast::aStdErrIsTerminal ()
bool	ast::aStdErrIsFile ()
std::string	ast::aGetModulePathFromAddress (void *addr)
std::string	ast::aLibDir ()
std::string	ast::aExeDir ()
std::string	ast::aLibPath ()
std::string	ast::aExePath ()
bool	ast::aCanDisplayGUI ()
A_ALWAYS_INLINE std::FILE *	ast::ast_fopen (const char *filepath, const char *mode)
A_ALWAYS_INLINE FILE *	ast::ast_freopen (const char *filepath, const char *mode, FILE *stream)
A_ALWAYS_INLINE int	ast::ast_vprintf (const char *format, va_list args)
int	ast::ast_printf (const char *format,...)
int	ast::aCurrentLineNumber (std::FILE *file)
errc_t	ast::aGetFilePath (std::FILE *file, std::string &filepath)
A_ALWAYS_INLINE std::string	ast::aGetFilePath (std::FILE *file)
void *	ast::aLoadLibrary (const char *filepath)
void *	ast::aGetProcAddress (void *lib, const char *funcName)
void *	ast::aResolveProcAddress (const char *filepath, const char *funcName)
errc_t	ast::aFreeLibrary (void *lib)
const char *	ast::aGetLoadError ()
errc_t	ast::aUiEditObject (Object *object)
Object *	ast::aUiSelectObject (StringView typeName)

枚举类型说明

EEndian

enum ast::EEndian

枚举值
eLittleEndian	小端字节序
eBigEndian	大端字节序

函数说明

aCanDisplayGUI()

AST_UTIL_CAPI bool ast::aCanDisplayGUI

(

)

判断是否可以显示GUI

返回

bool

aCurrentLineNumber()

AST_UTIL_CAPI int ast::aCurrentLineNumber

(

std::FILE *

file

)

获取文件当前行号

参数

file

文件指针

返回

当前行号，从1开始计数

aExeDir()

AST_UTIL_API std::string ast::aExeDir

(

)

获取当前的可执行文件所在目录

返回

aExePath()

AST_UTIL_API std::string ast::aExePath

(

)

获取当前的可执行文件路径

返回

aFreeLibrary()

AST_UTIL_CAPI errc_t ast::aFreeLibrary

(

void *

lib

)

卸载动态库

参数

lib

动态库句柄

返回

0: 成功

aGetEndian()

AST_UTIL_CAPI EEndian ast::aGetEndian

(

)

获取当前系统的字节序

返回

EEndian 当前系统的字节序

aGetFilePath() [1/2]

A_ALWAYS_INLINE std::string ast::aGetFilePath

(

std::FILE *

file

)

获取文件路径

参数

file

文件指针

返回

文件路径，utf-8编码

aGetFilePath() [2/2]

AST_UTIL_CAPI errc_t ast::aGetFilePath	(	std::FILE *	file,
		std::string &	filepath )

获取文件路径

参数

file	文件指针
filepath	输出文件路径，utf-8编码

返回

错误码

aGetLoadError()

AST_UTIL_CAPI const char * ast::aGetLoadError

(

)

获取最后的错误信息

返回

错误信息字符串

aGetModulePathFromAddress()

AST_UTIL_API std::string ast::aGetModulePathFromAddress

(

void *

addr

)

获取函数、变量所在模块的路径

参数

addr

函数地址/变量地址

返回

std::string 模块路径

aGetProcAddress()

AST_UTIL_CAPI void * ast::aGetProcAddress	(	void *	lib,
		const char *	funcName )

从动态库中查询函数指针

参数

lib	动态库
funcName	函数名称

返回

aIsCI()

AST_UTIL_CAPI bool ast::aIsCI

(

)

检查是否在持续集成环境中运行

返回

如果在CI环境中运行，返回true；否则返回false

aIsFile()

AST_UTIL_CAPI bool ast::aIsFile

(

FILE *

file

)

检查文件是否为普通文件

参数

file

文件指针

返回

如果文件为普通文件，返回true；否则返回false

aIsGithubCI()

AST_UTIL_CAPI bool ast::aIsGithubCI

(

)

检查是否在Github action CI环境中运行

返回

如果在Github action CI环境中运行，返回true；否则返回false

aIsGitlabCI()

AST_UTIL_API bool ast::aIsGitlabCI

(

)

检查是否在Gitlab runner CI环境中运行

返回

如果在Gitlab runner CI环境中运行，返回true；否则返回false

aIsTerminal()

AST_UTIL_CAPI bool ast::aIsTerminal

(

FILE *

file

)

检查文件是否为终端

参数

file

文件指针

返回

如果文件为终端，返回true；否则返回false

aLibDir()

AST_UTIL_API std::string ast::aLibDir

(

)

获取当前的AstUtil动态库所在目录

返回

aLibPath()

AST_UTIL_API std::string ast::aLibPath

(

)

获取当前的AstUtil动态库的名称

返回

aLoadLibrary()

AST_UTIL_CAPI void * ast::aLoadLibrary

(

const char *

filepath

)

加载动态库

参数

filepath

动态库路径

返回

aProjectName()

AST_UTIL_API StringView ast::aProjectName

(

)

获取当前项目的名称

返回

项目的名称

aResolveProcAddress()

AST_UTIL_CAPI void * ast::aResolveProcAddress	(	const char *	filepath,
		const char *	funcName )

从动态库中获取函数指针

参数

filepath	动态库路径
funcName	函数名称

返回

aStdErrIsFile()

AST_UTIL_CAPI bool ast::aStdErrIsFile

(

)

检查标准错误是否为文件

返回

如果标准错误为文件，返回true；否则返回false

aStdErrIsTerminal()

AST_UTIL_CAPI bool ast::aStdErrIsTerminal

(

)

检查标准错误是否为终端

返回

如果标准错误为终端，返回true；否则返回false

aStdInIsFile()

AST_UTIL_CAPI bool ast::aStdInIsFile

(

)

检查标准输入是否为文件

返回

如果标准输入为文件，返回true；否则返回false

aStdInIsTerminal()

AST_UTIL_CAPI bool ast::aStdInIsTerminal

(

)

检查标准输入是否为终端

返回

如果标准输入为终端，返回true；否则返回false

aStdOutIsFile()

AST_UTIL_CAPI bool ast::aStdOutIsFile

(

)

检查标准输出是否为文件

返回

如果标准输出为文件，返回true；否则返回false

aStdOutIsTerminal()

AST_UTIL_CAPI bool ast::aStdOutIsTerminal

(

)

检查标准输出是否为终端

返回

如果标准输出为终端，返回true；否则返回false

aUiEditObject()

AST_UTIL_CAPI errc_t ast::aUiEditObject

(

Object *

object

)

编辑对象

~

参数

object

要编辑的对象

返回

errc_t 错误码

aUiSelectObject()

AST_UTIL_CAPI Object * ast::aUiSelectObject

(

StringView

typeName

)

选择对象

~

参数

typeName

对象类型名

返回

Object* 选择的对象指针