From bf8dd319145869238483f15891d9f053b62ad545 Mon Sep 17 00:00:00 2001
From: "Markus F.X.J. Oberhumer" <markus@oberhumer.com>
Date: Tue, 21 Nov 2023 20:29:54 +0100
Subject: [PATCH] all: minor cleanups

---
 CMakeLists.txt              | 44 ++++++++++++++++---------------------
 misc/make/Makefile-extra.mk |  1 +
 src/packer.h                | 16 +++++++-------
 src/util/xspan.h            |  1 +
 4 files changed, 29 insertions(+), 33 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 1ed26ecb..f278fff0 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -7,18 +7,6 @@
 #   A C++ compiler that fully implements C++17: clang-5, gcc-8 or msvc-2019-16.11
 #   (older or other compilers may work but are unsupported, use at your own risk)
 
-# CMake version check; using a somewhat current CMake version is highly recommended
-if(DEFINED UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION)
-    cmake_minimum_required(VERSION "${UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION}" FATAL_ERROR)
-else()
-    cmake_minimum_required(VERSION "3.8" FATAL_ERROR) # CMake >= 3.8 is needed for CXX_STANDARD 17
-endif()
-
-macro(upx_cmake_include_hook section) # developer convenience
-    include("${CMAKE_CURRENT_SOURCE_DIR}/misc/cmake/hooks/CMakeLists.${section}.txt" OPTIONAL)
-    include("${CMAKE_CURRENT_SOURCE_DIR}/maint/make/CMakeLists.${section}.txt" OPTIONAL)
-endmacro()
-
 # Sections of this CMakeLists.txt:
 #   - options
 #   - init
@@ -29,6 +17,19 @@ endmacro()
 #   - install
 #   - print summary
 
+# CMake version check; using a somewhat current CMake version is highly recommended
+if(DEFINED UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION)
+    cmake_minimum_required(VERSION "${UPX_CONFIG_CMAKE_MINIMUM_REQUIRED_VERSION}" FATAL_ERROR)
+else()
+    cmake_minimum_required(VERSION "3.8" FATAL_ERROR) # CMake >= 3.8 is needed for CXX_STANDARD 17
+endif()
+
+# support config hooks; developer convenience
+macro(upx_cmake_include_hook section)
+    include("${CMAKE_CURRENT_SOURCE_DIR}/misc/cmake/hooks/CMakeLists.${section}.txt" OPTIONAL)
+    include("${CMAKE_CURRENT_SOURCE_DIR}/maint/make/CMakeLists.${section}.txt" OPTIONAL)
+endmacro()
+
 #***********************************************************************
 # options
 #***********************************************************************
@@ -59,7 +60,7 @@ option(UPX_CONFIG_DISABLE_SELF_PACK_TEST "Do not test packing UPX with itself" O
 # init
 #***********************************************************************
 
-upx_cmake_include_hook(2_init_begin)
+upx_cmake_include_hook(2_init)
 
 # Disallow in-source builds. Note that you will still have to manually
 # clean up a few files if you accidentally try an in-source build.
@@ -216,8 +217,6 @@ if(NOT DEFINED MINGW AND CMAKE_C_PLATFORM_ID MATCHES "^MinGW")
     set(MINGW 1)
 endif()
 
-upx_cmake_include_hook(2_init_end)
-
 #***********************************************************************
 # common compilation flags
 #***********************************************************************
@@ -228,7 +227,7 @@ include(CheckIncludeFile)
 include(CheckStructHasMember)
 include(CheckSymbolExists)
 
-upx_cmake_include_hook(3_common_compilation_flags_begin)
+upx_cmake_include_hook(3_common_compilation_flags)
 
 if(NOT DEFINED HAVE_UNISTD_H)
     check_include_file("unistd.h" HAVE_UNISTD_H)
@@ -319,6 +318,7 @@ if(MSVC_FRONTEND OR WIN32 OR MINGW OR CYGWIN)
     add_definitions(-D_CRT_SECURE_NO_DEPRECATE)
     add_definitions(-D_CRT_SECURE_NO_WARNINGS)
     add_definitions(-DWIN32_LEAN_AND_MEAN)
+    add_definitions(-D__USE_MINGW_ANSI_STDIO)
 endif()
 if(MSVC_FRONTEND)
     # use -funsigned-char; set __cplusplus according to selected C++ standard
@@ -426,8 +426,6 @@ endif()
 endif()
 endif()
 
-upx_cmake_include_hook(3_common_compilation_flags_end)
-
 #***********************************************************************
 # targets
 #***********************************************************************
@@ -437,7 +435,7 @@ set(UPX_CONFIG_DISABLE_THREADS ON) # multithreading is currently not used; maybe
 set(UPX_CONFIG_DISABLE_BZIP2 ON)   # bzip2 is currently not used; we might need it to decompress linux kernels
 set(UPX_CONFIG_DISABLE_ZSTD ON)    # zstd is currently not used; maybe in UPX version 5
 
-upx_cmake_include_hook(4_targets_begin)
+upx_cmake_include_hook(4_targets)
 
 if(NOT UPX_CONFIG_DISABLE_THREADS)
     find_package(Threads)
@@ -502,13 +500,11 @@ if(Threads_FOUND)
     target_link_libraries(upx Threads::Threads)
 endif()
 
-upx_cmake_include_hook(4_targets_end)
-
 #***********************************************************************
 # target compilation flags
 #***********************************************************************
 
-upx_cmake_include_hook(5_target_compilation_flags_begin)
+upx_cmake_include_hook(5_target_compilation_flags)
 
 if(NOT UPX_CONFIG_DISABLE_BZIP2)
 set(t upx_vendor_bzip2)
@@ -599,8 +595,6 @@ else()
     target_compile_options(${t} PRIVATE ${warn_Wall} ${warn_Werror})
 endif()
 
-upx_cmake_include_hook(5_target_compilation_flags_end)
-
 #***********************************************************************
 # test
 #   ctest
@@ -676,7 +670,7 @@ endif()
 endif() # UPX_CONFIG_CMAKE_DISABLE_INSTALL
 
 #***********************************************************************
-# show summary
+# summary
 # print some info about the build configuration
 #***********************************************************************
 
diff --git a/misc/make/Makefile-extra.mk b/misc/make/Makefile-extra.mk
index 6a489589..cfb4037d 100644
--- a/misc/make/Makefile-extra.mk
+++ b/misc/make/Makefile-extra.mk
@@ -8,6 +8,7 @@ UPX_MAKEFILE_EXTRA_MK_INCLUDED := 1
 
 override check_defined   = $(foreach 1,$1,$(if $(filter undefined,$(origin $1)),$(error ERROR: variable '$1' is not defined),))
 override check_undefined = $(foreach 1,$1,$(if $(filter undefined,$(origin $1)),,$(error ERROR: variable '$1' is already defined)))
+$(call check_defined,run_config run_build)
 $(call check_undefined,run_config_and_build)
 
 #***********************************************************************
diff --git a/src/packer.h b/src/packer.h
index 806ae767..c8f2788b 100644
--- a/src/packer.h
+++ b/src/packer.h
@@ -36,7 +36,7 @@ class UiPacker;
 class Filter;
 
 /*************************************************************************
-// purely abstract minimal base class for all packers
+// PackerBase: purely abstract minimal base class for all packers
 //
 // clients: PackMaster, UiPacker
 **************************************************************************/
@@ -61,7 +61,7 @@ public:
     // a recognized format.
     // canPack() can also return -1 to fail early; see class PackMaster
     virtual tribool canPack() = 0;
-    // canUnpack() should throw a cantUnpackException explaining why it cannot pack
+    // canUnpack() should throw a cantUnpackException explaining why it cannot unpack
     // a recognized format.
     // canUnpack() can also return -1 to fail early; see class PackMaster
     virtual tribool canUnpack() = 0;
@@ -80,16 +80,16 @@ protected:
     InputFile *const fi;                // reference
     union {                             // unnamed union
         const upx_int64_t file_size;    // must get set by constructor
-        const upx_uint64_t file_size_u; // (explicitly unsigned)
+        const upx_uint64_t file_size_u; // (explicitly unsigned to avoid casts)
     };
     PackHeader ph; // must be filled by canUnpack(); also used by UiPacker
 };
 
 /*************************************************************************
-// abstract default implementation class for packers
+// Packer: default implementation base class for all current packers
 //
-// Packer can be viewed as "PackerDefaultImplV1"; it is grown historically
-// and still would benefit from a decomposition
+// Packer can be viewed as "PackerDefaultImplVersion1"; it is grown
+// historically and really would benefit from a decomposition
 **************************************************************************/
 
 class Packer : public PackerBase {
@@ -244,7 +244,7 @@ protected:
     static unsigned unoptimizeReloc(SPAN_S(const byte) & in, MemBuffer &out, SPAN_P(byte) image,
                                     unsigned image_size, int bits, bool bswap);
 
-    // Target Endianness abstraction
+    // TE - Target Endianness abstraction
 #if 0
     // permissive version using "void *"
     inline unsigned get_te16(const void *p) const noexcept { return bele->get16(p); }
@@ -296,7 +296,7 @@ protected:
 #endif
 
 protected:
-    const N_BELE_RTP::AbstractPolicy *bele = nullptr; // target endianness
+    const N_BELE_RTP::AbstractPolicy *bele = nullptr; // TE - Target Endianness
 
     // PackHeader
     int ph_format = -1;
diff --git a/src/util/xspan.h b/src/util/xspan.h
index 6db76fec..67488e5c 100644
--- a/src/util/xspan.h
+++ b/src/util/xspan.h
@@ -48,6 +48,7 @@
 #define XSPAN_CONFIG_ENABLE_SPAN_CONVERSION 1
 #endif
 
+// actual implementation
 #include "xspan_impl.h"
 
 #ifdef XSPAN_NAMESPACE_NAME