DiagnosticTable.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
    DiagnosticTable.h: Diagnostic table implementation
=============================================================================*/
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/VarArgs.h"
#include "Misc/AssertionMacros.h"
#include "Templates/UnrealTemplate.h"
#include "Containers/UnrealString.h"
#include "Misc/DateTime.h"
#include "HAL/PlatformProcess.h"
#include "HAL/FileManager.h"
#include "Misc/Paths.h"
 
#if ALLOW_DEBUG_FILES
 
class FDiagnosticTableWriterCSV
{
public:
 
    FDiagnosticTableWriterCSV(FArchive* InOutputStream)
    :   OutputStream(InOutputStream)
    {}
 
    ~FDiagnosticTableWriterCSV()
    {
        // Ensure the user flushed the last row to the output.
        check(!CurrentRow.Len());
 
        // Close the output stream.
        Close();
    }
 
    void AddColumn(const TCHAR* Format,...)
    {
        check(OutputStream);
 
        // Format the input string.
        TCHAR ColumnText[4096];
        GET_TYPED_VARARGS(TCHAR,ColumnText,UE_ARRAY_COUNT(ColumnText),UE_ARRAY_COUNT(ColumnText)-1,Format,Format);
 
        // If this isn't the first column in the row, add a comma to separate the columns.
        if(CurrentRow.Len())
        {
            CurrentRow += TEXT(',');
        }
 
        // Replace quotes in the column with doubles quotes.
        FString EscapedText = ColumnText;
        EscapedText = EscapedText.Replace(TEXT("\""),TEXT("\"\""));
 
        // Append the enquoted column to the current row.
        CurrentRow += TEXT('\"');
        CurrentRow += EscapedText;
        CurrentRow += TEXT('\"');
    }
 
    void CycleRow()
    {
        check(OutputStream);
 
        // Write the current row to the output stream.
        OutputStream->Logf(TEXT("%s"),*CurrentRow);
 
        // Reset the current row.
        CurrentRow.Empty();
    }
 
    void Close()
    {
        if(OutputStream)
        {
            // Close the output stream.
            OutputStream->Close();
            OutputStream = NULL;
        }
    }
 
    bool OutputStreamIsValid()
    {
        return (OutputStream != NULL);
    }
 
private:
 
    FString CurrentRow;
 
    FArchive* OutputStream;
};
 
class FDiagnosticTableViewer : public FDiagnosticTableWriterCSV
{
public:
 
    static FString GetUniqueTemporaryFilePath(const TCHAR* BaseName)
    {
        return FString::Printf(TEXT("%sLogs/%s-%s.csv"), *FPaths::ProjectDir(), BaseName, *FDateTime::Now().ToString());
    }
 
    FDiagnosticTableViewer(const TCHAR* InTemporaryFilePath, bool bInSuppressViewer = false)
    :   FDiagnosticTableWriterCSV(IFileManager::Get().CreateDebugFileWriter(InTemporaryFilePath))
    ,   bHasOpenedViewer(false)
    ,   bSuppressViewer(bInSuppressViewer)
    ,   TemporaryFilePath(InTemporaryFilePath)
    {}
 
    ~FDiagnosticTableViewer()
    {
        OpenViewer();
    }
 
    void OpenViewer()
    {
        if(FPlatformProperties::HasEditorOnlyData() && !bHasOpenedViewer && !bSuppressViewer)
        {
            bHasOpenedViewer = true;
 
            // Close the writer.
            Close();
 
            // Open the viewer.
            FPlatformProcess::LaunchURL(*FString::Printf(TEXT("%s"),*IFileManager::Get().ConvertToAbsolutePathForExternalAppForRead(*TemporaryFilePath)), NULL, NULL);
        }
    }
 
private:
    
    bool bHasOpenedViewer;
 
    bool bSuppressViewer;
 
    FString TemporaryFilePath;
};
 
#endif