summaryrefslogtreecommitdiffhomepage
path: root/cmake/GetGitRevisionDescription.cmake
blob: e4ac79c0886808ccfbdcf9e7607e2b52d5c658b1 (plain)
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
# - 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_head_revision _refspecvar _hashvar)
        set(GIT_PARENT_DIR "${CMAKE_SOURCE_DIR}")
        set(GIT_DIR "${GIT_PARENT_DIR}/.git")
        while(NOT EXISTS "${GIT_DIR}")  # .git dir not found, search parent directories
                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)
                        # We have reached the root directory, we are not in git
                        set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
                        set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
                        return()
                endif()
                set(GIT_DIR "${GIT_PARENT_DIR}/.git")
        endwhile()
        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)
        if(NOT GIT_FOUND)
                find_package(Git QUIET)
        endif()
        #get_git_head_revision(refspec hash)
        if(NOT GIT_FOUND)
                set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
                return()
        endif()
        #if(NOT hash)
        #        set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
        #        return()
        #endif()

        # TODO sanitize
        #if((${ARGN}" MATCHES "&&") OR
        #       (ARGN MATCHES "||") OR
        #       (ARGN MATCHES "\\;"))
        #       message("Please report the following error to the project!")
        #       message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
        #endif()

        #message(STATUS "Arguments to execute_process: ${ARGN}")

        execute_process(COMMAND
                "${GIT_EXECUTABLE}"
                describe
                ${ARGN}
                WORKING_DIRECTORY
                "${CMAKE_SOURCE_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_get_exact_tag _var)
        git_describe(out ${ARGN})
        set(${_var} "${out}" PARENT_SCOPE)
endfunction()