CMake: Migrate to hhc.cmake.

Remove FindHHC.cmake in favor of CMake's FindHTMLHelp. Remove the
hhc.cmd wrapper.

Change-Id: I548e58d2264c74596e9067d5053b056c35089b3c
Reviewed-on: https://code.wireshark.org/review/6449
Reviewed-by: Gerald Combs <gerald@wireshark.org>

Makefile.am

@@ -1215,24 +1215,21 @@ EXTRA_DIST = \
 	wiretap/CMakeLists.txt	\
 	README.cmake		\
 	ConfigureChecks.cmake	\
-	cmake/TestFileOffsetBits.c	\
-	cmake/TestLargeFiles.c.cmakein	\
-	cmake/TestWindowsFSeek.c	\
-	cmake/modules/CMakeInstallDirs.cmake	\
-	cmake/modules/COPYING-CMAKE-SCRIPTS	\
 	cmake/modules/CheckCCompilerFlag.cmake	\
 	cmake/modules/CheckCLinkerFlag.cmake	\
+	cmake/modules/CMakeInstallDirs.cmake	\
+	cmake/modules/COPYING-CMAKE-SCRIPTS	\
 	cmake/modules/FindADNS.cmake		\
 	cmake/modules/FindAIRPCAP.cmake		\
 	cmake/modules/FindASCIIDOC.cmake	\
 	cmake/modules/FindCAP.cmake		\
 	cmake/modules/FindCARES.cmake		\
-	cmake/modules/FindFOP.cmake		\
-	cmake/modules/FindGCRYPT.cmake		\
-	cmake/modules/FindGEOIP.cmake		\
 	cmake/modules/FindChocolatey.cmake	\
 	cmake/modules/FindDOXYGEN.cmake		\
+	cmake/modules/FindFOP.cmake		\
 	cmake/modules/FindFreetype.cmake	\
+	cmake/modules/FindGCRYPT.cmake		\
+	cmake/modules/FindGEOIP.cmake		\
 	cmake/modules/FindGLIB2.cmake		\
 	cmake/modules/FindGMODULE2.cmake	\
 	cmake/modules/FindGNUTLS.cmake		\
@@ -1241,11 +1238,11 @@ EXTRA_DIST = \
 	cmake/modules/FindGTK3.cmake		\
 	cmake/modules/FindHtmlViewer.cmake	\
 	cmake/modules/FindKERBEROS.cmake	\
-	cmake/modules/FindNL.cmake		\
 	cmake/modules/FindLEX.cmake		\
 	cmake/modules/FindLUA.cmake		\
 	cmake/modules/FindLYNX.cmake		\
 	cmake/modules/FindM.cmake		\
+	cmake/modules/FindNL.cmake		\
 	cmake/modules/FindOS_X_FRAMEWORKS.cmake	\
 	cmake/modules/FindPCAP.cmake		\
 	cmake/modules/FindPOD.cmake		\
@@ -1262,8 +1259,11 @@ EXTRA_DIST = \
 	cmake/modules/FindYACC.cmake		\
 	cmake/modules/FindYAPP.cmake		\
 	cmake/modules/FindZLIB.cmake		\
+	cmake/modules/gmxTestLargeFiles.cmake	\
+	cmake/modules/hhc.cmake	\
 	cmake/modules/LICENSE.txt		\
 	cmake/modules/LocatePythonModule.cmake	\
+	cmake/modules/readme.txt		\
 	cmake/modules/UseABICheck.cmake		\
 	cmake/modules/UseAsn2Wrs.cmake		\
 	cmake/modules/UseCheckAPI.cmake		\
@@ -1273,8 +1273,9 @@ EXTRA_DIST = \
 	cmake/modules/UseWinLibs.cmake		\
 	cmake/modules/WiresharkConfig.cmake.in	\
 	cmake/modules/WiresharkConfigVersion.cmake.in \
-	cmake/modules/gmxTestLargeFiles.cmake	\
-	cmake/modules/readme.txt		\
+	cmake/TestFileOffsetBits.c	\
+	cmake/TestLargeFiles.c.cmakein	\
+	cmake/TestWindowsFSeek.c	\
 	ui/win32/Makefile.nmake			\
 	ui/win32/console_win32.c		\
 	ui/win32/console_win32.h		\

cmake/modules/FindHHC.cmake

@@ -1,26 +0,0 @@
-#
-# - Find the Microsoft HTML Help compiler.
-# Sets HHC_EXECUTABLE to the path to hhc.exe
-# Sets HHC_WRAPPER to a wrapper script that ignores hhc.exe's return value.
-#
-
-find_package(HTMLHelp)
-set(HHC_EXECUTABLE ${HTML_HELP_COMPILER})
-
-include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args(HHC DEFAULT_MSG HHC_EXECUTABLE)
-
-mark_as_advanced(HHC_EXECUTABLE)
-
-if(WIN32)
-  # hhc.exe returns 1 on success. Create a wrapper script that ignores
-  # this.
-  set(HHC_WRAPPER ${CMAKE_BINARY_DIR}/tools/hhc.cmd)
-  file(TO_NATIVE_PATH "${HHC_EXECUTABLE}" HHC_EXECUTABLE_NATIVE_WINDOWS_PATH)
-  configure_file(${CMAKE_SOURCE_DIR}/tools/hhc.cmd.in
-    ${HHC_WRAPPER}
-    NEWLINE_STYLE WIN32
-  )
-  find_package_handle_standard_args(HHC DEFAULT_MSG HHC_WRAPPER)
-  mark_as_advanced(HHC_WRAPPER)
-endif()

cmake/modules/FindXSLTPROC.cmake

@@ -187,6 +187,7 @@ MACRO(XML2HHP _guide _docbooksource)
 	COMMAND ${CMAKE_COMMAND} -E make_directory ${_basedir}/${_gfxdir}
 	COMMAND ${CMAKE_COMMAND} -E copy_directory ${_gfxdir} ${_basedir}/${_gfxdir}
 	COMMAND ${CMAKE_COMMAND} -E copy_directory common_graphics ${_basedir}
+	# HTML Help doesn't render decimal character entities in the title.
 	COMMAND ${SED_EXECUTABLE}
 	    -e "s|er&#8217;s Guide</title>|er's Guide</title>|"
 	    < ${_docbooksource}
@@ -202,6 +203,9 @@ MACRO(XML2HHP _guide _docbooksource)
 	    --nonet custom_layer_chm.xsl
 	    ${_docbook_plain_title}
         DEPENDS
+	    # AsciiDoc uses UTF-8 by default, which is unsupported by HTML
+	    # Help. We may want to render an ISO-8859-1 version, or get rid
+	    # of HTML Help.
             ${_docbooksource}
     )
 ENDMACRO(XML2HHP)

cmake/modules/hhc.cmake

@@ -1,9 +1,12 @@
 # hhc.exe returns 1 on success - which cmake instprets as failure in case
 #  of add_custom_command.
 
-# Params 0,1 and 2 are "cmake -P hhc.cmake"
-set(_param ${CMAKE_ARGV3})
+# Params are
+#   cmake -P /path/to/hhc.cmake "/path/to/hhc.exe" project.hhp
+set(_hhc_executable ${CMAKE_ARGV3})
+set(_project_file ${CMAKE_ARGV4})
 
-EXECUTE_PROCESS(
-  COMMAND ${HHC_EXECUTABLE} ${_param}
+execute_process(
+  COMMAND ${_hhc_executable} ${_project_file}
+  RESULT_VARIABLE _return_code
 )

docbook/CMakeLists.txt

@@ -23,27 +23,30 @@ find_package( FOP ) # Call before XSLTPROC
 find_package( LYNX )
 find_package( XSLTPROC )
 find_package( XMLLINT )
-find_package( HHC )
+find_package( HTMLHelp )
 
 find_package( ASCIIDOC )
 
 if(WIN32)
-	MACRO( HHP2CHM _hhpsource )
-		GET_FILENAME_COMPONENT( _source_base_name ${_hhpsource} NAME_WE )
+	macro( HHP2CHM _hhpsource )
+		get_filename_component( _source_base_name ${_hhpsource} NAME_WE )
 
-		ADD_CUSTOM_COMMAND(
+		add_custom_command(
 			OUTPUT ${_output_chm}
 			WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-			# hhc.exe returns 1 on success.
-			COMMAND ${HHC_WRAPPER} ${_hhpsource}
+			# The number and order of arguments MUST match hhc.cmake.
+			COMMAND ${CMAKE_COMMAND} -P
+				${CMAKE_SOURCE_DIR}/cmake/modules/hhc.cmake
+					"${HTML_HELP_COMPILER}"
+					${_hhpsource}
 			DEPENDS
 				${_hhpsource}
 		)
-	ENDMACRO()
+	endmacro()
 else()
-	MACRO( HHP2CHM _hhpsource )
+	macro( HHP2CHM _hhpsource )
 	# Dummy.
-	ENDMACRO()
+	endmacro()
 endif()
 
 set(COMMON_GRAPHICS

tools/Makefile.am

@@ -138,7 +138,6 @@ EXTRA_DIST = \
 	gen-bugnote					\
 	git-compare-abis.sh				\
 	git-export-release.sh				\
-	hhc.cmd.in					\
 	html2text.py					\
 	idl2deb						\
 	idl2wrs						\

tools/hhc.cmd.in

@@ -1,6 +0,0 @@
-@echo off
-"@HHC_EXECUTABLE_NATIVE_WINDOWS_PATH@" %*
-echo hhc.exe returned %errorlevel%
-
-cmd /c exit 0
-echo We are returning %errorlevel%