FindRuby.cmake 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file Copyright.txt or https://cmake.org/licensing for details.
  3. #.rst:
  4. # FindRuby
  5. # --------
  6. #
  7. # Find Ruby
  8. #
  9. # This module finds if Ruby is installed and determines where the
  10. # include files and libraries are. Ruby 1.8, 1.9, 2.0 and 2.1 are
  11. # supported.
  12. #
  13. # The minimum required version of Ruby can be specified using the
  14. # standard syntax, e.g. find_package(Ruby 1.8)
  15. #
  16. # It also determines what the name of the library is. This code sets
  17. # the following variables:
  18. #
  19. # ``RUBY_EXECUTABLE``
  20. # full path to the ruby binary
  21. # ``RUBY_INCLUDE_DIRS``
  22. # include dirs to be used when using the ruby library
  23. # ``RUBY_LIBRARY``
  24. # full path to the ruby library
  25. # ``RUBY_VERSION``
  26. # the version of ruby which was found, e.g. "1.8.7"
  27. # ``RUBY_FOUND``
  28. # set to true if ruby ws found successfully
  29. #
  30. # Also:
  31. #
  32. # ``RUBY_INCLUDE_PATH``
  33. # same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it
  34. # RUBY_ARCHDIR=`$RUBY -r rbconfig -e 'printf("%s",Config::CONFIG@<:@"archdir"@:>@)'`
  35. # RUBY_SITEARCHDIR=`$RUBY -r rbconfig -e 'printf("%s",Config::CONFIG@<:@"sitearchdir"@:>@)'`
  36. # RUBY_SITEDIR=`$RUBY -r rbconfig -e 'printf("%s",Config::CONFIG@<:@"sitelibdir"@:>@)'`
  37. # RUBY_LIBDIR=`$RUBY -r rbconfig -e 'printf("%s",Config::CONFIG@<:@"libdir"@:>@)'`
  38. # RUBY_LIBRUBYARG=`$RUBY -r rbconfig -e 'printf("%s",Config::CONFIG@<:@"LIBRUBYARG_SHARED"@:>@)'`
  39. # uncomment the following line to get debug output for this file
  40. # set(_RUBY_DEBUG_OUTPUT TRUE)
  41. # Determine the list of possible names of the ruby executable depending
  42. # on which version of ruby is required
  43. set(_RUBY_POSSIBLE_EXECUTABLE_NAMES ruby)
  44. # if 1.9 is required, don't look for ruby18 and ruby1.8, default to version 1.8
  45. if(DEFINED Ruby_FIND_VERSION_MAJOR AND DEFINED Ruby_FIND_VERSION_MINOR)
  46. set(Ruby_FIND_VERSION_SHORT_NODOT "${Ruby_FIND_VERSION_MAJOR}${RUBY_FIND_VERSION_MINOR}")
  47. # we can't construct that if only major version is given
  48. set(_RUBY_POSSIBLE_EXECUTABLE_NAMES
  49. ruby${Ruby_FIND_VERSION_MAJOR}.${Ruby_FIND_VERSION_MINOR}
  50. ruby${Ruby_FIND_VERSION_MAJOR}${Ruby_FIND_VERSION_MINOR}
  51. ${_RUBY_POSSIBLE_EXECUTABLE_NAMES})
  52. else()
  53. set(Ruby_FIND_VERSION_SHORT_NODOT "18")
  54. endif()
  55. if(NOT Ruby_FIND_VERSION_EXACT)
  56. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby2.4 ruby24)
  57. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby2.3 ruby23)
  58. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby2.2 ruby22)
  59. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby2.1 ruby21)
  60. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby2.0 ruby20)
  61. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby1.9 ruby19)
  62. # if we want a version below 1.9, also look for ruby 1.8
  63. if("${Ruby_FIND_VERSION_SHORT_NODOT}" VERSION_LESS "19")
  64. list(APPEND _RUBY_POSSIBLE_EXECUTABLE_NAMES ruby1.8 ruby18)
  65. endif()
  66. list(REMOVE_DUPLICATES _RUBY_POSSIBLE_EXECUTABLE_NAMES)
  67. endif()
  68. find_program(RUBY_EXECUTABLE NAMES ${_RUBY_POSSIBLE_EXECUTABLE_NAMES})
  69. if(RUBY_EXECUTABLE AND NOT RUBY_VERSION_MAJOR)
  70. function(_RUBY_CONFIG_VAR RBVAR OUTVAR)
  71. execute_process(COMMAND ${RUBY_EXECUTABLE} -r rbconfig -e "print RbConfig::CONFIG['${RBVAR}']"
  72. RESULT_VARIABLE _RUBY_SUCCESS
  73. OUTPUT_VARIABLE _RUBY_OUTPUT
  74. ERROR_QUIET)
  75. if(_RUBY_SUCCESS OR _RUBY_OUTPUT STREQUAL "")
  76. execute_process(COMMAND ${RUBY_EXECUTABLE} -r rbconfig -e "print Config::CONFIG['${RBVAR}']"
  77. RESULT_VARIABLE _RUBY_SUCCESS
  78. OUTPUT_VARIABLE _RUBY_OUTPUT
  79. ERROR_QUIET)
  80. endif()
  81. set(${OUTVAR} "${_RUBY_OUTPUT}" PARENT_SCOPE)
  82. endfunction()
  83. # query the ruby version
  84. _RUBY_CONFIG_VAR("MAJOR" RUBY_VERSION_MAJOR)
  85. _RUBY_CONFIG_VAR("MINOR" RUBY_VERSION_MINOR)
  86. _RUBY_CONFIG_VAR("TEENY" RUBY_VERSION_PATCH)
  87. # query the different directories
  88. _RUBY_CONFIG_VAR("archdir" RUBY_ARCH_DIR)
  89. _RUBY_CONFIG_VAR("arch" RUBY_ARCH)
  90. _RUBY_CONFIG_VAR("rubyhdrdir" RUBY_HDR_DIR)
  91. _RUBY_CONFIG_VAR("rubyarchhdrdir" RUBY_ARCHHDR_DIR)
  92. _RUBY_CONFIG_VAR("libdir" RUBY_POSSIBLE_LIB_DIR)
  93. _RUBY_CONFIG_VAR("rubylibdir" RUBY_RUBY_LIB_DIR)
  94. # site_ruby
  95. _RUBY_CONFIG_VAR("sitearchdir" RUBY_SITEARCH_DIR)
  96. _RUBY_CONFIG_VAR("sitelibdir" RUBY_SITELIB_DIR)
  97. # vendor_ruby available ?
  98. execute_process(COMMAND ${RUBY_EXECUTABLE} -r vendor-specific -e "print 'true'"
  99. OUTPUT_VARIABLE RUBY_HAS_VENDOR_RUBY ERROR_QUIET)
  100. if(RUBY_HAS_VENDOR_RUBY)
  101. _RUBY_CONFIG_VAR("vendorlibdir" RUBY_VENDORLIB_DIR)
  102. _RUBY_CONFIG_VAR("vendorarchdir" RUBY_VENDORARCH_DIR)
  103. endif()
  104. # save the results in the cache so we don't have to run ruby the next time again
  105. set(RUBY_VERSION_MAJOR ${RUBY_VERSION_MAJOR} CACHE PATH "The Ruby major version" FORCE)
  106. set(RUBY_VERSION_MINOR ${RUBY_VERSION_MINOR} CACHE PATH "The Ruby minor version" FORCE)
  107. set(RUBY_VERSION_PATCH ${RUBY_VERSION_PATCH} CACHE PATH "The Ruby patch version" FORCE)
  108. set(RUBY_ARCH_DIR ${RUBY_ARCH_DIR} CACHE PATH "The Ruby arch dir" FORCE)
  109. set(RUBY_HDR_DIR ${RUBY_HDR_DIR} CACHE PATH "The Ruby header dir (1.9+)" FORCE)
  110. set(RUBY_ARCHHDR_DIR ${RUBY_ARCHHDR_DIR} CACHE PATH "The Ruby arch header dir (2.0+)" FORCE)
  111. set(RUBY_POSSIBLE_LIB_DIR ${RUBY_POSSIBLE_LIB_DIR} CACHE PATH "The Ruby lib dir" FORCE)
  112. set(RUBY_RUBY_LIB_DIR ${RUBY_RUBY_LIB_DIR} CACHE PATH "The Ruby ruby-lib dir" FORCE)
  113. set(RUBY_SITEARCH_DIR ${RUBY_SITEARCH_DIR} CACHE PATH "The Ruby site arch dir" FORCE)
  114. set(RUBY_SITELIB_DIR ${RUBY_SITELIB_DIR} CACHE PATH "The Ruby site lib dir" FORCE)
  115. set(RUBY_HAS_VENDOR_RUBY ${RUBY_HAS_VENDOR_RUBY} CACHE BOOL "Vendor Ruby is available" FORCE)
  116. set(RUBY_VENDORARCH_DIR ${RUBY_VENDORARCH_DIR} CACHE PATH "The Ruby vendor arch dir" FORCE)
  117. set(RUBY_VENDORLIB_DIR ${RUBY_VENDORLIB_DIR} CACHE PATH "The Ruby vendor lib dir" FORCE)
  118. mark_as_advanced(
  119. RUBY_ARCH_DIR
  120. RUBY_ARCH
  121. RUBY_HDR_DIR
  122. RUBY_ARCHHDR_DIR
  123. RUBY_POSSIBLE_LIB_DIR
  124. RUBY_RUBY_LIB_DIR
  125. RUBY_SITEARCH_DIR
  126. RUBY_SITELIB_DIR
  127. RUBY_HAS_VENDOR_RUBY
  128. RUBY_VENDORARCH_DIR
  129. RUBY_VENDORLIB_DIR
  130. RUBY_VERSION_MAJOR
  131. RUBY_VERSION_MINOR
  132. RUBY_VERSION_PATCH
  133. )
  134. endif()
  135. # In case RUBY_EXECUTABLE could not be executed (e.g. cross compiling)
  136. # try to detect which version we found. This is not too good.
  137. if(RUBY_EXECUTABLE AND NOT RUBY_VERSION_MAJOR)
  138. # by default assume 1.8.0
  139. set(RUBY_VERSION_MAJOR 1)
  140. set(RUBY_VERSION_MINOR 8)
  141. set(RUBY_VERSION_PATCH 0)
  142. # check whether we found 1.9.x
  143. if(${RUBY_EXECUTABLE} MATCHES "ruby1\\.?9")
  144. set(RUBY_VERSION_MAJOR 1)
  145. set(RUBY_VERSION_MINOR 9)
  146. endif()
  147. # check whether we found 2.0.x
  148. if(${RUBY_EXECUTABLE} MATCHES "ruby2\\.?0")
  149. set(RUBY_VERSION_MAJOR 2)
  150. set(RUBY_VERSION_MINOR 0)
  151. endif()
  152. # check whether we found 2.1.x
  153. if(${RUBY_EXECUTABLE} MATCHES "ruby2\\.?1")
  154. set(RUBY_VERSION_MAJOR 2)
  155. set(RUBY_VERSION_MINOR 1)
  156. endif()
  157. # check whether we found 2.2.x
  158. if(${RUBY_EXECUTABLE} MATCHES "ruby2\\.?2")
  159. set(RUBY_VERSION_MAJOR 2)
  160. set(RUBY_VERSION_MINOR 2)
  161. endif()
  162. # check whether we found 2.3.x
  163. if(${RUBY_EXECUTABLE} MATCHES "ruby2\\.?3")
  164. set(RUBY_VERSION_MAJOR 2)
  165. set(RUBY_VERSION_MINOR 3)
  166. endif()
  167. # check whether we found 2.4.x
  168. if(${RUBY_EXECUTABLE} MATCHES "ruby2\\.?4")
  169. set(RUBY_VERSION_MAJOR 2)
  170. set(RUBY_VERSION_MINOR 4)
  171. endif()
  172. endif()
  173. if(RUBY_VERSION_MAJOR)
  174. set(RUBY_VERSION "${RUBY_VERSION_MAJOR}.${RUBY_VERSION_MINOR}.${RUBY_VERSION_PATCH}")
  175. set(_RUBY_VERSION_SHORT "${RUBY_VERSION_MAJOR}.${RUBY_VERSION_MINOR}")
  176. set(_RUBY_VERSION_SHORT_NODOT "${RUBY_VERSION_MAJOR}${RUBY_VERSION_MINOR}")
  177. set(_RUBY_NODOT_VERSION "${RUBY_VERSION_MAJOR}${RUBY_VERSION_MINOR}${RUBY_VERSION_PATCH}")
  178. endif()
  179. find_path(RUBY_INCLUDE_DIR
  180. NAMES ruby.h
  181. HINTS
  182. ${RUBY_HDR_DIR}
  183. ${RUBY_ARCH_DIR}
  184. /usr/lib/ruby/${_RUBY_VERSION_SHORT}/i586-linux-gnu/ )
  185. set(RUBY_INCLUDE_DIRS ${RUBY_INCLUDE_DIR} )
  186. # if ruby > 1.8 is required or if ruby > 1.8 was found, search for the config.h dir
  187. if( "${Ruby_FIND_VERSION_SHORT_NODOT}" GREATER 18 OR "${_RUBY_VERSION_SHORT_NODOT}" GREATER 18 OR RUBY_HDR_DIR)
  188. find_path(RUBY_CONFIG_INCLUDE_DIR
  189. NAMES ruby/config.h config.h
  190. HINTS
  191. ${RUBY_HDR_DIR}/${RUBY_ARCH}
  192. ${RUBY_ARCH_DIR}
  193. ${RUBY_ARCHHDR_DIR}
  194. )
  195. set(RUBY_INCLUDE_DIRS ${RUBY_INCLUDE_DIRS} ${RUBY_CONFIG_INCLUDE_DIR} )
  196. endif()
  197. # Determine the list of possible names for the ruby library
  198. set(_RUBY_POSSIBLE_LIB_NAMES ruby ruby-static ruby${_RUBY_VERSION_SHORT} ruby${_RUBY_VERSION_SHORT_NODOT} ruby-${_RUBY_VERSION_SHORT} ruby-${RUBY_VERSION})
  199. if(WIN32)
  200. set( _RUBY_MSVC_RUNTIME "" )
  201. if( MSVC_VERSION EQUAL 1200 )
  202. set( _RUBY_MSVC_RUNTIME "60" )
  203. endif()
  204. if( MSVC_VERSION EQUAL 1300 )
  205. set( _RUBY_MSVC_RUNTIME "70" )
  206. endif()
  207. if( MSVC_VERSION EQUAL 1310 )
  208. set( _RUBY_MSVC_RUNTIME "71" )
  209. endif()
  210. if( MSVC_VERSION EQUAL 1400 )
  211. set( _RUBY_MSVC_RUNTIME "80" )
  212. endif()
  213. if( MSVC_VERSION EQUAL 1500 )
  214. set( _RUBY_MSVC_RUNTIME "90" )
  215. endif()
  216. set(_RUBY_ARCH_PREFIX "")
  217. if(CMAKE_SIZEOF_VOID_P EQUAL 8)
  218. set(_RUBY_ARCH_PREFIX "x64-")
  219. endif()
  220. list(APPEND _RUBY_POSSIBLE_LIB_NAMES
  221. "${_RUBY_ARCH_PREFIX}msvcr${_RUBY_MSVC_RUNTIME}-ruby${_RUBY_NODOT_VERSION}"
  222. "${_RUBY_ARCH_PREFIX}msvcr${_RUBY_MSVC_RUNTIME}-ruby${_RUBY_NODOT_VERSION}-static"
  223. "${_RUBY_ARCH_PREFIX}msvcrt-ruby${_RUBY_NODOT_VERSION}"
  224. "${_RUBY_ARCH_PREFIX}msvcrt-ruby${_RUBY_NODOT_VERSION}-static" )
  225. endif()
  226. find_library(RUBY_LIBRARY NAMES ${_RUBY_POSSIBLE_LIB_NAMES} HINTS ${RUBY_POSSIBLE_LIB_DIR} )
  227. include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
  228. set(_RUBY_REQUIRED_VARS RUBY_EXECUTABLE RUBY_INCLUDE_DIR RUBY_LIBRARY)
  229. if(_RUBY_VERSION_SHORT_NODOT GREATER 18)
  230. list(APPEND _RUBY_REQUIRED_VARS RUBY_CONFIG_INCLUDE_DIR)
  231. endif()
  232. if(_RUBY_DEBUG_OUTPUT)
  233. message(STATUS "--------FindRuby.cmake debug------------")
  234. message(STATUS "_RUBY_POSSIBLE_EXECUTABLE_NAMES: ${_RUBY_POSSIBLE_EXECUTABLE_NAMES}")
  235. message(STATUS "_RUBY_POSSIBLE_LIB_NAMES: ${_RUBY_POSSIBLE_LIB_NAMES}")
  236. message(STATUS "RUBY_ARCH_DIR: ${RUBY_ARCH_DIR}")
  237. message(STATUS "RUBY_HDR_DIR: ${RUBY_HDR_DIR}")
  238. message(STATUS "RUBY_POSSIBLE_LIB_DIR: ${RUBY_POSSIBLE_LIB_DIR}")
  239. message(STATUS "Found RUBY_VERSION: \"${RUBY_VERSION}\" , short: \"${_RUBY_VERSION_SHORT}\", nodot: \"${_RUBY_VERSION_SHORT_NODOT}\"")
  240. message(STATUS "_RUBY_REQUIRED_VARS: ${_RUBY_REQUIRED_VARS}")
  241. message(STATUS "RUBY_EXECUTABLE: ${RUBY_EXECUTABLE}")
  242. message(STATUS "RUBY_LIBRARY: ${RUBY_LIBRARY}")
  243. message(STATUS "RUBY_INCLUDE_DIR: ${RUBY_INCLUDE_DIR}")
  244. message(STATUS "RUBY_CONFIG_INCLUDE_DIR: ${RUBY_CONFIG_INCLUDE_DIR}")
  245. message(STATUS "--------------------")
  246. endif()
  247. FIND_PACKAGE_HANDLE_STANDARD_ARGS(Ruby REQUIRED_VARS ${_RUBY_REQUIRED_VARS}
  248. VERSION_VAR RUBY_VERSION )
  249. mark_as_advanced(
  250. RUBY_EXECUTABLE
  251. RUBY_LIBRARY
  252. RUBY_INCLUDE_DIR
  253. RUBY_CONFIG_INCLUDE_DIR
  254. )
  255. # Set some variables for compatibility with previous version of this file
  256. set(RUBY_POSSIBLE_LIB_PATH ${RUBY_POSSIBLE_LIB_DIR})
  257. set(RUBY_RUBY_LIB_PATH ${RUBY_RUBY_LIB_DIR})
  258. set(RUBY_INCLUDE_PATH ${RUBY_INCLUDE_DIRS})