Skip to content

Update console.c - Refactor code for improved readability, safety, and maintainability #18737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 81 additions & 88 deletions win32/console.c
Original file line number Diff line number Diff line change
Expand Up @@ -12,105 +12,98 @@
+----------------------------------------------------------------------+
| Author: Michele Locati <mlocati@gmail.com> |
+----------------------------------------------------------------------+
*/
*/

#include "php.h"
#include "SAPI.h"
#include "win32/console.h"


PHP_WINUTIL_API BOOL php_win32_console_fileno_is_console(zend_long fileno)
{/*{{{*/
BOOL result = FALSE;
HANDLE handle = (HANDLE) _get_osfhandle(fileno);

if (handle != INVALID_HANDLE_VALUE) {
DWORD mode;
if (GetConsoleMode(handle, &mode)) {
result = TRUE;
}
}
return result;
}/*}}}*/
{
HANDLE handle = (HANDLE)_get_osfhandle(fileno);

if (handle == INVALID_HANDLE_VALUE) {
return FALSE;
}

DWORD mode;
return GetConsoleMode(handle, &mode);
}

PHP_WINUTIL_API BOOL php_win32_console_fileno_has_vt100(zend_long fileno)
{/*{{{*/
BOOL result = FALSE;
HANDLE handle = (HANDLE) _get_osfhandle(fileno);

if (handle != INVALID_HANDLE_VALUE) {
DWORD events;

if (fileno != 0 && !GetNumberOfConsoleInputEvents(handle, &events)) {
// Not STDIN
DWORD mode;

if (GetConsoleMode(handle, &mode)) {
if (mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING) {
result = TRUE;
}
}
}
}
return result;
}/*}}}*/
{
HANDLE handle = (HANDLE)_get_osfhandle(fileno);

if (handle == INVALID_HANDLE_VALUE) {
return FALSE;
}

// Skip STDIN check for non-input handles
if (fileno != 0) {
DWORD mode;
if (GetConsoleMode(handle, &mode)) {
return (mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING) != 0;
}
}

return FALSE;
}

PHP_WINUTIL_API BOOL php_win32_console_fileno_set_vt100(zend_long fileno, BOOL enable)
{/*{{{*/
BOOL result = FALSE;
HANDLE handle = (HANDLE) _get_osfhandle(fileno);

if (handle != INVALID_HANDLE_VALUE) {
DWORD events;

if (fileno != 0 && !GetNumberOfConsoleInputEvents(handle, &events)) {
// Not STDIN
DWORD mode;

if (GetConsoleMode(handle, &mode)) {
DWORD newMode;

if (enable) {
newMode = mode | ENABLE_VIRTUAL_TERMINAL_PROCESSING;
}
else {
newMode = mode & ~ENABLE_VIRTUAL_TERMINAL_PROCESSING;
}
if (newMode == mode) {
result = TRUE;
}
else {
if (SetConsoleMode(handle, newMode)) {
result = TRUE;
}
}
}
}
}
return result;
}/*}}}*/
{
HANDLE handle = (HANDLE)_get_osfhandle(fileno);

if (handle == INVALID_HANDLE_VALUE) {
return FALSE;
}

// Skip STDIN check for non-input handles
if (fileno != 0) {
DWORD mode;
if (!GetConsoleMode(handle, &mode)) {
return FALSE;
}

const DWORD newMode = enable
? (mode | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
: (mode & ~ENABLE_VIRTUAL_TERMINAL_PROCESSING);

if (newMode == mode) {
return TRUE;
}

return SetConsoleMode(handle, newMode);
}

return FALSE;
}

PHP_WINUTIL_API BOOL php_win32_console_is_own(void)
{/*{{{*/
if (!IsDebuggerPresent()) {
CONSOLE_SCREEN_BUFFER_INFO csbi;
DWORD pl[1];
BOOL ret0 = FALSE, ret1 = FALSE;

if (GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi)) {
ret0 = !csbi.dwCursorPosition.X && !csbi.dwCursorPosition.Y;
}

ret1 = GetConsoleProcessList(pl, 1) == 1;

return ret0 && ret1;
}

return FALSE;
}/*}}}*/
{
if (IsDebuggerPresent()) {
return FALSE;
}

CONSOLE_SCREEN_BUFFER_INFO csbi;
const HANDLE stdoutHandle = GetStdHandle(STD_OUTPUT_HANDLE);

// Check cursor position
BOOL atOrigin = FALSE;
if (GetConsoleScreenBufferInfo(stdoutHandle, &csbi)) {
atOrigin = (csbi.dwCursorPosition.X == 0 && csbi.dwCursorPosition.Y == 0);
}

// Check process count
DWORD processList[1];
const DWORD processCount = GetConsoleProcessList(processList, 1);

return atOrigin && (processCount == 1);
}

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);
}/*}}}*/

{
static const char CLI_SAPI_NAME[] = "cli";
static const size_t CLI_SAPI_NAME_LEN = sizeof(CLI_SAPI_NAME) - 1;

return strncasecmp(sapi_module.name, CLI_SAPI_NAME, CLI_SAPI_NAME_LEN) == 0;
}