K2Node_JsonDeserialize.cpp 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. // Copyright 2021-2022, DearBing. All Rights Reserved.
  2. #include "K2Node_JsonDeserialize.h"
  3. #include "Engine/UserDefinedStruct.h"
  4. #include "EdGraph/EdGraphPin.h"
  5. #include "EdGraphSchema_K2.h"
  6. #include "K2Node_CallFunction.h"
  7. #include "K2Node_IfThenElse.h"
  8. #include "Kismet2/BlueprintEditorUtils.h"
  9. #include "KismetCompiler.h"
  10. #include "BlueprintActionDatabaseRegistrar.h"
  11. #include "BlueprintNodeSpawner.h"
  12. #include "EditorCategoryUtils.h"
  13. #include "DBJsonBPLibrary.h"
  14. #include "Json.h"
  15. #define LOCTEXT_NAMESPACE "K2Node_JsonDeserialize"
  16. UK2Node_JsonDeserialize::UK2Node_JsonDeserialize( const FObjectInitializer& ObjectInitializer )
  17. : Super( ObjectInitializer )
  18. {
  19. NodeTooltip = LOCTEXT( "NodeTooltip", "Try to parse a JSON String into a structure." );
  20. }
  21. void UK2Node_JsonDeserialize::AllocateDefaultPins()
  22. {
  23. const UEdGraphSchema_K2* K2Schema = GetDefault<UEdGraphSchema_K2>();
  24. CreatePin( EGPD_Input, UEdGraphSchema_K2::PC_Exec, UEdGraphSchema_K2::PN_Execute );
  25. UEdGraphPin* SuccessPin = CreatePin( EGPD_Output, UEdGraphSchema_K2::PC_Exec, UEdGraphSchema_K2::PN_Then );
  26. SuccessPin->PinFriendlyName = LOCTEXT( "Success Exec pin", "Success" );
  27. UEdGraphPin* FailedPin = CreatePin( EGPD_Output, UEdGraphSchema_K2::PC_Exec, TEXT("Failed"));
  28. FailedPin->PinFriendlyName = LOCTEXT( "Failed Exec pin", "Failure" );
  29. // Input Json str
  30. UEdGraphPin* DataPin = CreatePin( EGPD_Input, UEdGraphSchema_K2::PC_String, TEXT("JsonStr"));
  31. SetPinToolTip( *DataPin, LOCTEXT( "DataPinDescription", "The JSON String to convert." ) );
  32. UEdGraphPin* ResultPin = CreatePin( EGPD_Output, UEdGraphSchema_K2::PC_Wildcard, UEdGraphSchema_K2::PN_ReturnValue );
  33. //ResultPin->bDisplayAsMutableRef = true;
  34. ResultPin->PinFriendlyName = LOCTEXT( "JsonStr to Struct Out Struct", "Structure" );
  35. SetPinToolTip( *ResultPin, LOCTEXT( "ResultPinDescription", "The returned structure, if converted." ) );
  36. UEdGraphPin* ErroInfoPin = CreatePin(EGPD_Output, UEdGraphSchema_K2::PC_String, TEXT("ErroInfo"));
  37. ErroInfoPin->PinFriendlyName = LOCTEXT("Convert Fail Info", "ErroInfo");
  38. SetPinToolTip(*ErroInfoPin, LOCTEXT("ResultPinDescription", "The returned Erro Info, if converted failed."));
  39. Super::AllocateDefaultPins();
  40. }
  41. void UK2Node_JsonDeserialize::SetPinToolTip( UEdGraphPin& MutatablePin, const FText& PinDescription ) const
  42. {
  43. MutatablePin.PinToolTip = UEdGraphSchema_K2::TypeToText( MutatablePin.PinType ).ToString();
  44. UEdGraphSchema_K2 const* const K2Schema = Cast<const UEdGraphSchema_K2>( GetSchema() );
  45. if ( K2Schema )
  46. {
  47. MutatablePin.PinToolTip += TEXT( " " );
  48. MutatablePin.PinToolTip += K2Schema->GetPinDisplayName( &MutatablePin ).ToString();
  49. }
  50. MutatablePin.PinToolTip += FString( TEXT( "\n" ) ) + PinDescription.ToString();
  51. }
  52. void UK2Node_JsonDeserialize::RefreshOutputPinType()
  53. {
  54. UEdGraphPin* ResultPin = GetResultPin();
  55. const bool bFillTypeFromConnected = ResultPin && ( ResultPin->PinType.PinCategory == UEdGraphSchema_K2::PC_Wildcard );
  56. UScriptStruct* OutputType = nullptr;
  57. if ( bFillTypeFromConnected )
  58. {
  59. FEdGraphPinType PinType = ResultPin->PinType;
  60. if ( ResultPin->LinkedTo.Num() > 0 )
  61. PinType = ResultPin->LinkedTo[ 0 ]->PinType;
  62. if ( PinType.PinCategory == UEdGraphSchema_K2::PC_Struct )
  63. OutputType = Cast<UScriptStruct>( PinType.PinSubCategoryObject.Get() );
  64. }
  65. SetReturnTypeForStruct( OutputType );
  66. }
  67. void UK2Node_JsonDeserialize::SetReturnTypeForStruct( UScriptStruct* StructType )
  68. {
  69. if ( StructType == GetReturnTypeForStruct() )
  70. return;
  71. UEdGraphPin* ResultPin = GetResultPin();
  72. if ( ResultPin->SubPins.Num() > 0 )
  73. GetSchema()->RecombinePin( ResultPin );
  74. ResultPin->PinType.PinSubCategoryObject = StructType;
  75. ResultPin->PinType.PinCategory = StructType ?
  76. UEdGraphSchema_K2::PC_Struct :
  77. UEdGraphSchema_K2::PC_Wildcard;
  78. CachedNodeTitle.Clear();
  79. }
  80. UScriptStruct* UK2Node_JsonDeserialize::GetReturnTypeForStruct() const
  81. {
  82. UScriptStruct* ReturnStructType = (UScriptStruct*)( GetResultPin()->PinType.PinSubCategoryObject.Get() );
  83. return ReturnStructType;
  84. }
  85. void UK2Node_JsonDeserialize::GetMenuActions( FBlueprintActionDatabaseRegistrar& ActionRegistrar ) const
  86. {
  87. UClass* ActionKey = GetClass();
  88. if ( ActionRegistrar.IsOpenForRegistration( ActionKey ) )
  89. {
  90. UBlueprintNodeSpawner* NodeSpawner = UBlueprintNodeSpawner::Create( GetClass() );
  91. check( NodeSpawner != nullptr );
  92. ActionRegistrar.AddBlueprintAction( ActionKey, NodeSpawner );
  93. }
  94. }
  95. FText UK2Node_JsonDeserialize::GetMenuCategory() const
  96. {
  97. return FText::FromString( TEXT( "DBJson" ) );
  98. }
  99. bool UK2Node_JsonDeserialize::IsConnectionDisallowed( const UEdGraphPin* MyPin, const UEdGraphPin* OtherPin, FString& OutReason ) const
  100. {
  101. if ( MyPin == GetResultPin() && MyPin->PinType.PinCategory == UEdGraphSchema_K2::PC_Wildcard )
  102. {
  103. bool bDisallowed = true;
  104. if ( OtherPin->PinType.PinCategory == UEdGraphSchema_K2::PC_Struct )
  105. {
  106. if ( UScriptStruct* ConnectionType = Cast<UScriptStruct>( OtherPin->PinType.PinSubCategoryObject.Get() ) )
  107. bDisallowed = false;
  108. }
  109. else if ( OtherPin->PinType.PinCategory == UEdGraphSchema_K2::PC_Wildcard )
  110. bDisallowed = false;
  111. if ( bDisallowed )
  112. OutReason = TEXT( "Must be a structure." );
  113. return bDisallowed;
  114. }
  115. return false;
  116. }
  117. FText UK2Node_JsonDeserialize::GetTooltipText() const
  118. {
  119. return NodeTooltip;
  120. }
  121. UEdGraphPin* UK2Node_JsonDeserialize::GetThenPin()const
  122. {
  123. const UEdGraphSchema_K2* K2Schema = GetDefault<UEdGraphSchema_K2>();
  124. UEdGraphPin* Pin = FindPinChecked( UEdGraphSchema_K2::PN_Then );
  125. check( Pin->Direction == EGPD_Output );
  126. return Pin;
  127. }
  128. UEdGraphPin* UK2Node_JsonDeserialize::GetDataPin() const
  129. {
  130. UEdGraphPin* Pin = FindPinChecked(TEXT("JsonStr"));
  131. check( Pin->Direction == EGPD_Input );
  132. return Pin;
  133. }
  134. UEdGraphPin* UK2Node_JsonDeserialize::GetFailedPin() const
  135. {
  136. UEdGraphPin* Pin = FindPinChecked(TEXT("Failed"));
  137. check( Pin->Direction == EGPD_Output );
  138. return Pin;
  139. }
  140. UEdGraphPin* UK2Node_JsonDeserialize::GetResultPin() const
  141. {
  142. const UEdGraphSchema_K2* K2Schema = GetDefault<UEdGraphSchema_K2>();
  143. UEdGraphPin* Pin = FindPin( UEdGraphSchema_K2::PN_ReturnValue );
  144. if (Pin == nullptr)
  145. {
  146. return nullptr;
  147. }
  148. check( Pin->Direction == EGPD_Output );
  149. return Pin;
  150. }
  151. FText UK2Node_JsonDeserialize::GetNodeTitle( ENodeTitleType::Type TitleType ) const
  152. {
  153. if ( TitleType == ENodeTitleType::MenuTitle )
  154. return LOCTEXT( "ListViewTitle", "JsonDeserialize" );
  155. if ( UEdGraphPin* ResultPin = GetResultPin() )
  156. {
  157. UScriptStruct* StructType = GetReturnTypeForStruct();
  158. if ( !StructType || ResultPin->LinkedTo.Num() == 0 )
  159. return NSLOCTEXT( "K2Node", "JsonDeserialize_Title_None", "JsonDeserialize Structure" );
  160. if ( CachedNodeTitle.IsOutOfDate( this ) )
  161. {
  162. FFormatNamedArguments Args;
  163. Args.Add( TEXT( "StructName" ), FText::FromName( StructType->GetFName() ) );
  164. FText LocFormat = NSLOCTEXT( "K2Node", "JsonDeserialize", "JsonDeserialize {StructName}" );
  165. CachedNodeTitle.SetCachedText( FText::Format( LocFormat, Args ), this );
  166. }
  167. }
  168. else
  169. return NSLOCTEXT( "K2Node", "JsonDeserialize_Title_None", "JsonDeserialize Structure" );
  170. return CachedNodeTitle;
  171. }
  172. void UK2Node_JsonDeserialize::ExpandNode( FKismetCompilerContext& CompilerContext, UEdGraph* SourceGraph )
  173. {
  174. Super::ExpandNode( CompilerContext, SourceGraph );
  175. const FName StructFromJsonStrFunctionName = GET_FUNCTION_NAME_CHECKED( UDBJsonBPLibrary, JsonDeserialize);
  176. UK2Node_CallFunction* CallStructFromJsonFunction = CompilerContext.SpawnIntermediateNode<UK2Node_CallFunction>( this, SourceGraph );
  177. CallStructFromJsonFunction->FunctionReference.SetExternalMember( StructFromJsonStrFunctionName, UDBJsonBPLibrary::StaticClass() );
  178. CallStructFromJsonFunction->AllocateDefaultPins();
  179. CompilerContext.MovePinLinksToIntermediate( *GetExecPin(), *( CallStructFromJsonFunction->GetExecPin() ) );
  180. UScriptStruct* StructType = GetReturnTypeForStruct();
  181. UUserDefinedStruct* UserStructType = Cast<UUserDefinedStruct>( StructType );
  182. UEdGraphPin* StructTypePin = CallStructFromJsonFunction->FindPinChecked( TEXT( "StructType" ) );
  183. if ( UserStructType && UserStructType->PrimaryStruct.IsValid() )
  184. StructTypePin->DefaultObject = UserStructType->PrimaryStruct.Get();
  185. else
  186. StructTypePin->DefaultObject = StructType;
  187. UEdGraphPin* DataInPin = CallStructFromJsonFunction->FindPinChecked( TEXT( "JsonStr" ) );
  188. CompilerContext.MovePinLinksToIntermediate( *GetDataPin(), *DataInPin );
  189. UEdGraphPin* OriginalReturnPin = FindPinChecked(UEdGraphSchema_K2::PN_ReturnValue);
  190. UEdGraphPin* FunctionOutStructPin = CallStructFromJsonFunction->FindPinChecked(TEXT("OutStruct"));
  191. UEdGraphPin* FunctionReturnPin = CallStructFromJsonFunction->FindPinChecked(UEdGraphSchema_K2::PN_ReturnValue);
  192. UEdGraphPin* FunctionThenPin = CallStructFromJsonFunction->GetThenPin();
  193. UEdGraphPin* OriginalErroInfoPin = FindPinChecked(TEXT("ErroInfo"));
  194. UEdGraphPin* ErroInfoPin = CallStructFromJsonFunction->FindPinChecked(TEXT("ErroInfo"));;
  195. CompilerContext.MovePinLinksToIntermediate(*OriginalErroInfoPin, *ErroInfoPin);
  196. FunctionOutStructPin->PinType = OriginalReturnPin->PinType;
  197. FunctionOutStructPin->PinType.PinSubCategoryObject = OriginalReturnPin->PinType.PinSubCategoryObject;
  198. UK2Node_IfThenElse* BranchNode = CompilerContext.SpawnIntermediateNode<UK2Node_IfThenElse>( this, SourceGraph );
  199. BranchNode->AllocateDefaultPins();
  200. FunctionThenPin->MakeLinkTo(BranchNode->GetExecPin());
  201. FunctionReturnPin->MakeLinkTo(BranchNode->GetConditionPin());
  202. CompilerContext.MovePinLinksToIntermediate(*GetThenPin(), *(BranchNode->GetThenPin()));
  203. CompilerContext.MovePinLinksToIntermediate(*GetFailedPin(), *(BranchNode->GetElsePin()));
  204. CompilerContext.MovePinLinksToIntermediate(*OriginalReturnPin, *FunctionOutStructPin);
  205. BreakAllNodeLinks();
  206. }
  207. FSlateIcon UK2Node_JsonDeserialize::GetIconAndTint( FLinearColor& OutColor ) const
  208. {
  209. OutColor = GetNodeTitleColor();
  210. static FSlateIcon Icon( "EditorStyle", "Kismet.AllClasses.FunctionIcon" );
  211. return Icon;
  212. }
  213. void UK2Node_JsonDeserialize::PostReconstructNode()
  214. {
  215. Super::PostReconstructNode();
  216. RefreshOutputPinType();
  217. }
  218. void UK2Node_JsonDeserialize::EarlyValidation( FCompilerResultsLog& MessageLog ) const
  219. {
  220. Super::EarlyValidation( MessageLog );
  221. if ( UEdGraphPin* ResultPin = GetResultPin() )
  222. {
  223. if ( ResultPin->LinkedTo.Num() == 0 )
  224. {
  225. MessageLog.Error( *LOCTEXT( "MissingPins", "Missing pins in @@" ).ToString(), this );
  226. return;
  227. }
  228. }
  229. }
  230. void UK2Node_JsonDeserialize::NotifyPinConnectionListChanged( UEdGraphPin* Pin )
  231. {
  232. Super::NotifyPinConnectionListChanged( Pin );
  233. if ( Pin == GetResultPin() )
  234. RefreshOutputPinType();
  235. }
  236. #undef LOCTEXT_NAMESPACE