1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2014 Alexis Laferrière <alexis.laf@xymus.net>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Annotations to gather metadata on Android projects. Get the metadata
18 # by calling `ModelBuilder::android_project_for`.
19 module android_annotations
23 import modelize_property
26 private import annotation
28 # Metadata associated to an Android project
30 # Name of the resulting application
31 var name
: nullable String = null
33 # Java package used to identify the APK
34 var java_package
: nullable String = null
36 # Version of the Android application and APK
37 var version
: nullable String = null
39 # Numerical version code of the Android application and APK
40 var version_code
: Int = 0
42 # Custom lines to add to the AndroidManifest.xml in the <manifest> node
43 var manifest_lines
= new Array[String]
45 # Custom lines to add to the AndroidManifest.xml in the <application> node
46 var manifest_application_lines
= new Array[String]
48 # Minimum API level required for the application to run
49 var min_api
: nullable Int = null
51 # Build target API level
52 var target_api
: nullable Int = null
54 # Maximum API level on which the application will be allowed to run
55 var max_api
: nullable Int = null
57 redef fun to_s
do return """
58 name: {{{name or else "null"}}}
59 namespace: {{{java_package or else "null"}}}
60 version: {{{version or else "null"}}}"""
63 redef class ModelBuilder
64 # Get the `AndroidProject` gathered from `mmodule` and its importations
65 fun android_project_for
(mmodule
: MModule): AndroidProject
67 var project
= new AndroidProject
69 var annot
= priority_annotation_on_modules
("app_name", mmodule
)
70 if annot
!= null then project
.name
= annot
.arg_as_string
(self)
72 annot
= priority_annotation_on_modules
("app_version", mmodule
)
73 if annot
!= null then project
.version
= annot
.as_version
(self)
75 annot
= priority_annotation_on_modules
("java_package", mmodule
)
76 if annot
!= null then project
.java_package
= annot
.arg_as_string
(self)
78 var annots
= collect_annotations_on_modules
("min_api_version", mmodule
)
79 for an
in annots
do project
.min_api
= an
.arg_as_int
(self)
81 annots
= collect_annotations_on_modules
("max_api_version", mmodule
)
82 for an
in annots
do project
.max_api
= an
.arg_as_int
(self)
84 annots
= collect_annotations_on_modules
("target_api_version", mmodule
)
85 for an
in annots
do project
.target_api
= an
.arg_as_int
(self)
87 annots
= collect_annotations_on_modules
("android_manifest", mmodule
)
88 for an
in annots
do project
.manifest_lines
.add an
.arg_as_string
(self) or else ""
90 annots
= collect_annotations_on_modules
("android_manifest_application", mmodule
)
91 for an
in annots
do project
.manifest_application_lines
.add an
.arg_as_string
(self) or else ""
93 # Get the date and time (down to the minute) as string
94 var local_time
= new Tm.localtime
95 var local_time_s
= local_time
.strftime
("%y%m%d%H%M")
96 project
.version_code
= local_time_s
.to_i
98 toolcontext
.check_errors
103 # Recursively collect all annotations by name in `mmodule` and its importations (direct and indirect)
104 private fun collect_annotations_on_modules
(name
: String, mmodule
: MModule): Array[AAnnotation]
106 var annotations
= new Array[AAnnotation]
107 for mmod
in mmodule
.in_importation
.greaters
do
108 if not mmodule2nmodule
.keys
.has
(mmod
) then continue
109 var amod
= mmodule2nmodule
[mmod
]
110 var module_decl
= amod
.n_moduledecl
111 if module_decl
== null then continue
112 var aas
= module_decl
.collect_annotations_by_name
(name
)
113 annotations
.add_all aas
118 # Get an annotation by name from `mmodule` and its super modules. Will recursively search
119 # in imported module to find the "latest" declaration and detects priority conflicts.
120 private fun priority_annotation_on_modules
(name
: String, mmodule
: MModule): nullable AAnnotation
122 if mmodule2nmodule
.keys
.has
(mmodule
) then
123 var amod
= mmodule2nmodule
[mmodule
]
124 var module_decl
= amod
.n_moduledecl
125 if module_decl
!= null then
126 var annotations
= module_decl
.collect_annotations_by_name
(name
)
127 if annotations
.length
== 1 then
128 return annotations
.first
129 else if annotations
.length
> 1 then
130 toolcontext
.error
(mmodule
.location
,
131 "Multiple declaration of annotation {name}, it must be defined only once.")
136 var sources
= new Array[MModule]
137 var annotations
= null
138 for mmod
in mmodule
.in_importation
.direct_greaters
do
139 var res
= priority_annotation_on_modules
(name
, mmod
)
145 if sources
.length
> 1 then
146 toolcontext
.error
(mmodule
.location
,
147 "Priority conflict on annotation {name}, it has been defined in: {sources.join(", ")}")
154 redef class AAnnotation
155 # Returns a version string (example: "1.5.6b42a7c") from an annotation `version(1, 5, git_revision)`.
157 # The user can enter as many fields as needed. The call to `git_revision` will be replaced by the short
158 # revision number. If the working tree is dirty, it will append another field with "d" for dirty.
159 private fun as_version
(modelbuilder
: ModelBuilder): String
161 var annotation_name
= n_atid
.n_id
.text
162 var version_fields
= new Array[Object]
166 if args
.length
< 1 then
167 modelbuilder
.error
(self, "Annotation error: \"{name}\
" expects at least a single argument.")
171 var format_error
= "Annotation error: \"{name}\
" expects its arguments to be of type Int or a call to `git_revision`"
175 if value
!= null then
176 version_fields
.add value
180 value
= arg
.as_string
181 if value
!= null then
182 version_fields
.add value
186 if value
== "git_revision" then
187 # Get Git short revision
188 var proc
= new IProcess("git", "rev-parse", "--short", "HEAD")
190 assert proc
.status
== 0
191 var lines
= proc
.read_all
192 var revision
= lines
.split
("\n").first
195 # If not, the return of `git diff --shortstat` is an empty line
196 proc
= new IProcess("git", "diff-index", "--quiet", "HEAD")
198 var dirty
= proc
.status
!= 0
199 if dirty
then revision
+= ".d"
201 version_fields
.add revision
205 modelbuilder
.error
(self, format_error
)
210 return version_fields
.join
(".")