chore(error): rename parameter a7 to numFramesToSkip in SErrDisplayError

.github/workflows/pr.yml

@@ -4,47 +4,60 @@ on: pull_request
 
 jobs:
   build:
-    name: ${{ matrix.config.name }}
-    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.flavor.name }} / ${{ matrix.build.system_name }} / ${{ matrix.build.build_type }} / ${{ matrix.build.compiler_name }}
+    runs-on: ${{ matrix.build.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        config:
-          - name: Ubuntu Latest (GCC)
-            os: ubuntu-latest
-            build_type: Release
+        flavor:
+          - name: WoW
+            define: WOW
+          - name: SC1
+            define: SC1
+
+        build:
+          - system_name: Linux
+            build_type: Debug
+            compiler_name: GCC
             test_path: StormTest
+            os: ubuntu-latest
             cc: gcc
             cxx: g++
 
-          - name: macOS Latest (Clang)
-            os: macos-latest
-            build_type: Release
+          - system_name: macOS
+            build_type: Debug
+            compiler_name: Clang
             test_path: StormTest
+            os: macos-latest
             cc: clang
             cxx: clang++
 
-          - name: Windows Latest (MSVC)
+          - system_name: Windows
+            build_type: Debug
+            compiler_name: MSVC
+            test_path: Debug/StormTest
             os: windows-latest
-            build_type: Release
-            test_path: Release/StormTest
             cc: cl
             cxx: cl
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
         with:
           submodules: true
 
+      - name: Install Dependencies (${{ matrix.build.os }})
+        run: sudo apt install -y lcov
+        if: matrix.build.os == 'ubuntu-latest'
+
       - name: Prepare
         run: mkdir build
 
       - name: Configure
-        run: cd build && cmake .. -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }}
+        run: cd build && cmake .. -DCMAKE_BUILD_TYPE=${{ matrix.build.build_type }} -DWHOA_STORM_FLAVOR=${{ matrix.flavor.define}}
 
       - name: Build
-        run: cmake --build build --config ${{ matrix.config.build_type }}
+        run: cmake --build build --config ${{ matrix.build.build_type }}
 
       - name: Test
-        run: ./build/test/${{ matrix.config.test_path }}
+        run: ./build/test/${{ matrix.build.test_path }}

.github/workflows/push.yml

@@ -7,47 +7,56 @@ on:
 
 jobs:
   build:
-    name: ${{ matrix.config.name }}
-    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.flavor.name }} / ${{ matrix.build.system_name }} / ${{ matrix.build.build_type }} / ${{ matrix.build.compiler_name }}
+    runs-on: ${{ matrix.build.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        config:
-          - name: Ubuntu Latest (GCC)
-            os: ubuntu-latest
+        flavor:
+          - name: WoW
+            define: WOW
+          - name: SC1
+            define: SC1
+
+        build:
+          - system_name: Linux
             build_type: Release
+            compiler_name: GCC
             test_path: StormTest
+            os: ubuntu-latest
             cc: gcc
             cxx: g++
 
-          - name: macOS Latest (Clang)
-            os: macos-latest
+          - system_name: macOS
             build_type: Release
+            compiler_name: Clang
             test_path: StormTest
+            os: macos-latest
             cc: clang
             cxx: clang++
 
-          - name: Windows Latest (MSVC)
-            os: windows-latest
+          - system_name: Windows
             build_type: Release
+            compiler_name: MSVC
             test_path: Release/StormTest
+            os: windows-latest
             cc: cl
             cxx: cl
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
         with:
           submodules: true
 
       - name: Prepare
         run: mkdir build
 
       - name: Configure
-        run: cd build && cmake .. -DCMAKE_BUILD_TYPE=${{ matrix.config.build_type }}
+        run: cd build && cmake .. -DCMAKE_BUILD_TYPE=${{ matrix.build.build_type }} -DWHOA_STORM_FLAVOR=${{ matrix.flavor.define}}
 
       - name: Build
-        run: cmake --build build --config ${{ matrix.config.build_type }}
+        run: cmake --build build --config ${{ matrix.build.build_type }}
 
       - name: Test
-        run: ./build/test/${{ matrix.config.test_path }}
+        run: ./build/test/${{ matrix.build.test_path }}

.gitignore

@@ -1,6 +1,11 @@
 .DS_Store
-.idea
-.vscode
+CMakeSettings.json
+.idea/
+.vscode/
+.vs/
 
 /build
+/build_*
+/cmake-build-*
 /dist
+/out

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.1...3.5)
 
 if (${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR})
     message(FATAL_ERROR
@@ -18,10 +18,50 @@ project(storm)
 
 set(CMAKE_CXX_STANDARD 11)
 
-include(lib/system/cmake/system.cmake)
+set(WHOA_SFILE_MODE "NATIVE" CACHE STRING "SFile backend (NATIVE or STORMLIB)")
+set_property(CACHE WHOA_SFILE_MODE PROPERTY STRINGS NATIVE STORMLIB)
+
+list(APPEND CMAKE_MODULE_PATH
+    "${CMAKE_CURRENT_SOURCE_DIR}/lib/system/cmake"
+    "${CMAKE_CURRENT_SOURCE_DIR}/vendor/cmake-modules"
+)
+
+include(system)
+
+# Standalone builds
+if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
+    set(WHOA_STANDALONE 1)
+    message(STATUS "Building Storm as a standalone project")
+endif()
+
+if(WHOA_ASSERTIONS_ENABLED)
+    add_definitions(-DWHOA_ASSERTIONS_ENABLED)
+endif()
+
+# Storm flavors
+if(WHOA_STORM_FLAVOR STREQUAL "SC1")
+    message(STATUS "Building Storm with StarCraft flavoring")
+
+    if (WHOA_SYSTEM_MAC OR WHOA_SYSTEM_LINUX)
+        add_definitions(-DWHOA_STORM_C_CRIT_SECT_RECURSIVE)
+    endif()
+
+    add_definitions(-DWHOA_RECT_USES_SCREEN_COORDINATES)
+    add_definitions(-DWHOA_SSTRHASH64_SUBTRACTS)
+    add_definitions(-DWHOA_SUPPORTS_KOREAN_CODEPAGE)
+elseif(WHOA_STORM_FLAVOR STREQUAL "WOW")
+    message(STATUS "Building Storm with World of Warcraft flavoring")
+    add_definitions(-DWHOA_DISPLAY_ERR_EXTRA_ARG)
+else()
+    message(STATUS "Building Storm with default flavoring")
+    add_definitions(-DWHOA_DISPLAY_ERR_EXTRA_ARG)
+endif()
 
 # OS defines
 if(WHOA_SYSTEM_WIN)
+    # Implicit behavior of CriticalSection
+    add_definitions(-DWHOA_STORM_C_CRIT_SECT_RECURSIVE)
+
     # Avoid win32 header hell
     add_compile_definitions(
         NOMINMAX
@@ -30,5 +70,49 @@ if(WHOA_SYSTEM_WIN)
 endif()
 
 add_subdirectory(lib)
-add_subdirectory(storm)
-add_subdirectory(test)
+add_subdirectory(vendor)
+
+# Code coverage reporting
+if(WHOA_STANDALONE AND CMAKE_BUILD_TYPE STREQUAL "Debug")
+    # GCC coverage configuration
+    if(CMAKE_COMPILER_IS_GNUCXX)
+        # Running coverage on linux+gcc:
+        #
+        #   sudo apt install lcov
+        #   cmake -DCMAKE_BUILD_TYPE=Debug ..
+        #   make
+        #   make StormCoverage
+        #
+        # Results in `StormCoverage/index.html`
+        include(CodeCoverage)
+
+        setup_target_for_coverage_lcov(
+                NAME StormCoverage
+                EXECUTABLE StormTest
+                DEPENDENCIES StormTest storm
+                BASE_DIRECTORY "${PROJECT_SOURCE_DIR}/storm"
+                LCOV_ARGS --rc branch_coverage=1
+                GENHTML_ARGS --rc genhtml_branch_coverage=1
+        )
+
+        message(STATUS "Code coverage reporting enabled")
+    endif()
+endif()
+
+if(WHOA_TEST_STORMDLL)
+    # Doesn't build squall, but still builds the tests to run against a real Storm.dll
+    add_definitions(-DWHOA_TEST_STORMDLL)
+    if(WHOA_STORMDLL_VERSION)
+        add_definitions(-DWHOA_STORMDLL_VERSION=${WHOA_STORMDLL_VERSION})
+    else()
+        add_definitions(-DWHOA_STORMDLL_VERSION=2016)
+    endif()
+    add_subdirectory(test/stormdll)
+else()
+    add_subdirectory(storm)
+endif()
+
+if(WHOA_STANDALONE)
+    # Add tests when standalone
+    add_subdirectory(test)
+endif()

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+## Running Tests
+
+### Coverage
+Only runnable with GCC.
+
+1. `sudo apt install lcov`
+2. `mkdir build`
+3. `cd build`
+4. `cmake -DCMAKE_BUILD_TYPE=Debug ..`
+5. `make StormCoverage`
+
+Open the resulting `html` file for the report.
+
+
+### Against an original copy of Storm.dll
+Only runnable on Windows. Allows running tests against the original `storm.dll` rather than against the recreated code, to test accuracy.
+
+1. `mkdir build`
+2. `cd build`
+2. `cmake -DWHOA_TEST_STORMDLL=1 -DWHOA_STORM_FLAVOR=SC1 -A Win32 ..`.
+3. `cmake --build .`
+4. Copy `storm.dll` from your Starcraft 1.17 installation folder to the same directory as `StormTest.exe`.
+5. Run `StormTest.exe` from the command line.
+
+To use a different version of Storm.dll, use the following arguments in the cmake command:
+
+| Arguments | Games |
+|-----------|-------|
+|`-DWHOA_STORMDLL_VERSION=2016`| Starcraft 1.17 |
+|`-DWHOA_STORMDLL_VERSION=2007`| Starcraft 1.15.0 ~ 1.16.1 |
+|`-DWHOA_STORMDLL_VERSION=2004`| Starcraft 1.11b ~ 1.14 |
+|`-DWHOA_STORMDLL_VERSION=2003`| Starcraft 1.10 ~ 1.11, Diablo II 1.10 ~ 1.13d |
+|`-DWHOA_STORMDLL_VERSION=2000`| Diablo 1.09, Starcraft 1.08 ~ Starcraft 1.09b, Diablo II 1.06 ~ Diablo II 1.09d, Warcraft II: BNE 2.02.1 |
+|`-DWHOA_STORMDLL_VERSION=1999`| Diablo 1.08, Diablo II 1.0 ~ Diablo II 1.05b |

README.md

@@ -1,7 +1,7 @@
 # Squall
 
 Squall is an unofficial open source implementation of the Storm standard
-library circa 2010.
+library.
 
 The Storm standard library is a collection of data structures and functions
 created by the talented folks at Blizzard Entertainment for use in their
@@ -11,37 +11,60 @@ This project attempts to provide a version of Storm compatible with the
 version used in the final release build of World of Warcraft: Wrath of the
 Lich King in 2010: 3.3.5a (12340).
 
+Squall also attempts to provide versions of Storm that work with other
+projects centered around classic Blizzard games, like
+[Starsurgical](https://github.com/Starsurgical). Note that Squall does not
+natively support being built as a dynamic library, although it may support
+such scenarios in the future.
+
 In the spirit of documenting what is presumed to have existed at the time,
 this project makes every attempt to maintain the canonical names, layouts, and
 side effects of the original implementation of Storm. At the same time, it
 attempts to ensure portability and compatibility with modern 64-bit systems.
 
+## Storm Flavors
+
+Squall supports different flavors depending on the type of project consuming
+it. These flavors can be configured by setting a CMake variable called
+`WHOA_STORM_FLAVOR`:
+
+- `WOW`: Ensures the resulting build is compatible with World of Warcraft
+  3.3.5a (12340)
+- `SC1`: Ensures the resulting build is compatible with StarCraft 1.16/1.17
+
+Flavors control groups of behavior-related defines. These defines can be used
+on their own if the groups defined by the flavors are not desired.
+
 ## FAQ
 
 **Why?**
 
 It's fascinating to explore the development practices used to build a modern
 major video game.
 
-**Why 3.3.5a?**
+**Why does Squall focus on specific game versions?**
 
-The game and its libraries have become significantly more complex in the
-intervening 10+ years. By picking 3.3.5a, it's possible to imagine this
+Storm changed a lot over the years it was used. By focusing on specific
+versions of the games that used Storm, it's possible to imagine this
 implementation will eventually be complete.
 
-**Will this let me cheat in the game?**
+**Will this let me cheat in a game?**
 
 No. Storm is a standard library, and none of its routines are particularly
-relevant to the anti-cheat measures found in the game.
+relevant to the anti-cheat measures found in the games that used it.
 
 **Can I use this in my own development projects?**
 
-It's probably a bad idea. The original library remains closed source, and this
-project is in no way official.
+Maybe. Keep in mind the original library remains closed source and this
+project is in no way sanctioned or official. Also keep in mind that C++, its
+standard library, and OS-provided capabilities like memory management,
+networking stacks, and rendering frameworks have substantially improved since
+the 1990s-2010.
 
 ## Legal
 
-This project is released into the public domain.
+This project is released into the public domain. No claim is made to any
+intellectual property contained in this project.
 
 World of Warcraft: Wrath of the Lich King ©2008 Blizzard Entertainment, Inc.
 All rights reserved. Wrath of the Lich King is a trademark, and World of