Add warning note about specific use of strtok

eldering · eldering · commit 98157a2a8075 · 2024-01-16T21:48:22.000Z
diff --git a/webapp/src/Twig/TwigExtension.php b/webapp/src/Twig/TwigExtension.php
@@ -862,6 +862,10 @@ public function codeEditor(
                            sprintf($editor, $code, $editable ? 'false' : 'true', $mode, $extraForEdit));
     }
 
+    // This function expects $difftext to be in unified diff format. In
+    // particular each line is expected to contain at least some character
+    // (that is, a leading space, + or -) so that strtok does not gobble up
+    // multiple empty lines in one go.
     protected function parseSourceDiff(string $difftext): string
     {
         $line   = strtok($difftext, "\n"); // first line

Original file line number	Diff line number	Diff line change
`@@ -862,6 +862,10 @@ public function codeEditor(`
`862`	`862`	`sprintf($editor, $code, $editable ? 'false' : 'true', $mode, $extraForEdit));`
`863`	`863`	`}`
`864`	`864`
	`865`	`+ // This function expects $difftext to be in unified diff format. In`
	`866`	`+ // particular each line is expected to contain at least some character`
	`867`	`+ // (that is, a leading space, + or -) so that strtok does not gobble up`
	`868`	`+ // multiple empty lines in one go.`
`865`	`869`	`protected function parseSourceDiff(string $difftext): string`
`866`	`870`	`{`
`867`	`871`	`$line = strtok($difftext, "\n"); // first line`