Commit Graph
37 Commits
Author SHA1 Message Date
Oliver Hamlet 1443ae91c6 Update docs 2026-01-21 20:13:30 +00:00
Oliver Hamlet 8a7190bfd3 Don't say modifiers aren't supported
They're supported by regress as of v0.10.5.
2026-01-21 17:55:56 +00:00
Oliver Hamlet faa48eb2e6 Update some outdated info in metadata doc 2025-10-11 10:22:35 +01:00
Oliver Hamlet f14e47e0e8 Switch to the regress crate for regex
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.
2025-07-29 18:25:40 +01:00
Oliver Hamlet efd2d43ae3 Update plugin name regex doc
fancy-regex supports more syntax than C++ std::regex, but for the syntax
that they both accept:

- std::regex matches . against a single character, fancy-regex matches
  it against a Unicode codepoint
- \w \W \d \D \s \S \b and \B are locale-dependent in std::regex but
  Unicode-aware and locale-independent in fancy-regex
- case-insensitive comparisons are locale-dependent in std::regex but
  are Unicode-aware and locale-independent in fancy-regex
- std::regex supports \0 and \cX escapes, where X is in [A-Za-z] but
  fancy-regex does not. This is not significant for libloot's usage as
  nul and control characters are not allowed in Windows filenames.
- std::regex treats \< and \> as < and > respectively, but fancy-regex
  treats them as start- and end-of-word boundary assertions
  respectively. This is not significant for libloot's usage as they are
  not allowed in Windows filenames.
- std::regex allows a literal [ to appear within a character class, but
  fancy-regex requires it to be escaped.

These differences are unlikely to cause any issues.
2025-07-29 17:56:31 +01:00
Oliver Hamlet bee0f36d7b Improve docs for language values 2025-06-11 17:34:56 +01:00
Oliver Hamlet 575e6d5c93 Add support for "constraint" in File metadata 2025-04-07 08:24:27 +01:00
Oliver Hamlet 0a7efcb4d3 Update version and changelogs for v0.21 release 2023-08-30 19:57:06 +01:00
Oliver HamletandOliver Hamlet dc95b18805 Replace use of Boost Format with fmt
Using the version of fmt that's bundled with spdlog.

This breaks compatibility with existing metadata messages that use
substitutions, as the placeholder syntax has changed. The new syntax is
compatible with C++20's std::format.
2023-08-29 21:32:52 +01:00
Oliver Hamlet 5589dfbf4c Replace references to GitHub Flavored Markdown with CommonMark
LOOT now uses Qt's support for Markdown, but its support for GFM is
bugged so LOOT uses CommonMark instead. The practical impact is very
minor, but reflect the difference in libloot's docs.
2022-02-06 17:45:08 +00:00
sibir-ine 720170509a Update Localised Content page
* Add Ukrainian to list of example languages (l10n added in v0.17.0).
2022-01-07 02:22:40 -08:00
Oliver Hamlet a9a71998f1 Rename the 'info' property in cleaning data objects to 'detail'
To be consistent with the new property in File objects, as they share
the same type and sematics.
2021-05-22 19:26:29 +01:00
Oliver Hamlet fc22d3d7a4 Add a "detail" property to File objects
This property can be used to provide detail about a requirement or
incompatibility that can be displayed in the error message displayed
for the file (if one is displayed).
2021-05-22 19:26:29 +01:00
sibir-ine 3b7694fc07 Update example in Examples
* LOOT currently displays type of notification by background color, not explicitly.
* Provided a manual translation of the example text, courtesy of a friend.
2021-04-09 04:46:34 -07:00
sibir-ine 06ce61de88 Update explanation in Language Support
* Explain new implementation of close matches.
* Wrapped lines at 80 characters.
2021-04-09 04:46:30 -07:00
Oliver Hamlet 0eace4b404 Updated example list of language codes
Fixes #78.
2021-04-03 13:32:49 +01:00
Oliver Hamlet 013b623f0b Replace broken links in docs
Fixes #77.
2021-04-03 13:29:03 +01:00
sibir-ineandOliver Hamlet 453334ae5f Add text to after section
- Clarify that regexes can't be used for afters, reqs, or incs.
  - As discussed with @MacSplody on Discord.
2021-03-26 10:04:23 +00:00
sibir-ineandOliver Hamlet b4fb4f079a Add text to req section
- Clarify behavior of conditions with req entries.
  - As discussed with @MacSplody on Discord.
2021-03-26 10:04:23 +00:00
SibirandGitHub 1ba07141e4 Fix typos & make adjustments to docs (#72)
* Adjustment
  - HTML entity doesn't render.

* Typos
  - Add a few missing spaces.
2021-03-11 16:10:22 -08:00
Oliver Hamlet 6e43be662f Clarify GitHub Flavored Markdown strings in metadata docs 2020-07-28 19:40:42 +01:00
Oliver Hamlet d9788b70fc Remove enabled field from PluginMetadata
It doesn't actually do anything, and fixing that turns out to be
very complicated. Since nobody appears to have noticed, just remove
the field entirely.
2020-07-11 19:13:13 +01:00
Oliver Hamlet 15076a6d26 Overhaul plugin metadata types' comparison operators
Change their implementations to check full object equality, with case insensitivity for filename strings.

The filename case insensitivity doesn't extend to filenames in condition strings, as conditions are compared as strings, but the risk of duplicates due to that is much less than the risk of treating non-duplicate objects as duplicates.
2020-07-11 19:13:07 +01:00
Oliver Hamlet 3baa0e88e5 Set version number and changelog for v0.15.2 2020-06-14 10:47:07 +01:00
Oliver Hamlet e9519b0e91 Fix inaccurate doc 2020-03-30 19:38:26 +01:00