php/archived-php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2026-03-24 00:02:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

gen_stub: move generateArgInfoCode() into FileInfo

Browse Source 
Reduce the number of global functions by moving it to instance method
`FileInfo::generateArgInfoCode()`.

In the process, make the following parts of `FileInfo` private:

- `$funcInfos`
- `$generateFunctionEntries`
- `$declarationPrefix`
- `$generateClassEntries`
- `$generateCEnums`
- `::getMinimumPhpVersionIdCompatibility()`
This commit is contained in:
Daniel Scherzer
2026-03-14 16:32:54 -07:00
parent 777fa5d158
commit f1dd3f2f30
1 changed files with 132 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

266
build/gen_stub.php
View File

@@ -144,9 +144,8 @@ function processStubFile(string $stubFile, Context $context, bool $includeOnly =
return $fileInfo;
}
[$arginfoCode, $declCode] = generateArgInfoCode(
[$arginfoCode, $declCode] = $fileInfo->generateArgInfoCode(
basename($stubFilenameWithoutExtension),
$fileInfo,
$context->allConstInfos,
$stubHash
);
@@ -162,9 +161,8 @@ function processStubFile(string $stubFile, Context $context, bool $includeOnly =
if ($fileInfo->shouldGenerateLegacyArginfo()) {
$legacyFileInfo = $fileInfo->getLegacyVersion();
[$arginfoCode] = generateArgInfoCode(
[$arginfoCode] = $legacyFileInfo->generateArgInfoCode(
basename($stubFilenameWithoutExtension),
$legacyFileInfo,
$context->allConstInfos,
$stubHash
);
@@ -4270,13 +4268,13 @@ class FileInfo {
/** @var ConstInfo[] */
public array $constInfos = [];
/** @var FuncInfo[] */
public array $funcInfos = [];
private array $funcInfos = [];
/** @var ClassInfo[] */
public array $classInfos = [];
public bool $generateFunctionEntries = false;
public string $declarationPrefix = "";
public bool $generateClassEntries = false;
public bool $generateCEnums = false;
private bool $generateFunctionEntries = false;
private string $declarationPrefix = "";
private bool $generateClassEntries = false;
private bool $generateCEnums = false;
private bool $isUndocumentable = false;
private bool $legacyArginfoGeneration = false;
private ?int $minimumPhpVersionIdCompatibility = null;
@@ -4355,7 +4353,7 @@ class FileInfo {
}
}
public function getMinimumPhpVersionIdCompatibility(): ?int {
private function getMinimumPhpVersionIdCompatibility(): ?int {
// Non-legacy arginfo files are always PHP 8.0+ compatible
if (!$this->legacyArginfoGeneration &&
$this->minimumPhpVersionIdCompatibility !== null &&
@@ -4619,6 +4617,130 @@ class FileInfo {
return $code;
}
/**
* @param array<string, ConstInfo> $allConstInfos
* @return array{string, string}
*/
public function generateArgInfoCode(
string $stubFilenameWithoutExtension,
array $allConstInfos,
string $stubHash
): array {
$code = "";
$generatedFuncInfos = [];
$argInfoCode = generateCodeWithConditions(
$this->getAllFuncInfos(), "\n",
function (FuncInfo $funcInfo) use (&$generatedFuncInfos) {
/* If there already is an equivalent arginfo structure, only emit a #define */
if ($generatedFuncInfo = $funcInfo->findEquivalent($generatedFuncInfos)) {
$code = sprintf(
"#define %s %s\n",
$funcInfo->getArgInfoName(), $generatedFuncInfo->getArgInfoName()
);
} else {
$code = $funcInfo->toArgInfoCode($this->getMinimumPhpVersionIdCompatibility());
}
$generatedFuncInfos[] = $funcInfo;
return $code;
}
);
if ($argInfoCode !== "") {
$code .= "$argInfoCode\n";
}
if ($this->generateFunctionEntries) {
$framelessFunctionCode = generateCodeWithConditions(
$this->getAllFuncInfos(), "\n",
static function (FuncInfo $funcInfo) {
return $funcInfo->getFramelessDeclaration();
}
);
if ($framelessFunctionCode !== "") {
$code .= "$framelessFunctionCode\n";
}
$generatedFunctionDeclarations = [];
$code .= generateCodeWithConditions(
$this->getAllFuncInfos(), "",
function (FuncInfo $funcInfo) use (&$generatedFunctionDeclarations) {
$key = $funcInfo->getDeclarationKey();
if (isset($generatedFunctionDeclarations[$key])) {
return null;
}
$generatedFunctionDeclarations[$key] = true;
return $this->declarationPrefix . $funcInfo->getDeclaration();
}
);
$code .= generateFunctionEntries(null, $this->funcInfos);
foreach ($this->classInfos as $classInfo) {
$code .= generateFunctionEntries($classInfo->name, $classInfo->funcInfos, $classInfo->cond);
}
}
$php80MinimumCompatibility = $this->getMinimumPhpVersionIdCompatibility() === null || $this->getMinimumPhpVersionIdCompatibility() >= PHP_80_VERSION_ID;
if ($this->generateClassEntries) {
$declaredStrings = [];
$attributeInitializationCode = generateFunctionAttributeInitialization($this->funcInfos, $allConstInfos, $this->getMinimumPhpVersionIdCompatibility(), null, $declaredStrings);
$attributeInitializationCode .= generateGlobalConstantAttributeInitialization($this->constInfos, $allConstInfos, $this->getMinimumPhpVersionIdCompatibility(), null, $declaredStrings);
if ($attributeInitializationCode) {
if (!$php80MinimumCompatibility) {
$attributeInitializationCode = "\n#if (PHP_VERSION_ID >= " . PHP_80_VERSION_ID . ")" . $attributeInitializationCode . "#endif\n";
}
}
if ($attributeInitializationCode !== "" || !empty($this->constInfos)) {
$code .= "\nstatic void register_{$stubFilenameWithoutExtension}_symbols(int module_number)\n";
$code .= "{\n";
$code .= generateCodeWithConditions(
$this->constInfos,
'',
static fn (ConstInfo $constInfo): string => $constInfo->getDeclaration($allConstInfos)
);
if ($attributeInitializationCode !== "" && $this->constInfos) {
$code .= "\n";
}
$code .= $attributeInitializationCode;
$code .= "}\n";
}
$code .= $this->generateClassEntryCode($allConstInfos);
}
$hasDeclFile = false;
$declCode = $this->generateCDeclarations();
if ($declCode !== '') {
$hasDeclFile = true;
$headerName = "ZEND_" . strtoupper($stubFilenameWithoutExtension) . "_DECL_{$stubHash}_H";
$declCode = "/* This is a generated file, edit {$stubFilenameWithoutExtension}.stub.php instead.\n"
. " * Stub hash: $stubHash */\n"
. "\n"
. "#ifndef {$headerName}\n"
. "#define {$headerName}\n"
. $declCode . "\n"
. "#endif /* {$headerName} */\n";
}
$code = "/* This is a generated file, edit {$stubFilenameWithoutExtension}.stub.php instead.\n"
. " * Stub hash: $stubHash"
. ($hasDeclFile ? "\n * Has decl header: yes */\n" : " */\n")
. $code;
return [$code, $declCode];
}
}
class DocCommentTag {
@@ -5248,130 +5370,6 @@ function generateCodeWithConditions(
return $code;
}
/**
* @param array<string, ConstInfo> $allConstInfos
* @return array{string, string}
*/
function generateArgInfoCode(
string $stubFilenameWithoutExtension,
FileInfo $fileInfo,
array $allConstInfos,
string $stubHash
): array {
$code = "";
$generatedFuncInfos = [];
$argInfoCode = generateCodeWithConditions(
$fileInfo->getAllFuncInfos(), "\n",
static function (FuncInfo $funcInfo) use (&$generatedFuncInfos, $fileInfo) {
/* If there already is an equivalent arginfo structure, only emit a #define */
if ($generatedFuncInfo = $funcInfo->findEquivalent($generatedFuncInfos)) {
$code = sprintf(
"#define %s %s\n",
$funcInfo->getArgInfoName(), $generatedFuncInfo->getArgInfoName()
);
} else {
$code = $funcInfo->toArgInfoCode($fileInfo->getMinimumPhpVersionIdCompatibility());
}
$generatedFuncInfos[] = $funcInfo;
return $code;
}
);
if ($argInfoCode !== "") {
$code .= "$argInfoCode\n";
}
if ($fileInfo->generateFunctionEntries) {
$framelessFunctionCode = generateCodeWithConditions(
$fileInfo->getAllFuncInfos(), "\n",
static function (FuncInfo $funcInfo) {
return $funcInfo->getFramelessDeclaration();
}
);
if ($framelessFunctionCode !== "") {
$code .= "$framelessFunctionCode\n";
}
$generatedFunctionDeclarations = [];
$code .= generateCodeWithConditions(
$fileInfo->getAllFuncInfos(), "",
static function (FuncInfo $funcInfo) use ($fileInfo, &$generatedFunctionDeclarations) {
$key = $funcInfo->getDeclarationKey();
if (isset($generatedFunctionDeclarations[$key])) {
return null;
}
$generatedFunctionDeclarations[$key] = true;
return $fileInfo->declarationPrefix . $funcInfo->getDeclaration();
}
);
$code .= generateFunctionEntries(null, $fileInfo->funcInfos);
foreach ($fileInfo->classInfos as $classInfo) {
$code .= generateFunctionEntries($classInfo->name, $classInfo->funcInfos, $classInfo->cond);
}
}
$php80MinimumCompatibility = $fileInfo->getMinimumPhpVersionIdCompatibility() === null || $fileInfo->getMinimumPhpVersionIdCompatibility() >= PHP_80_VERSION_ID;
if ($fileInfo->generateClassEntries) {
$declaredStrings = [];
$attributeInitializationCode = generateFunctionAttributeInitialization($fileInfo->funcInfos, $allConstInfos, $fileInfo->getMinimumPhpVersionIdCompatibility(), null, $declaredStrings);
$attributeInitializationCode .= generateGlobalConstantAttributeInitialization($fileInfo->constInfos, $allConstInfos, $fileInfo->getMinimumPhpVersionIdCompatibility(), null, $declaredStrings);
if ($attributeInitializationCode) {
if (!$php80MinimumCompatibility) {
$attributeInitializationCode = "\n#if (PHP_VERSION_ID >= " . PHP_80_VERSION_ID . ")" . $attributeInitializationCode . "#endif\n";
}
}
if ($attributeInitializationCode !== "" || !empty($fileInfo->constInfos)) {
$code .= "\nstatic void register_{$stubFilenameWithoutExtension}_symbols(int module_number)\n";
$code .= "{\n";
$code .= generateCodeWithConditions(
$fileInfo->constInfos,
'',
static fn (ConstInfo $constInfo): string => $constInfo->getDeclaration($allConstInfos)
);
if ($attributeInitializationCode !== "" && $fileInfo->constInfos) {
$code .= "\n";
}
$code .= $attributeInitializationCode;
$code .= "}\n";
}
$code .= $fileInfo->generateClassEntryCode($allConstInfos);
}
$hasDeclFile = false;
$declCode = $fileInfo->generateCDeclarations();
if ($declCode !== '') {
$hasDeclFile = true;
$headerName = "ZEND_" . strtoupper($stubFilenameWithoutExtension) . "_DECL_{$stubHash}_H";
$declCode = "/* This is a generated file, edit {$stubFilenameWithoutExtension}.stub.php instead.\n"
. " * Stub hash: $stubHash */\n"
. "\n"
. "#ifndef {$headerName}\n"
. "#define {$headerName}\n"
. $declCode . "\n"
. "#endif /* {$headerName} */\n";
}
$code = "/* This is a generated file, edit {$stubFilenameWithoutExtension}.stub.php instead.\n"
. " * Stub hash: $stubHash"
. ($hasDeclFile ? "\n * Has decl header: yes */\n" : " */\n")
. $code;
return [$code, $declCode];
}
/** @param FuncInfo[] $funcInfos */
function generateFunctionEntries(?Name $className, array $funcInfos, ?string $cond = null): string {
// No need to add anything if there are no function entries