feat: add wrapping of global function with existing check

ncs.php

@@ -8,7 +8,6 @@
 declare(strict_types=1);
 
 return [
-	// constant NULL, FALSE in src/PhpGenerator/Type.php
-	'constant_case' => false,
+	// constants in src/PhpGenerator/Type.php
 	'lowercase_static_reference' => false,
 ];

readme.md

@@ -297,6 +297,7 @@ $function = new Nette\PhpGenerator\GlobalFunction('foo');
 $function->setBody('return $a + $b;');
 $function->addParameter('a');
 $function->addParameter('b');
+$function->wrapInExistingCheck();
 echo $function;
 
 // or use the PsrPrinter for output compliant with PSR-2 / PSR-12 / PER
@@ -306,9 +307,12 @@ echo $function;
 The result is:
 
 ```php
-function foo($a, $b)
+if (! function_exists('foo'))
 {
-	return $a + $b;
+    function foo($a, $b)
+    {
+        return $a + $b;
+    }
 }
 ```
 

src/PhpGenerator/Dumper.php

@@ -73,14 +73,14 @@ private function dumpString(string $s): string
 
 		$utf8 = preg_match('##u', $s);
 		$escaped = preg_replace_callback(
-			$utf8 ? '#[\p{C}\\\\]#u' : '#[\x00-\x1F\x7F-\xFF\\\\]#',
+			$utf8 ? '#[\p{C}\\\]#u' : '#[\x00-\x1F\x7F-\xFF\\\]#',
 			fn($m) => $special[$m[0]] ?? (strlen($m[0]) === 1
 					? '\x' . str_pad(strtoupper(dechex(ord($m[0]))), 2, '0', STR_PAD_LEFT)
 					: '\u{' . strtoupper(ltrim(dechex(self::utf8Ord($m[0])), '0')) . '}'),
 			$s,
 		);
 		return $s === str_replace('\\\\', '\\', $escaped)
-			? "'" . preg_replace('#\'|\\\\(?=[\'\\\\]|$)#D', '\\\\$0', $s) . "'"
+			? "'" . preg_replace('#\'|\\\(?=[\'\\\]|$)#D', '\\\$0', $s) . "'"
 			: '"' . addcslashes($escaped, '"$') . '"';
 	}
 

src/PhpGenerator/GlobalFunction.php

@@ -22,6 +22,8 @@ final class GlobalFunction
 	use Traits\CommentAware;
 	use Traits\AttributeAware;
 
+	private bool $wrapInExistingCheck = false;
+
 	public static function from(string|\Closure $function, bool $withBody = false): self
 	{
 		return (new Factory)->fromFunctionReflection(Nette\Utils\Callback::toReflection($function), $withBody);
@@ -38,4 +40,16 @@ public function __clone(): void
 	{
 		$this->parameters = array_map(fn($param) => clone $param, $this->parameters);
 	}
+
+
+	public function wrapInExistingCheck(bool $wrap = true): self
+	{
+		$this->wrapInExistingCheck = $wrap;
+		return $this;
+	}
+
+	public function getWrapInExistingCheck(): bool
+	{
+		return $this->wrapInExistingCheck;
+	}
 }

src/PhpGenerator/Helpers.php

@@ -75,7 +75,7 @@ public static function tagName(string $name, string $of = PhpNamespace::NameNorm
 
 	public static function simplifyTaggedNames(string $code, ?PhpNamespace $namespace): string
 	{
-		return preg_replace_callback('~/\*\(([ncf])\*/([\w\x7f-\xff\\\\]++)~', function ($m) use ($namespace) {
+		return preg_replace_callback('~/\*\(([ncf])\*/([\w\x7f-\xff\\\]++)~', function ($m) use ($namespace) {
 			[, $of, $name] = $m;
 			return $namespace
 				? $namespace->simplifyType($name, $of)
@@ -106,7 +106,7 @@ public static function isIdentifier(mixed $value): bool
 
 	public static function isNamespaceIdentifier(mixed $value, bool $allowLeadingSlash = false): bool
 	{
-		$re = '#^' . ($allowLeadingSlash ? '\\\\?' : '') . self::ReIdentifier . '(\\\\' . self::ReIdentifier . ')*$#D';
+		$re = '#^' . ($allowLeadingSlash ? '\\\?' : '') . self::ReIdentifier . '(\\\\' . self::ReIdentifier . ')*$#D';
 		return is_string($value) && preg_match($re, $value);
 	}
 

src/PhpGenerator/PhpNamespace.php

@@ -200,7 +200,7 @@ public function resolveName(string $name, string $of = self::NameNormal): string
 	 */
 	public function simplifyType(string $type, string $of = self::NameNormal): string
 	{
-		return preg_replace_callback('~[\w\x7f-\xff\\\\]+~', fn($m) => $this->simplifyName($m[0], $of), $type);
+		return preg_replace_callback('~[\w\x7f-\xff\\\]+~', fn($m) => $this->simplifyName($m[0], $of), $type);
 	}
 
 

src/PhpGenerator/Printer.php

@@ -49,13 +49,17 @@ public function printFunction(GlobalFunction $function, ?PhpNamespace $namespace
 		$body = $this->printFunctionBody($function);
 		$braceOnNextLine = $this->isBraceOnNextLine(str_contains($params, "\n"), (bool) $returnType);
 
-		return $this->printDocComment($function)
+		$functionPrint = $this->printDocComment($function)
 			. $this->printAttributes($function->getAttributes())
 			. $line
 			. $params
 			. $returnType
 			. ($braceOnNextLine ? "\n" : ' ')
 			. "{\n" . $this->indent($body) . "}\n";
+
+		$wrapper = "if (! function_exists('{$function->getName()}'))\n{\n{$this->indent($functionPrint)}}\n";
+
+		return $function->getWrapInExistingCheck() ? $wrapper : $functionPrint;
 	}
 
 

tests/PhpGenerator/Dumper.dump().phpt

@@ -34,8 +34,8 @@ Assert::same("'Hello'", $dumper->dump('Hello'));
 Assert::same('"\t\n\r\e"', $dumper->dump("\t\n\r\e"));
 Assert::same('"\u{FEFF}"', $dumper->dump("\xEF\xBB\xBF")); // BOM
 Assert::same('\'$"\\\\\'', $dumper->dump('$"\\'));
-Assert::same('\'$"\\ \x00\'', $dumper->dump('$"\\ \x00')); // no escape
-Assert::same('"\\$\\"\\\\ \x00"', $dumper->dump("$\"\\ \x00"));
+Assert::same('\'$"\ \x00\'', $dumper->dump('$"\ \x00')); // no escape
+Assert::same('"\$\"\\\ \x00"', $dumper->dump("$\"\\ \x00"));
 Assert::same(
 	"'I\u{F1}t\u{EB}rn\u{E2}ti\u{F4}n\u{E0}liz\u{E6}ti\u{F8}n'",
 	$dumper->dump("I\u{F1}t\u{EB}rn\u{E2}ti\u{F4}n\u{E0}liz\u{E6}ti\u{F8}n"), // Iñtërnâtiônàlizætiøn

tests/PhpGenerator/GlobalFunction.wrapped.phpt

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\GlobalFunction;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$function = new GlobalFunction('test');
+$function->setBody('return $a + $b;');
+$function->addAttribute('ExampleAttribute');
+$function->addComment('My Function');
+$function->wrapInExistingCheck();
+
+same(
+	<<<'XX'
+		if (! function_exists('test'))
+		{
+			/**
+			 * My Function
+			 */
+			#[ExampleAttribute]
+			function test()
+			{
+				return $a + $b;
+			}
+		}
+
+		XX,
+	(string) $function,
+);

tests/PhpGenerator/Helpers.isNamespaceIdentifier.phpt

@@ -13,9 +13,9 @@ Assert::true(Helpers::isNamespaceIdentifier("\x7F"));
 Assert::true(Helpers::isNamespaceIdentifier("\x7F\\\x7F"));
 Assert::false(Helpers::isNamespaceIdentifier('0Item'));
 Assert::true(Helpers::isNamespaceIdentifier('Item\Item'));
-Assert::false(Helpers::isNamespaceIdentifier('Item\\\\Item'));
-Assert::false(Helpers::isNamespaceIdentifier('\\Item'));
+Assert::false(Helpers::isNamespaceIdentifier('Item\\\Item'));
+Assert::false(Helpers::isNamespaceIdentifier('\Item'));
 Assert::false(Helpers::isNamespaceIdentifier('Item\\'));
 
-Assert::true(Helpers::isNamespaceIdentifier('\\Item', allowLeadingSlash: true));
+Assert::true(Helpers::isNamespaceIdentifier('\Item', allowLeadingSlash: true));
 Assert::false(Helpers::isNamespaceIdentifier('Item\\', allowLeadingSlash: true));

tests/PhpGenerator/PhpFile.phpt

@@ -74,7 +74,7 @@ $interfaceF
 $traitG = $file->addTrait('Baz\G');
 Assert::same($file->addNamespace('Baz'), $traitG->getNamespace());
 
-$file->addFunction('Baz\\f2')
+$file->addFunction('Baz\f2')
 	->setReturnType('Foo\B');
 
 
@@ -112,7 +112,7 @@ Assert::same([
 	'FooBar\I',
 ], array_keys($file->getClasses()));
 
-Assert::same(['Baz\\f2', 'f1'], array_keys($file->getFunctions()));
+Assert::same(['Baz\f2', 'f1'], array_keys($file->getFunctions()));