Merge branch '29-many-error-codes-are-not-defined' into 'dev'

Use predictable exit codes

Resolve "Many error codes are not defined"

See merge request atom/AtOM!35

atom

@@ -1,15 +1,17 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
 ## Define exit codes
-# General config errors [10-19]
-ELOAD=10
-EINTERVAL=11
-ENOCFG=19
-# Source cofig errors [20-29]
-# Destination config errors [30-49]
-EFORMAT=30
-ECHANNEL=31
-EFMTINVPARM=49
+source "$SHAREDIR"/errorcodes
 
 # config structures
 declare -A			\
@@ -36,21 +38,11 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob
 
-source $SHAREDIR/id3genres
+source "$SHAREDIR"/id3genres
 
 for function in "$LIBDIR"/*/*
 do
@@ -125,12 +117,12 @@ do
 		:)
 			echo "-$OPTARG requires an argument"
 			help
-			exit 127
+			exit $EINVARG
 		;;
 		*)
 			echo "Unrecognized option: -$OPTARG"
 			help
-			exit 127
+			exit $EINVARG
 		;;
 	esac
 done

lib/database/checkVersion

@@ -18,7 +18,7 @@ checkDatabaseVersion() {
 			echo "Database schema version $dbversion is higher than
 				that of this version of AtOM
 				($currentdbversion). Bailing out." >&2
-			exit 1
+			exit $EDBVERSION
 		fi
 	else
 		Insert atom 1 <<<"version $currentdbversion"

lib/workers/master

@@ -220,7 +220,7 @@ master() {
 				echo "Waiting for children to come back home..."
 				wait
 				echo $'\nGood luck!'
-				exit 1
+				exit $ETASKLEFT
 			elif (( ready == 0 ))
 			then
 				sleep 0.1

share/errorcodes

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+## Define exit codes
+# General config errors [10-19]
+EDBVERSION=10
+ELOAD=11
+EINTERVAL=12
+ELOAD=13
+EIONICE=14
+ENOCFG=19
+# Source cofig errors [20-29]
+# Destination config errors [30-49]
+EFORMAT=30
+ECHANNEL=31
+EQUALITY=32
+EMAXBPS=33
+EINVDEST=34
+EFMTINVPARM=49
+# Tasks
+ETASKLEFT=50
+# Sanity
+ESANITY=60
+# Invalid arguments
+EINVARG=127

toys/checkextensions

@@ -8,6 +8,19 @@ EOWarn
 
 read -p "Press Enter to continue or Ctrl-C to abort"
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -30,16 +43,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/checkgenre

@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -22,16 +35,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/checkmissing

@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -22,16 +35,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/cleandestinations

@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -22,16 +35,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/createindex

@@ -1,6 +1,17 @@
 #!/usr/bin/env bash
 
-#!/bin/bash
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
 
 # config structures
 declare -A			\
@@ -24,16 +35,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/lowquality

@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -22,16 +35,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob

toys/missingtags

@@ -1,5 +1,18 @@
 #!/usr/bin/env bash
 
+declare -r				\
+	DOCDIR=%DOCDIR%			\
+	LIBDIR=%LIBDIR%			\
+	SHAREDIR=%SHAREDIR%
+declare -r				\
+	exampleconf=$DOCDIR/example.cfg	\
+	schema=$SHAREDIR/schema.sql	\
+					\
+	oldIFS="$IFS"
+
+## Define exit codes
+source "$SHAREDIR"/errorcodes
+
 # config structures
 declare -A			\
 	destinationchannels	\
@@ -23,16 +36,6 @@ declare -A			\
 	exit $EBASHVERS
 }
 
-declare -r				\
-	DOCDIR=%DOCDIR%			\
-	LIBDIR=%LIBDIR%			\
-	SHAREDIR=%SHAREDIR%
-declare -r				\
-	exampleconf=$DOCDIR/example.cfg	\
-	schema=$SHAREDIR/schema.sql	\
-					\
-	oldIFS="$IFS"
-
 LC_ALL=C
 
 shopt -s extglob