GetGitRevisionDescription.cmake 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. # - Returns a version string from Git
  2. #
  3. # These functions force a re-configure on each git commit so that you can
  4. # trust the values of the variables in your build system.
  5. #
  6. # get_git_head_revision(<refspecvar> <hashvar> [<additional arguments to git describe> ...])
  7. #
  8. # Returns the refspec and sha hash of the current head revision
  9. #
  10. # git_describe(<var> [<additional arguments to git describe> ...])
  11. #
  12. # Returns the results of git describe on the source tree, and adjusting
  13. # the output so that it tests false if an error occurs.
  14. #
  15. # git_get_exact_tag(<var> [<additional arguments to git describe> ...])
  16. #
  17. # Returns the results of git describe --exact-match on the source tree,
  18. # and adjusting the output so that it tests false if there was no exact
  19. # matching tag.
  20. #
  21. # Requires CMake 2.6 or newer (uses the 'function' command)
  22. #
  23. # Original Author:
  24. # 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
  25. # http://academic.cleardefinition.com
  26. # Iowa State University HCI Graduate Program/VRAC
  27. #
  28. # Copyright Iowa State University 2009-2010.
  29. # Distributed under the Boost Software License, Version 1.0.
  30. # (See accompanying file LICENSE_1_0.txt or copy at
  31. # http://www.boost.org/LICENSE_1_0.txt)
  32. if(__get_git_revision_description)
  33. return()
  34. endif()
  35. set(__get_git_revision_description YES)
  36. # We must run the following at "include" time, not at function call time,
  37. # to find the path to this module rather than the path to a calling list file
  38. get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
  39. function(get_git_head_revision _refspecvar _hashvar)
  40. set(GIT_PARENT_DIR "${CMAKE_SOURCE_DIR}")
  41. set(GIT_DIR "${GIT_PARENT_DIR}/.git")
  42. while(NOT EXISTS "${GIT_DIR}") # .git dir not found, search parent directories
  43. set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}")
  44. get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH)
  45. if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT)
  46. # We have reached the root directory, we are not in git
  47. set(${_refspecvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
  48. set(${_hashvar} "GITDIR-NOTFOUND" PARENT_SCOPE)
  49. return()
  50. endif()
  51. set(GIT_DIR "${GIT_PARENT_DIR}/.git")
  52. endwhile()
  53. set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
  54. if(NOT EXISTS "${GIT_DATA}")
  55. file(MAKE_DIRECTORY "${GIT_DATA}")
  56. endif()
  57. if(NOT EXISTS "${GIT_DIR}/HEAD")
  58. return()
  59. endif()
  60. set(HEAD_FILE "${GIT_DATA}/HEAD")
  61. configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY)
  62. configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
  63. "${GIT_DATA}/grabRef.cmake"
  64. @ONLY)
  65. include("${GIT_DATA}/grabRef.cmake")
  66. set(${_refspecvar} "${HEAD_REF}" PARENT_SCOPE)
  67. set(${_hashvar} "${HEAD_HASH}" PARENT_SCOPE)
  68. endfunction()
  69. function(git_describe _var)
  70. if(NOT GIT_FOUND)
  71. find_package(Git QUIET)
  72. endif()
  73. get_git_head_revision(refspec hash)
  74. if(NOT GIT_FOUND)
  75. set(${_var} "GIT-NOTFOUND" PARENT_SCOPE)
  76. return()
  77. endif()
  78. if(NOT hash)
  79. set(${_var} "HEAD-HASH-NOTFOUND" PARENT_SCOPE)
  80. return()
  81. endif()
  82. # TODO sanitize
  83. #if((${ARGN}" MATCHES "&&") OR
  84. # (ARGN MATCHES "||") OR
  85. # (ARGN MATCHES "\\;"))
  86. # message("Please report the following error to the project!")
  87. # message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
  88. #endif()
  89. #message(STATUS "Arguments to execute_process: ${ARGN}")
  90. execute_process(COMMAND
  91. "${GIT_EXECUTABLE}"
  92. describe
  93. ${hash}
  94. ${ARGN}
  95. WORKING_DIRECTORY
  96. "${CMAKE_SOURCE_DIR}"
  97. RESULT_VARIABLE
  98. res
  99. OUTPUT_VARIABLE
  100. out
  101. ERROR_QUIET
  102. OUTPUT_STRIP_TRAILING_WHITESPACE)
  103. if(NOT res EQUAL 0)
  104. set(out "${out}-${res}-NOTFOUND")
  105. endif()
  106. set(${_var} "${out}" PARENT_SCOPE)
  107. endfunction()
  108. function(git_get_exact_tag _var)
  109. git_describe(out --exact-match ${ARGN})
  110. set(${_var} "${out}" PARENT_SCOPE)
  111. endfunction()