Add sapi_windows_console_size()

This function is supposed to retrieve the width and height of a console
window on Windows.  It expects a single stream argument, and if that is
a console, returns its width and height as two element array (aka.
pair).  On failure the function returns false.

Author: cmb69

ext/standard/basic_functions.stub.php

@@ -3569,6 +3569,9 @@ function stream_isatty($stream): bool {}
 #ifdef PHP_WIN32
 /** @param resource $stream */
 function sapi_windows_vt100_support($stream, ?bool $enable = null): bool {}
+
+/** @param resource $stream */
+function sapi_windows_console_size($stream): array|bool {}
 #endif
 
 /** @param resource $stream */

ext/standard/basic_functions_arginfo.h

@@ -1774,6 +1774,48 @@ PHP_FUNCTION(sapi_windows_vt100_support)
 		}
 	}
 }
+
+PHP_FUNCTION(sapi_windows_console_size)
+{
+	zval *zsrc;
+	php_stream *stream;
+	zend_long fileno;
+	int width, height;
+	zval ztmp;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+	Z_PARAM_RESOURCE(zsrc)
+	ZEND_PARSE_PARAMETERS_END();
+
+	php_stream_from_zval(stream, zsrc);
+
+	/* get the fd.
+	 * NB: Most other code will NOT use the PHP_STREAM_CAST_INTERNAL flag when casting.
+	 * It is only used here so that the buffered data warning is not displayed.
+	 */
+	if (php_stream_can_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
+		php_stream_cast(stream, PHP_STREAM_AS_FD_FOR_SELECT | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
+	} else if (php_stream_can_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL) == SUCCESS) {
+		php_stream_cast(stream, PHP_STREAM_AS_FD | PHP_STREAM_CAST_INTERNAL, (void*)&fileno, 0);
+	} else {
+		php_error_docref(NULL, E_WARNING, "not able to analyze the specified stream");
+		RETURN_FALSE;
+	}
+
+	if (!php_win32_console_fileno_is_console(fileno)) {
+		RETURN_FALSE;
+	}
+
+	if (!php_win32_console_size(fileno, &width, &height)) {
+		RETURN_FALSE;
+	}
+
+	array_init(return_value);
+	ZVAL_LONG(&ztmp, width);
+	zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &ztmp);
+	ZVAL_LONG(&ztmp, height);
+	zend_hash_next_index_insert(Z_ARRVAL_P(return_value), &ztmp);
+}
 #endif
 
 #ifdef HAVE_SHUTDOWN

ext/standard/streamsfuncs.c

@@ -114,3 +114,14 @@ PHP_WINUTIL_API BOOL php_win32_console_is_cli_sapi(void)
 	return strlen(sapi_module.name) >= sizeof("cli") - 1 && !strncmp(sapi_module.name, "cli", sizeof("cli") - 1);
 }/*}}}*/
 
+PHP_WINUTIL_API BOOL php_win32_console_size(zend_long fileno, int *width, int *height)
+{
+	HANDLE handle = (HANDLE) _get_osfhandle(fileno);
+	CONSOLE_SCREEN_BUFFER_INFO csbi;
+	if (!GetConsoleScreenBufferInfo(handle, &csbi)) {
+		return 0;
+	}
+	*width = csbi.srWindow.Right - csbi.srWindow.Left + 1;
+	*height = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
+	return 1;
+}

win32/console.c

@@ -60,4 +60,7 @@ PHP_WINUTIL_API BOOL php_win32_console_is_own(void);
 /* Check whether the current SAPI is run on console. */
 PHP_WINUTIL_API BOOL php_win32_console_is_cli_sapi(void);
 
+/* Gets the width and height of a console. */
+PHP_WINUTIL_API BOOL php_win32_console_size(zend_long fileno, int *width, int *height);
+
 #endif