FCompilerResultsLog

Syntax

class FCompilerResultsLog

Remarks

This class represents a log of compiler output lines (errors, warnings, and information notes), each of which can be a rich tokenized message

Variables

Name Description

Public variable

TSet < TWeakObje ...

 

AnnotatedNodes

Tracks nodes that produced errors/warnings

Public variable

bool

 

bAnnotateMentionedNodes

Should nodes mentioned in messages be annotated for display with that message?

Public variable

bool

 

bLogDetailedResults

Should detailed results be appended to the final summary log?

Public variable

bool

 

bLogInfoOnly

Should we log only Info messages, or all messages?

Public variable

bool

 

bSilentMode

Should we be silent?

Public variable

int

 

EventDisplayThresholdMs

Minimum event time (ms) for inclusion into the final summary log.

Protected variable

TMap < TWeakObje ...

 

FullMacroBacktrackMap

Map to track intermediate nodes back to the source macro instance nodes.

Protected variable

TMap < TWeakObje ...

 

IntermediateTunnelNodeToTunnelInstanceMap

Map to track intermediate tunnel nodes back to the intermediate expansion tunnel instance.

Public variable

TArray < TShared ...

 

Messages

List of all tokenized messages.

Public variable

int32

 

NumErrors

Number of error messages.

Public variable

int32

 

NumWarnings

Number of warnings.

Protected variable

FBacktrackMap

 

SourceBacktrackMap

Maps from transient object created during compiling to original 'source code' object.

Protected variable

FString

 

SourcePath

Name of the source object being compiled.

Constructors

Name Description

Public function

FCompilerResultsLog

(
    bool bIsCompatibleWithEvents
)

Destructors

Name Description

Public function Virtual

~FCompilerResultsLog()

Functions

Name Description

Protected function

void

 

AddChildEvent

(
    TSharedPtr < FCompilerEvent >& Pare...,
    TSharedRef < FCompilerEvent >& Chil...
)

Helper method to add a child event to the given parent event scope

Public function

void

 

AddTokenizedMessage

(
    TSharedRef < FTokenizedMessage > InM...
)

Store an already tokenized message.

Protected function

void

 

AnnotateNode

(
    const TArray < UEdGraphNode * > ...,
    TSharedRef < FTokenizedMessage > Log...
)

Links the UEdGraphNode with the LogLine:

Public function

void

 

Append

(
    FCompilerResultsLog const& Other
)

Public function

void

 

BeginEvent

(
    const TCHAR * InName
)

Begin a new compiler event

Public function

int32

 

CalculateStableIdentifierForLatentActionManager

(
    const UEdGraphNode * Node
)

Returns a int32 used to uniquely identify an action for the latent action manager

Public function

bool

 

CommitPotentialMessages

(
    UEdGraphNode * Source
)

Commit all stored potential messages for a given node. Returns true if any messages were written.

Public function

void

 

EndEvent()

End the current compiler event

Public function

TSharedRef < ...

 

Error

(
    const TCHAR * Format,
    Args... args
)

Write an error in to the compiler log.

Public function

UObject *...

 

FindSourceMacroInstance

(
    const UEdGraphNode * Intermedia...
)

Public function

UObject cons...

 

FindSourceObject

(
    UObject const* PossiblyDuplica...
)

Returns the true source object for the passed in object

Public function

UObject *...

 

FindSourceObject

(
    UObject * PossiblyDuplicatedObj...
)

Returns the true source object for the passed in object

Public function

T const *...

 

FindSourceObjectTypeChecked

(
    UObject const* PossiblyDuplica...
)

Public function

T *

 

FindSourceObjectTypeChecked

(
    UObject * PossiblyDuplicatedObj...
)

Returns the true source object for the passed in object; does type checking on the result

Public function

const UEdGra ...

 

FindSourcePin

(
    const UEdGraphPin * PossiblyDup...
)

Public function

UEdGraphPin ...

 

FindSourcePin

(
    UEdGraphPin * PossiblyDuplicate...
)

Public function Static

TSharedRef < ...

 

GetBlueprintMessageLog

(
    UBlueprint * InBlueprint
)

Get the message log listing for this blueprint

Public function Static

FCompilerRes ...

 

GetEventTarget()

Access the current event target log

Public function

const UEdGra ...

 

GetIntermediateTunnelInstance

(
    const UEdGraphNode * Intermedia...
)

Returns the intermediate tunnel instance that generated the node

Public function Static

FName

 

GetLogName()

Accessor for the LogName, so it can be opened elsewhere

Protected function

void

 

InternalLogEvent

(
    const FCompilerEvent& InEvent,
    int32 InDepth
)

Internal helper method to recursively append event details into the MessageLog

Protected function

void

 

InternalLogMessage

(
    FName MessageID,
    const TCHAR * Format,
    const TSharedRef < FTokenizedMessage ...,
    Args... args
)

Protected function

void

 

InternalLogMessage

(
    FName MessageID,
    const TSharedRef < FTokenizedMessage ...,
    const TArray < UEdGraphNode * > ...
)

Protected function

void

 

InternalLogSummary()

Internal method to append the final compiler results summary to the MessageLog

Protected function

bool

 

IsMessageEnabled

(
    FName ID
)

Returns true if the user has requested this compiler message be suppressed

Public function

TSharedRef < ...

 

Note

(
    const TCHAR * Format,
    Args... args
)

Write a note in to the compiler log.

Public function

void

 

NotifyIntermediateMacroNode

(
    UEdGraphNode * SourceNode,
    const UEdGraphNode * Intermedia...
)

Update the map that tracks nodes created by macro instance nodes

Public function

void

 

NotifyIntermediateObjectCreation

(
    UObject * NewObject,
    UObject * SourceObject
)

Update the source backtrack map to note that NewObject was most closely generated/caused by the SourceObject

Public function

void

 

NotifyIntermediatePinCreation

(
    UEdGraphPin * NewObject,
    UEdGraphPin * SourceObject
)

Public function

void

 

NotifyIntermediateTunnelNode

(
    const UEdGraphNode * Node,
    const UEdGraphNode * OuterTunne...
)

Update the expansion map to note that Node was expanded from OuterTunnelInstance, both the node and tunnel instance should be intermediate nodes

Public function Static

void

 

Register()

Register this log with the MessageLog module

Public function

void

 

SetSourcePath

(
    const FString & InSourcePath
)

Set the source name for the final log summary

Public function

TSharedRef < ...

 

StorePotentialError

(
    const UEdGraphNode * Source,
    const TCHAR * Format,
    Args... args
)

Store a potential error for a given node in the compiler log.

Public function

TSharedRef < ...

 

StorePotentialNote

(
    const UEdGraphNode * Source,
    const TCHAR * Format,
    Args... args
)

Store a potential note for a given node in the compiler log.

Public function

TSharedRef < ...

 

StorePotentialWarning

(
    const UEdGraphNode * Source,
    const TCHAR * Format,
    Args... args
)

Store a potential warning for a given node in the compiler log.

Protected function

void

 

Tokenize

(
    const TCHAR * Text,
    FTokenizedMessage & OutMessage,
    TArray < UEdGraphNode * >& OutS...
)

Protected function

void

 

Tokenize

(
    const TCHAR * Format,
    FTokenizedMessage & OutMessage,
    TArray < UEdGraphNode * >& OutS...,
    T First,
    Args... Rest
)

Public function Static

void

 

Unregister()

Unregister this log from the MessageLog module

Public function

TSharedRef < ...

 

Warning

(
    const TCHAR * Format,
    Args... args
)

Write a warning in to the compiler log.

Public function

void

 

Warning

(
    FName ID,
    const TCHAR * Format,
    Args... args
)

Write a warning in to the compiler log.

Constants

Name

Description

CurrentEventTarget

The log target for compile events

GetGlobalModuleCompilerDumpDelegateHandle

Handle to the registered GetGlobalModuleCompilerDump delegate.

Name

The log's name, for easy re-use

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/Kismet2/CompilerResultsLog.h