Fixes #815.

.clang-format

@@ -0,0 +1,15 @@
---
Language: Cpp
BasedOnStyle: Google

AccessModifierOffset: -2
AllowAllParametersOfDeclarationOnNextLine: false
AllowShortIfStatementsOnASingleLine: false
BinPackArguments: false
BinPackParameters: false
BreakConstructorInitializers: AfterColon
ConstructorInitializerAllOnOneLineOrOnePerLine: true
FixNamespaceComments: false
SpaceAfterTemplateKeyword: false
Standard: Cpp11
...

.gitignore

@@ -44,11 +44,14 @@ Thumbs.db
# Other #
#########

.vscode/
*.user
*.suo
*.sdf
*.opensdf
build
*.mo
bower_components
node_modules
*.pb.h
*.pb.cc
coverage/

.travis.yml

@@ -8,6 +8,8 @@ addons:
      - ubuntu-toolchain-r-test # ppa:ubuntu-toolchain-r/test
    packages:
      - libbz2-dev
      - libhttp-parser-dev
      - libssh2-1-dev
      - libssl-dev
      - gcc-5
      - g++-5
@@ -19,48 +21,48 @@ addons:
      - libxss-dev
      - libasound2-dev
      - libxtst-dev
      # Scripting dependencies
      - imagemagick

cache:
  directories:
    - $TRAVIS_BUILD_DIR/node_modules
    - $TRAVIS_BUILD_DIR/bower_components
    - $HOME/boost_1_61_0/boost
    - $HOME/boost_1_61_0/stage/lib
    - $HOME/boost_1_67_0/boost
    - $HOME/boost_1_67_0/stage/lib
  yarn: true

before_install:
  - nvm install 8
  - curl -o- -L https://yarnpkg.com/install.sh | bash -s -- --version 1.3.2
  - export PATH=$HOME/.yarn/bin:$PATH

install:
  # Use GCC 5.
  - if [ "$CXX" = "g++" ]; then export CXX="g++-5" CC="gcc-5"; fi
  - export CXXFLAGS="-fPIC" CFLAGS="-fPIC"
  # Install the latest stable Node.js. The default Node.js version is too old
  # for some of the JavaScript syntax used.
  - npm install -g nvm
  - nvm install node
  # Install Node.js dependencies
  - npm install
  - yarn install
  # Add local binary path to PATH
  - export PATH="./node_modules/.bin:$PATH"
  # Install runtime dependencies using Bower
  - bower install
  # Install Boost
  - wget https://raw.githubusercontent.com/WrinklyNinja/ci-scripts/1.0.0/install_boost.py
  - python install_boost.py --directory ~ --boost-version 1.61.0 atomic chrono date_time filesystem iostreams locale log regex system thread
  - python install_boost.py --directory ~ --boost-version 1.67.0 filesystem locale system
  # Install packages for generating documentation
  - pip install --user sphinx sphinx_rtd_theme
  - pip install --user -r docs/requirements.txt
  # Add sphinx-build to PATH
  - export PATH="$HOME/.local/bin:$PATH"
  # Get CMake (version available in repositories is too old, needs to be 3.1+)
  - wget --no-check-certificate https://cmake.org/files/v3.7/cmake-3.7.2-Linux-x86_64.tar.gz
  - tar -xzf cmake-3.7.2-Linux-x86_64.tar.gz
  - export PATH=$PWD/cmake-3.7.2-Linux-x86_64/bin:$PATH
  - wget https://github.com/WrinklyNinja/svg_to_ico/releases/download/0.1.0/svg_to_ico.tar.xz
  - tar -xJf svg_to_ico.tar.xz

before_script:
  - mkdir build
  - node scripts/create_ico.js
  - ./svg_to_ico -i resources/icon.svg -o build/icon/icon.ico
  # Move into the cloned LOOT repo build path.
  - cd build
  # Link dynamically to the C++ standard library runtime.
  - cmake .. -DBOOST_ROOT=~/boost_1_61_0
  - cmake .. -DBOOST_ROOT=~/boost_1_67_0

script:
  - make all

CONTRIBUTING.md

@@ -66,17 +66,17 @@ Some strings to be translated may contain special characters. Different types of

If you're adding a new translation, LOOT's source code must be updated to recognise it. You can do this yourself and include the changes in your translation's pull request if you wish. The files and functions which must be updated are given below.

* The [LOOT API](https://github.com/loot/loot-api) must be updated to support the language, see its CONTRIBUTING.md for details.
* In [get_languages_query.h](src/gui/cef/query/get_languages_query.h), add the language's ISO code and name to the map returned by `getLanguages()`.
* In [archive.js](scripts/archive.js), add the language folder to the list returned by `getLanguageFolders()`.
* In [installer.iss](scripts/installer.iss), add an entry for your language's translation file to the `[Files]` section.

## Code Style

LOOT's JavaScript uses a slightly tweaked version of the Airbnb style, and can be automatically linted by ESLint, so isn't covered here.
LOOT's JavaScript code style is codified by the included ESLint configuration, which is based off the Airbnb and Prettier rules.

### C++ Code Style

The [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) is used as the base, with deviations as listed below.
The [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) is used as the base, with deviations as listed below. Formatting style is codified in the repository's `.clang-format` file, but is not enforced.

#### C++ Features

@@ -91,8 +91,3 @@ The [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)

* Constant, enumerator and variable names should use `camelCase` or `underscore_separators`, but they should be consistent within the same scope.
* Function names should use `PascalCase` or `camelCase`, but they should be consistent within the same scope.

#### Formatting

* Line length doesn't matter.
* `public`, `protected` and `private` keywords should not be indented within a class declaration.

README.md

@@ -2,11 +2,11 @@

[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/loot/loot?branch=dev&svg=true)](https://ci.appveyor.com/project/WrinklyNinja/loot)
[![Travis Build Status](https://travis-ci.org/loot/loot.svg?branch=dev)](https://travis-ci.org/loot/loot)
[![Documentation Status](https://readthedocs.org/projects/loot/badge/?version=latest)](http://loot.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/loot/badge/?version=latest)](https://loot.readthedocs.io/en/latest/?badge=latest) [![Greenkeeper badge](https://badges.greenkeeper.io/loot/loot.svg)](https://greenkeeper.io/)

## Introduction

LOOT is a plugin load order optimisation tool for TES IV: Oblivion, TES V: Skyrim, TES V: Skyrim Special Edition, Fallout 3, Fallout: New Vegas and Fallout 4. It is designed to assist mod users in avoiding detrimental conflicts, by automatically calculating a load order that satisfies all plugin dependencies and maximises each plugin's impact on the user's game.
LOOT is a plugin load order optimisation tool for TES IV: Oblivion, TES V: Skyrim, TES V: Skyrim Special Edition, Skyrim VR, Fallout 3, Fallout: New Vegas, Fallout 4 and Fallout 4 VR. It is designed to assist mod users in avoiding detrimental conflicts, by automatically calculating a load order that satisfies all plugin dependencies and maximises each plugin's impact on the user's game.

LOOT also provides some load order error checking, including checks for requirements, incompatibilities and cyclic dependencies. In addition, it provides a large number of plugin-specific usage notes, bug warnings and Bash Tag suggestions.

@@ -16,7 +16,7 @@ LOOT is intended to make using mods easier, and mod users should still possess a

## Downloads

Releases are hosted on [GitHub](https://github.com/loot/loot/releases), and snapshot builds are available on [Bintray](https://bintray.com/wrinklyninja/loot). The snapshot build archives are named like so:
Releases are hosted on [GitHub](https://github.com/loot/loot/releases), and snapshot builds are available on [Bintray](https://bintray.com/loot/snapshots/loot). The snapshot build archives are named like so:

```
loot_<last tag>-<revisions since tag>-g<short revision ID>_<branch>.7z
@@ -50,7 +50,7 @@ You may also need to set `BOOST_ROOT` if CMake cannot find Boost.

### Rebuilding the HTML UI

The GUI's HTML file is automatically built when building the LOOT GUI binary, but it can also be built by running `node scripts/build_ui.js` from the repository root.
The GUI's HTML file is automatically built when building the LOOT GUI binary, but it can also be built by running `yarn build` from the repository root.

## Building The Documentation

@@ -67,4 +67,4 @@ Packaging scripts are provided for creating an installer on Windows and compress

Run the `scripts/installer.iss` [Inno Setup](http://www.jrsoftware.org/isinfo.php) script to build an installer executable in the `build` folder. The script requires the [Inno Download Plugin](https://bitbucket.org/mitrich_k/inno-download-plugin) to be installed. If the unofficial Korean and Simplified Chinese Inno Setup translation files are installed alongside the official translation files, then the installer script will also offer those language options. If they are not found, the installer will be built without them.

The archive packaging script requires [Git](https://git-scm.com/), and on Windows it also requires [7-Zip](http://7-zip.org), while on Linux it requires `tar` and `xz`. It can be run using `node scripts/archive.js`, and creates an archive for LOOT in the `build` folder. The archives are named as described in the Downloads section above.
The archive packaging script requires [Git](https://git-scm.com/), and on Windows it also requires [7-Zip](https://www.7-zip.org/), while on Linux it requires `tar` and `xz`. It can be run using `node scripts/archive.js`, and creates an archive for LOOT in the `build` folder. The archives are named as described in the Downloads section above.

appveyor.yml

@@ -6,54 +6,53 @@ configuration: Release

cache:
  - node_modules
  - bower_components
  - C:\projects\boost_1_61_0\boost
  - C:\projects\boost_1_61_0\stage\32\lib
  - "%LOCALAPPDATA%\\Yarn"

environment:
  github_auth_token:
    secure: V1GojGQfrAiQtUWtNNXfm3samiH+1yNF5UYhkn8B8mbif20IGTGWNlBS9E4S0SUC
    secure: yDqT5l/e5MntbW99V6+MHlfFgNv+UIogFfeyUVqtFk5lFRB/dAraLLwKCLl6y+DH
  bintray_auth_token:
    secure: fBQJmUDK/EgEUWjjbo6bWcitczeFTJZT4OZ3ZZ4FoUT6soBsTWPQJnr8YEVMFhGP
    secure: PgsEA6TjHVf718zMnK7J/fT1hUAVNKBeWhpYgYaeCyeZk37VT4Ics6j7+B7ElLEr

install:
  - choco install -y InnoSetup imagemagick.tool
  - python -m pip install sphinx sphinx_rtd_theme
  - npm install
  - .\node_modules\.bin\bower install
  - ps: (New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/WrinklyNinja/ci-scripts/1.1.0/install_boost.py', "$env:APPVEYOR_BUILD_FOLDER\install_boost.py")
  - ps: (New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/WrinklyNinja/ci-scripts/1.2.0/delete_old_bintray_versions.py', "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py")
  - ps: python $env:APPVEYOR_BUILD_FOLDER\install_boost.py -d C:\projects -b 1.61.0 -a 32 atomic chrono date_time filesystem iostreams locale log regex system thread
  - ps: Install-Product node LTS
  - python -m pip install -r docs/requirements.txt
  - yarn install
  - ps: (New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/WrinklyNinja/ci-scripts/2.0.0/delete_old_bintray_versions.py', "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py")
  - ps: (New-Object Net.WebClient).DownloadFile('https://github.com/WrinklyNinja/svg_to_ico/releases/download/0.1.0/svg_to_ico.7z', "$env:APPVEYOR_BUILD_FOLDER\svg_to_ico.7z")
  - 7z e -y svg_to_ico.7z


before_build:
  - cd %APPVEYOR_BUILD_FOLDER%
  - ps: mkdir build
  - set PATH=C:\ProgramData\chocolatey\lib\imagemagick.tool\tools;%PATH%;C:\Program Files\Inkscape
  - node scripts\create_ico.js
  - .\svg_to_ico.exe -i resources\icon.svg -o build\icon\icon.ico
  - cd build
  - cmake .. -G "Visual Studio 14 2015" -DBOOST_ROOT="C:/projects/boost_1_61_0" -DBOOST_LIBRARYDIR="C:/projects/boost_1_61_0/stage/32/lib"
  - cmake .. -G "Visual Studio 14 2015" -DBOOST_ROOT="C:\Libraries\boost_1_67_0" -DBOOST_LIBRARYDIR="C:\Libraries\boost_1_67_0\lib32-msvc-14.0" -DMSVC_STATIC_RUNTIME=ON

build:
  verbosity: minimal
  project: '$(APPVEYOR_BUILD_FOLDER)\build\LOOT.sln'

test_script:
  - cd %APPVEYOR_BUILD_FOLDER%
  - npm test
  - yarn lint
  - yarn test
  - cd %APPVEYOR_BUILD_FOLDER%\build\%CONFIGURATION%
  - .\loot_gui_tests.exe --gtest_output=xml:loot_gui_tests.xml

after_test:
  - cd %APPVEYOR_BUILD_FOLDER%
  - C:\Python27\Scripts\sphinx-build -b html docs build\docs\html
  - ps: $env:GIT_DESCRIBE = ((git describe --tags --long --abbrev=7) | Out-String) -replace "`n|`r", ""
  - ps: $env:LOOT_VERSION = "${env:GIT_DESCRIBE}_$env:APPVEYOR_REPO_BRANCH" -replace '[/<>"|]', '-'
  - ps: $env:PATH = "$env:PATH;C:\cygwin\bin\"
  - node scripts\potomo.js
  - ps: scripts\appveyor\build_installer.ps1
  - node scripts\archive.js

artifacts:
  - path: build\loot_$(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH).7z
  - path: build\loot_$(LOOT_VERSION).7z
    name: LOOT
  - path: build\LOOT Installer.exe
    name: installer
@@ -62,34 +61,33 @@ deploy:
  - provider: BinTray
    username: wrinklyninja
    api_key:
      secure: fBQJmUDK/EgEUWjjbo6bWcitczeFTJZT4OZ3ZZ4FoUT6soBsTWPQJnr8YEVMFhGP
    subject: wrinklyninja
    repo: loot
      secure: PgsEA6TjHVf718zMnK7J/fT1hUAVNKBeWhpYgYaeCyeZk37VT4Ics6j7+B7ElLEr
    subject: loot
    repo: snapshots
    package: loot
    version: $(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)
    version: $(LOOT_VERSION)
    publish: true
    override: true
    artifact: LOOT

  - provider: GitHub
    tag: $(APPVEYOR_REPO_TAG_NAME)
    release: LOOT v$(APPVEYOR_REPO_TAG_NAME)
    description: |
      Requires Windows 7 or later and the [MSVC 2015 x86 redistributable](https://download.microsoft.com/download/6/A/A/6AA4EDFF-645B-48C5-81CC-ED5963AEAD48/vc_redist.x86.exe), and [7-Zip](http://www.7-zip.org/) to extract the archives.

      ## Change Logs
      - [Application](https://loot.readthedocs.io/en/$(APPVEYOR_REPO_TAG_NAME)/app/changelog.html)

      *Note: The files below with `tar.xz` extensions contain Linux binaries. They won't work on Windows computers.*
      Requires Windows 7 or later and the [MSVC 2015 x86 redistributable](https://download.microsoft.com/download/6/A/A/6AA4EDFF-645B-48C5-81CC-ED5963AEAD48/vc_redist.x86.exe), and [7-Zip](https://www.7-zip.org/) to extract the archives. The list of changes can be found [here](https://loot.readthedocs.io/en/$(APPVEYOR_REPO_TAG_NAME)/app/changelog.html).
    auth_token:
      secure: V1GojGQfrAiQtUWtNNXfm3samiH+1yNF5UYhkn8B8mbif20IGTGWNlBS9E4S0SUC
      secure: yDqT5l/e5MntbW99V6+MHlfFgNv+UIogFfeyUVqtFk5lFRB/dAraLLwKCLl6y+DH
    artifact: LOOT,installer
    draft: false
    force_update: true
    on:
      appveyor_repo_tag: true

on_success:
  - ps: python "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py" -o loot -g loot -u wrinklyninja -b loot -p loot -t $env:bintray_auth_token -a $env:github_auth_token -n 30
  - ps: |
      if ($env:bintray_auth_token -And $env:github_auth_token) {
        python "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py" -g loot/loot -b loot/snapshots/loot -u wrinklyninja -k $env:bintray_auth_token -t $env:github_auth_token -n 30
      }
  - ps: scripts\appveyor\update_masterlist_branches.ps1

on_finish: