Files
UnrealEngineUWP/Engine/Source/Developer/Windows/LiveCoding/Private/External/LC_ClientCommandActions.cpp
Ben Marsh e1fe0cc030 Integrating live coding feature (aka Live++) into UE4.
Allows fast iteration of C++ changes without restarting the application. To use, select the "Live Coding (Experimental)" mode from the drop down menu next to the editor's compile button, or type "LiveCoding" into the console for a monolithic build. Press Ctrl+Alt+F11 to find changes and compile.

Changes vs standalone Live++ version:

* UBT is used to execute builds. This allows standard UE4 adaptive unity mode, allows us to reuse object files when we do regular builds, supports using any build executor allowed by UBT (XGE, SNDBS, etc..).
* Adding new source files is supported.
* Custom visualizer for FNames is supported via a weakly linked symbol in a static library (Engine/Extras/NatvisHelpers).
* Settings are exposed in the editor's project settings dialog.
* Standalone application has been rewritten as a Slate app ("LiveCodingConsole"). There is an additional option to start the program as hidden, where it will not be visible until Ctrl+Alt+F11 is hit. Similarly, closing the window will hide it instead of closing the application.
* Does not require a standalone licensed version of Live++.

Known issues:

* Does not currently support class layout changes / object reinstancing

#rb none
#fyi Marc.Audy, Stefan.Boberg, Nick.Penwarden
#jira

[CL 5304722 by Ben Marsh in 4.22 branch]
2019-03-05 15:54:02 -05:00

212 lines
4.9 KiB
C++

// Copyright 2011-2019 Molecular Matters GmbH, all rights reserved.
#include "LC_ClientCommandActions.h"
#include "LC_ClientUserCommandThread.h"
#include "LC_DuplexPipe.h"
#include "LC_SyncPoint.h"
#include "LC_Executable.h"
#include "LC_Event.h"
#include "LC_Process.h"
#include "LC_Logging.h"
bool actions::RegisterProcessFinished::Execute(CommandType* command, const DuplexPipe* pipe, void* context)
{
pipe->SendAck();
bool* successfullyRegisteredProcess = static_cast<bool*>(context);
*successfullyRegisteredProcess = command->success;
// don't continue execution
return false;
}
bool actions::EnableModuleFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::DisableModuleFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::EnableAllModulesFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::DisableAllModulesFinished::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
Event* event = static_cast<Event*>(command->token);
event->Signal();
pipe->SendAck();
return false;
}
bool actions::EnterSyncPoint::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
syncPoint::Enter();
pipe->SendAck();
return true;
}
bool actions::LeaveSyncPoint::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
syncPoint::Leave();
pipe->SendAck();
return true;
}
bool actions::CallHooks::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
for (const hook::Function* hook = command->first; hook < command->last; ++hook)
{
// note that sections are often padded with zeroes, so skip everything that's zero
hook::Function function = *hook;
if (function)
{
function();
}
}
pipe->SendAck();
return true;
}
bool actions::GetModule::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
HMODULE module = ::GetModuleHandleW(command->path);
if (module)
{
wchar_t fullPath[MAX_PATH];
::GetModuleFileNameW(module, fullPath, MAX_PATH);
// send back command with module info
{
commands::GetModuleInfo cmd = { module, process::GetId(), command->loadImports, command->taskContext };
wcscpy_s(cmd.path, fullPath);
pipe->SendAck();
pipe->SendCommandAndWaitForAck(cmd);
}
}
else
{
pipe->SendAck();
pipe->SendCommandAndWaitForAck(commands::GetModuleInfo { nullptr, process::GetId(), command->loadImports, command->taskContext });
}
return true;
}
// BEGIN EPIC MOD - Support for UE4 debug visualizers
struct FNameEntry;
class FChunkedFixedUObjectArray;
// END EPIC MOD
bool actions::LoadPatch::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
// load library into this process
HMODULE module = ::LoadLibraryW(command->path);
// BEGIN EPIC MOD - Support for UE4 debug visualizers
typedef void InitNatvisHelpersFunc(FNameEntry*** NameTable, FChunkedFixedUObjectArray* ObjectArray);
InitNatvisHelpersFunc* InitNatvisHelpers = (InitNatvisHelpersFunc*)(void*)GetProcAddress(module, "InitNatvisHelpers");
if (InitNatvisHelpers != nullptr)
{
extern FNameEntry*** GFNameTableForDebuggerVisualizers_MT;
extern FChunkedFixedUObjectArray*& GObjectArrayForDebugVisualizers;
(*InitNatvisHelpers)(GFNameTableForDebuggerVisualizers_MT, GObjectArrayForDebugVisualizers);
}
// END EPIC MOD
pipe->SendAck();
// send back command with module info
pipe->SendCommandAndWaitForAck(commands::LoadPatchInfo { module });
return true;
}
bool actions::UnloadPatch::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
// unload library from this process
::FreeLibrary(command->module);
pipe->SendAck();
return true;
}
bool actions::CallEntryPoint::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
executable::CallDllEntryPoint(command->moduleBase, command->entryPointRva);
pipe->SendAck();
return true;
}
bool actions::LogOutput::Execute(CommandType* command, const DuplexPipe* pipe, void*)
{
logging::LogNoFormat<logging::Channel::USER>(command->buffer);
pipe->SendAck();
return true;
}
bool actions::CompilationFinished::Execute(CommandType*, const DuplexPipe* pipe, void*)
{
pipe->SendAck();
// don't continue execution
return false;
}
bool actions::HandleExceptionFinished::Execute(CommandType* command, const DuplexPipe* pipe, void* context)
{
ClientUserCommandThread::ExceptionResult* resultContext = static_cast<ClientUserCommandThread::ExceptionResult*>(context);
resultContext->returnAddress = command->returnAddress;
resultContext->framePointer = command->framePointer;
resultContext->stackPointer = command->stackPointer;
resultContext->continueExecution = command->continueExecution;
pipe->SendAck();
// don't continue execution
return false;
}