跳转至

Utils（工具函数）

ll/api/utils/ · 通用

概述

Utils 模块提供了各种实用函数，包括系统信息、字符串操作、哈希、随机数生成、文件 I/O、Base64 编码和错误处理。

头文件

头文件 说明
ll/api/utils/SystemUtils.h 系统信息（操作系统、语言环境、环境变量、模块路径）
ll/api/utils/StringUtils.h 字符串分割、替换、大小写转换
ll/api/utils/HashUtils.h 哈希工具
ll/api/utils/RandomUtils.h 随机数生成
ll/api/utils/ErrorUtils.h 错误提取和格式化
ll/api/utils/StacktraceUtils.h 堆栈跟踪生成
ll/api/utils/FontUtils.h 字体枚举
ll/api/utils/FileUtils.h 文件 I/O 工具
ll/api/utils/Base64Utils.h Base64 编码/解码
ll/api/utils/CompressUtils.h 压缩与解压,支持流式和一次性两种用法

核心函数

SystemUtils

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
namespace ll::sys_utils {
std::string getSystemName();
std::string getSystemLocaleCode();
data::Version getSystemVersion();

void* getModuleHandle(void* addr);
std::filesystem::path getModulePath(void* addr);
std::string getModuleFileName(void* addr);

std::optional<std::string> getEnvironmentVariable(std::string_view name);
}

StringUtils

C++
1
2
3
4
5
6
7
8
namespace ll::string_utils {
std::vector<std::string> splitByPattern(std::string_view str, std::string_view pattern);
std::string& replaceAll(std::string& str, std::string_view oldVal, std::string_view newVal);
std::string& toLower(std::string& str);
std::string& toUpper(std::string& str);
std::string toCamelCase(std::string_view str);
std::string toSnakeCase(std::string_view str);
}

FileUtils

C++
1
2
3
4
5
namespace ll::file_utils {
std::optional<std::string> readFile(std::filesystem::path const& path);
bool writeFile(std::filesystem::path const& path, std::string_view content);
std::optional<data::Version> getVersion(std::filesystem::path const& path);
}

HashUtils

C++
1
2
3
4
5
6
7
8
9
namespace ll::hash_utils {
size_t doHash(auto const&... args);

struct HashCombiner {
    size_t hash = 0;
    HashCombiner& add(auto const& val);
    operator size_t() const;
};
}

RandomUtils

C++
1
2
3
4
namespace ll::random_utils {
int randomInt(int min, int max);
double randomReal(double min, double max);
}

Base64Utils

C++
1
2
3
4
namespace ll::base64_utils {
std::string encode(std::string_view data);
std::string decode(std::string_view data);
}

CompressUtils

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
namespace ll::compress_utils {
enum class CompressFormat : int { Gzip, Zlib };
enum class CompressLevel : int { Store, Fastest, Default, Best };

std::string_view extensionOf(CompressFormat format);

Expected<std::string> compress(std::string_view data, CompressFormat = CompressFormat::Gzip,
                               CompressLevel = CompressLevel::Default);
Expected<std::string> decompress(std::string_view data, CompressFormat = CompressFormat::Gzip,
                                 size_t maxSize = 0);

Expected<> compressFile(std::filesystem::path const& src, std::filesystem::path const& dst, ...);
Expected<> decompressFile(std::filesystem::path const& src, std::filesystem::path const& dst, ...);
}

使用方法

系统信息

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#include "ll/api/utils/SystemUtils.h"

void printSystemInfo() {
    auto osName = ll::sys_utils::getSystemName();
    auto locale = ll::sys_utils::getSystemLocaleCode();
    auto version = ll::sys_utils::getSystemVersion();

    // 获取环境变量
    auto path = ll::sys_utils::getEnvironmentVariable("PATH");
}

字符串操作

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
#include "ll/api/utils/StringUtils.h"

void stringOps() {
    std::string text = "Hello World";
    ll::string_utils::toLower(text);  // "hello world"

    auto parts = ll::string_utils::splitByPattern("a,b,c", ",");
    // parts == {"a", "b", "c"}

    std::string str = "foo bar foo";
    ll::string_utils::replaceAll(str, "foo", "baz");
    // str == "baz bar baz"
}

文件操作

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
#include "ll/api/utils/FileUtils.h"

void fileOps() {
    auto content = ll::file_utils::readFile("config.txt");
    if (content) {
        // 使用 *content
    }

    ll::file_utils::writeFile("output.txt", "Hello");
}

哈希

C++
1
2
3
4
5
6
7
8
9
#include "ll/api/utils/HashUtils.h"

void hashExample() {
    size_t hash = ll::hash_utils::doHash("key", 123, 45.6);

    ll::hash_utils::HashCombiner combiner;
    combiner.add("part1").add(42).add(3.14);
    size_t combined = combiner;
}

随机数

C++
1
2
3
4
5
6
#include "ll/api/utils/RandomUtils.h"

void randomExample() {
    int dice = ll::random_utils::randomInt(1, 6);
    double chance = ll::random_utils::randomReal(0.0, 1.0);
}

Base64

C++
1
2
3
4
5
6
#include "ll/api/utils/Base64Utils.h"

void base64Example() {
    std::string encoded = ll::base64_utils::encode("Hello");
    std::string decoded = ll::base64_utils::decode(encoded);
}

压缩

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#include "ll/api/utils/CompressUtils.h"

void compressExample() {
    using namespace ll::compress_utils;

    auto packed = compress("hello hello hello");
    if (!packed) {
        return;
    }
    auto original = decompress(*packed);
}

数据较大时改用流式,这样两侧都不会整块驻留内存。按需多次调用 write 推入数据,最后调用一次 finish:

C++
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
#include "ll/api/utils/CompressUtils.h"

ll::Expected<> compressToSocket(std::string_view chunk1, std::string_view chunk2) {
    using namespace ll::compress_utils;

    Compressor codec{[&](std::string_view out) -> ll::Expected<> {
        // 每次有输出产生时都会被调用
        return sendBytes(out);
    }};
    if (auto res = codec.status(); !res) {
        return res;
    }
    if (auto res = codec.write(chunk1); !res) {
        return res;
    }
    if (auto res = codec.write(chunk2); !res) {
        return res;
    }
    return codec.finish();
}

文件到文件的场景用 compressFile 和 decompressFile,它们基于同一套机制,并且先写入临时文件再改名, 因此中途被打断不会留下半个文件。

decompress 会限制输出大小,因为很小的输入也可能解压出极大的数据。已知预期大小时请显式传入 maxSize。

相关模块