Add MSVC support

Author: GoGoOtaku

.clang-format

@@ -5,7 +5,7 @@ AlignAfterOpenBracket: Align
 AlignArrayOfStructures: Left
 AlignConsecutiveAssignments:
   Enabled:         true
-  AcrossEmptyLines: true
+  AcrossEmptyLines: false
   AcrossComments:  true
   AlignCompound:   false
   PadOperators:    true
@@ -17,7 +17,7 @@ AlignConsecutiveBitFields:
   PadOperators:    false
 AlignConsecutiveDeclarations:
   Enabled:         true
-  AcrossEmptyLines: true
+  AcrossEmptyLines: false
   AcrossComments:  true
   AlignCompound:   false
   PadOperators:    false

CMakeLists.txt

@@ -1,18 +1,83 @@
 cmake_minimum_required(VERSION 3.20.0)
-project(readpe)
+
+set(CMAKE_DISABLE_SOURCE_CHANGES ON)
+set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+
+project(readpe LANGUAGES C VERSION 1.0.0)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 option(BUILD_DISASSEMBLER "Build with basic disassembler support (deprecated)" OFF)
-option(BUILD_LEGACY "Build support for legacy executables by link name" ON)
-option(BUILD_STANDALONE "Build separate executables" OFF)
-option(BUILD_STATIC "Build static executable" Off)
 option(ENABLE_TESTS "Enable testing" On)
 
+option(READPE_LEGACY "Build support for legacy executables by link name" ON)
+
+# TODO:
+# option(READPE_STANDALONE "Build separate executables" OFF)
+
+option(LIBPE_STATIC "Link libpe into readpe staticially" Off)
+
+set(DEFAULT_LINK_SSDEEP OFF)
+if(LIBPE_STATIC)
+    set(DEFAULT_LINK_SSDEEP ON)
+endif()
+
+option(LIBPE_LINK_SSDEEP "LINK SSDEEP GPL2 code into libpe" ${DEFAULT_LINK_SSDEEP})
+
+include(dependencies)
+
+if(MSVC)
+    # vcpkg on Linux has issues hijacking find_package for Windows packages
+    # Maybe I can figure out how this works better at some point
+    # It might come down to running vcpkg through wine also
+    # Anyway this is a workaround for a niche case of a niche case
+    if(CMAKE_HOST_SYSTEM_NAME MATCHES "Linux")
+        include(cmake/toolchains/msvc-wine.cmake)
+
+        # My wine installation of msvc does not like my CRT
+        add_definitions(
+            -D_CRT_SECURE_NO_WARNINGS
+        )
+
+        set(OPENSSL_ROOT_DIR ${VCPKG_ROOT}/installed/x64-windows)
+    endif()
+
+    add_definitions(
+        -D_SLURP_EXECUTABLE
+    )
+
+    # MSVC debug builds also require urctbased.dll and VCRUNTIME140D.dll
+    # This does not affect RelWithDebInfo
+
+    # TODO: This might not work on windows
+    install(PROGRAMS
+        "${VCPKG_ROOT}/installed/x64-windows/bin/libcrypto-3-x64.dll"
+        DESTINATION bin
+    )
+endif()
+
+if(CYGWIN)
+    # TODO: These are probably not needed anymore
+    ##  cp $(PEV_DIR)/userdb.txt $(ZIPDIR)
+    ##  cp $(PEV_DIR)/windows/run.bat $(ZIPDIR)/
+    install(PROGRAMS
+        /usr/bin/cygwin1.dll
+        /usr/bin/cygcrypto-3.dll
+        /usr/bin/cygz.dll
+        DESTINATION bin
+    )
+endif()
+
 if(BUILD_DISASSEMBLER)
-    add_subdirectory(lib/libudis86/libudis86)
+    add_subdirectory(lib/udis86/libudis86)
+endif()
+
+if(LIBPE_LINK_SSDEEP)
+    add_subdirectory(lib/fuzzy)
 endif()
 
+add_subdirectory(lib/compat)
 add_subdirectory(lib/libpe)
 add_subdirectory(src/plugins)
 add_subdirectory(src)
@@ -21,28 +86,23 @@ if(ENABLE_TESTS)
     include("${CMAKE_SOURCE_DIR}/cmake/tests.cmake")
 endif()
 
-set(
-    CPACK_PACKAGE_NAME ${PROJECT_NAME}
-    CACHE STRING "The resulting package name"
-)
-
-
-set(CPACK_STRIP_FILES YES)
-
-
+set(CPACK_PACKAGE_NAME ${PROJECT_NAME})
 set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
 set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
 set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
+set(CPACK_RESOURCE_FILE_README  "${CMAKE_SOURCE_DIR}/README.md")
+set(CPACK_STRIP_FILES YES)
 
-
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
-set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
-
+install(FILES
+    "${CPACK_RESOURCE_FILE_LICENSE}"
+    "${CPACK_RESOURCE_FILE_README}"
+    TYPE DOC
+)
 
 include(CPack)
-configure_file ("${PROJECT_SOURCE_DIR}/cmake/cpackopt.cmake.in"
-                "${PROJECT_BINARY_DIR}/cpackopt.cmake"
-                @ONLY)
-set (CPACK_PROJECT_CONFIG_FILE
-     "${PROJECT_BINARY_DIR}/cpackopt.cmake")
+configure_file("${PROJECT_SOURCE_DIR}/cmake/cpackopt.cmake.in"
+               "${PROJECT_BINARY_DIR}/cpackopt.cmake"
+               @ONLY)
+set(CPACK_PROJECT_CONFIG_FILE "${PROJECT_BINARY_DIR}/cpackopt.cmake")
 

Makefile

@@ -10,35 +10,37 @@ and analyze PE (Portable Executables) binaries.
 ## How to build on Linux
 
     cd readpe
-    make
+    cmake -B build
+    cmake --build build
 
-**NOTE**: You may need to install OpenSSL using your package manager. Examples:
+**NOTE**: You may need to install CMake, and OpenSSL using your package manager. Examples:
 
-    apt install libssl-dev
-    yum install openssl-devel
+    apt install cmake libssl-dev
+    yum install cmake3 openssl-devel
 
 ## How to install on Linux
 
     cd readpe
-    sudo make install
+    sudo cmake --install build
     echo "/usr/local/lib" | sudo tee /etc/ld.so.conf.d/libpe.conf
     sudo ldconfig
 
 ## How to build on macOS
 
     cd readpe
-    CFLAGS="-I/usr/local/opt/openssl/include/" LDFLAGS="-L/usr/local/opt/openssl/lib/" make
+    CFLAGS="-I/usr/local/opt/openssl/include/" LDFLAGS="-L/usr/local/opt/openssl/lib/" cmake -B build
+    cmake --build build
 
-**NOTE**: You may need to install OpenSSL and PCRE via [Homebrew](https://brew.sh):
+**NOTE**: You may need to install CMake, OpenSSL and PCRE via [Homebrew](https://brew.sh):
 
     brew update
-    brew install openssl
+    brew install cmake openssl
 
-## How to build on Windows (via [Cygwin](https://cygwin.com))
+## How to build on Windows using [Cygwin](https://cygwin.com))
 
     cd readpe
-    make
-    make zip
+    cmake -B build
+    cmake --build build
 
 **NOTE**: The following packages must be installed along with your Cygwin:
 
@@ -48,9 +50,15 @@ and analyze PE (Portable Executables) binaries.
 | Devel    | binutils      |
 | Devel    | gcc-core      |
 | Devel    | git           |
-| Devel    | make          |
+| Devel    | cmake         |
 | Net      | libssl-devel  |
 
+## How to build on Windows using Visual Studio [EXPERIMENTAL]
+
+Open CMakeLists.txt in Visual Studio.
+
+This is still highly experimental and bug reports are highly appriciated.
+
 ## FAQ
 
 ### Is this pev? / What happened to pev?
@@ -84,4 +92,69 @@ This project is licensed under the GNU General Public License version 2
 with the exception of the contents of lib/libpe which are licensed under the
 GNU Lesser General Public License version 3.
 
-A copy of these licenses can be found respectively in the project root and lib/libpe.
+A copy of these licenses can be found respectively
+in the project root and lib/libpe folders.
+
+### Acknowledgments
+
+Sources are given as acknowledgement for the original authors
+and do not represent an endorsement of this project by said authors.
+
+#### lib/compat/asprintf.c
+
+Code written by [Thomas Gamper](https://github.com/eiszapfen2000/asprintf)
+Licensed under [BSD-3-Clause License](https://opensource.org/license/bsd-3-clause)
+
+#### lib/compat/strlcat.c
+
+Code from the [OpenBSD Project](https://www.openbsd.org/)
+Licensed under [ISC License](https://opensource.org/license/isc)
+
+#### lib/compat/getopt.c lib/compat/include/getopt.h
+
+Code from the [GNU C Library](https://sourceware.org/glibc)
+Licensed under [LGPL-2.1+](https://opensource.org/license/lgpl-2-1)
+
+#### lib/compat/include/unistd.h
+
+Code from [win32ports/unistd_h](https://github.com/win32ports/unistd_h)
+Licensed under the [MIT License](https://opensource.org/license/mit)
+
+#### lib/compat/include/sys/queue.h
+
+Code from the [FreeBSD Project](https://www.freebsd.org/)
+Licensed under [BSD-3-Clause License](https://opensource.org/license/bsd-3-clause)
+
+#### lib/fuzzy
+
+Code from [SSDeep Project](https://ssdeep-project.github.io/ssdeep/index.html)
+Licensed under [GPL-2.0+](https://opensource.org/license/gpl-2.0)
+
+#### lib/udis86 include/udis86.h
+
+Code from [Udis86 library](https://sourceforge.net/projects/udis86/)
+Licensed under [BSD-2-Clause License](https://opensource.org/license/bsd-2-clause)
+
+#### src/dylib.c src/dylib.h src/stack.h
+
+Code written by Jardel Weyrich
+Licensed under [MIT License](https://opensource.org/license/mit)
+
+### Static linked libraries
+
+#### uthash
+
+Project can be found [here](https://troydhanson.github.io/uthash/)
+Source code can be found [here](https://github.com/troydhanson/uthash)
+Licensed under [BSD-1-Clause](https://opensource.org/license/bsd-1-clause)
+
+#### dirent
+
+Project can be found [here](https://github.com/tronkko/dirent)
+Licensed under [MIT License](https://opensource.org/license/mit)
+
+#### dlfcn-win32
+
+Project can be found [here](https://github.com/dlfcn-win32/dlfcn-win32)
+Licensed under [MIT License](https://opensource.org/license/mit)
+

README.md

@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+
+ARCH=${ARCH:-"x64"}
+BIN=${BIN:-"/opt/msvc/bin/$ARCH"}
+
+ARCH=$(. "$BIN/msvcenv.sh" && echo $ARCH)
+mkdir -p msvc-wine
+
+export VCPKG_ROOT=/opt/msvc/VC/vcpkg
+
+cat >msvc-wine/$ARCH-windows.cmake <<EOF
+set(VCPKG_TARGET_ARCHITECTURE $ARCH)
+set(VCPKG_CRT_LINKAGE dynamic)
+set(VCPKG_LIBRARY_LINKAGE dynamic)
+# set(VCPKG_BUILD_TYPE release)
+set(VCPKG_CHAINLOAD_TOOLCHAIN_FILE \${VCPKG_ROOT_DIR}/scripts/toolchains/mingw.cmake)
+
+set(VCPKG_POLICY_ALLOW_OBSOLETE_MSVCRT enabled)
+set(VCPKG_TARGET_IS_MINGW ON)
+set(ENV{CC} x86_64-w64-mingw32-gcc)
+set(ENV{CXX} x86_64-w64-mingw32-g++)
+
+set(ENV{PATH} "$BIN:\$ENV{PATH}")
+EOF
+
+#  
+# Install dependencies with classic mode
+vcpkg install --vcpkg-root=$VCPKG_ROOT --triplet=x64-windows --overlay-triplets=./msvc-wine
+
+cat >msvc-wine/$ARCH-windows.cmake <<EOF
+set(VCPKG_TARGET_ARCHITECTURE $ARCH)
+set(VCPKG_CRT_LINKAGE dynamic)
+set(VCPKG_LIBRARY_LINKAGE dynamic)
+# set(VCPKG_BUILD_TYPE release)
+set(VCPKG_DISABLE_COMPILER_TRACKING ON)
+set(VCPKG_CHAINLOAD_TOOLCHAIN_FILE \${VCPKG_ROOT_DIR}/scripts/toolchains/windows.cmake)
+
+set(ENV{CC} cl.exe)
+set(ENV{CXX} cl.exe)
+
+set(ENV{PATH} "$BIN:\$ENV{PATH}")
+EOF
+
+CMAKE_ARGS=(
+    -G"Ninja Multi-Config"
+    -DCMAKE_C_COMPILER=$BIN/cl
+    -DCMAKE_CXX_COMPILER=$BIN/cl
+    -DCMAKE_SYSTEM_NAME=Windows
+    -DVCPKG_TARGET_TRIPLET=x64-windows
+    -DVCPKG_OVERLAY_TRIPLETS=./msvc-wine
+    -DVCPKG_MANIFEST_INSTALL=OFF
+    -DVCPKG_MANIFEST_MODE=ON
+    -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake
+    -DOpenSSL_DIR=$VCPKG_ROOT/installed/x64-windows/share/openssl
+)
+
+# Vcpkg uses pwsh and dumpbin to copy dependencies into the output directory for executables.
+if command -v pwsh &>/dev/null; then
+    echo "Powershell installed!"
+    export PATH=$BIN:$PATH
+else
+    CMAKE_ARGS+=(
+        -DVCPKG_APPLOCAL_DEPS=OFF
+    )
+fi
+
+case $OSTYPE in
+    darwin*)
+        CMAKE_ARGS+=(
+            # No winbind package available on macOS.
+            # https://github.com/mstorsjo/msvc-wine/issues/6
+            -DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=Embedded
+        ) ;;
+esac
+
+# CMAKE_CONFIG=Debug
+CMAKE_CONFIG=RelWithDebInfo
+# CMAKE_CONFIG=Release
+
+cmake -B msvc-wine -DCMAKE_BUILD_TYPE=${CMAKE_CONFIG}  "${CMAKE_ARGS[@]}"
+cmake --build msvc-wine --config ${CMAKE_CONFIG} -- -v
+
+cd msvc-wine
+cpack -C ${CMAKE_CONFIG} -G 7Z
+