Android-NDK开发之基础--Android.mk文件语法规范(转JavaEye)

转载 2012年03月29日 17:52:42

原文:http://gyht0808.javaeye.com/blog/765730

 

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平台的名字,如同在Android开放源码中指定的那样。如果是’arm’,表示要生成ARM兼容的指令,与CPU架构的修订版无关。

  TARGET_PLATFORM

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

  TARGET_ARCH_ABI

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

  ARMv5TE或更高级CPU,并且具有'softfloat'浮点支持。

  其他的ABI将在以后的NDK版本中介绍,它们会有不同的名字。注意所有基于ARM的ABI都会把'TARGET_ARCH'定义成‘arm’,但是会有不同的‘TARGET_ARCH_ABI’

    TARGET_ABI

 

  目标平台和abi的组合,它事实上被定义成$(TARGET_PLATFORM)-$(TARGET_ARCH_ABI)

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

  在默认的情况下,它会是'android-1.5-arm'

  ///////////////////

  NDK-提供的功能宏

  -

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

  下面是GNU Make ‘功能’宏,必须通过使用'$(call )'来求值,他们返回文本化的信息。

  my-dir

  返回当前 Android.mk所在的目录路径,相对于NDK编译系统的顶层。这是有用的,在Android.mk文件的开头如此定义:

  LOCAL_PATH := $(call my-dir)

  all-subdir-makefiles

  返回一个位于当前'my-dir'路径的子目录列表。例如,看下面的目录层次:

  sources/foo/Android.mk

  sources/foo/lib1/Android.mk

  sources/foo/lib2/Android.mk

  如果 sources/foo/Android.mk包含一行:

  include $(call all-subdir-makefiles)

  那么它就会自动包含 sources/foo/lib1/Android.mk and

  sources/foo/lib2/Android.mk

  这项功能用于向编译系统提供深层次嵌套的代码目录层次。注意,在默认情况下,NDK将会只搜索在 sources/*/Android.mk中的文件。

  this-makefile

  返回当前 Makefile的路径(即这个函数调用的地方)

  parent-makefile

  返回调用树中父Makefile路径。即包含当前Makefile的Makefile路径。

  grand-parent-makefile

  猜猜看...

  模块描述变量:

  -

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

  下面的变量用于向编译系统描述你的模块。你应该定义在 'include $(CLEAR_VARS)'和'include $(BUILD_XXXXX)'之间定义。正如前面描写的那样,$(CLEAR_VARS是一个脚本,清除所有这些变量,除非在描述中显式注明。

  LOCAL_PATH

  这个变量用于给出当前文件的路径。你必须在Android.mk的开头定义,可以这样使用:

  LOCAL_PATH := $(call my-dir)

  这个变量不会被$(CLEAR_VARS)清除,因此每个Android.mk只需要定义一次(在你在一个文件中定义了几个模块的情况下)。

    LOCAL_MODULE

  这是你模块的名字,它必须是唯一的,而且不能包含空格。你必须在包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字,例如,如果一个一个共享库模块的名字是,那么生成文件的名字就是lib.so。但是,在你的NDK生成文件中(或者 Android.mk或者Application.mk),你应该只涉及(引用)有正常名字的其他模块。

  LOCAL_SRC_FILES

  这是要编译的源代码文件列表。只要列出要传递给编译器的文件,因为编译系统自动为你计算依赖。

  注意源代码文件名称都是相对于LOCAL_PATH的,你可以使用路径部分,例如:

  LOCAL_SRC_FILES := foo.c

  toto/bar.c

  注意:在生成文件中都要使用UNIX风格的斜杠 (/).windows风格的反斜杠不会被正确的处理。

  LOCAL_CPP_EXTENSION

  这是一个可选变量,用来指定C++代码文件的扩展名,默认是'.cpp',但是你可以改变它,比如:

  LOCAL_CPP_EXTENSION := .cxx

  LOCAL_CFLAGS

  可选的编译器选项,在编译C代码文件的时候使用。

  这可能是有用的,指定一个附加的包含路径(相对于NDK的顶层目录),宏定义,或者编译选项。

  重要信息:不要在 Android.mk中改变optimization/debugging级别,只要在Application.mk中指定合适的信息,就会自动地为你处理这个问题,在调试期间,会让NDK自动生成有用的数据文件。

  LOCAL_CXXFLAGS

  Same as LOCAL_CFLAGS for C++ source files

  LOCAL_CPPFLAGS

  与 LOCAL_CFLAGS相同,但是对C 和 C++ source files都适用。

  LOCAL_STATIC_LIBRARIES

  应该链接到这个模块的静态库列表(使用BUILD_STATIC_LIBRARY生成),这仅仅对共享库模块才有意义。

  LOCAL_SHARED_LIBRARIES

  这个模块在运行时要依赖的共享库模块列表,在链接时需要,在生成文件时嵌入的相应的信息。

  注意:这不会附加列出的模块到编译图,也就是,你仍然需要在Application.mk中把它们添加到程序要求的模块中。

  LOCAL_LDLIBS

  编译你的模块要使用的附加的链接器选项。这对于使用”-l”前缀传递指定库的名字是有用的。例如,下面将告诉链接器生成的模块要在加载时刻链接到/system/lib/libz.so

    LOCAL_LDLIBS := -lz

  看docs/STABLE-APIS.TXT获取你使用NDK发行版能链接到的开放的系统库列表。

  LOCAL_ALLOW_UNDEFINED_SYMBOLS

  默认情况下,在试图编译一个共享库时,任何未定义的引用将导致一个“未定义的符号”错误。这对于在你的源代码文件中捕捉错误会有很大的帮助。

  然而,如果你因为某些原因,需要不启动这项检查,把这个变量设为‘true’。注意相应的共享库可能在运行时加载失败。

相关文章推荐

Android-NDK开发之基础--Android.mk文件语法规范(转JavaEye)

原文:http://gyht0808.javaeye.com/blog/765730 Introduction:  Android.mk编译文件是用来向Android NDK描述你的C,C++源代码文...
  • GEOLO
  • GEOLO
  • 2011年01月28日 11:17
  • 3673

anroid ndk文档翻译之四:Android.mk文件语法规范(下部)

NDK-提供的功能宏 - - - - - - - - - - - - - - - 下面是GNU Make ‘功能’宏,必须通过使用'$(call )'来求值,他们返回文本化的信息...

Android ndk文档翻译之三:Android.mk文件语法规范(上部)2010-09-14 14:32

今天翻译ANDROID-MK.TXT文件 Android.mk文件语法规范 Introduction: Android.mk编译文件是用来向AndroidNDK描述你...

opus NDK 编译 Android.mk文件

  • 2014年11月29日 12:28
  • 5KB
  • 下载

Android.mk文件的语法规范(http://www.srombauts.fr/android-ndk-r5b/docs/ANDROID-MK.html

Android.mk file syntax specification Introduction: ------------- This document describes the synta...
  • liuxiIT
  • liuxiIT
  • 2012年06月21日 17:16
  • 1312

Android.mk语法说明(android ndk开发)

下面是我个人对android-ndk-r4版本中Android.mk文件做的翻译,由于自己英语水平和专业知识的限制,有些地方可能翻译的不是很准确,敬请指正,本文仅希望对做android NDK开发的同...
  • ygc87
  • ygc87
  • 2011年08月22日 10:50
  • 3976

NDK 基础开发实例(Android.mk环境配置下)

在我写这篇文章的时候,Android Studio已经是2.3版本了,已经集成CMake 编译工具, 用户只需在 新建项目的时候,添加选项(Include C++ support),Android ...

NDK开发之Android.mk文件初探

Android.mk是一个向Android NDK 构建系统描述NDK 项目的GUN Makefile片段.

Android.mk文件语法规范

序言:-------------此文档旨在描述Android.mk文件的语法,Android.mk文件为Android NDK(原生开发)描述了你C/C++源文件。为了明白下面的内容,你必须已经阅读了...

Android.mk文件语法规范

http://zensheno.blog.51cto.com/2712776/501371 概述: Android.mk编译文件是用来向Android NDK描述你的C,C++源代码文...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Android-NDK开发之基础--Android.mk文件语法规范(转JavaEye)
举报原因:
原因补充:

(最多只允许输入30个字)