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
|
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
FindHTMLHelp
------------
Finds the Microsoft HTML Help Compiler and its API which is part of the HTML
Help Workshop:
.. code-block:: cmake
find_package(HTMLHelp [...])
.. note::
HTML Help Workshop is in maintenance mode only and is considered deprecated.
For modern documentation, consider alternatives such as Microsoft Help Viewer
for producing ``.mshc`` files or web-based documentation tools.
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``HTMLHelp_FOUND``
.. versionadded:: 4.2
Boolean indicating whether HTML Help was found.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
``HTML_HELP_COMPILER``
Full path to the HTML Help Compiler (``hhc.exe``), used to compile ``.chm``
files.
``HTML_HELP_INCLUDE_PATH``
Directory containing ``htmlhelp.h``, required for applications integrating the
HTML Help API.
``HTML_HELP_LIBRARY``
Full path to ``htmlhelp.lib`` library, required for linking applications that
use the HTML Help API.
Examples
^^^^^^^^
Finding HTML Help Compiler:
.. code-block:: cmake
find_package(HTMLHelp)
message(STATUS "HTML Help Compiler found at: ${HTML_HELP_COMPILER}")
#]=======================================================================]
if(WIN32)
find_program(HTML_HELP_COMPILER
NAMES hhc
PATHS
"[HKEY_CURRENT_USER\\Software\\Microsoft\\HTML Help Workshop;InstallDir]"
PATH_SUFFIXES "HTML Help Workshop"
)
get_filename_component(HTML_HELP_COMPILER_PATH "${HTML_HELP_COMPILER}" PATH)
find_path(HTML_HELP_INCLUDE_PATH
NAMES htmlhelp.h
PATHS
"${HTML_HELP_COMPILER_PATH}/include"
"[HKEY_CURRENT_USER\\Software\\Microsoft\\HTML Help Workshop;InstallDir]/include"
PATH_SUFFIXES "HTML Help Workshop/include"
)
find_library(HTML_HELP_LIBRARY
NAMES htmlhelp
PATHS
"${HTML_HELP_COMPILER_PATH}/lib"
"[HKEY_CURRENT_USER\\Software\\Microsoft\\HTML Help Workshop;InstallDir]/lib"
PATH_SUFFIXES "HTML Help Workshop/lib"
)
mark_as_advanced(
HTML_HELP_COMPILER
HTML_HELP_INCLUDE_PATH
HTML_HELP_LIBRARY
)
endif()
if(HTML_HELP_COMPILER AND HTML_HELP_INCLUDE_PATH AND HTML_HELP_LIBRARY)
set(HTMLHelp_FOUND TRUE)
else()
set(HTMLHelp_FOUND FALSE)
endif()
|
