You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
c1e728c293
#rb Martin Ridgers #jira UE-191791 #rnx - Add a new ::IsProcessInteractive function to UE::Virtualization::Utils namespace that will return true if we think the current process is being run in a scenario where a user will be present and that it is okay to show an interactive error dialog. - Use this new check to make sure that we do not try to display the "connection error" dialog on start up (even though as a slate dialog this will usually fail to display in non-interactive scenarios anyway) - Use the new check to avoid displaying the "payload pull failure" dialog and default to the process shutting down instead. -- Added some code comments to explain why we force the process to exit rather than logging a fatal error. [CL 28183133 by paul chipchase in ue5-main branch]
87 lines
2.9 KiB
C++
87 lines
2.9 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "Containers/StringFwd.h"
|
|
#include "Containers/UnrealString.h"
|
|
|
|
class FPackagePath;
|
|
|
|
struct FIoHash;
|
|
|
|
namespace UE::Virtualization::Utils
|
|
{
|
|
|
|
/**
|
|
* Converts a FIoHash into a file path.
|
|
*
|
|
* This utility will take an FIoHash and return a file path that is
|
|
* 3 directories deep. The first six characters of the id will be used to
|
|
* create the directory names, with each directory using two characters.
|
|
* The remaining thirty four characters will be used as the file name.
|
|
* Lastly the extension '.payload' will be applied to complete the path/
|
|
* Example: FIoHash 0139d6d5d477e32dfd2abd3c5bc8ea8507e8eef8 becomes
|
|
* 01/39/d6/d5d477e32dfd2abd3c5bc8ea8507e8eef8.payload'
|
|
*
|
|
* @param Id The payload identifier used to create the file path.
|
|
* @param OutPath Will be reset and then assigned the resulting file path.
|
|
* The string builder must have a capacity of at least 52 characters
|
|
to avoid reallocation.
|
|
*/
|
|
void PayloadIdToPath(const FIoHash& Id, FStringBuilderBase& OutPath);
|
|
|
|
/**
|
|
* Converts a FIoHash into a file path.
|
|
*
|
|
* See above for further details
|
|
*
|
|
* @param Id The payload identifier used to create the file path.
|
|
* @return The resulting file path.
|
|
*/
|
|
FString PayloadIdToPath(const FIoHash& Id);
|
|
|
|
/**
|
|
* Fill in the given string builder with the human readable message of the current system
|
|
* code, followed by the code value itself.
|
|
* In the system value is currently 0, then we assume that it was cleared before this was
|
|
* able to be called and write that the error is unknown instead of assuming that the
|
|
* operation was a success.
|
|
*/
|
|
void GetFormattedSystemError(FStringBuilderBase& SystemErrorMessage);
|
|
|
|
|
|
enum class ETrailerFailedReason : uint8
|
|
{
|
|
/** Could not open the package for reading */
|
|
NotFound,
|
|
/** The header of the package (summary) could not be read or was otherwise corrupted */
|
|
InvalidSummary,
|
|
/** The package predates package version 1002 in which the package trailer was introduced */
|
|
OutOfDate,
|
|
/** The reason for the missing package trailer could not be determined */
|
|
Unknown
|
|
};
|
|
|
|
/**
|
|
* Utility that returns the reason why a given package does not have a package trailer.
|
|
* Note that it does not actually try to load the trailer or validate that the trailer
|
|
* is in fact missing and assumes that the caller previously attempted to a call to
|
|
* load a trailer from the package but it failed.
|
|
*/
|
|
ETrailerFailedReason FindTrailerFailedReason(const FPackagePath& PackagePath);
|
|
|
|
/**
|
|
* Parse the given path and expand any environment variables found with the format
|
|
* $(EnvVarName). If the variable cannot be found the function will return false
|
|
* and OutExpandedPath will be reset.
|
|
*/
|
|
bool ExpandEnvironmentVariables(FStringView InputPath, FStringBuilderBase& OutExpandedPath);
|
|
|
|
/**
|
|
* Returns true if the process is interactive and we should display error dialogs to
|
|
* the user.
|
|
* */
|
|
bool IsProcessInteractive();
|
|
|
|
} // namespace UE::Virtualization::Utils
|