From 9f24b043621183f547ded7153fec4d852cfaf46d Mon Sep 17 00:00:00 2001
From: Frans de Jonge <fransdejonge@gmail.com>
Date: Fri, 20 Oct 2017 13:59:53 +0000
Subject: [PATCH] kodev: add debug flags (#3379)

* `--gdb=X`
* `--valgrind=X`
---
 kodev | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 59 insertions(+), 2 deletions(-)

diff --git a/kodev b/kodev
index 68bb46876..be1aa99ee 100755
--- a/kodev
+++ b/kodev
@@ -263,6 +263,7 @@ usage: release <OPTIONS> <TARGET>
 
 OPTIONS:
 
+    --debug               debug-enabled release (for remote gdb)
     --ignore-translation  do not fetch translation for release
 
 TARGET:
@@ -278,6 +279,9 @@ ${SUPPORTED_RELEASE_TARGETS}"
         PARAM=$(echo "$1" | awk -F= '{print $1}')
         VALUE=$(echo "$1" | awk -F= '{print $2}')
         case $PARAM in
+            --debug)
+                export KODEBUG=1
+                ;;
             --ignore-translation)
                 ignore_translation=1
                 ;;
@@ -375,10 +379,13 @@ OPTIONS:
     -w=X, --screen-width=X   set width of the emulator screen (default: 540)
     -d=X, --screen-dpi=X     set DPI of the emulator screen (default: 160)
     --no-build               run reader without rebuilding
+    --no-debug               no debugging symbols (requires rebuilding)
     --disable-touch          use this if you want to simulate keyboard only devices
     -s=FOO --simulate=FOO    simulate dimension and other specs for a given device model
                              supported model: kobo-aura-one, kindle3, hidpi
+    --gdb=X                  run with debugger (default: nemiver)
     --graph                  graph memory use (requires gnuplot)
+    --valgrind=X             run with valgrind (default: valgrind --trace-children=yes)
 
 TARGET:
 
@@ -386,6 +393,7 @@ TARGET:
     "
     screen_width=540
     screen_height=720
+    export KODEBUG=1
     while [[ $1 == '-'* ]]; do
         PARAM=$(echo "$1" | awk -F= '{print $1}')
         VALUE=$(echo "$1" | awk -F= '{print $2}')
@@ -396,9 +404,48 @@ TARGET:
             --no-build)
                 no_build=true
                 ;;
+            --no-debug)
+                export KODEBUG=
+                ;;
+            --gdb)
+                if [ ! -z "${VALUE}" ]; then
+                    gdb=${VALUE}
+                else
+                    # Try to use friendly defaults for gdb
+                    if command -v nemiver >/dev/null; then
+                        # Nemiver is a nice GUI
+                        gdb=nemiver
+                    elif command -v ddd >/dev/null; then
+                        # DDD is a slightly less nice GUI
+                        gdb=ddd
+                    elif command -v cgdb >/dev/null; then
+                        # cgdb is a nice curses-based gdb front
+                        gdb=cgdb
+                    elif command -v gdb >/dev/null; then
+                        # gdb -tui is a slightly less nice terminal user interface
+                        gdb="gdb -tui"
+                    else
+                        echo "Couldn't find gdb."
+                        exit 1
+                    fi
+                fi
+                ;;
             --graph)
                 graph_memory=true
                 ;;
+            --valgrind)
+                if [ ! -z "${VALUE}" ]; then
+                    valgrind=${VALUE}
+                else
+                    # Try to use sensible defaults for valgrind
+                    if command -v valgrind >/dev/null; then
+                        valgrind="valgrind --trace-children=yes"
+                    else
+                        echo "Couldn't find valgrind."
+                        exit 1
+                    fi
+                fi
+                ;;
             -w | --screen-width)
                 screen_width=${VALUE}
                 ;;
@@ -408,7 +455,7 @@ TARGET:
                     screen_height=${VALUE}
                 else
                     echo "${RUN_HELP_MSG}"
-                    exit 0
+                    exit 1
                 fi
                 ;;
             -d | --screen-dpi)
@@ -489,6 +536,16 @@ TARGET:
                 CATCHSEGV=$(which catchsegv)
             fi
 
+            KOREADER_COMMAND="${CATCHSEGV} ./reader.lua -d ${args}"
+
+            if [ ! -z "${gdb}" ]; then
+                KOREADER_COMMAND="${gdb} ./luajit reader.lua -d ${args}"
+            fi
+
+            if [ ! -z "${valgrind}" ]; then
+                KOREADER_COMMAND="${valgrind} ./luajit reader.lua -d ${args}"
+            fi
+
             echo "[*] Running KOReader with arguments: $*..."
             pushd "${EMU_DIR}" && {
                 if [ $# -lt 1 ]; then
@@ -501,7 +558,7 @@ TARGET:
                 RETURN_VALUE=85
                 while [ $RETURN_VALUE -eq 85 ]; do
                     EMULATE_READER_W=${screen_width} EMULATE_READER_H=${screen_height} EMULATE_READER_DPI=${screen_dpi} \
-                        $CATCHSEGV ./reader.lua -d "$args"
+                        ${KOREADER_COMMAND}
                     RETURN_VALUE=$?
                 done
             } && popd || exit