android.mk文档规范

《android.mk文档规范》由会员分享，可在线阅读，更多相关《android.mk文档规范（7页珍藏版）》请在金锄头文库上搜索。

1、 Android.mk 文档规范 1 Android.mk 文档规范文档规范 Android.mk 编译文件是用来向 Android NDK 描述你的 C,C+源代码文件的， 这篇文档描 述了它的语法。在阅读下面的内容之前，假定你已经阅读了 docs/OVERVIEW.TXT 文件，了解 了它们的脚色和用途。 一、概述一、概述 一个 Android.mk file 用来向编译系统描述你的源代码。具体来说： （1） 该文件是 GNU Makefile 的一小部分， 会被编译系统解析一次或更多次的 build 系统。 因此，您应尽量减少您声明的变量，不要认为某些变量在解析过程中不会被定义。 （2）

2、这个文件的语法允许把你的源代码组织成模块，一个模块属下列类型之一： 1）静态库 2）共享库 且只有共享库将被安装/复制到您的应用软件包，虽然静态库能被用于生成共享库。 可以在每一个 Android.mk file 中定义一个或多个模块， 你也可以在几个模块中使用同一个 源代码文件。 编译系统为你处理许多细节问题。例如，你不需要在你的 Android.mk 中列出头文件和依 赖文件。NDK 编译系统将会为你自动处理这些问题。这也意味着，在升级 NDK 后，你应该 得到新的 toolchain/platform 支持，而且不需要改变你的 Android.mk 文件。 注意，这个语法同公开发布的 A

3、ndroid 平台的开源代码很接近，然而编译系统实现他们的 方式却是不同的，这是故意这样设计的，可以让程序开发人员重用外部库的源代码更容易。 在描述语法细节之前，咱们来看一个简单的“hello world“的例子，比如，下面的文件： sources/helloworld/helloworld.c sources/helloworld/Android.mk helloworld.c是一个 JNI 共享库，实现返回“hello world“字符串的原生方法。相应的 Android.mk 文件会象下面这样： LOCAL_PATH := $(call my-dir) include $(CLEAR_V

4、ARS) LOCAL_MODULE:= helloworld LOCAL_SRC_FILES := helloworld.c include $(BUILD_SHARED_LIBRARY) 解释一下这几行代码： LOCAL_PATH := $(call my-dir) 一个Android.mk file首先必须定义好LOCAL_PATH变量。 它用于在开发树中查找源文件。 在这个例子中， 宏函数my-dir, 由编译系统提供， 用于返回当前路径(即包含Android.mk file 文件的目录)。 include $(CLEAR_VARS) CLEAR_VARS 由编译系统提供(可以在 and

5、roid 安装目录下的/build/core/config.mk 文件看 到其定义，为 CLEAR_VARS:= $(BUILD_SYSTEM)/clear_vars.mk)，指定让 GNU MAKEFILE 为 你 清 除 许 多LOCAL_XXX变 量 ( 例 如LOCAL_MODULE ， LOCAL_SRC_FILES ，Android.mk 文档规范 2 LOCAL_STATIC_LIBRARIES，等等)，除 LOCAL_PATH。这是必要的，因为所有的编译控 制文件都在同一个 GNU MAKE 执行环境中，所有的变量都是全局的。 LOCAL_MODULE := helloworl

6、d LOCAL_MODULE 变量必须定义，以标识你在 Android.mk 文件中描述的每个模块。名称 必须是唯一的，而且不包含任何空格。注意编译系统会自动产生合适的前缀和后缀，换句话 说，一个被命名为foo的共享库模块，将会生成libfoo.so文件。注意：如果把库命名为 libhelloworld，编译系统将不会添加任何的 lib 前缀，也会生成 libhelloworld.so，这是 为了支持来源于 Android 平台的源代码的 Android.mk 文件。 LOCAL_SRC_FILES := helloworld.c LOCAL_SRC_FILES 变量必须包含将要编译打包进模块

7、中的 C 或 C+源代码文件。不用 在这里列出头文件和包含文件，编译系统将会自动找出依赖型的文件。 【注意，默认的 C+源码文件的扩展名是.cpp 。指定一个不同的扩展名也是可能的，只要定义 LOCAL_DEFAULT_CPP_EXTENSION 变量，不要忘记开始的小圆点(也就是定义为 .cxx,而不是cxx)】 include $(BUILD_SHARED_LIBRARY) BUILD_SHARED_LIBRARY 是编译系统提供的变量，指向一个 GNU Makefile 脚本(应该 就 是 在 build/core 目 录 下 的 shared_library.mk) ， 负 责 收 集

8、 自 从 上 次 调 用 include $(CLEAR_VARS)以来，定义在 LOCAL_XXX 变量中的所有信息，并且决定编译什么，如何正 确地去做。并根据其规则生成静态库。同理对于静态库。 在 sources/samples 目录下有更复杂一点的例子，写有注释的 Android.mk 文件。 二、参考二、参考 这是一份你应该在 Android.mk 中依赖或定义的变量列表， 可以定义其他变量为自己使用， 但是 NDK 编译系统保留下列变量名： -以 LOCAL_开头的名字（例如 LOCAL_MODULE） -以 PRIVATE_, NDK_ 或 APP_开头的名字（内部使用） -小写名

9、字（内部使用，例如my-dir） 如果为了方便在 Android.mk 中定义自己的变量，建议使用 MY_前缀，一个小例子： MY_SOURCES := foo.c ifneq ($(MY_CONFIG_BAR),) MY_SOURCES += bar.c endif LOCAL_SRC_FILES += $(MY_SOURCES) 1. GNU Make 变量变量 这些 GNU Make 变量在你的 Android.mk 文件解析之前，就由编译系统定义好了。注意在 某些情况下，NDK 可能分析 Android.mk 几次，每一次某些变量的定义会有不同。 （1）CLEAR_VARS: 指向一个

10、编译脚本，几乎所有未定义的 LOCAL_XXX 变量都在 “Module-description“节中列出。必须在开始一个新模块之前包含这个脚本：include $(CLEAR_VARS) （2）BUILD_SHARED_LIBRARY: 指向编译脚本，收集所有的在 LOCAL_XXX 变量中提 供的信息，并且决定如何把列出的源代码文件编译成一个共享库。注意，必须至少在包含这 个文件之前定义 LOCAL_MODULE 和 LOCAL_SRC_FILES。使用例子： Android.mk 文档规范 3 include $(BUILD_SHARED_LIBRARY) #这将生成一个名为 lib$(

11、LOCAL_MODULE).so 的文件 （3） BUILD_STATIC_LIBRARY: 一个 BUILD_SHARED_LIBRARY 变量用于编译一个静 态库。静态库不会复制到的 project/packages 中，但是能够用于编译共享库， （看下面描述的 LOCAL_STATIC_LIBRARIES and LOCAL_STATIC_WHOLE_LIBRARIES） 。使用例子： include $(BUILD_STATIC_LIBRARY) #注意，这将会生成一个名为 lib$(LOCAL_MODULE).a 的文件 （4） TARGET_ARCH: 目标 CPU 平台的名字,

12、和 android 开放源码中指定的那样。 如果是 arm，表示要生成 ARM 兼容的指令，与 CPU 架构的修订版无关。 （5）TARGET_PLATFORM: Android.mk 解析的时候，目标 Android 平台的名字.详情可参 考/development/ndk/docs/stable- apis.txt. android-3 - Official Android 1.5 system images android-4 - Official Android 1.6 system images android-5 - Official Android 2.0 system imag

13、es （6）TARGET_ARCH_ABI: 暂时只支持两个 value，armeabi 和 armeabi-v7a。在 现在的版本中一般把这两个值简单的定义为 arm， 通过 android 平台内部对它重定义来获得更 好的匹配。其他的 ABI 将在以后的 NDK 版本中介绍，它们会有不同的名字。注意所有基于 ARM 的 ABI 都会把 TARGET_ARCH定义成arm， 但是会有不同的TARGET_ARCH_ABI。 （ 7 ） TARGET_ABI: 目 标 平 台 和ABI的 组 合 ， 它 事 实 上 被 定 义 成 $(TARGET_PLATFORM)-$(TARGET_ARCH

14、_ABI) ， 在想要在真实的设备中针对一个特别的 目标系统进行测试时，会有用。在默认的情况下，它会是android-3-arm。 2. 模块描述变量模块描述变量 下面的变量用于向编译系统描述你的模块。你应该定义在include $(CLEAR_VARS) 和include $(BUILD_XXXXX)之间。正如前面描写的那样，$(CLEAR_VARS)是一个脚 本，清除所有这些变量，除非在描述中显式注明。 （1） LOCAL_PATH: 这个变量用于给出当前文件的路径。必须在 Android.mk 的开头定 义，可以这样使用： LOCAL_PATH := $(call my-dir) 这个变

15、量不会被$(CLEAR_VARS)清除，因此每个 Android.mk 只需要定义一次(即使在一 个文件中定义了几个模块的情况下)。 （2）LOCAL_MODULE: 这是模块的名字，它必须是唯一的，而且不能包含空格。必须在 包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字。例如，如 果一个一个共享库模块的名字是，那么生成文件的名字就是 lib.so。但是，在的 NDK 生成文 件中(或者 Android.mk 或者 Application.mk)，应该只涉及(引用)有正常名字的其他模块。 （3）LOCAL_SRC_FILES: 这是要编译的源代码文件列表。只

16、要列出要传递给编译器的 文件，因为编译系统自动计算依赖。注意源代码文件名称都是相对于 LOCAL_PATH 的，你可 以使用路径部分，例如： LOCAL_SRC_FILES := foo.c toto/bar.c 【注意：在生成文件中都要使用 UNIX 风格的斜杠(/).windows 风格的反斜杠不会被正确的处理。 】 Android.mk 文档规范 4 （4） LOCAL_CPP_EXTENSION: 这是一个可选变量， 用来指定 C+代码文件的扩展名， 默认是.cpp,但是可以改变它，比如： LOCAL_CPP_EXTENSION := .cxx （5） LOCAL_C_INCLUDES: 路径的可选配置，是从根目录开始的所有源文件(C, C+ and Assembly)。比如: LOCAL_C_INCLUDES := sources/foo 或者： LOCAL_C_INCLUDES := $(LOCAL_PATH)/./foo 需要在任