Commit: patch 9.1.1605: cannot specify scope for chdir()

[Christian Brabandt]

patch 9.1.1605: cannot specify scope for chdir()

Commit: https://github.com/vim/vim/commit/8a65a49d509d5a9dd5759a4287969896e8941c10
Author: kuuote <znmx...@gmail.com>
Date: Fri Aug 8 13:09:25 2025 +0200

patch 9.1.1605: cannot specify scope for chdir()

Problem: Cannot specify scope for chdir()
Solution: Add optional scope argument (kuuote)

closes: #17888

Signed-off-by: kuuote <znmx...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index 2c18290f9..f4409f39a 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -1783,16 +1783,23 @@ charidx({string}, {idx} [, {countcc} [, {utf16}]])
Return type: |Number|


-chdir({dir}) *chdir()*
- Change the current working directory to {dir}. The scope of
- the directory change depends on the directory of the current
- window:
- - If the current window has a window-local directory
- (|:lcd|), then changes the window local directory.
- - Otherwise, if the current tabpage has a local
- directory (|:tcd|) then changes the tabpage local
- directory.
- - Otherwise, changes the global directory.
+chdir({dir} [, {scope}]) *chdir()*
+ Changes the current working directory to {dir}. The scope of
+ the change is determined as follows:
+ If {scope} is not present, the current working directory is
+ changed to the scope of the current directory:
+ - If the window local directory (|:lcd|) is set, it
+ changes the current working directory for that scope.
+ - Otherwise, if the tab page local directory (|:tcd|) is
+ set, it changes the current directory for that scope.
+ - Otherwise, changes the global directory for that scope.
+
+ If {scope} is present, changes the current working directory
+ for the specified scope:
+ "window" Changes the window local directory. |:lcd|
+ "tabpage" Changes the tab page local directory. |:tcd|
+ "global" Changes the global directory. |:cd|
+
{dir} must be a String.
If successful, returns the previous working directory. Pass
this to another chdir() to restore the directory.
diff --git a/runtime/doc/version9.txt b/runtime/doc/version9.txt
index a82676c42..1052e7e51 100644
--- a/runtime/doc/version9.txt
+++ b/runtime/doc/version9.txt
@@ -1,4 +1,4 @@
-*version9.txt* For Vim version 9.1. Last change: 2025 Jul 25
+*version9.txt* For Vim version 9.1. Last change: 2025 Aug 08


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -41722,6 +41722,7 @@ Functions: ~
not finished
- Add the optional {opts} |Dict| argument to |getchar()| to control: cursor
behaviour, return type and whether or not to simplify the returned key
+- |chdir()| allows to optionally specify a scope argument

Others: ~
- the regex engines match correctly case-insensitive multi-byte characters
diff --git a/src/evalfunc.c b/src/evalfunc.c
index c7936238e..7211048d1 100644
--- a/src/evalfunc.c
+++ b/src/evalfunc.c
@@ -2086,7 +2086,7 @@ static funcentry_T global_functions[] =
ret_number, f_charcol},
{"charidx", 2, 4, FEARG_1, arg4_string_number_bool_bool,
ret_number, f_charidx},
- {"chdir", 1, 1, FEARG_1, arg1_string,
+ {"chdir", 1, 2, FEARG_1, arg2_string,
ret_string, f_chdir},
{"cindent", 1, 1, FEARG_1, arg1_lnum,
ret_number, f_cindent},
diff --git a/src/filepath.c b/src/filepath.c
index 15f770f42..0ef77f9d8 100644
--- a/src/filepath.c
+++ b/src/filepath.c
@@ -842,7 +842,22 @@ f_chdir(typval_T *argvars, typval_T *rettv)
vim_free(cwd);
}

- if (curwin->w_localdir != NULL)
+ if (argvars[1].v_type != VAR_UNKNOWN)
+ {
+ char_u *s = tv_get_string(&argvars[1]);
+ if (STRCMP(s, "global") == 0)
+ scope = CDSCOPE_GLOBAL;
+ else if (STRCMP(s, "tabpage") == 0)
+ scope = CDSCOPE_TABPAGE;
+ else if (STRCMP(s, "window") == 0)
+ scope = CDSCOPE_WINDOW;
+ else
+ {
+ semsg(_(e_invalid_value_for_argument_str_str), "scope", s);
+ return;
+ }
+ }
+ else if (curwin->w_localdir != NULL)
scope = CDSCOPE_WINDOW;
else if (curtab->tp_localdir != NULL)
scope = CDSCOPE_TABPAGE;
diff --git a/src/testdir/test_cd.vim b/src/testdir/test_cd.vim
index 878a2aeb5..1b7777e1b 100644
--- a/src/testdir/test_cd.vim
+++ b/src/testdir/test_cd.vim
@@ -96,10 +96,20 @@ func Test_chdir_func()
call assert_equal('y', fnamemodify(getcwd(3, 2), ':t'))
call assert_equal('testdir', fnamemodify(getcwd(1, 1), ':t'))

+ " Forcing scope
+ call chdir('.', 'global')
+ call assert_match('^\[global\]', trim(execute('verbose pwd')))
+ call chdir('.', 'tabpage')
+ call assert_match('^\[tabpage\]', trim(execute('verbose pwd')))
+ call chdir('.', 'window')
+ call assert_match('^\[window\]', trim(execute('verbose pwd')))
+
" Error case
call assert_fails("call chdir('dir-abcd')", 'E344:')
silent! let d = chdir("dir_abcd")
call assert_equal("", d)
+ call assert_fails("call chdir('.', test_null_string())", 'E475:')
+ call assert_fails("call chdir('.', [])", 'E730:')
" Should not crash
call chdir(d)
call assert_equal('', chdir([]))
diff --git a/src/testdir/test_vim9_builtin.vim b/src/testdir/test_vim9_builtin.vim
index 675dcd00c..40cc15f1a 100644
--- a/src/testdir/test_vim9_builtin.vim
+++ b/src/testdir/test_vim9_builtin.vim
@@ -770,6 +770,8 @@ enddef

def Test_chdir()
assert_fails('chdir(true)', 'E1174:')
+ assert_fails('chdir(".", test_null_string())', 'E475:')
+ assert_fails('chdir(".", [])', 'E730:')
enddef

def Test_cindent()
diff --git a/src/version.c b/src/version.c
index 2cd99fc78..e4acba9a5 100644
--- a/src/version.c
+++ b/src/version.c
@@ -719,6 +719,8 @@ static char *(features[]) =

static int included_patches[] =
{ /* Add new patch number below this line */
+/**/
+ 1605,
/**/
1604,
/**/