mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Oliver Hamlet
f14e47e0e8
It uses about 56 MB less memory when LOOT launches into my Skyrim SE
large test load order with the latest masterlist and prelude, and
explicitly targets ECMAScript-like syntax like C++ std::regex does,
though supports newer functionality.
Compared to fancy-regex's syntax support, regress adds support for the
\0 nul character escape and removes support for:
- modifiers (e.g. `(?i)`)
- some Unicode character classes (e.g. used with `\p{}` and `\P{}`)
- the ASCII/POSIX character classes (e.g. `[:alpha:]`)
- various character escapes, including \A \a \z \b{start} \<
\b{end} \> \b{start-half} \b{end-half}
- (?P<name>exp) named capture groups
However, since regress's v flag requires more characters to be escaped
inside character classes than fancy-regex's Unicode support requires,
it's not used, so that further restricts the supported Unicode character
classes, and means that character class intersection, union and
subtraction syntaxes aren't supported.
The nul character escape is irrelevant for filename matching as it's not
allowed in Windows or Linux filenames.
Compared to C++ std::regex, the new restrictions are:
- the lack of support for ASCII/POSIX character classes
- the lack of support for control character escapes (e.g. `\cX`)
The lack of support for control character escapes is irrelevant as
control characters aren't allowed in Windows filenames.
A search of the masterlists doesn't find any use of the ASCII character
classes, and it's very unlikely that any user metadata would use them.
If such syntax is in use, it'll cause an error.
254 lines
7.7 KiB
ReStructuredText
254 lines
7.7 KiB
ReStructuredText
***************
|
|
Version History
|
|
***************
|
|
|
|
The version history of the metadata syntax is given below.
|
|
|
|
0.26 - 2025-04-19
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The ``File`` data structure now has a ``constraint`` key that takes a
|
|
condition string that must evaluate to true for the file's existence to be
|
|
recognised.
|
|
- The ``file_size(file_path path, file_size size)`` condition function, which
|
|
returns true if the given file's size matches the given number of bytes, and
|
|
false otherwise (including if the file doesn't exist).
|
|
- The ``filename_version(regular_expression path, version given_version, comparison_operator comparator)``
|
|
condition function, which takes a regex path with a single capture group, a
|
|
version string and a comparison operator and returns true if there is a path
|
|
that matches the regex path and the value captured by the regex is a version
|
|
string for which the comparison against the given version is true. Unlike the
|
|
other version functions, it always returns false if it cannot find a version
|
|
to compare against the given version, irrespective of the given comparison
|
|
operator.
|
|
- The ``description_contains(file_path path, regular_expression regex)``
|
|
condition function, which takes a path and a regex and returns true if the
|
|
given path is a plugin with a description that contains text that matches the
|
|
given regex, and false otherwise (including if the path does not exist, is not
|
|
a plugin, or has no description).
|
|
- The ``is_executable(file_path path)`` condition function, which returns true
|
|
if the given path is a Windows executable (PE) file.
|
|
|
|
Changed
|
|
-------
|
|
|
|
- Line breaks are now accepted as whitespace when parsing condition strings, so
|
|
long expressions can be split over multiple lines.
|
|
|
|
|
|
0.21 - 2023-08-30
|
|
=================
|
|
|
|
Changed
|
|
-------
|
|
|
|
- The syntax for substitution placeholders is now zero-indexed and uses curly
|
|
braces instead of percentage signs. For example, ``%1% %2%`` is now
|
|
``{0} {1}``.
|
|
|
|
Removed
|
|
-------
|
|
|
|
- Support for the ``LOOT`` file path alias. It will now be interpreted as a
|
|
normal path, i.e. a file or folder named ``LOOT`` in the game's data path.
|
|
|
|
0.18 - 2022-02-27
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The condition function ``readable(filesystem_path path)``, which checks if
|
|
the given path is a readable directory or file.
|
|
|
|
Changed
|
|
-------
|
|
|
|
- The documentation for the version comparison condition functions has been
|
|
updated to detail the supported version syntax and semantics.
|
|
- Mentions of GitHub Flavored Markdown have been replaced with CommonMark, as
|
|
LOOT now uses the latter instead of the former.
|
|
|
|
Fixed
|
|
-----
|
|
|
|
- Support for ``not (<expression>)`` syntax was not properly documented.
|
|
- The documentation for the version comparison functions stated that missing
|
|
versions would be treated as if they were ``0``, which was not accurate.
|
|
|
|
0.17 - 2021-09-24
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The ``File`` data structure now has a ``detail`` key that takes a string or
|
|
localised content list.
|
|
- The top-level ``prelude`` key can be used to supply common data structure
|
|
definitions, and in masterlists its value is replaced by the contents of the
|
|
masterlist prelude file, if present.
|
|
- Support for parsing inverted metadata conditions (``not (<expression>)``).
|
|
|
|
Changed
|
|
-------
|
|
|
|
- The cleaning data structure's ``info`` key has been renamed to ``detail`` for
|
|
consistency.
|
|
|
|
0.16 - 2020-07-12
|
|
=================
|
|
|
|
Changed
|
|
-------
|
|
|
|
- Equality for all metadata data structures is now determined by comparison of
|
|
all their fields. String comparison is case-sensitive, with the exception of
|
|
``File``'s ``name`` field.
|
|
|
|
Removed
|
|
-------
|
|
|
|
- The ``enabled`` field has been removed from plugin metadata objects.
|
|
|
|
0.15 - 2019-11-05
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The condition function ``is_master(file_path path)``, which checks if the
|
|
given file is an installed master plugin.
|
|
|
|
0.14 - 2018-12-09
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The ``Group`` data structure now has a ``description`` key that takes a string
|
|
value.
|
|
- The condition function ``product_version(file_path path, version
|
|
given_version, comparison_operator comparator)``, which checks against the
|
|
Product Version field of an executable.
|
|
|
|
Changed
|
|
-------
|
|
|
|
- ``clean`` and ``dirty`` metadata are now allowed in regex plugin entries.
|
|
- ``Location``, ``Message``, ``MessageContent`` and ``Tag`` equality comparisons
|
|
are now case-sensitive.
|
|
- Regular expressions in condition strings now use a `modified Perl grammar`_
|
|
instead of a modified ECMAScript grammar. ``Plugin`` object ``name`` fields
|
|
still use the modified ECMAScript grammar for regex values. To improve
|
|
portability and avoid mistakes, it's best to stick to using the subset of
|
|
regular expression features that are common to both grammars.
|
|
|
|
Removed
|
|
-------
|
|
|
|
- The change in regular expression grammar means that the following regular
|
|
expression features are no longer supported in condition strings:
|
|
|
|
- ``\c<letter>`` control code escape sequences, use ``\x<hex>`` instead
|
|
- The ``\0`` null escape sequence, - use ``\x00`` instead
|
|
- The ``[:d:]``, ``[:w:]`` and ``[:s:]`` character classes,
|
|
use ``\d``, ``\w`` and ``\s`` instead respectively.
|
|
- ``\<number>`` backreferences
|
|
- ``(?=<subpattern>)`` and ``(?!<subpattern>)`` positive and negative lookahead
|
|
|
|
.. _modified Perl grammar: https://docs.rs/regex/1.0.5/regex/index.html#syntax
|
|
|
|
0.13 - 2018-04-02
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
- The ``Group`` data structure.
|
|
- The ``groups`` list to the root of the metadata file format.
|
|
- The ``group`` key to the plugin data structure.
|
|
|
|
Removed
|
|
-------
|
|
|
|
- The ``priority`` field from the plugin data structure.
|
|
- The ``global_priority`` field from the plugin data structure.
|
|
|
|
0.10 - 2016-11-06
|
|
=================
|
|
|
|
Added
|
|
-----
|
|
|
|
* The ``clean`` key to the plugin data structure.
|
|
* The ``global_priority`` field to the plugin data structure.
|
|
* The ``many_active()`` condition function.
|
|
* The ``info`` key to the cleaning data structure.
|
|
|
|
Changed
|
|
-------
|
|
|
|
* Renamed the ``str`` key in the localised content data structure to ``text`` .
|
|
* The ``priority`` field of the plugin data structure now stores values between -127 and 127 inclusive.
|
|
* Regular expressions no longer accept ``\`` as a directory separator: ``/`` must now be used.
|
|
* The ``file()`` condition function now also accepts a regular expression.
|
|
* The ``active()`` condition function to also accept a regular expression.
|
|
* Renamed the dirty info data structure to the cleaning data structure.
|
|
|
|
Removed
|
|
-------
|
|
|
|
* The ``regex()`` condition function, as it has been obsoleted by the ``file()`` function's new regex support.
|
|
|
|
0.8 - 2015-07-22
|
|
================
|
|
|
|
Added
|
|
-----
|
|
|
|
* The ``name`` key to the location data structure.
|
|
* The ``many("regex")`` condition function.
|
|
* The documentation now defines the equality criteria for all of the metadata syntax's non-standard data structures.
|
|
|
|
Changed
|
|
-------
|
|
|
|
* Detection of regular expression plugin entries. Previously, a plugin entry was treated as having a regular expression filename if the filename ended with ``\.esp`` or ``\.esp`` . Now, a plugin entry is treated as having a regular expression filename if the filename contains one or more of ``:\*?|`` .
|
|
|
|
Removed
|
|
-------
|
|
|
|
* Removed the ``ver`` key in the location data structure.
|
|
|
|
Fixed
|
|
-----
|
|
|
|
* The documentation gave the values of the ``after`` , ``req`` , ``inc`` , ``tag`` , ``url`` and ``dirty`` keys as lists, when they have always been sets.
|
|
|
|
0.7 - 2015-05-20
|
|
================
|
|
|
|
Added
|
|
-----
|
|
|
|
* The message string substitution key, i.e. ``sub`` , in the message data structure.
|
|
* Support for YAML merge keys, i.e. ``<<`` .
|
|
|
|
Changed
|
|
-------
|
|
|
|
* Messages may now be formatted using most of GitHub Flavored Markdown, minus the GitHub-specific features (like @mentions, issue/repo linking and emoji).
|
|
|
|
0.6 - 2014-07-05
|
|
================
|
|
|
|
No changes.
|
|
|
|
0.5 - 2014-03-31
|
|
================
|
|
|
|
Initial release.
|