Merge branch 'fortran-lang:master' into iterative

Author: jalvesz

.github/collab.sh

@@ -535,6 +535,191 @@ The function returns a `logical` value:
 
 ---
 
+## `make_directory` - Creates an empty directory
+
+### Status
+
+Experimental
+
+### Description
+
+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 [,err])`
+
+### Class
+
+Subroutine
+
+### Arguments
+
+`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
+
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
+
+### Return values
+
+`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_make_directory.f90!}
+```
+
+---
+
+## `make_directory_all` - Creates an empty directory with all its parent directories
+
+### Status
+
+Experimental
+
+### Description
+
+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):make_directory_all(subroutine)]] (path [,err])`
+
+### Class
+
+Subroutine
+
+### Arguments
+
+`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
+
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
+
+### Return values
+
+`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_make_directory.f90!}
+```
+
+---
+
+## `remove_directory` - Removes an empty directory
+
+### 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.
+
+### Syntax
+
+`call [[stdlib_system(module):remove_directory(subroutine)]] (path, err)`
+
+### Class
+
+Subroutine
+
+### Arguments
+
+`path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
+
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
+
+### Return values
+
+`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_remove_directory.f90!}
+```
+
+---
+
+## `get_cwd` - Gets the current working directory
+
+### Status
+
+Experimental
+
+### Description
+
+This subroutine retrieves the current working directory the running process is executing from.
+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])`
+
+### Class
+
+Subroutine
+
+### Arguments
+
+`cwd`: Shall be a character string for receiving the path of the current working directory (cwd). It is an `intent(out)` argument.
+
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `intent(out)` argument.
+
+### Return values
+
+`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!}
+```
+
+---
+
+## `set_cwd` - Sets the current working directory
+
+### Status
+
+Experimental
+
+### Description
+
+This subrotine sets the current working directory the process is executing from.
+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])`
+
+### Class
+
+Subroutine
+
+### Arguments
+
+`path`: Shall be a character string containing the path of the directory. It is an `intent(in)` argument.
+
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `intent(out)` argument.
+
+### Return values
+
+`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!}
+```
+
+---
+
 ## `null_device` - Return the null device file path
 
 ### Status
@@ -571,6 +756,8 @@ None.
 {!example/system/example_null_device.f90!}
 ```
 
+---
+
 ## `delete_file` - Delete a file
 
 ### Status
@@ -612,6 +799,8 @@ The file is removed from the filesystem if the operation is successful. If the o
 {!example/system/example_delete_file.f90!}
 ```
 
+---
+
 ## `join_path` - Joins the provided paths according to the OS
 
 ### Status
@@ -674,6 +863,8 @@ The result is an `allocatable` character string or `type(string_type)`
 {!example/system/example_path_join.f90!}
 ```
 
+---
+
 ## `split_path` - splits a path immediately following the last separator
 
 ### Status
@@ -714,6 +905,8 @@ The splitted path. `head` and `tail`.
 {!example/system/example_path_split_path.f90!}
 ```
 
+---
+
 ## `base_name` - The last part of a path
 
 ### Status
@@ -749,6 +942,8 @@ A character string or `type(string_type)`.
 {!example/system/example_path_base_name.f90!}
 ```
 
+---
+
 ## `dir_name` - Everything except the last part of the path
 
 ### Status

doc/specs/stdlib_ascii.md

@@ -16,4 +16,6 @@ ADD_EXAMPLE(path_join)
 ADD_EXAMPLE(path_split_path)
 ADD_EXAMPLE(path_base_name)
 ADD_EXAMPLE(path_dir_name)
-
+ADD_EXAMPLE(make_directory)
+ADD_EXAMPLE(remove_directory)
+ADD_EXAMPLE(cwd)

doc/specs/stdlib_system.md

@@ -0,0 +1,32 @@
+! Illustrate the usage of `get_cwd`, `set_cwd`
+program example_cwd
+    use stdlib_system, only: get_cwd, set_cwd
+    use stdlib_error, only: state_type
+    implicit none 
+
+    character(len=:), allocatable :: path
+    type(state_type) :: err
+
+    call get_cwd(path, err)
+
+    if (err%error()) then
+        print *, "Error getting current working directory: "//err%print()
+    end if
+    
+    print *, "CWD: "//path
+
+    call set_cwd("./src", err)
+
+    if (err%error()) then
+        print *, "Error setting current working directory: "//err%print()
+    end if
+
+    call get_cwd(path, err)
+
+    if (err%error()) then
+        print *, "Error getting current working directory after using set_cwd: "//err%print()
+    end if
+    
+    print *, "CWD: "//path
+end program example_cwd
+

example/system/CMakeLists.txt

@@ -0,0 +1,25 @@
+! Illustrate the usage of `make_directory`, `make_directory_all`
+program example_make_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("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/example_cwd.f90

@@ -0,0 +1,17 @@
+! Illustrate the usage of `remove_directory`
+program example_remove_directory
+    use stdlib_system, only: remove_directory
+    use stdlib_error, only: state_type
+    implicit none
+
+    type(state_type) :: err
+
+    call remove_directory("directory_to_be_removed", err)
+
+    if (err%error()) then
+        print *, err%print()
+    else
+        print *, "directory removed successfully"
+    end if
+
+end program example_remove_directory

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
@@ -121,6 +121,7 @@ set(SRC
     stdlib_system_subprocess.c
     stdlib_system_subprocess.F90
     stdlib_system_path.f90
+    stdlib_system.c
     stdlib_system.F90
     stdlib_sparse.f90
     stdlib_specialfunctions_legendre.f90