#include <PathViews.h>

Public Member Functions
	UE_DEPRECATED (4.25, "FPathViews::GetBaseFilename(InPath, bRemovePath) has been superseded by " "FPathViews::GetBaseFilename(InPath) and FPathViews::GetBaseFilenameWithPath(InPath).") static CORE_API FStringView GetBaseFilename(const FStringView &InPath

Static Public Member Functions
static CORE_API FStringView	GetCleanFilename (const FStringView &InPath)

static CORE_API FStringView	GetBaseFilename (const FStringView &InPath)

static CORE_API FStringView	GetBaseFilenameWithPath (const FStringView &InPath)

static CORE_API FStringView	GetPath (const FStringView &InPath)

static CORE_API FStringView	GetExtension (const FStringView &InPath, bool bIncludeDot=false)

static CORE_API FStringView	GetPathLeaf (const FStringView &InPath)

static CORE_API bool	IsPathLeaf (FStringView InPath)

static CORE_API bool	IsDriveSpecifierWithoutRoot (FStringView InPath)

static CORE_API void	IterateComponents (FStringView InPath, TFunctionRef< void(FStringView)> ComponentVisitor)

static CORE_API void	IterateAncestors (FStringView InPath, TFunctionRef< bool(FStringView)> AncestorVisitor)

static CORE_API void	Split (const FStringView &InPath, FStringView &OutPath, FStringView &OutName, FStringView &OutExt)

template<typename CharType , typename... ArgTypes>
static void	Append (TStringBuilderBase< CharType > &Builder, ArgTypes &&... Args)

static CORE_API FString	ChangeExtension (const FStringView &InPath, const FStringView &InNewExtension)

static CORE_API FString	SetExtension (const FStringView &InPath, const FStringView &InNewExtension)

static CORE_API bool	IsSeparator (TCHAR c)

static CORE_API bool	Equals (FStringView A, FStringView B)

static CORE_API bool	Less (FStringView A, FStringView B)

static CORE_API bool	TryMakeChildPathRelativeTo (FStringView Child, FStringView Parent, FStringView &OutRelPath)

static CORE_API bool	IsParentPathOf (FStringView Parent, FStringView Child)

static CORE_API bool	IsRelativePath (FStringView InPath)

static CORE_API bool	HasRedundantTerminatingSeparator (FStringView A)

static CORE_API void	ToAbsolutePath (FStringView InPath, FStringBuilderBase &OutPath)

static CORE_API void	ToAbsolutePath (FStringView BasePath, FStringView InPath, FStringBuilderBase &OutPath)

static CORE_API void	ToAbsolutePathInline (FStringBuilderBase &InOutPath)

static CORE_API void	ToAbsolutePathInline (FStringView BasePath, FStringBuilderBase &InOutPath)

static CORE_API void	NormalizeFilename (FStringBuilderBase &InOutPath)

static CORE_API void	NormalizeDirectoryName (FStringBuilderBase &InOutPath)

static CORE_API bool	CollapseRelativeDirectories (FStringBuilderBase &InOutPath, bool bCollapseAllPossible=false)

static CORE_API void	RemoveDuplicateSlashes (FStringBuilderBase &InOutPath)

static CORE_API void	SplitFirstComponent (FStringView InPath, FStringView &OutFirstComponent, FStringView &OutRemainder)

static CORE_API void	SplitVolumeSpecifier (FStringView InPath, FStringView &OutVolumeSpecifier, FStringView &OutRemainder)

static CORE_API void	AppendPath (FStringBuilderBase &InOutPath, FStringView AppendPath)

static CORE_API FStringView	GetMountPointNameFromPath (const FStringView InPath, bool *bOutHadClassesPrefix=nullptr, bool bInWithoutSlashes=true)

Public Attributes
bool	bRemovePath

Member Function Documentation

◆ Append()

template<typename CharType , typename... ArgTypes>

static void FPathViews::Append	(	TStringBuilderBase< CharType > &	Builder,
		ArgTypes &&...	Args
	)

inlinestatic

Appends each suffix argument to the path in the builder and ensures that there is a separator between them.

Examples: ("", "") -> "" ("A", "") -> "A/" ("", "B") -> "B" ("/", "B") -> "/B" ("A", "B") -> "A/B" ("A/", "B") -> "A/B" ("A\\", "B") -> "A\B" ("A/B", "C/D") -> "A/B/C/D" ("A/", "B", "C/", "D") -> "A/B/C/D"

Parameters

Builder	A possibly-empty path that may end in a separator.
Args	Arguments that can write to a string builder and do not start with a separator.

◆ AppendPath()

void FPathViews::AppendPath	(	FStringBuilderBase &	InOutPath,
		FStringView	AppendPath
	)

static

If AppendPath is a relative path, append it as a relative path onto InOutPath. If AppendPath is absolute, reset InOutPath and replace it with RelPath. Handles presence or absence of terminating separator in BasePath. Does not interpret . or ..; each occurrence of these in either path will remain in the combined InOutPath.

◆ ChangeExtension()

FString FPathViews::ChangeExtension	(	const FStringView &	InPath,
		const FStringView &	InNewExtension
	)

static

Replaces the pre-existing file extension of a filename.

Parameters

InPath	A valid file path with a pre-existing extension.
InNewExtension	The new extension to use (prefixing with a '.' is optional)

Returns: The new file path complete with the new extension unless InPath is not valid in which case a copy of InPath will be returned instead.

◆ CollapseRelativeDirectories()

bool FPathViews::CollapseRelativeDirectories	(	FStringBuilderBase &	InOutPath,
		bool	bCollapseAllPossible = `false`
	)

static

Collapses redundant paths like "/./" and "SkipDir/..". FPaths::CollapseRelativeDirectories() equivalent.

◆ Equals()

bool FPathViews::Equals	(	FStringView	A,
		FStringView	B
	)

static

Return true if the given paths are the same path (with exceptions noted below). Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A/B.C", "../A/B.C") -> true ("../A/B", "../A/B.C") -> false ("../A/", "../A/") -> true ("../A/", "../A") -> true ("d:/root/Engine/", "d:\root\Engine") -> true (../../../Engine/Content", "d:/root/Engine/Content") -> false (d:/root/Engine/..", "d:/root") -> false (d:/root/Engine/./Content", "d:/root/Engine/Content") -> false

◆ GetBaseFilename()

FStringView FPathViews::GetBaseFilename ( const FStringView & InPath )

static

Returns the portion of the path after the last separator and before the last dot.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> "C" "A/B/C" -> "C" "A/B/" -> "" "A" -> "A"

Returns: The portion of the path after the last separator and before the last dot.

◆ GetBaseFilenameWithPath()

FStringView FPathViews::GetBaseFilenameWithPath ( const FStringView & InPath )

static

Returns the portion of the path before the last dot.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> "A/B/C" "A/B/C" -> "A/B/C" "A/B/" -> "A/B/" "A" -> "A"

Returns: The portion of the path before the last dot.

◆ GetCleanFilename()

FStringView FPathViews::GetCleanFilename ( const FStringView & InPath )

static

Returns the portion of the path after the last separator.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> "C.D" "A/B/C" -> "C" "A/B/" -> "" "A" -> "A"

Returns: The portion of the path after the last separator.

◆ GetExtension()

FStringView FPathViews::GetExtension	(	const FStringView &	InPath,
		bool	bIncludeDot = `false`
	)

static

Returns the portion of the path after the last dot following the last separator, optionally including the dot.

Examples: (Using '/' but '\' is valid too.) "A/B.C.D" -> "D" (bIncludeDot=false) or ".D" (bIncludeDot=true) "A/B/C.D" -> "D" (bIncludeDot=false) or ".D" (bIncludeDot=true) "A/B/.D" -> "D" (bIncludeDot=false) or ".D" (bIncludeDot=true) ".D" -> "D" (bIncludeDot=false) or ".D" (bIncludeDot=true) "A/B/C" -> "" "A.B/C" -> "" "A.B/" -> "" "A" -> ""

Parameters

bIncludeDot Whether to include the leading dot in the returned view.

Returns: The portion of the path after the last dot following the last separator, optionally including the dot.

◆ GetMountPointNameFromPath()

FStringView FPathViews::GetMountPointNameFromPath	(	const FStringView	InPath,
		bool *	bOutHadClassesPrefix = `nullptr`,
		bool	bInWithoutSlashes = `true`
	)

static

Returns the name of the mount point in a path Removes starting forward slash and Classes_ prefix if bInWithoutSlashes is true Example: "/Classes_A/Textures" returns "A" and sets bOutHadClassesPrefix=true if bInWithoutSlashes is true returns "/Classes_A" otherwise and sets bOutHadClassesPrefix=false

◆ GetPath()

FStringView FPathViews::GetPath ( const FStringView & InPath )

static

Returns the portion of the path before the last separator.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> "A/B" "A/B/C" -> "A/B" "A/B/" -> "A/B" "A" -> ""

Returns: The portion of the path before the last separator.

◆ GetPathLeaf()

FStringView FPathViews::GetPathLeaf ( const FStringView & InPath )

static

Returns the last non-empty path component.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> "C.D" "A/B/C" -> "C" "A/B/" -> "B" "A" -> "A"

Returns: The last non-empty path component.

◆ HasRedundantTerminatingSeparator()

bool FPathViews::HasRedundantTerminatingSeparator ( FStringView A )

static

Report whether the path has an unneeded trailing slash. /root/path -> false /root/ -> true /root// -> true / -> false // -> false /// -> true d:/ -> false d:// -> true

◆ IsDriveSpecifierWithoutRoot()

bool FPathViews::IsDriveSpecifierWithoutRoot ( FStringView InPath )

static

Report whether the given path is an invalid path because it has a drive specifier (':') without a following path separator indicating the root of that drive. In general usage on Windows, drive specifiers without a following path separator are interpreted to mean the current working directory of the given drive. But that context is not always applicable and will need to be handled in system-specific ways.

See also: SplitVolumeSpecifier for callers who want to followup by modifing the path.

D: -> true D:/ -> false D:root -> true D:/root -> false //volume -> false /root -> false relpath -> false

See FPathViewsVolumeSpecifierTest for further edgecases.

◆ IsParentPathOf()

bool FPathViews::IsParentPathOf	(	FStringView	Parent,
		FStringView	Child
	)

static

Return whether Parent is a parent path of (or is equal to) Child. Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A", "../A/B") -> true ("../A/", "../A\B") -> true ("../A", "../A/") -> true ("../A", ".././A/") -> false ("d:/root/Engine", "../../../Engine") -> false

Parameters

Parent	An absolute path that may be a parent path of Child.
Child	An absolute path that may be a child path of Parent.

Returns: True if and only if Child is a child path of Parent (or is equal to it).

◆ IsPathLeaf()

bool FPathViews::IsPathLeaf ( FStringView InPath )

static

Return whether the given relative or absolute path is a leaf path - has no separators.

Examples: (Using '/' but '\' functions the same way) A -> true A/ -> true D:/ -> true / -> true // -> true A/B -> false D:/A -> false //A -> false

◆ IsRelativePath()

bool FPathViews::IsRelativePath ( FStringView InPath )

static

Return whether the given path is a relativepath - does not start with a separator or volume:. Returns true for empty paths.

◆ IsSeparator()

bool FPathViews::IsSeparator ( TCHAR c )

static

Return whether the given character is a path-separator character (/ or )

◆ IterateAncestors()

void FPathViews::IterateAncestors	(	FStringView	InPath,
		TFunctionRef< bool(FStringView)>	AncestorVisitor
	)

static

Calls AncestorVisitor with the given path and its ancestor paths. If AncestorVisitor returns false, iteration stops. If the string begins with a path root as understood by SplitVolumeSpecifier, that will be the last item visited with the modification that a separator following a drive specifier will be included by this function.

Examples: "" -> { "" } "/" -> { "/" } "A/B.C" -> { "A/B.C", "A" } "A/B/C" -> { "A/B/C", "A/B", "A" } "../../A/B/C.D" -> { "../../A/B/C.D", "../../A/B", "../../A", "../..", ".." } "/A/B" -> { "/A/B", "/A", "/" } "/A/B/" -> { "/A/B", "/A", "/" } "C:/A/B" -> { "C:/A/B", "C:/A", "C:/" } "C:A/B" -> { "C:A/B", "C:A", "C:" } "\\ShareName/A/B" -> { "\\ShareName/A/B", "\\ShareName/A", "\\ShareName" }

When moving to the next ancestor, extra trailing separators are also removed, e.g. "/A//B" -> { "/A//B", "/A" } Note that separators are not removed except at the end of the current path, as with visiting "/A//B" above.

◆ IterateComponents()

void FPathViews::IterateComponents	(	FStringView	InPath,
		TFunctionRef< void(FStringView)>	ComponentVisitor
	)

static

Splits InPath into individual directory components, and calls ComponentVisitor on each. Note that this function does not properly handle Windows network paths such as //ShareName/Path and drive components such as C: (without trailing slash) may not be considered valid paths by some APIs.

Examples: "A/B.C" -> {"A", "B.C"} "A/B/C" -> {"A", "B", "C"} "../../A/B/C.D" -> {"..", "..", "A", "B", "C.D" } "/A/B/C" -> { "", "A", "B", "C" } "C:/A/B/C" -> { "C:", "A", "B", "C" } "//ShareName/Path" -> { "", "", "ShareName", "Path" }

◆ Less()

bool FPathViews::Less	(	FStringView	A,
		FStringView	B
	)

static

Return true if the the first path is lexicographically less than the second path (with caveats noted below). Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A/B.C", "../A/B.C") -> false (they are equal) ("../A/B", "../A/B.C") -> true (a string is greater than any prefix of itself) ("../A/", "../A/") -> false (they are equal) ("../A/", "../A") -> false (they are equal) ("../A", "../A/") -> false (they are equal) ("d:/root/Engine/", "d:\root\Engine") -> false (they are equal) (../../../Engine/Content", "d:/root/Engine/Content") -> true ('.' is less than 'd') (d:/root/Engine/..", "d:/root") -> false (A string is greater than any prefix of itself) (d:/root/Engine/./Content", "d:/root/Engine/Content") -> false

◆ NormalizeDirectoryName()

void FPathViews::NormalizeDirectoryName ( FStringBuilderBase & InOutPath )

static

Normalize and remove trailing slash unless the preceding character is '/' or ':'

◆ NormalizeFilename()

void FPathViews::NormalizeFilename ( FStringBuilderBase & InOutPath )

static

Convert \ to / and do platform-specific normalization

◆ RemoveDuplicateSlashes()

void FPathViews::RemoveDuplicateSlashes ( FStringBuilderBase & InOutPath )

static

Removes duplicate forward slashes, e.g. "a/b//c////f.e" -> "a/b/c/f.e"

◆ SetExtension()

FString FPathViews::SetExtension	(	const FStringView &	InPath,
		const FStringView &	InNewExtension
	)

static

Sets the file extension of a filename.

Parameters

InPath	A file path with or without a pre-existing extension.
InNewExtension	The new extension to use (prefixing with a '.' is optional)

Returns: The new file path complete with the new extension.

◆ Split()

void FPathViews::Split	(	const FStringView &	InPath,
		FStringView &	OutPath,
		FStringView &	OutName,
		FStringView &	OutExt
	)

static

Splits a path into three parts, any of which may be empty: the path, the clean name, and the extension.

Examples: (Using '/' but '\' is valid too.) "A/B/C.D" -> ("A/B", "C", "D") "A/B/C" -> ("A/B", "C", "") "A/B/" -> ("A/B", "", "") "A/B/.D" -> ("A/B", "", "D") "A/B.C.D" -> ("A", "B.C", "D") "A" -> ("", "A", "") "A.D" -> ("", "A", "D") ".D" -> ("", "", "D")

Parameters

OutPath	[out] Receives the path portion of the input string, excluding the trailing separator.
OutName	[out] Receives the name portion of the input string.
OutExt	[out] Receives the extension portion of the input string, excluding the dot.

◆ SplitFirstComponent()

void FPathViews::SplitFirstComponent	(	FStringView	InPath,
		FStringView &	OutFirstComponent,
		FStringView &	OutRemainder
	)

static

Split the given absolute or relative path into its topmost directory and the relative path from that directory. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling.

Parameters

InPath	The path to split.
OutFirstComponent	Receives the first directory element in the path, or InPath if it is a leaf path.
OutRemainder	Receives the relative path from OutFirstComponent to InPath, or empty if InPath is a leaf path.

◆ SplitVolumeSpecifier()

void FPathViews::SplitVolumeSpecifier	(	FStringView	InPath,
		FStringView &	OutVolumeSpecifier,
		FStringView &	OutRemainder
	)

static

Split the path into a volume specifier and the rest of the path. This function handles drive specifiers without a root in a specific way, see the examples and

See also: IsDriveSpecifierWithoutRoot

<emptystring> -> { '', '' } D: -> { 'D:', '' } D:root/path -> { 'D:', 'root/path' } D:/root/path -> { 'D:', '/root/path' } //volume -> { '//volume', '' } //volume/root/path -> { '//volume', '/root/path' } root/path -> { '', 'root/path' } /root/path -> { '', '/root/path' }

See FPathViewsVolumeSpecifierTest for further edgecases.

◆ ToAbsolutePath() [1/2]

void FPathViews::ToAbsolutePath	(	FStringView	BasePath,
		FStringView	InPath,
		FStringBuilderBase &	OutPath
	)

static

Convert to absolute using explicit BasePath, normalize and append. FPaths::ConvertRelativePathToFull() equivalent.

◆ ToAbsolutePath() [2/2]

void FPathViews::ToAbsolutePath	(	FStringView	InPath,
		FStringBuilderBase &	OutPath
	)

static

Convert to absolute using process BaseDir(), normalize and append. FPaths::ConvertRelativePathToFull() equivalent.

◆ ToAbsolutePathInline() [1/2]

void FPathViews::ToAbsolutePathInline ( FStringBuilderBase & InOutPath )

static

Convert to absolute using process BaseDir() and normalize inlined. FPaths::ConvertRelativePathToFull() equivalent.

◆ ToAbsolutePathInline() [2/2]

void FPathViews::ToAbsolutePathInline	(	FStringView	BasePath,
		FStringBuilderBase &	InOutPath
	)

static

Convert to absolute using explicit BasePath and normalize inlined. FPaths::ConvertRelativePathToFull() equivalent.

◆ TryMakeChildPathRelativeTo()

bool FPathViews::TryMakeChildPathRelativeTo	(	FStringView	Child,
		FStringView	Parent,
		FStringView &	OutRelPath
	)

static

Check whether Parent is a parent path of Child and report the relative path if so. Case-insensitive / is treated as equal to \ Presence or absence of terminating separator (/) is ignored in the comparison. Directory elements of . and .. are currently not interpreted and are treated as literal characters. Callers should not rely on this behavior as it may be corrected in the future. callers should instead conform the paths before calling. Relative paths and absolute paths are not resolved, and relative paths will never equal absolute paths. Callers should not rely on this behavior as it may be corrected in the future; callers should instead conform the paths before calling. Examples: ("../A/B", "../A") -> (true, "B") ("../A\B", "../A/") -> (true, "B") ("../A/", "../A") -> (true, "") (".././A/", "../A") -> (false, "") ("../../../Engine", "d:/root/Engine") -> (false, "")

Parameters

Child	An absolute path that may be a child path of Parent.
Parent	An absolute path that may be a parent path of Child.
OutRelPath	Receives the relative path from Parent to Child, or empty if Parent is not a parent of Child.

Returns: True if and only if Child is a child path of Parent (or is equal to it).

◆ UE_DEPRECATED()

FPathViews::UE_DEPRECATED	(	4.	25,
		"FPathViews::GetBaseFilename(InPath, bRemovePath) has been superseded by " "FPathViews::GetBaseFilename(InPath) and FPathViews::GetBaseFilenameWithPath(InPath)."
	)		const &

Returns the portion of the path before the last dot and optionally after the last separator.

Member Data Documentation

◆ bRemovePath

bool FPathViews::bRemovePath

The documentation for this class was generated from the following files:

Engine/Source/Runtime/Core/Public/Misc/PathViews.h
Engine/Source/Runtime/Core/Private/Misc/PathViews.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Member Function Documentation

◆ Append()

◆ AppendPath()

◆ ChangeExtension()

◆ CollapseRelativeDirectories()

◆ Equals()

◆ GetBaseFilename()

◆ GetBaseFilenameWithPath()

◆ GetCleanFilename()

◆ GetExtension()

◆ GetMountPointNameFromPath()

◆ GetPath()

◆ GetPathLeaf()

◆ HasRedundantTerminatingSeparator()

◆ IsDriveSpecifierWithoutRoot()

◆ IsParentPathOf()

◆ IsPathLeaf()

◆ IsRelativePath()

◆ IsSeparator()

◆ IterateAncestors()

◆ IterateComponents()

◆ Less()

◆ NormalizeDirectoryName()

◆ NormalizeFilename()

◆ RemoveDuplicateSlashes()

◆ SetExtension()

◆ Split()

◆ SplitFirstComponent()

◆ SplitVolumeSpecifier()

◆ ToAbsolutePath() [1/2]

◆ ToAbsolutePath() [2/2]

◆ ToAbsolutePathInline() [1/2]

◆ ToAbsolutePathInline() [2/2]

◆ TryMakeChildPathRelativeTo()

◆ UE_DEPRECATED()

Member Data Documentation

◆ bRemovePath