feat(stdlib_system): rename get_console_width to get_terminal_size and update its functionality

Author: zoziha

doc/specs/stdlib_system.md

@@ -533,39 +533,36 @@ The file is removed from the filesystem if the operation is successful. If the o
 {!example/system/example_delete_file.f90!}
 ```
 
-## `get_console_width` - Get the width of the console
+## `get_terminal_size` - Get the size of the terminal window
 
 ### 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.
+This subroutine returns the size of the terminal window in characters. 
 
 Note: This routine performs a detailed runtime inspection, so it has non-negligible overhead.
 
 ### Syntax
 
-`width = [[stdlib_system(module):get_console_width(function)]]()`
+`call [[stdlib_system(module):get_terminal_size(subroutine)]](columns, lines)`
 
 ### Class
 
-Function
+Subroutine
 
 ### Arguments
 
-None.
+`columns`: Shall be an `intent(out)` argument of type `integer` that will contain the number of columns in the terminal window.
 
-### Return Value
+`lines`: Shall be an `intent(out)` argument of type `integer` that will contain the number of lines in the terminal window.
 
-- **Type:** `integer`
-- Returns the width of the console window in characters.
+Note: If the query fails, the values of `columns` and `lines` will be set to `-1`.
 
 ### Example
 
 ```fortran
-{!./example/system/example_get_console_width.f90}!
+{!./example/system/example_get_terminal_size.f90}!
 ```

example/system/CMakeLists.txt

@@ -1,5 +1,5 @@
 ADD_EXAMPLE(get_runtime_os)
-ADD_EXAMPLE(get_console_width)
+ADD_EXAMPLE(get_terminal_size)
 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_terminal_size
+
+    use stdlib_system, only: get_terminal_size
+    implicit none
+
+    integer :: columns, lines
+
+    !> Get terminal size
+    call get_terminal_size(columns, lines)
+
+    print "(2(a,i0))", "Terminal size is ", columns, 'x', lines
+    print "(a)", repeat("*", columns)
+
+end program example_get_terminal_size

example/system/example_get_terminal_size.f90

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

src/CMakeLists.txt

@@ -84,7 +84,7 @@ module stdlib_system
 public :: elapsed
 public :: is_windows
 
-public :: get_console_width
+public :: get_terminal_size
 
 !! version: experimental
 !!
@@ -550,14 +550,16 @@ module function process_get_ID(process) result(ID)
         integer(process_ID) :: ID
     end function process_get_ID
 
-    !! Returns the width of the console window.
+    !! Returns the size of the terminal window.
     !!
     !! ### Returns:
-    !! - **integer**: The width of the console window.
+    !! - **columns**: The number of columns in the terminal window.
+    !! - **lines**: The number of lines in the terminal 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
+    subroutine get_terminal_size(columns, lines) bind(C)
+        integer, intent(out) :: columns, lines
+    end subroutine get_terminal_size
 
 end interface
 

src/stdlib_system.F90

@@ -7,22 +7,25 @@
 #include <unistd.h>
 #endif
 
-int get_console_width()
+void get_terminal_size(int *columns, int *lines)
 {
-    int width = 80; // default value
+    *columns = -1;
+    *lines = -1;
+
 #ifdef _WIN32
-    CONSOLE_SCREEN_BUFFER_INFO csbi;
     HANDLE hConsole = GetStdHandle(STD_OUTPUT_HANDLE);
+    CONSOLE_SCREEN_BUFFER_INFO csbi;
     if (GetConsoleScreenBufferInfo(hConsole, &csbi))
     {
-        width = csbi.srWindow.Right - csbi.srWindow.Left + 1;
+        *columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
+        *lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
     }
 #else
     struct winsize w;
     if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) == 0)
     {
-        width = w.ws_col;
+        *columns = w.ws_col;
+        *lines = w.ws_row;
     }
 #endif
-    return width;
-}
+}

src/stdlib_system_get_console_width.c renamed to src/stdlib_system_get_terminal_size.c

@@ -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, &
-                             get_console_width
+                             get_terminal_size
     implicit none
 
 contains
@@ -12,23 +12,26 @@ 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_terminal_size', test_get_terminal_size), &
             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)
+    subroutine test_get_terminal_size(error)
         type(error_type), allocatable, intent(out) :: error
-        integer :: width
+        integer :: columns, lines
 
-        !> Get console width
-        width = get_console_width()
+        !> Get terminal size
+        call get_terminal_size(columns, lines)
 
-        call check(error, width > 0, "Console width is not positive")
+        call check(error, columns > 0, "Terminal width is not positive")
+        if (allocated(error)) return
+
+        call check(error, lines > 0, "Terminal height is not positive")
 
-    end subroutine test_get_console_width
+    end subroutine test_get_terminal_size
 
     subroutine test_get_runtime_os(error)
         type(error_type), allocatable, intent(out) :: error