feat(cmake): Compile translations on during build

Compilation actually doesn't take very long (just a few seconds). This allows removing the binary `*.qm` files from the source tree and thus reduce of both the size of diffs and the transferred git object deltas on translation changes.
Holzhaus · Oct 17, 2024 · 147bad2 · 147bad2
1 parent ac33b83
commit 147bad2
Show file tree

Hide file tree

Showing 81 changed files with 54 additions and 12 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -19,7 +19,6 @@
 
 # Exclude Transifex files from merging
 /res/translations/*.ts merge=ours
-/res/translations/*.qm merge=ours
 
 # Treat serato test data as binary
 *.octet-stream binary

diff --git a/.gitignore b/.gitignore
@@ -66,3 +66,6 @@ src/mixxx.rc.include
 src/mixxx.res
 src/test/**/*.actual
 res/qrc_mixxx.cc
+
+# Ignore translations (now compiled via CMake and removed from git)
+res/translations/*.qm
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1795,17 +1795,6 @@ install(
     "${MIXXX_INSTALL_DATADIR}"
 )
 
-# Translation files
-install(
-  DIRECTORY
-    "${CMAKE_CURRENT_SOURCE_DIR}/res/translations"
-  DESTINATION
-    "${MIXXX_INSTALL_DATADIR}"
-  FILES_MATCHING PATTERN
-    "*.qm"
-)
-
-
 # Font files
 #
 # Font installation is only enabled on Windows and macOS, because on Linux/BSD
@@ -2828,6 +2817,53 @@ elseif(WIN32)
   endif()
 endif()
 
+# Mixxx translation files
+file(GLOB MIXXX_TS_FILES "${CMAKE_CURRENT_SOURCE_DIR}/res/translations/*.ts")
+message(VERBOSE "Mixxx translation files: ${MIXXX_TS_FILES}")
+
+if(QT6)
+  find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS LinguistTools)
+  set_source_files_properties(
+    ${MIXXX_TS_FILES}
+    PROPERTIES OUTPUT_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}/res/translations"
+  )
+  qt_add_lrelease(
+    TS_FILES ${MIXXX_TS_FILES}
+    LRELEASE_TARGET mixxx-translations
+    EXCLUDE_FROM_ALL
+    NO_GLOBAL_TARGET
+    QM_FILES_OUTPUT_VARIABLE MIXXX_QM_FILES
+    OPTIONS -nounfinished
+  )
+else()
+  find_program(LRELEASE_EXECUTABLE "lrelease")
+  if(LRELEASE_EXECUTABLE)
+    message(STATUS "Found lrelease: ${LRELEASE_EXECUTABLE}")
+  else()
+    message(FATAL_ERROR "Could NOT find lrelease (missing executable)")
+  endif()
+
+  set(MIXXX_QM_FILES "")
+  foreach(TS_FILE ${MIXXX_TS_FILES})
+    string(REGEX REPLACE "[.]ts$" ".qm" QM_FILE "${TS_FILE}")
+    add_custom_command(
+      OUTPUT "${QM_FILE}"
+      DEPENDS "${TS_FILE}"
+      COMMAND "${LRELEASE_EXECUTABLE}" -nounfinished "${TS_FILE}" -qm "${QM_FILE}"
+    )
+    list(APPEND MIXXX_QM_FILES "${QM_FILE}")
+  endforeach()
+  add_custom_target(mixxx-translations DEPENDS ${MIXXX_QM_FILES})
+endif()
+add_dependencies(mixxx mixxx-translations)
+install(
+  FILES
+    ${MIXXX_QM_FILES}
+  DESTINATION
+    "${MIXXX_INSTALL_DATADIR}/translations"
+)
+
+# Qt translation files
 if(APPLE OR WIN32)
   # qt_de.qm is just one arbitrary file in the directory that needs to be located;
   # there is no particular reason to look for this file versus any other one in the directory.

diff --git a/res/translations/mixxx_ar.qm b/res/translations/mixxx_ar.qm
diff --git a/res/translations/mixxx_ast.qm b/res/translations/mixxx_ast.qm
diff --git a/res/translations/mixxx_bg.qm b/res/translations/mixxx_bg.qm
diff --git a/res/translations/mixxx_br.qm b/res/translations/mixxx_br.qm
diff --git a/res/translations/mixxx_bs.qm b/res/translations/mixxx_bs.qm
diff --git a/res/translations/mixxx_ca.qm b/res/translations/mixxx_ca.qm
diff --git a/res/translations/mixxx_cs.qm b/res/translations/mixxx_cs.qm
diff --git a/res/translations/mixxx_da.qm b/res/translations/mixxx_da.qm
diff --git a/res/translations/mixxx_de.qm b/res/translations/mixxx_de.qm
diff --git a/res/translations/mixxx_el.qm b/res/translations/mixxx_el.qm
diff --git a/res/translations/mixxx_en_CA.qm b/res/translations/mixxx_en_CA.qm
diff --git a/res/translations/mixxx_en_GB.qm b/res/translations/mixxx_en_GB.qm
diff --git a/res/translations/mixxx_eo.qm b/res/translations/mixxx_eo.qm
diff --git a/res/translations/mixxx_es.qm b/res/translations/mixxx_es.qm
diff --git a/res/translations/mixxx_es_419.qm b/res/translations/mixxx_es_419.qm
diff --git a/res/translations/mixxx_es_AR.qm b/res/translations/mixxx_es_AR.qm
diff --git a/res/translations/mixxx_es_CO.qm b/res/translations/mixxx_es_CO.qm
diff --git a/res/translations/mixxx_es_CR.qm b/res/translations/mixxx_es_CR.qm
diff --git a/res/translations/mixxx_es_EC.qm b/res/translations/mixxx_es_EC.qm
diff --git a/res/translations/mixxx_es_ES.qm b/res/translations/mixxx_es_ES.qm
diff --git a/res/translations/mixxx_es_MX.qm b/res/translations/mixxx_es_MX.qm
diff --git a/res/translations/mixxx_es_PA.qm b/res/translations/mixxx_es_PA.qm
diff --git a/res/translations/mixxx_es_UY.qm b/res/translations/mixxx_es_UY.qm
diff --git a/res/translations/mixxx_et.qm b/res/translations/mixxx_et.qm
diff --git a/res/translations/mixxx_eu.qm b/res/translations/mixxx_eu.qm
diff --git a/res/translations/mixxx_fa.qm b/res/translations/mixxx_fa.qm
diff --git a/res/translations/mixxx_fi.qm b/res/translations/mixxx_fi.qm
diff --git a/res/translations/mixxx_fr.qm b/res/translations/mixxx_fr.qm
diff --git a/res/translations/mixxx_ga.qm b/res/translations/mixxx_ga.qm
diff --git a/res/translations/mixxx_gl.qm b/res/translations/mixxx_gl.qm
diff --git a/res/translations/mixxx_he.qm b/res/translations/mixxx_he.qm
diff --git a/res/translations/mixxx_hi_IN.qm b/res/translations/mixxx_hi_IN.qm
diff --git a/res/translations/mixxx_hr.qm b/res/translations/mixxx_hr.qm
diff --git a/res/translations/mixxx_hu.qm b/res/translations/mixxx_hu.qm
diff --git a/res/translations/mixxx_hy.qm b/res/translations/mixxx_hy.qm
diff --git a/res/translations/mixxx_id.qm b/res/translations/mixxx_id.qm
diff --git a/res/translations/mixxx_is.qm b/res/translations/mixxx_is.qm
diff --git a/res/translations/mixxx_it.qm b/res/translations/mixxx_it.qm
diff --git a/res/translations/mixxx_ja.qm b/res/translations/mixxx_ja.qm
diff --git a/res/translations/mixxx_ko.qm b/res/translations/mixxx_ko.qm
diff --git a/res/translations/mixxx_lb.qm b/res/translations/mixxx_lb.qm
diff --git a/res/translations/mixxx_lt.qm b/res/translations/mixxx_lt.qm
diff --git a/res/translations/mixxx_lv.qm b/res/translations/mixxx_lv.qm
diff --git a/res/translations/mixxx_mi.qm b/res/translations/mixxx_mi.qm
diff --git a/res/translations/mixxx_mk.qm b/res/translations/mixxx_mk.qm
diff --git a/res/translations/mixxx_ml.qm b/res/translations/mixxx_ml.qm
diff --git a/res/translations/mixxx_mn.qm b/res/translations/mixxx_mn.qm
diff --git a/res/translations/mixxx_mr.qm b/res/translations/mixxx_mr.qm
diff --git a/res/translations/mixxx_ms.qm b/res/translations/mixxx_ms.qm
diff --git a/res/translations/mixxx_my.qm b/res/translations/mixxx_my.qm
diff --git a/res/translations/mixxx_nb.qm b/res/translations/mixxx_nb.qm
diff --git a/res/translations/mixxx_nl.qm b/res/translations/mixxx_nl.qm
diff --git a/res/translations/mixxx_nn.qm b/res/translations/mixxx_nn.qm
diff --git a/res/translations/mixxx_oc.qm b/res/translations/mixxx_oc.qm
diff --git a/res/translations/mixxx_pl.qm b/res/translations/mixxx_pl.qm
diff --git a/res/translations/mixxx_pt.qm b/res/translations/mixxx_pt.qm
diff --git a/res/translations/mixxx_pt_BR.qm b/res/translations/mixxx_pt_BR.qm
diff --git a/res/translations/mixxx_pt_PT.qm b/res/translations/mixxx_pt_PT.qm
diff --git a/res/translations/mixxx_ro.qm b/res/translations/mixxx_ro.qm
diff --git a/res/translations/mixxx_ru.qm b/res/translations/mixxx_ru.qm
diff --git a/res/translations/mixxx_si.qm b/res/translations/mixxx_si.qm
diff --git a/res/translations/mixxx_sk.qm b/res/translations/mixxx_sk.qm
diff --git a/res/translations/mixxx_sl.qm b/res/translations/mixxx_sl.qm
diff --git a/res/translations/mixxx_sn.qm b/res/translations/mixxx_sn.qm
diff --git a/res/translations/mixxx_sq_AL.qm b/res/translations/mixxx_sq_AL.qm
diff --git a/res/translations/mixxx_sr.qm b/res/translations/mixxx_sr.qm
diff --git a/res/translations/mixxx_sv.qm b/res/translations/mixxx_sv.qm
diff --git a/res/translations/mixxx_te.qm b/res/translations/mixxx_te.qm
diff --git a/res/translations/mixxx_tr.qm b/res/translations/mixxx_tr.qm
diff --git a/res/translations/mixxx_uk.qm b/res/translations/mixxx_uk.qm
diff --git a/res/translations/mixxx_uz.qm b/res/translations/mixxx_uz.qm
diff --git a/res/translations/mixxx_vi.qm b/res/translations/mixxx_vi.qm
diff --git a/res/translations/mixxx_zh.qm b/res/translations/mixxx_zh.qm
diff --git a/res/translations/mixxx_zh_CN.qm b/res/translations/mixxx_zh_CN.qm
diff --git a/res/translations/mixxx_zh_HK.qm b/res/translations/mixxx_zh_HK.qm
diff --git a/res/translations/mixxx_zh_TW.qm b/res/translations/mixxx_zh_TW.qm
diff --git a/tools/debian_buildenv.sh b/tools/debian_buildenv.sh
@@ -100,6 +100,7 @@ case "$1" in
             qt5keychain-dev \
             qtdeclarative5-dev \
             qtscript5-dev \
+            qttools5-dev \
             "${PACKAGES_EXTRA[@]}"
         ;;
     *)

diff --git a/tools/debian_buildenv_qt6.sh b/tools/debian_buildenv_qt6.sh
@@ -100,6 +100,9 @@ case "$1" in
             protobuf-compiler \
             qtkeychain-qt6-dev \
             qt6-declarative-dev \
+            qt6-tools-dev \
+            qt6-tools-dev-tools \
+            qt6-l10n-tools \
             "${PACKAGES_EXTRA[@]}"
         ;;
     *)