41

我正在用 C++ 编写一个应用程序,它依赖于我项目中的各种资源。现在,我拥有从生成的可执行文件到源中硬编码的每个资源的相对路径,这允许我的程序打开文件并读取每个资源中的数据。这工作正常,但它要求我从相对于资源的特定路径启动可执行文件。因此,如果我尝试从其他任何地方启动我的可执行文件,它将无法打开文件并且无法继续。

是否有一种可移植的方式让 CMake 将我的资源嵌入到可执行文件(或库)中,以便我可以在运行时简单地在内存中访问它们,而不是打开路径脆弱的文件?我发现了一个相关的问题,看起来嵌入资源可以通过一些ld魔法做得很好。所以我的问题是如何使用 CMake 以可移植的跨平台方式执行此操作?我实际上需要我的应用程序在 x86 和 ARM 上运行。我可以只支持 Linux(嵌入式),但如果有人可以建议如何为 Windows(嵌入式)执行此操作,则可以加分。

编辑:我忘了提到解决方案的所需属性。当我为 ARM 构建时,我希望能够使用 CMake 交叉编译应用程序,而不必在我的 ARM 目标上本地编译它。

4

6 回答 6

39

作为sfstewman答案的替代方案,这里有一个小的 cmake ( 2.8 ) 函数,用于将特定文件夹中的所有文件转换为 C 数据并将它们写入希望的输出文件中:

# Creates C resources file from files in given directory
function(create_resources dir output)
    # Create empty output file
    file(WRITE ${output} "")
    # Collect input files
    file(GLOB bins ${dir}/*)
    # Iterate through input files
    foreach(bin ${bins})
        # Get short filename
        string(REGEX MATCH "([^/]+)$" filename ${bin})
        # Replace filename spaces & extension separator for C compatibility
        string(REGEX REPLACE "\\.| |-" "_" filename ${filename})
        # Read hex data from file
        file(READ ${bin} filedata HEX)
        # Convert hex data for C compatibility
        string(REGEX REPLACE "([0-9a-f][0-9a-f])" "0x\\1," filedata ${filedata})
        # Append data to output file
        file(APPEND ${output} "const unsigned char ${filename}[] = {${filedata}};\nconst unsigned ${filename}_size = sizeof(${filename});\n")
    endforeach()
endfunction()
于 2014-11-29T20:51:12.117 回答
38

执行此操作的最简单方法之一是在您的构建中包含一个小型、可移植的 C 程序,该程序读取资源并生成一个 C 文件,其中包含资源数据的长度和作为常量字符文字数组的实际资源数据。这将完全独立于平台,但只能用于相当小的资源。对于更大的资源,您可能不想将文件嵌入程序中。

对于资源“foo”,生成的 C 文件“foo.c”将包含:

const char foo[] = { /* bytes of resource foo */ };
const size_t foo_len = sizeof(foo);

要从 C++ 访问资源,请在使用它们的标头或 cpp 文件中声明以下两个符号:

extern "C" const char foo[];
extern "C" const size_t foo_len;

foo.c在构建中生成,您需要 C 程序的目标(称为 embedfile.c),并且您需要使用ADD_CUSTOM_COMMAND命令来调用此程序:

add_executable(embedfile embedfile.c)

add_custom_command(
  OUTPUT foo.c
  COMMAND embedfile foo foo.rsrc
  DEPENDS foo.rsrc)

然后,包含foo.c在需要“foo”资源的目标的源列表中。您现在可以访问“foo”的字节。

程序 embedfile.c 是:

#include <stdlib.h>
#include <stdio.h>

FILE* open_or_exit(const char* fname, const char* mode)
{
  FILE* f = fopen(fname, mode);
  if (f == NULL) {
    perror(fname);
    exit(EXIT_FAILURE);
  }
  return f;
}

int main(int argc, char** argv)
{
  if (argc < 3) {
    fprintf(stderr, "USAGE: %s {sym} {rsrc}\n\n"
        "  Creates {sym}.c from the contents of {rsrc}\n",
        argv[0]);
    return EXIT_FAILURE;
  }

  const char* sym = argv[1];
  FILE* in = open_or_exit(argv[2], "r");

  char symfile[256];
  snprintf(symfile, sizeof(symfile), "%s.c", sym);

  FILE* out = open_or_exit(symfile,"w");
  fprintf(out, "#include <stdlib.h>\n");
  fprintf(out, "const char %s[] = {\n", sym);

  unsigned char buf[256];
  size_t nread = 0;
  size_t linecount = 0;
  do {
    nread = fread(buf, 1, sizeof(buf), in);
    size_t i;
    for (i=0; i < nread; i++) {
      fprintf(out, "0x%02x, ", buf[i]);
      if (++linecount == 10) { fprintf(out, "\n"); linecount = 0; }
    }
  } while (nread > 0);
  if (linecount > 0) fprintf(out, "\n");
  fprintf(out, "};\n");
  fprintf(out, "const size_t %s_len = sizeof(%s);\n\n",sym,sym);

  fclose(in);
  fclose(out);

  return EXIT_SUCCESS;
}
于 2012-08-05T06:58:22.817 回答
8

我想提出另一种选择。它使用 GCC 链接器将二进制文件直接嵌入到可执行文件中,无需中间源文件。在我看来,这更简单,更有效。

set( RC_DEPENDS "" )

function( add_resource input )
    string( MAKE_C_IDENTIFIER ${input} input_identifier )
    set( output "${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/${input_identifier}.o" )
    target_link_libraries( ${PROJECT_NAME} ${output} )

    add_custom_command(
        OUTPUT ${output}
        COMMAND ${CMAKE_LINKER} --relocatable --format binary --output ${output} ${input}
        DEPENDS ${input}
    )

    set( RC_DEPENDS ${RC_DEPENDS} ${output} PARENT_SCOPE )
endfunction()

# Resource file list
add_resource( "src/html/index.html" )

add_custom_target( rc ALL DEPENDS ${RC_DEPENDS} )

然后在您的 C/C++ 文件中,您只需要:

extern char index_html_start[] asm( "_binary_src_html_index_html_start" );
extern char index_html_end[]   asm( "_binary_src_html_index_html_end" );
extern size_t index_html_size  asm( "_binary_src_html_index_html_size" );
于 2019-05-06T13:13:00.620 回答
5

我想说在 C++ 中嵌入资源的最优雅的方法是简单地使用 Qt 资源系统,它可以跨不同平台移植,与 CMake 兼容,并且基本上包含了上面答案中所做的一切,除了提供压缩之外,完全经过测试和万无一失,其他一切。

创建一个 Qt 资源文件 - 一个列出要嵌入的文件的 XML:

<RCC>
    <qresource prefix="/">
        <file>uptriangle.png</file>
        <file>downtriangle.png</file>
    </qresource>
</RCC>

调用文件 qtres.qrc。上面的资源文件将在最终可执行文件中嵌入两个 png 文件(与 qtres.qrc 位于同一目录中)。您可以使用 QtCreator(Qt IDE)轻松地将监视器资源添加/删除到 qrc 文件。

现在在您的 CMakeLists.txt 文件中添加:

set(CMAKE_AUTOMOC ON)
find_package(Qt5Core)
qt5_add_resources(QT_RESOURCE qtres.qrc)

在您的 main.cpp 中,在您需要访问资源之前,添加以下行:

Q_INIT_RESOURCE(qtres);

现在,您可以使用与 Qt 资源系统兼容的 Qt 类来访问上述任何资源,例如 QPixmap、QImage ......而且最重要的是,在一般情况下,QResource 包装器类可能会包装嵌入式 Qt 资源并允许通过友好的界面。例如,要访问上述资源中 downtriangle.png 中的数据,以下几行就可以了:

#include <QtCore>
#include <QtGui>

// ...

int main(int argc, char **argv)
{

    // ...

    Q_INIT_RESOURCE(qtres);

    // ...
    QResource res("://downtriangle.png"); // Here's your data, anyway you like
    // OR
    QPixmap pm("://downtriangle.png");  // Use it with Qt classes already

    // ...

}

这里可以使用 res 来直接访问数据,使用 res.data(), res.size() ... 解析文件的图片内容使用 pm。使用 pm.size(), pm.width() ...

你可以走了。我希望它有所帮助。

于 2014-07-24T05:34:31.870 回答
5

将任何文件转换为 C/C++ 源代码的纯 CMake 函数,仅使用 CMake 命令实现:

####################################################################################################
# This function converts any file into C/C++ source code.
# Example:
# - input file: data.dat
# - output file: data.h
# - variable name declared in output file: DATA
# - data length: sizeof(DATA)
# embed_resource("data.dat" "data.h" "DATA")
####################################################################################################

function(embed_resource resource_file_name source_file_name variable_name)

    file(READ ${resource_file_name} hex_content HEX)

    string(REPEAT "[0-9a-f]" 32 column_pattern)
    string(REGEX REPLACE "(${column_pattern})" "\\1\n" content "${hex_content}")

    string(REGEX REPLACE "([0-9a-f][0-9a-f])" "0x\\1, " content "${content}")

    string(REGEX REPLACE ", $" "" content "${content}")

    set(array_definition "static const unsigned char ${variable_name}[] =\n{\n${content}\n};")

    set(source "// Auto generated file.\n${array_definition}\n")

    file(WRITE "${source_file_name}" "${source}")

endfunction()

https://gist.github.com/amir-saniyan/de99cee82fa9d8d615bb69f3f53b6004

于 2020-06-29T19:11:59.187 回答
1

有一个名为cmrc的单文件 CMake 脚本可让您轻松嵌入数据。

示例用法:

include(CMakeRC.cmake)
cmrc_add_resource_library(foo-resources
        ALIAS foo::rc
        NAMESPACE foo
        shaders/trig.vert
        shaders/trig.frag)

target_link_libraries(foo foo::rc)
#include <cmrc/cmrc.hpp>

CMRC_DECLARE(foo); // It should be the NAMESPACE property you specified
                   // in your CMakeLists.txt

int main() {
    auto fs = cmrc::foo::get_filesystem();
    auto vert_shader = fs.open("shaders/trig.vert");
    auto frag_shader = fs.open("shaders/trig.frag");
    ...
    glShaderSource(vertexShader, 1, &vert_shader.begin(), nullptr);
}

它可能是最容易设置和使用的库。

于 2022-01-23T11:35:57.240 回答