Broken Function: Return type of stream_isatty is incorrect

[rvock]

Function URL

https://www.php.net/stream_isatty

PHP Version

8.3

Safe Version

2.5.0,dev-master

Description

The PHP function returns a boolean.
The Safe PHP function returns void:

safe/generated/8.4/stream.php

Lines 198 to 205 in 4fbc008

	function stream_isatty($stream): void
	{
	error_clear_last();
	$safeResult = \stream_isatty($stream);
	if ($safeResult === false) {
	throw StreamException::createFromPhpError();
	}
	}

This means, we cannot use the Safe PHP version

[shish]

The documentation says "Returns true on success or false on failure." - if that documentation is correct, then Safe is doing the right thing... but I feel like it's more likely that the documentation is wrong, and it actually "returns true if the resource is a TTY and false if not", in which case Safe isn't needed at all, because neither of those return values are "an error" (if that's the case, we should add it to our list of false-positive functions to be ignored)

If the actual implementation is "returns true if it's a TTY, returns false if it's not a TTY or if there is an error", then that's trickier...

[rvock]

Hm, I am not sure.
Looking at the PHP source code, I think, the function might return false, if the argument is not a stream:
https://github.com/php/php-src/blob/php-8.5.0/ext/standard/streamsfuncs.c#L1598-L1629

But I am not sure, when or how this can happen, because the method already expects a resource as parameter and triggers a TypeError, if no resource is passed.