diff options
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/dev/check_parameters.php | 2 | ||||
| -rwxr-xr-x | scripts/dev/gen_stub.php | 478 | ||||
| -rwxr-xr-x | scripts/dev/genfiles | 2 | ||||
| -rwxr-xr-x | scripts/dev/search_underscores.php | 2 |
4 files changed, 478 insertions, 6 deletions
diff --git a/scripts/dev/check_parameters.php b/scripts/dev/check_parameters.php index 8c8d6dff40..47b0affacf 100755 --- a/scripts/dev/check_parameters.php +++ b/scripts/dev/check_parameters.php @@ -2,8 +2,6 @@ <?php /* +----------------------------------------------------------------------+ - | PHP Version 7 | - +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | diff --git a/scripts/dev/gen_stub.php b/scripts/dev/gen_stub.php new file mode 100755 index 0000000000..f03e4b82c2 --- /dev/null +++ b/scripts/dev/gen_stub.php @@ -0,0 +1,478 @@ +#!/usr/bin/env php +<?php declare(strict_types=1); + +use PhpParser\Node; +use PhpParser\Node\Expr; +use PhpParser\Node\Stmt; + +error_reporting(E_ALL); + +try { + initPhpParser(); +} catch (Exception $e) { + echo "{$e->getMessage()}\n"; + exit(1); +} + +if ($argc >= 2) { + // Generate single file. + processStubFile($argv[1]); +} else { + // Regenerate all stub files we can find. + $it = new RecursiveIteratorIterator( + new RecursiveDirectoryIterator('.'), + RecursiveIteratorIterator::LEAVES_ONLY + ); + foreach ($it as $file) { + $pathName = $file->getPathName(); + if (preg_match('/\.stub\.php$/', $pathName)) { + processStubFile($pathName); + } + } +} + +function processStubFile(string $stubFile) { + $arginfoFile = str_replace('.stub.php', '', $stubFile) . '_arginfo.h'; + + try { + $funcInfos = parseStubFile($stubFile); + $arginfoCode = generateArgInfoCode($funcInfos); + file_put_contents($arginfoFile, $arginfoCode); + } catch (Exception $e) { + echo "In $stubFile:\n{$e->getMessage()}\n"; + exit(1); + } +} + +class Type { + /** @var string */ + public $name; + /** @var bool */ + public $isBuiltin; + /** @var bool */ + public $isNullable; + + public function __construct(string $name, bool $isBuiltin, bool $isNullable = false) { + $this->name = $name; + $this->isBuiltin = $isBuiltin; + $this->isNullable = $isNullable; + } + + public static function fromNode(Node $node) { + if ($node instanceof Node\NullableType) { + $type = self::fromNode($node->type); + return new Type($type->name, $type->isBuiltin, true); + } + if ($node instanceof Node\Name) { + assert($node->isFullyQualified()); + return new Type($node->toString(), false); + } + if ($node instanceof Node\Identifier) { + return new Type($node->toString(), true); + } + throw new Exception("Unexpected node type"); + } + + public function toTypeCode() { + assert($this->isBuiltin); + switch (strtolower($this->name)) { + case "bool": + return "_IS_BOOL"; + case "int": + return "IS_LONG"; + case "float": + return "IS_DOUBLE"; + case "string": + return "IS_STRING"; + case "array": + return "IS_ARRAY"; + case "object": + return "IS_OBJECT"; + case "void": + return "IS_VOID"; + case "callable": + return "IS_CALLABLE"; + default: + throw new Exception("Not implemented: $this->name"); + } + } + + public static function equals(?Type $a, ?Type $b): bool { + if ($a === null || $b === null) { + return $a === $b; + } + + return $a->name === $b->name + && $a->isBuiltin === $b->isBuiltin + && $a->isNullable === $b->isNullable; + } +} + +class ArgInfo { + const SEND_BY_VAL = 0; + const SEND_BY_REF = 1; + const SEND_PREFER_REF = 2; + + /** @var string */ + public $name; + /** @var int */ + public $sendBy; + /** @var bool */ + public $isVariadic; + /** @var Type|null */ + public $type; + + public function __construct(string $name, int $sendBy, bool $isVariadic, ?Type $type) { + $this->name = $name; + $this->sendBy = $sendBy; + $this->isVariadic = $isVariadic; + $this->type = $type; + } + + public function equals(ArgInfo $other): bool { + return $this->name === $other->name + && $this->sendBy === $other->sendBy + && $this->isVariadic === $other->isVariadic + && Type::equals($this->type, $other->type); + } + + public function getSendByString(): string { + switch ($this->sendBy) { + case self::SEND_BY_VAL: + return "0"; + case self::SEND_BY_REF: + return "1"; + case self::SEND_PREFER_REF: + return "ZEND_SEND_PREFER_REF"; + } + throw new Exception("Invalid sendBy value"); + } +} + +class ReturnInfo { + /** @var bool */ + public $byRef; + /** @var Type|null */ + public $type; + + public function __construct(bool $byRef, ?Type $type) { + $this->byRef = $byRef; + $this->type = $type; + } + + public function equals(ReturnInfo $other): bool { + return $this->byRef === $other->byRef + && Type::equals($this->type, $other->type); + } +} + +class FuncInfo { + /** @var string */ + public $name; + /** @var ArgInfo[] */ + public $args; + /** @var ReturnInfo */ + public $return; + /** @var int */ + public $numRequiredArgs; + /** @var string|null */ + public $cond; + + public function __construct( + string $name, array $args, ReturnInfo $return, int $numRequiredArgs, ?string $cond + ) { + $this->name = $name; + $this->args = $args; + $this->return = $return; + $this->numRequiredArgs = $numRequiredArgs; + $this->cond = $cond; + } + + public function equalsApartFromName(FuncInfo $other): bool { + if (count($this->args) !== count($other->args)) { + return false; + } + + for ($i = 0; $i < count($this->args); $i++) { + if (!$this->args[$i]->equals($other->args[$i])) { + return false; + } + } + + return $this->return->equals($other->return) + && $this->numRequiredArgs === $other->numRequiredArgs + && $this->cond === $other->cond; + } +} + +function parseFunctionLike(string $name, Node\FunctionLike $func, ?string $cond): FuncInfo { + $comment = $func->getDocComment(); + $paramMeta = []; + + if ($comment) { + $commentText = substr($comment->getText(), 2, -2); + + foreach (explode("\n", $commentText) as $commentLine) { + if (preg_match('/^\*\s*@prefer-ref\s+\$(.+)$/', trim($commentLine), $matches)) { + $varName = $matches[1]; + if (!isset($paramMeta[$varName])) { + $paramMeta[$varName] = []; + } + $paramMeta[$varName]['preferRef'] = true; + } + } + } + + $args = []; + $numRequiredArgs = 0; + $foundVariadic = false; + foreach ($func->getParams() as $i => $param) { + $varName = $param->var->name; + $preferRef = !empty($paramMeta[$varName]['preferRef']); + unset($paramMeta[$varName]); + + if ($preferRef) { + $sendBy = ArgInfo::SEND_PREFER_REF; + } else if ($param->byRef) { + $sendBy = ArgInfo::SEND_BY_REF; + } else { + $sendBy = ArgInfo::SEND_BY_VAL; + } + + if ($foundVariadic) { + throw new Exception("Error in function $name: only the last parameter can be variadic"); + } + + if ($param->default instanceof Expr\ConstFetch && + $param->default->name->toLowerString() === "null" && + $param->type && !($param->type instanceof Node\NullableType) + ) { + throw new Exception( + "Parameter $varName of function $name has null default, but is not nullable"); + } + + $foundVariadic = $param->variadic; + + $args[] = new ArgInfo( + $varName, + $sendBy, + $param->variadic, + $param->type ? Type::fromNode($param->type) : null + ); + if (!$param->default && !$param->variadic) { + $numRequiredArgs = $i + 1; + } + } + + foreach (array_keys($paramMeta) as $var) { + throw new Exception("Found metadata for invalid param $var of function $name"); + } + + $returnType = $func->getReturnType(); + $return = new ReturnInfo( + $func->returnsByRef(), + $returnType ? Type::fromNode($returnType) : null); + return new FuncInfo($name, $args, $return, $numRequiredArgs, $cond); +} + +function handlePreprocessorConditions(array &$conds, Stmt $stmt): ?string { + foreach ($stmt->getComments() as $comment) { + $text = trim($comment->getText()); + if (preg_match('/^#\s*if\s+(.+)$/', $text, $matches)) { + $conds[] = $matches[1]; + } else if (preg_match('/^#\s*ifdef\s+(.+)$/', $text, $matches)) { + $conds[] = "defined($matches[1])"; + } else if (preg_match('/^#\s*ifndef\s+(.+)$/', $text, $matches)) { + $conds[] = "!defined($matches[1])"; + } else if (preg_match('/^#\s*else$/', $text)) { + if (empty($conds)) { + throw new Exception("Encountered else without corresponding #if"); + } + $cond = array_pop($conds); + $conds[] = "!($cond)"; + } else if (preg_match('/^#\s*endif$/', $text)) { + if (empty($conds)) { + throw new Exception("Encountered #endif without corresponding #if"); + } + array_pop($conds); + } else if ($text[0] === '#') { + throw new Exception("Unrecognized preprocessor directive \"$text\""); + } + } + + return empty($conds) ? null : implode(' && ', $conds); +} + +/** @return FuncInfo[] */ +function parseStubFile(string $fileName) { + if (!file_exists($fileName)) { + throw new Exception("File $fileName does not exist"); + } + + $code = file_get_contents($fileName); + + $lexer = new PhpParser\Lexer(); + $parser = new PhpParser\Parser\Php7($lexer); + $nodeTraverser = new PhpParser\NodeTraverser; + $nodeTraverser->addVisitor(new PhpParser\NodeVisitor\NameResolver); + + $stmts = $parser->parse($code); + $nodeTraverser->traverse($stmts); + + $funcInfos = []; + $conds = []; + foreach ($stmts as $stmt) { + $cond = handlePreprocessorConditions($conds, $stmt); + if ($stmt instanceof Stmt\Nop) { + continue; + } + + if ($stmt instanceof Stmt\Function_) { + $funcInfos[] = parseFunctionLike($stmt->name->toString(), $stmt, $cond); + continue; + } + + if ($stmt instanceof Stmt\ClassLike) { + $className = $stmt->name->toString(); + foreach ($stmt->stmts as $classStmt) { + $cond = handlePreprocessorConditions($conds, $classStmt); + if ($classStmt instanceof Stmt\Nop) { + continue; + } + + if (!$classStmt instanceof Stmt\ClassMethod) { + throw new Exception("Not implemented {$classStmt->getType()}"); + } + + $funcInfos[] = parseFunctionLike( + 'class_' . $className . '_' . $classStmt->name->toString(), $classStmt, $cond); + } + continue; + } + + throw new Exception("Unexpected node {$stmt->getType()}"); + } + + return $funcInfos; +} + +function funcInfoToCode(FuncInfo $funcInfo): string { + $code = ''; + if ($funcInfo->return->type) { + $returnType = $funcInfo->return->type; + if ($returnType->isBuiltin) { + $code .= sprintf( + "ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_%s, %d, %d, %s, %d)\n", + $funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs, + $returnType->toTypeCode(), $returnType->isNullable + ); + } else { + $code .= sprintf( + "ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_%s, %d, %d, %s, %d)\n", + $funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs, + str_replace('\\', '\\\\', $returnType->name), $returnType->isNullable + ); + } + } else { + $code .= sprintf( + "ZEND_BEGIN_ARG_INFO_EX(arginfo_%s, 0, %d, %d)\n", + $funcInfo->name, $funcInfo->return->byRef, $funcInfo->numRequiredArgs + ); + } + + foreach ($funcInfo->args as $argInfo) { + $argKind = $argInfo->isVariadic ? "ARG_VARIADIC" : "ARG"; + if ($argInfo->type) { + if ($argInfo->type->isBuiltin) { + $code .= sprintf( + "\tZEND_%s_TYPE_INFO(%s, %s, %s, %d)\n", + $argKind, $argInfo->getSendByString(), $argInfo->name, + $argInfo->type->toTypeCode(), $argInfo->type->isNullable + ); + } else { + $code .= sprintf( + "\tZEND_%s_OBJ_INFO(%s, %s, %s, %d)\n", + $argKind, $argInfo->getSendByString(), $argInfo->name, + str_replace('\\', '\\\\', $argInfo->type->name), $argInfo->type->isNullable + ); + } + } else { + $code .= sprintf( + "\tZEND_%s_INFO(%s, %s)\n", $argKind, $argInfo->getSendByString(), $argInfo->name); + } + } + + $code .= "ZEND_END_ARG_INFO()"; + return $code; +} + +function findEquivalentFuncInfo(array $generatedFuncInfos, $funcInfo): ?FuncInfo { + foreach ($generatedFuncInfos as $generatedFuncInfo) { + if ($generatedFuncInfo->equalsApartFromName($funcInfo)) { + return $generatedFuncInfo; + } + } + return null; +} + +/** @param FuncInfo[] $funcInfos */ +function generateArginfoCode(array $funcInfos): string { + $code = "/* This is a generated file, edit the .stub.php file instead. */"; + $generatedFuncInfos = []; + foreach ($funcInfos as $funcInfo) { + $code .= "\n\n"; + if ($funcInfo->cond) { + $code .= "#if {$funcInfo->cond}\n"; + } + + /* If there already is an equivalent arginfo structure, only emit a #define */ + if ($generatedFuncInfo = findEquivalentFuncInfo($generatedFuncInfos, $funcInfo)) { + $code .= sprintf( + "#define arginfo_%s arginfo_%s", + $funcInfo->name, $generatedFuncInfo->name + ); + } else { + $code .= funcInfoToCode($funcInfo); + } + + if ($funcInfo->cond) { + $code .= "\n#endif"; + } + + $generatedFuncInfos[] = $funcInfo; + } + return $code . "\n"; +} + +function initPhpParser() { + $version = "4.2.2"; + $phpParserDir = __DIR__ . "/PHP-Parser-$version"; + if (!is_dir($phpParserDir)) { + $cwd = getcwd(); + chdir(__DIR__); + + passthru("wget https://github.com/nikic/PHP-Parser/archive/v$version.tar.gz", $exit); + if ($exit !== 0) { + passthru("curl -LO https://github.com/nikic/PHP-Parser/archive/v$version.tar.gz", $exit); + } + if ($exit !== 0) { + throw new Exception("Failed to download PHP-Parser tarball"); + } + if (!mkdir($phpParserDir)) { + throw new Exception("Failed to create directory $phpParserDir"); + } + passthru("tar xvzf v$version.tar.gz -C PHP-Parser-$version --strip-components 1", $exit); + if ($exit !== 0) { + throw new Exception("Failed to extract PHP-Parser tarball"); + } + unlink(__DIR__ . "/v$version.tar.gz"); + chdir($cwd); + } + + spl_autoload_register(function(string $class) use($phpParserDir) { + if (strpos($class, "PhpParser\\") === 0) { + $fileName = $phpParserDir . "/lib/" . str_replace("\\", "/", $class) . ".php"; + require $fileName; + } + }); +} diff --git a/scripts/dev/genfiles b/scripts/dev/genfiles index d29c0d778a..ffdfcdc3ca 100755 --- a/scripts/dev/genfiles +++ b/scripts/dev/genfiles @@ -1,8 +1,6 @@ #!/bin/sh # # +----------------------------------------------------------------------+ -# | PHP Version 7 | -# +----------------------------------------------------------------------+ # | Copyright (c) The PHP Group | # +----------------------------------------------------------------------+ # | This source file is subject to version 3.01 of the PHP license, | diff --git a/scripts/dev/search_underscores.php b/scripts/dev/search_underscores.php index 5c2016e489..fd2a54c183 100755 --- a/scripts/dev/search_underscores.php +++ b/scripts/dev/search_underscores.php @@ -3,8 +3,6 @@ /* +----------------------------------------------------------------------+ - | PHP Version 7 | - +----------------------------------------------------------------------+ | Copyright (c) The PHP Group | +----------------------------------------------------------------------+ | This source file is subject to version 3.01 of the PHP license, | |