OutputDeviceHelper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/StringFwd.h"
#include "Logging/LogVerbosity.h"
#include "Misc/OutputDevice.h"
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_1
#include "Containers/UnrealString.h"
#endif
 
class FArchive;
class FName;
class FString;
 
/** Helper functions used by FOutputDevice derived classes **/
struct FOutputDeviceHelper
{
    /** Append a formatted log line to the string builder. */
    static void AppendFormatLogLine(FWideStringBuilderBase& Output, ELogVerbosity::Type Verbosity, const FName& Category, const TCHAR* Message = nullptr, ELogTimes::Type LogTime = ELogTimes::None, double Time = -1.0, int32* OutCategoryIndex = nullptr);
    static void AppendFormatLogLine(FUtf8StringBuilderBase& Output, ELogVerbosity::Type Verbosity, const FName& Category, const TCHAR* Message = nullptr, ELogTimes::Type LogTime = ELogTimes::None, double Time = -1.0, int32* OutCategoryIndex = nullptr);
 
    /**
     * Formats a log line with date, time, category and verbosity prefix
     * @param Verbosity Message verbosity
     * @param Category Message category
     * @param Message Optional message text. If nullptr, only the date/time/category/verbosity prefix will be returned
     * @param LogTime Time format
     * @param Time Time in seconds
     * @param OutCategoryIndex (if non-null) The index of the category within the return string is written here, or INDEX_NONE if the category is suppressed
     * @returns Formatted log line
     */
    static FString FormatLogLine(ELogVerbosity::Type Verbosity, const FName& Category, const TCHAR* Message = nullptr, ELogTimes::Type LogTime = ELogTimes::None, double Time = -1.0, int32* OutCategoryIndex = nullptr);
 
    /**
     * Formats, casts to ANSI char and serializes a message to archive. Optimized for small number of allocations and Serialize calls
     * @param Output Output archive 
     * @param Message Log message
     * @param Verbosity Message verbosity
     * @param Category Message category
     * @param Time Message time
     * @param bSuppressEventTag True if the message date/time prefix should be suppressed
     * @param bAutoEmitLineTerminator True if the message should be automatically appended with a line terminator
     **/
    static void FormatCastAndSerializeLine(FArchive& Output, const TCHAR* Message, ELogVerbosity::Type Verbosity, const FName& Category, double Time, bool bSuppressEventTag, bool bAutoEmitLineTerminator);
};