165acc4f3e
- Consolidated all output string definitions enums into `tidyenum.h`, which is where they belong, and where they have proper visibility. - Re-arranged `messages.c/h` with several comments useful to developers. - Properly added the key lookup functions and the language localization functions into tidy.h/tidylib.c with proper name-spacing. - Previous point restored a *lot* of sanity to the #include pollution that's been introduced in light of these. - Note that opaque types have been (properly) introduced. Look at the updated headers for `language.h`. In particular only an opaque structure is passed outside of LibTidy, and so use TidyLangWindowsName and TidyLangPosixName to poll these objects. - Console application updated as a result of this. - Removed dead code: - void TY_(UnknownOption)( TidyDocImpl* doc, char c ); - void TY_(UnknownFile)( TidyDocImpl* doc, ctmbstr program, ctmbstr file ); - Redundant strings were removed with the removal of this dead code. - Several enums were given fixed starting values. YOUR PROGRAMS SHOULD NEVER depend on enum values. `TidyReportLevel` is an example of such. - Some enums were removed as a result of this. `TidyReportLevel` now has matching strings, so the redundant `TidyReportLevelStrings` was removed. - All of the PO's and language header files were regenerated as a result of the string cleanup and header cleanup. - Made the interface to the library version and release date consistent. - CMakeLists.txt now supports SUPPORT_CONSOLE_APP. The intention is to be able to remove console-only code from LibTidy (for LibTidy users). - Updated README/MESSAGES.md, which is *vastly* more simple now.
369 lines
14 KiB
CMake
369 lines
14 KiB
CMake
# CMakeLists.txt - 20150402 - 20150130 - 20140801 - for github htacg/tidy-html5
|
|
# Prepare for changing the name to 'tidy'
|
|
cmake_minimum_required (VERSION 2.8.7)
|
|
|
|
set(LIB_NAME tidy)
|
|
|
|
project (${LIB_NAME})
|
|
|
|
# ### NOTE: *** Adjust version.txt when required ***
|
|
# read 'version' file into a variable (stripping any newlines or spaces)
|
|
# 20150609: Revert to supplying BOTH version and date, as we had back in Jan 2015
|
|
# NOTE: Both version and date MUST be DOT separated, in two lines.
|
|
file(READ version.txt versionFile)
|
|
if (NOT versionFile)
|
|
message(FATAL_ERROR "Unable to determine libtidy version. version.txt file is missing.")
|
|
endif()
|
|
string(STRIP "${versionFile}" VERSION_TEXT)
|
|
string(REGEX REPLACE "(.*)[\r\n|\n](.*)" "\\1" LIBTIDY_VERSION ${VERSION_TEXT})
|
|
string(REGEX REPLACE "(.*)[\r\n|\n](.*)" "\\2" LIBTIDY_DATE ${VERSION_TEXT})
|
|
# establish version number
|
|
if (LIBTIDY_VERSION)
|
|
string(REPLACE "." ";" VERSION_LIST ${LIBTIDY_VERSION})
|
|
list(GET VERSION_LIST 0 TIDY_MAJOR_VERSION)
|
|
list(GET VERSION_LIST 1 TIDY_MINOR_VERSION)
|
|
list(GET VERSION_LIST 2 TIDY_POINT_VERSION)
|
|
else ()
|
|
message(FATAL_ERROR "*** FAILED to get a VERSION from version.txt!")
|
|
endif ()
|
|
# establish version date
|
|
if (LIBTIDY_DATE)
|
|
string(REPLACE "." ";" DATE_LIST ${LIBTIDY_DATE})
|
|
list(GET DATE_LIST 0 tidy_YEAR)
|
|
list(GET DATE_LIST 1 tidy_MONTH)
|
|
list(GET DATE_LIST 2 tidy_DAY)
|
|
else ()
|
|
message(FATAL_ERROR "*** FAILED to get a DATE from version.txt!")
|
|
endif ()
|
|
|
|
# By default, BOTH library types built, Allow turning OFF shared if not needed
|
|
set( LIB_TYPE STATIC ) # set default message
|
|
option( BUILD_SHARED_LIB "Set OFF to NOT build shared library" ON )
|
|
option( BUILD_TAB2SPACE "Set ON to build utility app, tab2space" OFF )
|
|
option( BUILD_SAMPLE_CODE "Set ON to build the sample code" OFF )
|
|
if (NOT MAN_INSTALL_DIR)
|
|
set(MAN_INSTALL_DIR share/man/man1)
|
|
endif ()
|
|
# Issue #326 - Allow linkage choice of console app tidy
|
|
option( TIDY_CONSOLE_SHARED "Set ON to link with shared(DLL) lib." OFF )
|
|
if (TIDY_CONSOLE_SHARED)
|
|
if (NOT BUILD_SHARED_LIB)
|
|
message(FATAL_ERROR "Enable shared build for this tidy linkage!")
|
|
endif ()
|
|
endif ()
|
|
|
|
# Allow building without extra language support
|
|
option( SUPPORT_LOCALIZATIONS "Set OFF to build without additional languages." ON )
|
|
if (SUPPORT_LOCALIZATIONS)
|
|
add_definitions ( -DSUPPORT_LOCALIZATIONS=1 )
|
|
else ()
|
|
add_definitions ( -DSUPPORT_LOCALIZATIONS=0 )
|
|
endif ()
|
|
|
|
# Allow building without console support, which mostly prevents console strings
|
|
# from existing in the library. Note that this will prevent the console
|
|
# application from being built, since it can't be linked.
|
|
option( SUPPORT_CONSOLE_APP "Set OFF to libraries only without console application support." ON )
|
|
if (SUPPORT_CONSOLE_APP)
|
|
add_definitions ( -DSUPPORT_CONSOLE_APP=1 )
|
|
else ()
|
|
add_definitions ( -DSUPPORT_CONSOLE_APP=0 )
|
|
endif ()
|
|
|
|
if(CMAKE_COMPILER_IS_GNUCXX)
|
|
set( WARNING_FLAGS -Wall )
|
|
endif(CMAKE_COMPILER_IS_GNUCXX)
|
|
|
|
if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
|
|
set( WARNING_FLAGS "-Wall -Wno-overloaded-virtual" )
|
|
endif()
|
|
|
|
if(WIN32 AND MSVC)
|
|
# turn off various warnings
|
|
set(WARNING_FLAGS "${WARNING_FLAGS} /wd4996")
|
|
# C4090: 'function' : different 'const' qualifiers
|
|
# C4244: '=' : conversion from '__int64' to 'uint', possible loss of data
|
|
# C4267: 'function' : conversion from 'size_t' to 'uint', possible loss of data
|
|
# foreach(warning 4244 4251 4267 4275 4290 4786 4305)
|
|
foreach(warning 4090 4244 4267)
|
|
set(WARNING_FLAGS "${WARNING_FLAGS} /wd${warning}")
|
|
endforeach()
|
|
set( MSVC_FLAGS "-DNOMINMAX -D_USE_MATH_DEFINES -D_CRT_SECURE_NO_WARNINGS -D_SCL_SECURE_NO_WARNINGS -D__CRT_NONSTDC_NO_WARNINGS" )
|
|
# if (${MSVC_VERSION} EQUAL 1600)
|
|
# set( MSVC_LD_FLAGS "/FORCE:MULTIPLE" )
|
|
# endif (${MSVC_VERSION} EQUAL 1600)
|
|
# set( NOMINMAX 1 )
|
|
# to distinguish between debug and release lib in windows
|
|
set( CMAKE_DEBUG_POSTFIX "d" ) # little effect in unix
|
|
else()
|
|
# add any gcc flags
|
|
endif()
|
|
|
|
set( CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS} ${MSVC_FLAGS} -D_REENTRANT" )
|
|
set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS} ${MSVC_FLAGS} -D_REENTRANT" )
|
|
set( CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${MSVC_LD_FLAGS}" )
|
|
|
|
add_definitions ( -DHAVE_CONFIG_H )
|
|
add_definitions ( -DSUPPORT_UTF16_ENCODINGS=1 )
|
|
add_definitions ( -DSUPPORT_ASIAN_ENCODINGS=1 )
|
|
add_definitions ( -DSUPPORT_ACCESSIBILITY_CHECKS=1 )
|
|
add_definitions ( -DLIBTIDY_VERSION="${LIBTIDY_VERSION}" )
|
|
add_definitions ( -DRELEASE_DATE="${tidy_YEAR}/${tidy_MONTH}/${tidy_DAY}" )
|
|
### add_definitions ( -DRC_NUMBER="MinGW" )
|
|
|
|
# Issue #188 - Support user items in platform.h
|
|
if (TIDY_CONFIG_FILE)
|
|
add_definitions( -DTIDY_CONFIG_FILE="${TIDY_CONFIG_FILE}" )
|
|
endif ()
|
|
if (TIDY_USER_CONFIG_FILE)
|
|
add_definitions( -DTIDY_USER_CONFIG_FILE="${TIDY_USER_CONFIG_FILE}" )
|
|
endif ()
|
|
if (SUPPORT_GETPWNAM)
|
|
add_definitions( -DSUPPORT_GETPWNAM=1 )
|
|
endif ()
|
|
|
|
if(BUILD_SHARED_LIB)
|
|
set(LIB_TYPE SHARED)
|
|
message(STATUS "*** Also building DLL library ${LIB_TYPE}, version ${LIBTIDY_VERSION}, date ${LIBTIDY_DATE}")
|
|
else()
|
|
message(STATUS "*** Only building static library ${LIB_TYPE}, version ${LIBTIDY_VERSION}, date ${LIBTIDY_DATE}")
|
|
endif()
|
|
|
|
include_directories ( "${PROJECT_SOURCE_DIR}/include" "${PROJECT_SOURCE_DIR}/src" )
|
|
|
|
##############################################################################
|
|
### tidy library
|
|
# file locations
|
|
set ( SRCDIR src )
|
|
set ( INCDIR include )
|
|
# file lists
|
|
set ( CFILES
|
|
${SRCDIR}/access.c ${SRCDIR}/attrs.c ${SRCDIR}/istack.c
|
|
${SRCDIR}/parser.c ${SRCDIR}/tags.c ${SRCDIR}/entities.c
|
|
${SRCDIR}/lexer.c ${SRCDIR}/pprint.c ${SRCDIR}/charsets.c ${SRCDIR}/clean.c
|
|
${SRCDIR}/message.c ${SRCDIR}/config.c ${SRCDIR}/alloc.c
|
|
${SRCDIR}/attrask.c ${SRCDIR}/attrdict.c ${SRCDIR}/attrget.c
|
|
${SRCDIR}/buffio.c ${SRCDIR}/fileio.c ${SRCDIR}/streamio.c
|
|
${SRCDIR}/tagask.c ${SRCDIR}/tmbstr.c ${SRCDIR}/utf8.c
|
|
${SRCDIR}/tidylib.c ${SRCDIR}/mappedio.c ${SRCDIR}/gdoc.c
|
|
${SRCDIR}/language.c )
|
|
set ( HFILES
|
|
${INCDIR}/tidyplatform.h ${INCDIR}/tidy.h ${INCDIR}/tidyenum.h
|
|
${INCDIR}/tidybuffio.h )
|
|
|
|
option (TIDY_COMPAT_HEADERS "If set to ON, compatability headers are included" OFF)
|
|
if (TIDY_COMPAT_HEADERS)
|
|
set ( HFILES ${HFILES} ${INCDIR}/buffio.h ${INCDIR}/platform.h )
|
|
endif ()
|
|
|
|
set ( LIBHFILES
|
|
${SRCDIR}/access.h ${SRCDIR}/attrs.h ${SRCDIR}/attrdict.h ${SRCDIR}/charsets.h
|
|
${SRCDIR}/clean.h ${SRCDIR}/config.h ${SRCDIR}/entities.h
|
|
${SRCDIR}/fileio.h ${SRCDIR}/forward.h ${SRCDIR}/lexer.h
|
|
${SRCDIR}/mappedio.h ${SRCDIR}/message.h ${SRCDIR}/parser.h
|
|
${SRCDIR}/pprint.h ${SRCDIR}/streamio.h ${SRCDIR}/tags.h
|
|
${SRCDIR}/tmbstr.h ${SRCDIR}/utf8.h ${SRCDIR}/tidy-int.h
|
|
${SRCDIR}/version.h ${SRCDIR}/gdoc.h ${SRCDIR}/language.h
|
|
${SRCDIR}/language_en.h ${SRCDIR}/win32tc.h )
|
|
if (MSVC)
|
|
list(APPEND CFILES ${SRCDIR}/sprtf.c)
|
|
list(APPEND LIBHFILES ${SRCDIR}/sprtf.h)
|
|
endif ()
|
|
#######################################
|
|
|
|
if (NOT LIB_INSTALL_DIR)
|
|
set(LIB_INSTALL_DIR lib${LIB_SUFFIX})
|
|
endif ()
|
|
|
|
if (NOT BIN_INSTALL_DIR)
|
|
set(BIN_INSTALL_DIR bin)
|
|
endif ()
|
|
|
|
if (NOT INCLUDE_INSTALL_DIR)
|
|
set(INCLUDE_INSTALL_DIR include)
|
|
endif ()
|
|
|
|
# Always build the STATIC library
|
|
set(name tidy-static)
|
|
add_library ( ${name} STATIC ${CFILES} ${HFILES} ${LIBHFILES} )
|
|
set_target_properties( ${name} PROPERTIES
|
|
OUTPUT_NAME ${LIB_NAME}s
|
|
)
|
|
if (NOT TIDY_CONSOLE_SHARED) # user wants default static linkage
|
|
list ( APPEND add_LIBS ${name} )
|
|
endif ()
|
|
install(TARGETS ${name}
|
|
RUNTIME DESTINATION ${BIN_INSTALL_DIR}
|
|
ARCHIVE DESTINATION ${LIB_INSTALL_DIR}
|
|
LIBRARY DESTINATION ${LIB_INSTALL_DIR}
|
|
)
|
|
install( FILES ${HFILES} DESTINATION ${INCLUDE_INSTALL_DIR} )
|
|
########################################
|
|
# if user option still on
|
|
if (BUILD_SHARED_LIB)
|
|
set(name tidy-share)
|
|
add_library ( ${name} SHARED ${CFILES} ${HFILES} ${LIBHFILES} )
|
|
set_target_properties( ${name} PROPERTIES
|
|
OUTPUT_NAME ${LIB_NAME} )
|
|
set_target_properties( ${name} PROPERTIES
|
|
VERSION ${LIBTIDY_VERSION}
|
|
SOVERSION ${TIDY_MAJOR_VERSION} )
|
|
set_target_properties( ${name} PROPERTIES
|
|
COMPILE_FLAGS "-DBUILD_SHARED_LIB" )
|
|
set_target_properties( ${name} PROPERTIES
|
|
COMPILE_FLAGS "-DBUILDING_SHARED_LIB" )
|
|
install(TARGETS ${name}
|
|
RUNTIME DESTINATION ${BIN_INSTALL_DIR}
|
|
ARCHIVE DESTINATION ${LIB_INSTALL_DIR}
|
|
LIBRARY DESTINATION ${LIB_INSTALL_DIR}
|
|
)
|
|
if (TIDY_CONSOLE_SHARED) # user wants shared/dll linkage
|
|
list ( APPEND add_LIBS ${name} )
|
|
endif ()
|
|
endif ()
|
|
|
|
##########################################################
|
|
### main executable - linked with STATIC/SHARED library
|
|
if (SUPPORT_CONSOLE_APP)
|
|
set(name ${LIB_NAME})
|
|
set ( BINDIR console )
|
|
add_executable( ${name} ${BINDIR}/tidy.c )
|
|
target_link_libraries( ${name} ${add_LIBS} )
|
|
if (MSVC)
|
|
set_target_properties( ${name} PROPERTIES DEBUG_POSTFIX d )
|
|
endif ()
|
|
if (NOT TIDY_CONSOLE_SHARED)
|
|
set_target_properties( ${name} PROPERTIES
|
|
COMPILE_FLAGS "-DTIDY_STATIC" )
|
|
endif ()
|
|
install (TARGETS ${name} DESTINATION bin)
|
|
endif ()
|
|
|
|
if (BUILD_TAB2SPACE)
|
|
set(name tab2space)
|
|
add_executable( ${name} ${BINDIR}/tab2space.c )
|
|
if (MSVC)
|
|
set_target_properties( ${name} PROPERTIES DEBUG_POSTFIX d )
|
|
endif ()
|
|
# no INSTALL of this 'local' tool - use depreciated
|
|
endif ()
|
|
|
|
if (BUILD_SAMPLE_CODE)
|
|
set(name test71)
|
|
set(dir console)
|
|
add_executable( ${name} ${dir}/${name}.cxx )
|
|
if (MSVC)
|
|
set_target_properties( ${name} PROPERTIES DEBUG_POSTFIX d )
|
|
endif ()
|
|
target_link_libraries( ${name} ${add_LIBS} )
|
|
# no INSTALL of this 'local' sample
|
|
endif ()
|
|
|
|
#==========================================================
|
|
# Create man pages
|
|
#==========================================================
|
|
if (UNIX AND SUPPORT_CONSOLE_APP)
|
|
find_program( XSLTPROC_FOUND xsltproc )
|
|
if (XSLTPROC_FOUND)
|
|
## NOTE: man name must match exe ie currently `${LIB_NAME}.1` not `tidy.1`
|
|
## also could use `manpath` command output to determine target install path
|
|
set(TIDY_MANFILE ${LIB_NAME}.1)
|
|
message(STATUS "*** Generating man ${TIDY_MANFILE} custom commands...")
|
|
set(TIDY1XSL ${CMAKE_CURRENT_BINARY_DIR}/tidy1.xsl)
|
|
set(TIDYHELP ${CMAKE_CURRENT_BINARY_DIR}/tidy-help.xml)
|
|
set(TIDYCONFIG ${CMAKE_CURRENT_BINARY_DIR}/tidy-config.xml)
|
|
add_custom_target(man ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME}")
|
|
configure_file(
|
|
${CMAKE_CURRENT_SOURCE_DIR}/man/tidy1.xsl.in
|
|
${TIDY1XSL}
|
|
)
|
|
|
|
# run built EXE to generate xml output
|
|
add_custom_command(
|
|
TARGET man
|
|
COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME} -xml-help > ${TIDYHELP}
|
|
COMMENT "Generate ${TIDYHELP}"
|
|
VERBATIM
|
|
)
|
|
|
|
# run built EXE to generate more xml output
|
|
add_custom_command(
|
|
TARGET man
|
|
COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME} -xml-config > ${TIDYCONFIG}
|
|
COMMENT "Generate ${TIDYCONFIG}"
|
|
VERBATIM
|
|
)
|
|
|
|
# run xsltproc to generate the install files..
|
|
add_custom_command(
|
|
TARGET man
|
|
DEPENDS ${TIDYHELP}
|
|
COMMAND xsltproc ARGS ${TIDY1XSL} ${TIDYHELP} > ${CMAKE_CURRENT_BINARY_DIR}/${TIDY_MANFILE}
|
|
COMMENT "Generate ${TIDY_MANFILE}"
|
|
VERBATIM
|
|
)
|
|
|
|
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${TIDY_MANFILE} DESTINATION ${MAN_INSTALL_DIR})
|
|
|
|
else ()
|
|
message(STATUS "*** NOTE: xsltproc NOT FOUND! Can NOT generate man page.")
|
|
message(STATUS "*** You need to install xsltproc in your system.")
|
|
endif ()
|
|
endif ()
|
|
|
|
##########################################################
|
|
### Create MSI,EXE, DMG, DEB/RPM
|
|
### TODO: Check each of these builds
|
|
##########################################################
|
|
set(BITNESS 32)
|
|
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
|
|
set(BITNESS 64)
|
|
endif()
|
|
if (WIN32)
|
|
# MSI - this needs WiX Tooset installed and a path to candle.exe
|
|
# EXE - this needs NSIS tools to be in path
|
|
set(CPACK_GENERATOR "NSIS;WIX;ZIP")
|
|
set(CPACK_SOURCE_GENERATOR "ZIP")
|
|
set(CPACK_WIX_UPGRADE_GUID "D809598A-B513-4752-B268-0BAC403B00E4")
|
|
elseif ( ${CMAKE_SYSTEM_NAME} MATCHES "Darwin" )
|
|
set(CPACK_GENERATOR "PackageMake")
|
|
set(CPACK_SOURCE_GENERATOR "TGZ")
|
|
else ()
|
|
set(CPACK_GENERATOR "DEB;RPM")
|
|
set(CPACK_SOURCE_GENERATOR "TGZ")
|
|
endif ()
|
|
|
|
set(CPACK_PACKAGE_NAME "${LIB_NAME}")
|
|
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${LIB_NAME} - HTML syntax checker")
|
|
set(CPACK_PACKAGE_VENDOR "HTML Tidy Advocacy Community Group")
|
|
set(CPACK_PACKAGE_CONTACT "maintainer@htacg.org")
|
|
|
|
set(CPACK_PACKAGE_VERSION ${LIBTIDY_VERSION})
|
|
set(CPACK_PACKAGE_VERSION_MAJOR "${TIDY_MAJOR_VERSION}")
|
|
set(CPACK_PACKAGE_VERSION_MINOR "${TIDY_MINOR_VERSION}")
|
|
set(CPACK_PACKAGE_VERSION_PATCH "${TIDY_POINT_VERSION}")
|
|
set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
|
|
|
|
set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/README/LICENSE.md")
|
|
set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
|
|
set(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_CURRENT_SOURCE_DIR}/README/README.html")
|
|
|
|
## debian config
|
|
set(CPACK_DEBIAN_PACKAGE_MAINTAINER ${CPACK_PACKAGE_CONTACT})
|
|
set(CPACK_DEBIAN_PACKAGE_HOMEPAGE "http://www.html-tidy.org/")
|
|
#set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc")
|
|
set(CPACK_DEBIAN_PACKAGE_SECTION "Libraries")
|
|
|
|
## RPM config
|
|
set(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/usr/share/man" "/usr/share/man/man1")
|
|
|
|
set(CPACK_SOURCE_IGNORE_FILES "${CMAKE_CURRENT_SOURCE_DIR}/test/;${CMAKE_CURRENT_SOURCE_DIR}/build/;${CMAKE_CURRENT_SOURCE_DIR}/.git/")
|
|
|
|
if (NOT WIN32 AND NOT APPLE)
|
|
set( CPACK_PACKAGE_FILE_NAME "${LIB_NAME}-${CPACK_PACKAGE_VERSION}-${BITNESS}bit" )
|
|
endif ()
|
|
|
|
include(CPack)
|
|
|
|
# eof
|