xcompose_generator.sh

#!/usr/bin/env bash

# CGS Custom Keyboards | .XCompose File Generator
# [AUTHOR]: Carlos González Sanz

# Script constants
KSC_XCOMPOSE="$HOME/.XCompose"
KSC_COMPOSE_DIR="$HOME/smk_compose"
KSC_COMPOSE_LOCAL_INCLUDE='include "%H/smk_compose/'

# Rules directories
KSC_COMPOSE_SEQS='sequences/compose_seqs'
KSC_DEAD_KEYS='sequences/dead_keys'

# .XCompose Headers
KSC_COMPOSE_HEADER=$(cat <<EOF
# Skorpian Master Keyboard | .XCompose Rules
# [AUTHOR]: Carlos González Sanz
#
# [NOTE]: This auto-generated file stores all dead keys and Compose rules
# designed for SMK Keyboards (SMK 16.0 onwards).
#
# Feel free to (un)comment (out) any "include" statement you want.
#
# Skorpian Master Keyboard (SMK):
#   - [CODENAME]:   Penguin Land
#   - [VERSION]:    16.0
#

# Mandatory locale rules
include "%L"

# Additional writing system rules (SMK 16.0+)
EOF
)

KSC_COMPOSE_FOOTER=$(cat <<EOF

##################
# [END OF RULES] #
##################
EOF
)

# Script functions
compose_rule_compression() {
    RULES_DIR=$1
    RULES_SUBDIR=$2
    COMPOSE_PREFIX=$3

    # [RULE ONE-WAY COMPRESSION ALGORITHM]
    #
    # This "compression" is done in 3 steps as follows:
    # - 1: Remove all comments from the current directory's rule modules.
    # - 2: Remove every blank line from the aforementioned modules.
    # - 3: Leave only a single space before and after each rule definition (" : ").
    #
    # After that, we just simply sort and discard any duplicate rules
    # before writing them to our current local .XCompose file.
    #
    cat "$RULES_SUBDIR"/* | sed 's/^#[[:space:]]*.*$//' | sed '/^$/d' | sed 's/[[:space:]]*:[[:space:]]*/ : /' | sort | uniq > "$KSC_COMPOSE_DIR/$COMPOSE_PREFIX$(basename "$RULES_DIR")-$(basename "$RULES_SUBDIR")"

    echo -e "Added new rules submodule on $KSC_COMPOSE_DIR/$COMPOSE_PREFIX$(basename "$1")-$(basename "$2")"
}

# Create XCompose folders
mkdir -p "$KSC_COMPOSE_DIR"

# Traverse all dead key rules first
for CUR_DIR in "$KSC_DEAD_KEYS"/*; do
    # Check if we have our rules inside writing system subdirectories
    RULE_FILE_COUNT=$(find "$CUR_DIR" -maxdepth 1 -type f -printf '.' | wc -c)
    echo -e "Searching for rules on $CUR_DIR..."

    if [[ $RULE_FILE_COUNT -eq 0 ]]; then
        for SUBDIR in "$CUR_DIR"/*; do
            if [[ -d "$SUBDIR" ]]; then
                echo -e "Searching for rules on $SUBDIR..."
                compose_rule_compression "$CUR_DIR" "$SUBDIR" ""
            fi
        done
    else
        compose_rule_compression "$CUR_DIR" "$CUR_DIR" ""
    fi
done

# Compile all XCompose rules starting with "<Multi_key>"
for CUR_DIR in "$KSC_COMPOSE_SEQS"/*; do
    # Check if we have our rules inside writing system subdirectories
    RULE_FILE_COUNT=$(find "$CUR_DIR" -maxdepth 1 -type f -printf '.' | wc -c)
    echo -e "Searching for <Multi_key> rules on $CUR_DIR..."

    if [[ $RULE_FILE_COUNT -eq 0 ]]; then
        for SUBDIR in "$CUR_DIR"/*; do
            if [[ -d "$SUBDIR" ]]; then
                echo -e "Searching for <Multi_key> rules on $SUBDIR..."
                compose_rule_compression "$CUR_DIR" "$SUBDIR" "compose-"
            fi
        done
    else
        compose_rule_compression "$CUR_DIR" "$CUR_DIR" "compose-"
    fi
done

# Write out the final .XCompose file
echo -e "$KSC_COMPOSE_HEADER" > "$KSC_XCOMPOSE"

for RULE_FILE in "$KSC_COMPOSE_DIR"/*; do
    echo -e "$KSC_COMPOSE_LOCAL_INCLUDE$(basename "$RULE_FILE")\"" >> "$KSC_XCOMPOSE"
done

echo -e "$KSC_COMPOSE_FOOTER" >> "$KSC_XCOMPOSE"

echo -e "> [INFO]: Autogenerated the local .XCompose file for SMK v16.0"