Merge pull request #9571 from keymanapp/feat/developer/remove-kmcmpdll

feat(developer): remove kmcomp, kmcmpdll 🎺

Author: mcdurdin

.github/labeler.yml

@@ -35,9 +35,8 @@ developer/:
   - developer/**
 
 developer/compilers/:
-  - developer/src/kmcomp/**
-  - developer/src/kmcmpdll/**
   - developer/src/kmc/**
+  - developer/src/kmcmplib/**
   - developer/src/kmc-*/**
 
 developer/ide/:

.github/multi-labeler.yml

@@ -87,15 +87,3 @@ labels:
   - label: 'windows/'
     matcher:
       title: '\(.*windows.*\):'
-
-  #
-  # epics -- we will add/remove these as we work on new epics each release
-  #
-
-  - label: 'epic-ldml'
-    matcher:
-      branch: '.*epic-ldml.*' # anywhere in the branch name, e.g. feat/epic-ldml/developer/... or feat/developer/foo-epic-ldml
-
-  - label: 'epic-kmcompx'
-    matcher:
-      branch: '.*epic-kmcompx.*'

.gitignore

@@ -73,7 +73,6 @@
 
 # /developer/TIKE/
 /windows/src/developer/TIKE/stock.kct
-/windows/src/developer/TIKE/kmcmpdll.dll
 
 # /developer/TIKE/redist/
 /windows/src/developer/TIKE/redist/Addins
@@ -85,12 +84,6 @@
 /windows/src/developer/inst/download.mak
 /windows/src/developer/inst/copydev.mak
 
-# /developer/kmcmpdll/
-/windows/src/developer/kmcmpdll/*.lastbuildstate
-
-# /developer/kmcmpdll/Debug/
-/windows/src/developer/kmcmpdll/Debug/*.idb
-
 /windows/src/developer/stock/stock.kct
 /windows/src/developer/uitemplates/keyman.kct
 
@@ -192,9 +185,3 @@ lcov.info
 /keyman*.changes
 /keyman*.tar.?z
 
-#Sabine:
-# /common/test/keyboards/invalid/source/*.kmx
-# /developer/src/test/auto/kmcomp/*.kmn
-# /developer/src/test/auto/kmcomp/*.kvk
-# /developer/src/test/auto/kmcomp/*.kvk*
-# /developer/src/test/auto/kmcomp/*.txt

common/test/keyboards/build.sh

@@ -1,225 +1,43 @@
 #!/usr/bin/env bash
-
-set -e
-set -u
-
 ## START STANDARD BUILD SCRIPT INCLUDE
 # adjust relative paths as necessary
 THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
 . "${THIS_SCRIPT%/*}/../../../resources/build/build-utils.sh"
-. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
 ## END STANDARD BUILD SCRIPT INCLUDE
-THIS_DIR="$(dirname "$THIS_SCRIPT")"
-
-display_usage() {
-  echo "usage: build.sh [build options] [targets]"
-  echo
-  echo "Build options:"
-  echo "  --clean, -c       Clean instead of build"
-  echo "  --debug, -d       Debug build"
-  echo "  --silent, -s      Suppress information messages"
-  echo "  --keyboard, -k    Build only keyboards (not packages)"
-  echo "  --kmcomp path     Specify path to kmcomp.exe, defaults"
-  echo "                    to windows/bin/developer/kmcomp.exe"
-  echo "  --zip-source      Create zip file for source of each"
-  echo "                    keyboard for artifact tests"
-  echo "  --index           Build index.html for artifact tests"
-  echo
-  echo "Targets (all unless specified):"
-
-  for d in "$THIS_DIR/"*/; do
-    d="$(basename "$d")"
-    if [ "$d" != "invalid" ]; then
-      echo "  $d"
-    fi
-  done
 
-  echo
-  exit 0
-}
+cd "$THIS_SCRIPT_PATH"
 
-QUIET=false
-DEBUG=false
-CLEAN=false
-KEYBOARDS_ONLY=false
-CUSTOM_KMCOMP=
-INDEX=false
-ZIPSOURCE=false
-KMCOMP="$KEYMAN_ROOT/developer/bin/kmcomp.exe"
-TARGETS=()
-
-# Parse args
-shopt -s nocasematch
-
-while [[ $# -gt 0 ]] ; do
-  key="$1"
-  case $key in
-    --help|-h|-\?)
-      display_usage
-      ;;
-    --clean|-c)
-      CLEAN=true
-      ;;
-    --debug|-d)
-      DEBUG=true
-      ;;
-    --silent|-s)
-      QUIET=true
-      ;;
-    --keyboard|-k)
-      KEYBOARDS_ONLY=true
-      ;;
-    --zip-source)
-      ZIPSOURCE=true
-      ;;
-    --index)
-      INDEX=true
-      ;;
-    --kmcomp)
-      shift
-      KMCOMP="$1"
-      CUSTOM_KMCOMP=true
-      ;;
-    *)
-      TARGETS+=("$key")
-  esac
-  shift
+targets=()
+# Build list of available targets from subfolders, if none specified
+for d in */; do
+  d="$(basename "$d")"
+  if [ "$d" != "invalid" ] && [ "$d" != "issue" ]; then
+    targets+=(":$d")
+  fi
 done
 
-# TODO: while this is intended to be cross platform, we
-# don't currently have a binary version of kmcomp available
-# during Linux and macOS builds, so that will need to be
-# manually sourced.
-KMCOMP_LAUNCHER=
-
-if ! $CUSTOM_KMCOMP; then
-  case "${OSTYPE}" in
-    "cygwin")
-      ;;
-    "msys")
-      ;;
-    "darwin"*)
-      # For Catalina (10.15) onwards, must use wine64
-      base_macos_ver=10.15
-      macos_ver=$(sw_vers -productVersion)
-      if verlt "$macos_ver" "$base_macos_ver"; then
-        KMCOMP_LAUNCHER=wine
-      else
-        # On Catalina, and later versions:
-        # wine-4.12.1 works; wine-5.0, wine-5.7 do not.
-        # retrieve these from:
-        # `brew tap gcenx/wine && brew install --cask --no-quarantine wine-crossover`
-        # may also need to `sudo spctl --master-disable`
-        KMCOMP_LAUNCHER=wine64
-        KMCOMP="$(dirname $KMCOMP)/kmcomp.x64.exe"
-      fi
-      ;;
-    *)
-      KMCOMP_LAUNCHER=wine
-      ;;
-  esac
-fi
+KMC="$KEYMAN_ROOT/developer/src/kmc/build/src/kmc.js"
 
-# Build list of available targets from subfolders, if none specified
-if [ ${#TARGETS[@]} == 0 ]; then
-  for d in "$THIS_DIR/"*/; do
-    d="$(basename "$d")"
-    if [ "$d" != "invalid" ] && [ "$d" != "issue" ]; then
-      TARGETS+=("$d")
-    fi
-  done
-fi
-
-if ! $QUIET; then
-  displayInfo "" \
-      "CLEAN: $CLEAN" \
-      "DEBUG: $DEBUG" \
-      "QUIET: $QUIET" \
-      "KEYBOARDS_ONLY: $KEYBOARDS_ONLY" \
-      "TARGETS: ${TARGETS[@]}" \
-      "ZIPSOURCE: $ZIPSOURCE" \
-      "INDEX: $INDEX" \
-      ""
-fi
-
-clean() {
-  local kpj="$1.kpj" ss= s=
-  if $QUIET; then
-    ss=-ss
-    s=-s
-  fi
-  pushd "$1" > /dev/null
-  if [ -f build.sh ]; then
-    ./build.sh -c $s
-  else
-    $KMCOMP_LAUNCHER "$KMCOMP" -c $ss "$kpj"
-  fi
-  popd > /dev/null
-}
+builder_describe "Test Keyboards" \
+  clean configure build \
+  ${targets[@]} \
+  "--index       Build index.html for artifact tests" \
+  "--zip-source  Create zip file for source of each keyboard for artifact tests" \
+  "--kmc=KMC     Specify path to kmc, defaults to developer/src/kmc/build/" \
+  "--silent,-s   Suppress information messages"
 
-build() {
-  local kpj="$1.kpj" d= t= ss= target= s= k=
-  if $KEYBOARDS_ONLY; then
-    k=-k
-    t=-t
-    target="$1.kmn"
-  fi
-  if $DEBUG; then
-    d=-d
-  fi
-  if $QUIET; then
-    s=-s
-    ss=-ss
-  fi
-  # -w - treat warnings as errors, we'll force this
-  # -cfc - check filename conventions
-  pushd "$1" > /dev/null
-  if [ -f build.sh ]; then
-    ./build.sh $d $k $s
-  else
-    $KMCOMP_LAUNCHER "$KMCOMP" $d $ss -w -cfc "$kpj" $t "$target"
-  fi
-  popd > /dev/null
-}
+builder_parse "$@"
 
-zipsource() {
+function zipsource() {
   local target="$1"
   pushd "$1" > /dev/null
   7z a -r -x!build -x"!$target.kpj.user" "${target}_source.zip" .
   popd > /dev/null
 }
 
-###
-
-for TARGET in "${TARGETS[@]}"; do
-  if $CLEAN; then
-    if ! $QUIET; then
-      echo
-      builder_heading "Cleaning target $TARGET"
-      echo
-    fi
-    clean "$TARGET"
-  else
-    if ! $QUIET; then
-      echo
-      builder_heading "Building target $TARGET"
-      echo
-    fi
-    build "$TARGET"
-
-    if $ZIPSOURCE; then
-      zipsource "$TARGET"
-    fi
-  fi
-done
-
-###
-
-if $INDEX; then
-  if $CLEAN; then
-    rm -f "$THIS_DIR/index.html"
-  else
-    cat << EOF > "$THIS_DIR/index.html"
+function build_index() {
+  local active_targets=($*)
+  cat << EOF > index.html
 <!DOCTYPE html>
 <html>
   <head>
@@ -231,19 +49,47 @@ if $INDEX; then
     <ul>
 EOF
 
-    for TARGET in "${TARGETS[@]}"; do
-      if $ZIPSOURCE; then
-        echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a> (<a href='$TARGET/${TARGET}_source.zip'>source</a>)</li>" >> "$THIS_DIR/index.html"
-      else
-        echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a></li>" >> "$THIS_DIR/index.html"
-      fi
-    done
+  for TARGET in "${active_targets[@]}"; do
+    if builder_has_option --zip-source; then
+      echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a> (<a href='$TARGET/${TARGET}_source.zip'>source</a>)</li>" >> index.html
+    else
+      echo "      <li><a href='$TARGET/build/$TARGET.kmp'>$TARGET.kmp</a></li>" >> index.html
+    fi
+  done
 
-    cat << 'EOF' >> "$THIS_DIR/index.html"
+  cat << EOF >> index.html
     </ul>
   </body>
 </html>
 EOF
+}
+
+###
+
+function build() {
+  local active_targets=()
+  for TARGET in "${targets[@]}"; do
+    if builder_has_action build$TARGET; then
+      active_targets+=(${TARGET#:})
+    fi
+  done
+
+  local ss=
+  if builder_has_option --silent; then
+    ss="--log-level silent"
   fi
-fi
-exit 0
+
+  node "$KMC" build $builder_debug $ss -w "${active_targets[@]}"
+
+  if builder_has_option --zip-source; then
+    for TARGET in "${active_targets[@]}"; do
+      zipsource "$TARGET"
+    done
+  fi
+
+  if builder_has_option --index; then
+    build_index "${active_targets[@]}"
+  fi
+}
+
+builder_run_action build build

core/doc/BUILDING.md

@@ -8,10 +8,3 @@ See [build configuration](../../docs/build/index.md) for details on how to confi
 On all platforms, use `build.sh`.
 
 * See `./build.sh --help` for more details
-
-## Note on kmcomp
-
-kmcomp is the command-line compiler from Keyman Developer, available from
-<https://keyman.com/developer/download> or in this repo in
-`/windows/src/developer/kmcomp`. The compiler is currently available as a
-Windows PE executable only, but it does run under WINE.