[pre-commit.ci] Pre-commit autoupdate. (#2421)

updates:
- [github.com/pre-commit/mirrors-clang-format: v22.1.2 → v22.1.5](https://github.com/pre-commit/mirrors-clang-format/compare/v22.1.2...v22.1.5)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.clang-format

@@ -0,0 +1,41 @@
+---
+# We'll use defaults from the LLVM style, but with 4 columns indentation.
+BasedOnStyle: LLVM
+IndentWidth: 2
+---
+Language: Cpp
+DeriveLineEnding: false
+UseCRLF: true
+DerivePointerAlignment: false
+PointerAlignment: Left
+AlignConsecutiveAssignments: true
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: Empty
+AlwaysBreakTemplateDeclarations: Yes
+AccessModifierOffset: -2
+AlignTrailingComments: true
+SpacesBeforeTrailingComments: 2
+NamespaceIndentation: Inner
+MaxEmptyLinesToKeep: 1
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: true
+  AfterControlStatement: false
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: true
+  BeforeCatch: false
+  BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: true
+ColumnLimit: 88
+ForEachMacros: ['Q_FOREACH', 'foreach']

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*.cpp]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+
+[*.h]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+
+[*.ui]
+indent_style = space
+indent_size = 2
+insert_final_newline = true

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+d13f6bb870cdda71257f665367be8ef9fca86255
+86bb01ba9eac879d3685c439ac9da0028bc4bc80

.gitattributes

@@ -0,0 +1,7 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.cpp text eol=crlf
+*.h text eol=crlf

.github/ISSUE_TEMPLATE/dev-ticket.md

@@ -0,0 +1,10 @@
+---
+name: Dev Ticket
+about: Reserved for development tasks and management.
+title: ''
+labels: Dev Ticket
+assignees: ''
+
+---
+
+Task:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: Feature Request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/game-support-request.md

@@ -0,0 +1,27 @@
+---
+name: Game support Request
+about: Request support for a new game
+title: Add support for game [GAME NAME]
+labels: 'Feature Request, additional games support, area: mo2 game plugins'
+assignees: ''
+
+---
+
+**This template is useful to add basic support using https://github.com/ModOrganizer2/modorganizer-basic_games.**
+
+**If you are vaguely familiar with programming you can try following the instructions on that link to get something working yourself. If you have trouble with that please fill in this template.**
+
+**Please provide the following information for the game (remove the optional lines you do not use):**
+
+- **Name:** Name of the game
+- **Short name:** Name of the game in Nexus URL (e.g. skyrimse for Skyrim SE).
+- **Nexus ID [optional]:** ID of the game on Nexus (you can usually find this in Nexus URL).
+- **Executable:** Name of the main executable for the game (relative to the game folder).
+- **Launcher [optional]:** Name of the game launcher (relative to the game folder).
+- **Data path:** Path to the data folder of the game (relative to the game folder). Please note that the Virtual Files System often does not work for top level dlls or exe files.
+- **Documents path:** Path to folder containing INI files, etc., for the game (usually under "My Games", or the game folder itself).
+- **Saves directory [optional]:** Path to the folder containing save games (this default to the path above).
+- **Save extension [optional]:** Extension of the saves
+- **Steam ID [optional]:** ID of the game on Steam (if the game is on Steam).
+
+**Provide additional details regarding the game that could be required for the plugin.**

.github/ISSUE_TEMPLATE/issue-report.md

@@ -0,0 +1,42 @@
+---
+name: Issue Report
+about: Create an issue report.
+title: ''
+labels: issue report
+assignees: ''
+
+---
+
+## The problem:
+Briefly describe the issue you are experiencing. Tell us what you were trying to do and what happened instead. Remember, this is _not_ a place to ask questions. For that, go to our [Discord server](https://discord.gg/ewUVAqyrQX).
+
+
+## To Reproduce:
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+
+## Environment:
+
+* Mod Organizer Version that exhibits the issue:
+* Last Mod Organizer Version that did not exhibit the issue (if applicable):
+* Desktop OS/version used to run Mod Organizer:
+
+## Details:
+If necessary, describe the problem you have been experiencing with more details and pictures.
+
+
+## Link to Mod Organizer logs:
+Right click on the log window at the bottom of MO2, set log level to debug, restart Mo2 and reproduce the problem.
+To access the log files you can press the Open folder icon over the modlist and select "Open MO2 Logs folder".
+
+### USVFS:
+Create a [GIST](https://gist.github.com) which is a paste of your latest USVFS log, and link them here.
+Do _NOT_ paste your full USVFS logs here, as it will make this issue very long and hard to read!
+If you are reporting a bug, _always_ include the USVFS logs!
+
+### MO Interface:
+Create a [GIST](https://gist.github.com) which is a paste of your mo_interface logs, and link them here.
+Do _NOT_ paste your full mo_interface logs here, as it will make this issue very long and hard to read!
+If you are reporting a bug, _always_ include the mo_interface logs!

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: Build ModOrganizer 2
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+env:
+  VCPKG_BINARY_SOURCES: ${{ vars.AZ_BLOB_VCPKG_URL != '' && format('clear;x-azblob,{0},{1},readwrite', vars.AZ_BLOB_VCPKG_URL, secrets.AZ_BLOB_SAS) || '' }}
+
+jobs:
+  build:
+    runs-on: windows-2022
+    steps:
+      - name: Build ModOrganizer
+        id: build-modorganizer
+        uses: ModOrganizer2/build-with-mob-action@master
+        with:
+          qt-modules: qtpositioning qtwebchannel qtwebengine qtwebsockets qtnetworkauth
+          mo2-dependencies: usvfs uibase bsatk esptk archive lootcli
+
+      - name: Install ModOrganizer
+        shell: pwsh
+        run: |
+          cmake --install vsbuild --config RelWithDebInfo
+        working-directory: ./build/${{ github.event.repository.name }}
+
+      - name: Package ModOrganizer
+        uses: actions/upload-artifact@master
+        with:
+          name: modorganizer
+          path: ./install/bin

.github/workflows/linting.yml

@@ -0,0 +1,17 @@
+name: Lint ModOrganizer 2
+
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Check format
+        uses: ModOrganizer2/check-formatting-action@master
+        with:
+          check-path: "."
+          exclude-regex: "third-party"

.gitignore

@@ -4,9 +4,16 @@ src/moc_*.cpp
 src/ui_*.h
 src/*.qrc.depends
 src/Modorganizer.*
+src/*.bak
 CMakeLists.txt.user
 edit
-stderr.log
-stdout.log
-build
-.idea
+/CMakeFiles
+.idea/*
+!.idea/filetypes/
+!.idea/filetypes/qt-translations.xml
+/msbuild.log
+/*std*.log
+/*build
+
+/src/version.aps
+.idea/

.hgignore

@@ -1,46 +0,0 @@
-syntax: glob
-scons_configure.py
-scons-ModOrganizer-*
-ModOrganizer-build-desktop*
-outputd/*
-output/*
-build-ModOrganizer-*
-source/NCC/*/bin
-source/NCC/*/obj
-source/NCC/bin
-*.orig
-source/plugins/proxyPython/build
-staging/*
-source - Copy/*
-ModOrganizer-build-*
-pdbs/*
-source/NCC/BossDummy.x/*
-*.ts
-staging_prepare/*
-staging_trans/*
-tools/python_zip/*
-Makefile
-html
-*.vcxproj
-*.pdb
-*.dll
-*.exp
-*.tlog
-*.user
-*.obj
-*.suo
-*.sln
-*.log
-*.filters
-*.lib
-source/organizer/resources/contents/icons
-source/plugins/build-*
-*/GeneratedFiles/*
-translations/*
-source/LocalPaths.pri
-source/*/Win32/Debug/*
-source/plugins/*/Win32/Debug/*
-*~
-syntax: regexp
-Makefile\.(Debug|Release)
-source/.*/debug/.*

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: check-case-conflict
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v22.1.5
+    hooks:
+    - id: clang-format
+      'types_or': [c++, c]
+
+ci:
+  autofix_commit_msg: "[pre-commit.ci] Auto fixes from pre-commit.com hooks."
+  autofix_prs: true
+  autoupdate_commit_msg: "[pre-commit.ci] Pre-commit autoupdate."
+  autoupdate_schedule: quarterly
+  submodules: false

CMakeLists.txt

@@ -1,14 +1,21 @@
-CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
+cmake_minimum_required(VERSION 3.16)
 
-PROJECT(organizer)
+# TODO: clean include directives
+set(MO2_CMAKE_DEPRECATED_UIBASE_INCLUDE ON)
 
+project(organizer)
 
-SET(DEPENDENCIES_DIR CACHE PATH "")
-# hint to find qt in dependencies path
-LIST(APPEND CMAKE_PREFIX_PATH ${DEPENDENCIES_DIR}/qt5/lib/cmake)
-FILE(GLOB_RECURSE BOOST_ROOT ${DEPENDENCIES_DIR}/boost*/project-config.jam)
-GET_FILENAME_COMPONENT(BOOST_ROOT ${BOOST_ROOT} DIRECTORY)
+# if MO2_INSTALL_IS_BIN is set, this means that we should install directly into the
+# installation prefix, without the bin/ subfolder, typically for a standalone build
+# to update an existing install
+if (MO2_INSTALL_IS_BIN)
+	set(_bin ".")
+else()
+	set(_bin bin)
+endif()
 
-SET(ZLIB_ROOT ${DEPENDENCIES_DIR}/zlib)
+add_subdirectory(src)
 
-ADD_SUBDIRECTORY(src)
+set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT organizer)
+
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/dump_running_process.bat DESTINATION ${_bin})

CMakePresets.json

@@ -0,0 +1,71 @@
+{
+  "configurePresets": [
+    {
+      "errors": {
+        "deprecated": true
+      },
+      "hidden": true,
+      "name": "cmake-dev",
+      "warnings": {
+        "deprecated": true,
+        "dev": true
+      }
+    },
+    {
+      "cacheVariables": {
+        "VCPKG_MANIFEST_NO_DEFAULT_FEATURES": {
+          "type": "BOOL",
+          "value": "ON"
+        }
+      },
+      "toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+      "hidden": true,
+      "name": "vcpkg"
+    },
+    {
+      "binaryDir": "${sourceDir}/vsbuild",
+      "architecture": {
+        "strategy": "set",
+        "value": "x64"
+      },
+      "cacheVariables": {
+        "CMAKE_CXX_FLAGS": "/EHsc /MP /W4",
+        "VCPKG_TARGET_TRIPLET": {
+          "type": "STRING",
+          "value": "x64-windows-static-md"
+        }
+      },
+      "generator": "Visual Studio 17 2022",
+      "inherits": ["cmake-dev", "vcpkg"],
+      "name": "vs2022-windows",
+      "toolset": "v143"
+    },
+    {
+      "cacheVariables": {
+        "VCPKG_MANIFEST_FEATURES": {
+          "type": "STRING",
+          "value": "standalone"
+        },
+        "MO2_INSTALL_IS_BIN": {
+          "type": "BOOL",
+          "value": "ON"
+        }
+      },
+      "inherits": "vs2022-windows",
+      "name": "vs2022-windows-standalone"
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "vs2022-windows",
+      "resolvePackageReferences": "on",
+      "configurePreset": "vs2022-windows"
+    },
+    {
+      "name": "vs2022-windows-standalone",
+      "resolvePackageReferences": "on",
+      "configurePreset": "vs2022-windows-standalone"
+    }
+  ],
+  "version": 4
+}

dump_running_process.bat

@@ -0,0 +1,2 @@
+pushd "%~dp0"
+start ModOrganizer.exe crashdump

mappings.imp

@@ -1,30 +0,0 @@
-[
-
-# for boost???
-# These are probably correct but might need a revisit as if you look at the boost documentation pages, it
-# can give you huge lists of alternate includes...
-    { symbol: [ "BOOST_FOREACH",                            "private", "<boost/foreach.hpp>", "public" ] },
-
-    { include: [ "@\"boost/bind/.*\"",                      "private", "<boost/bind.hpp>", "public" ] },
-    { include: [ "@\"boost/algorithm/string/.*\"",          "private", "<boost/algorithm/string.hpp>", "public" ] },
-    { include: [ "@\"boost/assign/.*\"",                    "private", "<boost/assign.hpp>", "public" ] },
-    { include: [ "@\"boost/filesystem/.*\"",                "private", "<boost/filesystem.hpp>", "public" ] },
-    { include: [ "@\"boost/format/.*\"",                    "private", "<boost/format.hpp>", "public" ] },
-    { include: [ "@\"boost/function/.*\"",                  "private", "<boost/function.hpp>", "public" ] },
-    { include: [ "@\"boost/local/.*\"",                     "private", "<boost/locale.hpp>", "public" ] },
-    { include: [ "@\"boost/python/.*\"",                    "private", "<boost/python.hpp>", "public" ] },
-    { include: [ "@\"boost/signals2/.*\"",                  "private", "<boost/signals2.hpp>", "public" ] },
-    { include: [ "\"boost/smart_ptr/scoped_array.hpp\"",    "private", "<boost/scoped_array.hpp>", "public" ] },
-    { include: [ "\"boost/smart_ptr/shared_ptr.hpp\"",      "private", "<boost/shared_ptr.hpp>", "public" ] },
-    # this appears to be excessive
-    #{ include: [ "@\"boost/thread/.*\"",                    "private", "<boost/thread.hpp>", "public" ] },
-
-# And this is specific to us
-    { include: [ "\"appconfig.inc\"", "private", "\"appconfig.h\"", "public" ] },
-
-]
-
-# Ones I don't yet know how to deal with
-#include "boost/fusion/container/vector/vector10_fwd.hpp"  // for fusion
-#include "boost/iterator/iterator_facade.hpp"  // for operator!=
-#include "boost/iterator/iterator_facade.hpp"

massage_messages.py

@@ -35,7 +35,7 @@ removing = None
 includes = dict()
 
 adding = None
-added = dict()
+added = defaultdict(list)
 lcadded = dict()
 
 foundline = None
@@ -70,10 +70,10 @@ def process_next_line(line, outfile):
     elif adding:
         m = re.match(r'.*class (.*);', line)
         if m:
-            added[m.group(1)] = (adding, line)
+            added[m.group(1)].append((adding, line))
             lcadded[m.group(1).lower() + '.h'] = m.group(1)
         else:
-            added[line] = (adding, line)
+            added[line].append((adding, line))
     elif removing:
         # Really we should stash these so that if we get a 'class xxx' in
         # the add lines we can print it here. also we could do the case
@@ -88,10 +88,12 @@ def process_next_line(line, outfile):
                 if clname in lcadded:
                     clname = lcadded[clname]
             if clname in added:
-                messages[removing].append(
-                    '%s(%s) : warning I0004: Replace include of %s with '
-                        'forward reference %s' % (
-                        removing, m.group(2), m.group(1), added[clname][1]))
+                for item in added[clname]:
+                    if removing == item[0]:
+                        messages[removing].append(
+                            '%s(%s) : warning I0004: Replace include of %s'
+                            ' with forward reference %s' % (
+                                     removing, m.group(2), m.group(1), item[1]))
                 del added[clname]
             else:
                 messages[removing].append(
@@ -140,9 +142,10 @@ if foundline is None:
     foundline = '1'
 
 for add in added:
-    messages[added[add][0]].append(
-        '%s(%s) : warning I0003: Need to include %s' % (
-                                       added[add][0], foundline, added[add][1]))
+    for item in added[add]:
+        messages[item[0]].append(
+            '%s(%s) : warning I0003: Need to include %s' % (
+                                                   item[0], foundline, item[1]))
 
 for file in sorted(messages.keys(), reverse = True):
     for line in messages[file]: