Files
UnrealEngineUWP/Engine/Source/Developer/Windows/LiveCodingServer/Private/External/LC_AppSettings.h
ben marsh 7c46cc6b4c 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

#ROBOMERGE-OWNER: ryan.gerleve
#ROBOMERGE-AUTHOR: ben.marsh
#ROBOMERGE-SOURCE: CL 5304722 in //UE4/Release-4.22/... via CL 5309051
#ROBOMERGE-BOT: ENGINE (Main -> Dev-Networking)

[CL 5326306 by ben marsh in Dev-Networking branch]
2019-03-06 18:19:24 -05:00

111 lines
3.2 KiB
C++

// Copyright 2011-2019 Molecular Matters GmbH, all rights reserved.
#pragma once
#include "CoreTypes.h"
#include "LC_Settings.h"
namespace appSettings
{
struct FocusOnRecompile
{
enum Enum
{
ON_ERROR,
ON_SUCCESS,
ON_SHORTCUT,
NEVER
};
};
void Startup(const wchar_t* group);
void Shutdown(void);
// returns a directory where Live++-related files are saved, e.g. %LocalAppData%\Live++
std::wstring GetLppDirectory(void);
// returns a path where symbols can be stored
std::wstring GetSymbolsDirectory(void);
// returns a path where user settings can be stored
std::wstring GetUserSettingsPath(void);
// returns a path where project settings can be stored
std::wstring GetProjectSettingsPath(void);
// returns the overridden compiler path
std::wstring GetCompilerPath(void);
// returns the overridden linker path
std::wstring GetLinkerPath(void);
void UpdateCompilerPathCache(void);
void UpdateLinkerPathCache(void);
void UpdatePathCache(void);
// apply a new value to any of the boolean settings
void ApplySettingBool(const char* const settingName, bool value);
// apply a new value to any of the int settings
void ApplySettingInt(const char* const settingName, int value);
// apply a new value to any of the string settings
void ApplySettingString(const char* const settingName, const wchar_t* const value);
// appearance
extern SettingInt* g_initialWindowMode;
extern SettingIntProxy* g_initialWindowModeProxy;
extern SettingBool* g_showFullPathInTitle;
extern SettingBool* g_showPathFirstInTitle;
// behaviour
extern SettingInt* g_receiveFocusOnRecompile;
extern SettingIntProxy* g_receiveFocusOnRecompileProxy;
extern SettingBool* g_showNotificationOnRecompile;
extern SettingBool* g_clearLogOnRecompile;
extern SettingBool* g_minimizeOnClose;
extern SettingBool* g_keepTrayIcon;
extern SettingString* g_playSoundOnSuccess;
extern SettingString* g_playSoundOnError;
extern SettingShortcut* g_compileShortcut;
// logging
extern SettingBool* g_showUndecoratedNames;
extern SettingBool* g_wordWrapOutput;
extern SettingBool* g_enableDevLog;
extern SettingBool* g_enableTelemetryLog;
extern SettingBool* g_enableDevLogCompilands;
// compiler
extern SettingString* g_compilerPath; // DO NOT USE directly, use GetCompilerPath instead!
extern SettingBool* g_useCompilerOverrideAsFallback;
extern SettingBool* g_useCompilerEnvironment;
extern SettingString* g_compilerOptions;
extern SettingBool* g_compilerForcePchPdbs;
// linker
extern SettingString* g_linkerPath; // DO NOT USE directly, use GetLinkerPath instead!
extern SettingBool* g_useLinkerOverrideAsFallback;
extern SettingBool* g_useLinkerEnvironment;
extern SettingString* g_linkerOptions;
extern SettingBool* g_forceLinkWeakSymbols;
// continuous compilation
extern SettingBool* g_continuousCompilationEnabled;
extern SettingString* g_continuousCompilationPath;
extern SettingInt* g_continuousCompilationTimeout;
// virtual drive
extern SettingString* g_virtualDriveLetter;
extern SettingString* g_virtualDrivePath;
// multi-process editing
extern SettingBool* g_installCompiledPatchesMultiProcess;
// amalgamated/unity builds
extern SettingBool* g_amalgamationSplitIntoSingleParts;
extern SettingInt* g_amalgamationSplitMinCppCount;
}