File: UtilGit.cmake

package info (click to toggle)
spring 104.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 47,512 kB
  • sloc: cpp: 391,093; ansic: 79,943; python: 12,356; java: 12,201; awk: 5,889; sh: 1,826; xml: 655; makefile: 486; perl: 405; php: 211; objc: 194; sed: 2
file content (214 lines) | stat: -rw-r--r-- 8,439 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# This file is part of the Spring engine (GPL v2 or later), see LICENSE.html


#
# Git related CMake utilities
# ---------------------------
#
# Functions and macros defined in this file:
# * Git_Util_Command         - Executes a git command plus arguments.
# * Git_Util_Hash            - Fetches the revision SHA1 hash of the current HEAD.
# * Git_Util_Branch          - Fetches the branch name of the current HEAD.
# * Git_Util_Describe        - Fetches the output of git-describe of the current HEAD.
# * Git_Info                 - Retrieves a lot of info about the HEAD of a repository
#

Set(Git_FIND_QUIETLY TRUE)
Find_Package(Git)

If    (GIT_FOUND)

	# Executes a git command plus arguments.
	Macro    (Git_Util_Command var dir command)
		Set(${var})
		Set(${var}-NOTFOUND)
		Set(CMD_GIT ${GIT_EXECUTABLE} ${command} ${ARGN})
		Execute_Process(
				COMMAND ${CMD_GIT}
				WORKING_DIRECTORY ${dir}
				RESULT_VARIABLE CMD_RET_VAL
				OUTPUT_VARIABLE ${var}
				ERROR_VARIABLE  GIT_ERROR
				OUTPUT_STRIP_TRAILING_WHITESPACE
				ERROR_STRIP_TRAILING_WHITESPACE
			)

		If    (NOT ${CMD_RET_VAL} EQUAL 0)
			Set(${var})
			Set(${var}-NOTFOUND "1")
			If    (NOT GIT_UTIL_FIND_QUIETLY)
				Message(STATUS "Command \"${CMD_GIT}\" in directory ${dir} failed with output:\n\"${GIT_ERROR}\"")
			EndIf (NOT GIT_UTIL_FIND_QUIETLY)
		EndIf (NOT ${CMD_RET_VAL} EQUAL 0)
	EndMacro (Git_Util_Command)




	# Fetches the revision SHA1 hash of the current HEAD.
	# This command may fail if dir is not a git repo.
	Macro    (Git_Util_Hash var dir)
		Git_Util_Command(${var} "${dir}" rev-list -n 1 ${ARGN} HEAD)
	EndMacro (Git_Util_Hash)




	# Fetches the branch name of the current HEAD.
	# This command may fail if dir is not a git repo.
	# In case dir has a detached HEAD, var will be set to "HEAD",
	# else it will be set to the branch name, eg. "master" or "develop".
	Macro    (Git_Util_Branch var dir)
		Git_Util_Command(${var} "${dir}" rev-parse --abbrev-ref ${ARGN} HEAD)
	EndMacro (Git_Util_Branch)




	# Fetches the output of git-describe of the current HEAD.
	# This command may fail if dir is not a git repo.
	# Only tags matching the given pattern (shell glob, see manual for git-tag)
	# may be used.
	# Example tag patterns: all tags:"*", spring-version-tags:"*.*.*"
	Macro    (Git_Util_Describe var dir tagPattern)
		Git_Util_Command(${var} "${dir}" describe --tags --candidates 999 --match "${tagPattern}" ${ARGN})
	EndMacro (Git_Util_Describe)





	# Sets the following vars:
	# * ${prefix}_GIT_REVISION_HASH     : `git rev-list -n 1 HEAD`
	#                                     -> 2d6bd9cb5a9ceb9c728dd34a1ab2925d4b0759e0
	# * ${prefix}_GIT_REVISION_NAME     : `git name-rev --name-only --tags --no-undefined --always 2d6bd9cb5a9ceb9c728dd34a1ab2925d4b0759e0`
	#                                     -> 2d6bd9c              # no related tag found (SHA1 starts with 2d6bd9c)
	#                                     -> 0.82.3^0             # exactly 0.82.3
	#                                     -> 0.82.3~2             # 2 commits before 0.82.3
	# * ${prefix}_GIT_DESCRIBE          : `git describe --tags`
	#                                     -> 0.82.3-1776-g2d6bd9c # 1776 commits after 0.82.3 (SHA1 starts with 2d6bd9c)
	#                                     -> 0.82.3               # exactly 0.82.3
	# * ${prefix}_GIT_BRANCH            : `git rev-parse --abbrev-ref HEAD`
	#                                     -> HEAD   # in case we are not on any branch (detached HEAD)
	#                                     -> master # the current branchs name
	# - ${prefix}_GIT_FILES_MODIFIED    : number of uncommitted modified files
	# - ${prefix}_GIT_FILES_ADDED       : number of uncommitted added files
	# - ${prefix}_GIT_FILES_DELETED     : number of uncommitted deleted files
	# - ${prefix}_GIT_FILES_UNVERSIONED : number of uncommitted unversioned files
	# - ${prefix}_GIT_FILES_CLEAN       : TRUE if there are no uncommitted modified files
	# - ${prefix}_GIT_FILES_CLEAN_VERY  : TRUE if there are no uncommitted modified, added, deleted or unversioned files
	Macro    (Git_Info dir prefix)

		# Fetch ${prefix}_GIT_REVISION_HASH
		Git_Util_Hash(${prefix}_GIT_REVISION_HASH "${dir}")


		# Fetch ${prefix}_GIT_REVISION_NAME
		Set(${prefix}_GIT_REVISION_NAME)
		Set(${prefix}_GIT_REVISION_NAME-NOTFOUND)
		If    (${prefix}_GIT_REVISION_HASH)
			Git_Util_Command(${prefix}_GIT_REVISION_NAME "${dir}"
					name-rev --name-only --tags --no-undefined --always ${${prefix}_GIT_REVISION_HASH})
		EndIf (${prefix}_GIT_REVISION_HASH)


		# Fetch ${prefix}_GIT_DESCRIBE
		Git_Util_Describe(${prefix}_GIT_DESCRIBE "${dir}" "*")


		# Fetch ${prefix}_GIT_BRANCH
		Git_Util_Branch(${prefix}_GIT_BRANCH "${dir}")


		# Fetch ${prefix}_GIT_FILES_MODIFIED
		# Fetch ${prefix}_GIT_FILES_ADDED
		# Fetch ${prefix}_GIT_FILES_DELETED
		# Fetch ${prefix}_GIT_FILES_UNVERSIONED
		# Fetch ${prefix}_GIT_FILES_CLEAN
		# Fetch ${prefix}_GIT_FILES_CLEAN_VERY
		Set(${prefix}_GIT_FILES_MODIFIED)
		Set(${prefix}_GIT_FILES_MODIFIED-NOTFOUND)
		Set(${prefix}_GIT_FILES_ADDED)
		Set(${prefix}_GIT_FILES_ADDED-NOTFOUND)
		Set(${prefix}_GIT_FILES_DELETED)
		Set(${prefix}_GIT_FILES_DELETED-NOTFOUND)
		Set(${prefix}_GIT_FILES_UNVERSIONED)
		Set(${prefix}_GIT_FILES_UNVERSIONED-NOTFOUND)
		Set(${prefix}_GIT_FILES_CLEAN)
		Set(${prefix}_GIT_FILES_CLEAN-NOTFOUND)
		Set(${prefix}_GIT_FILES_CLEAN_VERY)
		Set(${prefix}_GIT_FILES_CLEAN_VERY-NOTFOUND)

		Git_Util_Command(${prefix}_GIT_STATUS_OUT "${dir}" status --porcelain)

		If    (${prefix}_GIT_STATUS_OUT)
			# convert the raw command output to a list like:
			# "M;M;M;M;M;A;D;D;??;??;??"
			String(REGEX REPLACE
					"^[ \t]*([^ \t]+)[ \t]*[^\n\r]+[\n\r]?" "\\1;"
					${prefix}_GIT_STATUS_OUT_LIST_NO_PATHS
					"${${prefix}_GIT_STATUS_OUT}")

			# count ammounts of all modification types in the list
			Set(${prefix}_GIT_FILES_MODIFIED    0)
			Set(${prefix}_GIT_FILES_ADDED       0)
			Set(${prefix}_GIT_FILES_DELETED     0)
			Set(${prefix}_GIT_FILES_UNVERSIONED 0)
			ForEach    (type ${${prefix}_GIT_STATUS_OUT_LIST_NO_PATHS})
				If     ("${type}" STREQUAL "M")
					Math(EXPR ${prefix}_GIT_FILES_MODIFIED    "${${prefix}_GIT_FILES_MODIFIED}    + 1")
				ElseIf ("${type}" STREQUAL "A")
					Math(EXPR ${prefix}_GIT_FILES_ADDED       "${${prefix}_GIT_FILES_ADDED}       + 1")
				ElseIf ("${type}" STREQUAL "D")
					Math(EXPR ${prefix}_GIT_FILES_DELETED     "${${prefix}_GIT_FILES_DELETED}     + 1")
				ElseIf ("${type}" STREQUAL "??")
					Math(EXPR ${prefix}_GIT_FILES_UNVERSIONED "${${prefix}_GIT_FILES_UNVERSIONED} + 1")
				EndIf  ()
			EndForEach (type)
			Math(EXPR ${prefix}_GIT_FILES_CHANGES
					"${${prefix}_GIT_FILES_MODIFIED} + ${${prefix}_GIT_FILES_ADDED} + ${${prefix}_GIT_FILES_DELETED} + ${${prefix}_GIT_FILES_UNVERSIONED}")

			If    (${${prefix}_GIT_FILES_MODIFIED} EQUAL 0)
				Set(${prefix}_GIT_FILES_CLEAN TRUE)
			Else  ()
				Set(${prefix}_GIT_FILES_CLEAN FALSE)
			EndIf ()
			If    (${${prefix}_GIT_FILES_CHANGES} EQUAL 0)
				Set(${prefix}_GIT_FILES_CLEAN_VERY TRUE)
			Else  ()
				Set(${prefix}_GIT_FILES_CLEAN_VERY FALSE)
			EndIf ()
		Else  (${prefix}_GIT_STATUS_OUT)
			Set(${prefix}_GIT_FILES_MODIFIED-NOTFOUND    "1")
			Set(${prefix}_GIT_FILES_ADDED-NOTFOUND       "1")
			Set(${prefix}_GIT_FILES_DELETED-NOTFOUND     "1")
			Set(${prefix}_GIT_FILES_UNVERSIONED-NOTFOUND "1")
			Set(${prefix}_GIT_FILES_CLEAN-NOTFOUND       "1")
			Set(${prefix}_GIT_FILES_CLEAN_VERY-NOTFOUND  "1")
		EndIf (${prefix}_GIT_STATUS_OUT)
	EndMacro (Git_Info)





	# Prints extensive git version info.
	# @see Git_Info
	Macro    (Git_Print_Info dir)
		Set(prefix Git_Print_Info_tmp_prefix_)
		Git_Info(${dir} ${prefix})
		Message("  SHA1              : ${${prefix}_GIT_REVISION_HASH}")
		Message("  revision-name     : ${${prefix}_GIT_REVISION_NAME}")
		Message("  describe          : ${${prefix}_GIT_DESCRIBE}")
		Message("  branch            : ${${prefix}_GIT_BRANCH}")
		Message("  local file stats")
		Message("    modified:       : ${${prefix}_GIT_FILES_MODIFIED}")
		Message("    added:          : ${${prefix}_GIT_FILES_ADDED}")
		Message("    deleted:        : ${${prefix}_GIT_FILES_DELETED}")
		Message("    unversioned:    : ${${prefix}_GIT_FILES_UNVERSIONED}")
		Message("  repository state")
		Message("    clean           : ${${prefix}_GIT_FILES_CLEAN}")
		Message("    very clean      : ${${prefix}_GIT_FILES_CLEAN_VERY}")
	EndMacro (Git_Print_Info)
EndIf (GIT_FOUND)