Merge branch 'master' into cwd

Author: wassup05

.github/collab.sh

@@ -543,12 +543,12 @@ Experimental
 
 ### Description
 
-It creates an empty directory.
+It creates an empty directory with default permissions.
 It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
 
 ### Syntax
 
-`call [[stdlib_system(module):make_directory(subroutine)]] (path, mode, err)`
+`call [[stdlib_system(module):make_directory(subroutine)]] (path [,err])`
 
 ### Class
 
@@ -558,13 +558,11 @@ Subroutine
 
 `path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`mode`: Shall be a scalar integer indicating the permission bits required (Not applicable to Windows). It is an `optional, intent(in)` argument.
-
-`err`: Shall be of type `state_type`, for error handling. It is an `optional, intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 
-The `err` is set accordingly.
+`err` is an optional state return flag. If not requested and an error occurs, an `FS_ERROR` will trigger an error stop.
 
 ### Example
 
@@ -574,20 +572,20 @@ The `err` is set accordingly.
 
 ---
 
-## `remove_directory` - Removes an empty directory
+## `make_directory_all` - Creates an empty directory with all its parent directories
 
 ### Status
 
 Experimental
 
 ### Description
 
-It deletes an empty directory.
-It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
+It creates an empty directory with default permissions.
+It also creates all the necessary parent directories in the path if they do not exist already.
 
 ### Syntax
 
-`call [[stdlib_system(module):remove_directory(subroutine)]] (path, err)`
+`call [[stdlib_system(module):make_directory_all(subroutine)]] (path [,err])`
 
 ### Class
 
@@ -597,79 +595,79 @@ Subroutine
 
 `path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 
-The `err` is set accordingly.
+`err` is an optional state return flag. If not requested and an error occurs, an `FS_ERROR` will trigger an error stop.
 
 ### Example
 
 ```fortran
-{!example/system/example_remove_directory.f90!}
+{!example/system/example_make_directory.f90!}
 ```
 
 ---
 
-## `get_cwd` - Gets the current working directory
+## `remove_directory` - Removes an empty directory
 
 ### Status
 
 Experimental
 
 ### Description
 
-It gets the current working directory associated with the process calling this subroutine.
+It deletes an empty directory.
 It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
 
 ### Syntax
 
-`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd, err)`
+`call [[stdlib_system(module):remove_directory(subroutine)]] (path, err)`
 
 ### Class
 
 Subroutine
 
 ### Arguments
 
-`cwd`: Shall be a character string containing the path of the current working directory (cwd). It is an `intent(out)` argument.
+`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 
-The `err` is set accordingly.
+`err` is an optional state return flag. On error if not requested, an `FS_ERROR` will trigger an error stop.
 
 ### Example
 
 ```fortran
-{!example/system/example_cwd.f90!}
+{!example/system/example_remove_directory.f90!}
 ```
 
 ---
 
-## `set_cwd` - Sets the current working directory
+## `get_cwd` - Gets the current working directory
 
 ### Status
 
 Experimental
 
 ### Description
 
-It sets the current working directory associated with the process calling this subroutine.
+It gets the current working directory associated with the process calling this subroutine.
 It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
 
 ### Syntax
 
-`call [[stdlib_system(module):set_cwd(subroutine)]] (path, err)`
+`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd, err)`
 
 ### Class
 
 Subroutine
 
 ### Arguments
 
-`path`: Shall be a character string containing the path of the directory. It is an `intent(in)` argument.
+`cwd`: Shall be a character string containing the path of the current working directory (cwd). It is an `intent(out)` argument.
 
 `err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
 
@@ -685,42 +683,43 @@ The `err` is set accordingly.
 
 ---
 
-## `null_device` - Return the null device file path
+## `set_cwd` - Sets the current working directory
 
 ### Status
 
 Experimental
 
 ### Description
 
-This function returns the file path of the null device, which is a special file used to discard any data written to it. 
-It reads as an empty file. The null device's path varies by operating system:
-- On Windows, the null device is represented as `NUL`.
-- On UNIX-like systems (Linux, macOS), the null device is represented as `/dev/null`.
+It sets the current working directory associated with the process calling this subroutine.
+It is designed to work across multiple platforms. On Windows, paths with both forward `/` and backward `\` slashes are accepted.
 
 ### Syntax
 
-`path = ` [[stdlib_system(module):null_device(function)]]`()`
+`call [[stdlib_system(module):set_cwd(subroutine)]] (path, err)`
 
 ### Class
 
-Function
+Subroutine
 
 ### Arguments
 
-None.
+`path`: Shall be a character string containing the path of the directory. It is an `intent(in)` argument.
 
-### Return Value
+`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
 
-- **Type:** `character(:), allocatable`
-- Returns the null device file path as a character string, appropriate for the operating system.
+### Return values
+
+The `err` is set accordingly.
 
 ### Example
 
 ```fortran
-{!example/system/example_null_device.f90!}
+{!example/system/example_cwd.f90!}
 ```
 
+---
+
 ## `delete_file` - Delete a file
 
 ### Status

doc/specs/stdlib_ascii.md

@@ -18,4 +18,6 @@ ADD_EXAMPLE(fs_error)
 ADD_EXAMPLE(path_join)
 ADD_EXAMPLE(path_split_path)
 ADD_EXAMPLE(path_base_name)
-ADD_EXAMPLE(path_dir_name)
+ADD_EXAMPLE(path_dir_name)
+ADD_EXAMPLE(make_directory)
+ADD_EXAMPLE(remove_directory)

doc/specs/stdlib_system.md

@@ -1,17 +1,25 @@
-! Illustrate the usage of make_directory
+! Illustrate the usage of `make_directory`, `make_directory_all`
 program example_make_directory
-    use stdlib_system, only: make_directory, is_directory
+    use stdlib_system, only: make_directory, make_directory_all
     use stdlib_error, only: state_type
     implicit none
 
     type(state_type) :: err
 
-    call make_directory("test", err=err)
+    call make_directory("temp_dir", err)
 
     if (err%error()) then
         print *, err%print()
     else
         print *, "directory created sucessfully"
     end if
 
+    call make_directory_all("d1/d2/d3/d4", err)
+
+    if (err%error()) then
+        print *, err%print()
+    else
+        print *, "nested directories created sucessfully"
+    end if
+
 end program example_make_directory

example/system/CMakeLists.txt

@@ -1,6 +1,6 @@
-! Illustrate the usage of remove_directory
+! Illustrate the usage of `remove_directory`
 program example_remove_directory
-    use stdlib_system, only: make_directory, is_directory, remove_directory
+    use stdlib_system, only: remove_directory
     use stdlib_error, only: state_type
     implicit none
 

example/system/example_make_directory.f90

@@ -56,7 +56,7 @@ set(fppFiles
     stdlib_specialfunctions_gamma.fypp
     stdlib_specialfunctions.fypp
     stdlib_specialmatrices.fypp
-    stdlib_specialmatrices_tridiagonal.fypp    
+    stdlib_specialmatrices_tridiagonal.fypp
     stdlib_stats.fypp
     stdlib_stats_corr.fypp
     stdlib_stats_cov.fypp
@@ -119,6 +119,7 @@ set(SRC
     stdlib_system_subprocess.F90
     stdlib_system.c
     stdlib_system_path.f90
+    stdlib_system.c
     stdlib_system.F90
     stdlib_sparse.f90
     stdlib_specialfunctions_legendre.f90

example/system/example_remove_directory.f90

@@ -107,47 +107,47 @@ module stdlib_ascii
 contains
 
     !> Checks whether `c` is an ASCII letter (A .. Z, a .. z).
-    pure logical function is_alpha(c)
+    elemental logical function is_alpha(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_alpha = (c >= 'A' .and. c <= 'Z') .or. (c >= 'a' .and. c <= 'z')
     end function
 
     !> Checks whether `c` is a letter or a number (0 .. 9, a .. z, A .. Z).
-    pure logical function is_alphanum(c)
+    elemental logical function is_alphanum(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_alphanum = (c >= '0' .and. c <= '9') .or. (c >= 'a' .and. c <= 'z') &
             .or. (c >= 'A' .and. c <= 'Z')
     end function
 
     !> Checks whether or not `c` is in the ASCII character set -
     !> i.e. in the range 0 .. 0x7F.
-    pure logical function is_ascii(c)
+    elemental logical function is_ascii(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_ascii = iachar(c) <= int(z'7F')
     end function
 
     !> Checks whether `c` is a control character.
-    pure logical function is_control(c)
+    elemental logical function is_control(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)
         is_control = ic < int(z'20') .or. ic == int(z'7F')
     end function
 
     !> Checks whether `c` is a digit (0 .. 9).
-    pure logical function is_digit(c)
+    elemental logical function is_digit(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_digit = ('0' <= c) .and. (c <= '9')
     end function
 
     !> Checks whether `c` is a digit in base 8 (0 .. 7).
-    pure logical function is_octal_digit(c)
+    elemental logical function is_octal_digit(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_octal_digit = (c >= '0') .and. (c <= '7');
     end function
 
     !> Checks whether `c` is a digit in base 16 (0 .. 9, A .. F, a .. f).
-    pure logical function is_hex_digit(c)
+    elemental logical function is_hex_digit(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_hex_digit = (c >= '0' .and. c <= '9') .or. (c >= 'a' .and. c <= 'f') &
             .or. (c >= 'A' .and. c <= 'F')
@@ -156,7 +156,7 @@ contains
     !> Checks whether or not `c` is a punctuation character. That includes
     !> all ASCII characters which are not control characters, letters,
     !> digits, or whitespace.
-    pure logical function is_punctuation(c)
+    elemental logical function is_punctuation(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c) !       '~'                 '!'
@@ -166,7 +166,7 @@ contains
 
     !> Checks whether or not `c` is a printable character other than the
     !> space character.
-    pure logical function is_graphical(c)
+    elemental logical function is_graphical(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)
@@ -177,7 +177,7 @@ contains
 
     !> Checks whether or not `c` is a printable character - including the
     !> space character.
-    pure logical function is_printable(c)
+    elemental logical function is_printable(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)
@@ -186,23 +186,23 @@ contains
     end function
 
     !> Checks whether `c` is a lowercase ASCII letter (a .. z).
-    pure logical function is_lower(c)
+    elemental logical function is_lower(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)
         is_lower = ic >= iachar('a') .and. ic <= iachar('z')
     end function
 
     !> Checks whether `c` is an uppercase ASCII letter (A .. Z).
-    pure logical function is_upper(c)
+    elemental logical function is_upper(c)
         character(len=1), intent(in) :: c !! The character to test.
         is_upper = (c >= 'A') .and. (c <= 'Z')
     end function
 
     !> Checks whether or not `c` is a whitespace character. That includes the
     !> space, tab, vertical tab, form feed, carriage return, and linefeed
     !> characters.
-    pure logical function is_white(c)
+    elemental logical function is_white(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)             ! TAB, LF, VT, FF, CR
@@ -211,7 +211,7 @@ contains
 
     !> Checks whether or not `c` is a blank character. That includes the
     !> only the space and tab characters
-    pure logical function is_blank(c)
+    elemental logical function is_blank(c)
         character(len=1), intent(in) :: c !! The character to test.
         integer :: ic
         ic = iachar(c)             ! TAB