Set version number to 4.0.2

Avoid having to copy the test script by modifying PYTHONPATH at runtime,
and move the test script into the test directory.

.gitignore

@@ -50,3 +50,5 @@ $RECYCLE.BIN/
 
 # Windows shortcuts
 *.lnk
+
+.vscode/

.travis.yml

@@ -1,47 +0,0 @@
-sudo: false
-language: cpp
-compiler: gcc
-
-addons:
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test           # ppa:ubuntu-toolchain-r/test
-    packages:
-      - gcc-5
-      - g++-5
-      - wget
-
-install:
-  # Use GCC 5.
-  - if [ "$CXX" = "g++" ]; then export CXX="g++-5" CC="gcc-5"; fi
-  # Download CMake binary because those available in PPAs either don't support
-  # xz downloads or don't support HTTPS.
-  - wget https://cmake.org/files/v3.6/cmake-3.6.2-Linux-x86_64.tar.gz
-  - tar -xf cmake-3.6.2-Linux-x86_64.tar.gz
-
-before_script:
-  # Move into the cloned LOOT repo build path.
-  - mkdir build && cd build
-  # Link dynamically to the C++ standard library runtime.
-  - ../cmake-3.6.2-Linux-x86_64/bin/cmake ..
-
-script:
-  - make all
-  - python -m unittest test
-
-after_success:
-  - ../cmake-3.6.2-Linux-x86_64/bin/cpack -C Release
-  - cd $TRAVIS_BUILD_DIR
-  # Need to replace the Bintray config files' version placeholders.
-  - VERSION=$(ls build/package/loot_api_python-*.tar.xz | sed 's/build\/package\/loot_api_python-//;s/-Linux.tar.xz//;')
-  - sed -i "s/REPLACE_THIS_VERSION/${VERSION}/" scripts/travis/loot-api.bintray.json
-
-deploy:
-  - provider: bintray
-    file: scripts/travis/loot-api.bintray.json
-    user: wrinklyninja
-    key:
-      secure: "XUj1hk5lNhyzPNs3iv1kw8h370QrS+hOcGvj7fMkMb3KQF+I7XJIIhi5lcVd/X5NB79M4IYKac+7n4fVPsf6jXd+SpKYKdPF5ZnSn00dtU34Jhz+DiZQoLdAVLhGgOTLxv2SE6kfvfCXXVlSSoVOVNH0rx0OWE/BjZaSxd9+XeQgEJ/qozvt9kl4sd02y/M4r9h4SAMGf3zav+PWy+5cigy/LFONDQ9oeCEOJmVbazlB2Hkt0GnRkPpW/jFjUvt5qs0jS1neBBmeVCxvue1qJVJBwPtIszNhoARn/mY1tfQ4b0MdzvYhK1kjHvtBLW+OoXOr5VaiZ2a0J+t7jtgfO2cadiIgqCbxddltq1CESFa3pSCpkAfSg1jkl3Lj7BJzSLrRLxySN+Hq0O4qR3A3cQOVt5glZIbabq0h1b9jxZSpU9D+jwgZxxmI8NZJRS4TegZ+Q1ygY/MrSydUWQ3fK0ls20GePKjPtK90ipqt0HLyjAcLLVshc1jB3MPqDKEPXnQtxrJmbHwZu2rzlngIjUNybJXQxuJLqcE/awijpoftbqxctXzEq2hMj/lp6Y4agX++hikPg+BP6HHCwuwgXTYkcUXC6v5Mm2NTboDnimiJq2aCzcgc4RVjes1o5cKng8xtpYCNoTkEd4Tu1DL+AR6tJnjXkvRsJCdBWUVIFG4="
-    skip_cleanup: true
-    on:
-      all_branches: true

CMakeLists.txt

@@ -6,6 +6,10 @@ include(ExternalProject)
 set(EXTERNAL_PROJECTS_PATH "${CMAKE_BINARY_DIR}/external/src")
 make_directory(${EXTERNAL_PROJECTS_PATH})
 
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
 ##############################
 # Get Build Revision
 ##############################
@@ -30,9 +34,10 @@ configure_file("${CMAKE_SOURCE_DIR}/src/wrapper_version.cpp.in" "${CMAKE_BINARY_
 # pybind11
 #######################################
 
-set(PYBIND11_URL "https://github.com/pybind/pybind11/archive/v1.8.1.tar.gz")
-set(PYBIND11_DOWNLOAD_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-1.8.1.tar.gz")
-set(PYBIND11_EXTRACTED_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-1.8.1")
+set(PYBIND11_VERSION "2.2.4")
+set(PYBIND11_URL "https://github.com/pybind/pybind11/archive/v${PYBIND11_VERSION}.tar.gz")
+set(PYBIND11_DOWNLOAD_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-${PYBIND11_VERSION}.tar.gz")
+set(PYBIND11_EXTRACTED_PATH "${EXTERNAL_PROJECTS_PATH}/pybind11-${PYBIND11_VERSION}")
 
 if (NOT EXISTS ${PYBIND11_DOWNLOAD_PATH})
     file(DOWNLOAD ${PYBIND11_URL} ${PYBIND11_DOWNLOAD_PATH})
@@ -49,49 +54,44 @@ add_subdirectory(${PYBIND11_EXTRACTED_PATH})
 #######################################
 
 if (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    set(LOOT_API_URL "https://bintray.com/wrinklyninja/loot/download_file?file_path=loot-api_0.10.1-0-gd8f8dc4_master.7z")
+    if (NOT "${CMAKE_GENERATOR}" MATCHES "(Win64|IA64)")
+        set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.14.5/libloot-0.14.5-0-g68ecc02_dev-win32.7z")
+    else()
+        set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.14.5/libloot-0.14.5-0-g68ecc02_dev-win64.7z")
+    endif()
 else()
-    set(LOOT_API_URL "https://bintray.com/wrinklyninja/loot/download_file?file_path=loot-api_0.10.1-0-gd8f8dc4_master.tar.xz")
+    set(LIBLOOT_URL "https://github.com/loot/libloot/releases/download/0.14.5/libloot.tar.xz")
 endif()
 
-ExternalProject_Add(loot-api-c++
+ExternalProject_Add(libloot
                     PREFIX "external"
-                    URL ${LOOT_API_URL}
+                    URL ${LIBLOOT_URL}
                     CONFIGURE_COMMAND ""
                     BUILD_COMMAND ""
                     INSTALL_COMMAND "")
-ExternalProject_Get_Property(loot-api-c++ SOURCE_DIR)
-set(LOOT_API_EXTRACTED_PATH ${SOURCE_DIR})
+ExternalProject_Get_Property(libloot SOURCE_DIR)
+set(LIBLOOT_EXTRACTED_PATH ${SOURCE_DIR})
 
 include_directories("${CMAKE_SOURCE_DIR}/src"
-                    "${LOOT_API_EXTRACTED_PATH}/include")
-link_directories(${LOOT_API_EXTRACTED_PATH})
-set(LOOT_API_STATIC_LIBRARY "${CMAKE_STATIC_LIBRARY_PREFIX}loot_api${CMAKE_STATIC_LIBRARY_SUFFIX}")
-set(LOOT_API_SHARED_LIBRARY "${CMAKE_SHARED_LIBRARY_PREFIX}loot_api${CMAKE_SHARED_LIBRARY_SUFFIX}")
-
-#######################################
-# Test Masterlist
-#######################################
-
-ExternalProject_Add(test-masterlist
-                    PREFIX "external"
-                    URL "https://github.com/loot/oblivion/archive/09286601739c11a3a3e4552c6ddbdcaeffd1a8d3.zip"
-                    CONFIGURE_COMMAND ""
-                    BUILD_COMMAND ""
-                    INSTALL_COMMAND "")
+                    "${LIBLOOT_EXTRACTED_PATH}/include")
+link_directories(${LIBLOOT_EXTRACTED_PATH})
+set(LIBLOOT_STATIC_LIBRARY "${CMAKE_STATIC_LIBRARY_PREFIX}loot${CMAKE_STATIC_LIBRARY_SUFFIX}")
+set(LIBLOOT_SHARED_LIBRARY "${CMAKE_SHARED_LIBRARY_PREFIX}loot${CMAKE_SHARED_LIBRARY_SUFFIX}")
 
 #######################################
 # Python Module
 #######################################
 
-pybind11_add_module(loot_api "${CMAKE_SOURCE_DIR}/src/main.cpp" "${CMAKE_BINARY_DIR}/generated/wrapper_version.cpp")
+pybind11_add_module(loot_api  "${CMAKE_SOURCE_DIR}/src/main.cpp"
+                              "${CMAKE_SOURCE_DIR}/src/convenience.cpp"
+                              "${CMAKE_BINARY_DIR}/generated/wrapper_version.cpp")
 
-add_dependencies(loot_api loot-api-c++ test-masterlist)
+add_dependencies(loot_api libloot)
 
 if (CMAKE_SYSTEM_NAME MATCHES "Windows")
-    target_link_libraries(loot_api PRIVATE ${LOOT_API_STATIC_LIBRARY})
+    target_link_libraries(loot_api PRIVATE ${LIBLOOT_STATIC_LIBRARY})
 else()
-    target_link_libraries(loot_api PRIVATE ${LOOT_API_SHARED_LIBRARY})
+    target_link_libraries(loot_api PRIVATE ${LIBLOOT_SHARED_LIBRARY})
 endif()
 
 ########################################
@@ -103,21 +103,14 @@ find_package(PythonInterp REQUIRED)
 # Copy the API binary to the build directory.
 add_custom_command(TARGET loot_api POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "${LOOT_API_EXTRACTED_PATH}/${LOOT_API_SHARED_LIBRARY}"
-        "$<TARGET_FILE_DIR:loot_api>/${LOOT_API_SHARED_LIBRARY}")
+        "${LIBLOOT_EXTRACTED_PATH}/${LIBLOOT_SHARED_LIBRARY}"
+        "$<TARGET_FILE_DIR:loot_api>/${LIBLOOT_SHARED_LIBRARY}")
 
-# Copy the test masterlist to the build directory.
-ExternalProject_Get_Property(test-masterlist SOURCE_DIR)
-add_custom_command(TARGET loot_api POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "${SOURCE_DIR}/masterlist.yaml"
-        "$<TARGET_FILE_DIR:loot_api>/masterlist.yaml")
+enable_testing()
 
-# Also copy the test Python script to the build directory.
-add_custom_command(TARGET loot_api POST_BUILD
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        "${CMAKE_SOURCE_DIR}/src/test.py"
-        "$<TARGET_FILE_DIR:loot_api>/test.py")
+add_test(NAME python
+         WORKING_DIRECTORY $<TARGET_FILE_DIR:loot_api>
+         COMMAND "${PYTHON_EXECUTABLE}" ${CMAKE_SOURCE_DIR}/test/test.py)
 
 ########################################
 # Install
@@ -125,12 +118,20 @@ add_custom_command(TARGET loot_api POST_BUILD
 
 install(TARGETS loot_api
         DESTINATION "."
-        CONFIGURATIONS Release)
+        CONFIGURATIONS Release RelWithDebInfo)
 
-install(FILES "${LOOT_API_EXTRACTED_PATH}/${LOOT_API_SHARED_LIBRARY}"
+install(FILES "${LIBLOOT_EXTRACTED_PATH}/${LIBLOOT_SHARED_LIBRARY}"
         "${CMAKE_SOURCE_DIR}/docs/README.md"
         DESTINATION "."
-        CONFIGURATIONS Release)
+        CONFIGURATIONS Release RelWithDebInfo)
+
+IF (MSVC)
+    install(FILES $<TARGET_PDB_FILE:loot_api>
+            DESTINATION .
+            OPTIONAL
+            CONFIGURATIONS RelWithDebInfo
+            RENAME loot_api_python.pdb)
+ENDIF ()
 
 ########################################
 # CPack
@@ -160,7 +161,7 @@ else()
     set(CPACK_GENERATOR "TXZ")
 endif()
 
-set(CPACK_PACKAGE_VERSION ${GIT_DESCRIBE_STRING})
+set(CPACK_PACKAGE_VERSION "${GIT_DESCRIBE_STRING}-python$ENV{PYTHON_VERSION}")
 set(CPACK_PACKAGE_DIRECTORY "${CMAKE_BINARY_DIR}/package")
 
 include(CPack)

README.md

@@ -1,21 +1,20 @@
 LOOT API Python Module
 =======================
 
-[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/loot/loot-api-python?branch=master&svg=true)](https://ci.appveyor.com/project/WrinklyNinja/loot-api-python)
-[![Travis Build Status](https://travis-ci.org/loot/loot-api-python.svg?branch=master)](https://travis-ci.org/loot/loot-api-python)
+[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/k2ugge3po7254o1o/branch/master?svg=true)](https://ci.appveyor.com/project/LOOT/loot-api-python/branch/master)
 [![Documentation Status](https://readthedocs.org/projects/loot-api-python/badge/)](http://loot-api-python.readthedocs.io/)
 
-A Python module that wraps the LOOT API, generated by [pybind11](https://github.com/pybind/pybind11).
+A Python module that wraps libloot, generated by [pybind11](https://github.com/pybind/pybind11). Not everything in the API is exposed: coverage can be extended on request (or by pull request).
 
 ## Downloads
 
-Snapshot builds are available on [Bintray](https://bintray.com/wrinklyninja/loot/loot-api-python). The snapshot build archives are named like so:
+Snapshot builds are available on [Bintray](https://bintray.com/loot/snapshots/loot-api-python). The snapshot build archives are named like so:
 
 ```
-loot_api_python-<short revision ID>-win32.7z
+loot_api_python-<short revision ID>-python<python version>-win<architecture>.7z
 ```
 
-For example `loot_api_python-94de368-win32.7z` was built using the revision with shortened commit ID `94de368`.
+For example `loot_api_python-94de368-python2.7-win32.7z` was built using the revision with shortened commit ID `94de368`.
 
 ## Documentation
 
@@ -23,6 +22,6 @@ The documentation can be found online at [Read The Docs](http://loot-api-python.
 
 ## Build Instructions
 
-The module's build system uses [CMake](https://cmake.org/) and requires [Python](https://www.python.org) (tested with 2.7). Make sure they're installed, then run CMake, and build the generated solution file.
+The module's build system uses [CMake](https://cmake.org/) and requires [Python](https://www.python.org). Make sure they're installed, then run CMake, and build the generated solution file.
 
 Only Windows support has been tested, though Linux builds should also be possible.

appveyor.yml

@@ -1,42 +1,81 @@
-os: Visual Studio 2015
+os: Visual Studio 2017
 
 version: "{build}-{branch}"
 
-configuration: Release
+configuration: RelWithDebInfo
+
+platform:
+  - Win32
+  - x64
+
+environment:
+  bintray_auth_token:
+    secure: PgsEA6TjHVf718zMnK7J/fT1hUAVNKBeWhpYgYaeCyeZk37VT4Ics6j7+B7ElLEr
+  github_auth_token:
+    secure: yDqT5l/e5MntbW99V6+MHlfFgNv+UIogFfeyUVqtFk5lFRB/dAraLLwKCLl6y+DH
+
+  matrix:
+    - PYTHON_VERSION: 2.7
+    - PYTHON_VERSION: 3.7
+
+install:
+  - ps: (New-Object Net.WebClient).DownloadFile('https://raw.githubusercontent.com/Ortham/ci-scripts/2.0.0/delete_old_bintray_versions.py', "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py")
 
 before_build:
+  - ps: $env:PYTHON_DIRECTORY_VERSION=$env:PYTHON_VERSION.Replace(".", "")
   - cd %APPVEYOR_BUILD_FOLDER%
   - ps: mkdir build
   - cd build
-  - cmake .. -G "Visual Studio 14 2015"
+  - ps: |
+      if ($env:PLATFORM -eq 'Win32') {
+        cmake .. -G "Visual Studio 15 2017" -DPYTHON_EXECUTABLE="C:\Python${env:PYTHON_DIRECTORY_VERSION}\python.exe"
+      } else {
+        cmake .. -G "Visual Studio 15 2017 Win64" -DPYTHON_EXECUTABLE="C:\Python${env:PYTHON_DIRECTORY_VERSION}-x64\python.exe"
+      }
 
 build:
   verbosity: minimal
   project: 'c:\projects\loot-api-python\build\loot_api_python.sln'
 
 test_script:
-  - cd %APPVEYOR_BUILD_FOLDER%\build\Release
-  - python -m unittest test
+  - cd %APPVEYOR_BUILD_FOLDER%\build\%CONFIGURATION%
+  - ps: $env:ARCHITECTURE=$env:PLATFORM.Substring($env:PLATFORM.Length - 2)
+  - py -%PYTHON_VERSION%-%ARCHITECTURE% -m unittest test
 
 after_test:
   - cd %APPVEYOR_BUILD_FOLDER%\build
-  - cpack
+  - cpack -C %CONFIGURATION%
   # AppVeyor checks out a specific commit, but that means the archive script
   # can't tell which branch it's on, so rename the 7z archives.
   - ps: $env:GIT_DESCRIBE = ((git describe --tags --long --always) | Out-String) -replace "`n|`r", ""
 
 artifacts:
-  - path: build\package\loot_api_python-$(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)-win32.7z
+  - path: build\package\loot_api_python-$(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)-python$(PYTHON_VERSION)-win$(ARCHITECTURE).7z
     name: loot_api_python
 
 deploy:
   - provider: BinTray
     username: wrinklyninja
     api_key:
-      secure: u234T2688DZmz4JH5+0iAHcUcL2fEIGculb8655bn4B1q7GckhplsitzgEbv3NFc
-    subject: wrinklyninja
-    repo: loot
+      secure: PgsEA6TjHVf718zMnK7J/fT1hUAVNKBeWhpYgYaeCyeZk37VT4Ics6j7+B7ElLEr
+    subject: loot
+    repo: snapshots
     package: loot-api-python
     version: $(GIT_DESCRIBE)_$(APPVEYOR_REPO_BRANCH)
     publish: true
     artifact: loot_api_python
+
+  - provider: GitHub
+    tag: $(APPVEYOR_REPO_TAG_NAME)
+    release: LOOT API Python Module v$(APPVEYOR_REPO_TAG_NAME)
+    description: |
+      Requires Windows 7 or later and the [MSVC 2017 x86 redistributable](https://download.visualstudio.microsoft.com/download/pr/749aa419-f9e4-4578-a417-a43786af205e/d59197078cc425377be301faba7dd87a/vc_redist.x86.exe), and [7-Zip](http://www.7-zip.org/) to extract the archive.
+    auth_token:
+      secure: yDqT5l/e5MntbW99V6+MHlfFgNv+UIogFfeyUVqtFk5lFRB/dAraLLwKCLl6y+DH
+    artifact: loot_api_python
+    draft: false
+    on:
+      appveyor_repo_tag: true
+
+on_success:
+  - ps: python "$env:APPVEYOR_BUILD_FOLDER\delete_old_bintray_versions.py" -g loot/loot-api-python -b loot/snapshots/loot-api-python -u wrinklyninja -k $env:bintray_auth_token -t $env:github_auth_token -n 30

docs/README.md

@@ -3,7 +3,7 @@ LOOT API Python Wrapper
 
 This archive contains a build of the LOOT API Python wrapper module and its corresponding 32-bit Windows build of the LOOT API.
 
-The DLL requires the [MSVC 2015 x86 redistributable](https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe)
+The DLL requires the [MSVC 2017 x86 redistributable](https://download.visualstudio.microsoft.com/download/pr/749aa419-f9e4-4578-a417-a43786af205e/d59197078cc425377be301faba7dd87a/vc_redist.x86.exe)
 to be installed.
 
 See the [online documentation](http://loot-api-python.readthedocs.org/) for more information.

docs/conf.py

@@ -55,7 +55,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'LOOT API Python Module'
-copyright = u'2016, WrinklyNinja'
+copyright = u'2019, WrinklyNinja'
 author = u'WrinklyNinja'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -346,5 +346,5 @@ texinfo_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'loot_api': ('http://loot.readthedocs.io/en/0.10.1/', None),
+    'loot_api': ('http://loot.readthedocs.io/en/0.14.5/', None),
 }

docs/reference.rst

@@ -14,8 +14,7 @@ values are unsigned integer constants.
 
 .. py:class:: loot_api.GameType
 
-  Wraps :cpp:type:`loot::GameType` to expose the LOOT API's game
-  codes.
+  Wraps :cpp:type:`loot::GameType` to expose the LOOT API's game codes.
 
   .. py:attribute:: fo3
   .. py:attribute:: fo4
@@ -24,27 +23,21 @@ values are unsigned integer constants.
   .. py:attribute:: tes5
   .. py:attribute:: tes5se
 
-.. py:class:: loot_api.LanguageCode
+.. py:class:: loot_api.LogLevel
 
-  Wraps :cpp:type:`loot::LanguageCode` to expose the LOOT API's
-  language codes.
+  Wraps :cpp:type:`loot::LogLevel` to expose the LOOT API's log level codes.
 
-  .. py:attribute:: english
-  .. py:attribute:: spanish
-  .. py:attribute:: russian
-  .. py:attribute:: french
-  .. py:attribute:: chinese
-  .. py:attribute:: polish
-  .. py:attribute:: brazilian_portuguese
-  .. py:attribute:: finnish
-  .. py:attribute:: german
-  .. py:attribute:: danish
-  .. py:attribute:: korean
+  .. py:attribute:: trace
+  .. py:attribute:: debug
+  .. py:attribute:: info
+  .. py:attribute:: warning
+  .. py:attribute:: error
+  .. py:attribute:: fatal
 
 .. py:class:: loot_api.MessageType
 
-  Wraps :cpp:type:`loot::MessageType` to expose the LOOT API's
-  message type codes.
+  Wraps :cpp:type:`loot::MessageType` to expose the LOOT API's message type
+  codes.
 
   .. py:attribute:: error
   .. py:attribute:: say
@@ -52,13 +45,26 @@ values are unsigned integer constants.
 
 .. py:class:: loot_api.PluginCleanliness
 
-  Wraps :cpp:type:`loot::PluginCleanliness` to expose the LOOT API's plugin cleanliness state codes.
+  Codes used to indicate the cleanliness of a plugin according to the
+  information contained within the loaded masterlist/userlist.
 
   .. py:attribute:: clean
+
+    Indicates that the plugin is clean.
+
   .. py:attribute:: dirty
+
+    Indicates that the plugin is dirty.
+
   .. py:attribute:: do_not_clean
+
+    Indicates that the plugin contains dirty edits, but that they are part of
+    the plugin’s intended functionality and should not be removed.
+
   .. py:attribute:: unknown
 
+    Indicates that no data is available on whether the plugin is dirty or not.
+
 Public-Field Data Structures
 ============================
 
@@ -81,7 +87,7 @@ Classes with public fields and no member functions.
     A boolean that is true if the masterlist has been modified from its state
     at the commit given by :py:attr:`revision_id`.
 
-.. py:class:: loot_api.Message
+.. py:class:: loot_api.SimpleMessage
 
   Wraps :cpp:class:`loot::SimpleMessage`.
 
@@ -91,12 +97,16 @@ Classes with public fields and no member functions.
 
   .. py:attribute:: language
 
-    A :py:class:`loot_api.LanguageCode` giving the message text language.
+    A Unicode string giving the message text language.
 
   .. py:attribute:: text
 
     A Unicode string containing the message text.
 
+  .. py:attribute:: condition
+
+    A Unicode string containing the message condition.
+
 .. py:class:: loot_api.PluginTags
 
   Wraps :cpp:class:`loot::PluginTags`.
@@ -117,49 +127,65 @@ Classes with public fields and no member functions.
 Functions
 =========
 
+.. py:function:: loot_api.set_logging_callback(callback) -> NoneType
+
+  Set the callback function that is called when logging. Wraps
+  :cpp:func:`loot::SetLoggingCallback`.
+
 .. py:function:: loot_api.is_compatible(int, int, int) -> bool
 
   Checks for API compatibility. Wraps :cpp:func:`loot::IsCompatible`.
 
-.. py:function:: loot_api.create_database(game : loot_api.GameType, [game_path : unicode = u'', [game_local_path : unicode = u'']]) -> loot_api.DatabaseInterface
+.. py:function:: loot_api.InitialiseLocale(unicode = u'') -> NoneType
 
-  Initialise a new database handle. Wraps :cpp:func:`loot::IsCompatible`.
+  Initialise the current global locale using the given ID. A blank value means
+  that the system default locale will be initialised. Wraps
+  :cpp:func:`loot::InitialiseLocale`.
+
+.. py:function:: loot_api.create_game_handle(game : loot_api.GameType, game_path : unicode, [game_local_path : unicode = u'']) -> loot_api.GameInterface
+
+  Initialise a new game handle. Wraps :cpp:func:`loot::CreateGameHandle`.
 
 Classes
 =======
 
+.. py:class:: loot_api.GameInterface
+
+  Wraps :cpp:class:`loot::GameInterface`.
+
+  .. py:function:: loot_api.get_database() -> loot_api.DatabaseInterface
+
+    Get a database handle. Wraps :cpp:func:`loot::GetDatabase`.
+
+  .. py:function:: loot_api.load_current_load_order_state() -> NoneType
+
+    Load the current load order state, discarding any previously held state.
+    Wraps :cpp:func:`loot::LoadCurrentLoadOrderState`.
+
 .. py:class:: loot_api.DatabaseInterface
 
   Wraps :cpp:class:`loot::DatabaseInterface`.
 
-  .. py:method:: eval_lists(loot_api.DatabaseInterface) -> NoneType
-
-    Evaluates all conditions and regular expression metadata entries in the loaded metadata lists. Wraps :cpp:func:`EvalLists`.
-
   .. py:method:: get_masterlist_revision(loot_api.DatabaseInterface, unicode, bool) -> loot_api.MasterlistInfo
 
     Gets the give masterlist’s source control revision. Wraps :cpp:func:`GetMasterlistRevision`.
 
-  .. py:method:: get_plugin_cleanliness(loot_api.DatabaseInterface, unicode) -> loot_api.PluginCleanliness
+  .. py:method:: get_plugin_metadata(loot_api.DatabaseInterface, plugin : unicode, [includeUserMetadata : bool = True, [evaluateConditions : bool = False]]) -> loot_api.PluginMetadata
 
-    Determines the database’s knowledge of a plugin’s cleanliness. Wraps :cpp:func:`GetPluginCleanliness`.
+    Get all a plugin’s loaded metadata. Wraps :cpp:func:`GetPluginMetadata`.
 
-  .. py:method:: get_plugin_messages(loot_api.DatabaseInterface, unicode, loot_api.LanguageCode) -> list<loot_api.Message>
+  .. py:method:: get_plugin_cleanliness(loot_api.DatabaseInterface, plugin : unicode, [evaluateConditions : bool = False]) -> loot_api.PluginCleanliness
 
-    Outputs the messages associated with the given plugin in the database. Wraps :cpp:func:`GetPluginMessages`.
+    Determines the database’s knowledge of a plugin’s cleanliness. Outputs whether the plugin should be cleaned or not, or if no data is available.
 
-  .. py:method:: get_plugin_tags(loot_api.DatabaseInterface, unicode) -> loot_api.PluginTags
+  .. py:method:: get_plugin_tags(loot_api.DatabaseInterface, plugin : unicode, [evaluateConditions : bool = False]) -> loot_api.PluginTags
 
-    Outputs the Bash Tags suggested for addition and removal by the database for the given plugin. Wraps :cpp:func:`GetPluginTags`.
+    Outputs the Bash Tags suggested for addition and removal by the database for the given plugin.
 
   .. py:method:: load_lists(loot_api.DatabaseInterface, masterlist_path : unicode, [userlist_path : unicode = u'']) -> NoneType
 
     Loads the masterlist and userlist from the paths specified. Wraps :cpp:func:`LoadLists`.
 
-  .. py:method:: sort_plugins(loot_api.DatabaseInterface, list<unicode>) -> list<unicode>
-
-    Calculates a new load order for all a game’s installed plugins and outputs the sorted order. Wraps :cpp:func:`SortPlugins`.
-
   .. py:method:: update_masterlist(loot_api.DatabaseInterface, unicode, unicode, unicode) -> bool
 
     Updates the given masterlist using the given Git repository details. Wraps :cpp:func:`UpdateMasterlist`.
@@ -216,3 +242,12 @@ Classes
   .. py:staticmethod:: string() -> unicode
 
     Returns the API version as a string of the form ``major.minor.patch``
+
+.. py:class:: loot_api.PluginMetadata
+
+  Wraps :cpp:class:`loot::PluginMetadata`.
+
+  .. py:method:: get_simple_messages(loot_api.PluginMetadata, unicode) -> list<loot_api.SimpleMessage>
+
+    Get the plugin’s messages as SimpleMessage objects for the given language.
+    Wraps :cpp:func:`GetPluginMessages`.

docs/usage.rst

@@ -10,13 +10,13 @@ Build archives contain two binaries:
 * ``loot_api.pyd`` is the Python wrapper
 * ``loot_api.dll`` is the C++ API DLL that the Python wrapper was built against.
 
-The C++ DLL requires the `Visual C++ 2015 Redistributable (x86)`_
+The C++ DLL requires the `Visual C++ 2017 Redistributable (x86)`_
 to be installed.
 
 To use the wrapper, copy both files to wherever you want to import them from
 (they must be in the same folder), and you're done!
 
-.. _Visual C++ 2015 Redistributable (x86): https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe
+.. _Visual C++ 2017 Redistributable (x86): https://download.visualstudio.microsoft.com/download/pr/749aa419-f9e4-4578-a417-a43786af205e/d59197078cc425377be301faba7dd87a/vc_redist.x86.exe
 
 Using the wrapper
 =================
@@ -28,7 +28,7 @@ To check if the module loaded is compatible with the version of the API that you
 developed against::
 
   >>> import loot_api
-  >>> loot_api.is_compatible(0,10,0)
+  >>> loot_api.is_compatible(0,14,0)
   True
   >>> loot_api.is_compatible(0,9,0)
   False
@@ -39,8 +39,9 @@ Getting a Plugin's Bash Tag Suggestions
 To get a plugin's Bash Tag suggestions from a ``masterlist.yaml`` metadata file::
 
   >>> import loot_api
-  >>> db = loot_api.create_database(loot_api.GameType.tes4, '', '')
-  >>> db.load_lists('masterlist.yaml', '')
+  >>> loot_api.initialise_locale()
+  >>> db = loot_api.create_game_handle(loot_api.GameType.tes4, 'C:\\path\\to\\oblivion\\directory')
+  >>> db.load_lists('masterlist.yaml')
   >>> tags = db.get_plugin_tags(u'Unofficial Oblivion Patch.esp')
   >>> tags.added
   set([u'Scripts', u'Relations', u'C.Owner', u'Actors.AIPackages', u'Actors.Stats', u'Actors.ACBS', u'C.Music', u'Factions', u'Invent', u'Relev', u'Names', u'C.Light', u'Delev', u'C.Name', u'C.Climate', u'NPC.Class', u'Stats', u'Actors.DeathItem', u'Creatures.Blood', u'Actors.CombatStyle', u'Actors.AIData'])

scripts/travis/loot-api.bintray.json

@@ -1,15 +0,0 @@
-{
-  "package": {
-    "name": "loot-api-python",
-    "repo": "loot",
-    "subject": "wrinklyninja"
-  },
-  "version": {
-    "name": "REPLACE_THIS_VERSION"
-  },
-  "files": [{
-    "includePattern": "build/package/(loot_api_python-.+\\.tar.xz)",
-    "uploadPattern": "$1"
-  }],
-  "publish": true
-}

src/convenience.cpp

@@ -0,0 +1,83 @@
+/*  LOOT
+
+A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+Fallout: New Vegas.
+
+Copyright (C) 2014-2017    Oliver Hamlet
+
+This file is part of LOOT.
+
+LOOT is free software: you can redistribute
+it and/or modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+LOOT is distributed in the hope that it will
+be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with LOOT.  If not, see
+<https://www.gnu.org/licenses/>.
+*/
+
+#include "convenience.h"
+
+#include <loot/api.h>
+
+namespace loot {
+PluginTags GetPluginTags(const std::shared_ptr<DatabaseInterface> db, const std::string& plugin, bool evaluateConditions) {
+  PluginTags tags;
+
+  auto metadata = db->GetPluginMetadata(plugin, false, evaluateConditions);
+  if (metadata.has_value()) {
+    for (const auto &tag : metadata.value().GetTags()) {
+      if (tag.IsAddition())
+        tags.added.insert(tag.GetName());
+      else
+        tags.removed.insert(tag.GetName());
+    }
+  }
+
+  metadata = db->GetPluginUserMetadata(plugin, evaluateConditions);
+  if (metadata.has_value()) {
+    tags.userlist_modified = !metadata.value().GetTags().empty();
+    for (const auto &tag : metadata.value().GetTags()) {
+      if (tag.IsAddition())
+        tags.added.insert(tag.GetName());
+      else
+        tags.removed.insert(tag.GetName());
+    }
+  }
+
+  return tags;
+}
+
+PluginCleanliness GetPluginCleanliness(const std::shared_ptr<DatabaseInterface> db, const std::string& plugin, bool evaluateConditions) {
+  auto metadata = db->GetPluginMetadata(plugin, true, evaluateConditions);
+
+  if (!metadata.has_value()) {
+    return PluginCleanliness::unknown;
+  }
+
+  auto dirtyInfo = metadata.value().GetDirtyInfo();
+  auto cleanInfo = metadata.value().GetCleanInfo();
+
+  if (dirtyInfo.empty() == cleanInfo.empty()) {
+    return PluginCleanliness::unknown;
+  }
+
+  if (!cleanInfo.empty()) {
+    return PluginCleanliness::clean;
+  }
+
+  for (const auto& info : dirtyInfo) {
+    if (info.ChooseInfo("en").GetText().find("Do not clean") != std::string::npos) {
+      return PluginCleanliness::do_not_clean;
+    }
+  }
+
+  return PluginCleanliness::dirty;
+}
+}

src/convenience.h

@@ -0,0 +1,46 @@
+/*  LOOT
+
+A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+Fallout: New Vegas.
+
+Copyright (C) 2014-2017    Oliver Hamlet
+
+This file is part of LOOT.
+
+LOOT is free software: you can redistribute
+it and/or modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+LOOT is distributed in the hope that it will
+be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with LOOT.  If not, see
+<https://www.gnu.org/licenses/>.
+*/
+
+#ifndef LOOT_API_PYTHON_CONVENIENCE
+#define LOOT_API_PYTHON_CONVENIENCE
+
+#include <memory>
+
+#include <loot/enum/game_type.h>
+#include <loot/database_interface.h>
+
+#include "plugin_cleanliness.h"
+#include "plugin_tags.h"
+
+namespace loot {
+PluginTags GetPluginTags(const std::shared_ptr<DatabaseInterface> db,
+                         const std::string& plugin,
+                         bool evaluateConditions = false);
+
+PluginCleanliness GetPluginCleanliness(const std::shared_ptr<DatabaseInterface> db,
+                                       const std::string& plugin,
+                                       bool evaluateConditions = false);
+}
+
+#endif

src/main.cpp

@@ -25,53 +25,59 @@
 #include <loot/api.h>
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
+#include <pybind11/functional.h>
 
+#include "convenience.h"
 #include "wrapper_version.h"
 
-PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>);
+using pybind11::arg;
+using pybind11::enum_;
+using pybind11::class_;
+using pybind11::metaclass;
+using std::filesystem::path;
+using std::filesystem::u8path;
 
-PYBIND11_PLUGIN(loot_api) {
-  using loot::CreateDatabase;
-  using loot::DatabaseInterface;
-  using loot::IsCompatible;
-  using loot::GameType;
-  using loot::LanguageCode;
-  using loot::LootVersion;
-  using loot::MessageType;
-  using loot::MasterlistInfo;
-  using loot::PluginCleanliness;
-  using loot::SimpleMessage;
-  using loot::PluginTags;
-  using loot::WrapperVersion;
+namespace loot {
+namespace py {
+std::shared_ptr<GameInterface> CreateGameHandle(GameType gameType, std::string gamePath, std::string gameLocalPath) {
+  return CreateGameHandle(gameType, u8path(gamePath), u8path(gameLocalPath));
+}
 
-  using pybind11::arg;
-  using pybind11::enum_;
-  using pybind11::class_;
+void LoadLists(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, std::string userlistPath) {
+  return db->LoadLists(u8path(masterlistPath), u8path(userlistPath));
+}
 
-  const std::string emptyString;
+void WriteMinimalList(std::shared_ptr<DatabaseInterface> db, std::string outputFile, bool overwrite) {
+  return db->WriteMinimalList(u8path(outputFile), overwrite);
+}
 
-  pybind11::module module("loot_api", "A Python module that wraps the LOOT API, generated by pybind11.");
+bool UpdateMasterlist(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, std::string remoteUrl, std::string remoteBranch) {
+  return db->UpdateMasterlist(u8path(masterlistPath), remoteUrl, remoteBranch);
+}
 
+MasterlistInfo GetMasterlistRevision(std::shared_ptr<DatabaseInterface> db, std::string masterlistPath, bool getShortId) {
+  return db->GetMasterlistRevision(u8path(masterlistPath), getShortId);
+}
+}
+
+void bindEnums(pybind11::module& module) {
   enum_<GameType>(module, "GameType")
     .value("tes4", GameType::tes4)
     .value("tes5", GameType::tes5)
     .value("tes5se", GameType::tes5se)
+    .value("tes5vr", GameType::tes5vr)
     .value("fo3", GameType::fo3)
     .value("fonv", GameType::fonv)
-    .value("fo4", GameType::fo4);
+    .value("fo4", GameType::fo4)
+    .value("fo4vr", GameType::fo4vr);
 
-  enum_<LanguageCode>(module, "LanguageCode")
-    .value("english", LanguageCode::english)
-    .value("spanish", LanguageCode::spanish)
-    .value("russian", LanguageCode::russian)
-    .value("french", LanguageCode::french)
-    .value("chinese", LanguageCode::chinese)
-    .value("polish", LanguageCode::polish)
-    .value("brazilian_portuguese", LanguageCode::brazilian_portuguese)
-    .value("finnish", LanguageCode::finnish)
-    .value("german", LanguageCode::german)
-    .value("danish", LanguageCode::danish)
-    .value("korean", LanguageCode::korean);
+  enum_<LogLevel>(module, "LogLevel")
+    .value("trace", LogLevel::trace)
+    .value("debug", LogLevel::debug)
+    .value("info", LogLevel::info)
+    .value("warning", LogLevel::warning)
+    .value("error", LogLevel::error)
+    .value("fatal", LogLevel::fatal);
 
   enum_<MessageType>(module, "MessageType")
     .value("say", MessageType::say)
@@ -83,28 +89,36 @@ PYBIND11_PLUGIN(loot_api) {
     .value("dirty", PluginCleanliness::dirty)
     .value("do_not_clean", PluginCleanliness::do_not_clean)
     .value("unknown", PluginCleanliness::unknown);
+}
 
+void bindMetadataClasses(pybind11::module& module) {
   class_<MasterlistInfo>(module, "MasterlistInfo")
     .def_readwrite("revision_id", &MasterlistInfo::revision_id)
     .def_readwrite("revision_date", &MasterlistInfo::revision_date)
     .def_readwrite("is_modified", &MasterlistInfo::is_modified);
 
-  class_<SimpleMessage>(module, "Message")
+  class_<SimpleMessage>(module, "SimpleMessage")
     .def_readwrite("type", &SimpleMessage::type)
     .def_readwrite("language", &SimpleMessage::language)
-    .def_readwrite("text", &SimpleMessage::text);
+    .def_readwrite("text", &SimpleMessage::text)
+    .def_readwrite("condition", &SimpleMessage::condition);
 
   class_<PluginTags>(module, "PluginTags")
     .def_readwrite("added", &PluginTags::added)
     .def_readwrite("removed", &PluginTags::removed)
     .def_readwrite("userlist_modified", &PluginTags::userlist_modified);
 
+  class_<PluginMetadata>(module, "PluginMetadata")
+    .def("get_simple_messages", &PluginMetadata::GetSimpleMessages);
+}
+
+void bindVersionClasses(pybind11::module& module) {
   class_<LootVersion>(module, "Version")
     .def_readonly_static("major", &LootVersion::major)
     .def_readonly_static("minor", &LootVersion::minor)
     .def_readonly_static("patch", &LootVersion::patch)
     .def_readonly_static("revision", &LootVersion::revision)
-    .def_static("string", LootVersion::string);
+    .def_static("string", LootVersion::GetVersionString);
 
   class_<WrapperVersion>(module, "WrapperVersion")
     .def_readonly_static("major", &WrapperVersion::major)
@@ -112,21 +126,56 @@ PYBIND11_PLUGIN(loot_api) {
     .def_readonly_static("patch", &WrapperVersion::patch)
     .def_readonly_static("revision", &WrapperVersion::revision)
     .def_static("string", WrapperVersion::string);
+}
+
+void bindInterfaceClasses(pybind11::module& module) {
+  class_<GameInterface, std::shared_ptr<GameInterface>>(module, "GameInterface")
+    .def("load_current_load_order_state", &GameInterface::LoadCurrentLoadOrderState)
+    .def("get_database", &GameInterface::GetDatabase);
 
   class_<DatabaseInterface, std::shared_ptr<DatabaseInterface>>(module, "DatabaseInterface")
-    .def("load_lists", &DatabaseInterface::LoadLists, arg("masterlist_path"), arg("userlist_path") = emptyString)
-    .def("eval_lists", &DatabaseInterface::EvalLists)
-    .def("sort_plugins", &DatabaseInterface::SortPlugins)
-    .def("update_masterlist", &DatabaseInterface::UpdateMasterlist)
-    .def("get_masterlist_revision", &DatabaseInterface::GetMasterlistRevision)
-    .def("get_plugin_tags", &DatabaseInterface::GetPluginTags)
-    .def("get_plugin_messages", &DatabaseInterface::GetPluginMessages)
-    .def("get_plugin_cleanliness", &DatabaseInterface::GetPluginCleanliness)
-    .def("write_minimal_list", &DatabaseInterface::WriteMinimalList);
+    .def("load_lists", &py::LoadLists, arg("masterlist_path"), arg("userlist_path") = "")
+    .def("update_masterlist", &py::UpdateMasterlist)
+    .def("get_masterlist_revision", &py::GetMasterlistRevision)
+    .def("get_plugin_metadata", &DatabaseInterface::GetPluginMetadata,
+      arg("plugin"),
+      arg("includeUserMetadata") = true,
+      arg("evaluateConditions") = false)
+    .def("get_plugin_tags", &GetPluginTags,
+      arg("plugin"),
+      arg("evaluateConditions") = false)
+    .def("get_plugin_cleanliness", &GetPluginCleanliness,
+      arg("plugin"),
+      arg("evaluateConditions") = false)
+    .def("write_minimal_list", &py::WriteMinimalList);
+}
+
+void bindClasses(pybind11::module& module) {
+  bindMetadataClasses(module);
+  bindVersionClasses(module);
+  bindInterfaceClasses(module);
+}
+
+void bindFunctions(pybind11::module& module) {
+  module.def("set_logging_callback", &SetLoggingCallback);
 
   module.def("is_compatible", &IsCompatible);
 
-  module.def("create_database", &CreateDatabase, arg("game"), arg("game_path") = emptyString, arg("game_local_path") = emptyString);
+  module.def("initialise_locale", &InitialiseLocale, arg("id") = "");
+
+  module.def("create_game_handle", &py::CreateGameHandle,
+    arg("game"),
+    arg("game_path"),
+    arg("game_local_path") = "");
+}
+}
+
+PYBIND11_PLUGIN(loot_api) {
+  pybind11::module module("loot_api", "A Python module that wraps the LOOT API, generated by pybind11.");
+
+  loot::bindEnums(module);
+  loot::bindClasses(module);
+  loot::bindFunctions(module);
 
   return module.ptr();
 }

src/plugin_cleanliness.h

@@ -0,0 +1,52 @@
+/*  LOOT
+
+    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+    Fallout: New Vegas.
+
+    Copyright (C) 2012-2016    WrinklyNinja
+
+    This file is part of LOOT.
+
+    LOOT is free software: you can redistribute
+    it and/or modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    LOOT is distributed in the hope that it will
+    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with LOOT.  If not, see
+    <https://www.gnu.org/licenses/>.
+    */
+#ifndef LOOT_PLUGIN_CLEANLINESS
+#define LOOT_PLUGIN_CLEANLINESS
+
+/**
+ * The namespace used by the LOOT API.
+ */
+namespace loot {
+/**
+ * @brief Codes used to indicate the cleanliness of a plugin according to the
+ *        information contained within the loaded masterlist/userlist.
+ */
+enum struct PluginCleanliness : unsigned int {
+  /** Indicates that the plugin is clean. */
+  clean,
+  /** Indicates that the plugin is dirty. */
+  dirty,
+  /**
+   * Indicates that the plugin contains dirty edits, but that they are
+   * part of the plugin's intended functionality and should not be removed.
+   */
+  do_not_clean,
+  /**
+   * Indicates that no data is available on whether the plugin is dirty or not.
+   */
+  unknown,
+};
+}
+
+#endif

src/plugin_tags.h

@@ -0,0 +1,58 @@
+/*  LOOT
+
+    A load order optimisation tool for Oblivion, Skyrim, Fallout 3 and
+    Fallout: New Vegas.
+
+    Copyright (C) 2012-2016    WrinklyNinja
+
+    This file is part of LOOT.
+
+    LOOT is free software: you can redistribute
+    it and/or modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, either version 3 of
+    the License, or (at your option) any later version.
+
+    LOOT is distributed in the hope that it will
+    be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with LOOT.  If not, see
+    <https://www.gnu.org/licenses/>.
+    */
+#ifndef LOOT_PLUGIN_TAGS
+#define LOOT_PLUGIN_TAGS
+
+#include <set>
+#include <string>
+
+namespace loot {
+/**
+ * @brief A structure that holds data about the Bash Tag suggestions made by
+ *        LOOT for a plugin.
+ */
+struct PluginTags {
+  inline PluginTags() : userlist_modified(false) {}
+
+  /**
+   * @brief A set of Bash Tag names suggested for addition to the specified
+   *        plugin. Empty if no Bash Tag additions are suggested.
+   */
+  std::set<std::string> added;
+
+  /**
+   * @brief A set of Bash Tag names suggested for removal from the specified
+   *        plugin. Empty if no Bash Tag removals are suggested.
+   */
+  std::set<std::string> removed;
+
+  /**
+  * @brief `true` if the Bash Tag suggestions were modified by data in the
+  *        userlist, `false` otherwise.
+  */
+  bool userlist_modified;
+};
+}
+
+#endif

src/wrapper_version.cpp.in

@@ -25,8 +25,8 @@
 #include "wrapper_version.h"
 
 namespace loot {
-const unsigned int WrapperVersion::major = 1;
-const unsigned int WrapperVersion::minor = 1;
+const unsigned int WrapperVersion::major = 4;
+const unsigned int WrapperVersion::minor = 0;
 const unsigned int WrapperVersion::patch = 2;
 const std::string WrapperVersion::revision = "@GIT_COMMIT_STRING@";
 

test/masterlist.yaml

@@ -0,0 +1,54 @@
+plugins:
+  - name: Oblivion.esm
+    msg:
+      - type: error
+        content: 'This must not be activated. However, it can be useful when porting Oblivion mods to Nehrim.'
+
+  - name: Unofficial Oblivion Patch.esp
+    tag:
+      - Actors.ACBS
+      - Actors.AIData
+      - Actors.AIPackages
+      - Actors.CombatStyle
+      - Actors.DeathItem
+      - Actors.Stats
+      - C.Climate
+      - C.Light
+      - C.Music
+      - C.Name
+      - C.Owner
+      - Creatures.Blood
+      - Delev
+      - Factions
+      - Invent
+      - Names
+      - NPC.Class
+      - Relations
+      - Relev
+      - Scripts
+      - Stats
+      - -C.Water
+
+  - name: clean_and_dirty.esp
+    dirty:
+      - crc: 0xDEADBEEF
+        util: '[TES4Edit v4.0.0](https://www.nexusmods.com/oblivion/mods/11536)'
+    clean:
+      - crc: 0xFEEDFACE
+        util: 'TES4Edit v4.0.0'
+
+  - name: clean.esp
+    clean:
+      - crc: 0xFEEDFACE
+        util: 'TES4Edit v4.0.0'
+
+  - name: dirty.esp
+    dirty:
+      - crc: 0xDEADBEEF
+        util: '[TES4Edit v4.0.0](https://www.nexusmods.com/oblivion/mods/11536)'
+
+  - name: do_not_clean.esp
+    dirty:
+      - crc: 0xDEADBEEF
+        util: '[TES4Edit v4.0.0](https://www.nexusmods.com/oblivion/mods/11536)'
+        info: 'Do not clean. This plugin is intentionally left dirty.'

test/test.py

@@ -1,17 +1,30 @@
 #!/usr/bin/env python
 
 import cProfile
+import os
 import os.path
 import shutil
+import sys
 import unittest
+
+sys.path.append(os.getcwd())
+
 from loot_api import Version
 from loot_api import WrapperVersion
 from loot_api import GameType
-from loot_api import LanguageCode
-from loot_api import Message
+from loot_api import SimpleMessage
 from loot_api import MessageType
-from loot_api import create_database
+from loot_api import PluginCleanliness
+from loot_api import create_game_handle
 from loot_api import is_compatible
+from loot_api import set_logging_callback
+from loot_api import initialise_locale
+
+def logging_callback(level, message):
+    pass
+
+set_logging_callback(logging_callback)
+initialise_locale()
 
 class GameFixture(unittest.TestCase):
     game_path = os.path.join(u'.', u'Oblivion')
@@ -33,34 +46,38 @@ class GameFixture(unittest.TestCase):
 class TestLootApi(GameFixture):
     def test_is_compatible(self):
         self.assertFalse(is_compatible(0, 9, 0))
-        self.assertTrue(is_compatible(0, 10, 0))
+        self.assertTrue(is_compatible(0, 14, 0))
 
     def test_version(self):
         self.assertEqual(Version.major, 0)
-        self.assertEqual(Version.minor, 10)
-        self.assertEqual(Version.patch, 1)
+        self.assertEqual(Version.minor, 14)
+        self.assertEqual(Version.patch, 5)
         self.assertNotEqual(Version.revision, u'')
-        self.assertEqual(Version.string(), "0.10.1")
+        self.assertEqual(Version.string(), "0.14.5")
 
     def test_wrapper_version(self):
-        self.assertEqual(WrapperVersion.major, 1)
-        self.assertEqual(WrapperVersion.minor, 1)
+        self.assertEqual(WrapperVersion.major, 4)
+        self.assertEqual(WrapperVersion.minor, 0)
         self.assertEqual(WrapperVersion.patch, 2)
         self.assertNotEqual(WrapperVersion.revision, u'')
         self.assertNotEqual(WrapperVersion.revision, Version.revision)
-        self.assertEqual(WrapperVersion.string(), "1.1.2")
+        self.assertEqual(WrapperVersion.string(), "4.0.2")
 
     def test_create_db(self):
-        db = create_database(GameType.tes4, self.game_path, self.local_path)
+        game = create_game_handle(GameType.tes4, self.game_path, self.local_path)
+        db = game.get_database()
         self.assertNotEqual(db, None)
 
 class TestDatabaseInterface(GameFixture):
-    masterlist_path = u'masterlist.yaml'
+    masterlist_path = os.path.join(os.path.dirname(__file__), u'masterlist.yaml')
 
     def setUp(self):
         super(TestDatabaseInterface, self).setUp()
 
-        self.db = create_database(GameType.tes4, self.game_path, self.local_path)
+        game = create_game_handle(GameType.tes4, self.game_path, self.local_path)
+        game.load_current_load_order_state()
+
+        self.db = game.get_database()
 
     def test_load_lists(self):
         self.db.load_lists(self.masterlist_path, u'')
@@ -96,23 +113,49 @@ class TestDatabaseInterface(GameFixture):
         ]))
         self.assertEqual(tags.removed, set([u'C.Water']))
 
-#        cProfile.runctx('self.test_get_plugin_tags_performance()', globals(), locals(), sort='cumtime')
-
-#    def test_get_plugin_tags_performance(self):
-#        self.db.load_lists(self.masterlist_path, u'')
-#
-#        for i in xrange(200000):
-#            tags = self.db.get_plugin_tags(u'Unofficial Oblivion Patch.esp')
-
     def test_get_plugin_messages(self):
         self.db.load_lists(self.masterlist_path, u'')
 
-        messages = self.db.get_plugin_messages(u'Oblivion.esm', LanguageCode.english)
+        messages = self.db.get_plugin_metadata(u'Oblivion.esm').get_simple_messages(u'en')
 
         self.assertEqual(len(messages), 1)
         self.assertEqual(messages[0].type, MessageType.error)
         self.assertEqual(messages[0].text, u'This must not be activated. However, it can be useful when porting Oblivion mods to Nehrim.')
 
+    def test_get_plugin_cleanliness_should_be_unknown_if_no_dirty_or_clean_metadata_exists(self):
+        self.db.load_lists(self.masterlist_path, u'')
+
+        cleanliness = self.db.get_plugin_cleanliness(u'unknown.esp')
+
+        self.assertEqual(cleanliness, PluginCleanliness.unknown)
+
+    def test_get_plugin_cleanliness_should_be_unknown_if_dirty_and_clean_metadata_exists(self):
+        self.db.load_lists(self.masterlist_path, u'')
+
+        cleanliness = self.db.get_plugin_cleanliness(u'clean_and_dirty.esp')
+
+        self.assertEqual(cleanliness, PluginCleanliness.unknown)
+
+    def test_get_plugin_cleanliness_should_be_clean_if_only_clean_metadata_exists(self):
+        self.db.load_lists(self.masterlist_path, u'')
+
+        cleanliness = self.db.get_plugin_cleanliness(u'clean.esp')
+
+        self.assertEqual(cleanliness, PluginCleanliness.clean)
+
+    def test_get_plugin_cleanliness_should_be_dirty_if_only_dirty_metadata_exists(self):
+        self.db.load_lists(self.masterlist_path, u'')
+
+        cleanliness = self.db.get_plugin_cleanliness(u'dirty.esp')
+
+        self.assertEqual(cleanliness, PluginCleanliness.dirty)
+
+    def test_get_plugin_cleanliness_should_be_do_not_clean_if_dirty_do_not_clean_info_exists(self):
+        self.db.load_lists(self.masterlist_path, u'')
+
+        cleanliness = self.db.get_plugin_cleanliness(u'do_not_clean.esp')
+
+        self.assertEqual(cleanliness, PluginCleanliness.do_not_clean)
 
 if __name__ == '__main__':
     unittest.main()