guiwf/lix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

parser: improve error message for ill-defined escape sequences

Browse Source 
fixes #1169

Change-Id: Ic93e0cb5442b717964de3ae9eb22f4cd48e4ad0a
This commit is contained in:
rootile
2026-06-25 21:03:09 +00:00
committed by eldritch horrors
parent de68de1d11
commit fce63f6dbf
3 changed files with 21 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lix/libexpr/parser/state.hh
+12 -2
View File
@@ -133,14 +133,24 @@ inline void State::badEscapeFound(const PosIdx pos, char found, bool isIndented)
{
auto escape = std::string(isIndented ? "''\\" : "\\");
auto interpolEscape = std::string(isIndented ? "''${" : "\\${");
auto backslashChar = std::string("\\") + found;
HintFmt dedicatedInsert = isIndented
? HintFmt("you can simply write it as %s in the string", backslashChar)
: HintFmt("you need to escape the %s itself: %s", escape, escape + escape + found);
HintFmt msg = HintFmt(
"%s is an ill-defined escape. You can drop the %s and simply write %s instead. "
"%s is an ill-defined escape sequence. In Nix, it simply means %s, therefore the %s is redundant and "
"should be removed. If the intent of the string was to mean %s instead (e.g. in a regex), %s. "
"Use %s to silence this warning.",
escape + found,
escape,
found,
escape,
backslashChar,
Uncolored(dedicatedInsert.str()),
"--extra-deprecated-features broken-string-escape"
);
/* Special case some common escapes to provide better messages */
if (found == '$' || found == '{') {
/* Someone possibly tried to escape an interpolation but used the wrong sequence.
tests/functional2/lang/string-indented/eval-okay-escapes.err.exp
+5 -5
View File
@@ -1,10 +1,10 @@
warning: ''\a is an ill-defined escape. You can drop the ''\ and simply write a instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: ''\a is an ill-defined escape sequence. In Nix, it simply means a, therefore the ''\ is redundant and should be removed. If the intent of the string was to mean \a instead (e.g. in a regex), you can simply write it as \a in the string. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:2:4:
1| ''
2| ''\a''\n
| ^
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
warning: ''\f is an ill-defined escape. You can drop the ''\ and simply write f instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: ''\f is an ill-defined escape sequence. In Nix, it simply means f, therefore the ''\ is redundant and should be removed. If the intent of the string was to mean \f instead (e.g. in a regex), you can simply write it as \f in the string. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:3:4:
2| ''\a''\n
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
@@ -22,19 +22,19 @@ warning: ''\$ is an ill-defined escape. You can drop the ''\ and simply write $
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
| ^
4| ''\'''${"x"}
warning: ''\" is an ill-defined escape. You can drop the ''\ and simply write " instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: ''\" is an ill-defined escape sequence. In Nix, it simply means ", therefore the ''\ is redundant and should be removed. If the intent of the string was to mean \" instead (e.g. in a regex), you can simply write it as \" in the string. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:3:16:
2| ''\a''\n
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
| ^
4| ''\'''${"x"}
warning: ''\v is an ill-defined escape. You can drop the ''\ and simply write v instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: ''\v is an ill-defined escape sequence. In Nix, it simply means v, therefore the ''\ is redundant and should be removed. If the intent of the string was to mean \v instead (e.g. in a regex), you can simply write it as \v in the string. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:3:28:
2| ''\a''\n
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
| ^
4| ''\'''${"x"}
warning: ''\\ is an ill-defined escape. You can drop the ''\ and simply write \ instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: ''\\ is an ill-defined escape sequence. In Nix, it simply means \, therefore the ''\ is redundant and should be removed. If the intent of the string was to mean \\ instead (e.g. in a regex), you can simply write it as \\ in the string. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:3:32:
2| ''\a''\n
3| ''\f''\{''\$''\"''\'''\r''\v''\\''\t
tests/functional2/lang/string/eval-okay-escapes.err.exp
+4 -4
View File
@@ -1,4 +1,4 @@
warning: \a is an ill-defined escape. You can drop the \ and simply write a instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: \a is an ill-defined escape sequence. In Nix, it simply means a, therefore the \ is redundant and should be removed. If the intent of the string was to mean \a instead (e.g. in a regex), you need to escape the \ itself: \\a. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:1:3:
1| "\a\n\{\$\"\'\r\v\\\t
| ^
@@ -8,17 +8,17 @@ warning: \{ is an ill-defined escape. You can drop the \ and simply write { inst
1| "\a\n\{\$\"\'\r\v\\\t
| ^
2| \f"
warning: \' is an ill-defined escape. You can drop the \ and simply write ' instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: \' is an ill-defined escape sequence. In Nix, it simply means ', therefore the \ is redundant and should be removed. If the intent of the string was to mean \' instead (e.g. in a regex), you need to escape the \ itself: \\'. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:1:13:
1| "\a\n\{\$\"\'\r\v\\\t
| ^
2| \f"
warning: \v is an ill-defined escape. You can drop the \ and simply write v instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: \v is an ill-defined escape sequence. In Nix, it simply means v, therefore the \ is redundant and should be removed. If the intent of the string was to mean \v instead (e.g. in a regex), you need to escape the \ itself: \\v. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:1:17:
1| "\a\n\{\$\"\'\r\v\\\t
| ^
2| \f"
warning: \f is an ill-defined escape. You can drop the \ and simply write f instead. Use --extra-deprecated-features broken-string-escape to silence this warning.
warning: \f is an ill-defined escape sequence. In Nix, it simply means f, therefore the \ is redundant and should be removed. If the intent of the string was to mean \f instead (e.g. in a regex), you need to escape the \ itself: \\f. Use --extra-deprecated-features broken-string-escape to silence this warning.
at /pwd/in.nix:2:2:
1| "\a\n\{\$\"\'\r\v\\\t
2| \f"