在 Linux 下编译 C/C++ 工程 - 以 ONScripter 为例

如果你下载了一个 C/C++ 工程的代码,想在 Linux 平台上编译生成可执行文件,应该怎么做呢?理想的情况是这样的:

第一步当然是解压缩了。用 unzip 指令解压 .zip 文件,其它所有奇奇怪怪看不懂的压缩包一般都可以用 tar zxvf 解决掉。

进入工程根目录,输入 ./configure 执行 shell 脚本。这个脚本会检测你的编译环境,并生成合适的 Makefile 文件。

执行 make 开始编译过程。如果想把编译的成果安装到计算机上,有时还可以再加一步 sudo make install

但是,出于种种原因,99%的工程都不会像刚才描述的那样一帆风顺。本文以 ONScripter 为例,还原了编译过程可能会遇到的诸多困难,希望能为你带来些许启发。

ONScripter 是一个开源的视觉小说(游戏)引擎。其源代码可在我的 GitHub 仓库 下载。尽管 README 文件由日语撰写,但我们依旧能从汉字和英文中获取诸多重要的信息:

- 作者使用的开发环境是 Linux 2.6 内核 + gcc 4.4 编译器。
- 软件依赖的组件有 libjpeg,bzip2,SDL 以及 SMPEG。
- 软件可以在包括 Linux,Windows,Andriod,iPad,MacOS 和 PSP 等平台上运行。
- 软件使用 Makefile 作为构建工具。

如果作者在 README 或官方网站中披露了代码的开发环境,一个实用的准则是不使用更老的系统和编译器构建这个项目。事实上,多数有经验的开发者会刻意选择陈旧稳定的环境和工具,所以这一点通常无需担心。但是,使用过新的编译器反而会带来意想不到的问题。从 gcc 6.0 开始,编译器默认使用 C++14 标准代替 C++98。很多符合 C++98 标准的代码此时将无法编译。为了强制使用 C++98 标准,你需要在 Makefile 合适的位置添加 -std=gnu++98 标识。

C/C++ 流行的构建工具有三种:Makefile,cmake 和 SCons。后两者会根据系统环境自动调整编译方式,但 Makefile 需要手工实现跨平台编译。为了便于维护,ONScripter 的作者很聪明地把 Makefile 拆分成了平台无关和平台有关的部分。下面是 ONScripter 所有 Makefile 的列表。

1
2
3
4
5
6
7
8
9
10
11
Makefile.ARMLinux
Makefile.GP2X
Makefile.iPhone
Makefile.iPodLinux
Makefile.Linux
Makefile.MacOSX
Makefile.onscripter
Makefile.Pandora
Makefile.PSP
Makefile.Win
Makefile.WinCE

这些文件中,只有 Makefile.onscripter 揭示了这个工程的结构(平台无关),其他文件则指定了各自平台下使用的编译器、依赖的库文件,以及其他标识。由于 ONScripter 支持的平台非常多,而 configure 只能在 shell 环境中运行,因此作者没有提供这个脚本。

下面节选了 Makefile.Linux 的代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# -*- Makefile -*-

EXESUFFIX =
OBJSUFFIX = .o

.SUFFIXES:
.SUFFIXES: $(OBJSUFFIX) .cpp .h

TARGET = onscripter$(EXESUFFIX) \
sardec$(EXESUFFIX) \
nsadec$(EXESUFFIX) \
sarconv$(EXESUFFIX) \
nsaconv$(EXESUFFIX)
EXT_OBJS =

# mandatory: SDL, SDL_ttf, SDL_image, SDL_mixer, bzip2, libjpeg
DEFS = -DLINUX
INCS = `sdl-config --cflags`
LIBS = `sdl-config --libs` -lSDL_ttf -lSDL_image -lSDL_mixer -lbz2 -ljpeg -lm

# recommended: smpeg
DEFS += -DUSE_SMPEG
INCS += `smpeg-config --cflags`
LIBS += `smpeg-config --libs`

# recommended: fontconfig (to get default font)
DEFS += -DUSE_FONTCONFIG
LIBS += -lfontconfig

# recommended: OggVorbis
DEFS += -DUSE_OGG_VORBIS
LIBS += -logg -lvorbis -lvorbisfile

# optional: support CD audio
DEFS += -DUSE_CDROM

# optional: avifile
DEFS += -DUSE_AVIFILE
INCS += `avifile-config --cflags`
LIBS += `avifile-config --libs`
TARGET += simple_aviplay$(EXESUFFIX)
EXT_OBJS += AVIWrapper$(OBJSUFFIX)

# optional: lua
DEFS += -DUSE_LUA
INCS += -I/usr/include/lua5.1
LIBS += -llua5.1
EXT_OBJS += LUAHandler$(OBJSUFFIX)

# optional: force screen width for PDA
#DEFS += -DPDA_WIDTH=640

# optional: enable English mode
#DEFS += -DENABLE_1BYTE_CHAR -DFORCE_1BYTE_CHAR

# for GNU g++
CC = g++
LD = g++ -o

CFLAGS = -O3 -Wall -fomit-frame-pointer -pipe -c $(INCS) $(DEFS)

RM = rm -f

include Makefile.onscripter

代码注释清楚地写明了在 Linux 系统下编译 ONScripter 必需、推荐和可选的依赖关系。你在编译前可根据需要打开或关闭相应的标识,然后用 make -f Makefile.Linux 开始编译过程。

如果不出所料,这时终端应该会显示如下消息:

1
2
3
4
5
6
7
8
9
10
11
g++  -O3 -Wall -fomit-frame-pointer -pipe -c `sdl-config --cflags` ...
/bin/sh: 1: sdl-config: not found
/bin/sh: 1: smpeg-config: not found
/bin/sh: 1: avifile-config: not found
In file included from ScriptParser.h:36:0,
from ONScripter.h:27,
from onscripter_main.cpp:24:
AnimationInfo.h:27:17: fatal error: SDL.h: No such file or directory
compilation terminated.
Makefile.onscripter:95: recipe for target 'onscripter_main.o' failed
make: *** [onscripter_main.o] Error 1

下面进入试错阶段。这个阶段比较无聊,但没有额外的难度。编译器声称找不到 SDL.h 文件,想必是因为你的系统中缺少相应的库文件。论软件仓库,Java 有 Maven,Python 有 pip,node 有 npm,但是 C/C++ 的仓库去哪里找呢?别着急,每个 Linux 发行版负担起了这项任务。

按照命名惯例,库文件都以 "lib" 开头。因此,SDL.h 对应的关键词应该是 "libsdl"。你需要从搜索结果中挖掘蛛丝马迹,安装貌似可以提供 SDL.h 的软件包,然后再试着编译,看看能不能解决这个问题。在 Debian/Ubuntu 系统下,搜索软件包的指令是

1
apt-cache search KEYWORD

经过数轮尝试,就能找到 SDL 库所有需要安装的软件包(实际结果因系统而异):

1
2
3
4
5
6
7
8
libsdl-image1.2
libsdl-image1.2-dev
libsdl-mixer1.2
libsdl-mixer1.2-dev
libsdl-ttf2.0-0
libsdl-ttf2.0-dev
libsdl1.2-dev
libsdl1.2debian

这些软件包分成 dev 包和非 dev 包两类。dev 包提供头文件,满足编译的需要。非 dev 包提供库文件,在链接时起作用,并于运行时加载。二者缺一不可。

总结来说,搜寻一个 C/C++ 工程依赖的库文件的方法如下:

  1. 尝试 make 工程
  2. 如果失败,捕捉编译器抛出的 No such file or directory 错误
  3. 搜索所有可能提供该文件的软件包
  4. 遴选并安装相应的软件包
  5. make clean 清理编译环境
  6. 返回第 1 步

如果你在编译过程中出现了其他错误,与之对应的原因就不止一种了,必须具体情况具体解决。因超出本文的讨论范围,以下不再叙述。