-
Notifications
You must be signed in to change notification settings - Fork 41
/
NodeDocsGenerator.cpp
592 lines (480 loc) · 16.8 KB
/
NodeDocsGenerator.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
// Copyright (C) 2016-2017 Cameron Angus. All Rights Reserved.
#pragma once
#include "NodeDocsGenerator.h"
#include "KantanDocGenLog.h"
#include "SGraphNode.h"
#include "SGraphPanel.h"
#include "NodeFactory.h"
#include "EdGraphSchema_K2.h"
#include "Kismet2/BlueprintEditorUtils.h"
#include "Kismet2/KismetEditorUtilities.h"
#include "BlueprintActionDatabase.h"
#include "BlueprintNodeSpawner.h"
#include "BlueprintFunctionNodeSpawner.h"
#include "BlueprintBoundNodeSpawner.h"
#include "BlueprintComponentNodeSpawner.h"
#include "BlueprintEventNodeSpawner.h"
#include "K2Node_DynamicCast.h"
#include "K2Node_Message.h"
#include "HighResScreenshot.h"
#include "XmlFile.h"
#include "Slate/WidgetRenderer.h"
#include "Engine/TextureRenderTarget2D.h"
#include "TextureResource.h"
#include "ThreadingHelpers.h"
#include "Stats/StatsMisc.h"
#include "Runtime/ImageWriteQueue/Public/ImageWriteTask.h"
FNodeDocsGenerator::~FNodeDocsGenerator()
{
CleanUp();
}
bool FNodeDocsGenerator::GT_Init(FString const& InDocsTitle, FString const& InOutputDir, UClass* BlueprintContextClass)
{
DummyBP = CastChecked< UBlueprint >(FKismetEditorUtilities::CreateBlueprint(
BlueprintContextClass,
::GetTransientPackage(),
NAME_None,
EBlueprintType::BPTYPE_Normal,
UBlueprint::StaticClass(),
UBlueprintGeneratedClass::StaticClass(),
NAME_None
));
if(!DummyBP.IsValid())
{
return false;
}
Graph = FBlueprintEditorUtils::CreateNewGraph(DummyBP.Get(), TEXT("TempoGraph"), UEdGraph::StaticClass(), UEdGraphSchema_K2::StaticClass());
DummyBP->AddToRoot();
Graph->AddToRoot();
GraphPanel = SNew(SGraphPanel)
.GraphObj(Graph.Get())
;
// We want full detail for rendering, passing a super-high zoom value will guarantee the highest LOD.
GraphPanel->RestoreViewSettings(FVector2D(0, 0), 10.0f);
DocsTitle = InDocsTitle;
IndexXml = InitIndexXml(DocsTitle);
ClassDocsMap.Empty();
OutputDir = InOutputDir;
return true;
}
UK2Node* FNodeDocsGenerator::GT_InitializeForSpawner(UBlueprintNodeSpawner* Spawner, UObject* SourceObject, FNodeProcessingState& OutState)
{
if(!IsSpawnerDocumentable(Spawner, SourceObject->IsA< UBlueprint >()))
{
return nullptr;
}
// Spawn an instance into the graph
auto NodeInst = Spawner->Invoke(Graph.Get(), IBlueprintNodeBinder::FBindingSet{}, FVector2D(0, 0));
// Currently Blueprint nodes only
auto K2NodeInst = Cast< UK2Node >(NodeInst);
if(K2NodeInst == nullptr)
{
UE_LOG(LogKantanDocGen, Warning, TEXT("Failed to create node from spawner of class %s with node class %s."), *Spawner->GetClass()->GetName(), Spawner->NodeClass ? *Spawner->NodeClass->GetName() : TEXT("None"));
return nullptr;
}
auto AssociatedClass = MapToAssociatedClass(K2NodeInst, SourceObject);
if(!ClassDocsMap.Contains(AssociatedClass))
{
// New class xml file needs adding
ClassDocsMap.Add(AssociatedClass, InitClassDocXml(AssociatedClass));
// Also update the index xml
UpdateIndexDocWithClass(IndexXml.Get(), AssociatedClass);
}
OutState = FNodeProcessingState();
OutState.ClassDocXml = ClassDocsMap.FindChecked(AssociatedClass);
OutState.ClassDocsPath = OutputDir / GetClassDocId(AssociatedClass);
return K2NodeInst;
}
bool FNodeDocsGenerator::GT_Finalize(FString OutputPath)
{
if(!SaveClassDocXml(OutputPath))
{
return false;
}
if(!SaveIndexXml(OutputPath))
{
return false;
}
return true;
}
void FNodeDocsGenerator::CleanUp()
{
if(GraphPanel.IsValid())
{
GraphPanel.Reset();
}
if(DummyBP.IsValid())
{
DummyBP->RemoveFromRoot();
DummyBP.Reset();
}
if(Graph.IsValid())
{
Graph->RemoveFromRoot();
Graph.Reset();
}
}
bool FNodeDocsGenerator::GenerateNodeImage(UEdGraphNode* Node, FNodeProcessingState& State)
{
SCOPE_SECONDS_COUNTER(GenerateNodeImageTime);
const FVector2D DrawSize(1024.0f, 1024.0f);
bool bSuccess = false;
AdjustNodeForSnapshot(Node);
FString NodeName = GetNodeDocId(Node);
FIntRect Rect;
TUniquePtr<TImagePixelData<FColor>> PixelData;
bSuccess = DocGenThreads::RunOnGameThreadRetVal([this, Node, DrawSize, &Rect, &PixelData]
{
auto NodeWidget = FNodeFactory::CreateNodeWidget(Node);
NodeWidget->SetOwner(GraphPanel.ToSharedRef());
const bool bUseGammaCorrection = false;
FWidgetRenderer Renderer(bUseGammaCorrection);
Renderer.SetIsPrepassNeeded(true);
auto RenderTarget = Renderer.DrawWidget(NodeWidget.ToSharedRef(), DrawSize);
auto Desired = NodeWidget->GetDesiredSize();
FTextureRenderTargetResource* RTResource = RenderTarget->GameThread_GetRenderTargetResource();
Rect = FIntRect(0, 0, (int32)Desired.X, (int32)Desired.Y);
FReadSurfaceDataFlags ReadPixelFlags(RCM_UNorm);
ReadPixelFlags.SetLinearToGamma(true); // @TODO: is this gamma correction, or something else?
PixelData = MakeUnique<TImagePixelData<FColor>>(FIntPoint((int32)Desired.X, (int32)Desired.Y));
if(RTResource->ReadPixelsPtr(PixelData->Pixels.GetData(), ReadPixelFlags, Rect) == false)
{
UE_LOG(LogKantanDocGen, Warning, TEXT("Failed to read pixels for node image."));
return false;
}
return true;
});
if(!bSuccess)
{
return false;
}
State.RelImageBasePath = TEXT("../img");
FString ImageBasePath = State.ClassDocsPath / TEXT("img");// State.RelImageBasePath;
FString ImgFilename = FString::Printf(TEXT("nd_img_%s.png"), *NodeName);
FString ScreenshotSaveName = ImageBasePath / ImgFilename;
TUniquePtr<FImageWriteTask> ImageTask = MakeUnique<FImageWriteTask>();
ImageTask->PixelData = MoveTemp(PixelData);
ImageTask->Filename = ScreenshotSaveName;
ImageTask->Format = EImageFormat::PNG;
ImageTask->CompressionQuality = (int32)EImageCompressionQuality::Default;
ImageTask->bOverwriteFile = true;
ImageTask->PixelPreProcessors.Add(TAsyncAlphaWrite<FColor>(255));
if(ImageTask->RunTask())
{
// Success!
bSuccess = true;
State.ImageFilename = ImgFilename;
}
else
{
UE_LOG(LogKantanDocGen, Warning, TEXT("Failed to save screenshot image for node: %s"), *NodeName);
}
return bSuccess;
}
inline FString WrapAsCDATA(FString const& InString)
{
return TEXT("<![CDATA[") + InString + TEXT("]]>");
}
inline FXmlNode* AppendChild(FXmlNode* Parent, FString const& Name)
{
Parent->AppendChildNode(Name, FString());
return Parent->GetChildrenNodes().Last();
}
inline FXmlNode* AppendChildRaw(FXmlNode* Parent, FString const& Name, FString const& TextContent)
{
Parent->AppendChildNode(Name, TextContent);
return Parent->GetChildrenNodes().Last();
}
inline FXmlNode* AppendChildCDATA(FXmlNode* Parent, FString const& Name, FString const& TextContent)
{
Parent->AppendChildNode(Name, WrapAsCDATA(TextContent));
return Parent->GetChildrenNodes().Last();
}
// For K2 pins only!
bool ExtractPinInformation(UEdGraphPin* Pin, FString& OutName, FString& OutType, FString& OutDescription)
{
FString Tooltip;
Pin->GetOwningNode()->GetPinHoverText(*Pin, Tooltip);
if(!Tooltip.IsEmpty())
{
// @NOTE: This is based on the formatting in UEdGraphSchema_K2::ConstructBasicPinTooltip.
// If that is changed, this will fail!
auto TooltipPtr = *Tooltip;
// Parse name line
FParse::Line(&TooltipPtr, OutName);
// Parse type line
FParse::Line(&TooltipPtr, OutType);
// Currently there is an empty line here, but FParse::Line seems to gobble up empty lines as part of the previous call.
// Anyway, attempting here to deal with this generically in case that weird behaviour changes.
while(*TooltipPtr == TEXT('\n'))
{
FString Buf;
FParse::Line(&TooltipPtr, Buf);
}
// What remains is the description
OutDescription = TooltipPtr;
}
// @NOTE: Currently overwriting the name and type as suspect this is more robust to future engine changes.
OutName = Pin->GetDisplayName().ToString();
if(OutName.IsEmpty() && Pin->PinType.PinCategory == UEdGraphSchema_K2::PC_Exec)
{
OutName = Pin->Direction == EEdGraphPinDirection::EGPD_Input ? TEXT("In") : TEXT("Out");
}
OutType = UEdGraphSchema_K2::TypeToText(Pin->PinType).ToString();
return true;
}
TSharedPtr< FXmlFile > FNodeDocsGenerator::InitIndexXml(FString const& IndexTitle)
{
const FString FileTemplate = R"xxx(<?xml version="1.0" encoding="UTF-8"?>
<root></root>)xxx";
TSharedPtr< FXmlFile > File = MakeShared< FXmlFile >(FileTemplate, EConstructMethod::ConstructFromBuffer);
auto Root = File->GetRootNode();
AppendChildCDATA(Root, TEXT("display_name"), IndexTitle);
AppendChild(Root, TEXT("classes"));
return File;
}
TSharedPtr< FXmlFile > FNodeDocsGenerator::InitClassDocXml(UClass* Class)
{
const FString FileTemplate = R"xxx(<?xml version="1.0" encoding="UTF-8"?>
<root></root>)xxx";
TSharedPtr< FXmlFile > File = MakeShared< FXmlFile >(FileTemplate, EConstructMethod::ConstructFromBuffer);
auto Root = File->GetRootNode();
AppendChildCDATA(Root, TEXT("docs_name"), DocsTitle);
AppendChildCDATA(Root, TEXT("id"), GetClassDocId(Class));
AppendChildCDATA(Root, TEXT("display_name"), FBlueprintEditorUtils::GetFriendlyClassDisplayName(Class).ToString());
AppendChild(Root, TEXT("nodes"));
return File;
}
bool FNodeDocsGenerator::UpdateIndexDocWithClass(FXmlFile* DocFile, UClass* Class)
{
auto ClassId = GetClassDocId(Class);
auto Classes = DocFile->GetRootNode()->FindChildNode(TEXT("classes"));
auto ClassElem = AppendChild(Classes, TEXT("class"));
AppendChildCDATA(ClassElem, TEXT("id"), ClassId);
AppendChildCDATA(ClassElem, TEXT("display_name"), FBlueprintEditorUtils::GetFriendlyClassDisplayName(Class).ToString());
return true;
}
bool FNodeDocsGenerator::UpdateClassDocWithNode(FXmlFile* DocFile, UEdGraphNode* Node)
{
auto NodeId = GetNodeDocId(Node);
auto Nodes = DocFile->GetRootNode()->FindChildNode(TEXT("nodes"));
auto NodeElem = AppendChild(Nodes, TEXT("node"));
AppendChildCDATA(NodeElem, TEXT("id"), NodeId);
AppendChildCDATA(NodeElem, TEXT("shorttitle"), Node->GetNodeTitle(ENodeTitleType::ListView).ToString());
return true;
}
inline bool ShouldDocumentPin(UEdGraphPin* Pin)
{
return !Pin->bHidden;
}
bool FNodeDocsGenerator::GenerateNodeDocs(UK2Node* Node, FNodeProcessingState& State)
{
SCOPE_SECONDS_COUNTER(GenerateNodeDocsTime);
auto NodeDocsPath = State.ClassDocsPath / TEXT("nodes");
FString DocFilePath = NodeDocsPath / (GetNodeDocId(Node) + TEXT(".xml"));
const FString FileTemplate = R"xxx(<?xml version="1.0" encoding="UTF-8"?>
<root></root>)xxx";
FXmlFile File(FileTemplate, EConstructMethod::ConstructFromBuffer);
auto Root = File.GetRootNode();
AppendChildCDATA(Root, TEXT("docs_name"), DocsTitle);
// Since we pull these from the class xml file, the entries are already CDATA wrapped
AppendChildRaw(Root, TEXT("class_id"), State.ClassDocXml->GetRootNode()->FindChildNode(TEXT("id"))->GetContent());//GetClassDocId(Class));
AppendChildRaw(Root, TEXT("class_name"), State.ClassDocXml->GetRootNode()->FindChildNode(TEXT("display_name"))->GetContent());// FBlueprintEditorUtils::GetFriendlyClassDisplayName(Class).ToString());
FString NodeShortTitle = Node->GetNodeTitle(ENodeTitleType::ListView).ToString();
AppendChildCDATA(Root, TEXT("shorttitle"), NodeShortTitle.TrimEnd());
FString NodeFullTitle = Node->GetNodeTitle(ENodeTitleType::FullTitle).ToString();
auto TargetIdx = NodeFullTitle.Find(TEXT("Target is "), ESearchCase::CaseSensitive);
if(TargetIdx != INDEX_NONE)
{
NodeFullTitle = NodeFullTitle.Left(TargetIdx).TrimEnd();
}
AppendChildCDATA(Root, TEXT("fulltitle"), NodeFullTitle);
FString NodeDesc = Node->GetTooltipText().ToString();
TargetIdx = NodeDesc.Find(TEXT("Target is "), ESearchCase::CaseSensitive);
if(TargetIdx != INDEX_NONE)
{
NodeDesc = NodeDesc.Left(TargetIdx).TrimEnd();
}
AppendChildCDATA(Root, TEXT("description"), NodeDesc);
AppendChildCDATA(Root, TEXT("imgpath"), State.RelImageBasePath / State.ImageFilename);
AppendChildCDATA(Root, TEXT("category"), Node->GetMenuCategory().ToString());
auto Inputs = AppendChild(Root, TEXT("inputs"));
for(auto Pin : Node->Pins)
{
if(Pin->Direction == EEdGraphPinDirection::EGPD_Input)
{
if(ShouldDocumentPin(Pin))
{
auto Input = AppendChild(Inputs, TEXT("param"));
FString PinName, PinType, PinDesc;
ExtractPinInformation(Pin, PinName, PinType, PinDesc);
AppendChildCDATA(Input, TEXT("name"), PinName);
AppendChildCDATA(Input, TEXT("type"), PinType);
AppendChildCDATA(Input, TEXT("description"), PinDesc);
}
}
}
auto Outputs = AppendChild(Root, TEXT("outputs"));
for(auto Pin : Node->Pins)
{
if(Pin->Direction == EEdGraphPinDirection::EGPD_Output)
{
if(ShouldDocumentPin(Pin))
{
auto Output = AppendChild(Outputs, TEXT("param"));
FString PinName, PinType, PinDesc;
ExtractPinInformation(Pin, PinName, PinType, PinDesc);
AppendChildCDATA(Output, TEXT("name"), PinName);
AppendChildCDATA(Output, TEXT("type"), PinType);
AppendChildCDATA(Output, TEXT("description"), PinDesc);
}
}
}
if(!File.Save(DocFilePath))
{
return false;
}
if(!UpdateClassDocWithNode(State.ClassDocXml.Get(), Node))
{
return false;
}
return true;
}
bool FNodeDocsGenerator::SaveIndexXml(FString const& OutDir)
{
auto Path = OutDir / TEXT("index.xml");
IndexXml->Save(Path);
return true;
}
bool FNodeDocsGenerator::SaveClassDocXml(FString const& OutDir)
{
for(auto const& Entry : ClassDocsMap)
{
auto ClassId = GetClassDocId(Entry.Key.Get());
auto Path = OutDir / ClassId / (ClassId + TEXT(".xml"));
Entry.Value->Save(Path);
}
return true;
}
void FNodeDocsGenerator::AdjustNodeForSnapshot(UEdGraphNode* Node)
{
// Hide default value box containing 'self' for Target pin
if(auto K2_Schema = Cast< UEdGraphSchema_K2 >(Node->GetSchema()))
{
if(auto TargetPin = Node->FindPin(K2_Schema->PN_Self))
{
TargetPin->bDefaultValueIsIgnored = true;
}
}
}
FString FNodeDocsGenerator::GetClassDocId(UClass* Class)
{
return Class->GetName();
}
FString FNodeDocsGenerator::GetNodeDocId(UEdGraphNode* Node)
{
// @TODO: Not sure this is right thing to use
return Node->GetDocumentationExcerptName();
}
#include "BlueprintVariableNodeSpawner.h"
#include "BlueprintDelegateNodeSpawner.h"
#include "K2Node_CallFunction.h"
#include "K2Node_DynamicCast.h"
/*
This takes a graph node object and attempts to map it to the class which the node conceptually belong to.
If there is no special mapping for the node, the function determines the class from the source object.
*/
UClass* FNodeDocsGenerator::MapToAssociatedClass(UK2Node* NodeInst, UObject* Source)
{
// For nodes derived from UK2Node_CallFunction, associate with the class owning the called function.
if(auto FuncNode = Cast< UK2Node_CallFunction >(NodeInst))
{
auto Func = FuncNode->GetTargetFunction();
if(Func)
{
return Func->GetOwnerClass();
}
}
// Default fallback
if(auto SourceClass = Cast< UClass >(Source))
{
return SourceClass;
}
else if(auto SourceBP = Cast< UBlueprint >(Source))
{
return SourceBP->GeneratedClass;
}
else
{
return nullptr;
}
}
bool FNodeDocsGenerator::IsSpawnerDocumentable(UBlueprintNodeSpawner* Spawner, bool bIsBlueprint)
{
// Spawners of or deriving from the following classes will be excluded
static const TSubclassOf< UBlueprintNodeSpawner > ExcludedSpawnerClasses[] = {
UBlueprintVariableNodeSpawner::StaticClass(),
UBlueprintDelegateNodeSpawner::StaticClass(),
UBlueprintBoundNodeSpawner::StaticClass(),
UBlueprintComponentNodeSpawner::StaticClass(),
};
// Spawners of or deriving from the following classes will be excluded in a blueprint context
static const TSubclassOf< UBlueprintNodeSpawner > BlueprintOnlyExcludedSpawnerClasses[] = {
UBlueprintEventNodeSpawner::StaticClass(),
};
// Spawners for nodes of these types (or their subclasses) will be excluded
static const TSubclassOf< UK2Node > ExcludedNodeClasses[] = {
UK2Node_DynamicCast::StaticClass(),
UK2Node_Message::StaticClass(),
};
// Function spawners for functions with any of the following metadata tags will also be excluded
static const FName ExcludedFunctionMeta[] = {
TEXT("BlueprintAutocast")
};
static const uint32 PermittedAccessSpecifiers = (FUNC_Public | FUNC_Protected);
for(auto ExclSpawnerClass : ExcludedSpawnerClasses)
{
if(Spawner->IsA(ExclSpawnerClass))
{
return false;
}
}
if(bIsBlueprint)
{
for(auto ExclSpawnerClass : BlueprintOnlyExcludedSpawnerClasses)
{
if(Spawner->IsA(ExclSpawnerClass))
{
return false;
}
}
}
for(auto ExclNodeClass : ExcludedNodeClasses)
{
if(Spawner->NodeClass->IsChildOf(ExclNodeClass))
{
return false;
}
}
if(auto FuncSpawner = Cast< UBlueprintFunctionNodeSpawner >(Spawner))
{
auto Func = FuncSpawner->GetFunction();
// @NOTE: We exclude based on access level, but only if this is not a spawner for a blueprint event
// (custom events do not have any access specifiers)
if((Func->FunctionFlags & FUNC_BlueprintEvent) == 0 && (Func->FunctionFlags & PermittedAccessSpecifiers) == 0)
{
return false;
}
for(auto const& Meta : ExcludedFunctionMeta)
{
if(Func->HasMetaData(Meta))
{
return false;
}
}
}
return true;
}