aboutsummaryrefslogtreecommitdiff
path: root/cmake/GetGitRevisionDescription.cmake
blob: 5044c682e458043b98feb90c143fc677bbbaac6a (plain) (blame)
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
# https://github.com/rpavlik/cmake-modules
#
# - Returns a version string from Git
#
# These functions force a re-configure on each git commit so that you can
# trust the values of the variables in your build system.
#
#  get_git_head_revision(<refspecvar> <hashvar> [<additional arguments to git describe> ...])
#
# Returns the refspec and sha hash of the current head revision
#
#  git_describe(<var> [<additional arguments to git describe> ...])
#
# Returns the results of git describe on the source tree, and adjusting
# the output so that it tests false if an error occurs.
#
#  git_get_exact_tag(<var> [<additional arguments to git describe> ...])
#
# Returns the results of git describe --exact-match on the source tree,
# and adjusting the output so that it tests false if there was no exact
# matching tag.
#
# Requires CMake 2.6 or newer (uses the 'function' command)
#
# Original Author:
# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
# http://academic.cleardefinition.com
# Iowa State University HCI Graduate Program/VRAC
#
# Copyright Iowa State University 2009-2010.
# Distributed under the Boost Software License, Version 1.0.
# (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)

if(__get_git_revision_description)
  return()
endif()
set(__get_git_revision_description YES)

# We must run the following at "include" time, not at function call time,
# to find the path to this module rather than the path to a calling list file
get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)

function(get_git_dir _gitdir)
  # check FORCED_GIT_DIR first
  if(FORCED_GIT_DIR)
    set(${_gitdir} ${FORCED_GIT_DIR} PARENT_SCOPE)
    return()
  endif()

  # check GIT_DIR in environment
  set(GIT_DIR $ENV{GIT_DIR})
  if(NOT GIT_DIR)
    set(GIT_PARENT_DIR ${CMAKE_CURRENT_SOURCE_DIR})
    set(GIT_DIR ${GIT_PARENT_DIR}/.git)
  endif()
  # .git dir not found, search parent directories
  while(NOT EXISTS ${GIT_DIR})
    set(GIT_PREVIOUS_PARENT ${GIT_PARENT_DIR})
    get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH)
    if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT)
      return()
    endif()
    set(GIT_DIR ${GIT_PARENT_DIR}/.git)
  endwhile()
  # check if this is a submodule
  if(NOT IS_DIRECTORY ${GIT_DIR})
    file(READ ${GIT_DIR} submodule)
    string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule})
    get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
    get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE)
  endif()
  set(${_gitdir} ${GIT_DIR} PARENT_SCOPE)
endfunction()

function(get_git_head_revision _refspecvar _hashvar)
  get_git_dir(GIT_DIR)
  if(NOT GIT_DIR)
    return()
  endif()

  set(GIT_DATA ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data)
  if(NOT EXISTS ${GIT_DATA})
    file(MAKE_DIRECTORY ${GIT_DATA})
  endif()

  if(NOT EXISTS ${GIT_DIR}/HEAD)
    return()
  endif()
  set(HEAD_FILE ${GIT_DATA}/HEAD)
  configure_file(${GIT_DIR}/HEAD ${HEAD_FILE} COPYONLY)

  configure_file(${_gitdescmoddir}/GetGitRevisionDescription.cmake.in
    ${GIT_DATA}/grabRef.cmake
    @ONLY)
  include(${GIT_DATA}/grabRef.cmake)

  set(${_refspecvar} ${HEAD_REF} PARENT_SCOPE)
  set(${_hashvar} ${HEAD_HASH} PARENT_SCOPE)
endfunction()

function(git_describe _var)
  get_git_dir(GIT_DIR)
  if(NOT GIT_DIR)
    return()
  endif()

  if(NOT GIT_FOUND)
    find_package(Git QUIET)
  endif()
  if(NOT GIT_FOUND)
    set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
    return()
  endif()

  get_git_head_revision(refspec hash)
  if(NOT hash)
    set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
    return()
  endif()

  execute_process(COMMAND
    ${GIT_EXECUTABLE}
    describe
    ${hash}
    ${ARGN}
    WORKING_DIRECTORY
    ${GIT_DIR}
    RESULT_VARIABLE
    res
    OUTPUT_VARIABLE
    out
    ERROR_QUIET
    OUTPUT_STRIP_TRAILING_WHITESPACE)
  if(NOT res EQUAL 0)
    set(out "${out}-${res}-NOTFOUND")
  endif()

  set(${_var} ${out} PARENT_SCOPE)
endfunction()

function(git_timestamp _var)
  get_git_dir(GIT_DIR)
  if(NOT GIT_DIR)
    return()
  endif()

  if(NOT GIT_FOUND)
    find_package(Git QUIET)
  endif()
  if(NOT GIT_FOUND)
    return()
  endif()

  get_git_head_revision(refspec hash)
  if(NOT hash)
    set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
    return()
  endif()

  execute_process(COMMAND ${GIT_EXECUTABLE} log -1 --format="%ci" ${hash} ${ARGN}
    WORKING_DIRECTORY ${GIT_DIR}
    RESULT_VARIABLE res
    OUTPUT_VARIABLE out
    ERROR_QUIET
    OUTPUT_STRIP_TRAILING_WHITESPACE)
  if(res EQUAL 0)
    string(REGEX REPLACE "[-\" :]" "" out ${out})
    string(SUBSTRING ${out} 0 12 out)
  else()
    set(out "${out}-${res}-NOTFOUND")
  endif()

  set(${_var} ${out} PARENT_SCOPE)
endfunction()

function(git_get_exact_tag _var)
  git_describe(out --exact-match ${ARGN})
  set(${_var} ${out} PARENT_SCOPE)
endfunction()