feat: `get_cwd` and `set_cwd` #1014

wassup05 · 2025-07-05T23:40:56Z

Depends on #1011

User facing functions added are

get_cwd (cwd, err) - Gets the current working directory (cwd) of the process.
set_cwd (path, err) - Sets the current working directory (cwd) of the process.

Binds to getcwd, chdir on Unix and _getcwd, _chdir on Windows
Error handling is done through state_type and both the platform specific error code and the user friendly error message are provided if an error occurs

wassup05 · 2025-07-07T14:32:05Z

I am honestly not sure how I should go about testing these functions independently

sebastian-mutz · 2025-07-09T14:26:45Z

I am honestly not sure how I should go about testing these functions independently

If I uncerstand correctly, it looks like you're already doing that by invoking execute_command_line; that seems like the best solution to me, but perhaps others think of something else..

wassup05 · 2025-07-09T14:37:37Z

Those are commits from the other branch @sebastian-mutz, the one in this PR: #1014

I don't think I can use execute_command_line here, because that spawns a child process to run the command and using cd would change the working directory of that child process not the parent one... But maybe there is some workaround I am not aware of

sebastian-mutz · 2025-07-22T10:09:37Z

Suggestions for testing (summarising from the chat with Jose):

For testing get_cwd:
gfortran: GETCWD
Intel : GETCWD
Flang: GETCWD

For testing set_cwd:
gfortran: CHDIR
Intel: CHDIR
Flang: CHDIR

Alternatively, using execute_command_line should be fine.

perazz

Thank you for this PR @wassup05. Here is a couple of comments:

the state handler err should be optional. So, the internal handleing features returning the state variable if present, or triggering an error stop if not. This will make behavior consistent to everywhere else.
For testing: I think set/get can be tested in the same test program imho. Here is an example:

get current directory and save it to "pwd" variable -> must be successful
create a new local temporary directory -> must be successful
set_cwd to that
get_cwd should now return the temporary directory
set_cwd back to "pwd"
check successful

I suggest to merge this PR after directory handling is merged into the library already.

perazz · 2025-07-22T13:23:49Z

doc/specs/stdlib_system.md

+
+### Description
+
+It gets the current working directory associated with the process calling this subroutine.


Suggested change

It gets the current working directory associated with the process calling this subroutine.

This subroutine retrieves the current working directory the running process is executing from.

perazz · 2025-07-22T13:25:13Z

doc/specs/stdlib_system.md

+
+### Syntax
+
+`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd, err)`


Suggested change

`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd, err)`

`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd [, err])`

perazz · 2025-07-22T13:25:24Z

doc/specs/stdlib_system.md

+
+`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.


Suggested change

`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.

`err` (optional): Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.

perazz · 2025-07-22T13:27:14Z

doc/specs/stdlib_system.md

+
+### Return values
+
+The `err` is set accordingly.


Suggested change

The `err` is set accordingly.

`err` is an optional state return flag. On error if not requested, a `FS_ERROR` will trigger an error stop.

perazz · 2025-07-22T13:28:10Z

src/stdlib_system.F90

+
+subroutine set_cwd(path, err)
+    character(len=*), intent(in) :: path
+    type(state_type), intent(out) :: err


Suggested change

type(state_type), intent(out) :: err

type(state_type), optional, intent(out) :: err

perazz · 2025-07-22T13:28:20Z

src/stdlib_system.F90

+
+subroutine get_cwd(cwd, err)
+    character(:), allocatable, intent(out) :: cwd
+    type(state_type), intent(out) :: err


Suggested change

type(state_type), intent(out) :: err

type(state_type), optional, intent(out) :: err

perazz · 2025-07-22T13:48:58Z

src/stdlib_system.F90

@@ -2,7 +2,7 @@ module stdlib_system
 use, intrinsic :: iso_c_binding, only : c_int, c_long, c_ptr, c_null_ptr, c_int64_t, c_size_t, &
    c_f_pointer
 use stdlib_kinds, only: int64, dp, c_bool, c_char
-use stdlib_strings, only: to_c_char
+use stdlib_strings, only: to_c_char, to_string
 use stdlib_error, only: state_type, STDLIB_SUCCESS, STDLIB_FS_ERROR


Suggested change

use stdlib_error, only: state_type, STDLIB_SUCCESS, STDLIB_FS_ERROR

use stdlib_error, only: state_type, STDLIB_SUCCESS, FS_ERROR

perazz · 2025-07-22T13:49:20Z

src/stdlib_system.F90

+
+    if (is_windows() .and. present(mode)) then
+        ! _mkdir() doesn't have a `mode` argument
+        err0 = state_type(STDLIB_FS_ERROR, "mode argument not present for Windows")


Suggested change

err0 = state_type(STDLIB_FS_ERROR, "mode argument not present for Windows")

err0 = FS_ERROR("mode argument not available on Windows")

perazz · 2025-07-22T13:50:14Z

src/stdlib_system.F90

+            return
+        case default
+            ! error
+            err0 = state_type(STDLIB_FS_ERROR, "code:", to_string(code)//',', c_get_strerror())


Suggested change

err0 = state_type(STDLIB_FS_ERROR, "code:", to_string(code)//',', c_get_strerror())

err0 = FS_ERROR_CODE(code, c_get_strerror())

wassup05 added 10 commits July 2, 2025 03:17

added functions and relevant wrappers

8d00eea

added tests

c9345c1

added specs

d94d7fb

added examples

e1f68d8

cleanup

c3db3a6

improve test flow a bit

8012ac8

add subroutines and C wrappers

7056a36

add C functions

988127f

add example

d8fedab

add docs

ae4dcc5

wassup05 force-pushed the cwd branch from 1c50e73 to ae4dcc5 Compare July 5, 2025 23:46

sebastian-mutz requested a review from perazz July 21, 2025 15:54

perazz requested changes Jul 22, 2025

View reviewed changes

perazz reviewed Jul 22, 2025

View reviewed changes

Merge branch 'master' into cwd

3c0fd24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: `get_cwd` and `set_cwd` #1014

feat: `get_cwd` and `set_cwd` #1014

Uh oh!

wassup05 commented Jul 5, 2025

Uh oh!

wassup05 commented Jul 7, 2025

Uh oh!

sebastian-mutz commented Jul 9, 2025

Uh oh!

wassup05 commented Jul 9, 2025

Uh oh!

sebastian-mutz commented Jul 22, 2025 •

edited

Loading

Uh oh!

perazz left a comment •

edited

Loading

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025

Uh oh!

perazz Jul 22, 2025 •

edited

Loading

Uh oh!

perazz Jul 22, 2025

Uh oh!

Uh oh!


		### Description

		It gets the current working directory associated with the process calling this subroutine.

	It gets the current working directory associated with the process calling this subroutine.
	This subroutine retrieves the current working directory the running process is executing from.


		### Syntax

		`call [[stdlib_system(module):get_cwd(subroutine)]] (cwd, err)`


		`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.

	`err`: Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
	`err` (optional): Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.

	The `err` is set accordingly.
	`err` is an optional state return flag. On error if not requested, a `FS_ERROR` will trigger an error stop.

	type(state_type), intent(out) :: err
	type(state_type), optional, intent(out) :: err

	use stdlib_error, only: state_type, STDLIB_SUCCESS, STDLIB_FS_ERROR
	use stdlib_error, only: state_type, STDLIB_SUCCESS, FS_ERROR

	err0 = state_type(STDLIB_FS_ERROR, "mode argument not present for Windows")
	err0 = FS_ERROR("mode argument not available on Windows")

	err0 = state_type(STDLIB_FS_ERROR, "code:", to_string(code)//',', c_get_strerror())
	err0 = FS_ERROR_CODE(code, c_get_strerror())

feat: get_cwd and set_cwd #1014

Are you sure you want to change the base?

feat: get_cwd and set_cwd #1014

Uh oh!

Conversation

wassup05 commented Jul 5, 2025

Uh oh!

wassup05 commented Jul 7, 2025

Uh oh!

sebastian-mutz commented Jul 9, 2025

Uh oh!

wassup05 commented Jul 9, 2025

Uh oh!

sebastian-mutz commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

perazz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

perazz Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feat: `get_cwd` and `set_cwd` #1014

feat: `get_cwd` and `set_cwd` #1014

sebastian-mutz commented Jul 22, 2025 •

edited

Loading

perazz left a comment •

edited

Loading

perazz Jul 22, 2025 •

edited

Loading