New CMake for nitpick.

.gitignore

@@ -104,3 +104,4 @@ tools/unity-avatar-exporter/ProjectSettings
 tools/unity-avatar-exporter/Temp
 server-console/package-lock.json
 vcpkg/
+/tools/nitpick/compiledResources

CMakeLists.txt

@@ -81,7 +81,7 @@ if (ANDROID)
   set(GLES_OPTION ON)
   set(PLATFORM_QT_COMPONENTS AndroidExtras WebView)
 else ()
-  set(PLATFORM_QT_COMPONENTS WebEngine)
+  set(PLATFORM_QT_COMPONENTS WebEngine Xml)
 endif ()
 
 if (USE_GLES AND (NOT ANDROID))

cmake/macros/SetPackagingParameters.cmake

@@ -78,6 +78,7 @@ macro(SET_PACKAGING_PARAMETERS)
   endif ()
 
   set(NITPICK_BUNDLE_NAME "nitpick")
+  set(NITPICK_ICON_PREFIX "nitpick")
 
   string(TIMESTAMP BUILD_TIME "%d/%m/%Y")
 
@@ -162,6 +163,7 @@ macro(SET_PACKAGING_PARAMETERS)
 
     set(INTERFACE_INSTALL_APP_PATH "${CONSOLE_INSTALL_DIR}/${INTERFACE_BUNDLE_NAME}.app")
     set(INTERFACE_ICON_FILENAME "${INTERFACE_ICON_PREFIX}.icns")
+    set(NITPICK_ICON_FILENAME "${NITPICK_ICON_PREFIX}.icns")
   else ()
     if (WIN32)
       set(CONSOLE_INSTALL_DIR "server-console")
@@ -178,6 +180,7 @@ macro(SET_PACKAGING_PARAMETERS)
   if (WIN32)
     set(INTERFACE_EXEC_PREFIX "interface")
     set(INTERFACE_ICON_FILENAME "${INTERFACE_ICON_PREFIX}.ico")
+    set(NITPICK_ICON_FILENAME "${NITPICK_ICON_PREFIX}.ico")
 
     set(CONSOLE_EXEC_NAME "server-console.exe")
 

tools/nitpick/CMakeLists.txt

@@ -1,105 +1,246 @@
-set (TARGET_NAME nitpick)
+set(TARGET_NAME nitpick)
 project(${TARGET_NAME})
 
-# Automatically run UIC and MOC.  This replaces the older WRAP macros
-SET (CMAKE_AUTOUIC ON) 
-SET (CMAKE_AUTOMOC ON) 
+function(JOIN VALUES GLUE OUTPUT)
+  string (REGEX REPLACE "([^\\]|^);" "\\1${GLUE}" _TMP_STR "${VALUES}")
+  string (REGEX REPLACE "[\\](.)" "\\1" _TMP_STR "${_TMP_STR}") #fixes escaping
+  set (${OUTPUT} "${_TMP_STR}" PARENT_SCOPE)
+endfunction()
 
-setup_hifi_project (Core Widgets Network Xml)
-link_hifi_libraries ()
+set(CUSTOM_NITPICK_QRC_PATHS "")
 
-# FIX: Qt was built with -reduce-relocations
-if (Qt5_POSITION_INDEPENDENT_CODE)
-    SET (CMAKE_POSITION_INDEPENDENT_CODE ON)
-endif()
+find_npm()
 
-# Qt includes
-include_directories (${CMAKE_CURRENT_SOURCE_DIR})
-include_directories (${Qt5Core_INCLUDE_DIRS})
-include_directories (${Qt5Widgets_INCLUDE_DIRS})
+if (BUILD_TOOLS AND NPM_EXECUTABLE)
+  add_custom_qrc_path(CUSTOM_NITPICK_QRC_PATHS "${CMAKE_SOURCE_DIR}/tools/jsdoc/out/hifiJSDoc.json" "auto-complete/hifiJSDoc.json")
+endif ()
 
-set (QT_LIBRARIES Qt5::Core Qt5::Widgets QT::Gui Qt5::Xml)
+set(RESOURCES_QRC ${CMAKE_CURRENT_BINARY_DIR}/resources.qrc)
+set(RESOURCES_RCC ${CMAKE_CURRENT_SOURCE_DIR}/compiledResources/resources.rcc)
+generate_qrc(OUTPUT ${RESOURCES_QRC} PATH ${CMAKE_CURRENT_SOURCE_DIR}/resources CUSTOM_PATHS ${CUSTOM_NITPICK_QRC_PATHS} GLOBS *)
+
+add_custom_command(
+  OUTPUT ${RESOURCES_RCC}
+  DEPENDS ${RESOURCES_QRC} ${GENERATE_QRC_DEPENDS}
+  COMMAND "${QT_DIR}/bin/rcc"
+  ARGS ${RESOURCES_QRC} -binary -o ${RESOURCES_RCC}
+)
 
 if (WIN32)
-    # Do not show Console
-    set_property (TARGET nitpick PROPERTY WIN32_EXECUTABLE true)
+  set(CMAKE_CXX_FLAGS_DEBUG  "${CMAKE_CXX_FLAGS_DEBUG} -bigobj")
+  add_definitions(-D_USE_MATH_DEFINES) # apparently needed to get M_PI and other defines from cmath/math.h
+  add_definitions(-DWINDOWS_LEAN_AND_MEAN) # needed to make sure windows doesn't go to crazy with its defines
 endif()
 
-target_zlib()
-add_dependency_external_projects (quazip)
-find_package (QuaZip REQUIRED)
-target_include_directories( ${TARGET_NAME} SYSTEM PUBLIC ${QUAZIP_INCLUDE_DIRS})
-target_link_libraries(${TARGET_NAME} ${QUAZIP_LIBRARIES})
+# grab the implementation and header files from src dirs
+file(GLOB_RECURSE NITPICK_SRCS "src/*.cpp" "src/*.h")
+GroupSources("src")
+list(APPEND NITPICK_SRCS ${RESOURCES_RCC})
+
+find_package(
+  Qt5 COMPONENTS
+  Gui Widgets Multimedia Network Qml Quick Script Svg Xml
+  ${PLATFORM_QT_COMPONENTS}
+)
+
+# grab the ui files in resources/ui
+file (GLOB_RECURSE QT_UI_FILES ui/*.ui)
+source_group("UI Files" FILES ${QT_UI_FILES})
+
+# have qt5 wrap them and generate the appropriate header files
+qt5_wrap_ui(QT_UI_HEADERS "${QT_UI_FILES}")
+
+# add them to the nitpick source files
+set(NITPICK_SRCS ${NITPICK_SRCS} "${QT_UI_HEADERS}" "${QT_RESOURCES}")
 
 if (APPLE)
+  # configure CMake to use a custom Info.plist
+  set_target_properties(${this_target} PROPERTIES MACOSX_BUNDLE_INFO_PLIST MacOSXBundleInfo.plist.in)
+
+  if (PRODUCTION_BUILD)
+    set(MACOSX_BUNDLE_GUI_IDENTIFIER com.highfidelity.nitpick)
+  else ()
+    if (DEV_BUILD)
+      set(MACOSX_BUNDLE_GUI_IDENTIFIER com.highfidelity.nitpick-dev)
+    elseif (PR_BUILD)
+      set(MACOSX_BUNDLE_GUI_IDENTIFIER com.highfidelity.nitpick-pr)
+    endif ()
+  endif ()
+
+  # set how the icon shows up in the Info.plist file
+  set(MACOSX_BUNDLE_ICON_FILE "${NITPICK_ICON_FILENAME}")
+
+  # set where in the bundle to put the resources file
+  set_source_files_properties(${CMAKE_CURRENT_SOURCE_DIR}/icon/${NITPICK_ICON_FILENAME} PROPERTIES MACOSX_PACKAGE_LOCATION Resources)
+
+  # append the discovered resources to our list of nitpick sources
+  list(APPEND NITPICK_SRCS ${CMAKE_CURRENT_SOURCE_DIR}/icon/${NITPICK_ICON_FILENAME})
+endif()
+
+
+# create the executable, make it a bundle on OS X
+if (APPLE)
+  add_executable(${TARGET_NAME} MACOSX_BUNDLE ${NITPICK_SRCS} ${QM})
+
   # make sure the output name for the .app bundle is correct
   # Fix up the rpath so macdeployqt works
   set_target_properties(${TARGET_NAME} PROPERTIES INSTALL_RPATH "@executable_path/../Frameworks")
+elseif (WIN32)
+  # configure an rc file for the chosen icon
+  set(CONFIGURE_ICON_PATH "${CMAKE_CURRENT_SOURCE_DIR}/icon/${NITPICK_ICON_FILENAME}")
+  set(CONFIGURE_ICON_RC_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/Icon.rc")
+  configure_file("${HF_CMAKE_DIR}/templates/Icon.rc.in" ${CONFIGURE_ICON_RC_OUTPUT})
 
-  # call the fixup_nitpick macro to add required bundling commands for installation
-  fixup_nitpick()
-endif ()
+  set(APP_FULL_NAME "High Fidelity Nitpick")
+  set(CONFIGURE_VERSION_INFO_RC_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/VersionInfo.rc")
+  configure_file("${HF_CMAKE_DIR}/templates/VersionInfo.rc.in" ${CONFIGURE_VERSION_INFO_RC_OUTPUT})
 
-package_libraries_for_deployment()
+  # add an executable that also has the icon itself and the configured rc file as resources
+  add_executable(${TARGET_NAME} WIN32 ${NITPICK_SRCS} ${QM} ${CONFIGURE_ICON_RC_OUTPUT} ${CONFIGURE_VERSION_INFO_RC_OUTPUT})
 
-if (WIN32)
-    add_paths_to_fixup_libs (${QUAZIP_DLL_PATH})
-
-    find_program(WINDEPLOYQT_COMMAND windeployqt PATHS ${QT_DIR}/bin NO_DEFAULT_PATH)
-    
-    if (NOT WINDEPLOYQT_COMMAND)
-      message(FATAL_ERROR "Could not find windeployqt at ${QT_DIR}/bin. windeployqt is required.")
-    endif ()
-
-    # add a post-build command to call windeployqt to copy Qt plugins
+  if (NOT DEV_BUILD)
     add_custom_command(
       TARGET ${TARGET_NAME}
       POST_BUILD
-      COMMAND CMD /C "SET PATH=%PATH%;${QT_DIR}/bin && ${WINDEPLOYQT_COMMAND} ${EXTRA_DEPLOY_OPTIONS} $<$<OR:$<CONFIG:Release>,$<CONFIG:MinSizeRel>,$<CONFIG:RelWithDebInfo>>:--release> \"$<TARGET_FILE:${TARGET_NAME}>\""
-    )
-        
-    # add a custom command to copy the empty Apps/Data High Fidelity folder (i.e. - a valid folder with no entities)
-    # this also copied to the containing folder, to facilitate running from Visual Studio
-    add_custom_command(
-        TARGET ${TARGET_NAME}
-        POST_BUILD
-        COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/AppDataHighFidelity" "$<TARGET_FILE_DIR:${TARGET_NAME}>/AppDataHighFidelity"
-        COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/AppDataHighFidelity" "AppDataHighFidelity"
-    )
-        
-    # add a custom command to copy the SSL DLLs
-    add_custom_command(
-        TARGET ${TARGET_NAME}
-        POST_BUILD
-        COMMAND "${CMAKE_COMMAND}" -E copy_directory "$ENV{VCPKG_ROOT}/installed/x64-windows/bin" "$<TARGET_FILE_DIR:${TARGET_NAME}>"
-    )
-elseif (APPLE)
-    # add a custom command to copy the empty Apps/Data High Fidelity folder (i.e. - a valid folder with no entities)
-    add_custom_command(
-        TARGET ${TARGET_NAME}
-        POST_BUILD
-        COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/AppDataHighFidelity" "$<TARGET_FILE_DIR:${TARGET_NAME}>/AppDataHighFidelity"
+      COMMAND "mt.exe" -manifest "${CMAKE_CURRENT_SOURCE_DIR}/nitpick.exe.manifest" -inputresource:"$<TARGET_FILE:${TARGET_NAME}>"\;\#1 -outputresource:"$<TARGET_FILE:${TARGET_NAME}>"\;\#1
+      COMMENT "Adding OS version support manifest to exe"
     )
+  endif()
+else ()
+  add_executable(${TARGET_NAME} ${NITPICK_SRCS} ${QM})
 endif ()
 
-# set the packaged nitpick folder so we can copy it
-set(PACKAGED_NITPICK_FOLDER "Release")
+
+if (BUILD_TOOLS AND NPM_EXECUTABLE)
+  # require JSDoc to be build before nitpick is deployed
+  add_dependencies(resources jsdoc)
+endif()
+
+add_dependencies(${TARGET_NAME} resources)
+
+# disable /OPT:REF and /OPT:ICF for the Debug builds
+# This will prevent the following linker warnings
+# LINK : warning LNK4075: ignoring '/INCREMENTAL' due to '/OPT:ICF' specification
+if (WIN32)
+  set_property(TARGET ${TARGET_NAME} APPEND_STRING PROPERTY LINK_FLAGS_DEBUG "/OPT:NOREF /OPT:NOICF")
+endif()
+
+link_hifi_libraries(entities-renderer ui)
+
+# perform standard include and linking for found externals
+foreach(EXTERNAL ${OPTIONAL_EXTERNALS})
+  if (${${EXTERNAL}_UPPERCASE}_REQUIRED)
+    find_package(${EXTERNAL} REQUIRED)
+  else ()
+    find_package(${EXTERNAL})
+  endif ()
+
+  if (${${EXTERNAL}_UPPERCASE}_FOUND AND NOT DISABLE_${${EXTERNAL}_UPPERCASE})
+    add_definitions(-DHAVE_${${EXTERNAL}_UPPERCASE})
+
+    # include the library directories (ignoring warnings)
+    if (NOT ${${EXTERNAL}_UPPERCASE}_INCLUDE_DIRS)
+      set(${${EXTERNAL}_UPPERCASE}_INCLUDE_DIRS ${${${EXTERNAL}_UPPERCASE}_INCLUDE_DIR})
+    endif ()
+
+    include_directories(SYSTEM ${${${EXTERNAL}_UPPERCASE}_INCLUDE_DIRS})
+
+    # perform the system include hack for OS X to ignore warnings
+    if (APPLE)
+      foreach(EXTERNAL_INCLUDE_DIR  ${${${EXTERNAL}_UPPERCASE}_INCLUDE_DIRS})
+        SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -isystem ${EXTERNAL_INCLUDE_DIR}")
+      endforeach()
+    endif ()
+
+    if (NOT ${${EXTERNAL}_UPPERCASE}_LIBRARIES)
+      set(${${EXTERNAL}_UPPERCASE}_LIBRARIES ${${${EXTERNAL}_UPPERCASE}_LIBRARY})
+    endif ()
+
+    if (NOT APPLE OR NOT ${${EXTERNAL}_UPPERCASE} MATCHES "SIXENSE")
+      target_link_libraries(${TARGET_NAME} ${${${EXTERNAL}_UPPERCASE}_LIBRARIES})
+    elseif (APPLE AND NOT INSTALLER_BUILD)
+      add_definitions(-DSIXENSE_LIB_FILENAME=\"${${${EXTERNAL}_UPPERCASE}_LIBRARY_RELEASE}\")
+    endif ()
+  endif ()
+endforeach()
+
+# include headers for nitpick and NitpickConfig.
+include_directories("${PROJECT_SOURCE_DIR}/src")
+
+if (UNIX AND NOT ANDROID)
+    if (CMAKE_SYSTEM_NAME MATCHES "Linux")
+        # Linux
+        target_link_libraries(${TARGET_NAME} pthread atomic)
+    else ()
+        # OSX
+        target_link_libraries(${TARGET_NAME} pthread)
+    endif ()
+endif()
+
+# assume we are using a Qt build without bearer management
+add_definitions(-DQT_NO_BEARERMANAGEMENT)
 
 if (APPLE)
-  install(
-    DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${PACKAGED_NITPICK_FOLDER}"
-    USE_SOURCE_PERMISSIONS
-    DESTINATION "nitpick"
-  )
-elseif (WIN32)
-  set(NITPICK_DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/${PACKAGED_NITPICK_FOLDER}")
+  # link in required OS X frameworks and include the right GL headers
+  find_library(OpenGL OpenGL)
+  find_library(AppKit AppKit)
 
-  install(
-    DIRECTORY "${NITPICK_DESTINATION}/"
-    DESTINATION ${NITPICK_INSTALL_DIR}
+  target_link_libraries(${TARGET_NAME} ${OpenGL} ${AppKit})
+
+  # setup install of OS X nitpick bundle
+  install(TARGETS ${TARGET_NAME}
+    BUNDLE DESTINATION ${NITPICK_INSTALL_DIR}
+    COMPONENT ${CLIENT_COMPONENT}
   )
 
-  # sign the copied nitpick executable after install
-  set(EXECUTABLE_PATH "${NITPICK_DESTINATION}/${NITPICK_EXEC_NAME}")
-  optional_win_executable_signing()
-endif()
+  # call the fixup_nitpick macro to add required bundling commands for installation
+  fixup_nitpick()
+
+else()
+  set(NITPICK_EXEC_DIR "$<TARGET_FILE_DIR:${TARGET_NAME}>")
+  set(RESOURCES_DEV_DIR "${NITPICK_EXEC_DIR}/resources")
+
+  # copy the resources files beside the executable
+  add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
+    COMMAND "${CMAKE_COMMAND}" -E copy_if_different
+      "${RESOURCES_RCC}"
+      "${NITPICK_EXEC_DIR}"
+    # FIXME, the edit script code loads HTML from the scripts folder
+    # which in turn relies on CSS that refers to the fonts.  In theory
+    # we should be able to modify the CSS to reference the QRC path to
+    # the ttf files, but doing so generates a CORS policy violation,
+    # so we have to retain a copy of the fonts outside of the resources binary
+  )
+
+  # link target to external libraries
+  if (WIN32)
+    # setup install of executable and things copied by fixup/windeployqt
+    install(
+      DIRECTORY "$<TARGET_FILE_DIR:${TARGET_NAME}>/"
+      DESTINATION ${NITPICK_INSTALL_DIR}
+      COMPONENT ${CLIENT_COMPONENT}
+      PATTERN "*.pdb" EXCLUDE
+      PATTERN "*.lib" EXCLUDE
+      PATTERN "*.exp" EXCLUDE
+    )
+
+    set(SCRIPTS_INSTALL_DIR "${NITPICK_INSTALL_DIR}")
+
+    set(EXECUTABLE_COMPONENT ${CLIENT_COMPONENT})
+
+    optional_win_executable_signing()
+  endif()
+endif()
+
+if (WIN32)
+    set(EXTRA_DEPLOY_OPTIONS "--qmldir  \"${PROJECT_SOURCE_DIR}/resources/qml\"")
+
+    set(TARGET_INSTALL_DIR ${NITPICK_INSTALL_DIR})
+    set(TARGET_INSTALL_COMPONENT ${CLIENT_COMPONENT})
+    manually_install_openssl_for_qt()
+
+    package_libraries_for_deployment()
+endif()
+
+# tell CMake to exclude ui_console.h for policy CMP0071
+set_property(SOURCE ui_console.h PROPERTY SKIP_AUTOMOC ON)

tools/nitpick/src/AWSInterface.h

@@ -16,7 +16,7 @@
 #include <QObject>
 #include <QTextStream>
 
-#include "ui/BusyWindow.h"
+#include "BusyWindow.h"
 
 #include "PythonInterface.h"
 

tools/nitpick/src/MismatchWindow.h

@@ -12,7 +12,7 @@
 
 #include "ui_MismatchWindow.h"
 
-#include "../common.h"
+#include "common.h"
 
 class MismatchWindow : public QDialog, public Ui::MismatchWindow {
     Q_OBJECT

tools/nitpick/src/Nitpick.h

@@ -15,11 +15,11 @@
 #include <QTextEdit>
 #include "ui_Nitpick.h"
 
-#include "../Downloader.h"
-#include "../Test.h"
+#include "Downloader.h"
+#include "Test.h"
 
-#include "../TestRunner.h"
-#include "../AWSInterface.h"
+#include "TestRunner.h"
+#include "AWSInterface.h"
 
 class Nitpick : public QMainWindow {
     Q_OBJECT

tools/nitpick/src/Test.cpp

@@ -19,7 +19,7 @@
 #include <quazip5/quazip.h>
 #include <quazip5/JlCompress.h>
 
-#include "ui/Nitpick.h"
+#include "Nitpick.h"
 extern Nitpick* nitpick;
 
 #include <math.h>

tools/nitpick/src/Test.h

@@ -18,7 +18,7 @@
 
 #include "AWSInterface.h"
 #include "ImageComparer.h"
-#include "ui/MismatchWindow.h"
+#include "MismatchWindow.h"
 #include "TestRailInterface.h"
 
 class Step {

tools/nitpick/src/TestRailInterface.h

@@ -11,10 +11,10 @@
 #ifndef hifi_test_testrail_interface_h
 #define hifi_test_testrail_interface_h
 
-#include "ui/BusyWindow.h"
-#include "ui/TestRailTestCasesSelectorWindow.h"
-#include "ui/TestRailRunSelectorWindow.h"
-#include "ui/TestRailResultsSelectorWindow.h"
+#include "BusyWindow.h"
+#include "TestRailTestCasesSelectorWindow.h"
+#include "TestRailRunSelectorWindow.h"
+#include "TestRailResultsSelectorWindow.h"
 
 #include <QDirIterator>
 #include <QtXml/QDomDocument>

tools/nitpick/src/TestRunner.cpp

@@ -13,7 +13,7 @@
 #include <QtWidgets/QMessageBox>
 #include <QtWidgets/QFileDialog>
 
-#include "ui/Nitpick.h"
+#include "Nitpick.h"
 extern Nitpick* nitpick;
 
 #ifdef Q_OS_WIN

tools/nitpick/src/main.cpp

@@ -8,7 +8,7 @@
 //  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
 //
 #include <QtWidgets/QApplication>
-#include "ui/Nitpick.h"
+#include "Nitpick.h"
 
 #include <iostream>