get_filename_component: Add DIRECTORY option (#14091)

The name "PATH" is not precise so add equivalent option "DIRECTORY".
Document the latter as preferred and the former as a legacy alias.

1 files changed, 10 insertions, 9 deletions

diff --git a/Tests/RunCMake/get_filename_component/KnownComponents.cmake b/Tests/RunCMake/get_filename_component/KnownComponents.cmake
index d5becc0..a4ef8ff 100644
--- a/Tests/RunCMake/get_filename_component/KnownComponents.cmake
+++ b/Tests/RunCMake/get_filename_component/KnownComponents.cmake
@@ -5,28 +5,29 @@ macro(check desc actual expect)
 endmacro()
 
 set(filename "/path/to/filename.ext.in")
-set(expect_PATH "/path/to")
+set(expect_DIRECTORY "/path/to")
 set(expect_NAME "filename.ext.in")
 set(expect_EXT ".ext.in")
 set(expect_NAME_WE "filename")
-foreach(c PATH NAME EXT NAME_WE)
+set(expect_PATH "/path/to")
+foreach(c DIRECTORY NAME EXT NAME_WE PATH)
   get_filename_component(actual_${c} "${filename}" ${c})
   check("${c}" "${actual_${c}}" "${expect_${c}}")
 endforeach()
 
-get_filename_component(test_slashes "c:\\path\\to\\filename.ext.in" PATH)
-check("PATH from backslashes" "${test_slashes}" "c:/path/to")
+get_filename_component(test_slashes "c:\\path\\to\\filename.ext.in" DIRECTORY)
+check("DIRECTORY from backslashes" "${test_slashes}" "c:/path/to")
 
-get_filename_component(test_winroot "c:\\filename.ext.in" PATH)
-check("PATH in windows root" "${test_winroot}" "c:/")
+get_filename_component(test_winroot "c:\\filename.ext.in" DIRECTORY)
+check("DIRECTORY in windows root" "${test_winroot}" "c:/")
 
 get_filename_component(test_absolute "/path/to/a/../filename.ext.in" ABSOLUTE)
 check("ABSOLUTE" "${test_absolute}" "/path/to/filename.ext.in")
 
-get_filename_component(test_cache "/path/to/filename.ext.in" PATH CACHE)
+get_filename_component(test_cache "/path/to/filename.ext.in" DIRECTORY CACHE)
 check("CACHE 1" "${test_cache}" "/path/to")
-get_filename_component(test_cache "/path/to/other/filename.ext.in" PATH CACHE)
+get_filename_component(test_cache "/path/to/other/filename.ext.in" DIRECTORY CACHE)
 check("CACHE 2" "${test_cache}" "/path/to")
 unset(test_cache CACHE)
-get_filename_component(test_cache "/path/to/other/filename.ext.in" PATH CACHE)
+get_filename_component(test_cache "/path/to/other/filename.ext.in" DIRECTORY CACHE)
 check("CACHE 3" "${test_cache}" "/path/to/other")