如何在C++中解析GLSL文件的#include指令并合并代码？

我希望在GLSL文件中使用#include指令，避免为每个GLSL着色器重复编写相同代码。我尝试自行编写小型解析器，但无法很好地定位GLSL文件中的所有#include语句。我需要提取被包含文件的路径，读取其内容并写入到着色器的std::string内容中（而非修改原GLSL文件）。

我尝试用以下代码查找着色器中的#include：

std::string include = "#include";
std::string shaderSource = ReadFile("shader.glsl");
std::uint32_t offset = 0, position = 0;
while ((position = shaderSource.find(include, offset)) != std::string::npos)
{
    offset += include.size();
    // parse the shader
}

但我意识到这种方法无法应对所有场景，解决方案应该比当前实现更复杂。

要正确解析GLSL中的#include，必须覆盖简单字符串匹配漏掉的关键场景，以下是可落地的实现思路：

• 过滤注释中的伪指令：GLSL的单行注释（//）和多行注释（/* */）里的#include不属于有效指令，必须跳过这些区域。
• 兼容空白字符：#include前后可能有空格、制表符或换行，比如 #include "common.glsl"，需要先跳过这些空白再处理路径。
• 精准提取路径：路径会用双引号（"path/file.glsl"）或尖括号（<path/file.glsl>）包裹，要准确提取引号/尖括号内的内容。
• 递归处理嵌套包含：被包含的文件中可能也有#include，需要递归展开直到所有嵌套都处理完成。
• 防止重复包含：维护一个已包含文件的列表，避免同一个文件被多次引入导致重复定义错误。

核心代码实现示例 #

1. 跳过注释的辅助函数

size_t SkipComments(const std::string& source, size_t pos) {
    size_t n = source.size();
    while (pos < n) {
        // 处理单行注释
        if (source[pos] == '/' && pos + 1 < n && source[pos+1] == '/') {
            while (pos < n && source[pos] != '\n') pos++;
        }
        // 处理多行注释
        else if (source[pos] == '/' && pos + 1 < n && source[pos+1] == '*') {
            pos += 2;
            while (pos < n - 1 && !(source[pos] == '*' && source[pos+1] == '/')) pos++;
            pos += 2; // 跳过闭合的*/
        }
        else {
            break;
        }
    }
    return pos;
}

2. 递归解析#include的主函数

std::string ResolveIncludes(const std::string& source, const std::string& baseDir, std::unordered_set<std::string>& includedFiles) {
    std::string result;
    size_t pos = 0;
    size_t n = source.size();
    const std::string includeToken = "#include";
    const size_t includeLen = includeToken.size();

    while (pos < n) {
        pos = SkipComments(source, pos);
        if (pos >= n) break;

        // 定位有效#include指令
        size_t includePos = source.find(includeToken, pos);
        if (includePos == std::string::npos) {
            result += source.substr(pos);
            break;
        }

        // 追加指令前的内容
        result += source.substr(pos, includePos - pos);
        pos = includePos + includeLen;

        // 跳过指令后的空白字符
        while (pos < n && isspace(source[pos])) pos++;
        if (pos >= n) break;

        // 识别路径包裹符号
        char wrapper = source[pos];
        if (wrapper != '"' && wrapper != '<') {
            // 格式无效，保留原内容
            result += includeToken + source.substr(includePos + includeLen);
            break;
        }
        pos++;

        // 找到路径闭合符号
        size_t endWrapperPos = source.find(wrapper == '"' ? '"' : '>', pos);
        if (endWrapperPos == std::string::npos) {
            // 未找到闭合符号，保留原内容
            result += includeToken + source.substr(includePos + includeLen);
            break;
        }

        // 提取并处理路径
        std::string includePath = source.substr(pos, endWrapperPos - pos);
        pos = endWrapperPos + 1;
        std::string fullPath = baseDir + "/" + includePath;

        // 跳过已包含的文件
        if (includedFiles.count(fullPath)) continue;
        includedFiles.insert(fullPath);

        // 递归解析被包含文件
        std::string includedSource = ReadFile(fullPath);
        result += ResolveIncludes(includedSource, baseDir, includedFiles);
    }

    return result;
}

3. 调用示例

std::string shaderSource = ReadFile("shader.glsl");
std::unordered_set<std::string> includedFiles;
// 第二个参数是着色器文件所在的基础目录，用于解析相对路径
std::string resolvedSource = ResolveIncludes(shaderSource, "./shaders", includedFiles);
// resolvedSource即为展开所有#include后的最终着色器源码

额外优化点 #

• 区分路径类型：尖括号<>通常对应系统级着色器路径，可以单独指定查找目录；双引号""对应当前文件的相对路径。
• 错误处理：添加文件读取失败、路径不存在的判断逻辑，抛出异常或输出错误日志。
• 条件包含支持：如果需要处理#ifdef等条件指令控制的#include，需扩展逻辑先解析预处理条件，再决定是否展开包含。

内容的提问来源于stack exchange，提问作者ParhamTny