GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Debug Commands work in progress

Browse Source
This commit is contained in:
Wojtek Figat
2024-10-03 10:24:15 +02:00
parent 791435ba76
commit a932d549f4
5 changed files with 334 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

293
Source/Engine/Debug/DebugCommands.cpp Normal file
View File

@@ -0,0 +1,293 @@
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
#include "DebugCommands.h"
#include "Engine/Core/Log.h"
#include "Engine/Core/Collections/Array.h"
#include "Engine/Engine/EngineService.h"
#include "Engine/Threading/Threading.h"
#include "Engine/Profiler/ProfilerCPU.h"
#include "Engine/Scripting/BinaryModule.h"
#include "Engine/Scripting/Scripting.h"
#include "Engine/Scripting/ManagedCLR/MAssembly.h"
#include "Engine/Scripting/ManagedCLR/MClass.h"
#include "Engine/Scripting/ManagedCLR/MMethod.h"
#include "Engine/Scripting/ManagedCLR/MField.h"
#include "Engine/Scripting/ManagedCLR/MProperty.h"
#include "FlaxEngine.Gen.h"
struct CommandData
{
String Name;
BinaryModule* Module;
void* Method = nullptr;
void* MethodGet = nullptr;
void* MethodSet = nullptr;
void* Field = nullptr;
void Invoke(StringView args) const
{
PROFILE_CPU();
// Get command signature
Array<ScriptingTypeMethodSignature::Param, InlinedAllocation<16>> sigParams;
if (Method)
{
ScriptingTypeMethodSignature sig;
Module->GetMethodSignature(Method, sig);
sigParams = MoveTemp(sig.Params);
}
else if (Field)
{
ScriptingTypeFieldSignature sig;
Module->GetFieldSignature(Field, sig);
auto& p = sigParams.AddOne();
p.IsOut = false;
p.Type = sig.ValueType;
}
else if (MethodSet && args.HasChars())
{
ScriptingTypeMethodSignature sig;
Module->GetMethodSignature(MethodSet, sig);
sigParams = MoveTemp(sig.Params);
sigParams.Resize(1);
}
// Parse arguments
Array<Variant> params;
params.Resize(sigParams.Count());
Array<String> argsSeparated;
String argsStr(args);
argsStr.Split(' ', argsSeparated);
for (int32 i = 0; i < argsSeparated.Count() && i < params.Count(); i++)
{
params[i] = Variant::Parse(argsSeparated[i], sigParams[i].Type);
}
// Call command
Variant result;
if (Method)
{
Module->InvokeMethod(Method, Variant::Null, ToSpan(params), result);
}
else if (Field)
{
if (args.IsEmpty())
Module->GetFieldValue(Field, Variant::Null, result);
else
Module->SetFieldValue(Field, Variant::Null, params[0]);
}
else if (MethodGet && args.IsEmpty())
{
Module->InvokeMethod(MethodGet, Variant::Null, ToSpan(params), result);
}
else if (MethodSet && args.HasChars())
{
Module->InvokeMethod(MethodSet, Variant::Null, ToSpan(params), result);
}
// Print result
if (result != Variant())
{
LOG_STR(Info, result.ToString());
}
}
};
namespace
{
CriticalSection Locker;
bool Inited = false;
Array<CommandData> Commands;
void OnBinaryModuleLoaded(BinaryModule* module)
{
if (module == GetBinaryModuleCorlib())
return;
#if USE_CSHARP
if (auto* managedModule = dynamic_cast<ManagedBinaryModule*>(module))
{
const MClass* attribute = ((NativeBinaryModule*)GetBinaryModuleFlaxEngine())->Assembly->GetClass("FlaxEngine.DebugCommand");
ASSERT_LOW_LAYER(attribute);
const auto& classes = managedModule->Assembly->GetClasses();
for (auto e : classes)
{
MClass* mclass = e.Value;
if (mclass->IsGeneric() ||
mclass->IsInterface() ||
mclass->IsEnum())
continue;
const bool useClass = mclass->HasAttribute(attribute);
// TODO: optimize this via stack-based format buffer and then convert Ansi to UTF16
#define BUILD_NAME(commandData, itemName) commandData.Name = String(mclass->GetName()) + TEXT(".") + String(itemName)
// Process methods
const auto& methods = mclass->GetMethods();
for (MMethod* method : methods)
{
if (!method->IsStatic())
continue;
const StringAnsi& name = method->GetName();
if (name.Contains("Internal_") ||
mclass->GetFullName().Contains(".Interop."))
continue;
if (name.StartsWith("get_") ||
name.StartsWith("set_") ||
name.StartsWith("op_") ||
name.StartsWith("add_") ||
name.StartsWith("remove_"))
continue;
if (!useClass && !method->HasAttribute(attribute))
continue;
auto& commandData = Commands.AddOne();
BUILD_NAME(commandData, method->GetName());
commandData.Module = module;
commandData.Method = method;
}
// Process fields
const auto& fields = mclass->GetFields();
for (MField* field : fields)
{
if (!field->IsStatic())
continue;
if (!useClass && !field->HasAttribute(attribute))
continue;
auto& commandData = Commands.AddOne();
BUILD_NAME(commandData, field->GetName());
commandData.Module = module;
commandData.Field = field;
}
// Process properties
const auto& properties = mclass->GetProperties();
for (MProperty* property : properties)
{
if (!property->IsStatic())
continue;
if (!useClass && !property->HasAttribute(attribute))
continue;
auto& commandData = Commands.AddOne();
BUILD_NAME(commandData, property->GetName());
commandData.Module = module;
commandData.MethodGet = property->GetGetMethod();
commandData.MethodSet = property->GetSetMethod();
}
}
#undef BUILD_NAME
}
else
#endif
{
// TODO: implement generic search for other modules (eg. Visual Scripts)
}
}
void OnScriptsReloading()
{
// Reset
Inited = false;
Commands.Clear();
}
void InitCommands()
{
PROFILE_CPU();
Inited = true;
const auto& modules = BinaryModule::GetModules();
for (BinaryModule* module : modules)
{
OnBinaryModuleLoaded(module);
}
Scripting::BinaryModuleLoaded.Bind(&OnBinaryModuleLoaded);
Scripting::ScriptsReloading.Bind(&OnScriptsReloading);
}
}
class DebugCommandsService : public EngineService
{
public:
DebugCommandsService()
: EngineService(TEXT("DebugCommands"), 0)
{
}
void Dispose() override
{
// Cleanup
ScopeLock lock(Locker);
Scripting::BinaryModuleLoaded.Unbind(&OnBinaryModuleLoaded);
Scripting::ScriptsReloading.Unbind(&OnScriptsReloading);
Commands.Clear();
Inited = true;
}
};
DebugCommandsService DebugCommandsServiceInstance;
void DebugCommands::Execute(StringView command)
{
// Preprocess command text
while (command.HasChars() && StringUtils::IsWhitespace(command[0]))
command = StringView(command.Get() + 1, command.Length() - 1);
while (command.HasChars() && StringUtils::IsWhitespace(command[command.Length() - 1]))
command = StringView(command.Get(), command.Length() - 1);
if (command.IsEmpty())
return;
StringView name = command;
StringView args;
int32 argsStart = name.Find(' ');
if (argsStart != -1)
{
name = command.Left(argsStart);
args = command.Right(argsStart + 1);
}
// Ensure that commands cache has been created
ScopeLock lock(Locker);
if (!Inited)
InitCommands();
// Find command to run
for (const CommandData& command : Commands)
{
if (name.Length() == command.Name.Length() &&
StringUtils::CompareIgnoreCase(name.Get(), command.Name.Get(), name.Length()) == 0)
{
command.Invoke(args);
return;
}
}
LOG(Error, "Unknown command '{}'", name);
}
bool DebugCommands::Iterate(const StringView& searchText, int32& index)
{
ScopeLock lock(Locker);
if (index >= 0)
{
if (!Inited)
InitCommands();
while (index < Commands.Count())
{
auto& command = Commands.Get()[index];
if (command.Name.StartsWith(searchText, StringSearchCase::IgnoreCase))
{
return true;
}
index++;
}
}
return false;
}
String DebugCommands::GetCommandName(int32 index)
{
ScopeLock lock(Locker);
CHECK_RETURN(Commands.IsValidIndex(index), String::Empty);
return Commands.Get()[index].Name;
}

15
Source/Engine/Debug/DebugCommands.cs Normal file
View File

@@ -0,0 +1,15 @@
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
using System;
namespace FlaxEngine
{
/// <summary>
/// Marks static method as debug command that can be executed from the command line or via console.
/// </summary>
[Serializable]
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public sealed class DebugCommand : Attribute
{
}
}

24
Source/Engine/Debug/DebugCommands.h Normal file
View File

@@ -0,0 +1,24 @@
// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.
#pragma once
#include "Engine/Scripting/ScriptingType.h"
/// <summary>
/// Debug commands and console variables system.
/// </summary>
API_CLASS(static) class FLAXENGINE_API DebugCommands
{
DECLARE_SCRIPTING_TYPE_MINIMAL(DebugCommands);
public:
/// <summary>
/// Executees the command.
/// </summary>
/// <param name="command">The command line (optionally with arguments).</param>
API_FUNCTION() static void Execute(StringView command);
public:
static bool Iterate(const StringView& searchText, int32& index);
static String GetCommandName(int32 index);
};

2
Source/Engine/Engine/Engine.h
View File

@@ -97,7 +97,7 @@ public:
/// Exits the engine.
/// </summary>
/// <param name="exitCode">The exit code.</param>
static void Exit(int32 exitCode = -1);
API_FUNCTION(Attributes="DebugCommand") static void Exit(int32 exitCode = -1);
/// <summary>
/// Requests normal engine exit.

2
Source/Engine/Graphics/Graphics.h
View File

@@ -9,7 +9,7 @@
/// <summary>
/// Graphics device manager that creates, manages and releases graphics device and related objects.
/// </summary>
API_CLASS(Static) class FLAXENGINE_API Graphics
API_CLASS(Static, Attributes="DebugCommand") class FLAXENGINE_API Graphics
{
DECLARE_SCRIPTING_TYPE_NO_SPAWN(Graphics);
public: