1 mkfile

Android ndk文档翻译之三:Android.mk文件语法规范(上部)
Android, ndk

今天翻译ANDROID-MK.TXT文件



Android.mk文件语法规范




Introduction:





Android.mk编译文件是用来向Android NDK描述你的C,C++源代码文件的， 这篇文档描述了它的语法。在阅读下面的内容之前，假定你已经阅读了docs/OVERVIEW.TXT文件，了解了它们的脚色和用途。









概述:



一个Android.mk file用来向编译系统描述你的源代码。具体来说：
-该文件是GNU Makefile的一小部分，会被编译系统解析一次或多次，
解析一次或更多次的build系统。因此，您
应尽量减少您声明的变量，不要认为某些变量在解析过程中不会被定义。







-这个文件的语法允许把你的源代码组织成模块，一个模块属下列类型之一：
-
静态库
-
共享库
只有共享库将被安装/复制到您的应用软件包。虽然静态库能被用于生成共享库。

你可以在每一个Android.mk file中定义一个或多个模块，你也可以在几个模块中使用同一个源代码文件。

-编译系统为你处理许多细节问题。例如，你不需要在你的Android.mk中列出头文件和依赖文件。NDK编译系统将会为你自动处理这些问题。这也意味着，在升级NDK后，你应该得到新的toolchain/platform支持，而且不需要改变你的Android.mk文件。

注意，这个语法同公开发布的Android平台的开源代码很接近，然而编译系统实现他们的方式却是不同的，这是故意这样设计的，可以让程序开发人员重用外部库的源代码更容易。




简单的例子:



---------------



在描述语法细节之前，咱们来看一个简单的"hello world"的例子，比如，下面的文件：





sources/helloworld/helloworld.c




sources/helloworld/Android.mk



'helloworld.c'是一个JNI共享库，实现返回"hello world"字符串的原生方法。




相应的Android.mk文件会象下面这样：





---------- cut here ------------------




LOCAL_PATH := $(call my-dir)









include $(CLEAR_VARS)









LOCAL_MODULE
:= helloworld




LOCAL_SRC_FILES := helloworld.c









include $(BUILD_SHARED_LIBRARY)




---------- cut here ------------------



好，我们来解释一下这几行代码：










LOCAL_PATH := $(call my-dir)



一个Android.mk file首先必须定义好LOCAL_PATH变量。它用于在开发树中查找源文件。在这个例子中，宏函数’my-dir’, 由编译系统提供，用于返回当前路径（即包含Android.mk file文件的目录）。









include $( CLEAR_VARS)


CLEAR_VARS由编译系统提供，指定让GNU MAKEFILE为你清除许多LOCAL_XXX变量（例如 LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES, 等等...),
除LOCAL_PATH 。这是必要的，因为所有的编译控制文件都在同一个GNU MAKE执行环境中，所有的变量都是全局的。



LOCAL_MODULE := helloworld
LOCAL_MODULE变量必须定义，以标识你在Android.mk文件中描述的每个模块。名称必须是唯一的，而且不包含任何空格。注意编译系统会自动产生合适的前缀和后缀，换句话说，一个被命名为'foo'的共享库模块，将会生成'libfoo.so'文件。



重要注意事项



如果你把库命名为‘libfoo’，编译系统将不会添加任何的lib前缀，也会生成libfoo.so，这是为了支持来源于Android平台的源代码的Android.mk文件，如果你确实需要这么做的话。




LOCAL_SRC_FILES := helloworld.c



LOCAL_SRC_FILES变量必须包含将要编译打包进模块中的C或C++源代码文件。注意，你不用在这里列出头文件和包含文件，因为编译系统将会自动为你找出依赖型的文件；仅仅列出直接传递给编译器的源代码文件就好。




注意，默认的C++源码文件的扩展名是’.cpp’. 指定一个不同的扩展名也是可能的，只要定义LOCAL_DEFAULT_CPP_EXTENSION变量，不要忘记开始的小圆点（也就是’.cxx’,而不是’cxx’）.








include $(BUILD_SHARED_LIBRARY)








BUILD_SHARED_LIBRARY是编译系统提供的变量，指向一个GNU Makefile脚本，负责收集自从上次调用'include $(CLEAR_VARS)'以来，定义在LOCAL_XXX变量中的所有信息，并且决定编译什么，如何正确地去做。还有BUILD_STATIC_LIBRARY变量生成静态库。




在sources/samples目录下有更复杂一点的例子，写有注释的Android.mk文件，你可以看看。









参考:





这是一份你应该在Android.mk中依赖或定义的变量列表，您可以定义其他变量为自己使用，




但是NDK编译系统保留下列变量名：




-以LOCAL_开头的名字（例如 LOCAL_MODULE）




-以PRIVATE_, NDK_ or APP_开头的名字（内部使用）




-小写名字（内部使用，例如’my-dir’）




如果您为了方便在Android.mk中定义自己的变量，我们建议使用MY_前缀，一个小例子：

---------- cut here ------------------




MY_SOURCES := foo.c




ifneq ($(MY_CONFIG_BAR),)




MY_SOURCES += bar.c




endif









LOCAL_SRC_FILES += $(MY_SOURCES)




---------- cut here ------------------








这样，我们就达到目的了。









NDK提供的变量:



-
- - - - - - - - - - -



这些GNU Make 变量在你的Android.mk文件解析之前，就由编译系统定义好了。




注意在某些情况下，NDK可能分析Android.mk几次，每一次某些变量的定义会有不同。









CLEAR_VARS








指向一个编译脚本，几乎所有未定义的LOCAL_XXX变量都在"Module-description"节中列出。你必须在开始一个新模块之前包含这个脚本。




include $(CLEAR_VARS)








BUILD_SHARED_LIBRARY



指向编译脚本，收集所有的你在LOCAL_XXX变量中提供的信息，并且决定如何把你列出的源代码文件编译成一个共享库。注意，你必须至少在包含这个文件之前定义LOCAL_MODULE和LOCAL_SRC_FILES，使用例子：




include $(BUILD_SHARED_LIBRARY)



注意这将生成一个名为lib$(LOCAL_MODULE).so的文件。









BUILD_STATIC_LIBRARY








一个BUILD_SHARED_LIBRARY变量用于编译一个静态库。静态库不会复制到你的project/packages中，诞生能够用于编译共享库，（看下面描述的LOCAL_STATIC_LIBRARIES and LOCAL_STATIC_WHOLE_LIBRARIES）




使用例子：




include $(BUILD_STATIC_LIBRARY)



注意，这将会生成一个名为lib$(LOCAL_MODULE).a的文件。








TARGET_ARCH



　　目标CPU平台的名字，如同在Ａｎｄｒｏｉｄ开放源码中指定的那样。如果是’arm’，表示要生成ARM兼容的指令，与CPU架构的修订版无关。









TARGET_PLATFORM



　　Android.mk解析的时候，目标Android平台的名字，现在只支持'android-1.5'。









TARGET_ARCH_ABI



CPU+ABI的名字，只支持’arm’,它的含义是：




ARMv5TE或更高级ＣＰＵ，并且具有'softfloat'浮点支持。




　　
其他的ＡＢＩ将在以后的ＮＤＫ版本中介绍，它们会有不同的名字。注意所有基于ＡＲＭ的ＡＢＩ都会把'TARGET_ARCH'定义成‘ａｒｍ’，但是会有不同的‘TARGET_ARCH_ABI’









TARGET_ABI



　　目标平台和ａｂｉ的组合，它事实上被定义成$(TARGET_PLATFORM)-$(TARGET_ARCH_ABI)



在你想要在真实的设备中针对一个特别的目标系统进行测试时，会有用。