Android.mk（TODO）

`Android.mk` 文件是 Android 构建系统（基于 GNU Make）的一个核心部分，用于定义如何构建项目中的模块。在 Android 中，`Android.mk` 文件主要用于描述本地模块（如库、可执行文件等）的构建信息。以下是 `Android.mk` 文件语法的详细介绍。

### 基本结构

一个简单的 `Android.mk` 文件通常包含以下几个部分：

1. **包含主构建脚本**：
   通常在文件开头，包含构建系统的顶层文件：
   ```makefile
   include $(CLEAR_VARS)
   ```

2. **定义模块名称**：
   使用 `LOCAL_MODULE` 变量定义模块名称：
   ```makefile
   LOCAL_MODULE := my_module
   ```

3. **指定模块类型**：
   使用适当的编译器变量来指定模块类型（静态库、共享库、可执行文件等）：
   ```makefile
   LOCAL_SRC_FILES := main.cpp
   LOCAL_STATIC_LIBRARIES := my_static_lib
   ```

4. **包括构建规则**：
   包含适当的构建脚本来处理定义的模块：
   ```makefile
   include $(BUILD_EXECUTABLE)
   ```

### 主要变量

#### 1. `LOCAL_PATH`
指定当前目录路径，通常用于确保相对路径正确：
```makefile
LOCAL_PATH := $(call my-dir)
```

#### 2. `include $(CLEAR_VARS)`
清除大多数 `LOCAL_` 变量，确保不受前面定义的影响：
```makefile
include $(CLEAR_VARS)
```

#### 3. `LOCAL_MODULE`
指定模块名称：
```makefile
LOCAL_MODULE := my_library
```

#### 4. `LOCAL_SRC_FILES`
指定模块的源文件列表：
```makefile
LOCAL_SRC_FILES := file1.cpp file2.cpp
```

#### 5. `LOCAL_C_INCLUDES`
指定头文件搜索路径：
```makefile
LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
```

#### 6. `LOCAL_SHARED_LIBRARIES` 和 `LOCAL_STATIC_LIBRARIES`
指定模块依赖的共享库和静态库：
```makefile
LOCAL_SHARED_LIBRARIES := libshared
LOCAL_STATIC_LIBRARIES := libstatic
```

#### 7. `LOCAL_CFLAGS` 和 `LOCAL_CPPFLAGS`
指定编译器标志：
```makefile
LOCAL_CFLAGS := -Wall
LOCAL_CPPFLAGS := -std=c++11
```

#### 8. `include $(BUILD_SHARED_LIBRARY)`，`include $(BUILD_STATIC_LIBRARY)`，`include $(BUILD_EXECUTABLE)`
指定构建类型（共享库、静态库或可执行文件）：
```makefile
include $(BUILD_SHARED_LIBRARY)
include $(BUILD_STATIC_LIBRARY)
include $(BUILD_EXECUTABLE)
```

### 示例

以下是一个示例 `Android.mk` 文件，构建一个共享库：

```makefile
# 设置当前路径
LOCAL_PATH := $(call my-dir)

# 清除变量
include $(CLEAR_VARS)

# 设置模块名称
LOCAL_MODULE := my_shared_lib

# 设置源文件
LOCAL_SRC_FILES := src/main.cpp src/util.cpp

# 设置头文件路径
LOCAL_C_INCLUDES := $(LOCAL_PATH)/include

# 设置依赖库
LOCAL_SHARED_LIBRARIES := libdependency

# 编译选项
LOCAL_CPPFLAGS := -std=c++11

# 构建共享库
include $(BUILD_SHARED_LIBRARY)
```

### 高级用法

#### 1. `LOCAL_PREBUILT_LIBS`
用于预编译库的包含：
```makefile
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)

LOCAL_MODULE := prebuilt_lib
LOCAL_SRC_FILES := libs/libprebuilt.so
include $(PREBUILT_SHARED_LIBRARY)
```

#### 2. `LOCAL_STATIC_LIBRARIES` 与 `LOCAL_SHARED_LIBRARIES`
包含其他模块：
```makefile
LOCAL_STATIC_LIBRARIES := libstatic
LOCAL_SHARED_LIBRARIES := libshared
```

#### 3. 包含其他 `Android.mk` 文件
```makefile
include $(LOCAL_PATH)/subdir/Android.mk
```

### 总结

`Android.mk` 文件通过变量定义和包含构建脚本来管理 Android 项目中的模块构建。理解这些语法和变量对于成功构建和管理 Android 项目至关重要。通过定义模块名称、源文件、依赖库和编译选项，可以灵活地构建不同类型的模块（共享库、静态库和可执行文件）。

让我们来创建一个简单的 `Android.mk` 文件的例子，它定义了一个共享库和一个可执行文件。这个例子将展示如何使用 `Android.mk` 文件中的基本语法和变量。

### 示例项目结构

假设我们的项目目录结构如下：

```
my_project/
├── Android.mk
├── src/
│   ├── main.cpp
│   ├── helper.cpp
│   └── library.cpp
└── include/
    ├── main.h
    ├── helper.h
    └── library.h
```

在这个项目中，我们有一个共享库和一个可执行文件。共享库将包含 `library.cpp`，可执行文件将使用共享库，并包含 `main.cpp` 和 `helper.cpp`。

### 示例 `Android.mk` 文件

```makefile
# 设置当前路径
LOCAL_PATH := $(call my-dir)

# 清除变量
include $(CLEAR_VARS)

# 定义共享库模块
LOCAL_MODULE := my_shared_lib
LOCAL_SRC_FILES := src/library.cpp
LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
LOCAL_CPPFLAGS := -std=c++11
include $(BUILD_SHARED_LIBRARY)

# 清除变量
include $(CLEAR_VARS)

# 定义可执行文件模块
LOCAL_MODULE := my_executable
LOCAL_SRC_FILES := src/main.cpp src/helper.cpp
LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
LOCAL_SHARED_LIBRARIES := my_shared_lib
LOCAL_CPPFLAGS := -std=c++11
include $(BUILD_EXECUTABLE)
```

### 解释

1. **设置当前路径**
   ```makefile
   LOCAL_PATH := $(call my-dir)
   ```
   `LOCAL_PATH` 变量设置为当前 `Android.mk` 文件所在的目录。`$(call my-dir)` 是一个内置的 GNU Make 函数，用于返回当前 makefile 文件的路径。

2. **清除变量**
   ```makefile
   include $(CLEAR_VARS)
   ```
   `include $(CLEAR_VARS)` 清除之前定义的所有 `LOCAL_` 变量，确保它们不会对后续的模块定义产生影响。

3. **定义共享库模块**
   ```makefile
   LOCAL_MODULE := my_shared_lib
   LOCAL_SRC_FILES := src/library.cpp
   LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
   LOCAL_CPPFLAGS := -std=c++11
   include $(BUILD_SHARED_LIBRARY)
   ```
   - `LOCAL_MODULE := my_shared_lib`: 定义模块名称为 `my_shared_lib`，这是一个共享库的名称。
   - `LOCAL_SRC_FILES := src/library.cpp`: 指定共享库的源文件为 `library.cpp`。
   - `LOCAL_C_INCLUDES := $(LOCAL_PATH)/include`: 指定头文件的包含路径。
   - `LOCAL_CPPFLAGS := -std=c++11`: 指定编译选项，这里使用 C++11 标准。
   - `include $(BUILD_SHARED_LIBRARY)`: 指定构建类型为共享库。

4. **清除变量**
   再次清除变量，为下一个模块的定义做准备。

5. **定义可执行文件模块**
   ```makefile
   LOCAL_MODULE := my_executable
   LOCAL_SRC_FILES := src/main.cpp src/helper.cpp
   LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
   LOCAL_SHARED_LIBRARIES := my_shared_lib
   LOCAL_CPPFLAGS := -std=c++11
   include $(BUILD_EXECUTABLE)
   ```
   - `LOCAL_MODULE := my_executable`: 定义模块名称为 `my_executable`，这是可执行文件的名称。
   - `LOCAL_SRC_FILES := src/main.cpp src/helper.cpp`: 指定可执行文件的源文件为 `main.cpp` 和 `helper.cpp`。
   - `LOCAL_C_INCLUDES := $(LOCAL_PATH)/include`: 指定头文件的包含路径。
   - `LOCAL_SHARED_LIBRARIES := my_shared_lib`: 指定依赖的共享库为 `my_shared_lib`，即前面定义的共享库。
   - `LOCAL_CPPFLAGS := -std=c++11`: 指定编译选项，这里使用 C++11 标准。
   - `include $(BUILD_EXECUTABLE)`: 指定构建类型为可执行文件。

### 总结

这个 `Android.mk` 文件示例展示了如何在 Android 构建系统中定义两个模块：一个共享库和一个可执行文件。通过定义 `LOCAL_MODULE`、`LOCAL_SRC_FILES`、`LOCAL_C_INCLUDES`、`LOCAL_SHARED_LIBRARIES` 等变量，我们可以告诉构建系统如何构建这些模块，以及它们之间的依赖关系。`include $(BUILD_SHARED_LIBRARY)` 和 `include $(BUILD_EXECUTABLE)` 分别指定了模块的类型。