Skip to content

Commit

Permalink
Use consistent syntax for Bash function declarations
Browse files Browse the repository at this point in the history
  • Loading branch information
cameel committed Nov 5, 2021
1 parent be6a85b commit 11d4b35
Show file tree
Hide file tree
Showing 16 changed files with 44 additions and 43 deletions.
2 changes: 1 addition & 1 deletion scripts/check_style.sh
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ then
exit 1
fi

function preparedGrep()
function preparedGrep
{
git grep -nIE "$1" -- '*.h' '*.cpp' | grep -v "${EXCLUDE_FILES_JOINED}"
return $?
Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/build_ossfuzz.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ROOTDIR="/root/project"
BUILDDIR="${ROOTDIR}/build"
mkdir -p "${BUILDDIR}" && mkdir -p "$BUILDDIR/deps"

generate_protobuf_bindings()
function generate_protobuf_bindings
{
cd "${ROOTDIR}"/test/tools/ossfuzz
# Generate protobuf C++ bindings
Expand All @@ -15,7 +15,7 @@ generate_protobuf_bindings()
done
}

build_fuzzers()
function build_fuzzers
{
cd "${BUILDDIR}"
cmake .. -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE:-Release}" \
Expand Down
4 changes: 2 additions & 2 deletions scripts/ci/docker_upgrade.sh
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
#!/usr/bin/env bash
set -e

function error() {
function error {
echo >&2 "ERROR: ${1} Aborting." && false
}

function warning() {
function warning {
echo >&2 "WARNING: ${1}"
}

Expand Down
24 changes: 12 additions & 12 deletions scripts/common.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ _initial_work_dir=$(pwd)
if [ "$CIRCLECI" ]
then
export TERM="${TERM:-xterm}"
function printTask() { echo "$(tput bold)$(tput setaf 2)$1$(tput setaf 7)"; }
function printError() { >&2 echo "$(tput setaf 1)$1$(tput setaf 7)"; }
function printWarning() { >&2 echo "$(tput setaf 11)$1$(tput setaf 7)"; }
function printLog() { echo "$(tput setaf 3)$1$(tput setaf 7)"; }
function printTask { echo "$(tput bold)$(tput setaf 2)$1$(tput setaf 7)"; }
function printError { >&2 echo "$(tput setaf 1)$1$(tput setaf 7)"; }
function printWarning { >&2 echo "$(tput setaf 11)$1$(tput setaf 7)"; }
function printLog { echo "$(tput setaf 3)$1$(tput setaf 7)"; }
else
function printTask() { echo "$(tput bold)$(tput setaf 2)$1$(tput sgr0)"; }
function printError() { >&2 echo "$(tput setaf 1)$1$(tput sgr0)"; }
function printWarning() { >&2 echo "$(tput setaf 11)$1$(tput sgr0)"; }
function printLog() { echo "$(tput setaf 3)$1$(tput sgr0)"; }
function printTask { echo "$(tput bold)$(tput setaf 2)$1$(tput sgr0)"; }
function printError { >&2 echo "$(tput setaf 1)$1$(tput sgr0)"; }
function printWarning { >&2 echo "$(tput setaf 11)$1$(tput sgr0)"; }
function printLog { echo "$(tput setaf 3)$1$(tput sgr0)"; }
fi

function printStackTrace
Expand Down Expand Up @@ -78,15 +78,15 @@ function printStackTrace
done
}

function fail()
function fail
{
printError "$@"

# Using return rather than exit lets the invoking code handle the failure by suppressing the exit code.
return 1
}

function assertFail()
function assertFail
{
printError ""
(( $# == 0 )) && printError "Assertion failed."
Expand All @@ -97,7 +97,7 @@ function assertFail()
exit 2
}

function msg_on_error()
function msg_on_error
{
local error_message
local no_stdout=false
Expand Down Expand Up @@ -171,7 +171,7 @@ function msg_on_error()
fi
}

safe_kill()
function safe_kill
{
local PID=${1}
local NAME=${2:-${1}}
Expand Down
3 changes: 2 additions & 1 deletion scripts/common_cmdline.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
YULARGS=(--strict-assembly)
FULLARGS=(--optimize --combined-json "abi,asm,ast,bin,bin-runtime,devdoc,hashes,metadata,opcodes,srcmap,srcmap-runtime,userdoc")
OLDARGS=(--optimize --combined-json "abi,asm,ast,bin,bin-runtime,devdoc,interface,metadata,opcodes,srcmap,srcmap-runtime,userdoc")
function compileFull()

function compileFull
{
local expected_exit_code=0
local expect_output='none'
Expand Down
2 changes: 1 addition & 1 deletion scripts/docker_deploy_manual.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ else
date -u +"nightly.%Y.%-m.%-d" > prerelease.txt
fi

tag_and_push()
function tag_and_push
{
docker tag "$image:$1" "$image:$2"
docker push "$image:$2"
Expand Down
8 changes: 4 additions & 4 deletions scripts/docs_version_pragma_check.sh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ source "${REPO_ROOT}/scripts/common_cmdline.sh"

developmentVersion=$("$REPO_ROOT/scripts/get_version.sh")

function versionGreater()
function versionGreater
{
v1=$1
v2=$2
Expand All @@ -58,7 +58,7 @@ function versionGreater()
return 1
}

function versionEqual()
function versionEqual
{
if [[ "$1" == "$2" ]]
then
Expand All @@ -67,7 +67,7 @@ function versionEqual()
return 1
}

function getAllAvailableVersions()
function getAllAvailableVersions
{
allVersions=()
local allListedVersions
Expand All @@ -85,7 +85,7 @@ function getAllAvailableVersions()
done
}

function findMinimalVersion()
function findMinimalVersion
{
local f=$1
local greater=false
Expand Down
6 changes: 3 additions & 3 deletions scripts/solc-bin/bytecode_reports_for_modified_binaries.sh
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@
# FIXME: Can't use set -u because the old Bash on macOS treats empty arrays as unbound variables
set -eo pipefail

die()
function die
{
# shellcheck disable=SC2059
>&2 printf "ERROR: $1\n" "${@:2}"
exit 1
}

get_reported_solc_version()
function get_reported_solc_version
{
local solc_binary="$1"

Expand All @@ -70,7 +70,7 @@ get_reported_solc_version()
echo "$version_banner" | tail -n 1 | sed -n -E 's/^Version: (.*)$/\1/p'
}

validate_reported_version()
function validate_reported_version
{
local reported_version="$1"
local expected_version_and_commit="$2"
Expand Down
2 changes: 1 addition & 1 deletion scripts/soltest.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ BOOST_OPTIONS=()
SOLTEST_OPTIONS=()
SOLIDITY_BUILD_DIR=${SOLIDITY_BUILD_DIR:-${REPO_ROOT}/build}

usage() {
function usage {
echo 2>&1 "
Usage: $0 [options] [soltest-options]
Runs BOOST C++ unit test program, soltest.
Expand Down
6 changes: 3 additions & 3 deletions scripts/test_antlr_grammar.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ SGR_BLUE="\033[34m"
vt_cursor_up() { echo -ne "\033[A"; }
vt_cursor_begin_of_line() { echo -ne "\r"; }

download_antlr4()
function download_antlr4
{
if [[ ! -e "$ANTLR_JAR" ]]
then
curl -o "${ANTLR_JAR}" "${ANTLR_JAR_URI}"
fi
}

prepare_workdir()
function prepare_workdir
{
mkdir -p "${ROOT_DIR}/build/deps"
mkdir -p "${WORKDIR}"
Expand All @@ -51,7 +51,7 @@ javac -classpath "${ANTLR_JAR}" "${WORKDIR}/src/"*.java -d "${WORKDIR}/target/"

# Run tests
failed_count=0
test_file()
function test_file
{
local SOL_FILE
SOL_FILE="$(${READLINK} -m "${1}")"
Expand Down
2 changes: 1 addition & 1 deletion scripts/tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ source "${REPO_ROOT}/scripts/common.sh"
WORKDIR=$(mktemp -d)
CMDLINE_PID=

cleanup() {
function cleanup {
# ensure failing commands don't cause termination during cleanup (especially within safe_kill)
set +e

Expand Down
6 changes: 3 additions & 3 deletions scripts/wasm-rebuild/docker-scripts/rebuild_tags.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ ORANGE='\033[0;33m'
CYAN='\033[0;36m'
RESET='\033[0m'

function generate_bytecode_report() {
function generate_bytecode_report {
rm -rf /tmp/report.txt

local EXIT_STATUS
Expand Down Expand Up @@ -74,15 +74,15 @@ function generate_bytecode_report() {
echo -e "${RED}FAILURE${RESET}"
fi
}
function clean_git_checkout() {
function clean_git_checkout {
git submodule deinit --all -q
git reset --hard HEAD --quiet
git clean -f -d -x --quiet
git checkout "$1" --quiet
git submodule init -q
git submodule update -q
}
function process_tag() {
function process_tag {
local TAG=$1
cd /src
# Checkout the historic commit instead of the tag directly.
Expand Down
4 changes: 2 additions & 2 deletions scripts/yul_coverage.sh
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ for arg in "$@"; do
esac
done

show_output_if() {
function show_output_if {
local VAR=${1}
if [ -n "${VAR}" ]; then
echo "${SOL_FILE}"
Expand All @@ -102,7 +102,7 @@ if [ ! -f "${SOLC}" ]; then
exit 1
fi

test_file() {
function test_file {
local SOL_FILE
local OUTPUT
SOL_FILE=${1}
Expand Down
4 changes: 2 additions & 2 deletions test/cmdlineTests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ function ask_expectation_update

# General helper function for testing SOLC behaviour, based on file name, compile opts, exit code, stdout and stderr.
# An failure is expected.
function test_solc_behaviour()
function test_solc_behaviour
{
local filename="${1}"
local solc_args
Expand Down Expand Up @@ -288,7 +288,7 @@ EOF
}


function test_solc_assembly_output()
function test_solc_assembly_output
{
local input="${1}"
local expected="${2}"
Expand Down
8 changes: 4 additions & 4 deletions test/docsCodeStyle.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ REPO_ROOT=$(cd "$(dirname "$0")/.." && pwd)

if [ "$CIRCLECI" ]
then
function printTask() { echo "$(tput bold)$(tput setaf 2)$1$(tput setaf 7)"; }
function printError() { echo "$(tput setaf 1)$1$(tput setaf 7)"; }
function printTask { echo "$(tput bold)$(tput setaf 2)$1$(tput setaf 7)"; }
function printError { echo "$(tput setaf 1)$1$(tput setaf 7)"; }
else
function printTask() { echo "$(tput bold)$(tput setaf 2)$1$(tput sgr0)"; }
function printError() { echo "$(tput setaf 1)$1$(tput sgr0)"; }
function printTask { echo "$(tput bold)$(tput setaf 2)$1$(tput sgr0)"; }
function printError { echo "$(tput setaf 1)$1$(tput sgr0)"; }
fi

printTask "Checking docs examples style"
Expand Down
2 changes: 1 addition & 1 deletion test/stopAfterParseTests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ FILETMP=$(mktemp -d)
cd "$FILETMP" || exit 1


function testFile()
function testFile
{
set +e
ALLOUTPUT=$($SOLC --combined-json ast --pretty-json "$@" --stop-after parsing 2>&1)
Expand Down

0 comments on commit 11d4b35

Please sign in to comment.