Rebase onto dev

.editorconfig

@@ -0,0 +1,18 @@
+# Configuration file for EditorConfig
+# More information is available under http://EditorConfig.org
+
+# Ignore any other files further up in the file system
+root = true
+
+# Configuration for all files
+[*]
+# Enforce Unix style line endings (\n only)
+end_of_line = lf
+# Always end files with a blank line
+insert_final_newline = true
+# Force space characters for indentation
+indent_style = space
+# Always indent by 2 characters
+indent_size = 2
+# Remove whitespace characters at the end of line
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,4 @@
+# Normalize line endings to LF (Unix) on check-in and prevents
+# conversion to CRLF (Windows) when the file is checked out.
+text eol=lf
+

.gitignore

@@ -4,14 +4,25 @@ version.hpp
 revision.cpp
 
 # project
-build/
+build.*/
 .loc.yml
 install_options
 *.sublime-workspace
 *.bck
 # ctags
 *.tags
 *.tags_sorted_by_file
+local_env.cmake
 
 # nomlib's github wiki
 wiki
+
+*local_env.cmake*
+
+#.vscode/CMakeUserPresets.json
+
+node_modules
+
+# Visual Code search index extension
+index.js
+

.gitmodules

@@ -0,0 +1,32 @@
+[submodule "vendor/SDL2_ttf.git"]
+	path = vendor/SDL2_ttf.git
+	url = https://github.com/libsdl-org/SDL_ttf.git
+  branch = release-2.0.12
+  ignore = dirty
+[submodule "vendor/SDL2_image.git"]
+	path = vendor/SDL2_image.git
+  url = https://github.com/libsdl-org/SDL_image.git
+  branch = release-2.0.0
+  ignore = dirty
+[submodule "vendor/SDL.git"]
+	path = vendor/SDL.git
+	url = https://github.com/libsdl-org/SDL
+	branch = release-2.0.4
+  #branch = release-2.24.0
+  ignore = dirty
+[submodule "vendor/gtest.git"]
+	path = vendor/gtest.git
+  url = https://github.com/google/googletest.git
+  branch = v1.8.x
+  ignore = dirty
+[submodule "vendor/libsndfile.git"]
+	path = vendor/libsndfile.git
+  url = https://github.com/libsndfile/libsndfile.git
+  branch = v1.0.30
+  ignore = dirty
+[submodule "vendor/openal-soft.git"]
+	path = vendor/openal-soft.git
+	url = https://github.com/kcat/openal-soft
+  branch = 9b6a226
+  ignore = dirty
+

.travis.yml

@@ -27,7 +27,7 @@ before_install:
   # - xvfb-run -- :99 -ac -screen 0 1024x768x32
   # - /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1024x768x32
 
-  # - brew update
+  - brew update
   # - brew install cmake
 
   # FIXME: It might be best if we packaged the freetype2 libs for libRocket
@@ -36,11 +36,15 @@ before_install:
 
   # NOM_DEPS_URL and NOM_OSX_SDK_URL has been set by our repository settings
   - wget -O /tmp/deps.tar.gz $NOM_DEPS_URL
-  - wget -O /tmp/osx10.7.sdk.tar.gz $NOM_OSX_SDK_URL
+  # NOTE: Ensure that nomlib builds against the latest OS X SDK instead of the
+  # minimum deployment version in the mean time -- until I get around to
+  # cleaning up this script and building for both the minimum and the latest
+  # SDKs...
+  # - wget -O /tmp/osx10.7.sdk.tar.gz $NOM_OSX_SDK_URL
 before_script:
   - tar -xzf /tmp/deps.tar.gz -C third-party
-  - sudo mkdir -p '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs'
-  - sudo tar -xzf /tmp/osx10.7.sdk.tar.gz -C /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs
+  # - sudo mkdir -p '/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs'
+  # - sudo tar -xzf /tmp/osx10.7.sdk.tar.gz -C /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs
   - mkdir -p build && cd build
   - cmake -GXcode -DDEBUG=on -DDEBUG_ASSERT=on -DEXAMPLES=on -DNOM_BUILD_TESTS=on -DCMAKE_OSX_DEPLOYMENT_TARGET=10.7 -DCMAKE_INSTALL_PREFIX=~/Library/Frameworks ..
 script:

.vscode/CMakeUserPresets.json

@@ -0,0 +1,3 @@
+{
+  "version": 10
+}

.vscode/bin/add_rpath.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# This script is intended to be ran from within the CMake environment.
+#
+# See cmake/macros.cmake, man 1 install_name_tool
+
+# install_name_tool
+${1} -add_rpath ${2} ${3}
+
+# We **must** exit with a successful return code for Xcode-generated project
+# builds, or else the whole build fails on us
+exit 0

.vscode/bin/check_json.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be non-interactively ran by the project's
+# build scripts.
+
+JSHINT_BIN=$(which jshint)
+
+if [[ -x $JSHINT_BIN ]]; then
+  # We only bother validating critical game files that would prevent us from
+  # initialization.
+  jshint ../Resources/cards.json
+  jshint ../Resources/config_game.json
+  jshint ../Resources/config_assets-low-res.json
+  jshint ../Resources/config_assets-hi-res.json
+else
+  echo "${0} WARN: Skipping JSON validation; jshint not found!"
+  echo "See installation instructions at http://jshint.com/install/"
+  # exit 1
+fi

.vscode/bin/clang_build.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be ran from the project's current build
+# directory.
+
+BUILD_BIN=$(which make)
+
+# Default build configuration type
+BUILD_TYPE="Debug"
+
+if [[ !( -z "${BUILD_TYPE_ARG}") ]]; then
+  BUILD_TYPE=$1
+fi
+
+if [[ !( -z "${NUM_THREADS}") ]]; then
+  NUM_THREADS_ARG="-j ${NUM_THREADS}"
+fi
+# echo "NUM_THREADS_ARG: ${NUM_THREADS_ARG}"
+
+../bin/check_json.sh
+
+if [[ $? -eq 0 ]]; then
+  echo "Building ${BUILD_TYPE} project... [target: build]"
+
+  ${BUILD_BIN} ${NUM_THREADS_ARG}
+else
+  echo "${0} ERROR: JSON validation failure has prevented building the project."
+  exit 1
+fi

.vscode/bin/clang_clean.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be ran from the project's current build
+# directory.
+
+BUILD_BIN=$(which make)
+BUILD_TYPE_ARG=$1
+
+# Default
+BUILD_TYPE="Debug"
+
+if [[ !( -z "${BUILD_TYPE_ARG}") ]]; then
+  BUILD_TYPE=$1
+fi
+
+if [[ !( -z "${NUM_THREADS}") ]]; then
+  NUM_THREADS_ARG="-j ${NUM_THREADS}"
+fi
+# echo "NUM_THREADS_ARG: ${NUM_THREADS_ARG}"
+
+echo "Building ${BUILD_TYPE} project... [target: build]"
+${BUILD_BIN} clean

.vscode/bin/clang_install.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be ran from the project's current build
+# directory.
+
+BUILD_BIN=$(which make)
+BUILD_TYPE_ARG=$1
+
+# Default
+BUILD_TYPE="Debug"
+
+if [[ !( -z "${BUILD_TYPE_ARG}") ]]; then
+  BUILD_TYPE=$1
+fi
+
+if [[ !( -z "${NUM_THREADS}") ]]; then
+  NUM_THREADS_ARG="-j ${NUM_THREADS}"
+fi
+# echo "NUM_THREADS_ARG: ${NUM_THREADS_ARG}"
+
+echo "Installing ${BUILD_TYPE} project... [target: build]"
+${BUILD_BIN} install

.vscode/bin/clang_uninstall.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be ran from the project's current build
+# directory.
+
+BUILD_BIN=$(which make)
+BUILD_TYPE_ARG=$1
+
+# Default
+BUILD_TYPE="Debug"
+
+if [[ !( -z "${BUILD_TYPE_ARG}") ]]; then
+  BUILD_TYPE=$1
+fi
+
+if [[ !( -z "${NUM_THREADS}") ]]; then
+  NUM_THREADS_ARG="-j ${NUM_THREADS}"
+fi
+# echo "NUM_THREADS_ARG: ${NUM_THREADS_ARG}"
+
+echo "Building ${BUILD_TYPE} project... [target: build]"
+${BUILD_BIN} uninstall

.vscode/bin/configure.sh

@@ -0,0 +1,97 @@
+#!/bin/sh
+
+# NOTE: This script is intended to be ran from the project's current build
+# directory.
+
+# Enable case-insensitive string matches for passing arguments around
+shopt -s nocasematch
+
+function usage_info()
+{
+  SCRIPT_NAME = $(basename $0)
+  echo "Usage: ${SCRIPT_NAME} <build_type> <install_dir>\n"
+  echo "...where <build_type> is one of Debug or Release"
+  echo "    (Defaults: ${BUILD_TYPE})\n"
+  echo "...where <install_dir> is the engine's destination install prefix"
+  echo "    (Defaults: ${BUILD_INSTALL_DIR})"
+  exit 0
+}
+
+MKDIR_BIN=$(which mkdir) # GNU coreutils
+RM_BIN=$(which rm) # GNU coreutils
+CMAKE_BIN=$(which cmake)
+
+# Default build configuration type
+BUILD_TYPE_ARG=$1
+GEN_PROJECT_TYPE_ARG=$2
+BUILD_TYPE="Debug"
+GEN_PROJECT_TYPE="" # i.e. CMake project generator: Xcode
+
+if [[ !( -z "${BUILD_TYPE_ARG}") ]]; then
+  BUILD_TYPE=${BUILD_TYPE_ARG}
+fi
+
+if [[ !( -z "${GEN_PROJECT_TYPE_ARG}") ]]; then
+  GEN_PROJECT_TYPE="-G${GEN_PROJECT_TYPE_ARG}"
+fi
+
+# The absolute path to CMake's local cache of project build variables
+CMAKE_CACHE_FILE="$(pwd)/CMakeCache.txt"
+
+# Sane engine defaults for building apps against
+#
+# IMPORTANT: A space character **must** be inserted at the beginning of the
+# BUILD_FLAGS string variable, or else the preprocessor flags will not be
+# parsed correctly by cmake
+BUILD_FLAGS+=" -DCMAKE_OSX_DEPLOYMENT_TARGET=10.7"
+if [ -z "${NOMLIB_DEPS_ROOT}" ]; then
+  BUILD_FLAGS+=" -DNOMLIB_DEPS_PREFIX=${HOME}/Projects/nomlib.git/third-party/osx"
+else
+  BUILD_FLAGS+=" -DNOMLIB_DEPS_PREFIX=${NOMLIB_DEPS_ROOT}"
+fi
+
+# Default installation path
+BUILD_INSTALL_DIR="$(pwd)"
+BUILD_INSTALL_DIR_ARG=$3
+
+# Check command arguments
+if [[ $1 == "-h" || $1 == "--help" ]]; then
+  usage_info
+else
+  # Set build configuration type
+  #
+  # IMPORTANT: A space character **must** be inserted at the beginning of the
+  # BUILD_FLAGS string variable, or else the preprocessor flags will not be
+  # parsed correctly by cmake
+  if [[ ${BUILD_TYPE_ARG} == "Debug" ]]; then
+    BUILD_FLAGS+=" -DDEBUG=on -DDEBUG_ASSERT=on"
+  elif [[ ${BUILD_TYPE_ARG} == "Release" ]]; then
+    BUILD_TYPE="Release"
+    BUILD_FLAGS+=" -DDEBUG=off -DDEBUG_ASSERT=off"
+  fi
+
+  echo "BUILD_FLAGS=${BUILD_FLAGS}"
+
+  if [[ !( -z "${BUILD_INSTALL_DIR_ARG}" ) ]]; then
+    # Override installation prefix path; it is best to let CMake deal with
+    # file path validation
+    BUILD_INSTALL_DIR=${3}
+  fi
+
+  echo "\nClearing CMake cache..."
+
+  if [[ -f "CMakeCache.txt" ]]; then
+    ${RM_BIN} -rf CMakeCache.txt
+  fi
+
+  if [[ -d "CMakeFiles" ]]; then
+    ${RM_BIN} -rf CMakeFiles
+  fi
+
+  echo "Generating ${BUILD_TYPE} project files..."
+  echo "BUILD_INSTALL_DIR: ${BUILD_INSTALL_DIR}"
+
+  ${CMAKE_BIN} "$GEN_PROJECT_TYPE" ${BUILD_FLAGS} \
+  -DCMAKE_INSTALL_PREFIX=${BUILD_INSTALL_DIR} \
+  ..
+fi

.vscode/bin/ctags.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+#
+#   Generate project tag file (symbol reference mappings)
+#
+# NOTE: This script should be ran from the project's root directory, i.e.:
+#       ~/Projects/nomlib.git/
+#
+
+SOURCE_DIR=src
+HEADER_DIR=include/nomlib/
+
+CTAGS_BIN=$(which ctags)
+
+${CTAGS_BIN} -R ${SOURCE_DIR} ${HEADER_DIR}