izzy/UnrealEngineUWP
0
0
Fork 0
mirror of https://github.com/izzy2lost/UnrealEngineUWP.git synced 2026-03-26 18:15:20 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add launch options to VSCodeProjectFileGenerator that allow attaching to a running process or debugging a core file

Browse Source 
#jira UE-92630
#rb Joakim.Lindqvist
#fyi brandon.schaefer

[CL 16403824 by james singer in ue5-main branch]
This commit is contained in:
james singer
2021-05-20 11:16:49 -04:00
parent 299c4be8fe
commit 2bd6138302
1 changed files with 124 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

180
Engine/Source/Programs/UnrealBuildTool/ProjectFiles/VisualStudioCode/VSCodeProjectFileGenerator.cs
View File

@@ -50,6 +50,18 @@ namespace UnrealBuildTool
[XmlConfigFile(Name = "IncludeAllFiles")]
private bool IncludeAllFiles = false;
/// <summary>
/// Whether VS Code project generation should include debug configurations to allow attaching to already running processes
/// </summary>
[XmlConfigFile(Name = "AddDebugAttachConfig")]
private bool bAddDebugAttachConfig = false;
/// <summary>
/// Whether VS Code project generation should include debug configurations to allow core dump debugging
/// </summary>
[XmlConfigFile(Name = "AddDebugCoreConfig")]
private bool bAddDebugCoreConfig = false;
private enum EPathType
{
Absolute,
@@ -1187,6 +1199,97 @@ namespace UnrealBuildTool
}
}
private void WriteNativeLaunchConfig(ProjectData.Project InProject, JsonFile OutFile, ProjectData.Target Target, ProjectData.BuildProduct BuildProduct)
{
bool bIsLinux = BuildProduct.Platform == UnrealTargetPlatform.Linux;
List<string> Types = new List<string>();
Types.Add("Launch");
if(bAddDebugAttachConfig && bIsLinux)
{
Types.Add("Attach");
}
if (bAddDebugCoreConfig && bIsLinux)
{
Types.Add("Debug Core");
}
string LaunchTaskName = String.Format("{0} {1} {2} Build", Target.Name, BuildProduct.Platform, BuildProduct.Config);
foreach(string Type in Types)
{
OutFile.BeginObject();
{
OutFile.AddField("name", Type + " " + Target.Name + " (" + BuildProduct.Config.ToString() + ")");
OutFile.AddField("request", (Type == "Attach")?"attach":"launch");
OutFile.AddField("program", MakeUnquotedPathString(BuildProduct.OutputFile, EPathType.Absolute));
switch (Type)
{
case "Launch":
OutFile.AddField("preLaunchTask", LaunchTaskName);
break;
case "Debug Core":
OutFile.AddField("coreDumpPath", "${input:coreFileName}");
break;
case "Attach":
OutFile.AddField("processId", "${command:pickProcess}");
break;
}
if(Type != "Attach")
{
OutFile.BeginArray("args");
{
if (Target.Type == TargetRules.TargetType.Editor)
{
if (InProject.Name != "UE5")
{
if (bForeignProject)
{
OutFile.AddUnnamedField(MakePathString(BuildProduct.UProjectFile, false, true));
}
else
{
OutFile.AddUnnamedField(InProject.Name);
}
}
}
}
OutFile.EndArray();
}
/*
DirectoryReference CWD = BuildProduct.OutputFile.Directory;
while (HostPlatform == UnrealTargetPlatform.Mac && CWD != null && CWD.ToString().Contains(".app"))
{
CWD = CWD.ParentDirectory;
}
if (CWD != null)
{
OutFile.AddField("cwd", MakePathString(CWD, true, true));
}
*/
OutFile.AddField("cwd", MakeUnquotedPathString(UE4ProjectRoot, EPathType.Absolute));
if (HostPlatform == UnrealTargetPlatform.Win64)
{
OutFile.AddField("stopAtEntry", false);
OutFile.AddField("externalConsole", true);
OutFile.AddField("type", "cppvsdbg");
OutFile.AddField("visualizerFile", MakeUnquotedPathString(FileReference.Combine(UE4ProjectRoot, "Engine", "Extras", "VisualStudioDebugging", "Unreal.natvis"), EPathType.Absolute));
}
else
{
OutFile.AddField("type", "cppdbg");
}
}
OutFile.EndObject();
}
}
private void WriteNativeLaunchConfig(ProjectData.Project InProject, JsonFile OutFile)
{
foreach (ProjectData.Target Target in InProject.Targets)
@@ -1195,62 +1298,7 @@ namespace UnrealBuildTool
{
if (BuildProduct.Platform == HostPlatform)
{
string LaunchTaskName = String.Format("{0} {1} {2} Build", Target.Name, BuildProduct.Platform, BuildProduct.Config);
OutFile.BeginObject();
{
OutFile.AddField("name", Target.Name + " (" + BuildProduct.Config.ToString() + ")");
OutFile.AddField("request", "launch");
OutFile.AddField("preLaunchTask", LaunchTaskName);
OutFile.AddField("program", MakeUnquotedPathString(BuildProduct.OutputFile, EPathType.Absolute));
OutFile.BeginArray("args");
{
if (Target.Type == TargetRules.TargetType.Editor)
{
if (InProject.Name != "UE5")
{
if (bForeignProject)
{
OutFile.AddUnnamedField(MakePathString(BuildProduct.UProjectFile, false, true));
}
else
{
OutFile.AddUnnamedField(InProject.Name);
}
}
}
}
OutFile.EndArray();
/*
DirectoryReference CWD = BuildProduct.OutputFile.Directory;
while (HostPlatform == UnrealTargetPlatform.Mac && CWD != null && CWD.ToString().Contains(".app"))
{
CWD = CWD.ParentDirectory;
}
if (CWD != null)
{
OutFile.AddField("cwd", MakePathString(CWD, true, true));
}
*/
OutFile.AddField("cwd", MakeUnquotedPathString(UE4ProjectRoot, EPathType.Absolute));
if (HostPlatform == UnrealTargetPlatform.Win64)
{
OutFile.AddField("stopAtEntry", false);
OutFile.AddField("externalConsole", true);
OutFile.AddField("type", "cppvsdbg");
OutFile.AddField("visualizerFile", MakeUnquotedPathString(FileReference.Combine(UE4ProjectRoot, "Engine", "Extras", "VisualStudioDebugging", "Unreal.natvis"), EPathType.Absolute));
}
else
{
OutFile.AddField("type", "lldb");
}
}
OutFile.EndObject();
WriteNativeLaunchConfig(InProject, OutFile, Target, BuildProduct);
}
else if (BuildProduct.Platform == UnrealTargetPlatform.Android)
{
@@ -1330,6 +1378,25 @@ namespace UnrealBuildTool
OutFile.BeginRootObject();
{
OutFile.AddField("version", "0.2.0");
if(bAddDebugCoreConfig)
{
OutFile.BeginArray("inputs");
OutFile.BeginObject();
OutFile.AddField("id", "coreFileName");
OutFile.AddField("type", "command");
OutFile.AddField("command", "filePicker.pick");
OutFile.BeginObject("args");
OutFile.AddField("masks", "core*");
OutFile.BeginObject("display");
OutFile.AddField("type", "fileRelativePath");
OutFile.AddField("detail", "filePath");
OutFile.EndObject();
OutFile.AddField("output", "filePath");
OutFile.EndObject();
OutFile.EndObject();
OutFile.EndArray();
}
OutFile.BeginArray("configurations");
{
foreach (ProjectData.Project Project in ProjectData.NativeProjects)
@@ -1499,6 +1566,7 @@ namespace UnrealBuildTool
{
WorkspaceFile.AddUnnamedField("vadimcn.vscode-lldb");
WorkspaceFile.AddUnnamedField("ms-vscode.mono-debug");
WorkspaceFile.AddUnnamedField("dfarley1.file-picker");
}
}
WorkspaceFile.EndArray();