stdlib_system: add get_console_width function

Author: zoziha

doc/specs/stdlib_system.md

@@ -532,3 +532,40 @@ The file is removed from the filesystem if the operation is successful. If the o
 ```fortran
 {!example/system/example_delete_file.f90!}
 ```
+
+## `get_console_width` - Get the width of the console
+
+### Status
+
+Experimental
+
+### Description
+
+This function returns the width of the console window in characters. 
+It is designed to work across multiple platforms. On Windows, the width is determined by the console window's size. 
+On UNIX-like systems (Linux, macOS), the width is determined by the terminal's size.
+
+Note: This routine performs a detailed runtime inspection, so it has non-negligible overhead.
+
+### Syntax
+
+`width = [[stdlib_system(module):get_console_width(function)]]()`
+
+### Class
+
+Function
+
+### Arguments
+
+None.
+
+### Return Value
+
+- **Type:** `integer`
+- Returns the width of the console window in characters.
+
+### Example
+
+```fortran
+{!./example/system/example_get_console_width.f90}!
+```

example/system/CMakeLists.txt

@@ -1,4 +1,5 @@
 ADD_EXAMPLE(get_runtime_os)
+ADD_EXAMPLE(get_console_width)
 ADD_EXAMPLE(delete_file)
 ADD_EXAMPLE(is_directory)
 ADD_EXAMPLE(null_device)

example/system/example_get_console_width.f90

@@ -0,0 +1,14 @@
+program example_get_console_width
+
+    use stdlib_system, only: get_console_width
+    implicit none
+
+    integer :: width
+
+    !> Get console width
+    width = get_console_width()
+
+    print "(a,i0)", "Console width is ", width
+    print "(a)", repeat("*", width)
+
+end program example_get_console_width

src/CMakeLists.txt

@@ -112,6 +112,7 @@ set(SRC
     stdlib_hashmap_open.f90
     stdlib_logger.f90
     stdlib_sorting_radix_sort.f90
+    stdlib_system_get_console_width.c
     stdlib_system_subprocess.c
     stdlib_system_subprocess.F90
     stdlib_system.F90

src/stdlib_system.F90

@@ -83,7 +83,9 @@ module stdlib_system
 public :: kill
 public :: elapsed
 public :: is_windows
-     
+
+public :: get_console_width
+
 !! version: experimental
 !!
 !! Tests if a given path matches an existing directory.
@@ -547,8 +549,17 @@ module function process_get_ID(process) result(ID)
         !> Return a process ID
         integer(process_ID) :: ID
     end function process_get_ID
-    
-end interface 
+
+    !! Returns the width of the console window.
+    !!
+    !! ### Returns:
+    !! - **integer**: The width of the console window.
+    !!
+    !! Note: This function performs a detailed runtime inspection, so it has non-negligible overhead.
+    integer function get_console_width() bind(C)
+    end function get_console_width
+
+end interface
 
 contains
 

src/stdlib_system_get_console_width.c

@@ -0,0 +1,28 @@
+#include <stdlib.h>
+
+#ifdef _WIN32
+#include <windows.h>
+#else
+#include <sys/ioctl.h>
+#include <unistd.h>
+#endif
+
+int get_console_width()
+{
+    int width = 80; // default value
+#ifdef _WIN32
+    CONSOLE_SCREEN_BUFFER_INFO csbi;
+    HANDLE hConsole = GetStdHandle(STD_OUTPUT_HANDLE);
+    if (GetConsoleScreenBufferInfo(hConsole, &csbi))
+    {
+        width = csbi.srWindow.Right - csbi.srWindow.Left + 1;
+    }
+#else
+    struct winsize w;
+    if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) == 0)
+    {
+        width = w.ws_col;
+    }
+#endif
+    return width;
+}

test/system/test_os.f90

@@ -1,7 +1,7 @@
 module test_os
     use testdrive, only : new_unittest, unittest_type, error_type, check, skip_test
-    use stdlib_system, only: get_runtime_os, OS_WINDOWS, OS_UNKNOWN, OS_TYPE, is_windows, null_device
-
+    use stdlib_system, only: get_runtime_os, OS_WINDOWS, OS_UNKNOWN, OS_TYPE, is_windows, null_device, &
+                             get_console_width
     implicit none
 
 contains
@@ -12,12 +12,24 @@ subroutine collect_suite(testsuite)
         type(unittest_type), allocatable, intent(out) :: testsuite(:)
 
         testsuite = [ &
+            new_unittest('test_get_console_width', test_get_console_width), &
             new_unittest('test_get_runtime_os', test_get_runtime_os), &
             new_unittest('test_is_windows', test_is_windows), &
             new_unittest('test_null_device', test_null_device) &
         ]
     end subroutine collect_suite
 
+    subroutine test_get_console_width(error)
+        type(error_type), allocatable, intent(out) :: error
+        integer :: width
+
+        !> Get console width
+        width = get_console_width()
+
+        call check(error, width > 0, "Console width is not positive")
+
+    end subroutine test_get_console_width
+
     subroutine test_get_runtime_os(error)
         type(error_type), allocatable, intent(out) :: error
         integer :: os