debug.sh

#!/usr/bin/env bash

#Don't let the user execute this as root, it breaks graphical login (Changes /tmp permissions)
if [[ $UID -eq 0 ]]; then
    echo "GTG shouldn't be run as root, terminating"
    exit
fi

args=""
dataset="default"
norun=0
pydebug=0
title=""
explicit_title=0
prefix_prog=""

# Create execution-time data directory if needed
mkdir -p tmp

# Interpret arguments. The ":" following the letter indicates that the opstring (optarg) needs a parameter specified. See also: https://stackoverflow.com/questions/18414054/rreading-optarg-for-optional-flags
while getopts "dwns:t:p:" o;
do  case "$o" in
    d)   args="$args -d";;
    w)   pydebug=1;;
    n)   norun=1;;
    s)   dataset="$OPTARG";;
    t)   title="$OPTARG" explicit_title=1;;
    p)   prefix_prog="$OPTARG";;
    [?]) cat >&2 <<EOF
Usage: $0 [-s dataset] [-t title] [-d] [-w] [-n] (-- args passed to gtg)
    -s dataset     Use the dataset located in $PWD/tmp/<dataset>
    -t title       Set a custom title/program name to use.
                   Use -t '' (empty) to un-set the title
                   (default is: 'GTG (debug version — "<dataset>" dataset)')
    -p prefix-prog Insert prefix-prog before the application file when
                   executing GTG. Example: -p 'python3 -m cProfile -o gtg.prof'
    -d             Enable debug mode, basically enables debug logging
    -w             Enable python warnings like deprecation warnings,
                   and other python 3.7+ development mode features.
                   Also see https://docs.python.org/3/library/devmode.html
    -n             Just generate the build system, don't actually run gtg
    -- args passed to gtg
                   These arguments are passed to the application as-is
                   Use -- --help to get help for the application
EOF
         exit 1;;
    esac
done
args_array=("${@}")
extra_args=("${args_array[@]:$((OPTIND-1))}")

# Copy dataset
if [[  "$dataset" != "default" \
        && ! -d "./tmp/$dataset" \
        && -d "data/test-data/$dataset" ]]; then
    echo "Copying $dataset dataset to ./tmp/"
    cp -r "data/test-data/$dataset" tmp/ || exit $?
fi

echo "Running the development/debug version - using separate user directories"
echo "Your data is in the 'tmp' subdirectory with the '$dataset' dataset."
echo "-----------------------------------------------------------------------"
export XDG_DATA_HOME="$PWD/tmp/$dataset/xdg/data"
export XDG_CACHE_HOME="$PWD/tmp/$dataset/xdg/cache"
export XDG_CONFIG_HOME="$PWD/tmp/$dataset/xdg/config"
export XDG_DATA_DIRS="$PWD/.local_build/install/share:${XDG_DATA_DIRS:-/usr/local/share:/usr/share}"

if [[ "$title" = "" ]] && [[ "$explicit_title" == 0 ]]; then
    title="GTG (debug version)"
    if [[ "$dataset" != "default" ]]; then
        title='GTG (debug version, "'$dataset'" dataset)'
    fi
fi
if ! [[ "$title" = "" ]]; then
    extra_args=('--title' "$title" "${extra_args[@]}")
fi

if [[ ! -d .local_build ]] || [[ ! -e .local_build/build.ninja ]]; then
    meson -Dprofile=development -Dprefix="$(pwd)"/.local_build/install .local_build || exit $?
fi

if [[ "$norun" -eq 0 ]]; then
    rm -f .local_build/GTG/plugins/*.gtg-plugin # Regenerate for translations
    ninja -C .local_build install || exit $?
    if [ "$pydebug" = 1 ]; then
        # https://docs.python.org/3/library/devmode.html#devmode
        export PYTHONDEVMODE=1
    fi
    # double quoting args seems to prevent python script from picking up flag arguments correctly
    # shellcheck disable=SC2086
    cd .local_build # To let python be able to find the modules
    ./prefix-gtg.sh $prefix_prog ./install/bin/gtg ${args} "${extra_args[@]}" || exit $?
fi