OpenHarmonyOS-gn与Ninja
GN语法及在鸿蒙的使用
[gn+ninja学习 0x01]gn和ninja是什么
ohos_sdk/doc/subsys-build-gn-coding-style-and-best-practice.md
GN 语言与操作
一、gn简介
gn是generate ninja的缩写，它是一个元编译系统（meta-build system）,是ninja的前端，gn和ninja结合起来，完成OpenHarmony操作系统的编译任务。
元构建系统是一个生成其他构建系统的构建系统，cmake就是一个非常典型的元构建系统。本系统文章要学习的gn也是个元构建系统。
| 类别 | gn+ninja | cmake+make |
|---|---|---|
| 元构建系统 | gn | cmake |
| 构建系统 | ninja | make |
| 元构建文件 | BUILD.gn | CMake.txt |
| 构建文件 | *.ninja | Makefile |
二、代码风格
命名
总体上遵循Linux kernel的命名风格，即小写字母+下划线的命名风格。
局部变量
我们这里对局部变量的定义为：在某作用域内，且不向下传递的变量。
为了更好的区别于全局变量，局部变量统一采用下划线开头。
# 例1 action运行脚本生成文件.
action("some_action") {
...
# _output是个局部变量，所以使用下划线开头
_output = "${target_out_dir}/${target_name}.out"
outputs = [ _output ]
args = [
...
"--output",
# 使用rebase_path转换目录.将相对于当前目录的文件名转换为根目录
rebase_path(_output, root_build_dir),
...
]
...
}
全局变量
全局变量使用小写字母开头。
如果变量值可以被gn args修改，则需要使用declare_args来声明，否则不要使用declare_args。
#例2
declare_args() {
# 可以通过gn args来修改some_feature的值
some_feature = false
}
目标命名
目标命名采用小写字母+下划线的命名方式。
模板中的子目标命名方式采用"${target_name}+双下划线+后缀"的命名方式。这样做有两点好处：
加入"${target_name}"可以防止子目标重名。
加入双下划线可以很方便地区分出子目标属于哪一个模块，方便在出现问题时快速定位。
# 例3
#template是 GN 复用代码的主要方式.通常,模板扩展为一个或多个其他目标类型.
template("ohos_shared_library") {
# "{target_name}"(主目标名)+"__"(双下划线)+"notice"(后缀)
_notice_target = "${target_name}__notice"
collect_notice(_notice_target) {
...
}
shared_library(target_name) {
...
}
}
自定义模板的命名
推荐采用动宾短语的形式来命名。
# 例4
# Good
template("compile_resources") {
...
}
格式化
gn脚本在提交之前需要执行格式化。格式化可以保证代码对齐，换行等风格的统一。使用gn自带的format工具即可。命令如下：
$ gn format path-to-BUILD.gn
gn format会按照字母序对import文件做排序，如果想保证import的顺序，可以添加空注释行。
假设原来的import顺序为：
# 例5
import("//b.gni")
import("//a.gni")
经过format之后变为：
import("//a.gni")
import("//b.gni")
如果想保证原有的import顺序，可以添加空注释行。
import("//b.gni")
# Comment to keep import order
import("//a.gni")
三、编码实践
gn文件中很多内置变量，列举常用变量如下：
import:将文件导入当前范围.
print:打印到控制台.
rebase_path:将文件或目录重新定位到另一个位置.
template:定义模板规则.
defined:返回是否定义了标识符.
asmflags:[string list]传递给汇编程序的标志.
cflags:[string list]传递给所有C编译器变量的标志.
ldflags:[string list]传递给链接器的标志.
libs:[string list]链接的附加库.
sources:[ file list ] 目标源文件 .
坚持就有收获！
