探索qrc，rcc和CMAKE_AUTORCC

前导知识：解决qt中cmake单独存放 .ui, .cpp, .h文件

前言

我们的Qt程序可以加载一些资源，比如程序窗口的图标。

像下面这样的原始图标，很丑。


可以给它加上图标，一个小海豚。

一、直接加载资源

这是最简单直接的方式。

#include <QApplication>
#include <QResource>
#include "MainWindow.h"

using namespace YQ;

int main (int argc, char *argv[])
{
	QApplication app (argc, argv);

	MainWindow w;
    w.setWindowIcon(QIcon("resource/icon.ico"));//填写图标路径
	w.show();
	return app.exec();
}

优点就是简单直接。

缺点是把东西都写死在程序里了，运行时，程序还必须能找到这个资源。
比如上面的resource/icon.ico，要求运行时必须有一个resource文件夹，然后里面有一个icon.ico，否则就会没有图标。

二、qrc文件

1. 格式

.qrc文件是Qt程序用的资源文件格式。类似的我们见过Windows的资源文件.rc文件。

.qrc文件是xml文件，一个最简单的例子如下：

<!DOCTYPE RCC>
<RCC version="1.0">
    <qresource>
        <file>resources/icon.ico</file>
		<!--其他资源-->
    </qresource>
</RCC>

多个资源只需要添加多个<file></file>标签即可。

很明显，qrc文件只是一种描述文件，用来描述如何组织/管理资源。

qrc本身并不能充当/提供资源来使用。

2. 手动使用

了解手动使用才能明白到底发生了什么。

qrc文件里面的资源路径，都是相对于qrc文件自身所在目录来寻找的，这也很符合常规。

需要用rcc工具将qrc文件编译后才能使用。

比如：

rcc --binary 1.qrc -o 1.rcc

这样就会得到一个二进制文件1.rcc。

这个二进制文件的目的是用来动态装载的，你可以把它当成一个动态链接库，到运行时才会去找它，找不到就没有资源可用。

使用例子：

#include <QApplication>
#include <QResource>
#include "MainWindow.h"

using namespace YQ;

int main (int argc, char *argv[])
{
	QApplication app (argc, argv);

    QResource::registerResource("resources.rcc");
	MainWindow w;
    w.setWindowIcon(QIcon(":resource/icon.ico"));
	w.show();
	return app.exec();
}

有几个要求：

1. 需要用QResource::registerResource()注册.rcc文件。
2. 运行时必须能访问到.rcc文件。
3. 访问资源时用冒号开头。

另外，qrc文件也可以给资源添加别名：

```xml
<!DOCTYPE RCC>
<RCC version="1.0">
    <qresource>
        <file alias="LOGO">resources/icon.ico</file>
...

这样很好，代码中使用很灵活，还可以屏蔽掉路径和文件类型：

QIcon(":LOGO")

3. 自动方式——CMAKE_AUTORCC

cmake中可以加上这样一行：

set(CMAKE_AUTORCC ON)

和前导知识中说过的CMAKE_AUTOUIC、CMAKE_AUTOMOC类似。

这样子cmake会自动帮你处理qrc文件，不需要再手动调用rcc来编译.qrc文件（cmake会自动调用rcc来编译）。

使用时，CMakeLists.txt像下面就行：

cmake_minimum_required(VERSION 3.1)
project(main)
set(EXE main)

set(CMAKE_PREFIX_PATH D:/Qt/6.3.2/mingw_64)

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOMOC ON)

##让cmake自动处理qrc
set(CMAKE_AUTORCC ON)


FILE(GLOB INC ${CMAKE_SOURCE_DIR}/include/*.h)
aux_source_directory(${CMAKE_SOURCE_DIR}/src SRC)

## 这一行就是完成了.qrc的添加
add_executable(${EXE} ${SRC} ${INC} resources.qrc) 



target_include_directories(${EXE} PUBLIC ${CMAKE_SOURCE_DIR}/include)

find_package(Qt6 REQUIRED Widgets Test)
target_link_libraries(${EXE} PUBLIC Qt6::Widgets Qt6::Test)

目录结构像这样：

$ ls
CMakeLists.txt  bin/  build/  include/    src/  resources.qrc

程序中使用像下面这样：

#include <QApplication>
#include <QResource>
#include "MainWindow.h"

using namespace YQ;

int main (int argc, char *argv[])
{
	QApplication app (argc, argv);
	MainWindow w;
    w.setWindowIcon(QIcon(":resource/icon.ico"));
	w.show();
	return app.exec();
}

4. 惊天大坑

如果你想探个究竟，就读完下面吧，否则，前面的已经够你写出正常运行的程序了。

---

不知道你有没有注意到，使用CMAKE_AUTORCC自动处理qrc，产生的程序即使不调用

 QResource::registerResource("resources.rcc");

也能正常显示图标，而且你压根找不到任何一个.rcc后缀的文件。

它们都去哪里了？
那只能是都跑到可执行程序里了，或者说嵌入进去了。

接下来，我也尝试着手动嵌入进去。

首先，
rcc --binary resource.qrc -o resource.rcc

手动生成了.rcc文件。

然后理所当然地，CMakeLists.txt这样写：

add_executable(${EXE} ${SRC} ${INC} resources.rcc) 

并且不要开启CMAKE_AUTORCC，没有任何用，也没必要、不需要。

然而这样得出的程序运行起来还是没有图标！！！

解决

反复地尝试、观察cmake的输出。

我们开启CMAKE_AUTORCC

[ 10%] Automatic MOC for target main
[ 10%] Built target main_autogen
[ 20%] Automatic RCC for include/resources.qrc
[ 30%] Building CXX object CMakeFiles/main.dir/main_autogen/mocs_compilation.cpp.obj
[ 40%] Building CXX object CMakeFiles/main.dir/src/Image.cpp.obj
[ 50%] Building CXX object CMakeFiles/main.dir/src/MainWindow.cpp.obj
[ 60%] Building CXX object CMakeFiles/main.dir/src/Mouse.cpp.obj
[ 70%] Building CXX object CMakeFiles/main.dir/src/api.cpp.obj
[ 80%] Building CXX object CMakeFiles/main.dir/src/main.cpp.obj
[ 90%] Building CXX object CMakeFiles/main.dir/main_autogen/6YEA5652QU/qrc_resources.cpp.obj
[100%] Linking CXX executable C:\Users\sixqaq\Desktop\draw_v2\bin\main.exe
[100%] Built target main

注意到里面唯一一个接近的文件：

CMakeFiles/main.dir/main_autogen/6YEA5652QU/qrc_resources.cpp.obj

什么都看不出来。

开启编译详细过程来看一下，

cmake --build . --verbose

就看那个AUTORCC的过程：

[ 20%] Automatic RCC for include/resources.qrc
D:\cmake\bin\cmake.exe -E cmake_autorcc C:/Users/sixqaq/Desktop/draw_v2/build/CMakeFiles/main_autogen.dir/AutoRcc_resources_6YEA5652QU_Info.json 
AutoRcc: Generating "SRC:/build/main_autogen/6YEA5652QU/qrc_resources.cpp", because it doesn't exist, from "SRC:/include/resources.qrc"
D:/Qt/6.3.2/mingw_64/./bin/rcc.exe -name resources -o C:/Users/sixqaq/Desktop/draw_v2/build/main_autogen/6YEA5652QU/qrc_resources.cpp C:/Users/sixqaq/Desktop/draw_v
2/include/resources.qrc

很明显它调用了rcc，我们简化一下就是下面这样：

rcc.exe -name resources -o qrc_resources.cpp resources.qrc

里面的-name参数先不管它，最后再说。
再简化一下就是这样：

rcc resources.qrc -o qrc_resources.cpp

我们之前手动生成的命令中有一个--binary，而且后缀名是.rcc，可这里却是.cpp。

这就是惊天大坑所在了。

带上--binary生成的会是一个用于动态链接的二进制文件，是真正的.rcc文件。

不带--binary生成的，其实就是一个.cpp文件。

当你把这个不带--binary生成的.cpp文件加入到add_executable()中（注意，后缀名得是.cpp，改成.rcc还是会被忽略），
也就是这样：

add_executable(${EXE} ${INC} qrc_resource.cpp)

这样，资源就会随着qrc_resource.cpp嵌入到可执行程序中，此时无需再

QResource::registerResource("resources.rcc");

同时，不需要单独提供一个.rcc文件。

而且，对比一下，你会发现在add_executable()中放入.rcc文件（也就是二进制文件），程序大小不会改变，看起来就像被忽略了一样。

可是，在add_executable()中加入rcc生成的.cpp文件，程序大小会大那么一点。

这也从另一个角度说明后者成功把资源嵌入了进去，而前者则没有。

---

最后再说那个rcc -name resources的意思，
rcc --help中说是用于生成外部资源初始化函数的名字。

尝试在name后面跟上不同的名字，比如"OKOKOK"，再对比两个qrc_resources.cpp文件，你就会得到答案，看起来是资源初始化函数。

这也正好应了前面不用再调用：

QResource::registerResource("resources.rcc");

大概是因为这里已经自动初始化过了。

另外，CMAKE_AUTORCC似乎能够处理.qrc文件重名的情况，猜测和这里也有一定关系。