Add support for PHP attributes

wouterj · wouterj · commit 4c325d974492 · 2024-05-17T21:46:01.000+02:00
diff --git a/src/Templates/highlight.php/php.json b/src/Templates/highlight.php/php.json
@@ -8,8 +8,23 @@
         "php7"
     ],
     "case_insensitive": true,
-    "keywords": "and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try switch continue endfor endif declare unset true false trait goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",
+    "keywords": "and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try match switch continue endfor endif declare unset true false goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",
     "contains": [
+        {
+            "className": "php-attribute",
+            "begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+|\\\\?[A-Z]+(?=[A-Z][a-z0-9_\\x7f-\\xff])){1,}(?![A-Za-z0-9])(?![$])",
+            "end": "]",
+            "contains": [
+                {
+                    "begin": "\\(",
+                    "end": "\\)",
+                    "keywords": "true false null new array",
+                    "contains": {
+                        "$ref": "#contains.10.contains.1.contains"
+                    }
+                }
+            ]
+        },
         {
             "className": "comment",
             "begin": "#",
@@ -35,7 +50,7 @@
                     "begin": "<\\?(php)?|\\?>"
                 },
                 {
-                    "$ref": "#contains.0.contains.0"
+                    "$ref": "#contains.1.contains.0"
                 },
                 {
                     "className": "doctag",
@@ -54,7 +69,7 @@
                     "begin": "@[A-Za-z]+"
                 },
                 {
-                    "$ref": "#contains.0.contains.0"
+                    "$ref": "#contains.1.contains.0"
                 },
                 {
                     "className": "doctag",
@@ -69,7 +84,7 @@
             "end": false,
             "contains": [
                 {
-                    "$ref": "#contains.0.contains.0"
+                    "$ref": "#contains.1.contains.0"
                 },
                 {
                     "className": "doctag",
@@ -105,7 +120,7 @@
             ]
         },
         {
-            "$ref": "#contains.1.contains.0"
+            "$ref": "#contains.2.contains.0"
         },
         {
             "className": "variable",
@@ -137,18 +152,19 @@
                     "className": "params",
                     "begin": "\\(",
                     "end": "\\)",
+                    "keywords": "true false null new array",
                     "contains": [
                         "self",
                         {
-                            "$ref": "#contains.7"
+                            "$ref": "#contains.8"
                         },
                         {
                             "className": "comment",
                             "begin": "/\\*",
                             "end": "\\*/",
                             "contains": [
                                 {
-                                    "$ref": "#contains.0.contains.0"
+                                    "$ref": "#contains.1.contains.0"
                                 },
                                 {
                                     "className": "doctag",
@@ -161,10 +177,10 @@
                             "className": "string",
                             "contains": [
                                 {
-                                    "$ref": "#contains.4.contains.0"
+                                    "$ref": "#contains.5.contains.0"
                                 },
                                 {
-                                    "$ref": "#contains.1.contains.0"
+                                    "$ref": "#contains.2.contains.0"
                                 }
                             ],
                             "variants": [
@@ -183,7 +199,7 @@
                                     "illegal": null,
                                     "contains": [
                                         {
-                                            "$ref": "#contains.4.contains.0"
+                                            "$ref": "#contains.5.contains.0"
                                         }
                                     ]
                                 },
@@ -194,7 +210,7 @@
                                     "illegal": null,
                                     "contains": [
                                         {
-                                            "$ref": "#contains.4.contains.0"
+                                            "$ref": "#contains.5.contains.0"
                                         },
                                         {
                                             "className": "subst",
@@ -230,7 +246,7 @@
         },
         {
             "className": "class",
-            "beginKeywords": "class interface",
+            "beginKeywords": "class interface trait enum",
             "end": "{",
             "excludeEnd": true,
             "illegal": "[:\\(\\$\"]",
@@ -239,7 +255,7 @@
                     "beginKeywords": "extends implements"
                 },
                 {
-                    "$ref": "#contains.9.contains.0"
+                    "$ref": "#contains.10.contains.0"
                 }
             ]
         },
@@ -249,7 +265,7 @@
             "illegal": "[\\.']",
             "contains": [
                 {
-                    "$ref": "#contains.9.contains.0"
+                    "$ref": "#contains.10.contains.0"
                 }
             ]
         },
@@ -258,18 +274,18 @@
             "end": ";",
             "contains": [
                 {
-                    "$ref": "#contains.9.contains.0"
+                    "$ref": "#contains.10.contains.0"
                 }
             ]
         },
         {
             "begin": "=>"
         },
         {
-            "$ref": "#contains.9.contains.1.contains.3"
+            "$ref": "#contains.10.contains.1.contains.3"
         },
         {
-            "$ref": "#contains.9.contains.1.contains.4"
+            "$ref": "#contains.10.contains.1.contains.4"
         }
     ]
 }
diff --git a/tests/fixtures/expected/blocks/code-blocks/php-attributes.html b/tests/fixtures/expected/blocks/code-blocks/php-attributes.html
@@ -1,4 +1,4 @@
-<div translate="no" data-loc="48" class="notranslate codeblock codeblock-length-md codeblock-php-attributes codeblock-php">
+<div translate="no" data-loc="54" class="notranslate codeblock codeblock-length-md codeblock-php-attributes codeblock-php">
     <div class="codeblock-scroll">
         <pre class="codeblock-lines">1
 2
@@ -47,7 +47,13 @@
 45
 46
 47
-48</pre>
+48
+49
+50
+51
+52
+53
+54</pre>
         <pre class="codeblock-code">
             <code>
                 <span class="hljs-comment">// src/SomePath/SomeClass.php</span>
@@ -63,85 +69,72 @@
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property1</span>
                 ;
-                <span class="hljs-php-attribute">#[AttributeName(</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[AttributeName()]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property2</span>
                 ;
-                <span class="hljs-php-attribute">#[AttributeName(</span>
-                <span class="hljs-string">'value'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[AttributeName(<span class="hljs-string">'value'</span>)]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property3</span>
                 ;
-                <span class="hljs-php-attribute">#[AttributeName(</span>
-                <span class="hljs-string">'value'</span>
-                , option:
-                <span class="hljs-string">'value'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[AttributeName(<span class="hljs-string">'value'</span>, option: <span class="hljs-string">'value'</span>)]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property4</span>
                 ;
-                <span class="hljs-php-attribute">#[AttributeName(</span>
-[<span class="hljs-string">'value'</span> =&gt; <span class="hljs-string">'value'</span>]<span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[AttributeName([<span class="hljs-string">'value'</span> =&gt; <span class="hljs-string">'value'</span>])]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property5</span>
                 ;
-                <span class="hljs-php-attribute">#[AttributeName(</span>
-                <span class="hljs-string">'value'</span>
-                , option:
-                <span class="hljs-string">'value'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[AttributeName(
+                    <span class="hljs-string">'value'</span>,
+                    option: <span class="hljs-string">'value'</span>
+                )]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property6</span>
                 ;
-                <span class="hljs-php-attribute">#[Assert\AttributeName(</span>
-                <span class="hljs-string">'value'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[Assert\AttributeName(<span class="hljs-string">'value'</span>)]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property7</span>
                 ;
-                <span class="hljs-php-attribute">#[Assert\AttributeName(</span>
-                <span class="hljs-string">'value'</span>
-                , option:
-                <span class="hljs-string">'value'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[Assert\AttributeName(
+                    <span class="hljs-string">'value'</span>,
+                    option: <span class="hljs-string">'value'</span>
+                )]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                     <span class="hljs-variable-other-marker">$</span> property8</span>
                 ;
-                <span class="hljs-php-attribute">#[Route(</span>
-                <span class="hljs-string">'/blog/{page&lt;\d+&gt;}'</span>
-                , name:
-                <span class="hljs-string">'blog_list'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[Route(<span class="hljs-string">'/blog/{page&lt;\d+&gt;}'</span>, name: <span class="hljs-string">'blog_list'</span>)]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                 <span class="hljs-variable-other-marker">$</span> property9</span>
                 ;
-                <span class="hljs-php-attribute">#[Assert\GreaterThanOrEqual(</span>
-                value:
-                <span class="hljs-number">18</span>
-                ,
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[Assert\GreaterThanOrEqual(
+                    value: <span class="hljs-number">18</span>,
+                )]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                 <span class="hljs-variable-other-marker">$</span> property10</span>
                 ;
-                <span class="hljs-php-attribute">#[ORM\CustomIdGenerator(</span>
-                class:
-                <span class="hljs-string">'doctrine.uuid_generator'</span>
-                <span class="hljs-php-attribute">)]</span>
+                <span class="hljs-php-attribute">#[ORM\CustomIdGenerator(class: <span class="hljs-string">'doctrine.uuid_generator'</span>)]</span>
                 <span class="hljs-keyword">private</span>
                 <span class="hljs-variable">
                 <span class="hljs-variable-other-marker">$</span> property11</span>
                 ;
+                <span class="hljs-php-attribute">#[Assert\AtLeastOneOf([
+                    <span class="hljs-keyword">new</span> Assert\Regex(<span class="hljs-string">'/#/'</span>),
+                    <span class="hljs-keyword">new</span> Assert\Length(min: <span class="hljs-number">10</span>),
+                ])]</span>
+                <span class="hljs-keyword">private</span>
+                <span class="hljs-variable">
+                <span class="hljs-variable-other-marker">$</span> property12</span>
+                ;
 }</code></pre>
     </div>
 </div>
diff --git a/tests/fixtures/source/blocks/code-blocks/php-attributes.rst b/tests/fixtures/source/blocks/code-blocks/php-attributes.rst
@@ -47,5 +47,10 @@
 
         #[ORM\CustomIdGenerator(class: 'doctrine.uuid_generator')]
         private $property11;
-    }
 
+        #[Assert\AtLeastOneOf([
+            new Assert\Regex('/#/'),
+            new Assert\Length(min: 10),
+        ])]
+        private $property12;
+    }
diff --git a/tests/fixtures/source/blocks/code-blocks/text.rst b/tests/fixtures/source/blocks/code-blocks/text.rst
@@ -1,3 +1,5 @@
 
 .. code-block:: text
     some text with special chars < > " & and some text with special chars already escaped &lt; &gt; &quot; &amp;
+
+    .. image:: image.png

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,23 @@`
`8`	`8`	`"php7"`
`9`	`9`	`],`
`10`	`10`	`"case_insensitive": true,`
`11`		- "keywords": "and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try switch continue endfor endif declare unset true false trait goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",
	`11`	+ "keywords": "and include_once list abstract global private echo interface as static endswitch array null if endwhile or const for endforeach self var while isset public protected exit foreach throw elseif include __FILE__ empty require_once do xor return parent clone use __CLASS__ __LINE__ else break print eval new catch __METHOD__ case exception default die require __FUNCTION__ enddeclare final try match switch continue endfor endif declare unset true false goto instanceof insteadof __DIR__ __NAMESPACE__ yield finally",
`12`	`12`	`"contains": [`
	`13`	`+ {`
	`14`	`+ "className": "php-attribute",`
	`15`	`+ "begin": "#\\[\\s*(\\\\?[A-Z][A-Za-z0-9_\\x7f-\\xff]+\|\\\\?[A-Z]+(?=[A-Z][a-z0-9_\\x7f-\\xff])){1,}(?![A-Za-z0-9])(?![$])",`
	`16`	`+ "end": "]",`
	`17`	`+ "contains": [`
	`18`	`+ {`
	`19`	`+ "begin": "\\(",`
	`20`	`+ "end": "\\)",`
	`21`	`+ "keywords": "true false null new array",`
	`22`	`+ "contains": {`
	`23`	`+ "$ref": "#contains.10.contains.1.contains"`
	`24`	`+ }`
	`25`	`+ }`
	`26`	`+ ]`
	`27`	`+ },`
`13`	`28`	`{`
`14`	`29`	`"className": "comment",`
`15`	`30`	`"begin": "#",`
`@@ -35,7 +50,7 @@`
`35`	`50`	`"begin": "<\\?(php)?\|\\?>"`
`36`	`51`	`},`
`37`	`52`	`{`
`38`		`- "$ref": "#contains.0.contains.0"`
	`53`	`+ "$ref": "#contains.1.contains.0"`
`39`	`54`	`},`
`40`	`55`	`{`
`41`	`56`	`"className": "doctag",`
`@@ -54,7 +69,7 @@`
`54`	`69`	`"begin": "@[A-Za-z]+"`
`55`	`70`	`},`
`56`	`71`	`{`
`57`		`- "$ref": "#contains.0.contains.0"`
	`72`	`+ "$ref": "#contains.1.contains.0"`
`58`	`73`	`},`
`59`	`74`	`{`
`60`	`75`	`"className": "doctag",`
`@@ -69,7 +84,7 @@`
`69`	`84`	`"end": false,`
`70`	`85`	`"contains": [`
`71`	`86`	`{`
`72`		`- "$ref": "#contains.0.contains.0"`
	`87`	`+ "$ref": "#contains.1.contains.0"`
`73`	`88`	`},`
`74`	`89`	`{`
`75`	`90`	`"className": "doctag",`
`@@ -105,7 +120,7 @@`
`105`	`120`	`]`
`106`	`121`	`},`
`107`	`122`	`{`
`108`		`- "$ref": "#contains.1.contains.0"`
	`123`	`+ "$ref": "#contains.2.contains.0"`
`109`	`124`	`},`
`110`	`125`	`{`
`111`	`126`	`"className": "variable",`
`@@ -137,18 +152,19 @@`
`137`	`152`	`"className": "params",`
`138`	`153`	`"begin": "\\(",`
`139`	`154`	`"end": "\\)",`
	`155`	`+ "keywords": "true false null new array",`
`140`	`156`	`"contains": [`
`141`	`157`	`"self",`
`142`	`158`	`{`
`143`		`- "$ref": "#contains.7"`
	`159`	`+ "$ref": "#contains.8"`
`144`	`160`	`},`
`145`	`161`	`{`
`146`	`162`	`"className": "comment",`
`147`	`163`	`"begin": "/\\*",`
`148`	`164`	`"end": "\\*/",`
`149`	`165`	`"contains": [`
`150`	`166`	`{`
`151`		`- "$ref": "#contains.0.contains.0"`
	`167`	`+ "$ref": "#contains.1.contains.0"`
`152`	`168`	`},`
`153`	`169`	`{`
`154`	`170`	`"className": "doctag",`
`@@ -161,10 +177,10 @@`
`161`	`177`	`"className": "string",`
`162`	`178`	`"contains": [`
`163`	`179`	`{`
`164`		`- "$ref": "#contains.4.contains.0"`
	`180`	`+ "$ref": "#contains.5.contains.0"`
`165`	`181`	`},`
`166`	`182`	`{`
`167`		`- "$ref": "#contains.1.contains.0"`
	`183`	`+ "$ref": "#contains.2.contains.0"`
`168`	`184`	`}`
`169`	`185`	`],`
`170`	`186`	`"variants": [`
`@@ -183,7 +199,7 @@`
`183`	`199`	`"illegal": null,`
`184`	`200`	`"contains": [`
`185`	`201`	`{`
`186`		`- "$ref": "#contains.4.contains.0"`
	`202`	`+ "$ref": "#contains.5.contains.0"`
`187`	`203`	`}`
`188`	`204`	`]`
`189`	`205`	`},`
`@@ -194,7 +210,7 @@`
`194`	`210`	`"illegal": null,`
`195`	`211`	`"contains": [`
`196`	`212`	`{`
`197`		`- "$ref": "#contains.4.contains.0"`
	`213`	`+ "$ref": "#contains.5.contains.0"`
`198`	`214`	`},`
`199`	`215`	`{`
`200`	`216`	`"className": "subst",`
`@@ -230,7 +246,7 @@`
`230`	`246`	`},`
`231`	`247`	`{`
`232`	`248`	`"className": "class",`
`233`		`- "beginKeywords": "class interface",`
	`249`	`+ "beginKeywords": "class interface trait enum",`
`234`	`250`	`"end": "{",`
`235`	`251`	`"excludeEnd": true,`
`236`	`252`	`"illegal": "[:\\(\\$\"]",`
`@@ -239,7 +255,7 @@`
`239`	`255`	`"beginKeywords": "extends implements"`
`240`	`256`	`},`
`241`	`257`	`{`
`242`		`- "$ref": "#contains.9.contains.0"`
	`258`	`+ "$ref": "#contains.10.contains.0"`
`243`	`259`	`}`
`244`	`260`	`]`
`245`	`261`	`},`
`@@ -249,7 +265,7 @@`
`249`	`265`	`"illegal": "[\\.']",`
`250`	`266`	`"contains": [`
`251`	`267`	`{`
`252`		`- "$ref": "#contains.9.contains.0"`
	`268`	`+ "$ref": "#contains.10.contains.0"`
`253`	`269`	`}`
`254`	`270`	`]`
`255`	`271`	`},`
`@@ -258,18 +274,18 @@`
`258`	`274`	`"end": ";",`
`259`	`275`	`"contains": [`
`260`	`276`	`{`
`261`		`- "$ref": "#contains.9.contains.0"`
	`277`	`+ "$ref": "#contains.10.contains.0"`
`262`	`278`	`}`
`263`	`279`	`]`
`264`	`280`	`},`
`265`	`281`	`{`
`266`	`282`	`"begin": "=>"`
`267`	`283`	`},`
`268`	`284`	`{`
`269`		`- "$ref": "#contains.9.contains.1.contains.3"`
	`285`	`+ "$ref": "#contains.10.contains.1.contains.3"`
`270`	`286`	`},`
`271`	`287`	`{`
`272`		`- "$ref": "#contains.9.contains.1.contains.4"`
	`288`	`+ "$ref": "#contains.10.contains.1.contains.4"`
`273`	`289`	`}`
`274`	`290`	`]`
`275`	`291`	`}`