1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Annotations to gather metadata on `app.nit` projects
16 module app_annotations
18 private import parser_util
22 private import annotation
24 # Metadata associated to an `app.nit` project
26 # Pretty name of the resulting application
27 var name
: String = mainmodule
.first_real_mmodule
.name
is lazy
29 # Short project name used in `namespace` and configuration files
30 var short_name
: String = mainmodule
.name
.replace
("-", "_") is lazy
32 # Namespace/package used to identify the application
33 var namespace
= "org.nitlanguage.{short_name}" is lazy
35 # Version of the application
38 # Numerical version code of the application
39 var version_code
: Int is lazy
do
41 # Get the date and time (down to the minute) as string
42 var gmtime
= new Tm.gmtime
43 var local_time_s
= gmtime
.strftime
("%y%m%d%H%M")
44 return local_time_s
.to_i
47 # Extra folders where to find platform specific resource files
48 var files
= new Array[String]
50 private var modelbuilder
: ModelBuilder
51 private var mainmodule
: MModule
55 var annot
= modelbuilder
.lookup_annotation_on_modules
("app_name", mainmodule
)
57 var val
= annot
.arg_as_string
(modelbuilder
)
58 if val
!= null then name
= val
61 annot
= modelbuilder
.lookup_annotation_on_modules
("app_version", mainmodule
)
62 if annot
!= null then version
= annot
.as_version
(modelbuilder
)
64 annot
= modelbuilder
.lookup_annotation_on_modules
("app_namespace", mainmodule
)
66 var val
= annot
.arg_as_string
(modelbuilder
)
67 if val
!= null then namespace
= val
70 var annots
= modelbuilder
.collect_annotations_on_modules
("app_files", mainmodule
)
71 for a
in annots
do files
.add_all a
.as_relative_paths
(modelbuilder
)
73 modelbuilder
.toolcontext
.check_errors
76 redef fun to_s
do return """
78 namespace: {{{namespace}}}
79 version: {{{version}}}"""
82 redef class AAnnotation
83 # Returns a version string (example: "1.5.6b42a7c") from an annotation `version(1, 5, git_revision)`.
85 # The user can enter as many fields as needed. The call to `git_revision` will be replaced by the short
86 # revision number. If the working tree is dirty, it will append another field with "d" for dirty.
87 private fun as_version
(modelbuilder
: ModelBuilder): String
89 var version_fields
= new Array[Object]
92 if args
.length
< 1 then
93 modelbuilder
.error
(self, "Syntax Error: `{name}` expects at least one argument.")
100 version_fields
.add value
104 value
= arg
.as_string
105 if value
!= null then
106 version_fields
.add value
110 if value
== "git_revision" then
111 # Get Git short revision
112 var proc
= new ProcessReader("git", "rev-parse", "--short", "HEAD")
114 if proc
.status
!= 0 then
115 # Fallback if this is not a git repository or git bins are missing
116 version_fields
.add
"0"
117 modelbuilder
.warning
(self, "git_revision", "Warning: `git_revision` used outside of a git repository or git binaries not available")
121 var lines
= proc
.read_all
122 var revision
= lines
.split
("\n").first
125 # If not, the return of `git diff --shortstat` is an empty line
126 proc
= new ProcessReader("git", "diff-index", "--quiet", "HEAD")
128 var dirty
= proc
.status
!= 0
129 if dirty
then revision
+= ".d"
131 version_fields
.add revision
135 var format_error
= "Syntax Error: `{name}` expects its arguments to be of type Int or a call to `git_revision`."
136 modelbuilder
.error
(self, format_error
)
141 return version_fields
.join
(".")
144 # Parse all arguments as paths relative to the declaring module
146 # If no arguments are given, then use the parent directory of the module.
147 private fun as_relative_paths
(modelbuilder
: ModelBuilder): Array[String]
149 var paths
= new Array[String]
151 var file
= location
.file
152 if file
== null then return paths
155 if args
.is_empty
then
156 paths
.add file
.filename
.dirname
159 var val
= arg
.as_string
161 paths
.add file
.filename
.dirname
/val
162 else modelbuilder
.error
(arg
, "Syntax Error: `app_files` expects String literals as arguments.")