FoundationEssentials: correct path canonicalisation handling on Windows (#639)

compnerd · jmschonfeld · web-flow · commit 08d50c1caa83 · 2024-05-30T13:12:47.000-07:00
* FoundationEssentials: correct path canonicalisation handling on Windows

Strip the extended path prefix for bypassing the Win32 API layer. This
is guaranteed to be prefixed on strings as per the documentation.

* Update Sources/FoundationEssentials/String/String+Path.swift

Co-authored-by: Jeremy Schonfeld &lt;1004103+jmschonfeld@users.noreply.github.com&gt;

---------

Co-authored-by: Jeremy Schonfeld &lt;1004103+jmschonfeld@users.noreply.github.com&gt;
diff --git a/Sources/FoundationEssentials/String/String+Path.swift b/Sources/FoundationEssentials/String/String+Path.swift
@@ -665,7 +665,9 @@ extension String {
                 guard GetFinalPathNameByHandleW(hFile, $0.baseAddress, dwLength, VOLUME_NAME_DOS) == dwLength - 1 else {
                     return nil
                 }
-                return String(decodingCString: $0.baseAddress!, as: UTF16.self)
+
+                // When using `VOLUME_NAME_DOS`, the returned path uses `\\?\`.
+                return String(decodingCString: $0.baseAddress!.advanced(by: 4), as: UTF16.self)
             }
         }
 #else

Original file line number	Diff line number	Diff line change
`@@ -665,7 +665,9 @@ extension String {`
`665`	`665`	`guard GetFinalPathNameByHandleW(hFile, $0.baseAddress, dwLength, VOLUME_NAME_DOS) == dwLength - 1 else {`
`666`	`666`	`return nil`
`667`	`667`	`}`
`668`		`- return String(decodingCString: $0.baseAddress!, as: UTF16.self)`
	`668`	`+`
	`669`	+ // When using `VOLUME_NAME_DOS`, the returned path uses `\\?\`.
	`670`	`+ return String(decodingCString: $0.baseAddress!.advanced(by: 4), as: UTF16.self)`
`669`	`671`	`}`
`670`	`672`	`}`
`671`	`673`	`#else`