Merge pull request CleverRaven#12 from CleverRaven/master

update

.clang-tidy

@@ -1,6 +1,6 @@
-Checks: 'clang-diagnostic-*,-clang-analyzer-security.FloatLoopCounter,-clang-analyzer-core.UndefinedBinaryOperatorResult'
+Checks: 'clang-diagnostic-*,modernize-use-using'
 WarningsAsErrors: '*'
-HeaderFilterRegex: '.*'
+HeaderFilterRegex: '(src|test).*'
 FormatStyle:     none
 
 # vim:tw=0

.travis.yml

@@ -32,127 +32,142 @@ branches:
   - master
   - development
 
+# Overall strategy for what sorts of builds to include:
+# We want a build for each compiler and each platform.
+# For PRs, we lessen the "each compiler" requirement to just covering the newest
+# and oldest relevant version of each compiler.
+# We also want to ensure that each of the following tweaks are covered in at
+# least one PR build:
+# - TILES=1
+# - SOUND=1
+# - RELEASE=1
+# - CMAKE=1
+# - SANITIZE=address
+# - LOCALIZE=0
+# - A clang-tidy run
+# We try to minimize the number of builds subject to those constraints.
+
+# To see what toolchains are available, consult the following:
+# https://github.com/travis-ci/apt-source-safelist/blob/master/ubuntu.json
+# https://launchpad.net/%7Eubuntu-toolchain-r/+archive/ubuntu/test/+index
+
 jobs:
   include:
     # Initial test stage, if this fails everything else is cancelled.
-    - stage: test
-      # GCC 5.4 is the pre-installed compiler on Xenial
-      env: COMPILER=g++ MODS=--mods=RL_Classes TEST_STAGE=1
+    - stage: Test
+      # Clang is consistently the fastest to build, so use it for the initial test.
+      env: CLANG=clang++-3.8 MODS=--mods=RL_Classes TEST_STAGE=1 CXXFLAGS='-Wno-error=unused-command-line-argument -D__extern_always_inline="extern __always_inline"'
+      name: "Clang 3.8 Make build with curses, style check and RL_Classes test"
+      compiler: clang
+      addons: &clang38
+        apt:
+          packages: ["clang-3.8", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
+          sources: *apt_sources
 
     # Then build different configurations and targets in parallel.
-    - stage: variants
-    # Linux Tiles
-      env: COMPILER=g++-8 CXXFLAGS='-Wno-implicit-fallthrough' TILES=1 SOUND=1 SANITIZE=address
+    - stage: "Main Compilers"
+      env: COMPILER=g++ LOCALIZE=0
+      name: "GCC 5.3 Make build with curses and no Localization"
+      compiler: gcc
+      addons: &gcc53
+        apt:
+          packages: ["g++-5=5.3.1-14ubuntu2", "libstdc++-5-dev=5.3.1-14ubuntu2", "gcc-5=5.3.1-14ubuntu2", "gcc-5-base=5.3.1-14ubuntu2", "cpp-5=5.3.1-14ubuntu2", "libgcc-5-dev=5.3.1-14ubuntu2", "libasan2=5.3.1-14ubuntu2", "libmpx0=5.3.1-14ubuntu2"]
+          sources: [*apt_sources]
+
+    - env: COMPILER=g++-8 CXXFLAGS='-Wno-implicit-fallthrough' TILES=1 SOUND=1 SANITIZE=address
+      name: "GCC 8 Make build with Tiles, Sound and address sanitization"
       compiler: gcc
       addons: &gcc8
         apt:
           packages: ["g++-8",   "g++-8-multilib",   "libc6-dbg", "libc6-dbg:i386", "libsdl2-dev", "libsdl2-ttf-dev", "libsdl2-image-dev", "libsdl2-mixer-dev"]
           sources: *apt_sources
 
-      # MXE variants using alternate repository http://mirror.mxe.cc/repos/apt
-      # GCC MinGW
-    - env: COMPILER='g++' LDFLAGS='-static-libgcc -static-libstdc++' MXE_TARGET='i686-w64-mingw32.static' WINE='wine'
-      addons: &gcc
+    - env: CLANG=clang++-8 SANITIZE=address EXTRA_TEST_OPTS="~[.] ~vehicle_efficiency ~vehicle_drag ~starting_items"
+      name: "Clang 8 Make build with address sanitization, but long-running tests disabled"
+      compiler: clang
+      addons: &clang8
         apt:
-          packages: ["wine"]
+          packages: ["clang-8", "libc6-dbg", "libc6-dbg:i386"]
+          sources: [*apt_sources, llvm-toolchain-xenial-8]
 
-    # Windows Tiles
-    - env: COMPILER='g++' LDFLAGS='-static-libgcc -static-libstdc++' MXE_TARGET='i686-w64-mingw32.static' WINE='wine' TILES=1 SOUND=1
+    - stage: "Platforms and Tidy"
+    # MXE variant using alternate repository http://mirror.mxe.cc/repos/apt
+      env: COMPILER='g++' LDFLAGS='-static-libgcc -static-libstdc++' MXE_TARGET='i686-w64-mingw32.static' WINE='wine' TILES=1 SOUND=1
+      name: "Mingw-w64 Make cross-compile to Windows with Tiles and Sound"
       compiler: gcc
       addons: &gcc
         apt:
           packages: ["wine"]
 
-    # CMake Clang 6.0 Tiles with CMAKE
-    - env: CLANG=clang++-6.0 TILES=1 SOUND=1 CXXFLAGS=-Wno-error=unused-command-line-argument CMAKE=1 RELEASE=1
-      dist: trusty
-      compiler: clang
-      addons: &clang60
-        apt:
-          packages: ["clang-6.0", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6", "libsdl2-dev", "libsdl2-ttf-dev", "libsdl2-image-dev", "libsdl2-mixer-dev"]
-          sources: [*apt_sources, llvm-toolchain-trusty-6.0]
-
-    # macOS Tiles
     - env: CLANG=clang++ NATIVE=osx OSX_MIN=10.13 TILES=1 SOUND=1
+      name: "Xcode 10.1 Make build with Tiles and sound (macOS)"
       os: osx
       osx_image: xcode10.1
       compiler: clang
 
-    # Finally check the compiler variants
-    - stage: compilers
-
-    # CMake Clang 8.0 Tiles with CMAKE and clang-tidy
-    # (analysis only; no build or tests)
-      env: CLANG=clang++-8 TILES=1 SOUND=1 CXXFLAGS=-Wno-unused-command-line-argument CMAKE=1 CATA_CLANG_TIDY=clang-tidy-8
+    - env: CLANG=clang++-8 TILES=1 SOUND=1 CXXFLAGS=-Wno-unused-command-line-argument CMAKE=1 CATA_CLANG_TIDY=clang-tidy-8
+      name: "Clang-tidy CMake build with Tiles and Sound"
       compiler: clang
-      addons: &clang80
+      addons: &clang8
         apt:
-          packages: ["clang-8", "clang-tidy-8", "libc6-dbg", "libc6-dbg:i386", "g++-6", "libsdl2-dev", "libsdl2-ttf-dev", "libsdl2-image-dev", "libsdl2-mixer-dev"]
+          packages: ["clang-8", "clang-tidy-8", "libsdl2-dev", "libsdl2-ttf-dev", "libsdl2-image-dev", "libsdl2-mixer-dev"]
           sources: [*apt_sources, llvm-toolchain-xenial-8]
 
-    - env: COMPILER=g++
-      compiler: gcc
-      addons: &gcc53
-        apt:
-          packages: ["g++-5=5.3.1-14ubuntu2", "libstdc++-5-dev=5.3.1-14ubuntu2", "gcc-5=5.3.1-14ubuntu2", "gcc-5-base=5.3.1-14ubuntu2", "cpp-5=5.3.1-14ubuntu2", "libgcc-5-dev=5.3.1-14ubuntu2", "libasan2=5.3.1-14ubuntu2", "libmpx0=5.3.1-14ubuntu2"]
-          sources: [*apt_sources]
+    # Finally check the compiler variants
+    - stage: compilers
+      # GCC 5.4 is default on Xenial
+      env: COMPILER=g++
+      name: "GCC 5.4 Make build with Curses"
+      if: type != pull_request
 
-    # GCC 6
     - env: COMPILER=g++-6
+      name: "GCC 6 Make build with Curses"
       if: type != pull_request
       compiler: gcc
       addons: &gcc6
         apt:
           packages: ["g++-6",   "g++-6-multilib",   "libc6-dbg", "libc6-dbg:i386"]
           sources: *apt_sources
 
-    # GCC 7
-    - env: COMPILER=g++-7 CXXFLAGS='-Wno-implicit-fallthrough' CODE_COVERAGE=true
+    - env: COMPILER=g++-7 CXXFLAGS='-Wno-implicit-fallthrough -D_GLIBCXX_DEBUG' CODE_COVERAGE=true
+      name: "GCC 7 Make build with Curses, GLIBCXX_DEBUG and code coverage"
       if: type != pull_request
       compiler: gcc
-      dist: trusty
       addons: &gcc7
         apt:
           packages: ["g++-7",   "g++-7-multilib",   "libc6-dbg", "libc6-dbg:i386", "lcov"]
           sources: *apt_sources
 
-    # GCC 8
-    # Also, adding _GLIBCXX_DEBUG so that one build can test with that
-    - env: COMPILER=g++-8 CXXFLAGS='-Wno-implicit-fallthrough -D_GLIBCXX_DEBUG'
-      compiler: gcc
-      addons: &gcc8
-        apt:
-          packages: ["g++-8",   "g++-8-multilib",   "libc6-dbg", "libc6-dbg:i386"]
-          sources: *apt_sources
-
-    # Clang 3.8
-    - env: CLANG=clang++-3.8 CXXFLAGS='-Wno-error=unused-command-line-argument -D__extern_always_inline="extern __always_inline"'
-      compiler: clang
-      addons: &clang38
+    - env: COMPILER='g++' LDFLAGS='-static-libgcc -static-libstdc++' MXE_TARGET='i686-w64-mingw32.static' WINE='wine'
+      name: "Mingw-w64 Make build with Curses"
+      if: type != pull_request
+      addons: &gcc
         apt:
-          packages: ["clang-3.8", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
-          sources: *apt_sources
+          packages: ["wine"]
 
-    # Clang 3.9
     - env: CLANG=clang++-3.9 CXXFLAGS='-Wno-error=unused-command-line-argument -D__extern_always_inline="extern __always_inline"'
+      name: "Clang 3.9 Make build with Curses"
       if: type != pull_request
       compiler: clang
       addons: &clang39
         apt:
           packages: ["clang-3.9", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
           sources: *apt_sources
 
-    # Clang 4.0
     - env: CLANG=clang++-4.0 CXXFLAGS=-Wno-error=unused-command-line-argument
+      name: "Clang 4 Make build with Curses"
       if: type != pull_request
       compiler: clang
       addons: &clang40
         apt:
           packages: ["clang-4.0", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
+          # Luckily the Trusty install Just Works on Xenial
           sources: [*apt_sources, llvm-toolchain-trusty-4.0]
 
-    # Clang 5.0
+    # Clang 5.0 (still on Trusty, because I could find no readily available
+    # source on Xenial at time of writing)
     - env: CLANG=clang++-5.0 CXXFLAGS=-Wno-error=unused-command-line-argument
+      name: "Clang 5 Make build with Curses"
       if: type != pull_request
       dist: trusty
       compiler: clang
@@ -161,14 +176,23 @@ jobs:
           packages: ["clang-5.0", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
           sources: [*apt_sources, llvm-toolchain-trusty-5.0]
 
-    # Clang 6.0
-    - env: CLANG=clang++-6.0 CXXFLAGS=-Wno-error=unused-command-line-argument SANITIZE=address EXTRA_TEST_OPTS="~[.] ~vehicle_efficiency ~vehicle_drag ~starting_items"
-      dist: trusty
+    - env: CLANG=clang++-6.0 TILES=1 SOUND=1 CXXFLAGS=-Wno-error=unused-command-line-argument CMAKE=1 RELEASE=1
+      name: "Clang 6 CMake build with tiles and sound"
+      if: type != pull_request
       compiler: clang
       addons: &clang60
         apt:
-          packages: ["clang-6.0", "g++-multilib", "libc6-dbg", "libc6-dbg:i386", "g++-6"]
-          sources: [*apt_sources, llvm-toolchain-trusty-6.0]
+          packages: ["clang-6.0", "g++-multilib", "libc6-dbg", "g++-6", "libsdl2-dev", "libsdl2-ttf-dev", "libsdl2-image-dev", "libsdl2-mixer-dev"]
+          sources: [*apt_sources, llvm-toolchain-xenial-6.0]
+
+    - env: CLANG=clang++-7
+      name: "Clang 7 Make build with Curses"
+      if: type != pull_request
+      compiler: clang
+      addons: &clang7
+        apt:
+          packages: ["clang-7", "libc6-dbg", "libc6-dbg:i386"]
+          sources: [*apt_sources, llvm-toolchain-xenial-7]
 
 before_script:
   - if [ -n "${CLANG}" ]; then COMPILER="$CLANG"; fi

CMakeLists.txt

@@ -212,7 +212,9 @@ IF(MSVC)
 		add_definitions(-D_X86_)
 	endif()
 ELSE()
-	SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -Wall -Wextra -Woverloaded-virtual -Wpedantic -std=c++14")
+	SET(CATA_WARNINGS
+		"-Werror -Wall -Wextra -Woverloaded-virtual -Wpedantic -Wmissing-declarations")
+	SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${CATA_WARNINGS} -std=c++14")
 	SET(CMAKE_CXX_FLAGS_DEBUG "-Og -g")
 ENDIF()
 

COMPILING.md

@@ -10,10 +10,11 @@
   * [Cross-compile to Windows from Linux](#cross-compile-to-windows-from-linux)
   * [Cross-compile to Mac OS X from Linux](#cross-compile-to-mac-os-x-from-linux)
   * [Cross-compile to Android from Linux](#cross-compile-to-android-from-linux)
+  * [Troubleshooting](#debian-troubleshooting)
 * [Mac OS X](#mac-os-x)
   * [Simple build using Homebrew](#simple-build-using-homebrew)
   * [Advanced info for Developers](#advanced-info-for-developers)
-  * [Troubleshooting](#troubleshooting)
+  * [Troubleshooting](#mac-troubleshooting)
 * [Windows](#windows)
   * [Visual Studio Guide](#visual-studio-guide)
   * [MinGW Guide](#mingw-guide)
@@ -219,6 +220,7 @@ Run:
 The procedure is very much similar to cross-compilation to Windows from Linux.
 Tested on ubuntu 14.04 LTS but should work on other distros as well.
 
+Please note that due to historical difficulties with cross-compilation errors, run-time optimizations are disabled for cross-compilation to Mac OS X targets. (`-O0` is specified as a compilation flag.) See [Pull Request #26564](https://github.com/CleverRaven/Cataclysm-DDA/pull/26564) for details.
 ### Dependencies
 
   * OSX cross-compiling toolchain [osxcross](https://github.com/tpoechtrager/osxcross)
@@ -352,6 +354,10 @@ To build a signed release APK (ie. one that can be installed on a device), [buil
 
 The app stores data files on the device in `/sdcard/Android/data/com.cleverraven/cataclysmdda/files`. The data is backwards compatible with the desktop version.
 
+## Linux Troubleshooting
+
+If you get an error stating `make: build-scripts/validate_pr_in_jenkins: Command not found` clone a separate copy of the upstream source to a new git repository as your git setup has become corrupted by the Blob.
+
 # Mac OS X
 
 To build Cataclysm on Mac you'll need [Command Line Tools for Xcode](https://developer.apple.com/downloads/) and the [Homebrew](http://brew.sh) package manager. With Homebrew, you can easily install or build Cataclysm using the [Cataclysm](https://formulae.brew.sh/formula/cataclysm) forumla.
@@ -472,7 +478,7 @@ The Cataclysm source is compiled using `make`.
 ### Make options
 
 * `NATIVE=osx` build for OS X. Required for all Mac builds.
-* `OSX_MIN=version` sets `-mmacosx-version-min=` (for OS X > 10.5 set it to 10.6 or higher); omit for 10.5.
+* `OSX_MIN=version` sets `-mmacosx-version-min=` (for OS X > 10.5 set it to 10.6 or higher); omit for 10.5. 10.12 or higher is highly recommended (see ISSUES below).
 * `TILES=1` build the SDL version with graphical tiles (and graphical ASCII); omit to build with `ncurses`.
 * `SOUND=1` - if you want sound; this requires `TILES=1` and the additional dependencies mentioned above.
 * `FRAMEWORK=1` (tiles only) link to SDL libraries under the OS X Frameworks folders; omit to use SDL shared libraries from Homebrew or Macports.
@@ -492,15 +498,15 @@ For more info, see the comments in the `Makefile`.
 
 Build a release SDL version using Clang without gettext:
 
-    make NATIVE=osx OSX_MIN=10.7 RELEASE=1 TILES=1 LOCALIZE=0 CLANG=1
+    make NATIVE=osx OSX_MIN=10.12 RELEASE=1 TILES=1 LOCALIZE=0 CLANG=1
 
 Build a release SDL version using Clang, link to libraries in the OS X Frameworks folders, don't use `gettext`, and package it into `Cataclysm.app`:
 
-    make app NATIVE=osx OSX_MIN=10.7 RELEASE=1 TILES=1 FRAMEWORK=1 LOCALIZE=0 CLANG=1
+    make app NATIVE=osx OSX_MIN=10.12 RELEASE=1 TILES=1 FRAMEWORK=1 LOCALIZE=0 CLANG=1
 
 Build a release curses version with gettext supplied by Macports:
 
-    make NATIVE=osx OSX_MIN=10.7 RELEASE=1 LOCALIZE=1 MACPORTS=1 CLANG=1
+    make NATIVE=osx OSX_MIN=10.12 RELEASE=1 LOCALIZE=1 MACPORTS=1 CLANG=1
 
 ### Compiling localization files
 
@@ -539,12 +545,18 @@ You can build a nice dmg distribution file with the `dmgdist` target. You will n
 
 Once `dmgbuild` is installed, you will be able to use the `dmgdist` target like this. The use of `USE_HOME_DIR=1` is important here because it will allow for an easy upgrade of the game while keeping the user config and his saves in his home directory.
 
-    make dmgdist NATIVE=osx OSX_MIN=10.7 RELEASE=1 TILES=1 FRAMEWORK=1 LOCALIZE=0 CLANG=1 USE_HOME_DIR=1
+    make dmgdist NATIVE=osx OSX_MIN=10.12 RELEASE=1 TILES=1 FRAMEWORK=1 LOCALIZE=0 CLANG=1 USE_HOME_DIR=1
 
 You should see a `Cataclysm.dmg` file.
 
 ## Troubleshooting
 
+### ISSUE: Game runs very slowly when built for Mac OS X 10.11 or earlier
+
+For versions of OS X 10.11 and earlier, run-time optimizations are disabled for native builds (`-O0` is specified as a compilation flag) due to errors that can occur in compilation. See [Pull Request #26564](https://github.com/CleverRaven/Cataclysm-DDA/pull/26564) for details. 
+
+If you're on a newer version of OS X, please use an appropriate value for the `OSX_MIN=` option, i.e. `OSX_MIN=10.14` if you are on Mojave.
+
 ### ISSUE: crash on startup due to libint.8.dylib aborting
 
 If you're compiling on Mountain Lion or above, it won't be possible to run successfully on older OS X versions due to libint.8 / pthreads version issue.

Makefile

@@ -21,7 +21,9 @@
 # Win32 (non-Cygwin)
 #   Run: make NATIVE=win32
 # OS X
-#   Run: make NATIVE=osx
+#   Run: make NATIVE=osx OSX_MIN=10.12
+#     It is highly recommended to supply OSX_MIN > 10.11
+#     otherwise optimizations are automatically disabled with -O0
 
 # Build types:
 # Debug (no optimizations)
@@ -81,7 +83,7 @@
 # PROFILE is for use with gprof or a similar program -- don't bother generally.
 # RELEASE_FLAGS is flags for release builds.
 RELEASE_FLAGS =
-WARNINGS = -Werror -Wall -Wextra -Woverloaded-virtual -Wpedantic
+WARNINGS = -Werror -Wall -Wextra -Woverloaded-virtual -Wpedantic -Wmissing-declarations
 # Uncomment below to disable warnings
 #WARNINGS = -w
 DEBUGSYMS = -g

android/app/jni/Application.mk

@@ -2,7 +2,7 @@
 
 # See CPLUSPLUS-SUPPORT.html in the NDK documentation for more information
 APP_STL := c++_shared
-APP_CPPFLAGS += -std=c++11
+APP_CPPFLAGS += -std=c++14
 ifneq ($(OS),Windows_NT)
     APP_LDFLAGS += -fuse-ld=gold
 endif

build-scripts/build.sh

@@ -18,6 +18,10 @@ if [ -n "$TEST_STAGE" ]
 then
     build-scripts/lint-json.sh
     make -j "$num_jobs" style-json
+
+    # Also build chkjson (even though we're not using it), to catch any
+    # compile errors there
+    make -j "$num_jobs" chkjson
 elif [ -n "$JUST_JSON" ]
 then
     echo "Early exit on just-json change"
@@ -107,7 +111,7 @@ else
         run_tests ./tests/cata_test &
         if [ -n "$MODS" ]
         then
-            run_tests ./tests/cata_test $MODS &
+            run_tests ./tests/cata_test --user-dir=modded $MODS &
             wait -n
         fi
         wait -n

build-scripts/requirements.sh

@@ -22,9 +22,9 @@ if just_json; then
 fi
 
 if [ -n "${CODE_COVERAGE}" ]; then
-  travis_retry pip install --user pyyaml cpp-coveralls;
-  export CXXFLAGS=--coverage;
-  export LDFLAGS=--coverage;
+  travis_retry pip install --user pyyaml cpp-coveralls
+  export CXXFLAGS="$CXXFLAGS --coverage"
+  export LDFLAGS="$LDFLAGS --coverage"
 fi
 
 if [ -n "$CATA_CLANG_TIDY" ]; then