UseJava.cmake 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file LICENSE.rst or https://cmake.org/licensing for details.
  3. #[=======================================================================[.rst:
  4. UseJava
  5. -------
  6. This file provides support for ``Java``. It is assumed that
  7. :module:`FindJava` has already been loaded. See :module:`FindJava` for
  8. information on how to load Java into your CMake project.
  9. Load this module in a CMake project with:
  10. .. code-block:: cmake
  11. include(UseJava)
  12. Synopsis
  13. ^^^^^^^^
  14. .. parsed-literal::
  15. `Creating and Installing JARS`_
  16. `add_jar`_ (<target_name> [SOURCES] <source1> [<source2>...] ...)
  17. `install_jar`_ (<target_name> DESTINATION <destination> [COMPONENT <component>])
  18. `install_jni_symlink`_ (<target_name> DESTINATION <destination> [COMPONENT <component>])
  19. `Header Generation`_
  20. `create_javah`_ ((TARGET <target> | GENERATED_FILES <VAR>) CLASSES <class>... ...)
  21. `Exporting JAR Targets`_
  22. `install_jar_exports`_ (TARGETS <jars>... FILE <filename> DESTINATION <destination> ...)
  23. `export_jars`_ (TARGETS <jars>... [NAMESPACE <namespace>] FILE <filename>)
  24. `Finding JARs`_
  25. `find_jar`_ (<VAR> NAMES <name1> [<name2>...] [PATHS <path1> [<path2>... ENV <var>]] ...)
  26. `Creating Java Documentation`_
  27. `create_javadoc`_ (<VAR> (PACKAGES <pkg1> [<pkg2>...] | FILES <file1> [<file2>...]) ...)
  28. Creating And Installing JARs
  29. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  30. .. _add_jar:
  31. .. command:: add_jar
  32. Creates a jar file containing java objects and, optionally, resources:
  33. .. code-block:: cmake
  34. add_jar(<target_name>
  35. [SOURCES] <source1> [<source2>...] [<resource1>...]
  36. [RESOURCES NAMESPACE <ns1> <resource1>... [NAMESPACE <nsX> <resourceX>...]... ]
  37. [INCLUDE_JARS <jar1> [<jar2>...]]
  38. [INCLUDE_MODULES <jar1> [<jar2>...]]
  39. [ENTRY_POINT <entry>]
  40. [VERSION <version>]
  41. [MANIFEST <manifest>]
  42. [OUTPUT_NAME <name>]
  43. [OUTPUT_DIR <dir>]
  44. [GENERATE_NATIVE_HEADERS <target>
  45. [DESTINATION (<dir>|INSTALL <dir> [BUILD <dir>])]]
  46. )
  47. This command creates a ``<target_name>.jar``. It compiles the given
  48. ``<source>`` files and adds the given ``<resource>`` files to
  49. the jar file. Source files can be java files or listing files
  50. (prefixed by ``@``). If only resource files are given then just a jar file
  51. is created.
  52. ``SOURCES``
  53. Compiles the specified source files and adds the result in the jar file.
  54. .. versionadded:: 3.4
  55. Support for response files, prefixed by ``@``.
  56. ``RESOURCES``
  57. .. versionadded:: 3.21
  58. Adds the named ``<resource>`` files to the jar by stripping the source file
  59. path and placing the file beneath ``<ns>`` within the jar.
  60. For example::
  61. RESOURCES NAMESPACE "/com/my/namespace" "a/path/to/resource.txt"
  62. results in a resource accessible via ``/com/my/namespace/resource.txt``
  63. within the jar.
  64. Resources may be added without adjusting the namespace by adding them to
  65. the list of ``SOURCES`` (original behavior), in this case, resource
  66. paths must be relative to ``CMAKE_CURRENT_SOURCE_DIR``. Adding resources
  67. without using the ``RESOURCES`` parameter in out of source builds will
  68. almost certainly result in confusion.
  69. .. note::
  70. Adding resources via the ``SOURCES`` parameter relies upon a hard-coded
  71. list of file extensions which are tested to determine whether they
  72. compile (e.g. File.java). ``SOURCES`` files which match the extensions
  73. are compiled. Files which do not match are treated as resources. To
  74. include uncompiled resources matching those file extensions use
  75. the ``RESOURCES`` parameter.
  76. ``INCLUDE_JARS``
  77. The list of jars are added to the classpath when compiling the java sources
  78. and also to the dependencies of the target. ``INCLUDE_JARS`` also accepts
  79. other target names created by ``add_jar()``. For backwards compatibility,
  80. jar files listed as sources are ignored (as they have been since the first
  81. version of this module).
  82. ``INCLUDE_MODULES``
  83. .. versionadded:: 4.3
  84. The list of jars are added to the module path when building the java sources
  85. and also to the dependencies of the target. ``INCLUDE_MODULES`` also
  86. accepts other target names created by ``add_jar()``.
  87. ``ENTRY_POINT``
  88. Defines an entry point in the jar file.
  89. ``VERSION``
  90. Adds a version to the target output name.
  91. The following example will create a jar file with the name
  92. ``shibboleet-1.2.0.jar`` and will create a symlink ``shibboleet.jar``
  93. pointing to the jar with the version information.
  94. .. code-block:: cmake
  95. add_jar(shibboleet shibbotleet.java VERSION 1.2.0)
  96. ``MANIFEST``
  97. Defines a custom manifest for the jar.
  98. ``OUTPUT_NAME``
  99. Specify a different output name for the target.
  100. ``OUTPUT_DIR``
  101. Sets the directory where the jar file will be generated. If not specified,
  102. :variable:`CMAKE_CURRENT_BINARY_DIR` is used as the output directory.
  103. ``GENERATE_NATIVE_HEADERS``
  104. .. versionadded:: 3.11
  105. Generates native header files for methods declared as native. These files
  106. provide the connective glue that allow your Java and C code to interact.
  107. An INTERFACE target will be created for an easy usage of generated files.
  108. Sub-option ``DESTINATION`` can be used to specify the output directory for
  109. generated header files.
  110. This option requires, at least, version 1.8 of the JDK.
  111. For an optimum usage of this option, it is recommended to include module
  112. JNI before any call to ``add_jar()``. The produced target for native
  113. headers can then be used to compile C/C++ sources with the
  114. :command:`target_link_libraries` command.
  115. .. code-block:: cmake
  116. find_package(JNI)
  117. add_jar(foo foo.java GENERATE_NATIVE_HEADERS foo-native)
  118. add_library(bar bar.cpp)
  119. target_link_libraries(bar PRIVATE foo-native)
  120. .. versionadded:: 3.20
  121. ``DESTINATION`` sub-option now supports the possibility to specify
  122. different output directories for ``BUILD`` and ``INSTALL`` steps. If
  123. ``BUILD`` directory is not specified, a default directory will be used.
  124. To export the interface target generated by ``GENERATE_NATIVE_HEADERS``
  125. option, sub-option ``INSTALL`` of ``DESTINATION`` is required:
  126. .. code-block:: cmake
  127. add_jar(foo foo.java GENERATE_NATIVE_HEADERS foo-native
  128. DESTINATION INSTALL include)
  129. install(TARGETS foo-native EXPORT native)
  130. install(DIRECTORY "$<TARGET_PROPERTY:foo-native,NATIVE_HEADERS_DIRECTORY>/"
  131. DESTINATION include)
  132. install(EXPORT native DESTINATION /to/export NAMESPACE foo)
  133. Some variables can be set to customize the behavior of ``add_jar()`` as well
  134. as the java compiler:
  135. ``CMAKE_JAVA_COMPILE_FLAGS``
  136. Specify additional flags to java compiler.
  137. ``CMAKE_JAVA_INCLUDE_PATH``
  138. Specify additional paths to the class path.
  139. ``CMAKE_JNI_TARGET``
  140. If the target is a JNI library, sets this boolean variable to ``TRUE`` to
  141. enable creation of a JNI symbolic link (see also
  142. :ref:`install_jni_symlink() <install_jni_symlink>`).
  143. ``CMAKE_JAR_CLASSES_PREFIX``
  144. If multiple jars should be produced from the same java source filetree,
  145. to prevent the accumulation of duplicate class files in subsequent jars,
  146. set/reset ``CMAKE_JAR_CLASSES_PREFIX`` prior to calling the ``add_jar()``:
  147. .. code-block:: cmake
  148. set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo)
  149. add_jar(foo foo.java)
  150. set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar)
  151. add_jar(bar bar.java)
  152. The ``add_jar()`` function sets the following target properties on
  153. ``<target_name>``:
  154. ``INSTALL_FILES``
  155. The files which should be installed. This is used by
  156. :ref:`install_jar() <install_jar>`.
  157. ``JNI_SYMLINK``
  158. The JNI symlink which should be installed. This is used by
  159. :ref:`install_jni_symlink() <install_jni_symlink>`.
  160. ``JAR_FILE``
  161. The location of the jar file so that you can include it.
  162. ``CLASSDIR``
  163. The directory where the class files can be found. For example to use them
  164. with ``javah``.
  165. ``NATIVE_HEADERS_DIRECTORY``
  166. .. versionadded:: 3.20
  167. The directory where native headers are generated. Defined when option
  168. ``GENERATE_NATIVE_HEADERS`` is specified.
  169. .. _install_jar:
  170. .. command:: install_jar
  171. This command installs the jar file to the given destination:
  172. .. code-block:: cmake
  173. install_jar(<target_name> <destination>)
  174. install_jar(<target_name> DESTINATION <destination> [COMPONENT <component>])
  175. This command installs the ``<target_name>`` file to the given
  176. ``<destination>``. It should be called in the same scope as
  177. :ref:`add_jar() <add_jar>` or it will fail.
  178. .. versionadded:: 3.4
  179. The second signature with ``DESTINATION`` and ``COMPONENT`` options.
  180. ``DESTINATION``
  181. Specify the directory on disk to which a file will be installed.
  182. ``COMPONENT``
  183. Specify an installation component name with which the install rule is
  184. associated, such as "runtime" or "development".
  185. The ``install_jar()`` command sets the following target properties
  186. on ``<target_name>``:
  187. ``INSTALL_DESTINATION``
  188. Holds the ``<destination>`` as described above, and is used by
  189. :ref:`install_jar_exports() <install_jar_exports>`.
  190. .. _install_jni_symlink:
  191. .. command:: install_jni_symlink
  192. Installs JNI symlinks for target generated by :ref:`add_jar() <add_jar>`:
  193. .. code-block:: cmake
  194. install_jni_symlink(<target_name> <destination>)
  195. install_jni_symlink(<target_name> DESTINATION <destination> [COMPONENT <component>])
  196. This command installs the ``<target_name>`` JNI symlinks to the given
  197. ``<destination>``. It should be called in the same scope as
  198. :ref:`add_jar() <add_jar>` or it will fail.
  199. .. versionadded:: 3.4
  200. The second signature with ``DESTINATION`` and ``COMPONENT`` options.
  201. ``DESTINATION``
  202. Specify the directory on disk to which a file will be installed.
  203. ``COMPONENT``
  204. Specify an installation component name with which the install rule is
  205. associated, such as "runtime" or "development".
  206. Utilize the following commands to create a JNI symbolic link:
  207. .. code-block:: cmake
  208. set(CMAKE_JNI_TARGET TRUE)
  209. add_jar(shibboleet shibbotleet.java VERSION 1.2.0)
  210. install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet)
  211. install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR})
  212. Header Generation
  213. ^^^^^^^^^^^^^^^^^
  214. .. _create_javah:
  215. .. command:: create_javah
  216. .. versionadded:: 3.4
  217. Generates C header files for java classes:
  218. .. code-block:: cmake
  219. create_javah(TARGET <target> | GENERATED_FILES <VAR>
  220. CLASSES <class>...
  221. [CLASSPATH <classpath>...]
  222. [DEPENDS <depend>...]
  223. [OUTPUT_NAME <path>|OUTPUT_DIR <path>]
  224. )
  225. .. deprecated:: 3.11
  226. This command will no longer be supported starting with version 10 of the JDK
  227. due to the `suppression of javah tool <https://openjdk.org/jeps/313>`_.
  228. The :ref:`add_jar(GENERATE_NATIVE_HEADERS) <add_jar>` command should be
  229. used instead.
  230. Create C header files from java classes. These files provide the connective
  231. glue that allow your Java and C code to interact.
  232. There are two main signatures for ``create_javah()``. The first signature
  233. returns generated files through variable specified by the ``GENERATED_FILES``
  234. option. For example:
  235. .. code-block:: cmake
  236. create_javah(GENERATED_FILES files_headers
  237. CLASSES org.cmake.HelloWorld
  238. CLASSPATH hello.jar
  239. )
  240. The second signature for ``create_javah()`` creates a target which
  241. encapsulates header files generation. E.g.
  242. .. code-block:: cmake
  243. create_javah(TARGET target_headers
  244. CLASSES org.cmake.HelloWorld
  245. CLASSPATH hello.jar
  246. )
  247. Both signatures share same options.
  248. ``CLASSES``
  249. Specifies Java classes used to generate headers.
  250. ``CLASSPATH``
  251. Specifies various paths to look up classes. Here ``.class`` files, jar
  252. files or targets created by command add_jar can be used.
  253. ``DEPENDS``
  254. Targets on which the javah target depends.
  255. ``OUTPUT_NAME``
  256. Concatenates the resulting header files for all the classes listed by
  257. option ``CLASSES`` into ``<path>``. Same behavior as option ``-o`` of
  258. ``javah`` tool.
  259. ``OUTPUT_DIR``
  260. Sets the directory where the header files will be generated. Same behavior
  261. as option ``-d`` of ``javah`` tool. If not specified,
  262. :variable:`CMAKE_CURRENT_BINARY_DIR` is used as the output directory.
  263. Exporting JAR Targets
  264. ^^^^^^^^^^^^^^^^^^^^^
  265. .. _install_jar_exports:
  266. .. command:: install_jar_exports
  267. .. versionadded:: 3.7
  268. Installs a target export file:
  269. .. code-block:: cmake
  270. install_jar_exports(TARGETS <jars>...
  271. [NAMESPACE <namespace>]
  272. FILE <filename>
  273. DESTINATION <destination> [COMPONENT <component>])
  274. This command installs a target export file ``<filename>`` for the named jar
  275. targets to the given ``<destination>`` directory. Its function is similar to
  276. that of :command:`install(EXPORT)`.
  277. ``TARGETS``
  278. List of targets created by :ref:`add_jar() <add_jar>` command.
  279. ``NAMESPACE``
  280. .. versionadded:: 3.9
  281. The ``<namespace>`` value will be prepend to the target names as they are
  282. written to the import file.
  283. ``FILE``
  284. Specify name of the export file.
  285. ``DESTINATION``
  286. Specify the directory on disk to which a file will be installed.
  287. ``COMPONENT``
  288. Specify an installation component name with which the install rule is
  289. associated, such as "runtime" or "development".
  290. .. _export_jars:
  291. .. command:: export_jars
  292. .. versionadded:: 3.7
  293. Writes a target export file:
  294. .. code-block:: cmake
  295. export_jars(TARGETS <jars>...
  296. [NAMESPACE <namespace>]
  297. FILE <filename>)
  298. This command writes a target export file ``<filename>`` for the named ``<jars>``
  299. targets. Its function is similar to that of :command:`export`.
  300. ``TARGETS``
  301. List of targets created by :ref:`add_jar() <add_jar>` command.
  302. ``NAMESPACE``
  303. .. versionadded:: 3.9
  304. The ``<namespace>`` value will be prepend to the target names as they are
  305. written to the import file.
  306. ``FILE``
  307. Specify name of the export file.
  308. Finding JARs
  309. ^^^^^^^^^^^^
  310. .. _find_jar:
  311. .. command:: find_jar
  312. Finds the specified jar file:
  313. .. code-block:: cmake
  314. find_jar(<VAR>
  315. <name> | NAMES <name1> [<name2>...]
  316. [PATHS <path1> [<path2>... ENV <var>]]
  317. [VERSIONS <version1> [<version2>]]
  318. [DOC "cache documentation string"]
  319. )
  320. This command is used to find a full path to the named jar. A cache
  321. entry named by ``<VAR>`` is created to store the result of this command.
  322. If the full path to a jar is found the result is stored in the
  323. variable and the search will not repeated unless the variable is
  324. cleared. If nothing is found, the result will be ``<VAR>-NOTFOUND``, and
  325. the search will be attempted again next time ``find_jar()`` is invoked with
  326. the same variable.
  327. ``NAMES``
  328. Specify one or more possible names for the jar file.
  329. ``PATHS``
  330. Specify directories to search in addition to the default locations.
  331. The ``ENV`` var sub-option reads paths from a system environment variable.
  332. ``VERSIONS``
  333. Specify jar versions.
  334. ``DOC``
  335. Specify the documentation string for the ``<VAR>`` cache entry.
  336. Creating Java Documentation
  337. ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  338. .. _create_javadoc:
  339. .. command:: create_javadoc
  340. Creates java documentation based on files and packages:
  341. .. code-block:: cmake
  342. create_javadoc(<VAR>
  343. (PACKAGES <pkg1> [<pkg2>...] | FILES <file1> [<file2>...])
  344. [SOURCEPATH <sourcepath>]
  345. [CLASSPATH <classpath>]
  346. [INSTALLPATH <install path>]
  347. [DOCTITLE <the documentation title>]
  348. [WINDOWTITLE <the title of the document>]
  349. [AUTHOR (TRUE|FALSE)]
  350. [USE (TRUE|FALSE)]
  351. [VERSION (TRUE|FALSE)]
  352. )
  353. The ``create_javadoc()`` command can be used to create java documentation.
  354. There are two main signatures for ``create_javadoc()``.
  355. The first signature works with package names on a path with source files:
  356. .. code-block:: cmake
  357. create_javadoc(my_example_doc
  358. PACKAGES com.example.foo com.example.bar
  359. SOURCEPATH "${CMAKE_CURRENT_SOURCE_DIR}"
  360. CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
  361. WINDOWTITLE "My example"
  362. DOCTITLE "<h1>My example</h1>"
  363. AUTHOR TRUE
  364. USE TRUE
  365. VERSION TRUE
  366. )
  367. The second signature for ``create_javadoc()`` works on a given list of files:
  368. .. code-block:: cmake
  369. create_javadoc(my_example_doc
  370. FILES java/A.java java/B.java
  371. CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
  372. WINDOWTITLE "My example"
  373. DOCTITLE "<h1>My example</h1>"
  374. AUTHOR TRUE
  375. USE TRUE
  376. VERSION TRUE
  377. )
  378. Both signatures share most of the options. For more details please read the
  379. javadoc manpage.
  380. ``PACKAGES``
  381. Specify java packages.
  382. ``FILES``
  383. Specify java source files. If relative paths are specified, they are
  384. relative to :variable:`CMAKE_CURRENT_SOURCE_DIR`.
  385. ``SOURCEPATH``
  386. Specify the directory where to look for packages. By default,
  387. :variable:`CMAKE_CURRENT_SOURCE_DIR` directory is used.
  388. ``CLASSPATH``
  389. Specify where to find user class files. Same behavior as option
  390. ``-classpath`` of ``javadoc`` tool.
  391. ``INSTALLPATH``
  392. Specify where to install the java documentation. If you specified, the
  393. documentation will be installed to
  394. ``${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR>``.
  395. ``DOCTITLE``
  396. Specify the title to place near the top of the overview summary file.
  397. Same behavior as option ``-doctitle`` of ``javadoc`` tool.
  398. ``WINDOWTITLE``
  399. Specify the title to be placed in the HTML ``<title>`` tag. Same behavior
  400. as option ``-windowtitle`` of ``javadoc`` tool.
  401. ``AUTHOR``
  402. When value ``TRUE`` is specified, includes the ``@author`` text in the
  403. generated docs. Same behavior as option ``-author`` of ``javadoc`` tool.
  404. ``USE``
  405. When value ``TRUE`` is specified, creates class and package usage pages.
  406. Includes one Use page for each documented class and package. Same behavior
  407. as option ``-use`` of ``javadoc`` tool.
  408. ``VERSION``
  409. When value ``TRUE`` is specified, includes the version text in the
  410. generated docs. Same behavior as option ``-version`` of ``javadoc`` tool.
  411. #]=======================================================================]
  412. block(SCOPE_FOR POLICIES)
  413. cmake_policy(SET CMP0140 NEW) # For return(PROPAGATE ...)
  414. function (__java_copy_file src dest comment)
  415. add_custom_command(
  416. OUTPUT ${dest}
  417. COMMAND ${CMAKE_COMMAND} -E copy_if_different
  418. ARGS ${src}
  419. ${dest}
  420. DEPENDS ${src}
  421. COMMENT ${comment}
  422. VERBATIM
  423. )
  424. endfunction ()
  425. function(__java_lcat VAR)
  426. foreach(_line IN LISTS ARGN)
  427. string(APPEND ${VAR} "${_line}\n")
  428. endforeach()
  429. set(${VAR} "${${VAR}}" PARENT_SCOPE)
  430. endfunction()
  431. function(__java_export_jar VAR TARGET PATH)
  432. get_target_property(_jarpath ${TARGET} JAR_FILE)
  433. get_filename_component(_jarname ${_jarpath} NAME)
  434. set(_target "${_jar_NAMESPACE}${TARGET}")
  435. __java_lcat(${VAR}
  436. "# Create imported target ${_target}"
  437. "add_library(${_target} IMPORTED STATIC)"
  438. "set_target_properties(${_target} PROPERTIES"
  439. " IMPORTED_LOCATION \"${PATH}/${_jarname}\""
  440. " JAR_FILE \"${PATH}/${_jarname}\")"
  441. ""
  442. )
  443. set(${VAR} "${${VAR}}" PARENT_SCOPE)
  444. endfunction()
  445. function(__java_copy_resource_namespaces VAR DEST JAVA_RESOURCE_FILES JAVA_RESOURCE_FILES_RELATIVE)
  446. set(_ns_ID "")
  447. set(_ns_VAL "")
  448. foreach(_item IN LISTS VAR)
  449. if(NOT _ns_ID)
  450. if(NOT _item STREQUAL "NAMESPACE")
  451. message(FATAL_ERROR "UseJava: Expecting \"NAMESPACE\", got\t\"${_item}\"")
  452. return()
  453. endif()
  454. endif()
  455. if(_item STREQUAL "NAMESPACE")
  456. set(_ns_VAL "") # Prepare for next namespace
  457. set(_ns_ID "${_item}")
  458. continue()
  459. endif()
  460. if( NOT _ns_VAL)
  461. # we're expecting the next token to be a namespace value
  462. # whatever it is, we're treating it like a namespace
  463. set(_ns_VAL "${_item}")
  464. continue()
  465. endif()
  466. if(_ns_ID AND _ns_VAL)
  467. # We're expecting a file name, check to see if we got one
  468. cmake_path(ABSOLUTE_PATH _item OUTPUT_VARIABLE _test_file_name)
  469. if (NOT EXISTS "${_test_file_name}")
  470. message(FATAL_ERROR "UseJava: File does not exist:\t${_item}")
  471. return()
  472. endif()
  473. endif()
  474. cmake_path(ABSOLUTE_PATH _item OUTPUT_VARIABLE _abs_file_name)
  475. cmake_path(GET _item FILENAME _resource_file_name)
  476. set(_dest_resource_file_name "${_ns_VAL}/${_resource_file_name}" )
  477. __java_copy_file( ${_abs_file_name}
  478. ${DEST}/${_dest_resource_file_name}
  479. "Copying ${_item} to the build directory")
  480. list(APPEND RESOURCE_FILES_LIST ${DEST}/${_dest_resource_file_name})
  481. list(APPEND RELATIVE_RESOURCE_FILES_LIST ${_dest_resource_file_name})
  482. endforeach()
  483. set(${JAVA_RESOURCE_FILES} "${RESOURCE_FILES_LIST}" PARENT_SCOPE)
  484. set(${JAVA_RESOURCE_FILES_RELATIVE} "${RELATIVE_RESOURCE_FILES_LIST}" PARENT_SCOPE)
  485. endfunction()
  486. # define helper scripts
  487. set(_JAVA_EXPORT_TARGETS_SCRIPT ${CMAKE_CURRENT_LIST_DIR}/UseJava/javaTargets.cmake.in)
  488. set(_JAVA_SYMLINK_SCRIPT ${CMAKE_CURRENT_LIST_DIR}/UseJava/Symlinks.cmake)
  489. if (CMAKE_HOST_WIN32 AND NOT CYGWIN AND CMAKE_HOST_SYSTEM_NAME MATCHES "Windows")
  490. set(_UseJava_PATH_SEP "$<SEMICOLON>")
  491. else ()
  492. set(_UseJava_PATH_SEP ":")
  493. endif()
  494. function(__java_resolve_jar outvar_path path_or_tgt)
  495. if (TARGET "${path_or_tgt}")
  496. # Check if this is a target created by add_jar
  497. get_target_property(jarpath "${path_or_tgt}" JAR_FILE)
  498. set("${outvar_path}" "${jarpath}")
  499. if (NOT jarpath) # Some other target that we do not know how to use as a JAR
  500. message(SEND_ERROR "target ${path_or_tgt} is not a jar")
  501. endif ()
  502. else () # Interpreted as the path to an external JAR
  503. set("${outvar_path}" "${path_or_tgt}")
  504. endif ()
  505. return(PROPAGATE "${outvar_path}")
  506. endfunction()
  507. # Helper that processes a list of add_jar-created targets or paths to external
  508. # JAR files and:
  509. # - appends each item (target name or JAR path) to the list in outvar_depsraw.
  510. # - appends the resolved JAR path to the list in outvar_depsresolved.
  511. # If any item cannot be resolved, because it is a target name that was not
  512. # created by add_jar, a SEND_ERROR message is raised.
  513. function(__java_build_deplists outvar_depsraw outvar_depsresolved jars_or_targets_lst)
  514. foreach(item IN LISTS "${jars_or_targets_lst}")
  515. __java_resolve_jar(res_path "${item}")
  516. if (res_path) # We would get a falsy value in the error case
  517. list(APPEND "${outvar_depsraw}" "${item}") # Keep the original name (possibly a target) here
  518. list(APPEND "${outvar_depsresolved}" "${res_path}")
  519. endif ()
  520. endforeach()
  521. return(PROPAGATE "${outvar_depsraw}" "${outvar_depsresolved}")
  522. endfunction()
  523. function(add_jar _TARGET_NAME)
  524. set(options) # currently there are no zero value args (aka: options)
  525. set(oneValueArgs "ENTRY_POINT;MANIFEST;OUTPUT_DIR;;OUTPUT_NAME;VERSION" )
  526. set(multiValueArgs "GENERATE_NATIVE_HEADERS;INCLUDE_JARS;INCLUDE_MODULES;RESOURCES;SOURCES" )
  527. cmake_parse_arguments(PARSE_ARGV 1 _add_jar
  528. "${options}"
  529. "${oneValueArgs}"
  530. "${multiValueArgs}" )
  531. # In CMake < 2.8.12, add_jar used variables which were set prior to calling
  532. # add_jar for customizing the behavior of add_jar. In order to be backwards
  533. # compatible, check if any of those variables are set, and use them to
  534. # initialize values of the named arguments. (Giving the corresponding named
  535. # argument will override the value set here.)
  536. #
  537. # New features should use named arguments only.
  538. if(NOT DEFINED _add_jar_VERSION AND DEFINED CMAKE_JAVA_TARGET_VERSION)
  539. set(_add_jar_VERSION "${CMAKE_JAVA_TARGET_VERSION}")
  540. endif()
  541. if(NOT DEFINED _add_jar_OUTPUT_DIR AND DEFINED CMAKE_JAVA_TARGET_OUTPUT_DIR)
  542. set(_add_jar_OUTPUT_DIR "${CMAKE_JAVA_TARGET_OUTPUT_DIR}")
  543. endif()
  544. if(NOT DEFINED _add_jar_OUTPUT_NAME AND DEFINED CMAKE_JAVA_TARGET_OUTPUT_NAME)
  545. set(_add_jar_OUTPUT_NAME "${CMAKE_JAVA_TARGET_OUTPUT_NAME}")
  546. # reset
  547. set(CMAKE_JAVA_TARGET_OUTPUT_NAME)
  548. endif()
  549. if(NOT DEFINED _add_jar_ENTRY_POINT AND DEFINED CMAKE_JAVA_JAR_ENTRY_POINT)
  550. set(_add_jar_ENTRY_POINT "${CMAKE_JAVA_JAR_ENTRY_POINT}")
  551. endif()
  552. # This *should* still work if <resources1>... are included without a
  553. # named RESOURCES argument. In that case, the old behavior of potentially
  554. # misplacing the within the Jar will behave as previously (incorrectly)
  555. set(_JAVA_SOURCE_FILES ${_add_jar_SOURCES} ${_add_jar_UNPARSED_ARGUMENTS})
  556. if (NOT DEFINED _add_jar_OUTPUT_DIR)
  557. set(_add_jar_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
  558. else()
  559. get_filename_component(_add_jar_OUTPUT_DIR ${_add_jar_OUTPUT_DIR} ABSOLUTE)
  560. endif()
  561. # ensure output directory exists
  562. file (MAKE_DIRECTORY "${_add_jar_OUTPUT_DIR}")
  563. if (_add_jar_ENTRY_POINT)
  564. set(_ENTRY_POINT_OPTION e)
  565. set(_ENTRY_POINT_VALUE ${_add_jar_ENTRY_POINT})
  566. endif ()
  567. if (_add_jar_MANIFEST)
  568. set(_MANIFEST_OPTION m)
  569. get_filename_component (_MANIFEST_VALUE "${_add_jar_MANIFEST}" ABSOLUTE)
  570. endif ()
  571. unset (_GENERATE_NATIVE_HEADERS)
  572. if (_add_jar_GENERATE_NATIVE_HEADERS)
  573. # Raise an error if JDK version is less than 1.8 because javac -h is not supported
  574. # by earlier versions.
  575. if (Java_VERSION VERSION_LESS 1.8)
  576. message (FATAL_ERROR "ADD_JAR: GENERATE_NATIVE_HEADERS is not supported with this version of Java.")
  577. endif()
  578. unset (_GENERATE_NATIVE_HEADERS_OUTPUT_DESC)
  579. cmake_parse_arguments (_add_jar_GENERATE_NATIVE_HEADERS "" "" "DESTINATION" ${_add_jar_GENERATE_NATIVE_HEADERS})
  580. if (NOT _add_jar_GENERATE_NATIVE_HEADERS_UNPARSED_ARGUMENTS)
  581. message (FATAL_ERROR "ADD_JAR: GENERATE_NATIVE_HEADERS: missing required argument.")
  582. endif()
  583. list (LENGTH _add_jar_GENERATE_NATIVE_HEADERS_UNPARSED_ARGUMENTS length)
  584. if (length GREATER 1)
  585. list (REMOVE_AT _add_jar_GENERATE_NATIVE_HEADERS_UNPARSED_ARGUMENTS 0)
  586. message (FATAL_ERROR "ADD_JAR: GENERATE_NATIVE_HEADERS: ${_add_jar_GENERATE_NATIVE_HEADERS_UNPARSED_ARGUMENTS}: unexpected argument(s).")
  587. endif()
  588. if (NOT _add_jar_GENERATE_NATIVE_HEADERS_DESTINATION)
  589. set (_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_TARGET_NAME}.dir/native_headers")
  590. else()
  591. list (LENGTH _add_jar_GENERATE_NATIVE_HEADERS_DESTINATION length)
  592. if (NOT length EQUAL 1)
  593. cmake_parse_arguments (_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION "" "BUILD;INSTALL" "" "${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION}")
  594. if (_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_UNPARSED_ARGUMENTS)
  595. message (FATAL_ERROR "ADD_JAR: GENERATE_NATIVE_HEADERS: DESTINATION: ${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_UNPARSED_ARGUMENTS}: unexpected argument(s).")
  596. endif()
  597. if (NOT _add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_INSTALL)
  598. message (FATAL_ERROR "ADD_JAR: GENERATE_NATIVE_HEADERS: DESTINATION: INSTALL sub-option is required.")
  599. endif()
  600. if (NOT _add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_BUILD)
  601. set(_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_BUILD "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_TARGET_NAME}.dir/native_headers")
  602. endif()
  603. set(_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION "${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_BUILD}")
  604. set(_GENERATE_NATIVE_HEADERS_OUTPUT_DESC "$<BUILD_INTERFACE:${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_BUILD}>" "$<INSTALL_INTERFACE:${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION_INSTALL}>")
  605. endif()
  606. endif()
  607. set (_GENERATE_NATIVE_HEADERS_TARGET ${_add_jar_GENERATE_NATIVE_HEADERS_UNPARSED_ARGUMENTS})
  608. set (_GENERATE_NATIVE_HEADERS_OUTPUT_DIR "${_add_jar_GENERATE_NATIVE_HEADERS_DESTINATION}")
  609. set (_GENERATE_NATIVE_HEADERS -h "${_GENERATE_NATIVE_HEADERS_OUTPUT_DIR}")
  610. if(NOT _GENERATE_NATIVE_HEADERS_OUTPUT_DESC)
  611. set(_GENERATE_NATIVE_HEADERS_OUTPUT_DESC "${_GENERATE_NATIVE_HEADERS_OUTPUT_DIR}")
  612. endif()
  613. endif()
  614. if (LIBRARY_OUTPUT_PATH)
  615. set(CMAKE_JAVA_LIBRARY_OUTPUT_PATH ${LIBRARY_OUTPUT_PATH})
  616. else ()
  617. set(CMAKE_JAVA_LIBRARY_OUTPUT_PATH ${_add_jar_OUTPUT_DIR})
  618. endif ()
  619. set(CMAKE_JAVA_INCLUDE_PATH
  620. ${CMAKE_JAVA_INCLUDE_PATH}
  621. ${CMAKE_CURRENT_SOURCE_DIR}
  622. ${CMAKE_JAVA_OBJECT_OUTPUT_PATH}
  623. ${CMAKE_JAVA_LIBRARY_OUTPUT_PATH}
  624. )
  625. foreach (JAVA_INCLUDE_DIR IN LISTS CMAKE_JAVA_INCLUDE_PATH)
  626. string(APPEND CMAKE_JAVA_INCLUDE_PATH_FINAL "${_UseJava_PATH_SEP}${JAVA_INCLUDE_DIR}")
  627. endforeach()
  628. set(CMAKE_JAVA_CLASS_OUTPUT_PATH "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${_TARGET_NAME}.dir")
  629. set(_JAVA_TARGET_OUTPUT_NAME "${_TARGET_NAME}.jar")
  630. if (_add_jar_OUTPUT_NAME AND _add_jar_VERSION)
  631. set(_JAVA_TARGET_OUTPUT_NAME "${_add_jar_OUTPUT_NAME}-${_add_jar_VERSION}.jar")
  632. set(_JAVA_TARGET_OUTPUT_LINK "${_add_jar_OUTPUT_NAME}.jar")
  633. elseif (_add_jar_VERSION)
  634. set(_JAVA_TARGET_OUTPUT_NAME "${_TARGET_NAME}-${_add_jar_VERSION}.jar")
  635. set(_JAVA_TARGET_OUTPUT_LINK "${_TARGET_NAME}.jar")
  636. elseif (_add_jar_OUTPUT_NAME)
  637. set(_JAVA_TARGET_OUTPUT_NAME "${_add_jar_OUTPUT_NAME}.jar")
  638. endif ()
  639. set(_JAVA_CLASS_FILES)
  640. set(_JAVA_COMPILE_FILES)
  641. set(_JAVA_COMPILE_FILELISTS)
  642. set(_JAVA_DEPENDS)
  643. set(_JAVA_COMPILE_DEPENDS)
  644. set(_JAVA_COMPILE_MODDEPENDS)
  645. set(_JAVA_RESOURCE_FILES)
  646. set(_JAVA_RESOURCE_FILES_RELATIVE)
  647. foreach(_JAVA_SOURCE_FILE IN LISTS _JAVA_SOURCE_FILES)
  648. get_filename_component(_JAVA_EXT ${_JAVA_SOURCE_FILE} EXT)
  649. get_filename_component(_JAVA_FILE ${_JAVA_SOURCE_FILE} NAME_WE)
  650. get_filename_component(_JAVA_PATH ${_JAVA_SOURCE_FILE} PATH)
  651. get_filename_component(_JAVA_FULL ${_JAVA_SOURCE_FILE} ABSOLUTE)
  652. if (_JAVA_SOURCE_FILE MATCHES "^@(.+)$")
  653. get_filename_component(_JAVA_FULL ${CMAKE_MATCH_1} ABSOLUTE)
  654. list(APPEND _JAVA_COMPILE_FILELISTS ${_JAVA_FULL})
  655. elseif (_JAVA_EXT MATCHES ".java")
  656. file(RELATIVE_PATH _JAVA_REL_BINARY_PATH ${CMAKE_CURRENT_BINARY_DIR} ${_JAVA_FULL})
  657. file(RELATIVE_PATH _JAVA_REL_SOURCE_PATH ${CMAKE_CURRENT_SOURCE_DIR} ${_JAVA_FULL})
  658. string(LENGTH ${_JAVA_REL_BINARY_PATH} _BIN_LEN)
  659. string(LENGTH ${_JAVA_REL_SOURCE_PATH} _SRC_LEN)
  660. if (_BIN_LEN LESS _SRC_LEN)
  661. set(_JAVA_REL_PATH ${_JAVA_REL_BINARY_PATH})
  662. else ()
  663. set(_JAVA_REL_PATH ${_JAVA_REL_SOURCE_PATH})
  664. endif ()
  665. get_filename_component(_JAVA_REL_PATH ${_JAVA_REL_PATH} PATH)
  666. list(APPEND _JAVA_COMPILE_FILES ${_JAVA_SOURCE_FILE})
  667. set(_JAVA_CLASS_FILE "${CMAKE_JAVA_CLASS_OUTPUT_PATH}/${_JAVA_REL_PATH}/${_JAVA_FILE}.class")
  668. set(_JAVA_CLASS_FILES ${_JAVA_CLASS_FILES} ${_JAVA_CLASS_FILE})
  669. elseif (_JAVA_EXT MATCHES ".jar"
  670. OR _JAVA_EXT MATCHES ".war"
  671. OR _JAVA_EXT MATCHES ".ear"
  672. OR _JAVA_EXT MATCHES ".sar")
  673. # Ignored for backward compatibility
  674. elseif (_JAVA_EXT STREQUAL "")
  675. # XXX: this was not being used after setting!
  676. # list(APPEND CMAKE_JAVA_INCLUDE_PATH ${JAVA_JAR_TARGET_${_JAVA_SOURCE_FILE}} ${JAVA_JAR_TARGET_${_JAVA_SOURCE_FILE}_CLASSPATH})
  677. list(APPEND _JAVA_DEPENDS ${JAVA_JAR_TARGET_${_JAVA_SOURCE_FILE}})
  678. else ()
  679. __java_copy_file(${CMAKE_CURRENT_SOURCE_DIR}/${_JAVA_SOURCE_FILE}
  680. ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/${_JAVA_SOURCE_FILE}
  681. "Copying ${_JAVA_SOURCE_FILE} to the build directory")
  682. list(APPEND _JAVA_RESOURCE_FILES ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/${_JAVA_SOURCE_FILE})
  683. list(APPEND _JAVA_RESOURCE_FILES_RELATIVE ${_JAVA_SOURCE_FILE})
  684. endif ()
  685. endforeach()
  686. if(_add_jar_RESOURCES) # Process RESOURCES if it exists
  687. __java_copy_resource_namespaces("${_add_jar_RESOURCES}"
  688. ${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  689. _JAVA_RESOURCE_FILES
  690. _JAVA_RESOURCE_FILES_RELATIVE)
  691. endif()
  692. # Build dependency lists and arguments for JARs in the classpath
  693. __java_build_deplists(_JAVA_DEPENDS _JAVA_COMPILE_DEPENDS _add_jar_INCLUDE_JARS)
  694. foreach (resolved_cp_item IN LISTS _JAVA_COMPILE_DEPENDS)
  695. string(APPEND CMAKE_JAVA_INCLUDE_PATH_FINAL "${_UseJava_PATH_SEP}${resolved_cp_item}")
  696. endforeach ()
  697. # Build dependency lists and arguments for JARs in the modulepath
  698. set(javac_mp_args)
  699. if (_add_jar_INCLUDE_MODULES)
  700. if (Java_VERSION VERSION_LESS 9)
  701. message(SEND_ERROR "INCLUDE_MODULES requires Java 9+")
  702. endif()
  703. __java_build_deplists(_JAVA_DEPENDS _JAVA_COMPILE_MODDEPENDS _add_jar_INCLUDE_MODULES)
  704. list(JOIN _JAVA_COMPILE_MODDEPENDS "${_UseJava_PATH_SEP}" javac_mp_args)
  705. set(javac_mp_args "--module-path [[${javac_mp_args}]]")
  706. endif()
  707. if (_JAVA_COMPILE_FILES OR _JAVA_COMPILE_FILELISTS)
  708. set (_JAVA_SOURCES_FILELISTS)
  709. if (_JAVA_COMPILE_FILES)
  710. # Create the list of files to compile.
  711. set(_JAVA_SOURCES_FILE ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_sources)
  712. string(REPLACE ";" "\"\n\"" _JAVA_COMPILE_STRING "\"${_JAVA_COMPILE_FILES}\"")
  713. file(
  714. CONFIGURE
  715. OUTPUT "${_JAVA_SOURCES_FILE}"
  716. CONTENT "${_JAVA_COMPILE_STRING}\n"
  717. @ONLY
  718. )
  719. list (APPEND _JAVA_SOURCES_FILELISTS "@${_JAVA_SOURCES_FILE}")
  720. endif()
  721. if (_JAVA_COMPILE_FILELISTS)
  722. foreach (_JAVA_FILELIST IN LISTS _JAVA_COMPILE_FILELISTS)
  723. list (APPEND _JAVA_SOURCES_FILELISTS "@${_JAVA_FILELIST}")
  724. endforeach()
  725. endif()
  726. cmake_language(GET_MESSAGE_LOG_LEVEL _LOG_LEVEL)
  727. # Compile the java files and create a list of class files
  728. # NOTE: this command generates an artificial dependency file
  729. set(stamp_file "${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_compiled_${_TARGET_NAME}")
  730. add_custom_command(OUTPUT "${stamp_file}"
  731. COMMAND ${CMAKE_COMMAND}
  732. -DCMAKE_JAVA_CLASS_OUTPUT_PATH=${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  733. -DCMAKE_JAR_CLASSES_PREFIX=${CMAKE_JAR_CLASSES_PREFIX}
  734. -P ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/UseJava/ClearClassFiles.cmake
  735. --log-level ${_LOG_LEVEL}
  736. DEPENDS ${_JAVA_COMPILE_FILES} ${_JAVA_COMPILE_FILELISTS} ${_JAVA_COMPILE_DEPENDS} ${_JAVA_COMPILE_MODDEPENDS} ${_JAVA_SOURCES_FILE}
  737. WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  738. COMMENT "Building Java objects for ${_TARGET_NAME}.jar"
  739. VERBATIM
  740. )
  741. cmake_language(EVAL CODE "
  742. add_custom_command(OUTPUT [[${stamp_file}]]
  743. APPEND COMMAND [[${Java_JAVAC_EXECUTABLE}]]
  744. \${CMAKE_JAVA_COMPILE_FLAGS}
  745. -classpath [[${CMAKE_JAVA_INCLUDE_PATH_FINAL}]]
  746. ${javac_mp_args}
  747. -d [[${CMAKE_JAVA_CLASS_OUTPUT_PATH}]]
  748. \${_GENERATE_NATIVE_HEADERS}
  749. \${_JAVA_SOURCES_FILELISTS}
  750. )
  751. ")
  752. add_custom_command(OUTPUT "${stamp_file}"
  753. APPEND COMMAND ${CMAKE_COMMAND} -E touch "${stamp_file}"
  754. )
  755. add_custom_command(
  756. OUTPUT ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_class_filelist
  757. COMMAND ${CMAKE_COMMAND}
  758. -DCMAKE_JAVA_CLASS_OUTPUT_PATH=${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  759. -DCMAKE_JAR_CLASSES_PREFIX=${CMAKE_JAR_CLASSES_PREFIX}
  760. -P ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/UseJava/ClassFilelist.cmake
  761. DEPENDS "${stamp_file}"
  762. WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  763. VERBATIM
  764. )
  765. else ()
  766. # create an empty java_class_filelist
  767. if (NOT EXISTS ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_class_filelist)
  768. file(WRITE ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_class_filelist "")
  769. endif()
  770. endif ()
  771. # create the jar file
  772. set(_JAVA_JAR_OUTPUT_PATH
  773. "${_add_jar_OUTPUT_DIR}/${_JAVA_TARGET_OUTPUT_NAME}")
  774. if (CMAKE_JNI_TARGET)
  775. add_custom_command(
  776. OUTPUT ${_JAVA_JAR_OUTPUT_PATH}
  777. COMMAND ${Java_JAR_EXECUTABLE}
  778. -cf${_ENTRY_POINT_OPTION}${_MANIFEST_OPTION} ${_JAVA_JAR_OUTPUT_PATH} ${_ENTRY_POINT_VALUE} ${_MANIFEST_VALUE}
  779. ${_JAVA_RESOURCE_FILES_RELATIVE} @java_class_filelist
  780. COMMAND ${CMAKE_COMMAND}
  781. -D_JAVA_TARGET_DIR=${_add_jar_OUTPUT_DIR}
  782. -D_JAVA_TARGET_OUTPUT_NAME=${_JAVA_TARGET_OUTPUT_NAME}
  783. -D_JAVA_TARGET_OUTPUT_LINK=${_JAVA_TARGET_OUTPUT_LINK}
  784. -P ${_JAVA_SYMLINK_SCRIPT}
  785. COMMAND ${CMAKE_COMMAND}
  786. -D_JAVA_TARGET_DIR=${_add_jar_OUTPUT_DIR}
  787. -D_JAVA_TARGET_OUTPUT_NAME=${_JAVA_JAR_OUTPUT_PATH}
  788. -D_JAVA_TARGET_OUTPUT_LINK=${_JAVA_TARGET_OUTPUT_LINK}
  789. -P ${_JAVA_SYMLINK_SCRIPT}
  790. DEPENDS ${_JAVA_RESOURCE_FILES} ${_JAVA_DEPENDS} ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_class_filelist
  791. WORKING_DIRECTORY ${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  792. COMMENT "Creating Java archive ${_JAVA_TARGET_OUTPUT_NAME}"
  793. VERBATIM
  794. )
  795. else ()
  796. add_custom_command(
  797. OUTPUT ${_JAVA_JAR_OUTPUT_PATH}
  798. COMMAND ${Java_JAR_EXECUTABLE}
  799. -cf${_ENTRY_POINT_OPTION}${_MANIFEST_OPTION} ${_JAVA_JAR_OUTPUT_PATH} ${_ENTRY_POINT_VALUE} ${_MANIFEST_VALUE}
  800. ${_JAVA_RESOURCE_FILES_RELATIVE} @java_class_filelist
  801. COMMAND ${CMAKE_COMMAND}
  802. -D_JAVA_TARGET_DIR=${_add_jar_OUTPUT_DIR}
  803. -D_JAVA_TARGET_OUTPUT_NAME=${_JAVA_TARGET_OUTPUT_NAME}
  804. -D_JAVA_TARGET_OUTPUT_LINK=${_JAVA_TARGET_OUTPUT_LINK}
  805. -P ${_JAVA_SYMLINK_SCRIPT}
  806. WORKING_DIRECTORY ${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  807. DEPENDS ${_JAVA_RESOURCE_FILES} ${_JAVA_DEPENDS} ${CMAKE_JAVA_CLASS_OUTPUT_PATH}/java_class_filelist
  808. COMMENT "Creating Java archive ${_JAVA_TARGET_OUTPUT_NAME}"
  809. VERBATIM
  810. )
  811. endif ()
  812. # Add the target and make sure we have the latest resource files.
  813. add_custom_target(${_TARGET_NAME} ALL DEPENDS ${_JAVA_JAR_OUTPUT_PATH})
  814. set_property(
  815. TARGET
  816. ${_TARGET_NAME}
  817. PROPERTY
  818. INSTALL_FILES
  819. ${_JAVA_JAR_OUTPUT_PATH}
  820. )
  821. if (_JAVA_TARGET_OUTPUT_LINK)
  822. set_property(
  823. TARGET
  824. ${_TARGET_NAME}
  825. PROPERTY
  826. INSTALL_FILES
  827. ${_JAVA_JAR_OUTPUT_PATH}
  828. ${_add_jar_OUTPUT_DIR}/${_JAVA_TARGET_OUTPUT_LINK}
  829. )
  830. if (CMAKE_JNI_TARGET)
  831. set_property(
  832. TARGET
  833. ${_TARGET_NAME}
  834. PROPERTY
  835. JNI_SYMLINK
  836. ${_add_jar_OUTPUT_DIR}/${_JAVA_TARGET_OUTPUT_LINK}
  837. )
  838. endif ()
  839. endif ()
  840. set_property(
  841. TARGET
  842. ${_TARGET_NAME}
  843. PROPERTY
  844. JAR_FILE
  845. ${_JAVA_JAR_OUTPUT_PATH}
  846. )
  847. set_property(
  848. TARGET
  849. ${_TARGET_NAME}
  850. PROPERTY
  851. CLASSDIR
  852. ${CMAKE_JAVA_CLASS_OUTPUT_PATH}
  853. )
  854. if (_GENERATE_NATIVE_HEADERS)
  855. # create an INTERFACE library encapsulating include directory for generated headers
  856. add_library (${_GENERATE_NATIVE_HEADERS_TARGET} INTERFACE)
  857. target_include_directories (${_GENERATE_NATIVE_HEADERS_TARGET} INTERFACE
  858. "${_GENERATE_NATIVE_HEADERS_OUTPUT_DESC}"
  859. ${JNI_INCLUDE_DIRS})
  860. set_property(TARGET ${_GENERATE_NATIVE_HEADERS_TARGET} PROPERTY NATIVE_HEADERS_DIRECTORY "${_GENERATE_NATIVE_HEADERS_OUTPUT_DIR}")
  861. # this INTERFACE library depends on jar generation
  862. add_dependencies (${_GENERATE_NATIVE_HEADERS_TARGET} ${_TARGET_NAME})
  863. set_property (DIRECTORY APPEND PROPERTY ADDITIONAL_CLEAN_FILES
  864. "${_GENERATE_NATIVE_HEADERS_OUTPUT_DIR}")
  865. endif()
  866. endfunction()
  867. function(INSTALL_JAR _TARGET_NAME)
  868. if (ARGC EQUAL 2)
  869. set (_DESTINATION ${ARGV1})
  870. else()
  871. cmake_parse_arguments(_install_jar
  872. ""
  873. "DESTINATION;COMPONENT"
  874. ""
  875. ${ARGN})
  876. if (_install_jar_DESTINATION)
  877. set (_DESTINATION ${_install_jar_DESTINATION})
  878. else()
  879. message(SEND_ERROR "install_jar: ${_TARGET_NAME}: DESTINATION must be specified.")
  880. endif()
  881. if (_install_jar_COMPONENT)
  882. set (_COMPONENT COMPONENT ${_install_jar_COMPONENT})
  883. endif()
  884. endif()
  885. get_property(__FILES
  886. TARGET
  887. ${_TARGET_NAME}
  888. PROPERTY
  889. INSTALL_FILES
  890. )
  891. set_property(
  892. TARGET
  893. ${_TARGET_NAME}
  894. PROPERTY
  895. INSTALL_DESTINATION
  896. ${_DESTINATION}
  897. )
  898. if (__FILES)
  899. install(
  900. FILES
  901. ${__FILES}
  902. DESTINATION
  903. ${_DESTINATION}
  904. ${_COMPONENT}
  905. )
  906. else ()
  907. message(SEND_ERROR "install_jar: The target ${_TARGET_NAME} is not known in this scope.")
  908. endif ()
  909. endfunction()
  910. function(INSTALL_JNI_SYMLINK _TARGET_NAME)
  911. if (ARGC EQUAL 2)
  912. set (_DESTINATION ${ARGV1})
  913. else()
  914. cmake_parse_arguments(_install_jni_symlink
  915. ""
  916. "DESTINATION;COMPONENT"
  917. ""
  918. ${ARGN})
  919. if (_install_jni_symlink_DESTINATION)
  920. set (_DESTINATION ${_install_jni_symlink_DESTINATION})
  921. else()
  922. message(SEND_ERROR "install_jni_symlink: ${_TARGET_NAME}: DESTINATION must be specified.")
  923. endif()
  924. if (_install_jni_symlink_COMPONENT)
  925. set (_COMPONENT COMPONENT ${_install_jni_symlink_COMPONENT})
  926. endif()
  927. endif()
  928. get_property(__SYMLINK
  929. TARGET
  930. ${_TARGET_NAME}
  931. PROPERTY
  932. JNI_SYMLINK
  933. )
  934. if (__SYMLINK)
  935. install(
  936. FILES
  937. ${__SYMLINK}
  938. DESTINATION
  939. ${_DESTINATION}
  940. ${_COMPONENT}
  941. )
  942. else ()
  943. message(SEND_ERROR "install_jni_symlink: The target ${_TARGET_NAME} is not known in this scope.")
  944. endif ()
  945. endfunction()
  946. function (find_jar VARIABLE)
  947. set(_jar_names)
  948. set(_jar_files)
  949. set(_jar_versions)
  950. set(_jar_paths
  951. /usr/share/java/
  952. /usr/local/share/java/
  953. ${Java_JAR_PATHS})
  954. set(_jar_doc "NOTSET")
  955. set(_state "name")
  956. foreach (arg IN LISTS ARGN)
  957. if (_state STREQUAL "name")
  958. if (arg STREQUAL "VERSIONS")
  959. set(_state "versions")
  960. elseif (arg STREQUAL "NAMES")
  961. set(_state "names")
  962. elseif (arg STREQUAL "PATHS")
  963. set(_state "paths")
  964. elseif (arg STREQUAL "DOC")
  965. set(_state "doc")
  966. else ()
  967. set(_jar_names ${arg})
  968. if (_jar_doc STREQUAL "NOTSET")
  969. set(_jar_doc "Finding ${arg} jar")
  970. endif ()
  971. endif ()
  972. elseif (_state STREQUAL "versions")
  973. if (arg STREQUAL "NAMES")
  974. set(_state "names")
  975. elseif (arg STREQUAL "PATHS")
  976. set(_state "paths")
  977. elseif (arg STREQUAL "DOC")
  978. set(_state "doc")
  979. else ()
  980. set(_jar_versions ${_jar_versions} ${arg})
  981. endif ()
  982. elseif (_state STREQUAL "names")
  983. if (arg STREQUAL "VERSIONS")
  984. set(_state "versions")
  985. elseif (arg STREQUAL "PATHS")
  986. set(_state "paths")
  987. elseif (arg STREQUAL "DOC")
  988. set(_state "doc")
  989. else ()
  990. set(_jar_names ${_jar_names} ${arg})
  991. if (_jar_doc STREQUAL "NOTSET")
  992. set(_jar_doc "Finding ${arg} jar")
  993. endif ()
  994. endif ()
  995. elseif (_state STREQUAL "paths")
  996. if (arg STREQUAL "VERSIONS")
  997. set(_state "versions")
  998. elseif (arg STREQUAL "NAMES")
  999. set(_state "names")
  1000. elseif (arg STREQUAL "DOC")
  1001. set(_state "doc")
  1002. else ()
  1003. set(_jar_paths ${_jar_paths} ${arg})
  1004. endif ()
  1005. elseif (_state STREQUAL "doc")
  1006. if (arg STREQUAL "VERSIONS")
  1007. set(_state "versions")
  1008. elseif (arg STREQUAL "NAMES")
  1009. set(_state "names")
  1010. elseif (arg STREQUAL "PATHS")
  1011. set(_state "paths")
  1012. else ()
  1013. set(_jar_doc ${arg})
  1014. endif ()
  1015. endif ()
  1016. endforeach ()
  1017. if (NOT _jar_names)
  1018. message(FATAL_ERROR "find_jar: No name to search for given")
  1019. endif ()
  1020. foreach (jar_name IN LISTS _jar_names)
  1021. foreach (version IN LISTS _jar_versions)
  1022. set(_jar_files ${_jar_files} ${jar_name}-${version}.jar)
  1023. endforeach ()
  1024. set(_jar_files ${_jar_files} ${jar_name}.jar)
  1025. endforeach ()
  1026. find_file(${VARIABLE}
  1027. NAMES ${_jar_files}
  1028. PATHS ${_jar_paths}
  1029. DOC ${_jar_doc}
  1030. NO_DEFAULT_PATH)
  1031. endfunction ()
  1032. function(create_javadoc _target)
  1033. set(_javadoc_packages)
  1034. set(_javadoc_files)
  1035. set(_javadoc_sourcepath)
  1036. set(_javadoc_classpath)
  1037. set(_javadoc_installpath "${CMAKE_INSTALL_PREFIX}/share/javadoc")
  1038. set(_javadoc_doctitle)
  1039. set(_javadoc_windowtitle)
  1040. set(_javadoc_author FALSE)
  1041. set(_javadoc_version FALSE)
  1042. set(_javadoc_use FALSE)
  1043. set(_state "package")
  1044. foreach (arg IN LISTS ARGN)
  1045. if (_state STREQUAL "package")
  1046. if (arg STREQUAL "PACKAGES")
  1047. set(_state "packages")
  1048. elseif (arg STREQUAL "FILES")
  1049. set(_state "files")
  1050. elseif (arg STREQUAL "SOURCEPATH")
  1051. set(_state "sourcepath")
  1052. elseif (arg STREQUAL "CLASSPATH")
  1053. set(_state "classpath")
  1054. elseif (arg STREQUAL "INSTALLPATH")
  1055. set(_state "installpath")
  1056. elseif (arg STREQUAL "DOCTITLE")
  1057. set(_state "doctitle")
  1058. elseif (arg STREQUAL "WINDOWTITLE")
  1059. set(_state "windowtitle")
  1060. elseif (arg STREQUAL "AUTHOR")
  1061. set(_state "author")
  1062. elseif (arg STREQUAL "USE")
  1063. set(_state "use")
  1064. elseif (arg STREQUAL "VERSION")
  1065. set(_state "version")
  1066. else ()
  1067. set(_javadoc_packages ${arg})
  1068. set(_state "packages")
  1069. endif ()
  1070. elseif (_state STREQUAL "packages")
  1071. if (arg STREQUAL "FILES")
  1072. set(_state "files")
  1073. elseif (arg STREQUAL "SOURCEPATH")
  1074. set(_state "sourcepath")
  1075. elseif (arg STREQUAL "CLASSPATH")
  1076. set(_state "classpath")
  1077. elseif (arg STREQUAL "INSTALLPATH")
  1078. set(_state "installpath")
  1079. elseif (arg STREQUAL "DOCTITLE")
  1080. set(_state "doctitle")
  1081. elseif (arg STREQUAL "WINDOWTITLE")
  1082. set(_state "windowtitle")
  1083. elseif (arg STREQUAL "AUTHOR")
  1084. set(_state "author")
  1085. elseif (arg STREQUAL "USE")
  1086. set(_state "use")
  1087. elseif (arg STREQUAL "VERSION")
  1088. set(_state "version")
  1089. else ()
  1090. list(APPEND _javadoc_packages ${arg})
  1091. endif ()
  1092. elseif (_state STREQUAL "files")
  1093. if (arg STREQUAL "PACKAGES")
  1094. set(_state "packages")
  1095. elseif (arg STREQUAL "SOURCEPATH")
  1096. set(_state "sourcepath")
  1097. elseif (arg STREQUAL "CLASSPATH")
  1098. set(_state "classpath")
  1099. elseif (arg STREQUAL "INSTALLPATH")
  1100. set(_state "installpath")
  1101. elseif (arg STREQUAL "DOCTITLE")
  1102. set(_state "doctitle")
  1103. elseif (arg STREQUAL "WINDOWTITLE")
  1104. set(_state "windowtitle")
  1105. elseif (arg STREQUAL "AUTHOR")
  1106. set(_state "author")
  1107. elseif (arg STREQUAL "USE")
  1108. set(_state "use")
  1109. elseif (arg STREQUAL "VERSION")
  1110. set(_state "version")
  1111. else ()
  1112. list(APPEND _javadoc_files ${arg})
  1113. endif ()
  1114. elseif (_state STREQUAL "sourcepath")
  1115. if (arg STREQUAL "PACKAGES")
  1116. set(_state "packages")
  1117. elseif (arg STREQUAL "FILES")
  1118. set(_state "files")
  1119. elseif (arg STREQUAL "CLASSPATH")
  1120. set(_state "classpath")
  1121. elseif (arg STREQUAL "INSTALLPATH")
  1122. set(_state "installpath")
  1123. elseif (arg STREQUAL "DOCTITLE")
  1124. set(_state "doctitle")
  1125. elseif (arg STREQUAL "WINDOWTITLE")
  1126. set(_state "windowtitle")
  1127. elseif (arg STREQUAL "AUTHOR")
  1128. set(_state "author")
  1129. elseif (arg STREQUAL "USE")
  1130. set(_state "use")
  1131. elseif (arg STREQUAL "VERSION")
  1132. set(_state "version")
  1133. else ()
  1134. list(APPEND _javadoc_sourcepath ${arg})
  1135. endif ()
  1136. elseif (_state STREQUAL "classpath")
  1137. if (arg STREQUAL "PACKAGES")
  1138. set(_state "packages")
  1139. elseif (arg STREQUAL "FILES")
  1140. set(_state "files")
  1141. elseif (arg STREQUAL "SOURCEPATH")
  1142. set(_state "sourcepath")
  1143. elseif (arg STREQUAL "INSTALLPATH")
  1144. set(_state "installpath")
  1145. elseif (arg STREQUAL "DOCTITLE")
  1146. set(_state "doctitle")
  1147. elseif (arg STREQUAL "WINDOWTITLE")
  1148. set(_state "windowtitle")
  1149. elseif (arg STREQUAL "AUTHOR")
  1150. set(_state "author")
  1151. elseif (arg STREQUAL "USE")
  1152. set(_state "use")
  1153. elseif (arg STREQUAL "VERSION")
  1154. set(_state "version")
  1155. else ()
  1156. list(APPEND _javadoc_classpath ${arg})
  1157. endif ()
  1158. elseif (_state STREQUAL "installpath")
  1159. if (arg STREQUAL "PACKAGES")
  1160. set(_state "packages")
  1161. elseif (arg STREQUAL "FILES")
  1162. set(_state "files")
  1163. elseif (arg STREQUAL "SOURCEPATH")
  1164. set(_state "sourcepath")
  1165. elseif (arg STREQUAL "DOCTITLE")
  1166. set(_state "doctitle")
  1167. elseif (arg STREQUAL "WINDOWTITLE")
  1168. set(_state "windowtitle")
  1169. elseif (arg STREQUAL "AUTHOR")
  1170. set(_state "author")
  1171. elseif (arg STREQUAL "USE")
  1172. set(_state "use")
  1173. elseif (arg STREQUAL "VERSION")
  1174. set(_state "version")
  1175. else ()
  1176. set(_javadoc_installpath ${arg})
  1177. endif ()
  1178. elseif (_state STREQUAL "doctitle")
  1179. if (${arg} STREQUAL "PACKAGES")
  1180. set(_state "packages")
  1181. elseif (arg STREQUAL "FILES")
  1182. set(_state "files")
  1183. elseif (arg STREQUAL "SOURCEPATH")
  1184. set(_state "sourcepath")
  1185. elseif (arg STREQUAL "INSTALLPATH")
  1186. set(_state "installpath")
  1187. elseif (arg STREQUAL "CLASSPATH")
  1188. set(_state "classpath")
  1189. elseif (arg STREQUAL "WINDOWTITLE")
  1190. set(_state "windowtitle")
  1191. elseif (arg STREQUAL "AUTHOR")
  1192. set(_state "author")
  1193. elseif (arg STREQUAL "USE")
  1194. set(_state "use")
  1195. elseif (arg STREQUAL "VERSION")
  1196. set(_state "version")
  1197. else ()
  1198. set(_javadoc_doctitle ${arg})
  1199. endif ()
  1200. elseif (_state STREQUAL "windowtitle")
  1201. if (${arg} STREQUAL "PACKAGES")
  1202. set(_state "packages")
  1203. elseif (arg STREQUAL "FILES")
  1204. set(_state "files")
  1205. elseif (arg STREQUAL "SOURCEPATH")
  1206. set(_state "sourcepath")
  1207. elseif (arg STREQUAL "CLASSPATH")
  1208. set(_state "classpath")
  1209. elseif (arg STREQUAL "INSTALLPATH")
  1210. set(_state "installpath")
  1211. elseif (arg STREQUAL "DOCTITLE")
  1212. set(_state "doctitle")
  1213. elseif (arg STREQUAL "AUTHOR")
  1214. set(_state "author")
  1215. elseif (arg STREQUAL "USE")
  1216. set(_state "use")
  1217. elseif (arg STREQUAL "VERSION")
  1218. set(_state "version")
  1219. else ()
  1220. set(_javadoc_windowtitle ${arg})
  1221. endif ()
  1222. elseif (_state STREQUAL "author")
  1223. if (arg STREQUAL "PACKAGES")
  1224. set(_state "packages")
  1225. elseif (arg STREQUAL "FILES")
  1226. set(_state "files")
  1227. elseif (arg STREQUAL "SOURCEPATH")
  1228. set(_state "sourcepath")
  1229. elseif (arg STREQUAL "CLASSPATH")
  1230. set(_state "classpath")
  1231. elseif (arg STREQUAL "INSTALLPATH")
  1232. set(_state "installpath")
  1233. elseif (arg STREQUAL "DOCTITLE")
  1234. set(_state "doctitle")
  1235. elseif (arg STREQUAL "WINDOWTITLE")
  1236. set(_state "windowtitle")
  1237. elseif (arg STREQUAL "AUTHOR")
  1238. set(_state "author")
  1239. elseif (arg STREQUAL "USE")
  1240. set(_state "use")
  1241. elseif (arg STREQUAL "VERSION")
  1242. set(_state "version")
  1243. else ()
  1244. set(_javadoc_author ${arg})
  1245. endif ()
  1246. elseif (_state STREQUAL "use")
  1247. if (arg STREQUAL "PACKAGES")
  1248. set(_state "packages")
  1249. elseif (arg STREQUAL "FILES")
  1250. set(_state "files")
  1251. elseif (arg STREQUAL "SOURCEPATH")
  1252. set(_state "sourcepath")
  1253. elseif (arg STREQUAL "CLASSPATH")
  1254. set(_state "classpath")
  1255. elseif (arg STREQUAL "INSTALLPATH")
  1256. set(_state "installpath")
  1257. elseif (arg STREQUAL "DOCTITLE")
  1258. set(_state "doctitle")
  1259. elseif (arg STREQUAL "WINDOWTITLE")
  1260. set(_state "windowtitle")
  1261. elseif (arg STREQUAL "AUTHOR")
  1262. set(_state "author")
  1263. elseif (arg STREQUAL "USE")
  1264. set(_state "use")
  1265. elseif (arg STREQUAL "VERSION")
  1266. set(_state "version")
  1267. else ()
  1268. set(_javadoc_use ${arg})
  1269. endif ()
  1270. elseif (_state STREQUAL "version")
  1271. if (arg STREQUAL "PACKAGES")
  1272. set(_state "packages")
  1273. elseif (arg STREQUAL "FILES")
  1274. set(_state "files")
  1275. elseif (arg STREQUAL "SOURCEPATH")
  1276. set(_state "sourcepath")
  1277. elseif (arg STREQUAL "CLASSPATH")
  1278. set(_state "classpath")
  1279. elseif (arg STREQUAL "INSTALLPATH")
  1280. set(_state "installpath")
  1281. elseif (arg STREQUAL "DOCTITLE")
  1282. set(_state "doctitle")
  1283. elseif (arg STREQUAL "WINDOWTITLE")
  1284. set(_state "windowtitle")
  1285. elseif (arg STREQUAL "AUTHOR")
  1286. set(_state "author")
  1287. elseif (arg STREQUAL "USE")
  1288. set(_state "use")
  1289. elseif (arg STREQUAL "VERSION")
  1290. set(_state "version")
  1291. else ()
  1292. set(_javadoc_version ${arg})
  1293. endif ()
  1294. endif ()
  1295. endforeach ()
  1296. set(_javadoc_builddir ${CMAKE_CURRENT_BINARY_DIR}/javadoc/${_target})
  1297. set(_javadoc_options -d ${_javadoc_builddir})
  1298. if (_javadoc_sourcepath)
  1299. list(JOIN _javadoc_sourcepath "${_UseJava_PATH_SEP}" _javadoc_sourcepath)
  1300. list(APPEND _javadoc_options -sourcepath "\"${_javadoc_sourcepath}\"")
  1301. endif ()
  1302. if (_javadoc_classpath)
  1303. list(JOIN _javadoc_classpath "${_UseJava_PATH_SEP}" _javadoc_classpath)
  1304. list(APPEND _javadoc_options -classpath "\"${_javadoc_classpath}\"")
  1305. endif ()
  1306. if (_javadoc_doctitle)
  1307. list(APPEND _javadoc_options -doctitle '${_javadoc_doctitle}')
  1308. endif ()
  1309. if (_javadoc_windowtitle)
  1310. list(APPEND _javadoc_options -windowtitle '${_javadoc_windowtitle}')
  1311. endif ()
  1312. if (_javadoc_author)
  1313. list(APPEND _javadoc_options -author)
  1314. endif ()
  1315. if (_javadoc_use)
  1316. list(APPEND _javadoc_options -use)
  1317. endif ()
  1318. if (_javadoc_version)
  1319. list(APPEND _javadoc_options -version)
  1320. endif ()
  1321. add_custom_target(${_target}_javadoc ALL
  1322. COMMAND ${Java_JAVADOC_EXECUTABLE}
  1323. ${_javadoc_options}
  1324. ${_javadoc_files}
  1325. ${_javadoc_packages}
  1326. WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  1327. )
  1328. install(
  1329. DIRECTORY ${_javadoc_builddir}
  1330. DESTINATION ${_javadoc_installpath}
  1331. )
  1332. endfunction()
  1333. function (create_javah)
  1334. if (Java_VERSION VERSION_GREATER_EQUAL 10)
  1335. message (FATAL_ERROR "create_javah: not supported with this Java version. Use add_jar(GENERATE_NATIVE_HEADERS) instead.")
  1336. elseif (Java_VERSION VERSION_GREATER_EQUAL 1.8)
  1337. message (DEPRECATION "create_javah: this command will no longer be supported starting with version 10 of JDK. Update your project by using command add_jar(GENERATE_NATIVE_HEADERS) instead.")
  1338. endif()
  1339. cmake_parse_arguments(_create_javah
  1340. ""
  1341. "TARGET;GENERATED_FILES;OUTPUT_NAME;OUTPUT_DIR"
  1342. "CLASSES;CLASSPATH;DEPENDS"
  1343. ${ARGN})
  1344. # check parameters
  1345. if (NOT _create_javah_TARGET AND NOT _create_javah_GENERATED_FILES)
  1346. message (FATAL_ERROR "create_javah: TARGET or GENERATED_FILES must be specified.")
  1347. endif()
  1348. if (_create_javah_OUTPUT_NAME AND _create_javah_OUTPUT_DIR)
  1349. message (FATAL_ERROR "create_javah: OUTPUT_NAME and OUTPUT_DIR are mutually exclusive.")
  1350. endif()
  1351. if (NOT _create_javah_CLASSES)
  1352. message (FATAL_ERROR "create_javah: CLASSES is a required parameter.")
  1353. endif()
  1354. set (_output_files)
  1355. # handle javah options
  1356. set (_javah_options)
  1357. if (_create_javah_CLASSPATH)
  1358. # CLASSPATH can specify directories, jar files or targets created with add_jar command
  1359. set (_classpath)
  1360. foreach (_path IN LISTS _create_javah_CLASSPATH)
  1361. if (TARGET ${_path})
  1362. get_target_property (_jar_path ${_path} JAR_FILE)
  1363. if (_jar_path)
  1364. list (APPEND _classpath "${_jar_path}")
  1365. list (APPEND _create_javah_DEPENDS "${_path}")
  1366. else()
  1367. message(SEND_ERROR "create_javah: CLASSPATH target ${_path} is not a jar.")
  1368. endif()
  1369. elseif (EXISTS "${_path}")
  1370. list (APPEND _classpath "${_path}")
  1371. if (NOT IS_DIRECTORY "${_path}")
  1372. list (APPEND _create_javah_DEPENDS "${_path}")
  1373. endif()
  1374. else()
  1375. message(SEND_ERROR "create_javah: CLASSPATH entry ${_path} does not exist.")
  1376. endif()
  1377. endforeach()
  1378. string (REPLACE ";" "${_UseJava_PATH_SEP}" _classpath "${_classpath}")
  1379. list (APPEND _javah_options -classpath "${_classpath}")
  1380. endif()
  1381. if (_create_javah_OUTPUT_DIR)
  1382. list (APPEND _javah_options -d "${_create_javah_OUTPUT_DIR}")
  1383. endif()
  1384. if (_create_javah_OUTPUT_NAME)
  1385. list (APPEND _javah_options -o "${_create_javah_OUTPUT_NAME}")
  1386. set (_output_files "${_create_javah_OUTPUT_NAME}")
  1387. get_filename_component (_create_javah_OUTPUT_DIR "${_create_javah_OUTPUT_NAME}" DIRECTORY)
  1388. get_filename_component (_create_javah_OUTPUT_DIR "${_create_javah_OUTPUT_DIR}" ABSOLUTE)
  1389. endif()
  1390. if (NOT _create_javah_OUTPUT_DIR)
  1391. set (_create_javah_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}")
  1392. endif()
  1393. if (NOT _create_javah_OUTPUT_NAME)
  1394. # compute output names
  1395. foreach (_class IN LISTS _create_javah_CLASSES)
  1396. string (REPLACE "." "_" _c_header "${_class}")
  1397. set (_c_header "${_create_javah_OUTPUT_DIR}/${_c_header}.h")
  1398. list (APPEND _output_files "${_c_header}")
  1399. endforeach()
  1400. endif()
  1401. # finalize custom command arguments
  1402. if (_create_javah_DEPENDS)
  1403. list (INSERT _create_javah_DEPENDS 0 DEPENDS)
  1404. endif()
  1405. add_custom_command (OUTPUT ${_output_files}
  1406. COMMAND "${Java_JAVAH_EXECUTABLE}" ${_javah_options} -jni ${_create_javah_CLASSES}
  1407. ${_create_javah_DEPENDS}
  1408. WORKING_DIRECTORY ${_create_javah_OUTPUT_DIR}
  1409. COMMENT "Building C header files from classes...")
  1410. if (_create_javah_TARGET)
  1411. add_custom_target (${_create_javah_TARGET} ALL DEPENDS ${_output_files})
  1412. endif()
  1413. if (_create_javah_GENERATED_FILES)
  1414. set (${_create_javah_GENERATED_FILES} ${_output_files} PARENT_SCOPE)
  1415. endif()
  1416. endfunction()
  1417. function(export_jars)
  1418. # Parse and validate arguments
  1419. cmake_parse_arguments(_export_jars
  1420. ""
  1421. "FILE;NAMESPACE"
  1422. "TARGETS"
  1423. ${ARGN}
  1424. )
  1425. if (NOT _export_jars_FILE)
  1426. message(SEND_ERROR "export_jars: FILE must be specified.")
  1427. endif()
  1428. if (NOT _export_jars_TARGETS)
  1429. message(SEND_ERROR "export_jars: TARGETS must be specified.")
  1430. endif()
  1431. set(_jar_NAMESPACE "${_export_jars_NAMESPACE}")
  1432. # Set content of generated exports file
  1433. string(REPLACE ";" " " __targets__ "${_export_jars_TARGETS}")
  1434. set(__targetdefs__ "")
  1435. foreach(_target IN LISTS _export_jars_TARGETS)
  1436. get_target_property(_jarpath ${_target} JAR_FILE)
  1437. get_filename_component(_jarpath ${_jarpath} PATH)
  1438. __java_export_jar(__targetdefs__ ${_target} "${_jarpath}")
  1439. endforeach()
  1440. # Generate exports file
  1441. configure_file(
  1442. ${_JAVA_EXPORT_TARGETS_SCRIPT}
  1443. ${_export_jars_FILE}
  1444. @ONLY
  1445. )
  1446. endfunction()
  1447. function(install_jar_exports)
  1448. # Parse and validate arguments
  1449. cmake_parse_arguments(_install_jar_exports
  1450. ""
  1451. "FILE;DESTINATION;COMPONENT;NAMESPACE"
  1452. "TARGETS"
  1453. ${ARGN}
  1454. )
  1455. if (NOT _install_jar_exports_FILE)
  1456. message(SEND_ERROR "install_jar_exports: FILE must be specified.")
  1457. endif()
  1458. if (NOT _install_jar_exports_DESTINATION)
  1459. message(SEND_ERROR "install_jar_exports: DESTINATION must be specified.")
  1460. endif()
  1461. if (NOT _install_jar_exports_TARGETS)
  1462. message(SEND_ERROR "install_jar_exports: TARGETS must be specified.")
  1463. endif()
  1464. set(_jar_NAMESPACE "${_install_jar_exports_NAMESPACE}")
  1465. if (_install_jar_exports_COMPONENT)
  1466. set (_COMPONENT COMPONENT ${_install_jar_exports_COMPONENT})
  1467. endif()
  1468. # Determine relative path from installed export file to install prefix
  1469. if(IS_ABSOLUTE "${_install_jar_exports_DESTINATION}")
  1470. file(RELATIVE_PATH _relpath
  1471. ${_install_jar_exports_DESTINATION}
  1472. ${CMAKE_INSTALL_PREFIX}
  1473. )
  1474. else()
  1475. file(RELATIVE_PATH _relpath
  1476. ${CMAKE_INSTALL_PREFIX}/${_install_jar_exports_DESTINATION}
  1477. ${CMAKE_INSTALL_PREFIX}
  1478. )
  1479. endif()
  1480. # Set up unique location for generated exports file
  1481. string(SHA256 _hash "${_install_jar_exports_DESTINATION}")
  1482. set(_tmpdir ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/JavaExports/${_hash})
  1483. # Set content of generated exports file
  1484. string(REPLACE ";" " " __targets__ "${_install_jar_exports_TARGETS}")
  1485. set(__targetdefs__ "set(_prefix \${CMAKE_CURRENT_LIST_DIR}/${_relpath})\n\n")
  1486. foreach(_target IN LISTS _install_jar_exports_TARGETS)
  1487. get_target_property(_dir ${_target} INSTALL_DESTINATION)
  1488. __java_export_jar(__targetdefs__ ${_target} "\${_prefix}/${_dir}")
  1489. endforeach()
  1490. __java_lcat(__targetdefs__ "\nunset(_prefix)")
  1491. # Generate and install exports file
  1492. configure_file(
  1493. ${_JAVA_EXPORT_TARGETS_SCRIPT}
  1494. ${_tmpdir}/${_install_jar_exports_FILE}
  1495. @ONLY
  1496. )
  1497. install(FILES ${_tmpdir}/${_install_jar_exports_FILE}
  1498. DESTINATION ${_install_jar_exports_DESTINATION}
  1499. ${_COMPONENT})
  1500. endfunction()
  1501. endblock()