Add support for overlay/fragments in DevicetreeLexer and update example DTS file

kartben · kartben · commit bbc7d1191a31 · 2026-01-22T15:58:08.000+01:00
The DTS lexer had issues with recognizing overlay/fragment syntax, whereby in
the following snippet:

&amp;i2c1 {
	serlcd@72 {
		compatible = "sparkfun,serlcd";
		reg = &lt;0x72&gt;;
		columns = &lt;16&gt;;
		rows = &lt;2&gt;;
		command-delay-ms = &lt;10&gt;;
		special-command-delay-ms = &lt;50&gt;;
	};
};

the "i2c1" was being tokenized as a Name.Attribute instead of a Name.Function,
causing the rest of the lexing to fail as it encountered the "@" character.

This fixes the issue by adding proper support for overlay/fragment syntax.

Signed-off-by: Benjamin Cabé &lt;benjamin@zephyrproject.org&gt;
diff --git a/pygments/lexers/devicetree.py b/pygments/lexers/devicetree.py
@@ -71,7 +71,10 @@ class DevicetreeLexer(RegexLexer):
         'root': [
             include('whitespace'),
             include('macro'),
-
+            # Overlay/fragment: &label { ... } or &{/path/to/node} { ... }
+            (r'(&)(?:([A-Za-z_]\w*)|(\{)([^}]+)(\}))(' + _ws + r')(\{)',
+             bygroups(Operator, Name.Function, Punctuation, Name.Namespace,
+                      Punctuation, Comment.Multiline, Punctuation), 'node'),
             # Nodes
             (r'([^/*@\s&]+|/)(@?)((?:0x)?[0-9a-fA-F,]*)(' + _ws + r')(\{)',
              bygroups(Name.Function, Operator, Number.Integer,
@@ -87,7 +90,10 @@ class DevicetreeLexer(RegexLexer):
         'node': [
             include('whitespace'),
             include('macro'),
-
+            # Overlay/fragment: &label { ... } or &{/path/to/node} { ... }
+            (r'(&)(?:([A-Za-z_]\w*)|(\{)([^}]+)(\}))(' + _ws + r')(\{)',
+             bygroups(Operator, Name.Function, Punctuation, Name.Namespace,
+                      Punctuation, Comment.Multiline, Punctuation), '#push'),
             (r'([^/*@\s&]+|/)(@?)((?:0x)?[0-9a-fA-F,]*)(' + _ws + r')(\{)',
              bygroups(Name.Function, Operator, Number.Integer,
                       Comment.Multiline, Punctuation), '#push'),
diff --git a/tests/examplefiles/devicetree/example.dts b/tests/examplefiles/devicetree/example.dts
@@ -79,6 +79,21 @@
 	};
 };
 
+&i2c1 {
+	serlcd@72 {
+		compatible = "sparkfun,serlcd";
+		reg = <0x72>;
+		columns = <16>;
+		rows = <2>;
+		command-delay-ms = <10>;
+		special-command-delay-ms = <50>;
+	};
+};
+
+&{/soc/i2c@e000d800} {
+	status = "okay";
+};
+
 &i2c3 {
 	clock-frequency = <100000>;
 	pinctrl-names = "default";
diff --git a/tests/examplefiles/devicetree/example.dts.output b/tests/examplefiles/devicetree/example.dts.output
