CrashReportCoreConfig.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
 
// FORCE_CRASH_REPORT_UNATTENDED can be added to target.cs or UBT commandline in order to set CRASH_REPORT_UNATTENDED_ONLY
// It should not be defined in code other than when undefined to please IntelliSense.
#ifndef FORCE_CRASH_REPORT_UNATTENDED
#define FORCE_CRASH_REPORT_UNATTENDED 0
#endif
 
#define CRASH_REPORT_UNATTENDED_ONLY                FORCE_CRASH_REPORT_UNATTENDED
 
class FConfigFile;
 
struct FFullCrashDumpEntry
{
    FFullCrashDumpEntry( const FString& InBranchName, const FString& InLocation, const bool bInExactMatch )
        : BranchName( InBranchName )
        , Location( InLocation )
        , bExactMatch( bInExactMatch )
    {}
 
 
    const FString BranchName;
 
    const FString Location;
 
    const bool bExactMatch;
};
 
struct FCrashReportCoreConfig
{
    static FCrashReportCoreConfig& Get()
    {
        static FCrashReportCoreConfig Instance;
        return Instance;
    }
 
    FCrashReportCoreConfig();
 
    const FString& GetVersion() const
    {
        return CrashReportClientVersion;
    }
 
    const FString& GetReceiverAddress() const
    {
        return CrashReportReceiverIP;
    }
 
    const FString& GetDataRouterURL() const
    {
        return DataRouterUrl;
    }
 
    const FString& GetDataRouterUnixSocket() const
    {
        return DataRouterUnixSocket;
    }
 
    const FString& GetDiagnosticsFilename() const
    {
        return DiagnosticsFilename;
    }
 
    bool GetAllowToBeContacted() const
    {
        return bAllowToBeContacted;
    }
 
    bool GetHideAllowToBeContactedOption() const
    {
        return bHideAllowToBeContactedOption;
    }
 
    bool GetSendLogFile() const
    {
        return bSendLogFile;
    }
 
    bool GetHideLogFilesOption() const
    {
        return bHideLogFilesOption;
    }
 
    bool GetHideRestartOption() const
    {
        return bHideRestartOption;
    }
 
    bool IsAllowedToCloseWithoutSending() const
    {
        return bIsAllowedToCloseWithoutSending;
    }
 
    bool IsAllowedToSendWithoutDetailedInfo() const
    {
        return bIsAllowedToSendWithoutDetailedInfo;
    }
 
    bool GetShowEndpointInTooltip() const
    {
        return bShowEndpointInTooltip;
    }
 
    const FString& GetCompanyName() const
    {
        return CompanyName;
    }
 
#if PLATFORM_WINDOWS
    bool IsAllowedToCopyFilesToClipboard() const
    {
        return bIsAllowedToCopyFilesToClipboard;
    }
#endif
 
    int GetUserCommentSizeLimit() const
    {
        return UserCommentSizeLimit;
    }
 
    void SetAllowToBeContacted( bool bNewValue );
    void SetSendLogFile( bool bNewValue );
 
 
    void ApplyProjectOverrides(const FString& ConfigFilePath);
 
    void SetProjectConfigOverrides(const FConfigFile& InConfigFile);
 
    FString GetFullCrashDumpLocationForBranch(const FString& BranchName) const;
 
    void PrintSettingsToLog() const;
 
protected:
    void ReadFullCrashDumpConfigurations();
 
    FString CrashReportClientVersion;
 
    FString CrashReportReceiverIP;
 
    FString DataRouterUrl;
 
    FString DataRouterUnixSocket;
 
    FString DiagnosticsFilename;
 
    FString SectionName;
 
    TArray<FFullCrashDumpEntry> FullCrashDumpConfigurations;
 
    bool bAllowToBeContacted;
 
    bool bHideAllowToBeContactedOption;
 
    bool bSendLogFile;
 
    bool bHideLogFilesOption;
 
    bool bHideRestartOption;
 
    bool bIsAllowedToCloseWithoutSending;
 
    bool bIsAllowedToSendWithoutDetailedInfo;
 
    FString CompanyName;
 
    bool bShowEndpointInTooltip;
 
#if PLATFORM_WINDOWS
    bool bIsAllowedToCopyFilesToClipboard;
#endif
 
    int UserCommentSizeLimit;
};